Installing the Salesforce package for Terminus Chat Experiences will allow Chat users to see data related to their chat interactions inside of Salesforce, and also leverage their Salesforce data inside of the Chat Experiences interface.
This article will review the steps that Terminus Chat Experiences customers will need to follow in order to install and configure the Terminus Chat Package in Salesforce, and inside Terminus.
Note: A Salesforce Admin will likely need to complete these installation steps.
Covered in this article:
- Installing the Terminus Chat Package (Ramble) in Salesforce
- Compact Layouts + Implementing Custom Fields
- Applying Event Compact Layouts to Packages
- Connecting Salesforce to Terminus Chat
- Terminus Chat Managed Package Reference List
Installing the Terminus Chat Package (Ramble) in Salesforce
In April of 2020, Terminus acquired account-based chat solution, Ramble. Terminus customers should note that, at this time, the Salesforce package for Chat Experiences is still called "Ramble."
To install the Ramble package inside your instance of Salesforce, follow these steps:
If you want to test the package in a Sandbox environment first, start by logging into your Salesforce sandbox account, or create a Salesforce developer account here.
Once inside Salesforce, you can install the Terminus Chat package using this link:
When installing, be sure to select the "Install For All Users" option:
After following the above directions, your Terminus Chat package should be successfully installed!
After clicking "Done," you be redirected to your installed packages tab, and you should see "Ramble" listed. If you ever need to access this from the main screen, Navigate to:
- Setup > Apps > Packaging/Installed Packages > Ramble
The uninstall option on this page provides a simple way to remove the package from your Salesforce instance if you choose to at a later time.
Compact Layouts + Implementing Custom Fields
With the Terminus Chat package installed, users can create their own Compact Layout with Custom Fields in Salesforce. A Compact Layout determines which fields are displayed in the details section when you expand an activity in the Activity Timeline. Changing the Compact Layout will impact the fields that show up in the highlighted areas (see image below) in Tasks, Task lists, and everywhere else the compact layout is used.
To create a new Compact Layout with the Ramble package data, follow these steps:
- Navigate to Setup > Object Manager > Find & click on Task
- Select Compact Layouts
- Click the "New" in the upper-left corner to create a new Compact Layout
- Give the layout a name (ex: Ramble Chat or Terminus Chat)
- Select the package fields that you want displayed on the layout, and then hit "Save."
Once your settings have been saved, your new compact layout can be applied to customize your tasks, task lists, and your activity timeline. After saving, click on the compact layouts on the left-hand side of the screen to bring you back to the compact layouts for your event tab, you will see that you now have access to the Ramble Chat Compact Layout. To utilize your new compact layout:
- Click Compact Layout Assignment within the desired Label
- Edit Assignment
- Switch Primary Compact Layout to Ramble Chat & Save
Once these changes have been applied, you should notice that your Primary Compact Layout has changed to your new custom compact layout.
Applying Event Compact Layouts to Packages
Once your Terminus package has been installed, and your custom layout has been created, you can also apply the new compact layout design to change the Event compact layout. To set this up, follow these steps:
- Navigate to: Setup > Object Manager > Event > Compact Layouts
- Click the Ramble Event Compact Layout under Label
- Edit Assignment
- Switch your Primary Compact Layout from "System Default" to "Ramble Event Compact Layout"
After saving, click on "Compact Layouts" on the left-hand side navigation to get back to the compact layouts for your event tab, you will see that you now have switched your Primary Event Compact Layout from the System Default to your customized Ramble Event Compact Layout.
Connecting Salesforce to Terminus Chat
Connecting your Salesforce instance to Terminus Chat will enhance your ability to manage helpful chat data, such as:
- Pass Chat Activity into Salesforce from Terminus Chat
- Create New Leads, Contacts, Tasks, and Cases from Terminus Chat
- Update the Visitor Info Panel in Chat Views with a Salesforce section, so chat users can easily see additional details about your accounts with data pulled from Salesforce.
Use Correct User ID
When connecting Salesforce to Terminus Chat, establish the connection via an integration/system user and not a personal user account. The account used for the Oauth connection must have admin permissions to each of the objects listed at the bottom of this article.
To connect Salesforce to your Chat instance, follow these steps:
- Navigate to the Administration settings section in Chat Experiences, and select the Team you want to manage (if you have multiple Teams):
Go to the Integrations section
Select the Setup button on the Salesforce integration icon:
NOTE: Instructions for Sandbox Installation
To connect to sandbox, follow the same steps, but click on this beaker icon rather than “Setup”.
Once you’ve completed sandbox testing and you’re ready to connect to production, you can click the settings gear icon, then “Disconnect”. You will then be able to click “Setup” to connect your production instance.
Follow the OAuth steps to connect Salesforce:
NOTE: Chat Playbook Users
There are currently two ways to send leads to Salesforce using Terminus Chat. The new Chat Playbooks functionality will allow you to send Chat Leads to Salesforce based on specific conditions. This method will allow you to have logic built into which leads you choose to send.
If your team is already using playbooks, your Terminus Chat administrator can configure auto-push to Salesforce in Concluding Plays.
Legacy Lead Process (Non-Playbook Users)
Within the Salesforce integration settings, Chat Administrators can also choose to automatically create chat visitors as either Leads or Contacts in Salesforce. If this setting is turned on, a generic Lead/Contact owner from your Salesforce instance will need to be assigned to any new records created from your chat conversations. If you elect not to use this feature, your team will be able to manually generate Leads or Contacts in their Terminus Chat portal, from the Info panel.
If you do choose to enable this setting, you can also make the following determinations:
- Type: You create chat visitors as either Leads or Contacts.
- Missed Chats: You can elect to send all missed and/or all answered chats to Salesforce.
- Lead/Contact Owner: Set the lead/contact owner to a Salesforce User.
- Campaign: We advise using a Campaign that allows you to understand either your different chat experiences (e.g. Website Homepage, Website Product Pages) or potentially a Chat-specific campaign.
Custom Data Mapping (All Users)
Your Terminus Chat package installation has already mapped common fields between Salesforce and Chat. Attempting to Map these fields will result in an error.
- First Name
- Last Name
- Lead / Contact Owner
Terminus Chat also provides the ability for administrators to define the data parameters that are passed to Salesforce when a lead or contact is generated:
- Begin by selecting the data type you want to send to Salesforce. You can select a UTM Variable, a Value, or a Data Ask/Element.
In the next field, you will then input in the name of the variable or the exact value you want to pass.
- For UTM Variables: This should be the name of the UTM variable that you want to pass.
- For Value: This is a static value that you will pass into the selected field for all chats.
- For Data Asks / Elements: A dropdown list will appear for you to select the Data Ask/Element that you would like to pass.
Next, select the Salesforce object you want to map the information to. Finally, provide the Salesforce field name (API Name).
Note: Writing Data to Salesforce Picklists
If you are passing data into a Salesforce field with predefined values, such as a picklist, the values that you are passing from Terminus Chat must exactly match an acceptable value for that field.
ABM Chat Routing
ABM Chat Routing, when configured, will route the chat directly to the account owner when a matching account has been identified in your Salesforce instance and the respective owner is a Terminus Chat user.
The default ABM Routing field is Account Owner; however, you can customize which field Terminus Chat should reference for ABM Routing.
To do so, select the Object to reference in “ABM Lookup Object.” Terminus Chat can reference the Account, Lead, or Contact object for ABM Routing.
Next, input the API Name of the ABM Routing Field. This field must be a user field type.
Salesforce User Filtering
The "Salesforce User Filtering" section allows Administrators to omit names from the "User" options from Salesforce. For example, if you have System Admins, or a Revenue or Sales Operations team who will not have access to Terminus Chat, you can omit them from the available Users list. You can also include specific user types or groups in Salesforce, versus creating large exclusion lists. For more information on Salesforce users in Chat, please see this article.
You are also able to map your Terminus Chat users to their respective Salesforce User IDs. This is valuable if, for some reason, the email addresses for your user accounts do not match.
Once these settings have been configured, your Terminus Chat and Salesforce instances should be properly connected and ready to utilize.
Finally, once you configure auto-push to create Leads or Contacts, if an existing Contact or Lead is identified (based on matching email address), Terminus Chat will append the Chat Activity to the existing record rather than creating a new, duplicate record.
Terminus Chat Managed Package Reference List
The following components are added to your Salesforce instance during Terminus Chat installation:
- Ramble Chat Type (Custom Field)
- Ramble Chat URL (Custom Field)
- RambleSaveLeadIgnoreDuplicate (Apex Class)
- RambleTest (Apex Class)
- Ramble Event Compact Layout (Compact Layout)
List of Affected Salesforce Objects
When enabled, the integration has the ability to read the following objects when pushing Chat data in Salesforce:
- Leads (ID, Name, Company, Email, Website, Phone, OwnerID)
- Contacts (ID, Name, Email, Phone, OwnerID)
- Campaigns (ID, Name, Type, Status, StartDate, EndDate, OwnerID)
- Accounts (ID, Name, Website, Phone, OwnerID)
- Salesforce Users (ID, Name)
- Organization Information (ID and Name)
When enabled, the integration has the ability to create data for the following objects when pushing chat data to Salesforce:
- Leads (FirstName, LastName, Company, Email, Phone, Website, OwnerID)
- Contacts (FirstName, LastName, Email, Phone, AccountID, OwnerID)
- CampaignMember (CampaignID, ContactID)
- Events (StartDateTime, EndDateTime, Subject, OwnerID, Location, Description, WhoID, Ramble_Chat_Type__c, Ramble_Chat_URL__c)
- Task (WhoID (ContactID/LeadID), Subject, Description, Priority, ActivityDate, Status="Not Started")
- Case (ContactID, Subject, Description, Priority, Status="new", Origin="chat")
When enabled, the integration has the ability to update data for the following objects when pushing chat data to Salesforce:
- Leads (OwnerID)
- Contacts (OwnerID)