tUniservRTMailSearch - 6.1

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

tUniservRTMailSearch properties

Component family

Data quality

 

Function

tUniservRTMailSearch searches for similar data based on the given input record.

Purpose

tUniservRTMailSearch searches for duplicate values and adds additional data to each record.

Basic settings

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. The schema is either Built-In or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the [Repository Content] window.

 

Host name

Server host name between double quotation marks.

 

Port

Listening port number of the server between double quotation marks.

 

Service

The service name is "mail" by default. Enter a new name if necessary (e.g. due to service suffix), between double quotation marks.

 

Maximum of displayed duplicates (0 = All)

Enter the maximum number of duplicates to be displayed in the Run view. The default value is 0, which means that all duplicates will be displayed (up to 1000 duplicates can be displayed).

 

Use rejects

Select this check box to set parameters based on which duplicate records should be added to the reject flow. Then set the:

Element: Duplicate count.

Operator: <, <=, =, >=, >.

Value: Enter the number manually.

Advanced settings

Uniserv Parameters

For detailed information, please refer to the Uniserv user manual mailRetrieval.

 

tStatCatcher Statistics

Select this check box to collect log data at the Job and the component levels.

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

tUniservRTMailSearch requires an input component and one or more output components.

Limitation

To use tUniservRTMailSearch, the Uniserv software mailRetrieval must be installed.

Note

Before the first use of tUniservRTMailSearch, an index pool must be created. You can create the index pool with tUniservRTMailBulk.

 

Scenario: Adding contacts to the mailRetrieval index pool

This scenario describes a batch job that adds contacts to the index pool of mailRetrieval. Before the addition, it must be checked whether these contacts already exist.

The input file for this scenario is already saved in the Repository, so that all schema metadata is available.

Note

Please note that the data from the input source must be related to the same country.

Dropping and connecting the components

  1. In the Repository view, expand the Metadata node and the directory in which the file is saved. Then drag this file into the design workspace.

    The dialog box below appears.

  2. Select tFileInputDelimited and then click OK to close the dialog box.

    The component is displayed in the workspace.

  3. Drag the following components from the Palette into the design workspace: two tMap components, tUniservRTMailSearch and tUniservRTMailOutput .

  4. Connect tMap with tUniservRTMailSearch first.

    Accept the schema from tUniservRTMailSearch by clicking Yes on the prompt window.

  5. Connect the other components via Row > Main.

Configuring the components

  1. Double-click tMap_1 to open the schema mapping window. On the left is the structure of the input file and on the right is the schema of tUniservRTMailSearch. At the bottom lies the Schema Editor, where you can find the attributes of the individual columns and edit them.

  2. Assign the columns of the input file to the respective columns of tUniservRTMailSearch. For this purpose, select a column of the input source and drag it onto the appropriate column on the right side.

  3. When your input list contains a reference ID, you should adopt it. In order to do so, create a new column IN_DBREF in the Schema Editor and connect it with your reference ID.

    Click OK to close the window.

  4. Double-click tUniservRTMailSearch to open its Basic settings view.

  5. Under Maximum of displayed "duplicates", enter 0 to display all the duplicates.

    Select Define rejects to open the rejects definition window.

  6. Click the [+] button to insert a new line in the window. Select Duplicate count under the element column, > under the operator column, and 0 under the value column. So all the existing contacts are disqualified and only the new contact will be added to the index pool.

  7. Enter the Advanced settings view and check the parameters. Reasonable parameters are preset. Detailed information can be found in the manual mailRetrieval.

  8. Double-click tMap_3 to open schema mapping window. On the left is the schema of tUniservRTMailSearch and on the right is the schema of tUniservRTMailOutput.

  9. Click Auto map! to assign the fields automatically.

  10. The only field that must be assigned manually is the reference ID. In order to do so, drag OUT-DBREF from the left side onto the field IN_DBREF on the right side.

    Click OK to close the dialog box.

  11. Double-click tUniservRTMailOutput to open the Basic settings view.

    From the Action on Data list, select Insert or update. This way, all new contacts are added to the index pool.