Set Up a Checking Profile

To get started with Checking Profiles, follow these major steps:

  1. Make sure that you have the profile administrator role.
  2. Make sure that the Checking Profiles feature is enabled in your core server properties.
  3. If you’re starting with a fresh Acrolinx installation, follow these extra steps:
    • Save new extraction settings.
    • Create new Checking Profiles.

      When you create Checking Profiles, add the extraction settings that you created in the previous step. If you don’t add your extraction settings to a profile, the classic integration 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.

  4. 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 check 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 integration 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 Integration and save changes to the check settings. The server updates the corresponding Checking Profile or extraction settings with the latest changes.

Enabling Checking Profiles

When you install Acrolinx, Checking Profiles are enabled by default. If they happen to be disabled, you can enable them in the core server properties file.

To enable Checking Profiles, follow these steps:

  1. Open the coreserver.properties

    To edit coreserver.properties from the Dashboard, go to Maintenance > Configuration Properties, then follow the folder structure config > server > bin and click on the file coreserver.properties. You can then edit the properties directly from the Dashboard.

    Alternatively, you can edit coreserver.properties from the configuration directory: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties

  2. If the following property is missing, add it:

    checkingProfiles.enabled=true
  3. Save your changes and restart the core server.
  4. Sign in 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 extraction settings for a specific user group.

To create a Checking Profile, follow these steps:

  1. Navigate to Guidance Settings > Checking Profiles and click New.
  2. Enter a name in the Profile Name field.
  3. (Optional) Select whether profile should be locked.
  4. Update the Guidance Settings.
  5. Update the Check Settings.

    These settings are the same check settings that users see on the Check tab.

Assigning Checking Profiles to Users

You assign a Checking Profile to a group of users so that you can configure their check settings. When users have a Checking Profile assigned to them, they don’t have to think about what settings to select. They can start working with Acrolinx straight away.

When you open the Profile Assignment page for the first time, you see an assignment with the name "Default Assignment: Every Checking Profile is assigned to every user". After you’ve created your own assignments, you can delete this assignment. Select the assignment and clickDelete.

To assign Checking Profiles to users, follow these steps:

  1. Navigate to Guidance Settings > Checking Profiles > Profile Assignment.
  2. Click New Assignment. 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>
  3. Click the arrow icon  next to the assignment name to expand the assignment.
  4. Give the assignment a more meaningful name.

    For example, you might call the assignment something like "Standard US for Techdoc Department with DITA settings".

  5. Select the Checking Profiles that you want to assign. You can do this with the following steps:

    1. In the Checking Profiles panel, click the plus icon + to add a Checking Profile.
    2. In the Select Profile window, select the required profiles.
  6. Define your user selection criteria. You can define the selection criteria by following the steps below:

    1. Click anywhere inside the Select By 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 Core Platform, you can see only the selectors "User ID" and "Acrolinx role".

    2. In the Choose Selector window, choose a selector from the dropdown list, select the applicable values, and click OK.

      To get started quickly, try using the selector "Acrolinx role".

    The Selected Users panel tells you how many users your assignment will affect.

  7. Click Apply All Changes.

    Your assignments apply to users immediately.