Salesforce Installation Guide

Salesforce Installation Guide Version 1.30

Salesforce Professional, Enterprise, Performance, Unlimited, and Developer Editions all integrate with CCAI Platform.

(The Essentials version of Salesforce is not supported).

Support for Salesforce Classic & Lightning

Installation link: Salesforce Enterprise 1.30

Installation Steps

The Agent Adapter installed in Salesforce allows agents to take calls and chats directly in a Salesforce Organization (Org). Versions after 1.17 support both Classic Experience and Lightning Experience.

The installation consists of 7 Steps:

  1. Locate Org ID and Org Name and Add to the Portal

  2. Install the App in Salesforce

  3. Enter Connected App Consumer Key and Secret into Portal

  4. Create a Connected App

  5. Place Connected App Consumer Key and Secret in the Portal

  6. Manage the Configuration in Salesforce

  7. Manage the Call Center

Data required to perform installation

Field Name

Where to Find

Where to Enter

Organization Id

Salesforce

Developer Settings in Portal

Organization Name

Salesforce

Developer Settings in Portal

Connected App Consumer Key

Salesforce

Developer Settings in Portal

Connected App Consumer Secret

Salesforce

Developer Settings in Portal

Tenant name

Admin Portal

<companyName>.<domain>

Custom Settings in SFDC

Customer Key

Developer Settings

Custom Settings in SFDC

Secret

Developer Settings

Custom Settings in SFDC

Connected App

Salesforce Connected App

Custom Settings in SFDC
Step 1: Locate Org ID and Org Name and Add to the Portal

In this section, you will set up an initial connection between the CCAI Platform Portal and Salesforce by finding the required org information and adding it into the CCAI Platform Portal.

Prerequisites:

  • Access to the Company Information page within Salesforce.

  • User with Admin role assigned in the Portal to access Developer Settings

  1. In Salesforce, go to Setup > Settings > Company Settings > Company Information.

    ::: tip Use the Quick Find search box in Salesforce Settings to quickly navigate to various pages throughout this configuration. :::

  2. Locate the Salesforce.com Organization Name and Organization ID in Company Information.

  3. Copy both values.

  4. In another browser tab, open the CCAI Platform Portal.

  5. Go to Settings > Developer Settings > CRM > Agent Platform.

  6. Select Salesforce.

  7. Locate the Salesforce Organization ID and Salesforce Organization Name fields.

  8. Enter the Salesforce Organization ID into the Salesforce Organization ID field and the Salesforce Organization Name into the Salesforce Organization Name field.

  9. Click Save.

Step 2: Install the App in Salesforce
Prerequisite
  • Salesforce user must have privileges to install packages into an Organization.

  1. Retrieve the Package Installation link here.

  2. Log in to Salesforce if prompted to do so.

  3. Select Install for All Users.

  4. Select Install (or Upgrade if your Org used a previous version). This may take a few minutes.

  5. Once the installation is complete, click Done.

    To verify the package installation in Salesforce, go to Platform Tools > Apps > Packaging > Installed Packages.

Step 3: Create a Custom Permission Set and Apply to All Agents

In this section, you will create a custom permission set (with the minimum requirements needed for integration), update it with case and contact permissions, and apply it to all agents who use the CCAI Platform Portal.

Prerequisites

  • User must be a Salesforce Admin to configure this section.

  • A list of agents who will be using the adapter in Salesforce.

Steps

  1. In Salesforce, go to Administration > Users > Permission Sets.

  2. Locate the CC_Agent Permission Set and click the Clone link.

  3. Rename the cloned Permission Set and click Save. For example Company_Agent_Clone.

  4. From the Permission Sets screen, click on the name of the new cloned Permission Set.

  5. Click Object Settings, in the Apps section.

  6. Configure the Object Settings for Accounts, Cases, Contacts, and Leads using the table below:

    Object Read Create Edit Delete View All Modify All
    Cases X X X X
    Contacts X X X X
    Accounts X X X X
    Leads X X X X

  7. To configure these settings, click on the Object Name. Click Edit (at the top).

  8. Use the checkboxes in the Object Permissions section to enable each of the required permissions (Read, Create, Edit, and View All).

  9. Click Save.

  10. Repeat these steps for each of the four objects (Accounts, Cases, Contacts, and Leads).

  11. Configure the Tasks object's Type field permission.

    ::: note Skip this step if using the CCAI Platform Session object. :::

    Object Field Read Access Edit Access
    Tasks Type X X

  12. Once all configurations are done, click Manage Assignments.

  13. Click the Add Assignments button.

  14. Use the checkboxes to select the desired users, then click Assign.

Step 4: Create a Connected App

