tDataStewardshipTaskInput Standard properties - Cloud - 8.0

Data Stewardship

Version
Cloud
8.0
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-20

These properties are used to configure the tDataStewardshipTaskInput 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 subscription-based 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.

The columns below are automatically added to the schema of this component and are read-only. They give the task metadata.
  • TDS_ID : task identifier.

  • TDS_STATE : current state of the task.

  • TDS_ASSIGNEE : task assignee.

  • TDS_CREATION : task creation date.

  • TDS_LAST_UPDATE: task last update date.

  • TDS_LAST_UPDATED_BY : identifier of the user who last updated the task.

  • TDS_PRIORITY: numeric value which represents the priority level of the task in the web application. Each numeric value is retrieved from a text value as below:

    • Very Low = 0

    • Low = 1

    • Medium = 2

    • High = 3

    • Very High = 3

    The No Priority is set by default to Medium = 2.

  • TDS_TAGS: the tag(s) assigned to the task retrieved as a list of comma-separated values.

  • TDS_ARBITRATION: (Available only when anARBITRATION campaign is selected) the choice assigned to the task in enumeration values.

  • TDS_ARBITRATION_LABEL: (Available only when an ARBITRATION or a GROUPING campaign is selected) the choice assigned to the task as displayed in Talend Data Stewardship.

  • TDS_MASTER: (Available only when a MERGING campaign is selected) indicator to whether the record is a master record.

  • TDS_SOURCE: (Available only when a MERGING campaign is selected) name of the source of the record.

  • TDS_SCORE: (Available only when a GROUPING or a MERGING campaign is selected) the calculated distance between the input and the master record according to the matching algorithm.

  • TDS_RATING: (Available only when a MERGING campaign is selected) provides the trust score per source record you set 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_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.

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, enter the password in double quotes in the pop-up dialog box, 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.

State

Select from the list the state in the workflow at which you want to retrieve 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 Any State option to retrieve all tasks whatever is their state.

Use the Custom option to specify different states of the tasks to be retrieved separated by commas, for example "New,toValidate1,Resolved". You must enter the exact label of the state you define in the workflow.

Assignee

Select the campaign participant whose tasks you want to retrieve.

No Assignee retrieves the tasks which are not assigned to any data steward, while Any Assignee retrieves the tasks without taking any assignee into account.

Custom enables 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 that appears.

If no level is selected, Any Priority retrieves all tasks whatever is their priority.

Choice (optional, available only when an ARBITRATION campaign is selected): Select any of the choice options set on the records in the campaign.

No Choice retrieves the tasks for which no choice has been selected by data stewards, while Any Choice retrieves all tasks whatever is the selected choice.

Tags (optional): Enter the tag(s) to associate with the tasks you want to retrieve. You can use the tag(s) to filter the tasks.

Query

Enter the query statement you want to use to filter the tasks to retrieve from the campaign.

The condition is composed of a field name, an operator and a value. When referencing record data, the name of the field must be prefixed by record.. You should use simple quotes around strings, and precede quotes within the string with a backslash. For example: to filter tasks by assignee and first name value when having a FirstName field in the record, use assignee='user1@talend.com' in the Assignee field and record.firstName='De\'wayne' in the Query field.

For more information, see The query language used with data stewardship components and the REST API.

Retrieve golden record only

Select this check box to read only the golden records which are the results of the merging process.

This option is available only with the MERGING campaigns and is selected by default.

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.

HTTP client configuration

Connect Timeout: Set the time in milliseconds (ms) you want to wait before the connection attempt fails and the Job is killed.

Request Timeout: Set the time in milliseconds (ms) you want to wait before the request attempt fails and the Job is killed.

The value 0 is interpreted as infinite waiting time.

Use ID based pagination

This option improves performances when fetching tasks by relying on the last task ID of a batch to fetch the next one.

Batch Size

Set the number of lines you want to have in each processed batch.

Do not change the default value unless you are facing performance issues. Increasing the batch size can improve the performance but setting a too high value could cause Job failures.

Consume tasks when they are read

This check box is selected by default to mark tasks as consumed on the Talend Data Stewardship server once they are retrieved by the component. These tasks will not be retrieved a second time when you rerun the Job with the same filter criteria.

Make sure to clear this check box only for very specific use cases, otherwise there is a very high risk of processing twice the same tasks.
Note: This option only applies to resolved tasks.

Max request attempts

Set the number of request attempts before throwing a timeout exception and killing the Job.

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 a start component of a Job or subJob and it always needs an output link.