tDataStewardshipTaskOutput Standard properties - 7.3

Data Stewardship

Version
7.3
Language
English
Product
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 Real-Time Big Data Platform
Module
Talend Data Stewardship
Talend Studio
Content
Data Governance > Third-party systems > Data Stewardship components
Data Quality and Preparation > Third-party systems > Data Stewardship components
Design and Development > Third-party systems > Data Stewardship components
Last publication date
2024-02-21

These properties are used to configure the tDataStewardshipTaskOutput component which runs in the Standard Job framework.

The Standard tDataStewardshipTaskOutput component belongs to the Talend Data Stewardship family.

The component in this framework is available in all Talend products.

Basic settings

Property Type

Either Built-in or Repository.

 

Built-In: You create and store the schema locally for this component only.

 

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

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. When you create a Spark Job, avoid the reserved word line when naming the fields.

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.

Once you select a campaign from the Find a campaign list, tDataStewardshipTaskOutput becomes aware of the schema defined in the campaign and creates identical schema columns in its basic settings. The component also adds the TDS_DUE_DATE and TDS_EXTERNAL_ID columns to the schema:
  • TDS_DUE_DATE: holds the task due date using the format: YYYY-MM-DD HH:mm:ss. The due date is calculated automatically according to the task delay time you define when creating the campaign in Talend Data Stewardship. If you do not define a delay date for tasks when creating the campaign, this column stays empty.

  • TDS_EXTERNAL_ID: helps you set an identifier of your choice on tasks so that you can retrieve them easily from any other system such as Talend MDM Web UI.

    If you do not define an identifier for tasks when creating the Job, this column stays empty.

In case you select to write the tasks in a MERGING or a GROUPING campaign, the below columns are automatically added to the schema:

  • TDS_GID: holds the group identifier.

    This identifier is used by tDataStewardshipTaskOutput to group records in tasks. All source records that should be grouped in a single task must have the same TDS_GID.

  • TDS_MASTER (only for a MERGING campaign): indicates if the record is a master or a source record.

    Two cases to consider:
    • If no source record is set as master for a given task, Talend Data Stewardship determines which attributes of matched records to use to create the master record according to the survivorship rules you define when creating the campaign.

      For more information about survivorship rules, see the section about setting data models in Merging campaigns in Talend Data Stewardship Examples.

      For further information about survivorship rules, see the online publications about setting data models in Merging campaigns on Talend Help Center (https://help.talend.com/).

    • If more than one source record is set as master for a given task, Talend Data Stewardship takes the first source set as master to be the master record. So the best practice is to have either 0 or one master record per task.
  • TDS_SOURCE: holds the name of the source of the record, if any.

  • TDS_RATING (only for a MERGING campaign): provides a trust score per source record at task creation. This score overrides the score you define at campaign creation, if any. It is an integer value, which represents a percentage between 0 and 100.

  • TDS_SCORE: provides the calculated distance between the input and the master records according to the matching algorithm.

  • TDS_CREATION: holds the task creation date.
  • TDS_LAST_UPDATE: holds task last update date.

URL

Enter the address to access the Talend Data Stewardship server suffixed with /data-stewardship/, for example http://<server_address>:19999/data-stewardship/.

If you are working with Talend Cloud Data Stewardship, use the URL for the corresponding data center suffixed with /data-stewardship/ to access the application, for example, https://tds.us.cloud.talend.com/data-stewardship for the AWS US data center.

For the URLs of available data centers, see Talend Cloud regions and URLs.

Username and Password

Enter the authentication information to log in to Talend Data Stewardship.

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.

If you are working with Talend Cloud Data Stewardship and if:
  • SSO is enabled, enter an access token in the field.
  • SSO is not enabled, enter either an access token or your password in the field.

Campaign

Click Find a campaign to open a list of all the campaigns available in Talend Data Stewardship, and select the name of the campaign holding the tasks. This is an informative read-only field.

Type

A read-only list which shows the campaign type out of the predefined types once the campaign is selected.

Override enforcement of data model

Select this check box if you want to process data on the Talend Data Stewardship server even if the schema type is not valid, no input validation of the schema is performed. This check box is selected by default for all campaign types to guarantee smooth processing of data.

State

Select from the list the state in the workflow at which you want to create the tasks.

This list displays the names of all the states you define in the campaign workflow. It shows the initial and final states and any validation state you add when creating the campaign in Talend Data Stewardship.

Use the Custom option if you want to contextualize values in order to define different states depending on different values. For example, you can assign the "New" value to the State field if you want all incoming fields to be checked, and assign the "To validate" value to the same field if you are confident with incoming values and just want them to be validated.

Assignee

Select the campaign participant whose tasks you want to create. Otherwise, select No Assignee to create the tasks without assigning them to anybody.

The Custom option allows you to assign tasks dynamically to the data stewards part of the campaign by defining context variables in the field which is displayed. The expected value is the steward's login.

You can use this option to assign the tasks to specific stewards based on a given attribute of the incoming data. For example, you can assign French customers to Jacques Bocuse, a French steward, and US customers to Cale Carolina, a US steward, or assign them based on the customer support level Platinum for the support team lead and Gold for experts.

Priority, Choice and Tags

Priority (optional): Select any of the task priorities. Otherwise, select Custom and set a custom expression in the field which is displayed.

If no level is selected, Medium is used by default.

Choice (optional, available only when an ARBITRATION campaign is selected): Select any of the choice options set on the records while defining the campaign in the web application. The default value is No Choice, this enables data stewards to do the work in the web application. However, setting an arbitration choice in the Job is a way to help the steward by pre-selecting the supposedly most relevant choice directly when creating the tasks.

Tags (optional): Enter the tag to associate with the tasks you want to create.

You can use the tag(s) to filter the tasks you want to load into the campaign.

Comments

(Optional): Select one or several schema columns and enter the comment you want to add to the tasks you want to create.

This table lists by default all the schema columns.

The campaign participant will be able to see the comment any time he/she places the pointer on the source record column in Talend Data Stewardship. This information can help him/her making a more informed decision when resolving the task.

Advanced settings

Campaign ID

Displays the technical name of the campaign once it is selected in the basic settings. However, you can modify the field value to replace it with a context parameter for example and pass context variables to the Job at runtime. This technical name is always used to identify a campaign when the Job communicates with Talend Data Stewardship whatever is the value in the Campaign field.

Max tasks per commit

Set the number of the tasks you want to have in each commit.

There are no limits for the batch size in Talend Data Stewardship (on premises).

However, you need to make sure not to exceed 200 tasks per commit in Talend Cloud Data Stewardship, setting higher values causes Job failure.

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

NB_LINE

The number of messages processed. This is an After variable and it returns an integer.

NB_REJECT

The number of rows rejected. This is an After variable and it returns an integer.

NB_SUCCESS

The number of rows successfully processed. This is an After variable and it returns an integer.

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.

Usage

Usage Rule

This component is usually used as an end component of a Job or subJob and it always needs an input link.