Skip to main content Skip to complementary content

Campaign properties

Properties to configure the actions you want to perform on a Talend Cloud Data Stewardship campaign while writing into or reading from it.

Information noteNote:
  • A Personal Access Token named Pipeline Designer - Data Stewardship integration (do not delete) is created when retrieving an existing campaign for the first time. This Personal Access Token should not be removed, otherwise you would no longer be able to read or write from/into campaigns.
  • Only Resolution and Merging campaigns are supported in Talend Cloud Pipeline Designer.
  • You can store up to 20 GB of tasks in Talend Cloud Data Stewardship per account.

Source campaign

Main settings
Property Configuration
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 Cloud 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.

If you select Any state, you will not be able to select specific stewards in the Assignee field. To be able to assign the task to a specific data steward, you need to select a specific state.

Assignee

Select the campaign participant whose tasks you want to retrieve. The default value is No Assignee and allows you to create the task without assigning it 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 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 is used by default to create tasks.

  • Tags (optional): Enter the tag to associate with the tasks you want to create. You can use tag to filter the tasks you want to load into the campaign.

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 this documentation.

Advanced settings
Property Configuration
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.

Consume tasks when they are read

This check box is selected by default to mark tasks as consumed on the Talend Cloud Data Stewardship server once they are retrieved. These tasks will not be retrieved a second time when you rerun the pipeline 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.
Information noteNote: This option is only available for resolved tasks.
Batch size Set the number of tasks you want to have for each execution. There are no batch size limits, however it is recommended not to exceed 200 tasks per execution for performance reasons.

The default value is 50.

Destination campaign

Information noteNote: If you want to insert tasks in a Merging campaign, you need to add these fields in the data of the source dataset:
  • TDS_GID: the group ID is used to group the different records under the same task. All records of the same task must be sent together.
  • TDS_MASTER: the master field indicates whether the current record is the golden record for the task. Possible values: true/false.
  • TDS_SOURCE (optional): this is the source name of this record.
Main settings
Property Configuration
Action Select the action you want to perform on the campaign:
  • Insert to insert tasks into the campaign.
  • Delete to delete tasks from the campaign.
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 Cloud 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 who is going to create the assigned task. The default value is No Assignee and allows you to insert the task without assigning it 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 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 is used by default to delete tasks and Medium priority is used to insert tasks.

  • Tags (optional): Enter the tag to associate with the tasks you want to create. You can use tags to filter the tasks you want to load into the campaign.

Input field of task ID

Task metadata that is automatically added to the schema.

TDS_ID is the task identifier used to identify tasks to be deleted.

This option is available only if you have previously selected the Delete option in the Action list.

Advanced settings
Property Configuration
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.

Batch size Set the number of tasks you want to have for each execution. There are no batch size limits, however it is recommended not to exceed 200 tasks per execution for performance reasons.

The default value is 50.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!