Skip to main content
 

How can we help?

Search

Admin Guide

  • Updated

Caution

To set up Oxygen WebAuthor, you need to contact the Acrolinx Support team. Decide which authentication method you want to use:

  1. With SSO - Our support will send you a password.

  2. Without SSO - Send us the URL of your (proxy) server to be stored as a CORS entry.

General Configurations

Set Up Acrolinx for Single Sign-On (SSO)

Before you can use Acrolinx for Oxygen XML Web Author, we recommend that you set up SSO for Acrolinx. To do this, follow the process in the article Set Up Acrolinx for Single Sign-On.

If you rely on another proxy solution, see Connect to Acrolinx Without SSO for more information.

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 the 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 URL field, enter your Acrolinx URL. For example, https://demo-inc.acrolinx.com.

  5. In the Single sign-on password field, enter the general access token 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!

Optional Configurations

Connect to Acrolinx Without SSO

If you use a different proxy solution to secure communication with Acrolinx, it's possible to connect to your Acrolinx Platform without SSO. To get started, you'll need to create an Acrolinx user that the Oxygen XML Web Author can use to connect to Acrolinx.

  1. Go to the Acrolinx Dashboard and add a user. The user should have the default role Author.

    Tip

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

  2. Enable Cross-Origin Resource Sharing (CORS).

  3. In Oxygen XML Web Author, go to Administration > Plugins and click Configure under Acrolinx for Oxygen XML Web Author.

  4. Enter your Acrolinx URL in the Acrolinx URL 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.

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:

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.