Acrolinx for Oxygen XML Web Author Admin Guide

How Acrolinx Interacts with Your Web Application

The following diagram illustrates how Acrolinx fits into the architecture of your web application. The web application communicates exclusively with your web server proxy. Your web server then passes checking requests on to the Acrolinx server. Acrolinx uses single sign-on to authenticate users with your web application.

General Configurations

Set Up Acrolinx for Single Sign-On (SSO)

Before you can use Acrolinx for Oxygen XML Web Author, you'll need to set up SSO for Acrolinx. To do this, follow the process in the article Set Up Acrolinx for Single Sign-on.

Connect to Acrolinx

Before you can check your content, you'll need to configure Oxygen XML Web Author to route internal checking requests to Acrolinx.

To enable Oxygen XML Web Author to connect to Acrolinx, follow these steps:

  1. Go to the Administration Page, then Click Settings > Plugins.
  2. Find Acrolinx for Oxygen XML Web Author in the list and click Configure. A Plugin configuration dialog box appears.
  3. In the Single Sign-on Settings section, check Enable Single Sign-on.
  4. In the Acrolinx address field, enter your Acrolinx URL with the default core server port number. For example, if your Acrolinx Platform is at https://demo-inc.acrolinx.com you would enter the URL as https://demo-inc.acrolinx.com:8031
  5. In the Single sign-on password field, enter the password that you configured in the core server properties file when enabling single sign-on for Acrolinx.
  6. Click Apply to save your configuration.

You can now run checks in Oxygen XML Web Author with Acrolinx!


 To Connect Without Single Sign-on

We don't recommend it, but you might need to disable single sign-on (SSO) for testing purposes. To do so, you'll need to create an Acrolinx user that Oxygen XML Web Author can use to connect to Acrolinx.

  1. First, go to the Acrolinx Dashboard and create a user.

    The user should have the default role Technical Writer or, if the role isn’t there, a role with the privileges Check documents and Run Term Harvesting.

    Make a note of the sign-in details - you'll need them later.

  2. You need to enable Cross-Origin Resource Sharing (CORS).
  3. In Oxygen XML Web Author, go to Administration Page > Plugins and click Configure under Acrolinx for Oxygen XML Web Author.
  4. Enter your Acrolinx URL in the Acrolinx server address field.
  5. When you open the Sidebar the first-time click Connect. Then click SIGN IN to open the Acrolinx sign-in page. A browser window opens where you can enter your sign-in details and confirm the request to access.
  6. Click Save.

Optional: Embed Check Data

Acrolinx for Oxygen XML Web Author supports embedding your check results directly in your document.

Here’s an example of how embedded check data looks for XML documents:

Example
acrolinxCheckData score="82" scorecardUrl=">SERVER_ADDRESS</output/en/gear_pump_xhtml_admin_38616c5a5ff3e6fe_1_report.html" timeStarted="2017-10-10T06:24:03Z" status="green"

To learn more, see our article on Embed Check Data for Sidebar Integrations.

If you're an Acrolinx On-premise customer, you'll first need to make some changes to an Acrolinx Core Platform properties file. You can find the steps in the article Embed Check Data for Sidebar Edition Integrations.

Optional: Manually Turn the Proxy Model on or Off

For single sign-on (SSO) to work correctly, Acrolinx uses a built-in proxy module that runs on the Oxygen XML Web Author server. When you configure SSO, this proxy module is turned on automatically. When you don't configure SSO then the proxy module stays turned off. However, if you want to turn the proxy module on, you can use this property.

To turn the proxy module in Acrolinx on or off, follow these steps:

  1. Go to the Administration Page, then Click Settings > Plugins.
  2. Find Acrolinx in the list and click Configure. A 'Plugin configuration' dialog box appears.
  3. In the Default Check Settings section, change the line to "useAcrolinxProxy": true to turn the proxy on or "useAcrolinxProxy": false to turn the proxy off.
  4. Click Apply to save your configuration.

Optional: Set the Default Checking Options

Administrators can configure the default checking options that get automatically applied for all users. This is helpful in environments where users typically work with the same type of document (for example creating posts for the company blog) and always require the same checking options. This feature also prevents problems that can occur when users select the wrong checking options by mistake.

Users receive the default checking options that the administrator has configured, but they can change these options and save their changes. If the user reloads the page or opens a new document, their saved checking options are applied. Changes the user makes to these checking options are saved in the cache of the web browser.

To configure the default checking options, follow these steps:

  1. Go to the Administration Page, then Click Settings > Plugins.
  2. Find Acrolinx in the list and click Configure. A 'Plugin configuration' dialog box appears.
  3. To configure the default checking options, update the following code in the Default Check Settings section:

    "defaultCheckSettings": { "language" : "<LANGUAGE_ID>", "ruleSetName" : "<RULE_SET>", "clientInformation" : {}, "checkSpelling" : <TRUE/FALSE>, "checkGrammar" : <TRUE/FALSE>, "checkStyle" : <TRUE/FALSE>, "checkReuse" : <TRUE/FALSE>, "checkSeo" : <TRUE/FALSE>, "harvestTerms" : <TRUE/FALSE>, "termSets" : [ "<TERM_SET>", "<TERM_SET>" ], "termStatuses" : [ "<TERMINOLOGY_OPTION>" ] } The following values are admitted for <TERMINOLOGY_OPTION> :
    TERMINOLOGY_DEPRECATED to check for deprecated terms.
    TERMINOLOGY_ADMITTED to check for admitted terms.
    TERMINOLOGY_VALID to check for valid terms.
  4. Click Apply to save your configuration.