CPQ Integration Installation Guide 

This guide provides the necessary information to install and deploy the Chargebee for Salesforce CPQ integration successfully.

Installing the package 

The CPQ integration is delivered as a Chargebee managed package in Salesforce org. The integration package link, password, and Chargebee site details are shared securely when you sign up to use the integration.

To install the package, perform these steps:

1. Enter the package URL and the password.

   

2. Select the profile as Install for All Users or Install for Specific Profiles.

3. Click Install.

The installation could take a few minutes to complete. Once the installation is successful, the Chargebee for CPQ integration can be accessed from Salesforce apps.

Configuring the integration 

After installing the package, perform the post-installation configurations in Salesforce to use the CPQ integration.

Add Chargebee site(s) 

You can connect single or multiple Chargebee sites to the same Salesforce instance by setting up named credential  for those sites. A named credential is used to store authentication details of an external system. It specifies the URL of a callout endpoint and its required authentication parameters in one definition. While configuring the CPQ integration, the named credential stores authentication information to connect Chargebee.

To add sites, perform these steps:

1. From the integration page, click Add Site.
2. On the Named Credentials page, select New Named Credential.
3. Enter the Label and Name identical to the Chargebee domain.
4. Enter the URL of your Chargebee site.
5. Select Named Principal from the Identify Type dropdown list.
6. Select Password Authentication from the Authentication Protocol dropdown list.
7. Create an API key with full access on your Chargebee site and enter the key in Username.
8. Enter the password as Chargebee.
9. Select Generate Authorization Header and Allow Merge Fields in HTTP Header from Callout Options.
10. Click Save.

After setting up the named credential, click Validate available on the integration launch page to authenticate your connection. Following the validation of the connection, either a success or failure message appears.

Connect a price book with Chargebee site(s) 

When the Salesforce CPQ instance is connected to multiple Chargebee sites, it is necessary to specify which price book  is associated with which site, so that product changes and requirements are reflected in the appropriate site. There is a one-to-one relationship between a Salesforce price book and a Chargebee site.

To connect a price book, perform these steps:

1. In the Quick Find search box, enter 'price books', then select Price Books.
2. Create a custom price book .
3. Select the Chargebee site you want to associate with the price book from the Site dropdown menu.
4. Add a site for existing price books. Navigate to the Details tab of a price book and select a Site using the dropdown option. Ensure to add the Site field in the page layout .

Schedule price book entry batch process 

The price book contains a customized collection of products and their price list. When you create products in Salesforce, a batch process allows you to sync those price book  entries to Chargebee Item prices. This allows your sales personnel to effectively create subscriptions, charges, and more for those products in Chargebee from Salesforce.

To schedule the batch process, perform these steps:

1. Go to Developer Console.
2. Select Open Execute Annonymous window from Debug dropdown list.
3. Enter the following commands in the Apex Code window.
   • To schedule the batch Process to run every 15 minutes:chargebeecpq.PriceBookEntryBatchSync.scheduleJob();
   • To schedule the batch Process to run on custom intervals: String jobName = 'Your job name here'; String cronExpression ='Your cron expression here'; chargebeecpq.PriceBookEntryBatchSync.scheduleJob(jobName,cronExpression); For example,String jobName = 'job1';String cronExpression ='0 0 12 * * ?';chargebeecpq.PriceBookEntryBatchSync.scheduleJob(job1,0 0 12 * * ?);
4. Click Execute.

The debug Logs display the execution results.

Edit Chargebee site settings 

This setting allows you to customize the connected Chargebee site with your Salesforce account.

To configure custom settings for your Chargebee site, perform these steps:

1. Go to Setup, enter 'custom settings' in the Quick Find search box, then select Custom Settings.
2. From the Custom Settings list, select Chargebee Site Settings > Manage >New.
3. Enter Name and Chargebee Site ID.
4. Select the required custom settings checkbox if they are enabled for your Chargebee site. By default, Product Families is selected.
   

Assign permission sets 

You can assign permissions to users with administrators and standard user privileges based on the tasks they perform using the Chargebee for CPQ integration.

To assign permission sets, perform these steps:

1. Go to Setup, enter ‘permission sets' in the Quick Find search box, then select Permissions Sets.

2. On the Permission Sets page, select the required permission sets.

   • Select Chargebee Admin for admins.
   • Select Chargebee User for standard users.
     

3. Click Manage Assignments.

4. Click Add Assignments.

5. Select users and then click Assign.

Set up page layouts 

Configure page layouts  to add user interface elements for the following:

• Buttons for all Chargebee actions in Salesforce.
• Custom fields introduced by Chargebee for standard Salesforce CPQ objects

Subscription

To configure the subscription layout, perform these steps:

1. Go to Setup > Object Manager.
2. Select Subscription object and go to Page Layouts.
3. Edit Subscription Layout and add Chargebee ID, Chargebee Site ID, Send to Chargebee fields. For more information, see Edit Page Layouts  for Standard Objects.
4. Click Save.
   

Order Product

To configure the order product layout, perform these steps:

1. Go to Setup > Object Manager.
2. Select Order Product object and go to Page Layouts.
3. Edit Order Product Layout and add Chargebee Plan, Chargebee ID, Send to Chargebee fields.
4. Click Save.
   

Price book entry

To configure the price book entry layout, perform these steps:

1. Go to Setup > Object Manager.
2. Select the Price Book Entry object and go to Page Layouts.
3. Edit Price Book Entry Layout and add Chargebee ID, Chargebee Site ID, Send to Chargebee fields.
4. Click Save.
   

Product

To configure the product layout, perform these steps:

1. Go to Setup > Object Manager.
2. Select Product object and go to Page Layouts.
3. Edit Product Layout and add Chargebee Item, Chargebee ID, Chargebee Type, Billing Frequency fields.
4. Click Save.
   

Account

To configure the account layout, perform these steps:

1. Go to Setup > Object Manager.
2. Select Account object and go to Page Layouts.
3. Edit Account Layout and add Auto Collection, Net Term Days, Chargebee Billing Contact, Chargebee Primary Contact, Chargebee ID, Locale, and Chargebee Site ID fields.
4. Click Save.
   

Set up validation rules for Chargebee Type field 

Validation rules ensure that user-entered data meet certain standards before it can be saved. Defining validation rules lets the integration sync correct data.
To configure the validation rules for the Chargebee Type, perform these steps:

1. Go to Setup > Object Manager.
2. Select Product object and go to Validation Rules.
3. Click New.
4. Enter the Rule Name as Chargebee_Type_Required.
5. Select the Active checkbox.
6. Enter the Description as Chargebee Type is required when Subscription Pricing is set.
7. Enter the Error Condition Formula as AND(NOT(ISBLANK(TEXT(SBQQ__SubscriptionPricing__c))),ISBLANK(TEXT(chargebeecpq__Chargebee_Type__c))).
8. Enter the Error Message as Chargebee Type is required when Subscription Pricing is set.
9. Select the Error Location as Field and set the field as Chargebee Type.
10. Click Save.