clone_task
Clones the definitions of the specified task on the specified server. The definitions include the task settings, tables/table patterns (include/exclude), table settings, and global transformations. The endpoint definitions are cloned with the task definition.
- You cannot override an existing task with the same name
- The task being cloned must have a source and target endpoint
Required user role
Operator or above on Qlik Enterprise Manager.
Syntax
def clone_task
(
self,
payload,
server,
task
)
Syntax Parameters
| Parameter | Type | Description |
|---|---|---|
|
payload |
AemCloneTaskReq |
The definitions to clone. All definitions are optional except the task name. |
| server | string |
The Replicate Server name as defined in Qlik Enterprise Manager. Example: myrepsrv1 |
|
task |
string |
The name of the Replicate task to clone. |
Payload parameters
| Name | Required | Description |
|---|---|---|
| new_task_name | Yes | The new name of the task after it has been cloned. |
| clone_permissions | No | Stipulates whether to clone the task permissions. The value can be true of false. The default is false, meaning that if this parameter is omitted, the permissions will not be cloned. |
| new_source_endpoint | No |
The display name of the source endpoint. The display name must already exist on the Replicate Server. Information noteThe display name must be of an endpoint of the same type used in the task being cloned. For example, if the source endpoint in the task being cloned is of type Oracle, you cannot specify MyNewSource if it is the display name of a Microsoft SQL Server endpoint.
|
| new_target_endpoint | No |
The display name of the target endpoint. The display name must already exist on the Replicate Server. Information noteThe display name must be of an endpoint of the same type used in the task being cloned. For example, if the target endpoint in the task being cloned is of type Oracle, you cannot specify MyNewTarget if it is the display name of a Microsoft SQL Server endpoint.
|
| new_control_schema | No | The new name of the schema in which to create the control tables. |
| new_target_schema | No | The new name of the schema in which to create the target tables. |
| new_control_table_tablespace | No |
The new name of the tablespace in which to create the control tables. Information noteRelevant when replicating to an Oracle target only.
|
| new_control_index_tablespace | No |
The new name of the tablespace in which to create the control table indexes. Information noteRelevant when replicating to an Oracle target only.
|
Example
When the following method is run, my-task will be cloned on Replicate server myreplicateserver to a new task called my-task-clone, but will be configured with a different target endpoint that has different-target-endpoint as its display name.
clone_task_req = AemCloneTaskReq() clone_task_req.new_task_name = 'my-task-clone' clone_task_req.new_target_endpoint = 'different-target-endpoint' self.aem_client.clone_task(clone_task_req, 'myreplicateserver', 'my-task')