Skip to main content
 

How can we help?

Search

Articles in this section
See more

Configure the AutoCheck Feature

  • Updated

The AutoCheck feature is available for Acrolinx Sidebar Integrations. AutoCheck is disabled by default, but when you enable it, writers see an extra "AutoCheck" option in the Sidebar. When a writer turns on AutoCheck, Acrolinx checks the active document at regular intervals. AutoCheck runs when a writer has a document open and hasn't interacted with the Sidebar for a certain period of time. It keeps running until the writer interacts with the Sidebar. If you're a Standard Stack user, you can enable AutoCheck and configure how often AutoCheck runs in the core server properties.

Tip

If you're on an Acrolinx Private Cloud 35469215 instance and are interested in these configurations, contact us and we'll set them for you!

If you're a Standard Stack user, you can edit the coreserver.properties from the configuration directory. Depending on your installation, your path might look like this:

<config directory>/server/bin/coreserver.properties.

Configuration Steps for Standard Stack

You configure AutoCheck with the following parameters:

Property

client.autoCheckEnabled

Default

false

Description

Enable or disable AutoCheck.

Property

client.autoCheckMinIntervalInS

Default

15 seconds

Description

The minimum amount of time to wait between two automatic checks

For example, you could configure this property so automatic checks happen every 30 seconds at a minimum.

Property

client.checkDelayExtractionFactor

Default

15

Description

Multiplier for time to wait after text extraction

This multiplier is designed to extend the AutoCheck time interval for large documents.

For large documents, it can take a while for Acrolinx to extract the text. Suppose that it takes 20 seconds. By the time the text is extracted, the next AutoCheck would be due to run again. This would cause Acrolinx to extract the text again in an infinite loop.

The multiplier is designed to prevent this situation.

Suppose that it takes 16 seconds to extract the text from your document and you keep the default multiplier of 15. Acrolinx will wait for 4 minutes before it runs the next AutoCheck.

Here's how we get to 4 minutes:

16 seconds (extraction time) * 15 (multiplier) = 240 seconds (240 / 60 = 4 minutes)

Note that the property client.checkFromTimeToTimeMinIntervalInS overrides this setting. If the calculated wait time is lower than the minimum time interval, Acrolinx uses the minimum time interval instead.

Property

client.checkDelayByUserInteractionInS

Default

10 seconds

Description

The time to wait after any interaction with the Sidebar is detected

For example, you might scroll down the list of cards or change tabs. In this case, Acrolinx would wait for 10 more seconds of Sidebar inactivity before starting an automatic check.

To configure time intervals for the "AutoCheck" feature, follow these steps:

  1. Open your overlay of the core server properties file.

  2. Add the following properties:

    client.autoCheckEnabled=true
client.autoCheckMinIntervalInS=<SECONDS>
client.checkDelayExtractionFactor=<NUMBER>
client.checkDelayByUserInteractionInS=<SECONDS>

    For example, you could raise all the default values like this:

    client.autoCheckEnabled=true
client.autoCheckMinIntervalInS=20
client.checkDelayExtractionFactor=20
client.checkDelayByUserInteractionInS=15

  3. Save your changes and restart the Acrolinx Platform.

  4. Ensure that users reopen their Acrolinx Integrations to receive the new setting. The new time settings will apply for any writer who turns on AutoCheck in the Sidebar.