Skip to main content
 

How can we help?

Search

Install and Update

  • Updated

What you should know about installing Acrolinx for Salesforce Knowledge.

Before You Install

If you want to know whether this version of the Acrolinx Integration works with your local platforms, check our Compatibility Guide.

Before you install, make sure that you already have the following:

Salesforce Knowledge

Acrolinx for Salesforce Knowledge Versions

Acrolinx Platform

Supported Salesforce Knowledge Versions

Notes

3.8

2023.05

Winter '24

3.6, 3.7.2

2023.05

Summer '23

CKEditor version 4.18.0

Salesforce Knowledge 3.8

Install and Update Acrolinx for Salesforce Knowledge 3.8

Install

First, make sure you've installed everything you need – see the section What You Should Know Before Installing above.

To install Acrolinx in Salesforce, follow these steps:

  1. Request the installation URL and installation key. You'll need to use the URL specific to the type of instance you want to install.

    Install a Production Instance

    URL:  https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5w000005hlEmAAI
Key:  lfQdkNb3ike6qx

    Install a Sandbox Instance

    URL: https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5w000005hlEmAAI 
Key: lfQdkNb3ike6qx

    Tip

    Want to see a complete list of the package components? Click View Components at the bottom of the install page for Acrolinx for Salesforce Knowledge.

  2. Follow the Salesforce instructions for installing managed packages.

    Warning

    After you install the integration, you'll need to take some extra steps before you can check your Salesforce content with Acrolinx. Visit the Acrolinx for Salesforce Knowledge Admin Guide for these details.

Update

To update Acrolinx for Salesforce Knowledge, follow the steps under Install. You don't need to remove the older version first.

Once you've installed the updated version of Acrolinx for Salesforce Knowledge 3.8, follow the steps in the Admin Guide to complete the setup. Before you set up automated checking, be sure to disable the old score calculation trigger.

Notice

Depending on your previous installation, you may find that some of the setup steps for Acrolinx for Salesforce Knowledge are already complete.

Remove Score Calculation Trigger

To remove the score calculation trigger from Salesforce, to the following:

  1. Manually create an archive with the files destructiveChanges.xml and package.xml.

    Tip

    Replace TriggerName and TriggerClassName with the corresponding names that are used in your org.

    destructiveChanges.xml:

    <?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>[TriggerName]</members>
        <name>ApexTrigger</name>
    </types>
    <types>
        <members>[TriggerTestClassName]</members>
        <name>ApexClass</name>
    </types>


    <version>59.0</version>
</Package>

    package.xml:

    <?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <version>59.0</version>
</Package>

  2. Sign in to Salesforce Workbench at https://workbench.developerforce.com/. Select your preferred environment (sandbox or production) from the dropdown in the top-right corner.

  3. Navigate to Migration > Deploy.

  4. Choose the archive files you created in step 1, and select Rollback on Error and Single Package.

  5. In the dropdown next to Test Level, select RunAllTests. Next to Run Tests type the name of the trigger test class TriggerTestClassName. Click Next.

  6. Click Deploy to start your deployment. You'll see the status Succeeded once the deployment is complete.

  7. Go to Object Manager > Knowledge__kav > triggers to make sure the trigger was removed.

Salesforce Knowledge 3.7.2

Install and Update Acrolinx for Salesforce Knowledge 3.7.2

Install

First, make sure you've installed everything you need – see the section What You Should Know Before Installing above.

To install Acrolinx in Salesforce, follow these steps:

  1. Request the installation URL and installation key. You'll need to use the URL specific to the type of instance you want to install.

    Install a Production Instance

    URL:  https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5w000005hl3YAAQ
Key:  lfQdkNb3ike6qx

    Install a Sandbox Instance

    URL: https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5w000005hl3YAAQ 
Key: lfQdkNb3ike6qx

    Tip

    Want to see a complete list of the package components? Click View Components at the bottom of the install page for Acrolinx for Salesforce Knowledge.

  2. Follow the Salesforce instructions for installing managed packages.

    Warning

    After you install the integration, you'll need to take some extra steps before you can check your Salesforce content with Acrolinx. Visit the Acrolinx for Salesforce Knowledge Admin Guide for these technical details.

Update

To update Acrolinx for Salesforce Knowledge, follow the steps under Install. You don't need to remove the older version first.

Once you've installed the updated version of Acrolinx for Salesforce Knowledge 3.7.2, follow the steps in the Admin Guide to complete the setup. Before you set up automated checking, be sure to disable the old score calculation trigger.

Notice

Depending on your previous installation, you may find that some of the setup steps for Acrolinx for Salesforce Knowledge are already complete.

Remove Score Calculation Trigger

To remove the score calculation trigger from Salesforce, to the following:

  1. Manually create an archive with the files destructiveChanges.xml and package.xml.

    Tip

    Replace TriggerName and TriggerClassName with the corresponding names that are used in your org.

    destructiveChanges.xml:

    <?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>[TriggerName]</members>
        <name>ApexTrigger</name>
    </types>
    <types>
        <members>[TriggerTestClassName]</members>
        <name>ApexClass</name>
    </types>


    <version>59.0</version>
</Package>

    package.xml:

    <?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <version>59.0</version>
