Task Execution - Overriding Parameters

A task execution can override execution parameters, as follows:

  • Setting the active environment based on the task's environments.
  • Setting key-value parameters on a session level.
  • Overriding Globals values on a session level.
  • Overriding the Sync Mode of the task execution.
  • Overriding additional execution parameters without changing the task itself.

Setting Active Environments

Extract Tasks

The TDM Execution process sets the task's environment as the active environment on the executed task.

Load Tasks

The TDM Execution process sets the active environment:

  1. Sets the task's source environment as the active environment.
  2. Gets the LUI from Fabric.
  3. Sets the task's target environment as the active environment.
  4. Runs the delete and/or load flows on the target environment.

Setting Key-Value Parameters

Set execution parameters like replace sequence, delete before load or insert to target indicators. These parameters are based on the task's settings and are set on a session level.

Overriding Globals Values

A project's Globals can be overridden on a TDM environment or TDM task level.

The TDM execution process sets the values on the Globals on a session level.

Note that task level Globals have a higher priority than TDM environment level Globals, i.e. if a Global variable is set on both - the task and the related environment levels - the task's Global value is set.

Overriding the Sync Mode on the Task Execution

When executing a TDM task, set the Sync mode according to the following table:

Override Sync - Source Env Level

Override Sync - Task Level 

Task Operation Mode

Task Execution Sync Mode

Results

None

None

All

On

LUIs are synced according to their sync method. See the Sync Behavior Summary table.

None

Request up-to-date entity

All

Force

LUI are synced from the source.

Always sync

None

All

Force

LUI are synced from the source.

Always sync

Request up-to-date entity

All

Force

LUI are synced from the source.

Do not sync

Request up-to-date entity

All

Force

LUI are synced from the source.

Do not sync

 

 

None

 

 

Insert

Off

  • First sync, return an error.
  • If the LUIs exist in Fabric:
  • Get the data from Fabric.

Delete and insert 

On

  • First sync, return an error.
  • If the LUIs exist in Fabric:
    • Source LU tables:
    • Get the data from Fabric.
    • Target LU tables:
    • Sync the data from the target environment.

Delete only

On


Target LU tables are synced

from the target environment.

Do not sync

 

 

Do not sync source data

 

 

Insert

Off

  • First sync, return an error.
  • If the LUIs exist in Fabric:
  • Get the data from Fabric. 

Delete and insert 

On

  • First sync, return an error.
  • If the LUIs exist in Fabric:
    • Source LU tables:
    • Get the data from Fabric.
    • Target LU tables:
    • Get the data from the target environment.

None

 

 

Do not sync source data

 

 

Insert

Off

  • First sync, return an error.
  • If the LUIs exist in Fabric:
  • Get the data from Fabric.

Delete and insert 

On

  • First sync, return an error.
  • If the LUIs exist in Fabric:
    • Source LU tables:
    • Get the data from Fabric.
    • Target LU tables:
    • Get the data from the target environment.

Overriding Additional Task Execution Parameters

The TDM API that starts a task execution can get a list of parameter-value pairs to override the original values of these parameters on the task execution without changing the task data.

This way, various users can use a task as a template and change (override) the execution parameters without changing the task itself: each user can run the task on their environment and update the execution parameter based on their needs.

TDM 7.2 supports the override of the following parameters:

  • TDM Environments:

  • Globals:

  • Entity List : provide a list of entities separated by a comma instead of the task's entity list. Note that the Entity List can only contain one entity ID when executing a task with a Synthetic selection method.

  • Selection Method : set the overridden selection method to 'L' (Entity List), when overriding the task's Entity List, except for a task with a Synthetic selection method. It is possible to provide a single entity in the Entity List to clone the entity by the task with the Synthetic selection method.

  • Number of Entities : change the number of entities to be processed by the task execution. This parameter is only relevant for Load tasks when the entitylist override parameter is not set.

Notes:

  • The TDM supports overriding the task execution parameters only when invoking the start task execution API outside the TDM GUI. Currently this option is not supported when executing the task using the TDM GUI.
  • The execution parameters override is not supported for Data Flux tasks.

Validate the Task Execution Parameters

This API validates the overridden parameters with the user's permissions on the task's environments:

  • Overrides the source and/or target environments: check the user's permissions on the new environments and verify that the user has permissions to run the task on the environments.
  • The task's environments are not overridden: check the user's permissions on the task's environments and verify that the user has permissions to run the task on the environments.
  • Overrides the Entity List or the Number of Entities: verify that the updated number of entities does not exceed the user's permissions on the environments on which the task needs to run.

If at least one of the validation fails, the API does not start the task and returns the validation errors.

Task Execution Process

The override of task execution parameters does not update the task itself, but only impacts the given task execution:

The task execution process gets the overridden parameters from task_execution_override_attrs TDM DB table and executes the task based on the overridden parameters.

Previous

