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 Oxygen XML Web Author to connect to Acrolinx, follow these steps:
Go to the Administration Page, then Click Settings > Plugins.
Find Acrolinx for Oxygen XML Web Author in the list and click Configure. A Plugin configuration dialog box appears.
In the Single Sign-on Settings section, check Enable Single Sign-on.
In the Acrolinx URL 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
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.
Click Apply to save your configuration.
You can now run checks in Oxygen XML Web Author with Acrolinx!
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 Oxygen XML Web Author can use to connect to Acrolinx.
Go to the Acrolinx Dashboard and add a user. The user should have the default role Author.
Make a note of the sign-in details — you'll need them later.
In Oxygen XML Web Author, go to Administration > Plugins and click Configure under Acrolinx for Oxygen XML Web Author.
Enter your Acrolinx URL in the Acrolinx URL field.
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.
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.