</Package>

  2. Sign in to Salesforce Workbench at https://workbench.developerforce.com/. Select your preferred environment (sandbox or production) from the dropdown in the top-right corner.

  3. Navigate to Migration > Deploy.

  4. Choose the archive files you created in step 1, and select Rollback on Error and Single Package.

  5. In the dropdown next to Test Level, select RunAllTests. Next to Run Tests type the name of the trigger test class TriggerTestClassName. Click Next.

  6. Click Deploy to start your deployment. You'll see the status Succeeded once the deployment is complete.

  7. Go to Object Manager > Knowledge__kav > triggers to make sure the trigger was removed.

Salesforce Knowledge 3.6

Install and Update Acrolinx for Salesforce Knowledge 3.6

Install

First, make sure you've installed everything you need – see the section What You Should Know Before Installing above.

To install Acrolinx in Salesforce, follow these steps:

  1. Request the installation URL and installation key. You'll need to use the URL specific to the type of instance you want to install.

    Install a Production Instance

    URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5w000005hkqFAAQ
Key: lfQdkNb3ike6qx

    Install a Sandbox Instance

    URL: https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5w000005hkqFAAQ
Key: lfQdkNb3ike6qx

    Tip

    Want to see a complete list of the package components? Click View Components at the bottom of the install page for Acrolinx for Salesforce Knowledge.

  2. Follow the Salesforce instructions for installing managed packages.

    Warning

    After you install the integration, you'll need to take some extra steps before you can check your Salesforce content with Acrolinx. Visit the Acrolinx for Salesforce Knowledge Admin Guide for these technical details.

Update

To update Acrolinx for Salesforce Knowledge, follow the steps under Install. You don't need to remove the older version first.

Once you've installed the updated version of Acrolinx for Salesforce Knowledge 3.6, follow the steps in the Admin Guide to complete the setup. Before you set up automated checking, be sure to remove the old score calculation trigger if you have one.

Notice

Depending on your previous installation, you may find that some of the setup steps for Acrolinx for Salesforce Knowledge are already complete.

Remove Score Calculation Trigger

To remove the score calculation trigger from Salesforce, to the following:

  1. Manually create an archive with the files destructiveChanges.xml and package.xml.

    Tip

    Replace TriggerName and TriggerClassName with the corresponding names that are used in your org.

    destructiveChanges.xml:

    <?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>[TriggerName]</members>
        <name>ApexTrigger</name>
    </types>
    <types>
        <members>[TriggerTestClassName]</members>
        <name>ApexClass</name>
    </types>


    <version>59.0</version>
</Package>

    package.xml:

    <?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <version>59.0</version>
</Package>

  2. Sign in to Salesforce Workbench at https://workbench.developerforce.com/. Select your preferred environment (sandbox or production) from the dropdown in the top-right corner.

  3. Navigate to Migration > Deploy.

  4. Choose the archive files you created in step 1, and select Rollback on Error and Single Package.

  5. In the dropdown next to Test Level, select RunAllTests. Next to Run Tests type the name of the trigger test class TriggerTestClassName. Click Next.

  6. Click Deploy to start your deployment. You'll see the status Succeeded once the deployment is complete.

  7. Go to Object Manager > Knowledge__kav > triggers to make sure the trigger was removed.

Salesforce Knowledge 3.4

Install and Update Acrolinx for Salesforce Knowledge 3.4

Install

First, make sure you've installed everything you need – see the section What You Should Know Before Installing above.

To install Acrolinx in Salesforce, follow these steps:

  1. Request the installation URL and installation key. You'll need to use the URL specific to the type of instance you want to install.

    Install a Production Instance

    URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t2I000000KnTiQAK
Key: o7LWZe5kjpXg

    Install a Sandbox Instance

    URL: https://test.salesforce.com/packaging/installPackage.apexp?p0=04t2I000000KnTiQAK
Key: o7LWZe5kjpXg

    Tip

    Want to see a complete list of the package components? Click View Components at the bottom of the install page for Acrolinx for Salesforce Knowledge.

  2. Follow the Salesforce instructions for installing managed packages.

    Warning

    After you install the integration, you'll need to take some extra steps before you can check your Salesforce content with Acrolinx. See the Acrolinx for Salesforce Knowledge Admin Guide for these technical details.

Update

When you update Acrolinx for Salesforce Knowledge, some of the components won't refresh automatically. There are a few things that you need to do before you can start using the latest version.

Update Batch Job Layouts

Some of the layouts may have changed between versions, so you'll need to update them.

  1. Go toSetup > Object Manager > Acrolinx Batch Check > Page Layouts.

  2. Click on Page Layout Assignment > Edit Assignment.

  3. Select all profiles from the list (press ctrl or cmd + click), and select Acrolinx Batch Job Layout next to Page Layout to Use.

  4. Click Save.

  5. Repeat the steps above for the Acrolinx Batch Job Row Layout.

Update Search Layout and List View

After you update your layouts, you can add the new fields to the Search Layout and List View for the Acrolinx Batch Check object.

Update Search Layout

  1. Go to Setup > Object Manager > Acrolinx Batch Check > Search Layouts.

    Tip

    Don't see Search Layouts? Go to Setup > Tabs. Click Edit next to Acrolinx Batch Checks and then Save.

  2. ClickEdit next to Default Layout.

  3. Remove Created Date from the Selected Fields list, and addthe following fields to the Selected Fields column:

    • Start Time

    • End Time

    • Status

    • Average Score

  4. Click Save.

Update List View

  1. Go to the Check History tab in the Acrolinx App.

  2. Select All under Select a List View.

  3. Click List View Controls and then Select Fields to Display.

  4. Remove Created Date from the Visible Fields column, and add the following fields to the Visible Fields column:

    • Start Time

    • End Time

    • Status

    • Average Score

  5. Click Save.