Create a Connected App in Salesforce, a required step for app version 1.15 and later.

A Connected App is an OAuth application that allows the CCAI Platform Portal to communicate with Salesforce.

Prerequisites
  • Copy your Portal URL. It should follow this structure: https://<tenant&>.<domain>.

  1. In Salesforce, go to Setup > Apps > App Manager.

  2. Click the New Connected App button.

  3. Update the Basic Information fields with the contents below:

    ::: note Make a note of your Connected App Name as you will need it in Step 6. :::

    Field Name Field Value
    Connected App Name UJET_Connected_App
    API Name UJET_Connected_App
    Contact Email <your email>

  4. Under API (Enable OAuth Settings), select the Enable OAuth Settings checkbox and update the settings using the table below:

    Field Name

    Field Value

    Enable OAuth Settings

    Selected (TRUE)

    Callback URL

    https://<tenant>.<domain>/v1/salesforce/oauth_callback

    Selected OAuth Scopes

    Access the identity URL service (id, profile, email, address, phone)

    Manage user data via APIs (API)

    Perform requests at any time (refresh_token, offline_access)

    Required Secret for web flow

    Selected (TRUE)

    Require Secret for Refresh Token flow.

    Selected (TRUE)

  5. Under the Canvas App Settings, update the settings with the following:

    Field Name

    Field Value

    Canvas

    Selected (TRUE)

    Canvas App URL

    https://<tenant>.<domain>/v1/salesforce/start

    Access Method

    Signed Request (POST)

    Locations

    Console

    Lightning Component

    Open CTI

    Visualforce Page

  6. Scroll to the bottom of the page and click Save.

  7. Click Continue to dismiss the confirmation message and wait for the Connected App to be created.

    ::: note It can take up to 10 minutes for the Connected App to be created. If your app is not displayed in Step 10, wait a few minutes and try again. :::

  8. Go to Setup > Apps > Connected Apps > Manage Connected Apps.

  9. Click the name of the app from the Connected Apps screen.

  10. Click Manage.

  11. Click the Edit Policies button.

  12. Under OAuth policies, select the Admin approved users are pre-authorized option from the Permitted Users dropdown:

  13. Click Save at the bottom of the page to return to the Manage screen for the Connected App.

  14. Scroll down to the Profiles section and click Manage Profiles.

  15. On the Application Assignment Profile screen, select the profile options your company will use, such as the System Administrator or another profile an agent may use.

    In this example, we are selecting Standard User and System Administrator:

  16. Click Save to return to the manage connected app view.

    A Connected App has been created.To verify the connected app was created, check if the app is listed in Settings > Apps > App Manager.

Step 5: Enter Connected App Consumer Key and Secret into Admin Portal

Enter client_id key and Secret into the Salesforce Admin Portal.

Prerequisites

  • Finish the steps in the Create a Connected App section above.

  • User must have access to the email address associated with Salesforce user account to receive an identity verification email.

  • Must be an Admin user in the CCAI Platform Portal

  1. Go to Setup > Create > Apps > Connected Apps and find your Connected App.

  2. Click on the arrow to the far right of the row.

  3. Click View.

  4. Click Manage Consumer Details.

  5. Verify your identity by entering the verification code sent to your email address.

  6. Copy the Consumer Key and Consumer Secret values displayed.

  7. Paste the Consumer Key from Salesforce into the Connected APP Consumer Key field.

  8. In the CCAI Platform Portal, go to Settings > Developer Settings and locate the Connected App Consumer Key and Connected App Secret fields.

  9. Paste the Consumer Secret into the Connected APP Consumer Secret field.

  10. Paste the Consumer Key from Salesforce into the Connected APP Consumer Key field.

  11. Click Save.

    The Connected App information has been added to the CCAI Platform Portal.

Step 6: Manage the Configuration in Salesforce

Configure App version 1.22 and later.

