Configure Acrolinx integration

Introduction

Acrolinx allows you to provide central styleguides and then check your texts against these styleguides. For information on the overall functionality, see www.acrolinx.com.

For this purpose, Censhare integrates the Acrolinx Sidebar into Censhare Web.

For more information:

• Use Acrolinx sidebar in Censhare Web.

• Acrolinx sidebar and its related functionality, see Acrolinx documentation Check With Acrolinx.

The configuration consists of two parts:

• Configure access to Acrolinx system: This sets up the connection of the Censhare Server to the Acrolinx system that is doing the analysis of the text.

• Configuration of the Cloud Gateway: A route in the Cloud Gateway must be added. This route allows the Cloud Gateway to handle calls related to Acrolinx properly.

Prerequisites

You must have an Acrolinx license by Markup AI (formerly Acrolinx) to use the Acrolinx integration in Censhare.

You have received the following information by Markup AI:

• Acrolinx server URL: This is the URL of the Acrolinx system to which the Censhare Server shall send its requests.

• SSO Secret key: This is the key that is required for authentication with the Acrolinx system.

• Language mapping keys: For any language that you want to use with Acrolinx, you require a language key provided by Markup AI.

Configure access to Acrolinx system

Open Censhare Admin Client

1. Open Censhare Admin Client.

2. Switch into the Admin mode for the Censhare Admin Client. This is required because you must enter the values in XML configuration itself. For more information, see Switch to Admin mode - Admin Client.

3. Go to Configuration / Modules / Acrolinx settings.

4. Double click on the Acrolinx settings server action to open.

5. in the top menu list of the Censhare Admin Client, click Admin and select Show/edit XML file.

6. The XML view of the configuration opens.

Configure Acrolinx settings

General setup:

1. Got to the line:

   XML

    <cmd-info name="acrolinx.configuration" type="server-action" enabled="false" ignore-error="true">
   

2. Enable the server action: set enabled to true:

   XML

    <cmd-info name="acrolinx.configuration" type="server-action" enabled="true" ignore-error="true">
   

Special setup:

1. Go to:

   XML

     ...
     <mapping/>
   </cmd>
   

2. Enter the following template between the two XML tags:

   XML

     <acrolinx server="ACROLINX_SERVER_URL" secret="SSO_SECRET_KEY">
       <language cs_language="LANG_ID" profile="ACROLINX_PROFILE_KEY"/>
     </acrolinx>
   

3. Replace ACROLINX_SERVER_URL with the URL that you have received by Markup AI.

4. Replace SSO_SECRET_KEY with the key that you have received by Markup AI.

5. Add at least one language mapping: Replace LANG_ID with the Censhare language ID, for example de. You can find an overview about all IDs in the Master data of the Censhare Admin Client: Open the Languages table in the Master data section. The ID column shows the available language IDs.

6. Replace ACROLINX_PROFILE_KEY with the respective language mapping key that you have received by Markup AI.

7. If you want to use more than one language, add another <language ... /> entry below the existing one and replace LANG_ID and ACROLINX_PROFILE_KEY accordingly.

8. Your added XML code can then look like this, for example:

   XML

       ...
       <mapping/> 
       <acrolinx server="https://DNS_NAME" secret="wqelrkn4r99323Y">
         <language cs_language="de" profile="KEY1"/>
         <language cs_language="en" profile="KEY2"/>
       </acrolinx>
     </cmd>
   

9. Click OK to save your changes in the XML view.

10. Click OK to save your changes in the Acrolinx settings configuration.

Update your Censhare Server

1. Update your Censhare Server in the Censhare Admin Client.

2. Your changes become immediately active. No server restart is necessary.

3. Users must refresh their Censhare Web browser tab to get changes in the configuration active.

Configure Cloud gateway: Censhare Cloud

The configuation of the Cloud Gateway must be done by Censhare IT: Create a ticket for it.

Configure Cloud gateway: Censhare Classic

These instructions assume that Censhare Server and Cloud Gateway are running on the same Virtual Machine (VM). Depending on your Censhare Classic setup this might be different.

1. Access the VM:

   Bash

   ssh root@VM-IP
   

VM-IP is the address of your Virtual Machine.

2. Go to the configuration folder of the Cloud Gateway, for example:

   Bash

   cd /opt/censer/core-cloud-gateway/
   

3. Open the application.yml file, for example:

   Bash

   vi application.yml
   

4. Scroll down to the "spring.cloud.gateway.routes:" section.

5. Add the following route somewhere below in this section:

   YAML

   - id: acrolinx_9000
     uri: CENSHARE_SERVER_HOST_PORT
     predicates:
     - Path=/acrolinx/**          # keeps the full /acrolinx/… path
     filters:
     - CustomTokenRelay
   

   CENSHARE_SERVER_HOST_PORT is the DNS entry of the server and the configured port for it. Depending on your Cloud Gateway configuration, this can also be a variable, for example:

   Bash

   http://${CENSHARE_SERVER_HOST_PORT}
   

6. Restart the Cloud Gateway, for example:

   Bash

   systemctl restart censhare.core-cloud-gateway.service
   

7. Check the status of the Cloud Gateway, for example:

   Bash

   systemctl status censhare.core-cloud-gateway.service