This document describes the interface of the Acrolinx Sidebar. Batch checking feature is only supported from sidebar version 15.0 and Core Platform version 2021.12.

Let's understand how the typical bootstrapping of an integration and the Acrolinx Sidebar works:

1. Load the host editor of your integration.

2. Load your integration code.

3. Register your integration as an AcrolinxPlugin.

var acrolinxPlugin = {...}
Copy

Check the AcrolinxPlugin interface for required methods, that you need to implement.

4. Load the sidebar and the referenced libraries code (usually sidebar.js, libs.js, sidebar.css).

5. Once the sidebar has finished loading it will request the integration to initialize by calling AcrolinxPlugin.requestInit|requestInit.

6. The AcrolinxPlugin now must call AcrolinxSidebar.init|init.

7. Once the init process has finished, the plug-in will be notified: AcrolinxPlugin.onInitFinished|onInitFinished.

8. If the user pushes the button "Check" or "Batch Check", AcrolinxPlugin.requestGlobalCheck|requestGlobalCheck is called. In case of a batch check, the flag RequestGlobalCheckOptions.batchCheck|batchCheck in options is set to true.

9. The acrolinxPlugin must call AcrolinxSidebar.checkGlobal|checkGlobal to perform a check. In case of a batch check, the acrolinxPlugin must call AcrolinxSidebar.initBatchCheck|initBatchCheck with a list of document identifiers to be checked.

10. When a regular check has finished, AcrolinxPlugin.onCheckResult|onCheckResult is called and the sidebar displays cards for the issues.

11. If the user clicks a card after a regular check, AcrolinxPlugin.selectRanges|selectRanges is called

12. When the user selects a replacement after a regular check, AcrolinxPlugin.replaceRanges|replaceRanges is called.

13. When a batch check is started, the sidebar will request the integration to initiate a check for each document identifier by calling AcrolinxPlugin.requestCheckForDocumentInBatch|requestCheckForDocumentInBatch.

14. The acrolinxPlugin must then call AcrolinxSidebar.checkDocumentInBatch|checkDocumentInBatch to perform a check on a given document.

15. If the user clicks a card after the batch check has started, AcrolinxPlugin.openDocumentInEditor|openDocumentInEditor is called requesting acrolinxPlugin to open the document.

For a minimal integration (not feature complete) you must implement requestInit, requestGlobalCheck, selectRanges and replaceRanges.