Salesforce.com Integration Guide

Bright Pattern Documentation

Generated: 8/11/2022 3:25 am
Content is available under license unless otherwise noted.

Purpose

The Bright Pattern Contact Center Salesforce.com Integration Guide provides detailed instructions for setting up your Bright Pattern Contact Center solution to function in an integrated manner with your Salesforce.com (SFDC) applications. Integration configuration provides your contact center with single agent sign-on, SFDC-data-driven interaction routing, screen pop, activity history, and click-to-call functions.



Audience

This Salesforce Integration Guide is intended for the IT/technical personnel responsible for the data infrastructure of the contact centers that use Bright Pattern Contact Center solutions for customer interaction processing and the Salesforce.com (SFDC) solution for customer relationship management. Readers of this guide are expected to have expertise and experience in administration of these systems as well as a solid understanding of contact center operations and resources that are involved in such operations.



Integration Scope

Salesforce.com (SFDC) integration provides the following functions for your contact center:


Sfdc-integration-guide-image3.png



Sfdc-integration-guide-image4.jpeg



Sfdc-integration-guide-image5.png





Prerequisites

To deploy the managed app in a Salesforce.com (SFDC) environment, you must have “Production” level login credentials. To verify the “Production” level credentials for proper permissions, login with your existing credentials to the Salesforce login.

Note: If you are unable to log into Salesforce.com directly, please contact your SFDC system administrator to review permission and access level settings.

For most types of integration described in this guide, Bright Pattern Contact Center version 3.6 or later is required. For import of calling lists and export of campaign results, Bright Pattern Contact Center version 3.10 or later is required.


< Previous | Next >

Importing a Call Center Definition File

To configure a call center in Salesforce, you will need to define it using a call center definition file. Call center definition files are used to support the integration of the Salesforce CRM Call Center with multiple CTI vendors. The first instance of a call center record for a particular CTI adapter must be defined by importing the adapter’s call center definition file.

How to Import the File in Salesforce Lightning

The following instructions are relevant only if you are using Salesforce Lightning.

Step 1: Set up your call centers

  1. Go to Salesforce Lightning's Setup view. A new tab will open.

    Select Setup view


  2. Go to Platform Tools > Feature Settings > Service > Call Center > Call Centers. Note that it is possible to have multiple call centers in Salesforce. Existing call centers are listed on the Call Centers page.

    Setup > Call Centers


Step 2: Copy call definition file

Be sure to upload the following XML.

This call definition file includes item muteRecordingUrls, which automatically mutes call recordings and pauses agents' screen recordings when those pages are visited. The muteRecordingUrls feature helps your contact center to be compliant when agents are receiving sensitive data (e.g., credit card numbers).

Also included is item reqSalesforceCompatibilityMode, provides compatibility with Salesforce Lightning; without this item, Bright Pattern integration will not work in Salesforce Lightning.


<callCenter>

<section sortOrder="0" name="reqGeneralInfo" label="General information">
<item sortOrder="0" name="reqInternalName" label="Internal name">CSIMIntegration</item>
<item sortOrder="1" name="reqDisplayName" label="Display name">CSIM Integration</item>
<item sortOrder="2" name="reqAdapterUrl" label="Agent Desktop URL"></item>
<item sortOrder="3" name="reqUseApi" label="Use CTI API">true</item>
<item sortOrder="4" name="reqSoftphoneHeight" label="Softphone height">300</item>
<item sortOrder="5" name="reqSoftphoneWidth" label="Softphone width">500</item>
<item sortOrder="6" name="custTenantUrl" label="Tenant URL (if different from AD URL)">example.com</item>
<item sortOrder="7" name="muteRecordingUrls" label="Mute Recording Urls"></item>
<item sortOrder="8" name="reqSalesforceCompatibilityMode" label="Salesforce Compatibility 
Mode">Lightning</item>
</section>

<section sortOrder="1" name="reqDialingOptions" label="Dialing Options">
<item sortOrder="0" name="reqOutsidePrefix" label="Outside Prefix">9</item>
<item sortOrder="1" name="reqLongDistPrefix" label="Long Distance Prefix">1</item>
<item sortOrder="2" name="reqInternationalPrefix" label="International Prefix">011</item>
</section>

</callCenter>


Step 3: Import the file to your call center

  1. Select the desired call center from the list (e.g., "BrightPattern Integration").

  2. Click the Import button.

  3. Click Choose file to select the definition file.

  4. Click Import again.


Importing a call center definition


Note that if the import does not work, it could be because you already have a call center of the same type configured. To get the call definition file imported properly, you may need to change the original internal name of your call center (e.g., "CSIMIntegration") to a different name. See reqInternalName in the call definition file above.

After you've imported the definition file to your call center, you will see the Call Center Detail page.


Call Center Detail


How to Import the File in Salesforce Classic

The following instructions are relevant only if you are using Salesforce Classic.

Step 1: Set up your call centers

In Salesforce Classic's Setup view, go to Build > Customize > Call Center > Call Centers.

Note that it is possible to have multiple call centers in Salesforce. Existing call centers are listed on the Call Centers page.

Call Centers


Step 2: Copy call definition file

Be sure to upload the following XML.

This call definition file includes item muteRecordingUrls, which automatically mutes call recordings and pauses agents' screen recordings when those pages are visited. The muteRecordingUrls feature helps your contact center to be compliant when agents are receiving sensitive data (e.g., credit card numbers).


<callCenter>

<section sortOrder="0" name="reqGeneralInfo" label="General information">
<item sortOrder="0" name="reqInternalName" label="Internal name">CSIMIntegration</item>
<item sortOrder="1" name="reqDisplayName" label="Display name">CSIM Integration</item>
<item sortOrder="2" name="reqAdapterUrl" label="Agent Desktop URL"></item>
<item sortOrder="3" name="reqUseApi" label="Use CTI API">true</item>
<item sortOrder="4" name="reqSoftphoneHeight" label="Softphone height">300</item>
<item sortOrder="5" name="reqSoftphoneWidth" label="Softphone width">500</item>
<item sortOrder="6" name="custTenantUrl" label="Tenant URL (if different from AD URL)">example.com</item>
<item sortOrder="7" name="muteRecordingUrls" label="Mute Recording Urls"></item>
</section>

<section sortOrder="1" name="reqDialingOptions" label="Dialing Options">
<item sortOrder="0" name="reqOutsidePrefix" label="Outside Prefix">9</item>
<item sortOrder="1" name="reqLongDistPrefix" label="Long Distance Prefix">1</item>
<item sortOrder="2" name="reqInternationalPrefix" label="International Prefix">011</item>
</section>


</callCenter>


Step 3: Import the file to your call center

  1. Select the desired call center from the list (e.g., "BrightPattern Integration").

  2. Click the Import button.

  3. Click Choose file to select the definition file.

  4. Click Import again.


Importing a call center definition


Note that if the import does not work, it could be because you already have a call center of the same type configured. To get the call definition file imported properly, you may need to change the original internal name of your call center (e.g., "CSIMIntegration") to a different name. See reqInternalName in the call definition file above.

After you've imported the definition file to your call center, you will see the Call Center Detail page.


Call Center Detail




Installing a Managed Package

To get started on configuring Salesforce integration, you must install a managed package. Installation can be performed by developers in either a sandbox or production environment with proper permissions.

Before you begin installing anything, make sure you have registered and created a Salesforce developer account. You can do that at salesforce.com.


How to Install the Managed App

  1. Go to the Salesforce AppExchange and get the BrightPattern Contact Center Integration app.

    Salesforce App Exchange


  2. At the bottom of the page, click Get It Now.

  3. In the dialog that pops up, log in with your Salesforce credentials for your Salesforce developer account. (If you do not already have a developer account, now is the time to create and register one.)

    You will be prompted to log in to your Salesforce developer account


  4. Select either Install in Production or Install in Sandbox. Then in the Confirm Installation Details dialog, agree to the terms and click Confirm and Install.
    Choose where to install it




< Previous | Next >

Configuring Call Center Parameters

After you have defined your call center and installed your managed package, set up the call center parameters that will enable integration with Bright Pattern Contact Center. Note that throughout this guide, configuration instructions are shown for both Salesforce Lightning and Salesforce Classic, where applicable.


Configuration in Salesforce Lightning

Step 1: Manage your call centers in Salesforce

  1. In Salesforce Lightning view, navigate to Setup.

  2. Go to Feature Settings > Service > Call Center > Call Centers and click on your call center (i.e., "BrightPattern"). The Call Center Detail page will open.

  3. If the Introducing Salesforce CRM Call Center splash page appears, click Continue.


Step 2: Edit call center properties

  1. On the Call Center Detail page, click Edit at the top of the list. The Call Center Edit page opens.

    Call Center Edit

  2. The most important property to edit is the Agent Desktop URL. In the Agent Desktop URL field, change the URL to the following:
    https://<host>:<port>/agentdesktop/Lightning.jsp?enableSFOpenCTI=1&sflogin=1

    Make sure to replace <host> with your host name and <port> with your port number. For example, in Salesforce Lightning, your URL might be:
    https://tobias_vm:8443/agentdesktop/Lightning.jsp?enableSFOpenCTI=1&sflogin=1

  3. Leave everything else about the URL the same.

  4. Optional: Adjust the size of the Agent Desktop call widget that appears on Salesforce on either the homepage (in Classic view) or on every page (in Lightning view). You adjust the size by replacing the default values of the Softphone height and Softphone width fields. The default size is 300 (W) x 500 (H). Note that if the size is too small, the Agent Desktop call widget will appear truncated.

  5. Click Save.


Step 3: Update your tenant access URL details if you have multiple call centers

If you have multiple tenants (i.e., call centers), you should update your tenant access URL information for the particular call center you are configuring.

  1. On the Call Center Detail page, modify the following Agent Desktop URL by replacing

    <tenant-name>.<service-provider-domain-name>

    with your Bright Pattern Contact Center tenant access URL (refer to the example below, noting that this URL changes based on the version of Salesforce that you are using):

    https://<tenant-name>.<service-provider-domain-name>/agentdesktop?enableSFOpenCTI=1&sflogin=1&apexClass=BrightPattern.CSIMIntegration

  2. Example: https://demo.brightpattern.com/agentdesktop?enableSFOpenCTI=1&sflogin=1&apexClass=BrightPattern.CSIMIntegration

  3. Modify the Tenant URL by replacing example.com with your fully qualified tenant URL (e.g., example.brightpattern.com).
  4. Click Save.


Step 4: Enable your identity provider

For Salesforce Lightning view, you should enable your identity provider early on in your integration configuration. Once you complete this step, you will not have to do it again. Enabling the identity provider is necessary for enabling single sign-on in the next section of this guide.

  1. In Salesforce.com, go to Setup and, in the search box, type Identity Provider. Select this option when it appears in the search list.

    Type "Identity Provider" and select it from the search list


  2. Click on Enable Identity Provider.

  3. In Identity Provider Setup, select the actual certificate to be used. If no certificates are shown, you should either create a new self-signed certificate or import a certificate from your setup. For more information, see section How to Add the Certificate.

    Select the certificate


  4. Use the download certificate button if the certificate was previously downloaded.

    You may need to click "Download Certificate"


Step 5: Edit the BrightPattern Integration app settings

  1. Go to Platform Tools > Connected Apps > Manage Connected Apps.

  2. Click BrightPattern in the list of connected apps. This is one of the apps deployed with the package.


Select BrightPattern from the list of connected apps


Step 6: Check phone number prefixes

  1. Log in to Bright Pattern's Contact Center Administrator application.

  2. Make sure that Outside Prefix is set accordingly to the current Dial-out entry in the Bright Pattern Contact Center Administrator application. This prefix will be added by Salesforce to any number that will be dialed using the “Click-To-Call” feature. For more information on prefixes, see the Contact Center Administrator Guide, section Dial-Out Entries.


Contact Center Administrator > Dial-Out Entries


