How to Modify Tasks on the Canvas
  • 27 Jul 2023
  • Dark
    Light
  • PDF

How to Modify Tasks on the Canvas

  • Dark
    Light
  • PDF

Article summary

To modify a task on the new canvas, double-click a task on the canvas to display the Task panel on the right. Each Task panel will contain a Data, Advanced, and Details tab.

  • The Data tab contains input and output variables.
  • The Advanced tab contains the Access Control, Run Window, and Retry Task configurations.
  • The Details tab contains a description of the task that can be edited as well as a link to the API Documents page.

Figure 1: Task Configuration Panel
01_Task Properties_2023.1

How to Edit a Task

To edit a task:

  1. Double-click any task in the workflow canvas to open the Edit task dialog.
  2. Update the appropriate task properties.
  3. Click the SAVE button to retain your changes.

How to Copy a Task

To copy a task within an automation:

  1. Right-click the task to view the pop up menu.
  2. Click Copy.
  3. Rigth-click anywhere on the Canvas and click Paste here from the pop up menu. A copy of the task is pasted onto the canvas.
Keyboard Shortcuts:
  • Command + C and Command + V can be used to copy and paste, respectively.
  • Holding the Option key and dragging to duplicate can be used as well.

How to Delete a Task

To delete a task:

  1. On the Automation Builder canvas, select the task you want to delete.
  2. Click the Delete button, or double-click the task and choose Delete from the pop up menu .
  3. Click the SAVE button in the title bar.

How to Spread Tasks on the Canvas

To spread tasks out on the canvas for better viewing and management:

  1. Click the Fit Window button fitWindowButton in the upper-right corner of the Canvas.
  2. An option to Spread Tasks will appear. Moving the slider will allow users to enlarge or shrink the area between tasks that are on the canvas.

Figure 2: Spread Tasks
18_Spread_Tasks_2023_2

How to Use Recent Tasks

The ten (10) most recent tasks moved from the Task Palette to the canvas will now be stored under the Recent Tasks icon for quick access. Click the icon for Recent Tasks and a dropdown will display the 10 most recent tasks added to the canvas.

From the Recent Tasks dropdown, each task can be dragged and dropped onto the canvas to use again as needed. Copying, pasting, or duplicating tasks already on the canvas will not add them to the Recent Tasks dropdown. Any task displayed in the Recent Tasks dropdown can be removed by clicking the "X" to the right of the task.

Figure 3: Recent Tasks
17_recent_2023_2


How to Find Adapter IDs

Adapter IDs can now be found under the Advanced tab in the Task Options dropdown.

Figure 4: Adapter IDs
12_Task_ID_2023_1

How to Retry a Task

From the Automation Builder canvas, a task can be setup to allow an operator of a job to retry it. Two types of task retry are available: Automatic and Manual.

  • The Automatic Retry is configured on the canvas with options for when to retry, how often, and if there should be a delay between retry attempts.
  • A Manual Retry is available within Operations (Job) Manager; however, to enable this capability, the automation designer must specifically have 'Retry Task' set to true.

To specify the retry settings on the Canvas:

  1. Open the Task Details dialog and click the Advanced tab.

  2. Expand the Retry Task dropdown.

  3. Toggle Enable Retry Task to "on".

  4. Select the Automatically Retry Task checkbox. When checked, the task will automatically retry without user intervention.

  5. Configure the Retry settings using the table below.

    Retry Setting Description
    Retry On Select a value from the dropdown to set what conditions to allow task retry to occur on.
    Number of Retry Attempts The number of times to retry a task before the workflow must continue running. Default value is "10". Note: Itential advises caution when increasing the Number of Retry Attempts. There is no limit to the number of times to retry a task.
    Retry Delay The number of seconds between retry attempts a task waits to retry again.

    Figure 5: Retry Settings Dialog
    08_retry_2023_1

  6. After running the workflow, you can manually retry a task by accessing the job in Operations Manager (IAP→ Operations Manager → Jobs), and clicking the Retry button in the Job Details panel, located in the vertical dots (⋮) button menu of the job, if available. You will be presented with a Retry Task modal that contains a previous iteration of retry values. From this modal, you can provide new inputs on the retry. The modal is also resizable. After entering the new inputs, click Continue Job.

    Figure 6: Retry Task Button
    09_Retry_OM_2023_1

How to Restrict an Automated Task from Running

You can restrict when an automated task will run by specifying a schedule. This is also defined as setting the Run Window for a task, which means the task will not run (once it is time to run) if the current time falls outside the run window.

To schedule an automated task:

  1. In an open automation, double-click an automated task to open the Edit task dialog.
  2. Click the Advanced tab and then expand the Run Window dropdown.
  3. Toggle the Enable Run Window switch to open the schedule options..
  4. Select an option from the Run Window Mode.
    1. Select Static to statically define the task's run window.
    2. Select Job to pass the schedule at run time through a job variable and then configure the properties. The job variable can be a job variable name, a static value, or an earlier task's outgoing variable name or error.
    3. Select Task to define the data source. Options include: job, static, or any prior task in the current automation (listed by name in the dropdown).
  5. Enter the **Window Start ** and Window End time in 24 HR format (HHMM) relative to the server's configured timezone.
  6. Select the days on which the task should run. The selected buttons will turn from white to blue.
  7. The selections are automatically SAVED in the task.

Figure 7: Run Window Dialog
11_Schedule_2023_1


How to Swap a Task on the Canvas

Tasks on the canvas can now be swapped without having to delete another task or the transition that connects to the task that is swapped.

To use this feature:

  1. Double-click the task on the canvas to display the task panel.

  2. In the upper-left corner of the task panel overlay, click the Swap Task icon ( ) to open a simplified version of the task palette that is used to add tasks to the canvas.

    Figure 8: Swap Task
    13_swap_task_2023_2

  3. Locate the replacement task via the task filter, or scroll through the list of tasks.

  4. Click on the replacement task to put it in focus and enable (highlight) the “Confirm Swap” button at the bottom of the panel.

  5. Click Confirm Swap. The replacement task will now show in place of the original task on the canvas.

  6. Click Cancel Swap to revert back to the original task displayed on the canvas.

    Figure 9: Confirm Swap and Cancel Swap Buttons
    14_confirm_2023_2

  7. Any data under the Advanced Tab of the original task will be retained in the swapped task.

    Figure 10: Advanced Variables (Tab)
    15_advaned_2023_2

  8. If the swapped task contains similar variables to the original task, select the Retain Task Data checkbox to carry over any relevant data that is applicable. If the swapped task is a completely different type of task, the variables will not be carried over.

Figure 11: Retain Task Data
16_retain_2023_2


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.