Skip to main content
 

How can we help?

Search

Create, Edit, and Delete Analytics Custom Fields

  • Updated

You can ask your users to enter custom user or document information when they sign into Acrolinx. When you add a field to the custom information form, all users have to fill out the form again before they run the next check. If you'd like to configure your custom fields from a third-party source, contact the Acrolinx Customer Success team.

Create and configure custom user and document fields

To configure the custom fields used to gather analytics data about your users or documents, use the Custom Fields page in Acrolinx. You can add up to 16 custom fields.

Tip

Before you use this feature, make sure that the reporting database is also enabled.

To configure custom fields, follow these steps:

  1. Navigate to Reporting > Analytics settings > Custom fields.

  2. Open the Users or Documentstab and click Add Field.

  3. Enter the Name and click OK.

  4. Select the Input type.

    • Choose Required if you want users to fill out the field.

    • Choose Optional if the field is a free-text field where users can enter any value.

    • (User fields only) Choose Third party if the field comes from an external source.

      Warning

      Note: The Third-party option currently only works with a PingFederate server.

      (Document fields only) Choose the From content option if values for this field should be extracted from the document.

      For more information about this feature, see the article Configure Automatic Data Mapping.

  5. Select the Field type.

    • Choose List if the field is a list field where users select a value from the predefined values.

    • Choose Text if the field is a free-text field where users can enter any value.

  6. (Optional) If the field is a list field, enter the values in the Values column.

    Enter each value in a new line. When you’ve entered all values, click OK.

  7. (Optional) If you’ve edited the values of a field and want users to review the new values, clear the custom information. Your users will have to enter their user data again.

Delete custom user and document fields

You can delete any custom information field that you no longer need. If you delete a field, the corresponding data remains in the database.

Note

Check your style guide assignments before you delete a field or field value. You might have style guides assigned to users based on the information in that field. For example, if you delete a department, users in that department might no longer receive the right guidelines. To check your assignments, navigate to Style guides > MANAGE ASSIGNMENTS.

To delete custom information fields, follow these steps:

  1. Navigate to Reporting > Analytics settings > Custom fields.

  2. Open the User or Document tab.

  3. Select the custom fields that you want to delete.

  4. Click Delete to delete the selected fields.

  5. Click OK to confirm.

Note

You can't delete the "Department" field, but you can change the Input type.

Edit custom user and document fields

Edit the custom information fields to reflect any changes in your reporting requirements.

You can edit custom field values but you can't edit custom field names. Custom field names are read only to ensure that your reporting data is consistent over time. If you want to update the field name, delete the original field and add a new field with the updated name.

Note

Check your style guide assignments before you delete a field or field value. You might have style guides assigned to users based on the information in that field. For example, if you delete a department, users in that department might no longer receive the right guidelines. To check your assignments, navigate to Style guides > MANAGE ASSIGNMENTS.

To edit custom information fields, follow these steps:

  1. Navigate to Reporting > Analytics settings > Custom fields.

  2. Open the User or Document tab.

  3. Click the table cell that you want to edit and add your changes.

  4. (Optional) If you've edited the values of a field and want users to review the new values, clear the custom information. Your users will have to enter their user data again.

If you need to modify the XML templates directly, go to Template Files for Analytics Custom Fields.