Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 4.11 KB

advanced-parameters.md

File metadata and controls

78 lines (44 loc) · 4.11 KB
product title description feature exl-id
campaign
Advanced parameters
Advanced parameters
Workflows, Data Management
6c90ac2f-0d2b-48b0-9245-3e5e3a3d027c

Advanced parameters{#advanced-parameters}

The properties screen of an activity has an [!UICONTROL Advanced] tab that lets you define a behavior in case of errors, the execution period for the activity; and lets you enter an initialization script. There are two versions of this tab:

  • a simplified version (for [!UICONTROL Start] and [!UICONTROL End] activities for instance)

  • a more detailed version (for the [!UICONTROL Query] activity, for instance)

The fields to be entered in the [!UICONTROL Advanced] tab are detailed in the following sections.

Name {#name}

This field contains the internal name of the activity.

Image {#image}

This field lets you change the image linked to an activity. For more on this, refer to Change activity images.

Execution {#execution}

This field lets you define the action to be carried out when the task is triggered. There are three possible options:

These options are generally selected in the cart by right-clicking the activity.

  • [!UICONTROL Normal]: the activity is executed as usual.
  • [!UICONTROL Do not activate]: this task and all the following tasks (in the same branch) are not executed.
  • [!UICONTROL Activate but do not execute]: this task and all the following tasks (in the same branch) are automatically stopped. This can be useful if you want to be there when the task is started. To execute the task manually, right-click the activity and select [!UICONTROL Normal execution].

Affinity {#affinity}

You can choose to force the execution of a workflow or workflow activity on a specific machine. To do this, you must define one or more propensities at the level of the workflow or the concerned activity.

High availability workflow configuration is detailed in this section.

Max. execution period {#max--execution-period}

This field lets you set a warning for when the task takes too long. It won't impact workflow operation. If the task isn't finished by the time the [!UICONTROL Max. execution period] is over, the [!UICONTROL Instance monitoring] page will show a warning for this workflow. This page is accessed via the [!UICONTROL Monitoring] tab of the home page.

Behavior {#behavior}

This field lets you define the behavior to be applied for using asynchronous tasks. There are two possible options:

  • [!UICONTROL Several tasks authorized]: several tasks can be executed at once, even if the first one isn't finished.
  • [!UICONTROL The current task has priority]: tasks in progress take priority. As long as a task is in progress, no other task will be executed.

Time zone {#time-zone}

This field lets you select the time zone of the activity. For more on this: Manage time zones.

In case of errors {#in-case-of-errors}

This field lets you define the action to be carried out when the activity has errors. There are two possible options:

  • [!UICONTROL Suspend the process]: the workflow is stopped automatically. Its status changes to [!UICONTROL Failed]. Once the problem is solved, re-start the workflow.
  • [!UICONTROL Ignore]: this task and all the following tasks (in the same branch) aren't executed. This can be useful for recurring tasks. If the branch has a scheduler placed upstream, it will start as usual on the next execution date.
  • [!UICONTROL Abort on error]: the workflow is stopped automatically and cannot be restarted. Its status changes to [!UICONTROL Failed].

Initialization script {#initialization-script}

This field lets you initialize variables or modify activity properties. For more on this, refer to: JavaScript scripts and templates.

Comment {#comment}

The [!UICONTROL Comment] field is a free field that lets you add a description.