tStandardizePhoneNumber - 6.3

Talend Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Warning

This component is available in the Palette of the Studio only if you have subscribed to one of the Talend Platform products.

Function

This component receives phone number data from its preceding component and formats and standardizes these numbers using a built-in Google libphonumber library, org.talend.libraries.google.libphonumber.

Purpose

This component standardizes phone numbers according to given formats.

Depending on the Talend solution you are using, this component can be used in one, some or all of the following Job frameworks:

tStandardizePhoneNumber properties

Component family

Data quality

 

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.

This component provides default columns. For further information, see section Default columns.

 

 

Built-In: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.

 

 

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. Related topic: see Talend Studio User Guide.

 

Phone number

Select the column holding the phone numbers of interest from the input data.

 

Country code

Select the column holding the country codes (ISO 2) from the input data.

Note

The input data processed by this component must be able to provide the two-letter ISO country codes alongside the corresponding phone numbers of interest.

 

Customize

Select this check box to set a custom country code (ISO 2). Once selected, it disables the Country code field and gives priority to the customized country code for phone number standardization.

For example, if the input data provides a set of phone numbers with a wrong country code or alternatively with no country code, then you can select this check box and type in the country code you need for standardization.

 

Phone number format for output

Select the format to be used to standardize the phone numbers of interest. The available options are:

- E164

- International

- National

Advanced settings

Avoid comparison

Select this check box to deactivate the comparison performed between the input and the output data at runtime. This could accelerate the execution process of the Job using this component.

 

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

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

This component is usually used as an intermediate component, and it requires an input component and an output component.

Limitation

n/a

Default columns

The following table presents details about the default columns provided by tStandardizePhoneNumber.

Columns

Description

StandardizedPhoneNumber

This column presents the standardized phone numbers.

IsValidPhoneNumber

This column indicates whether a phone number processed is recognized as valid.

IsPossiblePhoneNumber

This column indicates whether a phone number processed is supposed to be valid.

IsAlreadyStandard

This column indicates whether a phone number processed is already standardized after comparing it with the output standardized phone number.

PhoneNumberType

This column indicates the type of a processed phone number, such as fixed line, toll free, etc.

ErrorMessage

This column presents the relative error message if a phone number is unrecognizable.

In addition to these default columns, you need to define more columns alongside in order for this component to receive the corresponding input data.

 

Scenario: Standardizing French phone numbers

In this scenario, you use three components to standardize some French phone numbers according to the French phone number format.

The components to be used are:

  • tFixedFlowInput: this component is used to provide the input data composed of phone numbers to be processed and the French country code (FR).

  • tStandardizePhoneNumber: this component standardizes the phone numbers of interest.

  • tLogRow: this component displays the result of this standardization.

To replicate this scenario, proceed as the following sections illustrate:

Dropping and linking the components

To do this, proceed as follows:

  1. Drop tFixedFlowInput, tStandardizePhoneNumber and tLogRow from the Palette to the Design workspace.

  2. Right-click the tFixedFlowInput component to open the contextual menu and select Row > Main.

  3. Do the same to connect tStandardizePhoneNumber to tLogRow using a Row > Main link.

Then you can continue to configure these components.

Configuring the input data

To do this, proceed as follows:

  1. Double click tFixedFlowInput to open its Component view.

  2. Next to Edit schema, click the three-dot button to open the schema editor.

  3. Click the plus button to add two rows.

  4. In the Column column, rename these two newly added rows. In this scenario, name them phone and country respectively.

  5. Click OK to validate these changes and accept the propagation prompted by the dialog box that pops up.

  6. In the Mode area, select the Use Inline Table option to display the Inline Table.

  7. Under this table, click the plus button to add as much number of rows as you need. In this scenario, add 12 rows.

  8. In this table, type in, between quotation marks, phone numbers of various formats and the corresponding ISO 2-letter country code in the phone and the country columns respectively. In this scenario, they read as follows:

Configuring the standardization process

To do this, proceed as follows:

  1. Double click tStandardizePhoneNumber to open its Component view.

  2. If required, click Sync columns to retrieve the schema from the previous component.

  3. In the Phone number field, select phone from the drop-down list as this column holds the phone numbers to be processed.

  4. In the Country code field, select country from the drop-down list as this column provides the country code to be used. In this scenario, this code is the French country code FR.

  5. In the Phone number format for output field, select National as you need to standardize these phone numbers according to the national standard format of France.

