Embed Check Data for Sidebar Integrations

Why Embed Check Data?

To get insight into the quality of a piece of content, writers and managers might like to see the Acrolinx Score with a link to the Scorecard directly in the content management system (CMS). If your Acrolinx administrator enables Embed Check Data, then your CMS administrator can show the metadata for each document. You can get an overview of the quality of all content in a glance and even use this information to make business decisions such as readiness for publishing or translation.

How Can I Use Embed Check Data?

With Embed Check Data enabled, Acrolinx embeds the check data in the document when you check the whole document.
The following example shows typical check data. Typical check data includes the Acrolinx Score, the Scorecard URL, the time that the check started and the checking status. The values are identical to the information in the Acrolinx Scorecard.

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"

Your documentation environment tracks the status of the document throughout its life cycle.


Not all Acrolinx Integrations support Embed Check Data, and there are differences in how each Integration handles the data. Some Integrations automatically display the data in the CMS. Other Integrations embed the data in the document (usually as a processing instruction) and let you decide how you'd like to use it.

The latest versions of the following Acrolinx Integrations support Embed Check Data:

IntegrationEmbed Check DataAutomatically Display Check Data*
Arbortext
Drupal
FrameMaker
MadCap Flare
Oxygen Eclipse

Oxygen XML Editor and XML Author


Oxygen XML Web Author
XMetaL
WordPress

*These Integrations automatically display the Acrolinx check data in the editor user interface. There's nothing to stop you building a similar display in any of the other editors, though!

Turn On Embed Check Data

Once you turn on Embed Check Data on your Acrolinx Core Platform, it will be available to any connected Acrolinx Integration from the table above.

To display the data in Drupal, a Drupal admin needs to take a few extra steps.


To turn on Embed Check Data on your Core Platform, follow these steps:

  1. Open the coreserver.properties

    To edit coreserver.properties from the Dashboard, go to Maintenance > Configuration Properties, then follow the folder structure config > server > bin and click on the file coreserver.properties. You can then edit the properties directly from the Dashboard.

    Alternatively, you can edit coreserver.properties from the configuration directory: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties

  2. Add the following property:

    client.embedCheckData=true
  3. Save your changes and restart the core server.