Step 7: Assign Salesforce.com (SFDC) users to the call center

  1. Go to Platform Tools > Feature Settings > Service > Call Center > Call Centers and click the name of your call center.

  2. Click the Manage Call Center Users button at the bottom of the page.

    Manage Call Center Users


  3. Select the name of the call center to which you want to assign users.

  4. In the Call Center Users related list, click Manage Call Center Users.

  5. On the Manage Users page, click Add More Users.

    Add more users


  6. Specify criteria to find the users who should be assigned to the call center.

    Find users to assign to the call center


  7. Click Find. Note that all users who already belong to a call center will be excluded from the search results because a user can be assigned to one call center at a time only.

  8. Select the checkbox next to each user who should be assigned to the call center. At the bottom of the screen, click Add to Call Center.


Note: To reassign a user to another call center, first remove this user from the currently assigned call center and then add the user to the desired call center. You can view the currently assigned call center in the User Detail page.


Step 8: Confirm that the new call center is correct

  1. Log out of Salesforce and log in again. This step is always required when changing the Agent Desktop URL in call center settings.
  2. Return to the newly created call center. You should see the Agent Desktop widget as shown on every page within Salesforce.


Salesforce Lightning with Agent Desktop widget


Configuration in Salesforce Classic

Step 1: Manage your call centers in Salesforce

  1. In Salesforce Classic view, navigate to Setup.

  2. Go to Build > Call Center > Call Centers and then select BrightPattern from the list. This is the call center you just installed.

    All Call Centers


  3. If the Introducing Salesforce CRM Call Center splash page appears, click Continue. The Call Center Detail page will open.


Step 2: Edit call center properties

  1. On the Call Center Detail page, click Edit. The Call Center Detail page opens.

    Edit call center details


  2. The most important property to edit is the ACS URL. This is the URL of your Bright Pattern Contact Center Agent Desktop. In the ACS URL field, modify the following Bright Pattern Contact Center Agent Desktop URL by replacing <tenant-name>.<service-provider-domain-name> with your Bright Pattern Contact Center tenant access URL (refer to the example):

    https://<tenant-name>.<service-provider-domain-name>/agentdesktop/SalesCloud.jsp?enableSFOpenCTI=1&sflogin=1&version=2

    Example: https://demo.brightpattern.com/agentdesktop/SalesCloud.jsp?enableSFOpenCTI=1&sflogin=1&version=2

  3. Leave everything else about the URL the same.

  4. Optional: Adjust the size of the Agent Desktop call widget that appears on Salesforce on either the homepage (in Classic view) or on every page (in Lightning view). You adjust the size by replacing the default values of the Softphone height and Softphone width fields. The default size is 300 (W) x 500 (H). Note that if the size is too small, the Agent Desktop call widget will appear truncated.

  5. Click Save.


Step 3: Update your tenant access URL details if you have multiple call centers

If you have multiple tenants (i.e., call centers), you should update your tenant access URL information for the particular call center you are configuring.

  1. On the Call Center Detail page, modify the following Agent Desktop URL by replacing

    <tenant-name>.<service-provider-domain-name>

    with your Bright Pattern Contact Center tenant access URL (refer to the example below, noting that this URL changes based on the version of Salesforce that you are using):

    https://<tenant-name>.<service-provider-domain-name>/agentdesktop?enableSFOpenCTI=1&sflogin=1&apexClass=BrightPattern.CSIMIntegration

  2. Example: https://demo.brightpattern.com/agentdesktop?enableSFOpenCTI=1&sflogin=1&apexClass=BrightPattern.CSIMIntegration

  3. Modify the Tenant URL by replacing example.com with your fully qualified tenant URL (e.g., example.brightpattern.com).
  4. Click Save.


Step 4: Edit the BrightPattern Integration app

  1. Go to Administer > Manage Apps > Connected Apps.

  2. Click BrightPattern in the list of connected apps. This is one of the apps deployed with the package. The Connected App Detail page opens.


Connected App Detail page


Step 5: Check phone number prefixes

  1. Log in to Bright Pattern's Contact Center Administrator application.

  2. Make sure that Outside Prefix is set accordingly to the current Dial-out entry in the Bright Pattern Contact Center Administrator application. This prefix will be added by Salesforce to any number that will be dialed using the “Click-To-Call” feature. For more information on prefixes, see the Contact Center Administrator Guide, section Dial-Out Entries.


Contact Center Administrator > Dial-Out Entries


Step 6: Assign Salesforce.com (SFDC) users to the call center

  1. Go to Setup > Customize > Call Center > Call Centers.

  2. On the All Call Center Users page, select the name of the call center to which you want to assign users.

  3. In the Call Center Detail page , under Call Center Users click Manage Call Center Users.

    Manage Call Center Users


  4. Click Add More Users.

    Add More Users


  5. Specify criteria to find the users who should be assigned to the call center.

    Select users


  6. Click Find. Note that all users who already belong to a call center will be excluded from the search results because a user can be assigned to one call center at a time only.

  7. Select the checkbox next to each user who should be assigned to the call center, and click Add to Call Center.


Note: To reassign a user to another call center, first remove this user from the currently assigned call center and then add the user to the desired call center. You can view the currently assigned call center in the “User” detail page.


Step 7: Confirm that the new call center is correct

Return to the newly created call center. You should see the Agent Desktop widget as shown on every page within Salesforce.



< Previous | Next >

Enabling Single Sign-On

Single Sign-on (SSO) functionality allows call center users to log in to Salesforce and Bright Pattern Contact Center applications simultaneously from a single login. The following instructions pertain to either Salesforce Lightning or Salesforce Classic views.

SSO in Salesforce Lightning

Step 1: Enable and deploy the domain

  1. From Salesforce.com, enable the organizational domain. Note that registration of the domain may take up to 24 hours. For more information, refer to Salesforce Help.

  2. Deploy the domain to assigned users.

  3. All users must log in using this domain URL, which should be in the following format: https://<your-domain-name>.my.salesforce.com/


Step 2: Customize the connected app

  1. In Salesforce Lightning, click the Edit Policies button at the top of the Connected App Detail page.

  2. Navigate to Platform Tools > Apps > Connected Apps > Manage Connected Apps and then select BrightPattern from the list of connected apps.

  3. Edit the following App settings:
    1. IP Relaxation - Relax IP restrictions
    2. Refresh Token Policy - Refresh token is valid until revoked
    3. ACS URL - https://<your-ServicePattern-tenant-URL>/agentdesktop/agentdesktop/sfsso/response

  4. Click Save.


