You can configure the server so that most plug-in settings are already configured for your users based on a "model user". The model user acts as a template that defines the plug-in settings for all other users.
Most of the settings that are visible in the Acrolinx Plug-in options dialog are saved in a user properties file which is stored on the Acrolinx Server . These properties include basic plug-in preferences, segmentation and filter settings, and checking options. You can use the model user to define all of these settings for your users.
Configuring the Model User
To set the default properties for each new user, you must create a model user properties file. The model user properties file acts as a template when the server creates new user properties files.
Creating the Model User Properties File and Setting the Model User
To create the model user properties file and select the model user, follow these steps:
- Open a host client with the relevant Acrolinx plug-in installed.
Open a document that your
users are likely to check.
Tip: If you work mainly with XML documents, ensure that the document is based on a DTD which is widely used in your team . All users will then inherit the segmentation and filter settings, regardless of what XML editor they use.
- Open the Acrolinx Options .
- Connect to your Acrolinx Server , and if prompted, register using the desired model user ID. Ensure that the user has a role with the privilege Edit plug-in segmentation and filter settings .
Configure the desired
options for the model user and click
(refer to the relevant plug-in
user guide for more information).
Restriction: The settings that you define on the Check tab in the plug-in options are only distributed to users who check with the same plug-in as you.
For example, if you select the checking options "Spelling", "Grammar", and "Terminology" in the Acrolinx Plug-in for Microsoft Word , users who check with the Acrolinx Plug-in for JustSystems XMetaL will not receive these settings as their default check settings. Only Word plug-in users receive these settings.
To ensure that the check settings are consistent for all plug-ins that your users have installed, define the check settings in each plug-in that is deployed in your organization.
- Navigate to the location where your user properties are stored, and check that a properties file has been created for your model user ID.
- In the Dashboard, navigate to the Users page and select the Model user by clicking the Change button and entering the desired model user ID.
- Click OK and restart the core server.
Updating the Model User Properties
If you update the model user properties, all users automatically inherit the changes. However, if your users have the appropriate privileges, they can update their plug-in options and override specific settings. If you update the model user properties, users only inherit the settings that do not conflict with their changes. For example, if you change the list of excluded elements for the model user, any user who has also made changes to the list of excluded elements will not automatically inherit the new list from the model user. This behavior ensures that changes that users make are not lost when the model user properties are updated. To ensure that all users in inherit all changes to the model user properties, you must remove any user-specific settings first.
To update the model user properties file, follow these steps:
- Open your editor application.
- Open the Acrolinx Options .
- Connect to your Acrolinx Server , and if prompted, register using the model user ID.
- Update the options for the model user (refer to the relevant plug-in user guide for more information).
- Click OK .
To ensure all users inherit all of your updates, check for any user
properties that conflict with your changes.
You can remove conflicting user properties by individually removing the conflicting properties from each user properties file or by deleting all user properties files.
If you delete an entire user properties file, you also delete any other changes that the user has made to their settings - even if the changes do not conflict with the changes you have made to the model user.
- Restart the core server.
- Have an end user open their plug-in options and check that the user has received the new settings.
Configuring the Location of the User Properties Files
When a user registers with the Acrolinx Server for the first time, the server creates a user properties file ( USER_NAME.properties ) which is stored in the default location:
If desired, you can set a new location to store the user properties files.
To change the location where user properties are stored, follow these steps:
How the Plug-ins Get Extraction Settings from the Server
If your users do not receive the extraction settings that you expect, you might have to troubleshoot how the extraction settings are allocated. To troubleshoot effectively, it is important to understand how the plug-ins get the right extraction settings from the Acrolinx server.
Document Type Identifiers
The Acrolinx plug-ins use different document type identifiers to get the right extraction settings from the Acrolinx server. For example, all plug-ins have a unique signature that the Acrolinx server can also use to determine the document type.
For example, if you check a document with the Acrolinx Plug-in for Microsoft Word, the server can assign the identifier "Word document" to your document and get the right extraction settings.
If you work with XML, the Acrolinx server can also use the information about the Document Type Definition (DTD) that is included in each XML file.
Suppose that you have several sets of extraction settings that are saved in Acrolinx and included in one checking profile that is assigned to you. When you run a check or open the Acrolinx options, Acrolinx takes the following steps to find the right extraction settings for your document:
The Acrolinx plug-in sends information about the document type to the Acrolinx
This information is divided up into identifiers. One identifier could be the plug-in signature and another identifier could be the public ID.
To learn more about these identifiers, review the full list of the document type identifiers .
The server checks this information against the information about the currently saved
If all identifiers from the plug-in match the identifiers in a set of saved extraction
settings, the server makes these settings available to you.
Some plug-ins send only one identifier such as the plug-in signature:
- If you have saved extraction settings that also contain the same plug-in signature and nothing else, the server makes these settings available to you.
If your saved extraction settings contain the same plug-in signature but also another
identifier such as the public ID, you will not receive these extraction settings.
This behavior occurs because there is a mismatch between the identifiers that the plug-in provides and the identifiers that the server has stored.
If you use server-side extraction, and you have several matching sets of extraction settings, the server selects the first set of extraction settings in the list of matches and applies the settings to the document.
If the identifiers from the plug-in do not match any combination of identifiers that are
in each of your saved extraction settings, you will not receive any extraction settings at
In this case, you must define new extraction settings in the plug-in interface, save them, and assign them to your checking profile.
- If all identifiers from the plug-in match the identifiers in a set of saved extraction settings, the server makes these settings available to you.