tMDMViewSearch - 6.3

Talend Open Studio for Big Data Components Reference Guide

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

Function

tMDMViewSearch selects records from an MDM Hub by applying filtering criteria you have created in a specific view. The resulting data is in XML structure.

For more information on a view on which you can define filtering criteria, see Talend Studio User Guide.

Purpose

This component allows you to retrieve the MDM records from an MDM hub.

tMDMViewSearch properties

Component family

Talend MDM

 

Basic settings

Schema and Edit Schema

A schema is a row description, it defines the number of fields that will be processed and passed on to the next component. The schema is either Built-in or remote 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.

Click Sync columns to collect the schema from the previous component.

 

 

Built-in: You create the schema and store it 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.

 

XML Field

Select the name of the column in which you want to write the XML data.

 Use an existing connectionSelect this check box if you want to use a configured tMDMConnection component.
 

MDM version

By default, Server 6.0 is selected. Although it is recommended to migrate existing Jobs for this new version, the Server 5.6 option is available to ease the process of the migration of your Jobs so as to keep them working without modification with a 6.0 server. To do so, an option on the server must be enabled to accept and translate requests from such Jobs.

 

URL

Type in the URL of the MDM server.

 

Username and Password

Type in the user authentication data for the MDM server.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

 

Data Container

Type in the name of the data container that holds the master data you want to read.

Type

Select Master or Staging to specify the database on which the action should be performed.

 

View Name

Type in the name of the view whose filters will be applied to process the records.

 

Operations

Complete this table to create the WHERE clause. The parameters to be set are:

- XPath: define the path expression to select the XML node at which point the filtering is operated.

- Functions: select an operator from the drop-down list, like Contains, Starts with, Equals, etc.

- Value: enter the value you want to retrieve. The value can be a string (for example, "Apple"), an Entity element (for example, "Product/Name") or a user-based variable (for example, "${user_context.language" or "${user_context.properties['location']}").

- Predicate: select the predicate to combine the filtering conditions in different manners. The predicate may be none, or, and, exactly, etc.

Warning

The parameters are case sensitive.

For more information about the operators and the predicates, see tMDMInput properties.

 

Order (One Row)

Complete this table to decide the presentation order of the retrieved records. The parameters to be set are:

- XPath: define the path expression to select the XML node at which point the sorting operation is performed.

- Order: select the presentation order that may be asc (ascending) or desc (descending).

Warning

The parameters are case sensitive.

Warning

For the time being, only the first row created in the Order table is valid.

 

Spell Threshold

Set it to -1 to deactivate this threshold. This threshold is used to decide the spell checking level.

 

Skip Rows

Type in the count of rows to be ignored to specify from which row the process should begin. For example, if you type 8 in the field, the process will begin from the 9th row.

 

Max Rows

Type in the maximum number of rows to be processed. If Limit = 0, no row is read or processed. By default, the limit is -1, meaning that no limit is set.

Advanced settings

Batch Size

Number of lines in each processed batch. By default, the batch size is set to -1, meaning that all the lines are processed in one batch.

tStatCatcher Statistics

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

Usage

Use this component to retrieve specific records.

Connections

Outgoing links (from this component to another):

Row: Iterate

Trigger: Run if; On Component Ok; On Component Error, On Subjob Ok, On Subjob Error.

Incoming links (from one component to this one):

Row: Iterate;

Trigger: Run if, On Component Ok, On Component Error, On Subjob Ok, On Subjob Error

For further information regarding connections, see Talend Studio User Guide.

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.

NB_LINE: the number of rows processed. This is an After variable and it returns an integer.

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.

Limitation

n/a

Scenario: Retrieving records from an MDM hub via an existing view

This scenario describes a two-component Job that retrieves a data record in XML structure.

In this example, you will select the T-shirt information from the Product entity via the Browse_items_Product view created from Talend Studio. Each record in the entity contains the details defined as filtering criteria: Id, Name, Description and Price.

  • From the Palette, drop tMDMViewSearch and tLogRow onto the design workspace.

  • Connect the components using a Row Main link.

  • Double-click tMDMViewSearch to view its Basic settings, in the Component tab and set the component properties.

  • In the Schema list, select Built-In and click the three-dot button next to Edit schema to open a dialog box in which you can define the structure of the XML data you want to write in.

  • Click the plus button and add one column of the type String. Name the column as Tshirt.

  • Click OK to validate your creation and proceed to the next step.

  • In the XML Field field, select Tshirt as the column you will write the retrieved data in.

  • Use your MDM server address in the URL field and type in the corresponding connection data in the Username and the Password fields. In this example, use the default url, then enter admin as username as well as password.

  • In the Data Container field, type in the container name: Product.

  • In the View Name field, type in the view name: Browse_item_Product.

  • Below the Operations table, click the plus button to add one row in this table.

  • In the Operations table, define the XPath as Product/Name, meaning that the filtering operation will be performed at the Name node, then select Contains in the Function column and type in Tshirt in the Value column.

  • Below the Order (One Row) table, click the plus button to add one row in this table.

  • In the Order (One Row) table, define the XPath as Product/Id and select the asc order for the Order column.

  • In the design workspace, click tLogRow to open its Basic settings view and set the properties.

  • Next to the three-dot button used for editing schema, click Sync columns to acquire the schema from the preceding component.

  • Press F6 to execute the Job.

In the console docked in the Run view, you can read the retrieved Tshirt records in XML structure, which are sorted in the ascending order.