Print this page
In this topic
The application retains an audit history of the coding changes that users make to field values. User audit logging for coding documents is also known as coding history. To implement coding history, you must configure an Elasticsearch cluster, which stores the coding history data.
You must also deploy the user audit log service to the portal. Then, to enable coding history for cases that existed before the audit log service is deployed, system administrators must run a migration process for each case to migrate coding entries from SQL to Elasticsearch. The migration requires you to install an additional service named the user audit data migration service.
After installing the new services, you must configure the following portal options:
●User audit log service URL: The URL that contains the host name of the audit log service machine and the port, 10003. After the user audit log service is installed and the URL is configured in this portal option, new cases automatically have coding history enabled. All coding decisions made by reviewers are logged.
●User audit migration service URL: The URL that contains the host name of the user audit migration service machine and the port, 10005. After the user audit migration service is installed and the URL is configured, system administrators can use the Coding History page to enable coding history for cases that existed before the audit logging service was deployed to the portal.
For more information about setting portal options, see Portal Options.
After you provide the audit log service and audit migration service URLs on the Portal Options page, the Coding History page is available. Use the Coding History page to manage the user audit log migration for cases.
Use the following procedure to open the Coding History page.
●On the Portal Home page, under Portal Management, click Cases and Servers > Coding History.
The following columns appear on the page:
oCase name: Contains the names of all cases in the portal.
oElasticsearch index name: Shows the index name if an Elasticsearch index exists for the case.
oMigration status: Displays the number and percentage of migrated documents.
oAction: Contains a value relative to the status of the migration. A case contains a Migrate link if the case does not have an Elasticsearch index yet or if the case existed before the coding history feature was introduced in the portal.
Note: New cases added after coding history is deployed appear on this page with an Elasticsearch index name and Complete in the Action column.
Use the following procedure to start the migration process for cases that existed before the audit log service is deployed for your portal.
1.On the Portal Home page, under Portal Management, click Cases and Servers > Coding History.
2.For the case for which you want to migrate indices, click the Migrate link in the Action column.
The text Migration started appears while the Elasticsearch index is being created, and before the migration starts. When an Elasticsearch index is created for the case and the migration begins, the text in the Action column changes to a link named Rerun migration.
3.Refresh the page to see the value in the Migration status column change.
4.If you refresh the page after ten minutes and the status is not progressing, it is likely that the migration job has stopped. Click the Rerun migration link.
Note: We do not recommend clicking Rerun migration unless you see a lack of migration progress, as this might result in duplicate entries.
The amount of time to complete migration is relative to the amount of document coding in the case. Complete appears in the Action column when the migration status is complete.
On the Coding History page, you can select multiple cases in the list and click Migrate at the top right of the page to start the migration service. The migration runs sequentially for one case at a time. If you refresh the page, the Migrate link reappears for cases that have not yet started migration. Do not click the Migrate link or button for these cases. Wait for the previous case to finish and then refresh the page to see the status update for the next case.
After creating Elasticsearch indices for cases, see the topic Work with security for features for instructions to enable the Coding History pane on the Documents page. You can then use the Coding History pane as described in View coding history to verify that coding history is working.