In this article

Overview

You can use this Snap to remove duplicate records from input documents. When you use multiple matching criteria to deduplicate your data, the Snap evaluates using each criterion separately, and then aggregates to give the final result. This Snap ignores fields with empty strings and whitespaces as no data.

Prerequisites

None.

Limitations

None.

Known Issues

The Deduplicate Snap fails to deduplicate data when the input document contains an empty string, white spaces, or null values in a field.

Support for Ultra Pipelines

Does not support Ultra Pipelines.

Snap Views

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String		N/A	Deduplicate Office Names
Threshold	Decimal	Required. The minimum confidence required for documents to be considered matched as duplicates using the matching criteria. Minimum Value: 0 Maximum Value: 1	0.8	0.95
Confidence	Checkbox	Select this check box to include each match's confidence levels in the output.	Deselected	N/A
Group ID	Checkbox	Select this check box to include the group ID for each record in the output.	Deselected	N/A
Matching Criteria	Fieldset	Enables you to specify the settings that you want to use to match input documents with the matching criteria.	N/A	N/A
Field	JSONPath	The field in the input dataset that you want to use for matching and identifying duplicates.	N/A	$name
Cleaner	String		None	Text
Comparator	String		Levenshtein	Numeric
Low	Decimal	A decimal value representing the level of probability of the input documents to be matched if the specified fields are completely unlike. If this value is left empty, a value of 0.3 is applied automatically.	N/A	0.1
High	Decimal	A decimal value representing the level of probability of the input documents to be matched if the specified fields are a complete match. If this value is left empty, a value of 0.95 is applied automatically.	NA	0.8
Minimum memory (MB)	Integer/Expression	Specify a minimum cut-off value for the memory the Snap must use when processing the documents. If the available memory is less than the specified value, the Snap stops execution and displays an exception to prevent the system from running out of memory. This feature is disabled if this value is 0. A lint message for the available memory and free disk space is displayed in the Pipeline Execution Statistics.	200	1000
Minimum free disk space (MB)	Integer/Expression	Specify the minimum free disk space required for the Snap to execute. If the free disk space is less the than the specified value, the Snap stops execution and displays an exception to prevent the system from running out of disk space. This feature is disabled if this value is 0. A lint message for the available memory and free disk space is displayed in the Pipeline Execution Statistics.	200	1000
Snap Execution	String	Specifies the execution type: Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution. Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation. Disabled: Disables the Snap and, by extension, its downstream Snaps.	Validate & Execute	N/A

Examples

Deduplicating the List of Childhood Centers in Chicago

In this example, you deduplicate the data in a CSV file containing a list of childhood centers in Chicago.

1. You add a File Reader Snap to the Pipeline and configure it to read the source CSV file stored online:
   
   
   The File Reader Snap displays the contents of the file, which contains many duplicate entries:
   
   
   
2. You add a CSV Parser Snap to the Pipeline to interpret the input data as a CSV document.
3. You add a Deduplicate Snap to the Pipeline and configure it to use the name, address, ZIP, and phone details in the input document as fields for deduplication:
   
   
   
4. You also add an additional output view to the Snap, where the Snap can display the duplicate data. Now, the Snap has two output views, one for the cleaned (deduplicated) data, and another for the duplicated records that the Snap filtered out.
   
   
   The Snap, when executed, offers the following two output documents (Output0 and Output1). Output0 contains the deduplicated data, while Output1 contains the duplicate data:
   
   
   
5. You attach a CSV Formatter Snap to each output view of the Deduplicate Snap to structure the outputs as CSV documents. You then connect a File Writer Snap to each CSV Formatter Snap to write the input data as files.
   
   
6. The Pipeline, when run, generates two output documents: one containing deduplicated data, and the other containing the duplicate data:
    
   

Download this Pipeline.

Downloads