If you manage a team of authors, you can use comparative checking to measure how a document has improved after authors use Acrolinx to correct a document. To use comparative checking, you must enable the Acrolinx Reporting Database Connector to store your checking results to a reporting database.
When you enable comparative checking, the plug-ins automatically run a check in the background when a user closes a document that they have edited or checked. The document is checked in the background as long as the user has previously edited or checked the document by using the Check or Check with Corrections Dialog functions.
The results of all background checks are written to your reporting database. You can use this data to compare the checking results before and after the author corrects a document with Acrolinx. The metadata is stored in the table UserMetaDataEjb . You can use this reporting data to measure the benefits and return on investment that Acrolinx provides.
The Scorecard and reporting data for each background check contain the metadata backgroundCheck=true so that you can compare checks that Acrolinx ran automatically in the background with checks that users ran.
Before you enable comparative checking, you should establish how you want to compare the checking data and work with your database administrator to develop database queries that you can use to generate comparison reports. If you are unsure about how to generate comparison reports, contact your Acrolinx project consultant who can assist you in getting started.
Enabling Comparative Checking
You enable comparative checking in the core server properties file. You can enable comparative checking for all plug-ins with the version 2.5 or later. When enabled, Acrolinx checks the document in the background when a user closes a file that they have edited or checked. No information about the final check is visible to the user.
To enable comparative checking for all supported plug-ins, follow these steps:
Open your overlay of the core server properties file.
You find the overlay for the core server properties file in the following location:
Add the following property:
- Save your changes and restart the core server.
Reopen your Acrolinx plug-in and run a check.
The plug-ins start to run comparative checks after you connect to the server and run an initial check.
List of Supported Plug-ins
The following table lists all Acrolinx plug-ins that support comparative checking.
|Acrolinx Plug-in for||Comparative check when closing a single document||Comparative check when closing editor with multiple documents|
|Arbortext Editor||Yes||Only the last closed document|
|JustSystems XMetaL||Yes||Only the last closed document|
|MadCap Flare||Yes||Multiple documents. The plug-in uses the check settings from the last manually checked document.|
|Microsoft PowerPoint||Yes. The comparative check is skipped if the text extraction of the original document took more than 2 minutes.||n/a|
|Microsoft Word||Yes. The comparative check is skipped if the text extraction of the original document took more than 2 minutes.||n/a|
|<oXygen/> XML Editor||Yes||Multiple documents|