Task Execution - Overriding Parameters

A task execution can override execution parameters, as follows:

  • Setting the active environment based on the task's environments.
  • Setting key-value parameters on a session level.
  • Overriding Globals values on a session level.
  • Overriding the Sync Mode of the task execution.
  • Overriding additional execution parameters without changing the task itself.

Setting Active Environments

Extract Tasks

The TDM Execution process sets the task's environment as the active environment on the executed task.

Load Tasks

The TDM Execution process sets the active environment:

  1. Sets the task's source environment as the active environment.
  2. Gets the LUI from Fabric.
  3. Sets the task's target environment as the active environment.
  4. Runs the delete and/or load flows on the target environment.

Setting Key-Value Parameters

Set execution parameters like replace sequence, delete before load or insert to target indicators. These parameters are based on the task's settings and are set on a session level.

Overriding Globals Values

A project's Globals can be overridden on a TDM environment or TDM task level.

The TDM execution process sets the values on the Globals on a session level.

Note that task level Globals have a higher priority than TDM environment level Globals, i.e. if a Global variable is set on both - the task and the related environment levels - the task's Global value is set.

Overriding the Sync Mode on the Task Execution

When executing a TDM task, set the Sync mode according to the following table:

Override Sync - Source Env Level

Override Sync - Task Level 

Task Operation Mode

Task Execution Sync Mode

Results

None

None

All

On

LUIs are synced according to their sync method. See the Sync Behavior Summary table.

None

Request up-to-date entity

All

Force

LUI are synced from the source.

Always sync

None

All

Force

LUI are synced from the source.

Always sync

Request up-to-date entity

All

Force

LUI are synced from the source.

Do not sync

Request up-to-date entity

All

Force

LUI are synced from the source.

Do not sync

 

 

None

 

 

Insert

Off

  • First sync, return an error.
  • If the LUIs exist in Fabric:
  • Get the data from Fabric.

Delete and insert 

On

  • First sync, return an error.
  • If the LUIs exist in Fabric:
    • Source LU tables:
    • Get the data from Fabric.
    • Target LU tables:
    • Sync the data from the target environment.

Delete only

On


Target LU tables are synced

from the target environment.

Do not sync

 

 

Do not sync source data

 

 

Insert

Off

  • First sync, return an error.
  • If the LUIs exist in Fabric:
  • Get the data from Fabric. 

Delete and insert 

On

  • First sync, return an error.
  • If the LUIs exist in Fabric:
    • Source LU tables:
    • Get the data from Fabric.
    • Target LU tables:
    • Get the data from the target environment.

None

 

 

Do not sync source data

 

 

Insert

Off

  • First sync, return an error.
  • If the LUIs exist in Fabric:
  • Get the data from Fabric.

Delete and insert 

On

  • First sync, return an error.
  • If the LUIs exist in Fabric:
    • Source LU tables:
    • Get the data from Fabric.
    • Target LU tables:
    • Get the data from the target environment.

Overriding Additional Task Execution Parameters

The TDM API that starts a task execution can get a list of parameter-value pairs to override the original values of these parameters on the task execution without changing the task data.

This way, various users can use a task as a template and change (override) the execution parameters without changing the task itself: each user can run the task on their environment and update the execution parameter based on their needs.

TDM 7.2 supports the override of the following parameters:

  • TDM Environments:

  • Globals:

  • Entity List : provide a list of entities separated by a comma instead of the task's entity list. Note that the Entity List can only contain one entity ID when executing a task with a Synthetic selection method.

  • Selection Method : set the overridden selection method to 'L' (Entity List), when overriding the task's Entity List, except for a task with a Synthetic selection method. It is possible to provide a single entity in the Entity List to clone the entity by the task with the Synthetic selection method.

  • Number of Entities : change the number of entities to be processed by the task execution. This parameter is only relevant for Load tasks when the entitylist override parameter is not set.

Notes:

  • The TDM supports overriding the task execution parameters only when invoking the start task execution API outside the TDM GUI. Currently this option is not supported when executing the task using the TDM GUI.
  • The execution parameters override is not supported for Data Flux tasks.

Validate the Task Execution Parameters

This API validates the overridden parameters with the user's permissions on the task's environments:

  • Overrides the source and/or target environments: check the user's permissions on the new environments and verify that the user has permissions to run the task on the environments.
  • The task's environments are not overridden: check the user's permissions on the task's environments and verify that the user has permissions to run the task on the environments.
  • Overrides the Entity List or the Number of Entities: verify that the updated number of entities does not exceed the user's permissions on the environments on which the task needs to run.

If at least one of the validation fails, the API does not start the task and returns the validation errors.

Task Execution Process

The override of task execution parameters does not update the task itself, but only impacts the given task execution:

The task execution process gets the overridden parameters from task_execution_override_attrs TDM DB table and executes the task based on the overridden parameters.

Previous