Configuring a Deduplication Clerical Review

A clerical review is the process of manually examining pairs that the algorithm did not identify as duplicates or non-duplicates.

During matching, objects that score between the clerical review threshold and the auto threshold are placed in a clerical review workflow. The potential duplicates from the clerical workflow are then displayed in a Web UI where a user reviews them manually.

Prerequisites

1. This documentation assumes that you are familiar with STEP Web UI design. If you are new to designing Web UIs, it is recommended that you review the Web UI Getting Started topics here.
2. For more information about creating a workflow, refer to the Workflows documentation here.
3. For details on configuring the Web UI for Merge Golden Record clerical reviews, refer to the Merging Confirmed Matches topic in the Matching, Linking, and Merging documentation here.

Create and Configure the Deduplication List

You must place the deduplication list inside a tab page.

1. Log in to the Web UI and click the gear wheel icon () to enter design mode.
2. Click New, and then select the Node Details screen type.

3. Enter a Screen ID and click OK.
4. In the Child components area, in the Main dropdown, select Tab Control.

5. Click go to component to configure the Tab Control component.
6. Add a Tab Page to the Tab Control.
7. On the Tab Page, set Tab Content to Deduplication List.

8. Click on the 'go to component' link to configure Deduplication List Properties.

9. In Headers, click Add, and then select the attribute headers you want to use for the list. Choose meaningful headers that will assist the user with confirming or rejecting potential duplicates.
10. Select Auto Submit if you want the task to be automatically submitted when all duplicate candidates have been confirmed or rejected.
11. If you selected Auto Submit, in the Event field, specify the workflow event to use after auto submit.

12. Select the Hide Selection Buttons option to hide selection buttons such as, ‘Select All’, ‘Show Details,’ etc.

13. Select the Property Direction option if you want to display the data based on the selection from the dropdown. If Horizontal is selected, then columns will be displayed horizontally. If Vertical is selected, then columns will be displayed vertically. If no option is selected, then by default it will be displayed as horizontal.

14. Select 'Show Group Headers' if the attribute group headers should be displayed.

15. Select 'Use Immediate Save' option if you want to save the entered / changed data automatically without clicking the 'Save' button.

16. In the Child components area, click Add, and then select the actions Confirm as Duplicate and Confirm as Non-Duplicate.
17. Click Save to save the changes.

The 'Hide Equal' and 'Mark Different' actions will automatically appear alongside any other actions configured on the Deduplication List. For more information, refer to the Comparing Data Using Hide Equal and Mark Different section of the Web User Interfaces documentation here.

Specify Node Details Buttons

1. Select the Node Details screen you just created.
2. In the Child component area, from the Buttons list, select Buttons.
3. Click go to component.
4. In the Child component area, click Add, and then select the Submit Action.
5. Double-click the Submit action. The Submit Action Properties window appears.

In this window, you can specify where the Web UI navigates to after the Submit action. You do this by setting up a Navigate To Handler. If you cannot refer to the Navigate To Handler list, drag the sizing handle to display all properties.

6. In the Navigate To Handler list, select Deduplication Navigate To Handler.

7. Deduplication Navigate To Handler Properties screen will be displayed.

8. In the Matching Algorithm ID field, specify the ID of the relevant matching algorithm.
9. In State ID, enter the review state of the clerical review workflow, and then click Save.

For more information about Submit Action, refer to the Submit Action topic here.

Create a Task List

The next step is to create a screen to hold the Clerical Review task.

1. Click New, in the Add Screen window, select Task List, and then click Add. The Task List Properties window appears.
2. In the Child component area, in the Node List, choose Node List and click go to component.
3. In the Node List Properties window, in the ID field, enter an ID for the Node List, and then click Add.
4. In the Task List Properties window, in the Child components area, click go to component. The Node List Properties window appears.
5. In the Child components area, in Display Modes, click Add.
   • In the Add component window, choose Table Display Mode, and click Add.
   • Double-click Table Display Mode and edit the table properties. For Headers, click Add, and select Deduplication Header to generate the link to the deduplication screen. Add any other headers that are meaningful to the users of the list.

   

   • Click the go to parent link. The Node List Properties dialog displays again.
   • If necessary, repeat the bullets in this step to add additional Display Modes (e.g., Compare Display Mode).
6. Back in Node List Properties, enable Use Details Overlay to make processing Clerical Review tasks a quicker process. Enabling this parameter means that when after a user clicks either the Confirm Duplicate or Reject Duplicate buttons from the deduplication screen, the user is returned to the clerical review task list after each update, instead of returning to the homepage. Additionally, the clerical review task list is refreshed after each update for confirm or reject action, removing items that have been addressed.

7. Click Save.

For information about individual table properties, refer to 'Tables and Lists' in the 'Web UI component configuration reference' available at [system]/webui/docs for more information.

Specify Mappings

1. From the screen list, select Main to go to the main screen of the designer.
2. In Mappings, click Add.

3. In the Screen Mapping properties window, in Conditions, click Add.
4. Select the Matching Algorithm condition, and then click Add.

5. Double click on the Matching Algorithm to configure the Matching Algorithm Condition Properties.

   Note: Matching Algorithm must exist to select in Matching Algorithm Condition Properties screen.

6. In the Screen list, select the screen you created for deduplication, click Add, and then click Save.

7. In the Mappings list, select the mapping you just created, and then click Up to move the screen mapping higher up in the list. Next you will create another mapping.

8. In Mappings, click Add.
9. In the Screen Mapping properties window, in Conditions, click Add.
10. Select the Status Selector Selection condition, and then click Add. The Status Selector Selection Condition properties window opens.
11. In the Workflow list, select the clerical review workflow.
12. In the Select a state list, select the start state of the clerical review workflow, click OK, and then click Add.

13. In the Screen Mapping properties window, in the Screen dropdown list, select the Task List screen you just created, and then click Save.
14. In the Mappings list, select the mapping you just created, and then click Up to move the screen mapping higher up in the list.