Executing the Job

Press F6 to run this Job.

You can read the execution result in the console of the Run view.

From this result table, you can find that the first input record 0147045670, for example, is standardized as 01 47 04 56 70 according to the French phone number format and this number is of FIXED LINE.

tStandardizePhoneNumber properties in Spark Batch Jobs

Component family

Data quality

 

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.

This component provides default columns. For further information, see section Default columns.

 

 

Built-In: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.

 

 

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. Related topic: see Talend Studio User Guide.

 

Phone number

Select the column holding the phone numbers of interest from the input data.

 

Country code

Select the column holding the country codes (ISO 2) from the input data.

Note

The input data processed by this component must be able to provide the two-letter ISO country codes alongside the corresponding phone numbers of interest.

 

Customize

Select this check box to set a custom country code (ISO 2). Once selected, it disables the Country code field and gives priority to the customized country code for phone number standardization.

For example, if the input data provides a set of phone numbers with a wrong country code or alternatively with no country code, then you can select this check box and type in the country code you need for standardization.

 

Phone number format for output

Select the format to be used to standardize the phone numbers of interest. The available options are:

- E164

- International

- National

Advanced settings

Avoid comparison

Select this check box to deactivate the comparison performed between the input and the output data at runtime. This could accelerate the execution process of the Job using this component.

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 in Spark Batch Jobs

This component is used as an intermediate step.

This component, along with the Spark Batch component Palette it belongs to, appears only when you are creating a Spark Batch Job.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents only Standard Jobs, that is to say traditional Talend data integration Jobs.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Spark Connection

You need to use the Spark Configuration tab in the Run view to define the connection to a given Spark cluster for the whole Job. In addition, since the Job expects its dependent jar files for execution, one and only one file system related component from the Storage family is required in the same Job so that Spark can use this component to connect to the file system to which the jar files dependent on the Job are transferred:

This connection is effective on a per-Job basis.

Related scenarios

No scenario is available for the Spark Batch version of this component yet.

tStandardizePhoneNumber properties in Spark Streaming Jobs

Component family

Data quality

 

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.

This component provides default columns. For further information, see section Default columns.

 

 

Built-In: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.

 

 

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. Related topic: see Talend Studio User Guide.

 

Phone number

Select the column holding the phone numbers of interest from the input data.

 

Country code

Select the column holding the country codes (ISO 2) from the input data.

Note

The input data processed by this component must be able to provide the two-letter ISO country codes alongside the corresponding phone numbers of interest.

 

Customize

Select this check box to set a custom country code (ISO 2). Once selected, it disables the Country code field and gives priority to the customized country code for phone number standardization.

For example, if the input data provides a set of phone numbers with a wrong country code or alternatively with no country code, then you can select this check box and type in the country code you need for standardization.

 

Phone number format for output

Select the format to be used to standardize the phone numbers of interest. The available options are:

- E164

- International

- National

Advanced settings

Avoid comparison

Select this check box to deactivate the comparison performed between the input and the output data at runtime. This could accelerate the execution process of the Job using this component.

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 in Spark Streaming Jobs

This component, along with the Spark Streaming component Palette it belongs to, appears only when you are creating a Spark Streaming Job.

This component is used as an intermediate step.

You need to use the Spark Configuration tab in the Run view to define the connection to a given Spark cluster for the whole Job.

This connection is effective on a per-Job basis.

For further information about a Talend Spark Streaming Job, see the sections describing how to create, convert and configure a Talend Spark Streaming Job of the Talend Big Data Getting Started Guide.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents only Standard Jobs, that is to say traditional Talend data integration Jobs.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Spark Connection

You need to use the Spark Configuration tab in the Run view to define the connection to a given Spark cluster for the whole Job. In addition, since the Job expects its dependent jar files for execution, one and only one file system related component from the Storage family is required in the same Job so that Spark can use this component to connect to the file system to which the jar files dependent on the Job are transferred:

This connection is effective on a per-Job basis.

Related scenarios

No scenario is available for the Spark Streaming version of this component yet.