Prerequisites

  • App version for Salesforce 1.22 or later is installed for the Salesforce Org.

  • Get your company's Company Key and Company Secret Code in the Admin Portal by going to Settings > Developer Settings.

  • Connected App is created (see the Create a Connected App section above).

  1. In Salesforce, go to Setup > Apps > Packaging > Installed Packages.

  2. Locate the CC_Agent_App and click the Configure.

  3. On the new tab that opens, click Add New Configuration.

  4. Complete the fields using the following values:

    Field Name

    Field Value

    Location for Field

    Setup Owner

    Organization or Profile

    If you want to set organizational level settings, select Organization. If you want to add profile level settings, select Profile. If you select Profile you can choose a profile for the settings to be applied to.

    Organization

    Your organization name displays here and is read only.

    Profile

    Your profile list displays here and you can choose a Profile if you selected Profile for Setup Owner.

    CompanyKey

    Company Key

    CCAI Platform Portal > Settings > Developer Settings

    CompanySecret

    Company Secret

    CCAI Platform Portal > Settings > Developer Settings

    Tenant

    Tenant Name

    In CCAI Platform Portal:

    https://<tenant>.<domain>

    Only enter the <tenant> portion of the Portal URL in this field.

    Note: This field has a 100 char limit.

    ConnectedApp

    Connected App API name

    Match the name in Create a Connected App (such as UJET_Connected_App)

  5. If you select Profile from the Setup Owner dropdown, you can select a profile that will be applied to this new configuration. If Organization was selected from Setup Owner, the Profile field is disabled.

  6. Click Save Configuration and you are returned to the list screen and the stored values display.

    If you want to add a new configuration, click Add New Configuration. If you do not want to add another configuration then you can close this window.

  7. Once the configuration is completed, close the browser window.

Step 7: Manage the Call Center

Configure a Call Center in Salesforce to give agents access to the adapter.

Prerequisites

  1. In Salesforce go to Setup > Feature Settings > Service > Call Center > Call Centers.

  2. Locate and click the Call Center titled Softphone_v2.

  3. Click Manage Call Center Users.

  4. Click Add More Users.

  5. Use the filter fields to search for specific users and then click Find. To view all users, click Find.

  6. Use the checkboxes in the search results to select the users that will use the Portal.

  7. Click Add to Call Center.

    To verify the result, go to Call Center and see that the users are listed.

After Installation

Set up the console for Salesforce Classic or Salesforce Lightning:

Console setup for Salesforce Classic

Console setup for Salesforce Lighting

Console setup for Salesforce Classic

Configure the Console App to use the adapter in the Salesforce Classic Experience.

Prerequisites

  • Complete Salesforce installation

  • Organization is configured to use Salesforce Classic experience.

Steps

  1. In Salesforce, go to Setup > Build > Create > Apps.

  2. On the Apps screen, locate the Sample Console and click Edit.

  3. To edit the Sample Console, scroll down to the Choose Console Components field and select the UJET_Chat component from the Available Items list.

  4. Click Add to move the component to the Selected Items list.

  5. Scroll down to the Assign to Profiles section and select the checkboxes for the profiles with the permission set that you configured in Section 3 above.

  6. Click Save.

  7. Verify the adapter is shown in the Console as expected:

    Use the app selector in the Sales menu at the top right corner of the screen to select Sample Console:

Result

Salesforce is set up in Salesforce Classic Console.

Console setup for Salesforce Lightning

Configure the Console App to use the adapter in the Salesforce Lightning Experience.

Prerequisites

  • Organization uses the Lightning Experience.

  • Must have System Administrator profile or be a user who can manage Apps.

  • Domain deployment for user with Salesforce is completed.

Steps

  1. In Salesforce go to Setup > Apps > App Manager.

  2. Locate the Sales and/or Service Console app that has Lightning in the App Type column.

  3. Click the arrow dropdown at the far right and select Edit.

  4. Click Utility Items from the App Settings menu on the left.

  5. Click Add Utility Item and select the Open CTI Softphone option.

  6. Configure the Label field as desired.

  7. Click Add Utility Item again and select ChatComponent in the Custom- Managed section.

  8. Update the Label as needed.

  9. Configure the Icon as needed.

  10. Click Save.

  11. Repeat Steps 2-10 if installing additional Lightning console apps.

The utility bar has been configured with the components. To confirm that Salesforce is set up with the Lightning Experience, check the utility bar in the console.

Version History

1.30

Increased UJET_Config.tenant field's size to 100

1.29

Renamed package to "CC_Agent_App"

1.28

  • Removed branding from Chat/SMS components in Classic/Lightning Application Toolbar.

  • Added configurable labels/icons for Chat/SMS components in Lightning Application.

1.27
  • Added UJET__Recording_Permission__c in UJET__Session__c object
1.26
  • Added UJET__Opportunity__c in UJET__Session__c object
1.24
  • Updated process for credential configuration in Salesforce post-installation
1.20
  • Added UJET__Feedback_Text__c field in UJET__Session__c object
1.18
  • Added Lead object support
1.17

  • Added Custom CCAI Platform Objects

    • Session

    • Action

    • Transfer

  • Added UJET__Email__c custom field in Account object

1.15

  • Added support for Salesforce Lightning

  • Added Call Center Version 2

  • Added customer-created connected application

  • Added Custom Settings

  • Bug fixes

1.13

  • Call Center Version 1

  • Salesforce Classic Support