Sfdc-integration-guide-image8.png


Step 3: Configure user profiles and field mapping (login mapping – custom attribute)

SFDC Single Sign-On integration requires user profiles assigned for users that are going to utilize Bright Pattern Contact Center to be authenticated by the SFDC Identity Provider. The following process maps the Single Sign-On parameters to the Bright Pattern Contact Center login ID.

  1. Navigate to Administration Setup > Manage Apps > Connected Apps, and select BrightPattern.

  2. Scroll down to Custom Attributes and click edit.

  3. In the Update Custom Attribute page that opens, specify the Attribute key and Attribute value as shown.

    Sfdc-integration-guide-image9.png



Bright Pattern Contact Center uses one optional custom service provider “Attribute key”: CSIMLoginID. This Attribute could be matched with any user’s field. By default, it is configured to match the SFDC user nickname ($User.CommunityNickname).

Note: If this attribute mapping is removed and no other attribute is specified, then the login ID will be taken as part of the SFDC username before the '@' sign.


Step 4: Set up Single Sign-On integration with Bright Pattern Contact Center

Single Sign-On functionality enables you to log in to only your integration account to use your integrated Salesforce Agent Desktop interface. Bright Pattern Contact Center integration account configuration requires the full SFDC URL (starting with <your-salesforce-domain>...) for use in the Call Center configuration integration accounts. This URL is available via the SFDC browser by right-clicking on the URL and choosing Copy Link Address as required.

New integration accounts are added in the Contact Center Administrator application. For more information, see the Contact Center Administrator Guide section Integration Accounts.

To create a new integration account, follow these steps:

  1. In a new browser tab, log in to the Bright Pattern Contact Center Administrator application. Keep this application open. You will be going back and forth between this application and Salesforce.com.

  2. From the main menu, under Call Center Configuration, select Integration Accounts.

  3. Click + at the bottom of the screen to add a new integration account.

    Add Salesforce.com integration account

You will be editing the following integration account properties with the information from Salesforce:


How to Add the Certificate

Before you can add the certificate, you have to ensure that there is one.

Note: In case you have multiple certificates, you must choose the certificate you want to use as the Idp Certificate on the App Settings page.

  1. In Salesforce.com, go to Settings > Security > Certificate and Key Management.

    Certificate and Key Management


  2. If you see no certificates listed, then either create a new self-signed certificate or import a certificate from your setup.

  3. To import, click the Import from Keystore button. Any certificates you import will be shown in the Idp Certificate field on the Connected App Edit page.

    IDP certificate shown


  4. In addition, you need a domain name for your call center. The domain is what you will add to your Salesforce integration account property Url. In Salesforce.com, go to Settings > My Domain to create one.

  5. Still in Salesforce.com, click Setup in the main menu at the top of the screen.

  6. Then go to Security > Certificate and Key Management.

  7. Select the certificate desired (or import a certificate). Note that you may have multiple certificates shown.

  8. Click Download Certificate.

  9. Open the downloaded file in Notepad (or Notepad ++) and copy the certificate content only (i.e., the text between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----).

    Sfdc-integration-guide-image11.png


  10. Go back to the Contact Center Administrator application and paste the certificate into the Salesforce integration account properties. Paste by clicking paste under Single Sign-on > Identity provider certificate.

  11. In the Set Identity Provider certificate dialog, click Set. This pastes in the certificate.


