Config Workbook Tool(CWB Tool) Reference and Guide

TableofContents

Introduction...........................................................................................................................................2

HowToInstallConfigWorkbook....................................................................................................2InstallConfigWorkbookfromAppExchange.......................................................................................................2InstallCWBFromConfigWorkbookSite...............................................................................................................4POSTINSTALLSTEP............................................................................................................................................................4

DownloadObjectmetadataReport................................................................................................4ObjectBasicReport.........................................................................................................................................................4ObjectBasicDetailOnly(WithoutProfileFLS)...................................................................................................6ObjectFullDetails............................................................................................................................................................7ObjectFieldVisibilityonLayouts.............................................................................................................................8ObjectPageLayoutAssignment.............................................................................................................................10ObjectModifiedDetail................................................................................................................................................11CustomFieldModifieddetail...................................................................................................................................11

DownloadCustomMetadata...........................................................................................................12

DownloadLightningComponent..................................................................................................12

DownloadVisualFlow......................................................................................................................12

DownloadPermissionSet...............................................................................................................12PermissionSetBasicDetail.....................................................................................................................................12PermissionSetFullDetail........................................................................................................................................13PermissionSetAssignmentDetail........................................................................................................................13PermissionSetModifiedDetail..............................................................................................................................13PermissionSetTabVisibilityDetail.....................................................................................................................13

DownloadCustomApplication......................................................................................................13

DownloadApexCode........................................................................................................................13

DownloadProfile...............................................................................................................................14ProfileBasicDetails.....................................................................................................................................................14ProfileFullDetails........................................................................................................................................................15ObjectorFieldPermissiononly..............................................................................................................................15ProfileModifiedDetail................................................................................................................................................15TabVisibilityDetail......................................................................................................................................................15

2

Introduction Salesforce metadata, at your fingertips. Quickly extract Salesforce metadata in Excel files, ex. Field Level Security, Profile permissions across objects, fields etc, Page Layouts , Permission set assignments, Apex, Visualforce. It also offers tools like Org Comparator, and Impact Analysis. It covers FLS,Profile Details, Layout detail, Permission set , Permission set assignment, Apex detail,Approval Process, Custom Application,Static Resource,Visual Flow, Custom Metadata, Object Fields Visibility on Layout.

How To Install Config Workbook CWB Tool can be install 2 ways:

1. From Salesforce AppExchange 2. From http://configworkbook.com

Install Config Workbook from AppExchange 1. Go the https://appexchange.salesforce.com 2. Click on Login button

3. Enter Personal Dev Org or Production Org login credential

3

4. Search Config Workbook and click on Config Workbook name

5. Click on Get It Now 6. Select Sandbox or Production

7. Click on Confirm and Install

8. Click on upgrade or install button

9 Wait for some time . will receive email notification once installation successful.

4

Install CWB From Config Workbook Site

Config workbook site always have the latest version of CWB. We can install it directly without login to AppExchange

1. Open http://configworkbook.com

2. Click on Production or Sandbox Install

3. Enter the Username and Password and follow the instruction which will display after successful login

POST INSTALL STEP

1. Create a remote site setting to white list your domain for callouts. Click on Remote Site Setting Link or Button

2. Now CWB Tool is ready for metadata report download.

Download Object metadata Report

Object Basic Report Use Basic report when you need basic detail along with Profile FLS. Basic report capabilities for many objects allow you to download metadata in a single excel sheet . Smaller selection improves performance. Fetch basic object details like: Field level security for each profile, Custom button/links, Formula field details, and Record Types.

Note: In case you run into heap issues, please reduce the number of selected profiles and objects by clicking on the filter icon button.

Follow the below steps to download basic object detail

5

1. Click on the filter icon . Filter the object and Profiles which you want to download

2. If managed object is not available in object Dropdown then go to the CWB Tool->Settings tab and include

Managed Package Detail. Select Object(s) and Profiles and click on Save&Close

3. Click on Download

6

4. Your report will be downloaded in your local machine.

Object Basic Detail Only (Without Profile FLS) Download object basic details like Object Name, Field Label, Field API name, Data Type etc.

1. Click on Download Object

2. Select object(s) which you want to download

7

3. Your report will be downloaded in your machine

Object Full Details Deep dive into every other aspect of Object level metadata details like:

- All of Object’s and field’s basic, system and other metadata level attributes - Every possible detail about Picklists, Formulas, Validation Rules, WebLinks, Action Overrides, List Views, Field Sets, Record Types, and Page Layouts.

