Skip to main content
 

How can we help?

Search

Overview of Relevant Configuration Properties

  • Updated

Note

We've compiled a list of configuration properties that might be relevant for advanced Acrolinx Standard Stack administrators. The following tables provide an overview of some configuration properties broken down by server component. Another table provides overview of the default sessions time outs of various Acrolinx components.

You configure most Acrolinx properties in the core server properties file or the language configuration files, however you can configure some properties in other types of configuration files. For more information on how to configure each property, see the relevant topics.

TABLE 1. CORE SERVER PROPERTIES

You can use the properties in the following table to configure the behavior of the core server.

Tip

If you're on an Acrolinx Private Cloud 35469215.png 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.

Properties

Relevant Topics

authentication.useExternal

authentication.external

authentication.external.ldap.localAuthenticationLifetimeMinutes

Use an External Directory Service to Authenticate Users

authentication.lockout.attempts

Configure the number of times a user may enter an incorrect password before the account gets locked. You can set 0 to turn off the lockout feature. By default it's set to 5. Note that the last attempt will already trigger the "account locked" error message.

authentication.lockout.durationSeconds

Configure the duration of the lockout in seconds. Accounts that are locked because of incorrect passwords get unlocked after this time period or after you restart the server. This value must be greater than 0 since we don’t support manual account unlocking. The default value is 30 seconds.

client.userIdDefault

Setting the Suggested Acrolinx Username when Users Register

dashboard.useHierarchicalCategorySelector

Configure the Terminology Manager to Display Category-based Fields in Tree View.

dictionary.editableScopes

Configure the spelling exception lists that a writer can submit entries to from the Sidebar. The options are document, guidanceProfile, and language. By default it's set to guidanceProfile,document.

Learn more in our article on how to restrict access to spelling exception lists.

endpointListenHost

Restrict the address that the core server listens on.

externalBaseUrl

Secure End-User Communication with Acrolinx

http.logging.filename

Web request logging. Visit Manage the Server Logs for details.

internalSslKeystore

internalSslKeystorePassword

internalSslKeystore and internalSslKeystorePassword are similar to sslKeystore and sslKeystorePassword respectively, but for internal communication between your core server and all your other servers (Language servers and Analytics server). You need to set them both explicitly.

languageServers.largeTaskWaitThreshold

languageServers.batchTaskWaitThreshold

languageServers.largeTaskSizeThreshold

Optimize the check request queue.

maxParallelResourceLoadRequests

serializedResourceReloading

Configuring language configurations to reload simultaneously.

sanitization.sanitizers.terminology.idAlias

sanitization.sanitizers.terminology.replacedRanges

Prevent special characters from causing problems when entering terms.

schedulerQueueLimit

Define the maximum number of checks that the core server can hold in the check request queue. The limit is for the sum of all checks, regardless of language or other attributes.

Optimize the Check Request Queue

securityHeadersEnabled

Toggle security features like the SAMEORIGIN policy. You might need to set this to true if you're embedding the Acrolinx Term Browser in an iframe. It's set to false by default.

singleSignOn.genericPassword

singleSignOn.allowedRemoteAddresses

Set Up Acrolinx for single sign-on

termBrowser.authRequired

By default set to true to secure access to the Acrolinx Term Browser. Anyone who opens the Term Browser needs to enter their Acrolinx sign-in details. Additionally, they'll need the privilege "sign in to the term browser" to successfully sign in. This privilege is part of the built-in role "Term Browser User".

termContributionUrl.isEnabled

termContributionUrl.contextFieldName

Configure Term Contribution from the Acrolinx Scorecard.

termContribution.disableInternalTermContribution

termContributionUrl.template

termHelpUrl.template

Integrate Acrolinx with a Third-Party Terminology Solution

termContribution.authRequired

Enabling Anonymous Term Contribution

termSearchLog.enableProposalSubmission

termSearchLog.statusName

termSearchLog.domainName

termSearchLog.languageName

Enable users to propose terms from the search field in the Acrolinx Term Browser and configure the default settings for proposed terms.

useCustomizableAdmittedTermFlag

suggestAdmittedTerms

Configure the Checking Behavior for Admitted Terms

TABLE 2. LANGUAGE CONFIGURATION PROPERTIES

Warning

