Skip to main content
Deutsch
Submit a request
 

How can we help?

Search

Articles in this section

Admin Guide

  • Updated

Configure Acrolinx for your needs in Salesforce.

Note

To set up Acrolinx for Salesforce Knowledge, you'll need admin privileges in Salesforce.

To set up Acrolinx for Salesforce Knowledge, do the following:

Acrolinx for Salesforce Knowledge 3.15

1. Prepare Your Instance

Acrolinx Platform Configurations

Enable Cross-Origin Resource Sharing (CORS)

Enable CORS between Salesforce and your Acrolinx Platform. See our article on how to enable CORS.

Set Up SSO

SSO lets you skip the browser-based sign-in process for the Acrolinx Sidebar. Learn how to set up Acrolinx for SSO.

Once you've enabled SSO, click the toggle switch next to Use SSO in the Acrolinx Setup. Enter your password in the Password field.

Salesforce Permissions

To use Acrolinx for Salesforce, writers need access to the knowledge base and one of two permission sets:

  • Acrolinx User — has access to the features that come with Acrolinx for Salesforce.

  • Acrolinx Administrator — has access to the Acrolinx User and can access the administrative page.

Assign Permissions to Your Writers:

  1. From Setup, enter "Users" in the Quick Find box. Select Users.

  2. Click the name of the user you want to assign permissions to.

  3. Navigate to Permission Set Assignments and click Edit Assignments.

  4. Select a permission and click Add to move it to Enabled Permission Sets.

  5. Click Save.

Generate Private Key and Server Certificate

Tip

Don't have OpenSSL? Learn how to install it.

  1. Generate a private key:

    openssl genrsa -des3 -passout pass:x -out server.pass.key 2048

  2. Create the key file:

    openssl rsa -passin pass:x -in server.pass.key -out server.key

    The server.key is your RSA private key.

  3. Generate the certificate request:

    openssl req -new -key server.key -out server.csr

  4. Generate the SSL certificate:

    openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out server.crt

    Server.Crt is your digital signature certificate.

2. Create the External Client App

External Client Apps let you integrate external applications into Salesforce using the new External Client App Manager.

2.1 Navigate to External Client App Manager

  • In Salesforce, click the Setup gear icon in the top-right corner.

  • In the Quick Find box, type: External Client Apps.

  • Under Apps > External Client Apps, click on External Client App Manager.

  • Click the New External Client App button.

2.2 Fill in Basic Information

Field

Description

Connected App Name

The unique name displayed in the App Manager and on the app's launcher tile.

API Name

The API name used when referring to your app from a program.

Contact Email

The contact email for you or your support team.
2.3 Enable OAuth Settings

  • Click to expand the API (Enable OAuth Settings) section.

  • Check the Enable OAuth checkbox.

2.4 App Settings

Configure Callback URL: Copy https://login.salesforce.com/ from the Acrolinx Setup Guide and paste it into the Callback URL field.

Select OAuth Scopes:

OAuth Scope

Description

Manage user data via APIs (api)

Gives access to the current, signed-in user's account using APIs.

Perform requests at any time (refresh_token, offline_access)

Allows a refresh token to be returned. The app can interact with the user's data while offline.
2.5 Enable JWT Bearer Flow

  • Check the Enable JWT Bearer Flow checkbox.

2.6 Upload the Certificate

  • Click Upload Files, select server.crt, and click Open.

2.7 Create the App

  • Click Create. You should see: "Success! External Client App created successfully"

3. Set Permissions

Field

Description

Label

The permission set label. Limit: 80 characters.

API Name

Unique name in the API. Only underscores and alphanumeric characters.

Click Save. Then assign Acrolinx Sidebar to users via Permission Set Assignments > Edit Assignments.

4. Configure App Policies

  • In Quick Find, type External Client App Manager. Click AcrolinxUserConnectedApp.

  • Click Edit, expand OAuth Policies.

  • Change Permitted Users to Admin approved users are pre-authorized. Click OK.

  • Move Acrolinx Sidebar to Selected Permission Sets. Click Save.

5. Provide the Consumer Key and Private Key

Field

Description

Consumer Key

Identifies the customer to Salesforce and a consumer secret establishes the ownership of the consumer key.

Private Key

Used in the encryption/decryption of data sent between your server and Salesforce. You create this when you request your certificate with a Certificate Signing Request (CSR).

  1. On the AcrolinxUserConnectedApp page, click Settings > expand OAuth Settings > click Consumer Key and Secret.

  2. Copy the Consumer Key and paste it into the Acrolinx Setup Guide.

  3. Open your server.key file, copy entire contents, and paste into Private Key.

  4. Click Save.

6. Connect to the Acrolinx Platform

Salesforce_ConnecttoAcrolinx.png

  1. Click Edit and paste your Acrolinx URL into the Acrolinx URL field.

  2. Click Add next to Add the Acrolinx URL to the Remote Site Settings.

  3. Click Edit to turn on SSO and enter your SSO password.

7. Edit the Record Page

Salesforce_EditRecordPage.png

Add components to the record page in Salesforce so you can check articles with Acrolinx and view the Acrolinx Score.

8. Set Up Batch and Automated Checking (Optional)

Salesforce_SetUpBatchChecking.png

Complete this step if your license includes batch or automated checking.

Add Fields

Note

Fields apply to both batch and automated checking.

Field label

Description

Acrolinx Score

Field to store the Acrolinx Score.

Acrolinx Scorecard

Field to store a link to the Acrolinx Scorecard.

Embed Scorecard

Field to embed the Acrolinx Scorecard link below the Score.

Last Checked

Store the article's last checked date.

Score Status

Store the "Score Status" color value.

Score Color

Display the "Score Status" color.
Set Up Automated Checking

Click Apply to create a flow that starts an automatic check when you save or update an article.

Alternative: Go to Setup > Custom Settings > enable Platform Events for Automated Checking.

9. Customize the Edit with Acrolinx Page (Optional)

Salseforce_Customize_edit_with_Acrolinx_page.png

Exclude certain Knowledge article fields from an Acrolinx check. Go to Customize the "Edit with Acrolinx" Page (Optional) tab and click Add.

Notice

Also update your Content Profile: add div isExcludedWithFieldSet="true" to Element Name with Filter Mode = exclude.

Start Manual Cache Cleanup (Optional)

Cache refreshes automatically every 6 hours. For immediate cleanup:

  1. Click Acrolinx Setup Guide > Clear Cache for Batch Checking (Optional).

  2. Select a user and click Clear Cache.

Archived Versions

Acrolinx for Salesforce Knowledge 3.13

Connected App approach: Create Connected App, Set Permissions, Provide Keys, Connect to Platform, Edit Record Page, Batch Checking, Automated Checking, Customize Edit Page.

Acrolinx for Salesforce Knowledge 3.11 and 3.12

Same as 3.13 with "Add Fields" and "Enable Lightning Editor". See Install, Update, or Uninstall.

Acrolinx for Salesforce Knowledge 3.6–3.10

Basic setup structure. See Install, Update, or Uninstall.