Documentation

ConfigWorkbook install & order guide

Everything you need to install ConfigWorkbook, place an order, and activate your subscription — start to finish in about five minutes.

Getting started

ConfigWorkbook is a native Salesforce app for documenting org metadata and security. This guide covers installation, placing an order, and activating your subscription.

Quick start

Install ConfigWorkbook from AppExchange.
Open the ConfigWorkbook app from the App Launcher.
Place a new order for a paid subscription (or explore free features first).
Start documenting and managing your org.

Installation

Prerequisites

Salesforce Enterprise Edition or higher
System Administrator profile or equivalent permissions
Valid Salesforce login credentials

Installation steps

Log in to your Salesforce account.
Visit ConfigWorkbook on AppExchange.
Click the “Get It Now” button.
Choose an install option (Production or Sandbox).
Grant the necessary permissions.
Complete the installation.

ConfigWorkbook installation options in Salesforce

Placing an order

Once ConfigWorkbook is installed, placing an order takes about two minutes. Here's exactly what happens, step by step.

Open the App Launcher and find ConfigWorkbook

In Salesforce, click the App Launcher (grid icon), search for ConfigWorkbook, and select it.

Click "Order App" inside the app

The Order App button is in the ConfigWorkbook app's top navigation.

"Order App" button inside ConfigWorkbook

On the Order List page, click "+New"

This opens a new order. If you're not sure whether you already have an active subscription, check the Order List first.

Confirm the popup

Click OK to proceed, or Cancel if you want to double-check your subscription status first.

Choose a plan and fill in your details

In the “Place New Order” popup, choose the Annual or Monthly subscription plan, then fill in the required fields:

• Name
• Email
• Company name
• Production Org ID

Place New Order form with plan selection and required fields

Review pricing and apply a coupon

The price breakdown shows the base amount, the online platform fee, and your final total. Have a coupon code? There's a field for that too.

Submit payment — you're done

Complete payment to finish the order. Your subscription key is emailed to you immediately, and you'll use it in the next section to activate your license.

Tips: Annual plans are cheaper long-term; monthly plans are easier to change. All prices are in US dollars, and your subscription key is always sent to the email you provide. Not sure which to pick? Start with monthly and switch later.

Activating your subscription

After your order is placed, activate the license inside ConfigWorkbook using the subscription key from your Order List.

Check your Order List

Your new order appears here with its status and subscription key.

Open CWB Tool → Subscription Detail

From the App Launcher, open ConfigWorkbook, click the CWB Tool menu, then Subscription Detail.

CWB Tool menu with Subscription Detail option

Copy your subscription key

Copy the key from your Order List (looks like online-ca506b4b2d7cxxxxxxxx).

Copying the subscription key from the Order List

Paste the key and apply it

Under “Do you have a subscription key?”, paste it into the box and click Apply.

Entering the subscription key to activate the license

Verify activation

Check Subscription Detail to confirm the activation period and key validity. That's it — you're fully activated.

Support

Contact us

For help with installation, ordering, or activation, reach out any time:

support@cwbtool.com

Troubleshooting

Installation fails — check system requirements and that you have System Administrator permissions.
Can't activate a license — verify the subscription key was copied in full, with no extra spaces, and try again.
Performance issues — clear your browser cache and refresh your Salesforce session.