plan is a sequence of tasks that are executed manually or based on a schedule. Plans can be used to automate the execution of multiple related tasks in the .

Before You Begin

Before you begin, please verify the following:

Create Plan

To begin, you must create a plan object.

Steps:

  1. From the left nav bar, click the Plans icon.
  2. The Plans page is displayed.
  3. In the Plans page, click Create. A new plan with the name  Untitled - X is created, where X is a number.  
  4. Click the  Untitled - X to enter a plan name and description.

  5. Your plan is saved and displayed in Plan View.

In Plan View, you create the objects that are part of your plan. These include:

Create Task

Steps:

  1. Identify the tasks that you wish to execute. See "Task Types" below.

    NOTE: You must have access to any assets that you wish to execute as tasks.

  2. Add a task.
    1. In Plan View, click the Plus icon at the bottom of your plan. 
    2. Specify the task to execute.
  3. Repeat the previous step to add additional tasks as needed.

    Tip: You can insert tasks between other tasks. Use the Plus icon between two plan objects.

  4. To test your plan, click Run now. The plan is immediately queued for execution. 
  5. Edit the plan and repeat the above steps until the plan is ready for production runs. 

    Tip: While a plan is in development, you may wish to disable its schedule, which prevents execution according to the schedule. You can still run test executions using the Run Now button.

  6. Create the schedule for the plan. 
    1. In the context menu for the plan, select Schedule.
    2. Specify one or more triggers for the schedule. When a trigger occurs, the plan is queued for execution.
  7. When ready, the plan runs at the time scheduled in the trigger.

Task Types

Based on the schedule's triggers, you can define a sequence of one or more tasks that are executed. 

Add run flow task

A flow task executes the recipes that produce the output objects of the flow. 

Steps:

  1. After you select the flow task type, use the Search bar or browse to select the flow that you wish to add as the task.
  2. Select the output or outputs that you wish to generate from the selected flow. 
  3. Click Create task.
  4. The task is created and added to the plan.

For more information, see Plan View for Flow Tasks.

Add HTTP task

An HTTP task is a request sent using HTTP protocol to a target URL, which could be a REST API endpoint.

NOTE: Specifying an HTTP request requires knowledge of the target endpoint and the parameters required for the request. HTTP tasks are considered developer-level objects. 

Steps:

  1. After you select the HTTP task type, you can specify the task in the context panel.
  2. Specify the fields of the request. 

    Tip: If possible, you should test the HTTP task before you create it. To test for basic connection, you should use the GET method, which just returns relevant information. Some other methods are potentially destructive.

  3. Click Save.
  4. The task is created and added to the plan.

For more information, see Create HTTP Task.

Add Slack task

Slack task is a message submitted from the  to a specified Slack channel.

Steps:

  1. After you select the Slack task type, you can specify the task in the context panel.
  2. Specify the fields of the request. 

  3. Click Save.
  4. The task is created and added to the plan.

For more information, see Create Slack Task.

Add Delete task

Delete task deletes a specified set of files or folders from backend storage.

Steps:

  1. After you select the Delete task type, you can specify the task in the context panel.
  2. Specify the path to the file or folder to delete. This path must already exist.

    1. Location: If this drop-down is available, select the file-based connection. To explore this connection, click Browse.

    2. Navigate to your preferred destination. Click Choose.

  3. Click Save.
  4. The task is created and added to the plan.

For more information, see Create Delete Task.

Apply Parameter Overrides

If your plan tasks include assets where which parameters have been defined, you can review and override these parameter values. Overrides are applied when the task is triggered as part of a plan run.

Steps:

  1. From the Plan View context menu, select Parameters.
  2. Review the names, sources, and current values for all of the parameters in your plan. 
  3. To apply an override, click the Pencil icon and enter a new value. Click Save.

Subsequent runs of the plan use this new value as the override for the parameter. 

Create Plan Branches

