Aurora: Configure custom Salesforce settings
The Khoros Community integration package leverages custom Salesforce settings, which are used by many components and relates to the Khoros Community configuration settings on Salesforce.
To apply settings for your Khoros environment:
- Sign in to your Salesforce.com environment.
- From the dropdown on the top right of the page, select App as "Khoros Salesforce Integration."
- Select the Custom Settings tab.
- Go to the Feature Settings tab.
- Select Create.
- Enter the Feature Settings:
- Feature Setting Name: Default is "DefaultSetting." Do not change this setting, as it is non-editable in newer packages.
- Create New Contact record: Select this option to enable the creation of a new Contact during user sync if a Contact with the matching email ID is not present. During User Sync, Contact and Community users are linked together. The linkage is necessary for Case Portal functionality. (You must enable the Community User Trigger below for this setting to work.)
- Link Community User with Contacts: Select this option to allow linking of Community user and Contact during user synchronization, if a contact with same email ID already exists. The linkage is necessary for Case Portal functionality. (You must enable the Community User Trigger below for this setting to work.)
- Case closure: Select this option to allow automatic case closure when a comment on a post is accepted as solution on community. (You must enable the Case Trigger below for this setting to work.)
- Max Allowed Private Message Subject Length: Sets the maximum length the Private Message subject (up to 43 characters).
- Max Allowed Private Message Body Length: Sets the maximum length the Private Message body.
- No of Federated Search Results from Salesforce: Limits the number of Federated Search results (applies to Salesforce results only). Default value is 100 (Package 4.1 onwards).
- Enable Community User Trigger: Select this option to enable Community User Trigger. This trigger runs on community user creation/update and links community users with contacts. This linkage is necessary for Case Portal and User Sync functionality.
- Enable Case Trigger: Turns on or off triggers on cases, which synchronize case status changes with community and also mark a case as closed.
- Enable Case Comment Emails: Toggle Case Comment email on and off. (Package 3.7 onwards)
- (Optional) Fallback Community Username: Enter username of the Community user to which postbacks should fall back to when a Community user is not found corresponding to the email address of the user replying. This is also used in case of multiple users with the same email address. Entered Community user should be a valid value. (Package 4.0 onwards)
- Allow Case Comments for public Community Cases: Select this option to enable the creation of Case Comment on Public Community Cases in Salesforce. (Comment does not sync to community.) If not selected, it does not allow case comment creation for public community cases in Salesforce. (Upcoming, Package 4.2 onwards)
Note: The Enable Knowledge and Lightning Knowledge options must be turned off as they are not supported in the community. These options allow knowledge base articles to be created, updated, deleted, and searched from the community.
- Select Save.
- Configure your remote site access.
- Set profile permissions:
- Go to Setup > Manage Users > Profile.
- Select the profile used for integration.
- Ensure the appropriate Field Level Security Permissions are granted for Standard and custom objects (Account, Case, Contact, Postback Comment, Community Users, Private Message). The recommendation is to grant the administrator role so that members can have read/write access to all fields for objects that are required for integration to work.
- Go to Custom Settings > Community Settings > Create.
- Enter community settings details (If you are using v4.3 connector version, go to step 12 instead).
- Community ID: The ID of the integrated application. Contact your CSM or Support to get this value for your community.
- Client ID: The Client ID of the SalesforceIntegration API App on the community (Admin > Dev Tools > API Apps). This is configured from <link to these instructions - https://docs.google.com/document/d/1MuDPjcuO2hPjFPzlXfktjO8tkWr3xhjysgsHZJSo-BI/edit?tab=t.0#heading=h.bfd4q6thij1w )
- Secret: The Secret corresponding to the Client ID.
- Redirect URL: The URL of the VisualForce page for Custom Settings.
- Base URL: The community base URL. For subpath-enabled communities, append the subpath.
- Is Proxy Enabled?: Always select this for Aurora applications.
- Context Name: Tapestry Context name/Webserver char path. Example: t5/s.
- Authorize the connection.
- After saving, the connection status shows Not Active.
- Select Authorize. You are redirected to the authentication window.
- Select Authorize. You are redirected to the authentication window.
Note: Authorize with an Administrator or a member with admin-like permissions to prevent API call failures.
- After successful authentication, you are redirected to the custom settings page with the message "TenantId: is successfully authorized."
- The Connection Status updates to Active. The Username field displays the username used for authorization.
- This generates Access and Refresh tokens, and they are stored in a Salesforce object.
Note:
- When the access token expires, the Connection status changes to Halted.
- A "RefreshAuthToken" link appears. You can always re-authorize by selecting the Authorize link.
- By default, the refresh token expiry of the salesforceIntegrationApp is set to 5 years.
- If you are using v4.3, then enter the Community Settings as shown below (If you are using v4.4, skip this step):
- Community Id: Enter your community ID. (You can get your ID from your Customer Success Manager, if you don't have it. If you've already entered this information, select Edit.)
- Username: Enter the Khoros username to be used in Khoros API calls.
Note: This user must be a non-SSO user with administrator permissions, and the email address for this user must be verified in the community. If an agent has an account on the target community that uses the same email address as their Salesforce account, their personal community user account is used as the author of the postback. We recommend that your brand's Salesforce agents create their own community accounts for this purpose. - Password: Enter the Khoros password associated with the above username.
- Base URL: Enter the Base URL value according to your Khoros environment (see below).
Note: Be sure to include the https:// and HT credentials. Use the following format:
https://<HTUSER>:<HTPASSWORD>@<***Community URL>
Example:
https://test123:qwerty98765@community-stage.khoros.com/ - Select the Is Proxy Enabled? checkbox.
- Context Name: Set Context Name to “t5" unless your Community has a Reverse Proxy implementation in place, in which case, contact your Customer Success Manager or Khoros Support and request the value of tapestry.context.name from your community config.
- Select Save.
- To set the maximum number of search results to be returned in the Federated Search component, go to the Feature Settings tab and set the No. of Federated Search value.
- Select Save.
With HT-Access turned off in the Khoros community:
Khoros Communities Stage |
Base URL |
Sandbox |
https:// [community_id].stage.lithium.com |
Production |
https:// [community_id].lithium.com |
Note: If you have a more descriptive CNAME/vanity address for your community, use that name when creating the URL (for example, https://community.mycwebaddress.com).
With HT-Access turned on in the Khoros community:
Note: Contact Support to get the ht-access credentials for your community. Contact your Customer Success Manager to get your Community ID.
Khoros Community Stage |
Base URL (Example with community id as “abc”) |
Sandbox |
https://htusername:htpassword@abc.stage.lithium.com |
Production |
https://htusername:htpassword@abc.lithium.com |