Configuration Workbook

The CWB is one of the useful apps in the App Exchange for documenting key meta data information of any Salesforce organization. It is the most convenient and unique app that is used to maintain the information of a Salesforce org’s meta data like Record types, Objects, Profile, Relationships, Validation rules, Apex class, Apex triggers, and etc.
configuration workbook salesforce


The CWB is one of the useful apps in the App Exchange for documenting key meta data information of any Salesforce organization. It is the most convenient and unique app that is used to maintain the information of a Salesforce org’s meta data like Record types, Objects, Profile, Relationships, Validation rules, Apex class, Apex triggers, and etc.

Challenge with manually maintaining Configuration Workbook: 

  • Large organizations use multiple record types, profiles, objects, relationships, validation rules, Apex classes, triggers, managed packages, etc.
  • Maintaining the metadata information of these components might not be a challenge for smaller organizations with limited number of active SF components, but maintaining the same for larger SF organizations would be time consuming and very complex.

Why choose CWB? 

  1. Ease of use: The way of downloading the list of components is very easy with CWB tool, Very clean and user-friendly user interface.
  2. Quality of document: The CWB document design and content are good and visually impressive, so the users can differentiate fields easily.

Installing the CWB: 

1. Log into your SF account and open App Exchange and search for “CWB” and open the “Config Workbook”.

configuration workbook salesforce

2. Click on “Get It Now”

configuration workbook salesforce

3. Click on the “Log in to the AppExchange”, enter the username and password if needed.configuration workbook salesforce

4. Select the Installation location either “Production” or “sandbox” and agree the terms and conditions and then Install it.

5. Select the access level–like who will use the app, whether admin only or all users or specific profile users and click on Install or Upgrade.configuration workbook salesforce

6. Third Party Access is required; So, Approve the Third Party Access via check the grant access checkbox while installing.configuration workbook salesforce

7. Then Click on the Continue button; now, the Installation is started and necessary permissions are given to the selected people.

8. If the Installation Progress took more time, then the following screen appears. Click on Done.configuration workbook salesforce

9. After the Installation completes, you will receive an email regarding the Installation.

How to verify the details of the CWB App after installation? 

First log into Salesforce and Go to Setup [Symbol] Build [Symbol] Installed Packages.

You will see an application named as “SFDC Config Workbook” and the installation details like dates, newly added tabs and newly added objects.

How to use the CWB? 

First log into Salesforce and select the application as “CWB Tool” and click on tab named as “CWB Tool”.

CWB Tools: 


Dashboard contains flow chart diagrams that represent the status of your organization like All Metadata details, Apex Details, Profile Details, Login IP Behavior, Login Behavior, and Login Profile Behavior.

We can also refresh the Dashboard to view the changes immediately.

configuration workbook salesforce

Download History: 

It shows the License details and history of metadata downloaded.

Downloadable List of Metadata Details: 

  1. Object
  2. Profile
  3. Permission Set
  4. Apex Code
  5. Workflow
  6. Page Layout
  7. Approval Process
  8. Static Resource
  9. Custom Applications
  10. Modified Details like Object update, Custom Field update, Layout Update and Workflow Update

Additional Features: 

  • Comparator
  • Compare Profile
  • Update Metadata


Code Comparator and Object Comparator are used to compare data between two different connected SF organizations.

We can compare Apex Class, Apex Page, Apex Components, and Apex Trigger.

Compare Profile: 

We can compare profiles within the same org as well as with other salesforce orgs.

We choose the Source Profile and Target Profile and we can view the details within the browser itself or we can download those comparison details in the form of excel sheet.

configuration workbook salesforce

Update Metadata: 

We can update the metadata for Validation Rules, Workflow Rules, Field Level Security and Object Permissions. We can also update the metadata of other connected orgs.

Validation Rules: 

We can’t edit the conditions for the validation rules, but we can add a description and we can activate or deactivate the validation rules.

configuration workbook salesforce

Workflow Rules: 

We can’t edit the conditions of the workflow rules, but we can add a description and can activate or deactivate the Workflow Rule.

configuration workbook salesforce

Field Level Security: 

The Field Level Security (Read only or Edit) permissions can be updated for Standard or Custom Profiles, as shown below.

configuration workbook salesforce

Object Permissions:  The Object permissions can also be updated for Standard or Custom Profiles.

configuration workbook salesforce


Fixed contract for all types of organizations because it is a monthly contract only.

configuration workbook salesforce


  • All licenses are tied to a single org.
  • No auto renewals.
  • License purchased for production org, doesn’t work in all related sandboxes.
  • A new license is needed for each sandbox.
  • Validity of license will expire in case Sandbox is refreshed or Org ID is changed for any reason.
  • Single and Multi-user licenses lock down the users. CWB interface offers easy association of users, so be careful about releasing access of the app to required users only, based on the number of purchased licenses.

Limitation of Free product: 

  • Object, profile, permission set limited to 5.
  • Metadata detail of the app, approval process, site, static resources are not available. [both free version and paid version]


CWB is a huge time saver. Without CWB, we need to document all meta data details manually and it might take many days to complete and again human error might cause additional delays. Another challenge is constantly maintaining the document to reflect all changes in SF.

CWB AppExchange Link:

About MST

At MST Solutions our cornerstone is to adapt, engage and create solutions which guarantee the success of our clients. The talent of our team and experiences in varied business verticals gives us an advantage over other competitors.

Recent Articles

Work with us.

Our people aren’t just employees, they are key to the success of our business. We recognize the strengths of each individual and allow them time and resources to further develop those skills, crafting a culture of leaders who are passionate about where they are going within our organization.