1. Click on Download Icon under object full detail

2. Select the Object(s) which you want to download (If installed package objects are not

visible in dropdown then Go to the CWB Tool->Settings and checked the Include

8

Manage Package detail checkbox)

3. Click on Download Object button 4. Report will be downloaded in your local machine

Object Field Visibility on Layouts

Deep dive into every other aspect of Object layout metadata details like: - Field visibility on layouts

1. Click on Download Icon

9

2. It will open Poppup. Select single or multiple objects and click on the Download layout button.

3. Report will be downloaded to your machine.

10

Object Page Layout Assignment

Download Page Layout Assignment to Profile along with record Types and know which layouts are not used yet

1. Click on Download Icon under Object Page Layout Assignment

2. Object Page Layout Assignment popup will open. Select the one or multiple object

11

3. Page layout assignment will be downloaded your local machine

Object Modified Detail

For all objects (standard / custom), explore who Created & LastModified objects, with dates and time.

Custom Field Modified detail

Explore who created or modified custom fields,Validation Rule, with dates & time.

12

Download Custom Metadata

You can download custom metadata record(s) in excel format.

1. Click on download icon

2. Select Metadata Type and click on the Download CustomMetadata button. 3. Report will be downloaded on your local machine.

Download Lightning Component

You can download lightning component detail in zip or excel. It will have all the JS code in single file.

Download Visual Flow

Explore visual flow details like Variable, Action Calls, Apex Plugin Calls, Assignment, Choices, Constant,Decision,DynamicChoiceSet, Formula,Loop,Meta data Value,RecordCreate,RecordDelete,RecordLookup,RecordUpdate,Screen,Step,Subflow,TextTemplate and Wait Event etc.

Download Flow Modified Detail

For all Flow, explore who Created & LastModified, with dates and time.

Download Permission Set

Permission Set Basic Detail

Fetches read/edit permission details for each field in every object across all permission sets.

1. Click on Filter icon 2. Select Object and Permission Set 3. Click on Save&Close button

13

4. Click on Download Icon 5. Report will download your local Machine

Permission Set Full Detail

Fetches all the permission set details for Application Visibilities, Class Accesses, Custom Permissions, External DataSource Access, Field Permissions, Object Permissions, Page Access, RecordType Visibilities, TabSettings, and User License.

1. Click on Download Icon 2. Select Permission Set 3. Click on Download Button 4. Select Download Permission Set 5. Report will download your local Machine

Permission Set Assignment Detail

1. Click on Download Icon under Permission Set->Full Detail 2. Select Permission Set 3. Click on Download Button 4. Select Download Permission Set Assignment Detail 5. Report will download your local Machine

Permission Set Modified Detail

Explore who created or modified Permissionset .

1. Click on Download Icon under Permission Set->Permissionset Modified Detail 2. Report will download your local Machine

Permission Set Tab Visibility Detail

Explore Tab Visibility in Permission Set .

Download Custom Application

Explore deep details about custom applications like Application Components, Domain Whitelist, Workspace Mappings, Keyboard Shortcuts, Live Agent Config, and Push Notifications.

Download Apex Code

Explore fine details about:

14

1. Apex : List of all classes, code coverage, namespace prefix, validity, created/last modified info, api version,code coverage, and length without comments. 2. Apex/VF Components and pages: Lists all components/pages with created/last modified info, namespace prefix, and api version etc. 3. Triggers : List of all triggers, code coverage, object name, associated DML events, namespace prefix,code coverage, validity, created/last slds-media__bodydified info, api version, and length without comments.

1. Click on Download Icon under Apex Code 2. Report will download your local Machine

Download Profile

Profile Basic Details

Explore basic details about profile like apex classes, pages, object permissions, applications and general user permissions.

1. Click on Filter icon 2. Select Object and Profile

15

3. Click on Save&Close button 4. Click on Download Icon 5. Report will download your local Machine

Profile Full Details

On top of all the basic permissions in the above report, this reports additionally offers field level security, record type and layout assignments, record type visibilities, tabs, and login IP range.

1. Click on Download Icon 2. Select Permission Set 3. Click on Download Button 4. Select Download Permission Set 5. Report will download your local Machine

Object or Field Permission only

Download Profile Users detail along with assigned Permission Set.

Profile Modified Detail

Explore who created or modified Profile .

1. Click on Download Icon under Profile->Profile Modified Detail 2. Report will download your local Machine

Tab Visibility Detail

Explore Tab Visibility in Profile .

16