|Acrolinx Server||4.3, 4.4, 4.5, 4.6, 4.7, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5|
How you get started might depend on whether you have upgraded your Acrolinx installation or have installed Acrolinx for the first time.
To get started with checking profiles, follow these major steps:
- Ensure that you have the profile administrator role .
- Enable the checking profiles feature in your core server properties .
If you are starting with a fresh Acrolinx installation, follow these extra steps:
- Save new extraction settings .
Create new checking profiles
Remember: When you create checking profiles, add the extraction settings that you created in the previous step . If you do not add your extraction settings to a profile, the plug-in segmentation and filter settings will be empty.
You might also follow this step if you have upgraded but want to start with fresh checking profiles and extraction settings.
- Assign your checking profiles to users .
Making Sure You Have the Profile Administrator Role
Not everyone in your organization has the privileges to access checking profiles. If you plan to administer the plug-in settings for your users, you or your Acrolinx administrator should ensure that your user account has the role "profile administrator". This role includes the privileges for editing checking profiles as well as plug-in segmentation and filter settings.
When you have this role, you can access the Checking Profiles section of the Dashboard. Additionally, users with this role can start an Acrolinx plug-in and save changes to the plug-in settings. The server updates the corresponding checking profile or extraction settings with the latest changes.
Enabling Checking Profiles
When you install the Acrolinx server, checking profiles are disabled by default. Before you start working with checking profiles, you must enable the feature in the core server properties file.
To enable checking profiles, 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.
- Log on to the Dashboard, open the Guidance Settings menu and check that you can see the Checking Profiles section.
Creating Checking Profiles
You create a checking profile to define the writing guide, term sets, check settings, and filter and segmentation settings for a specific user group.
To create a checking profile, follow these steps:
- Enter a name in the Profile Name field.
- ( Optional ) Select whether profile should be locked .
- Select the language and writing guide that this checking profile should use .
- Select the term sets that should be selected when a user works with this checking profile .
Select the appropriate SEO settings
Select the extraction settings that should be available for this checking profile
If there are no settings available, try saving some extraction settings on the Extraction Settings page .
These settings are the same check settings that plug-in users see on the Check tab. If you do not know what these settings do, refer to an Acrolinx plug-in user guide.
Saving New Extraction Settings
If you are a profile administrator, the Acrolinx server tracks every revision that you make to the plug-in filter and segmentation settings. You can select one of your revisions in the Dashboard and save that revision as a named set of extraction settings. Once you have saved extraction settings, you can add them to a checking profile.
To save new extraction settings, follow these steps:
- Navigate to
table and select a revision that you want to save as new extraction settings.
If you cannot find a suitable revision or are unsure about what to select, save a new revision or create a new set of extraction settings .
- In the Saved Extraction Settings panel, select Save with new name and enter a name for the settings.
You can now add the extraction settings to a checking profile .Remember: The plug-in segmentation and filter settings will be empty until you add your extraction settings to a checking profile. You must also ensure that the checking profile is assigned to you .
Assigning Checking Profiles to Users
You assign a checking profile to a group of users so that you can configure their plug-in settings. When users have a checking profile assigned to them, they do not have to think about what settings to select. They can start working with Acrolinx straight away.
To assign checking profiles to users, follow these steps:
- Navigate to
A new assignment row is created at the top of the assignments table. Acrolinx automatically gives this assignment a name according to the following naming convention:
Assignment <NUMBER> - <DATE> <TIME>
- Click the arrow icon next to the assignment name to expand the assignment.
Give the assignment a more meaningful name.
For example, you might call the assignment something like "Standard US for Techdoc Department with DITA settings".
Select the checking profiles that you want to assign.
- In the Checking Profiles panel, click the plus icon + to add a checking profile.
- In the Select Profile window, select the required profiles.
Define your user selection criteria.
Click anywhere inside the
panel to add a selector.
A selector is a category of selection criteria such as "Department" or "Team". Unless you have enabled custom user information for your Acrolinx server, you can see only the selectors "User ID" and "Acrolinx role".
window, choose a selector from the dropdown list, select the applicable values, and click
Tip: To get started quickly, try using the selector "Acrolinx role".
The Selected Users panel tells you how many users your assignment will affect.
- Click anywhere inside the Select By panel to add a selector.
Apply All Changes
Your assignments apply to users immediately.