Acrolinx has started to phase out support for these configuration properties. If you’ve already enabled Targets, you won't be able to use them. Reach out to your Acrolinx contact if you have any questions, or view our Sunset Policy for more specific details.

You can use the properties in the following table to configure the checking behavior for a particular language. You configure these properties in the language configuration files. Depending on your installation, your path might look like this: <config directory>/ data/configurations.properties

Properties

Relevant Topics

harvestingRules

Configuring Term Discovery Behavior.

lengthChecker.sentenceLength

Configuring the Maximum Length for the 'Sentence Too Long' Guideline.

lengthChecker.sentenceTooLongRuleName

lengthChecker.sentenceTooLongPhrase

Configuring how the ''Sentence Too Long' Guideline appears for Integration users.

reuse.overrideOtherFlags

Preventing Reuse Issues from Overriding Other Issues.

reuseSentenceHelp

sentenceTooLongHelp

spellCheckerHelp

Customizing the Location of Help Files.

terminology.sources

Configure Term Sets in the Language Configuration File.

termharvesting.onlyServerSide

Configuring Term Discovery Behavior.

terminology.markAdmittedTerms

terminology.scoreAdmittedTerms

Configure the Checking Behavior for Admitted Terms

TABLE 3. OTHER PROPERTIES

You can use the properties in the following table to configure the component that is included in parentheses after the property name.

Properties

Relevant Topics

termhelp.template.root

(Term Browser properties)

<config directory>/data/data/termbrowser.properties

Configuring the Location of the Term Help Templates

OVERVIEW OF SESSION TIMEOUTS

Acrolinx Features

Core Server Properties (if available)

Settings

Acrolinx Platform

dashboard.session.timeout

For your security, Acrolinx signs you out of the dashboard after 24 hours of inactivity.

This property lets you change the default to a value of 2 minutes or more. Users can also set a timeout in the user settings themselves. Visit User Settings.

Term Browser

The Term Browser session timeout is 24 hours by default and can't be changed.

Translation View

The Translation View session timeout is 24 hours by default and can't be changed.

Term Contributor

termContribution.session.timeout=<MINUTES>

By default, Acrolinx will sign you out of the term contribution page after 30 minutes.

To meet the requirements of your organization, you can use this property to change this timeout to a value of 2 minutes or more. Visit Configure the Term Contributor.

Sidebar Integrations

license.authTokenExpireTimeMinutes=<MINUTES>

This property defines when authentication tokens expire. You can change the property to a value in minutes. By default, it's set to 43,200 minutes, which equals 30 days. Visit Use an External Directory Service to Authenticate Users.

Note

Tokens will expire sooner than this setting in the following cases:

  • You've changed your password before a token you've created expires.

  • You've created more than one API token in your dashboard settings

client.doNotStoreAccessToken

Set to false by default. To increase security, set it to true. When you do this, the Sidebar won't store authentication information. Instead, it'll just keep this information in memory.

Any saved access tokens will be deleted after a user signs in. This means that when you enable the doNotStoreAccessToken, a user can sign in one last time with any locally stored token.

Note

When you enable this feature, users will have to sign in each time they check a new document in most editors.

The Desktop Checker, Content Analyzer, and CLI use the same mechanism as the Sidebar.

The default session timeout for third-party CCMS integrations like AEM or WordPress depends on the settings in the CCMS. Acrolinx trusts these systems and doesn’t keep track of how long tokens are valid.

Sign-In Timeouts

Acrolinx supports five sign-in authentication options:

  • The default session timeout for the Acrolinx sign-in is 30 days.

  • The default session timeout for External Authentication with PingFederate (SAML 2.0, OpenId Connect) orGoogle (OAuth 2.0) is 30 days. Learn more in Use OAuth to Authenticate Users and Use SAML and PingFederate to Authenticate Users.

  • The default session timeout forJAAS/LDAP (on-prem deployment Authentication Option) is 30 days. Get more information in Use an External Directory Service to Authenticate Users.

  • The default session timeout for SSO (single sign-on) depends on the settings in the CCMS (AEM, Wordpress). Acrolinx trusts these systems and doesn’t keep track of how long tokens are valid. See Set Up Acrolinx for Single Sign-On.

  • You can use an API token for authentication. This authentication method makes it possible to skip the browser-based sign-in process and to run checks on your content without touching a browser or editor software. The API Token for SSO in automated Integrations is valid for 4 years and not configurable. Visit Create an API Token.