In some scenarios, you may need to branch plan execution steps based on the results of a task in the plan. For example, you may need to send separate messages using an HTTP task depending on whether a previous task succeeds or fails in execution.  You can create branches in the plan graph by adding task execution rules and parallel nodes, which run based on the success and failure states of your plan runs. 

To begin this simple example:

  1. Create your first task. 
  2. Complete the following sections.

Add Task Execution Rule

Next, you create the first HTTP task that results from the above task and the execution rule that determines when it runs.

Steps :

  1. Click the plus icon below the existing task node.
  2. Select the HTTP task type and enter information in the required fields. See Add HTTP Tasks above.
  3. Click the link connecting the created HTTP task node and its previous task node and select On success

The HTTP task is executed only when the task has run successfully.

Add Parallel Task

Next, you can create the HTTP task that runs when the first task fails.

Steps:

  1. Click the plus icon below the first task node and select Add a parallel node. A parallel node is added to the plan graph. See Example below.
  2. Select the HTTP task type and enter information in the required fields. See Add HTTP Tasks.
  3. Click the link connecting the new HTTP task and its previous task node and select On failure

The second HTTP task is executed only when the first task has failed to execute.

Tip: You can use parallel tasks to create separate paths through a plan when there are no dependencies between the paths.


Example - Success or Failure Tasks in a Plan

Success and Failure tasks

When the first task complete successfully, the On success HTTP task sends a message.

When the task fails, the On failure HTTP task delivers a different message.

Test Plan

After you have created the tasks of your plan, you can perform a test run of the plan.

Steps:

  1. To test, click  Run now.
  2. The plan run is queued for execution.

Monitor Plan Runs

  1. in the upper-right corner of Plan View, click the Runs link.
  2. In the Plan Runs page, you can track the progress of your plan run.
    1. The most recently triggered plan run is displayed.
    2. If you have executed multiple runs, you can use the angle brackets next to the timestamp for the run.
  3. For tasks in progress, you can click the task to display information in the context panel.
  4. To see the details for the plan run, click the Outputs tab. Then, click Job details.

For more information, see Plan Runs Page.

Add Plan Schedule

You can add a schedule object to specify the triggers when the plan is to be executed.

NOTE: A plan's schedule cannot be executed until its schedule has been enabled. If a plan has a disabled schedule, you can still execute it via the Run Now button.

Steps:

  1. To begin, do one of the following, click Schedule from the Plan View context menu.
  2. In the right context panel, click Create schedule.
  3. In the Add Trigger panel, you can specify the triggers when the plan is executed. You can specify one or more triggers:

    Add trigger(s)
  4. For each trigger:

    1. Timezone: Specify the timezone that applies to the scheduled time. For more information on timezones, see Supported Time Zone Values.

    2. Frequency: You can specify the frequency of when the schedule is triggered.

      1. In each trigger, you can specify multiple On values (e.g. Same time on Sunday and Monday).

      2. As needed, you can specify the On value using a modified form of cron job syntax. For more information, see cron Schedule Syntax Reference.

  5. To add more triggers, click Add another trigger and specify it.

    1. To delete a trigger, click the X next to it.

  6. Parameter overrides:

    1. If the assets in your plan contain parameters, you can apply overrides to the parameter values. 
    2. Overrides provided in this panel are applied only when the trigger is executed.

      NOTE: Multiple values are ok for plan parameters, as long as the parameter values do not conflict. If you see a warning icon next to a set of multiple parameter values, then you must fix this conflict in the original asset, or the plan fails to execution.

    3. You can apply overrides through Plan View, too.  
  7. To save your schedule, click Save.

  8. In the context panel, you can make changes to your schedule:
    1. After saving, the schedule is automatically enabled. To disable the schedule, use the slider bar. 

      NOTE: A plan cannot be executed if the schedule for it has been disabled.

    2. To make changes to the schedule and its triggers, click Edit.