Step 5: Provide the identity provider initiated login URL

  1. Go back to Salesforce.com. Navigate to Platform Tools > Apps > Connected Apps > Manage Connected Apps.

  2. Click Connected Apps and select the App created earlier (i.e., "BrightPattern").

  3. Under section SAML Login Information, copy the full URL from the Idp-initiated Login URL. (Copy the URL by using the Copy/Paste menu; it will be automatically prefixed with the domain URL as created earlier (e.g., https://<your-sf-domain>.salesforce.com...).

    SFDC-SAML-Login-50.PNG


  4. Paste the copied login URL (full URL) into the Salesforce integration account properties on Bright Pattern Contact Center, and click Apply.

    Saleforce.com integration account properties



SSO in Salesforce Classic

Step 1: Enable and deploy the domain

  1. From Salesforce.com, enable the organizational domain. Note that registration of the domain may take up to 24 hours. For more information, refer to Salesforce Help.

  2. Deploy the domain to assigned users.

  3. All users must log in using this domain URL, which should be in the following format: https://<your-domain-name>.my.salesforce.com/


Step 2: Customize the connected app

  1. In Salesforce Classic, go to Setup.
  2. Navigate to Administration Setup > Manage Apps > Connected Apps and then select BrightPattern from the list of connected apps.

    Connected Apps


  3. On the Connected App Detail page that opens, click Edit Policies.

    Connected App Detail


  4. Edit the following App settings:
    1. IP Relaxation - Relax IP restrictions
    2. Refresh Token Policy - Refresh token is valid until revoked
    3. ACS URL - https://<your-ServicePattern-tenant-URL>/agentdesktop/agentdesktop/sfsso/response

  5. Click Save.


Sfdc-integration-guide-image8.png

Step 3: Configure user profiles and field mapping (login mapping – custom attribute)

The SFDC Single Sign-On integration requires user profiles assigned for users that are going to utilize Bright Pattern Contact Center to be authenticated by the SFDC Identity Provider. The following process maps the Single Sign-On parameters to the Bright Pattern Contact Center login ID.

  1. Go back to Administer > Manage Apps > Connected Apps, and select BrightPattern to get to the Connected App Detail page.

  2. Scroll down to Custom Attributes and click Edit.

    Edit custom attributes


  3. In the Update Custom Attribute page that opens, specify the Attribute key and Attribute value as shown.

    Sfdc-integration-guide-image9.png



Bright Pattern Contact Center uses one optional custom service provider “Attribute key”: CSIMLoginID. This Attribute could be matched with any user’s field. By default, it is configured to match the SFDC user nickname ($User.CommunityNickname).

Note: If this attribute mapping is removed and no other attribute is specified, then the login ID will be taken as part of the SFDC username before the '@' sign.


Step 4: Set up Single Sign-On integration with Bright Pattern Contact Center

Single Sign-On functionality enables you to log in to only your integration account to use your integrated Salesforce Agent Desktop interface. Bright Pattern Contact Center integration account configuration requires the full SFDC URL (starting with <your-salesforce-domain>...) for use in the Call Center configuration integration accounts. This URL is available via the SFDC browser by right-clicking on the URL and choosing Copy Link Address as required.

New integration accounts are added in the Contact Center Administrator application. For more information, see the Contact Center Administrator Guide section Integration Accounts.

To create a new integration account, follow these steps:

  1. In a new browser tab, log in to the Bright Pattern Contact Center Administrator application. Keep this application open. You will be going back and forth between this application and Salesforce.com.

  2. From the main menu, under Call Center Configuration, select Integration Accounts.

  3. Click + at the bottom of the screen to add a new integration account.

    Add Salesforce.com integration account

You will be editing the following integration account properties with the information from Salesforce:


How to Add the Certificate

Before you can add the certificate, you have to ensure that there is one.

Note: In case you have multiple certificates, you must choose the certificate you want to use as the Idp Certificate on the App Settings page.

  1. In Salesforce.com, go to Administration Setup > Security Controls > Certificate and Key Management.

    Certificate and Key Management


  2. If you see no certificates listed, then either create a new one or import a certificate from your setup.

  3. To import, click the Import from Keystore button. Any certificates you import will be shown in the Idp Certificate field on the Connected App Edit page. Note that if you have multiple certificates, you must choose the certificate you want to use as the Idp Certificate on the App Settings page.

    IDP certificate shown


  4. In addition, you need a domain name for your call center. The domain is what you will add to your Salesforce integration account property Url. In Salesforce.com, go to Administration Setup > Domain Management > My Domain to create one.

  5. Still in Salesforce.com, click Setup in the main menu at the top of the screen.

  6. Then go to Administration Setup > Security Controls > Certificate and Key Management.

  7. Select the certificate desired (or import a certificate). Note that you may have multiple certificates shown.

  8. Click Download Certificate.

  9. Open the downloaded file in Notepad (or Notepad ++) and copy the certificate content only (i.e., the text between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----).

    Sfdc-integration-guide-image11.png


  10. Go back to the Contact Center Administrator application and paste the certificate into the Salesforce integration account properties. Paste by clicking paste under Single Sign-on > Identity provider certificate.

  11. In the Set Identity Provider certificate dialog, click Set. This pastes in the certificate.

Step 5: Provide the identity provider initiated login URL

  1. Go back to Salesforce.com. Navigate to Administration Setup > Manage Apps > Connected Apps'.

  2. Select the App created earlier (i.e., "BrightPattern").

  3. Under section SAML Login Information, copy the full URL from the Idp-initiated Login URL. (Copy the URL by using the Copy/Paste menu; it will be automatically prefixed with the domain URL as created earlier (e.g., https://<your-sf-domain>.salesforce.com...).

    SFDC-SAML-Login-50.PNG


  4. Paste the copied login URL (full URL) into the Salesforce integration account properties on Bright Pattern Contact Center, and click Apply.

    Saleforce.com integration account properties




< Previous | Next >

Enabling SFDC Data Access from Scenarios

The server-side integration is implemented using Saleforce.com (SFDC) web services via the SFDC REST API (http://wiki.developerforce.com/page/REST_API).

Bright Pattern Contact Center authenticates with Salesforce using the Web Server OAuth Authentication flow. The refresh token mechanism is used to obtain and refresh the access token.


In Salesforce Lightning

Step 1: Create a new connected app

  1. In Salesforce Lightning, go to Platform Tools > Apps > App Manager.
  2. At the top of the Lightning Experience App Manager, under Connected Apps, click New.


Create new app


Step 2: Configure the connected app

To configure the connected app, enter the following details on the New Connected App page.

Basic information

Sfdc-integration-guide-image13.png



API (Enable OAuth Settings)

  1. Check the Enable OAuth settings at API (Enable OAuth Settings) > Enable OAuth Settings

    1. Callback URL - https://<your-brightpattern-domain>/admin/salesforcecallback.html
    2. Select Available OAuth Scopes.

      Sfdc-integration-guide-step2.png


  2. Then access and manage your data (API).

  3. Full access (full)

  4. Perform requests on your behalf at any time (refresh_token, offline_access).

  5. Click Save.


Note: The SFDC updates for these parameters take a few minutes to propagate through the system--wait five minutes while SFDC updates these settings internally.


Step 3: Update the earlier created Bright Pattern Contact Center/Salesforce.com integration account

  1. Log in to the Bright Pattern Contact Center Administrator application, and go to Configuration > Call Center Configuration > Integration Accounts > Salesforce.com.

  2. In the integration account properties, add the consumer key and consumer secret obtained from the connected app created above.
    1. In Salesforce.com, go to App Setup > Apps > Connected Apps, and select the connected app created earlier.
    2. Copy the Consumer key and Consumer secret directly from the connected app.

      Sfdc-integration-guide-image15.png


  3. Go back to Contact Center Administrator, and paste the the consumer key and secret into the integration account properties.


Step 4: Update the security profile to include the new connected app

  1. In Salesforce.com, go to Administration > Users to get to the All Users page.

  2. A list of users will be shown. In the Profiles column, click System Administrator.

    Click the Administrator profile


  3. The Profile Detail page will open. Click Edit.

    Edit the System Adminstrator profile


  4. In Connected App Access, check the connected app created earlier.

    SFDC-Admin-Connected-App-50.PNG


  5. Click Save.


Step 5: Update the Bright Pattern Contact Center Administrator application

In Contact Center Administrator application, open the Salesforce integration account that you added previously. Go to Configuration > Call Center Configuration > Integration Accounts > Salesforce.com.


SFDC-Data-Scenarios-50.PNG


Under Data Access from Scenarios, specify the following data:


The Salesforce integration account configuration should now be complete. You can use the Check limits button to see the SFDC limits associated with this account.


Step 6: Edit your Salesforce.com scenario

In the Scenario Builder application, edit your Salesforce.com scenario to include the following scenario blocks. These blocks allow your contact center to access SFDC data and enable screen pop:


Bright Pattern Contact Center Administrator provides a scenario template for a simple inbound workflow involving look-ups and screen pop of SFDC data.


In Salesforce Classic

Step 1: Create a new connected app

To create a new connected app:

  1. In Salesforce Classic, go to Build > Create > Apps.
  2. At the bottom of the Apps list, under Connected Apps, click New.


Create new app


Step 2: Configure the connected app

To configure the connected app, enter the following details on the New Connected App page.

Basic information

Sfdc-integration-guide-image13.png



API (Enable OAuth Settings)

  1. Check the Enable OAuth settings at API (Enable OAuth Settings) > Enable OAuth Settings

    1. Callback URL - https://<your-brightpattern-domain>/admin/salesforcecallback.html
    2. Select Available OAuth Scopes.

      Sfdc-integration-guide-step2.png


  2. Then access and manage your data (API).

  3. Full access (full)

  4. Perform requests on your behalf at any time (refresh_token, offline_access).

  5. Click Save.


Note: The SFDC updates for these parameters take a few minutes to propagate through the system--wait five minutes while SFDC updates these settings internally.


Step 3: Update the earlier created Bright Pattern Contact Center/Salesforce.com integration account

  1. Log in to the Bright Pattern Contact Center Administrator application, and go to Configuration > Call Center Configuration > Integration Accounts > Salesforce.com.

  2. In the integration account properties, add the consumer key and consumer secret obtained from the connected app created above.
    1. In Salesforce.com, go to App Setup > Apps > Connected Apps, and select the connected app created earlier.
    2. Copy the Consumer key and Consumer secret directly from the connected app.

      Sfdc-integration-guide-image15.png


  3. Go back to Contact Center Administrator, and paste the the consumer key and secret into the integration account properties.


Step 4: Update the security profile to include the new connected app

  1. In Salesforce.com, from Administer (or Administration > Setup), select Manage Users > Profiles.

  2. Click System Administrator.

  3. Click Edit.

  4. In Connected App Access, check the connected app created earlier.

    Sfdc-integration-guide-image17.png


  5. Click Save.


Step 5: Update the Bright Pattern Contact Center Administrator application

In Contact Center Administrator application, open the Salesforce integration account that you added previously. Go to Configuration > Call Center Configuration > Integration Accounts > Salesforce.com.


SFDC-Data-Scenarios-50.PNG


Under Data Access from Scenarios, specify the following data:


The Salesforce integration account configuration should now be complete. You can use the Check limits button to see the SFDC limits associated with this account.


Step 6: Edit your Salesforce.com scenario

In the Scenario Builder application, edit your Salesforce.com scenario to include the following scenario blocks. These blocks allow your contact center to access SFDC data and enable screen pop:


Bright Pattern Contact Center Administrator provides a scenario template for a simple inbound workflow involving look-ups and screen pop of SFDC data.


< Previous | Next >

Importing Calling Lists and Exporting Campaign Results

You can import calling lists for your outbound campaigns directly from Salesforce.com (SFDC) and set up automated periodic updates of such lists to include changes made to the corresponding data in SFDC. You can also automatically create SFDC records based on campaign results.

In order to enable calling lists to be imported and campaign results to be exported, you must first enable access to SFDC data. See the integration steps of section Enabling SFDC Data Access from Scenarios.

For more information about list data, see the Contact Center Administrator Guide, section Lists.


How to Import List Data from SFDC

Step 1: Create a list

  1. In the Contact Center Administrator application, select Lists from the configuration menu, and click the Import list button. This will start the List Import Wizard.

  2. In the first wizard screen (List Type), select Create a list from Salesforce.com SOQL query.

    Sfdc-integration-guide-image25.PNG
  3. Click Next.


Step 2: Name your list

  1. In the Name and Source dialog, assign a unique List Name.

  2. Select the Saleforce.com integration account.

  3. Specify the query for selecting Saleforce.com records for this calling list. The query must be written in the Salesforce Object Query Language (SOQL). Note that the selected records must contain object identifiers and must have at least one phone number field.

  4. Click Next.


SFDC-List-Import.PNG


Step 3: Review and Edit list fields if needed

  1. Edit the list fields as necessary. For more information, see the Contact Center Administration Guide, section Lists. Note that SFDC object identifiers will be used as keys for list record identification; therefore, field ID will be automatically marked as a required field.

  2. Click Next.


Sfdc-integration-guide-image27.PNG


Step 4: Confirm import results

  1. Review the results of import, and click Ok.

  2. In the List Properties view, enable periodic updates of this list. (Note that for lists of Salesforce.com type, new records matching the original SOQL query will be added to the list during each update, while any records that may have been removed from Salesforce will be disabled in the list. If there are campaign results available for such disabled records, they will be preserved.)

  3. If necessary, edit other list properties and assign this list to your campaign.

  4. Click Apply.


Note: There is a 30 second timeout on the Bright Pattern side to begin receiving data from SFDC after the SOQL query is submitted. This timeout applies to both the initial list import and subsequent periodic updates.


How to Export Campaign Results to SFDC

Step 1: Select a campaign

  1. In the Contact Center Administrator application, in section Services and Campaigns, select a campaign.

  2. Open the Results tab.

  3. Click the add link under Periodic Salesforce.com Export Jobs. The Edit Salesforce.com Export Parameters dialog will open.


Note that there is no dependency between data export and import. Export to SFDC can be configured for any campaign regardless of the source of the data.


Step 2: Specify export job parameters and type of object to be created

  1. Define the general parameters of the export job.

    Edit Salesforce.com Export Parameters


  2. Under Destination, select the Salesforce.com integration account.

  3. Then specify the type of Salesforce.com object that will be created using the results of this campaign.


Sfdc-integration-guide-image28.PNG


Step 3: Enable field mapping

  1. Click the Map fields button and map properties of the specified Salesforce.com object to the corresponding campaign result fields.

  2. In the dialog that appears, for each object property that will be defined using the campaign data, click the $() link.

  3. Select the corresponding field of the campaign results, and, if necessary, edit it in the Value to set field.

  4. Note that object fields of type ID are generated automatically by SFDC and cannot be modified.


Sfdc-integration-guide-image29.PNG

Step 4: Test the results of the export

  1. Click the Test by creating object button.

  2. Check that an object of the specified type is created in SFDC with the mapped properties filled with test data.



< Previous | Next >

Customizing SFDC Activity Objects

Salesforce.com (SFDC) activity history is a list of associated tasks or the history of activities that have been carried out on an object. For example, the activity history section on a contact record may contain a list of actions that the sales rep has taken in working that lead, such as emails sent, calls made, and so forth. In addition to the predefined Activity History Objects, these fields can be extended with customized activities to track against objects.


How to Customize an Activity Object

Note that the following steps are done in Salesforce Classic view.

Step 1: Create custom fields for an object

  1. In Salesforce.com, go to Customize > Activities > Activity Fields and then work in Activity Custom Fields to create custom fields.

  2. Add a new field, set the label name, and assign the field name.A sample of the predefined Recording URL (Custom Activity Field) is shown. Note the naming convention:

    Sfdc-integration-guide-image30.png


  3. In a new browser tab, open your Salesforce.com scenario entry in the Scenario Builder application.

  4. Note that upon saving a new custom field, SFDC will automatically add suffix “__c” to it. In order to supply interaction data to this field, use the field name including suffix “__c” in the Attached Data scenario block. For example, to populate Custom Activity field XXXX, it is required to have the scenario block Attached Data XXXX__c.


Notes

Activity Field data may be updated via the Attached Data block in a scenario referencing the Activity Field API Name.


Sfdc-integration-guide-image31.png


To populate regular (not custom) Activity Fields with any data from the scenario, just use the field name without the “__c” suffix.


Step 2: Manage layouts to include new custom fields

  1. In Salesforce.com, go to Customize > Activities > Task Page Layouts to create or modify page layouts to include new custom fields.

  2. Add a new field by dragging and dropping the new field into the Task Page Layout.

  3. Modify the layout as required.

  4. Then save the new layout.


Predefined Fields

Predefined fields (Label/Field Name = Parameter) include the following:


Sfdc-integration-guide-image32.png


Note that activity history is added to the last record that the agent had open on the Agent Desktop while finishing the call (or the related after-call work).


< Previous | Next >

Configuring SFDC Data Screen Pop for Outbound Preview Campaigns

Screen pop is the feature that distributes specific data to agents' screens during interactions. When enabled for agents working with Salesforce.com (SFDC), screen pop literally "pops" SFDC data such as calling records to the Agent Desktop application of the agent, who then previews the information before beginning interactions.


How to configure SFDC data screen pop for an outbound preview campaign

  1. Before importing a calling list that will be used in this campaign, make sure it contains identifiers of the SFDC objects that are to be displayed in the Agent Desktop when the corresponding calling records are distributed to the agent for preview. These identifiers are obtained from Salesforce.com, where they are generated for every case, account, and contact.

  2. When importing this calling list, assign type Other to the field containing the SFDC identifier and give it a descriptive name (e.g., "SalesforceID").

  3. When configuring the general properties of your preview campaign, set the Screenpop URL parameter to $(workitem.otherInfo.[SFDC ID field name]). For example, set it to $(workitem.otherInfo.SalesforceID).

Note: [SFDC ID field name] is case sensitive.


SFDC-preview-screenpop-config.PNG



< Previous | Next >

Searching for a Contact Using the Salesforce.com Search Block

This section describes the various ways to use scenario blocks when searching for a contact. For more information on scenario blocks, see the Scenario Builder Reference Guide.


How to Clean the ANI Using Set Variable

Use the Set Variable block with the following properties to clean the ANI from any meaningless symbols.


Sfdc-integration-guide-image34.png


How to Set a Value for the SFDCANI Using Set Variable

Use the Set Variable block with the following properties to set a value for the SFDCANI.


Sfdc-integration-guide-image35.png

How to Use the Salesforce.com Search Block

Use the Salesforce.com Search block with the following SOQL query:

SELECT Id, Name, Account.Id FROM Contact WHERE Phone LIKE '$(SFDCANI)' or MobilePhone LIKE '$(SFDCANI)'


Salesforce.com Search properties


< Previous | Next >

Locating or Creating Screen Pop URLs for an SFDC Object

SFDC integration provides the ability to access defined Saleforce.com (SFDC) Objects as screen pop candidates through the use of the associated screen pop scenario block URL, which is typically supplied by the SFDC System Administrator; however, the following process is provided as an example of how to derive the SFDC Object screen pop URLs on your own.

Bright Pattern Contact Center uses the Salesforce.com Screenpop scenario block to display SFDC records (objects) in the Agent Desktop application. This block not only allows the selection of an individual Object ID, but it will also accommodate SFDC URLs for screen pop objects.

Note: The Object ID URL may differ between Service Cloud and Sales Cloud. Therefore, a single scenario may or may not work across the enterprise.


Sfdc-integration-guide-image36.png


Locating SFDC Screen pop URLs for Sales Cloud

Utilizing Salesforce, perform the desired task manually that you wish to perform via the screen pop URL. For example, if you are interested in opening a new case from an account and a specific contact within Sales Cloud, you should proceed as follows:


Step 1: Select a Sales Cloud account and create a new case

  1. From within Sales Cloud, select > Accounts.

  2. Scroll down to Contacts.

  3. Select a sample Contact.

  4. From the Contact record, scroll down to Cases, and then select New Case. A new case record should open, as shown.


Sfdc-integration-guide-image37.png


Step 2: Configure the URL that identifies the SFDC Object for screen pop

  1. Copy the page URL as your starting reference:

    https://bpdemo-dev-ed.my.salesforce.com/500/e?retURL=%2F003E000000NoeJj&def_contact_id=003E000000NoeJj&def_account_id=001E000000NK3Pl

  2. The URL identifies the SFDC Object parameters required for your screen pop. The initial SFDC URL segment is not required (https://bpdemo-dev-ed.my.salesforce.com/) and should be removed--the desktop integration will use the configured domain URL. The result is as follows:

    500/e?retURL=%2F003E000000NoeJj&def_contact_id=003E000000NoeJj&def_account_id=001E000000NK3Pl

  3. The Object parameters contact_id and account_id would be replaced by the scenario-defined objects/variables. For example:

    500/e?retURL=%2F003E000000NoeJj&def_contact_id=$(SFContact.Id)&def_account_id=$(SFContact.Account.Id)


Notes

Common Object ID identifiers (as identified by the three leading field characters) are as follows:


Typically, the retURL or Return URL is not desired unless the requirement is to return to a specific object. By removing the Return URL, the default action will be to return to the original work object.


This URL will be placed in the Salesforce.com Screenpop block's Object ID field.


Sfdc-integration-guide-image38.png


Locating SFDC Screen Pop URLs for Service Cloud (Service Console)

Utilizing Salesforce, perform the desired task manually that you wish to perform via the Screen pop URL. For example, if you are interested in opening a new case from an account and a specific contact within Service Cloud, you should proceed as follows.


Step 1: Select a Service Cloud account and create a new case

  1. From within Service Cloud, select > Accounts.

  2. Scroll down to a specific account.

  3. Select a sample account.

  4. From the Account record selected, scroll down to Contacts.

  5. Select a sample contact with which to work.

  6. From the Contact record, scroll down to Cases, and then select New Case. A new Case record should open.

  7. To locate the behind-the-scenes URL, select the down arrow on the left side, as shown.


Sfdc-integration-guide-image39.png


Step 2: Edit the new case

Select New Case and click the edit link. This should result in the Link to Share dialog box.


Sfdc-integration-guide-image40.png


In Link to Share, three options are available:


Step 3: Configure the URL that identifies the SFDC Object for screen pop

  1. Select “Include only this tab” to provide the simple URL for the screen pop described.

  2. Copy the page URL as your starting reference:

    https://bpdemo-dev-ed.my.salesforce.com/console#%2F500%2Fe%3Fdef_contact_id%3D003E000000NoeJk%26def_account_id%3D001E000000NK3Pm


The URL identifies the SFDC Object parameters required for your screen pop. The initial SFDC URL segment is not required (https://bpdemo-dev-ed.my.salesforce.com/) and should be removed--the desktop integration will use the configured domain URL. The result is:

console#%2F500%2Fe%3Fdef_contact_id%3D003E000000NoeJk%26def_account_id%3D001E000000NK3Pm


The Object parameters def_contact_id and def_account_id would be replaced by the scenario-defined objects/variables.

The URI data format is as follows (for reference only):

%3D = “=”

%26 = “&”

%2F = “/”

%3F = “?”

Thus the result would be the following:

console#%2F500%2Fe%3Fdef_contact_id%3D$(SFContact.Id)%26def_account_id%3D$(SFContact.Account.Id)


Common Object ID identifiers (as identified by the three leading field characters) are as follows:


This URL will be placed in the Salesforce.com Screenpop scenario block's Object ID field:


Sfdc-integration-guide-image41.png


< Previous | Next >


Enabling the Service Console or Service Cloud


Sfdc-integration-guide-image43.png


< Previous

Pausing and Resuming Recordings

SFDC integration provides an integrated Agent Desktop within your Salesforce environment. As such, the same agent and supervisor functionality found in the Agent Desktop application are available to users signed in to their Salesforce.com integration accounts. For more information on the various functions, controls, and capabilities of Agent Desktop, see the Bright Pattern Contact Center Agent Guide and Supervisor Guide.

As part of Agent Desktop functionality, logged in supervisors may record the calls of agents on their teams. In addition, logged in supervisors with the privilege Monitor agent screen have the option to view screens of selected members of their team and monitor their desktop actions in real time. Furthermore, supervisors with the privilege Watch agent screen recordings may record the screen of a logged in agent who is currently in the Busy state (i.e., an agent who is handling an interaction). Supervisors may start, stop, or pause a screen recording at any time (see section Screen Monitoring Controls below).


Call Recording

How to Start Recording

Click the Start Recording Supervisor-guide-image24.png button. The button will change its function to Stop recording.


How to Pause Recording

Click the Pause Recording Pause-Screen-Recording.png button. The button will change its function to Pause recording.


How to Stop Recording

Click the Stop recording Supervisor-guide-image25.png button. Otherwise, the call recording will stop automatically when the call is released.


Screen Monitoring

How to Begin Screen Monitoring

  1. Select the desired agent from the Agent Metrics View in the Agent Desktop widget. The Contact Info Panel will display the monitoring functions.
  2. Click the See Screen button Supervisor-guide-image33.png. A new window will open, showing you the desktop of the selected agent.

Note that you can only continuously monitor a screen of one agent at a time. Thus, if you activate this function for another agent, monitoring of the originally selected agent will stop.


How to Pause Monitoring the Agent’s Screen

Occasionally you may wish to omit certain parts of an agent's activity from a screen recording, without stopping the recording entirely. Such a need may arise when agents are receiving sensitive data from customers, such as credit card numbers, social security numbers, and so forth.

To pause monitoring and screen recording, click the Pause recording button Pause-Screen-Recording.png. Clicking the Pause recording button again will resume the recording.

The capability to pause a recording is enabled by the call center .XML definition file that was uploaded during Salesforce integration configuration. For more information, see section Installing a Managed Package.


Screen recording controls are given at the top of the monitoring window

How to Stop Monitoring the Agent’s Screen

Simply close the browser window.



How to Remove SFDC Integration

Removing Salesforce.com (SFDC) integration involves deleting the Salesforce.com integration account from Bright Pattern's Contact Center Administrator application and, optionally, deleting the connected app from Salesforce.com.


Salesforce.com integration account


To remove the SFDC integration account, follow these steps:

  1. Log in to the Bright Pattern Contact Center Administrator application.

  2. From the main menu, under Call Center Configuration, select Integration Accounts.

  3. From the list of accounts, select the SFDC integration account you wish to remove.

  4. Click the X button at the bottom of the screen to remove the integration account.

  5. A dialog will open, asking you to confirm deletion. Click OK.


For more information on integration accounts, see the Contact Center Administrator Guide, section Integration Accounts.


Optional: Uninstall in Salesforce

  1. In Saleforce.com, navigate to Manage Connected Apps.
  2. Click the call center you wish to uninstall (i.e., "BrightPattern").
  3. Click Uninstall at the top of the Connected App Detail page to uninstall your connected app.



< Previous