To get insight into the quality of a piece of content, writers and managers might like to see the Acrolinx Score directly in their content management system (CMS). With Embed Check Data, your CMS administrator can show the metadata for each document. This gives you an overview of the quality of all content at a glance and lets you click the score to access the Scorecard. Use this information to make business decisions such as readiness for publishing or translation.

When you enable Embed Check Data, Acrolinx embeds check data when you run a check on a 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 the same as the values you see 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:

*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!

Note that once you turn on Embed Check Data in your Acrolinx Platform, it will be available to any connected Acrolinx Integration from the table above.

To turn on Embed Check Data on your Standard Stack instance, follow these steps: