Page tree

 

Contents:


A plan is a sequence of tasks that are executed based on a schedule. Plans can be used to automate the execution of multiple related tasks, such as all of the outputs generated from a set of multiple related flows.

  • When a plan is triggered:
    • The set of tasks in the plan are triggered in the order listed in the plan. 
    • All of the dependencies for any task are also executed. For example, if a flow output requires the outputs from another upstream flow, then that flow's output is also generated.
    • If one task fails to execute, the other tasks are not executed.
  • For more information on plans, see Overview of Operationalization.

Before You Begin

Before you begin, please verify the following:

  • You have access to all of the flows that you wish to use in your plan.
  • For each flow in your plan:
    • All of the recipes whose results you wish to generate have output objects associated with them.
    • Each output object has at least one of the following that has been created for it:
      • write setting object (table-based output)
      • publication (file-based output)

        NOTE: In a flow, all recipes that you wish to have executed by the corresponding task must have a defined output object. For each output object, you must create at least one write settings or publication object. During plan runs, these objects are not validated, and missing outputs are ignored.

Workflow

NOTE: Parameter values are applied to a plan, but you cannot apply parameter overrides to the plan. You can apply flow parameter overrides on individual flows, which are applied at the time of plan execution. For more information, see Manage Parameters Dialog.


Workflow steps:

  1. Identify the tasks that you wish to execute. 

    NOTE: You must have access to any flows that you wish to execute. See Flows Page.

  2. 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.
  3. Add a task.
    1. In Plan View, click the Plus icon at the bottom of your plan. 
    2. Specify the task to execute.
  4. 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.

  5. Before you can run a plan, it must be activated, which sets the current version of the plan as the one to execute. Click Activate.
  6. To test your plan, click Run now. The plan is immediately executed. 
  7. 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.

  8. When ready, the plan runs at the time scheduled in the trigger.

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. See Plans Page.
  3. In the Plans page, click Create
  4. Enter a Name and Description for your plan. Click Create.
  5. Your plan is saved and displayed in Plan View. See Plan View Page.

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

  • Plan Schedule: A schedule is composed of one or more triggers that determine when the plan is executed.
    • Trigger: Scheduling object that determines the conditions under which the plan is executed. 
    • A schedule can contain one or more triggers.
  • Task: An action that is executed when triggered.
    • You can build a sequence of one or more tasks in your plan.

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 the plan has been activated and its schedule has been enabled. If a plan with a disabled schedule has been activated, you can still execute it via the Run Now button.

Steps:

  1. When you first open Plan View, you should see an empty plan:

    Figure: Plan View - empty plan

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

    Figure: Add trigger(s)

  5. 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.

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

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

  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.

Add Task

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

  • To add a new task, click the + icon below the trigger. 
  • To insert a task between two other objects, click the + icon between them.

Add run flow task

Steps:

  1. After you click the + icon, 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.

Activate Plan

NOTE: Before you can run a plan, you must activate the plan. Only the latest version of the plan can be activated. The activated version is used during any plan runs.

To activate a plan, click Activate.

When you activate a plan, a snapshot of the plan is taken.

  • This snapshot is used in all subsequent executions of the plan. 
  • Subsequent changes to the flows, outputs, and other objects referenced in the snapshot can still affect job executions.
  • For more information on plan execution, see Overview of Operationalization.

If you make subsequent changes to the plan, it must be re-activated to apply those changes to your plan runs.

Test Plan

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

Steps:

  1. You must activate the version of the plan that you wish to run. Only the latest version of the plan can be activated.
  2. To test, click Run now.
  3. 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. See Job Details Page.

This page has no comments.