Creating Multi-Stage Execution Plans

Campaign managers have the possibility of creating a multi-stage execution plan for the campaign stages that can be started manually, set to run automatically at a certain date and time, or with a defined recurrence. To set up a multi-stage execution plan, in the Innovation Studio main menu, go to Automation Blocks> Omnichannel Campaigns > Multi-Stage Execution Plan.

IMPORTANT!  
Multi-stage execution plans can be set up only if at stage level the stages included in the execution plan have the Controlled By Execution Plan field set to true and the business status of the campaign is Approved with the closing date set in the future.

There are two ways to start an execution plan:

  • Manually, by using the Start Now button after setting the transition and schedule type.
  • Automatically, by defining the schedule rules for a date set in the future, or with a certain recurrence.

Follow the below steps to define and run a multi-stage execution plan.

1. In the Multi-Stage Execution Plan List, click the Insert button from the right upper corner. The Multi-Stage Execution Plan page is displayed.

2. Fill in the fields:


Field Required Type Description
Name No Text The name of the execution plan.
Stage Transition Yes Option Set

Establish when to move from one stage to another. This setting applies only when two stages are codependent and it determines when the second stage begins. The available options are:

  • When Stage Completed: the transition occurs when all the messages have been created but have not been yet sent to the recipients.
  • When Stage Sent: the transition occurs when all the generated communications from the message queue are sent to the recipients.

Schedule Type Yes Option Set

Schedule when to run the execution plan. The available options are:

  • Manual: The execution plan starts when the Start Now button is pressed.
  • One Time: The execution plan is scheduled to start at a date and time set in the future but only if the execution plan has an Approved business status.
  • Recurrent: Define a recurrence for when new multi-stage execution plan instances are created.
Scheduled Date Yes Date

Schedule the date and time when to run the execution plan.

NOTE  
This field is available only if the Schedule Type field is set to One Time.
Cron Expression No  

Schedule a recurrence for the execution plan. For example, the execution plan can be scheduled to run every day at 9 AM.

NOTE  
This field is available only if the Schedule Type field is set to Recurrent.
Scheduled Timezone Yes Option Set

Select the timezone that applies to the execution plan scheduled date.

NOTE  
This field is available only if the Schedule Type field is set to either Recurrent or One Time.

Stages Available

This section displays the stages that can be used when running the execution plan.

Field Description
Campaign The campaign name that is part of the stage.
Campaign Code The campaign code.
Stage The name of the stage.
 

Execution Tree

This section displays the stages selected when running the execution plan. By default, the execution plan runs the stages from the execution tree from top to bottom. Stages can be sequentially ordered by using the drag and drop option to place one stage after another.

 

FieldDescription
StageThe name of the stage.
CampaignThe name of the campaign.
 

After the schedule rules are defined, the campaign manager can set different business statuses for the execution plan based on the business workflow transitions. The execution plan can have the following statuses: Draft, Pending Approval, Approved, Stopped, Denied.

When the execution plan is in Draft status, changes can be made to it by campaign managers. From the Pending Approval status, it can be either approved or denied. If it's in Approved status, then the execution plan can be run, creating new execution plan instances.

HINT  
The Start Now button is functional only for execution plans in Approved statuses with the Schedule Type field set to Manual.

If the status is changed to Stopped, then another execution plan instance does not start running on that execution plan. In case an execution plan instance is running while the campaign manager changes the status to Stopped, then the execution plan instance runs until the end.

After clicking the Start Now button, campaign managers can pause, resume, or cancel the delivery of the messages generated by an execution plan instance by using the following options:

  • Pause delivery: Use this button to stop the delivery of all the remaining messages that have not been sent to the recipient on that stage instance. In this case, messages are still created but are no longer sent to the recipients.

    This button is displayed if an execution plan instance is in progress.

  • Resume delivery: Use this button to resume the delivery of the messages that haven't been sent to the recipient.

    This button is displayed if an execution plan instance is paused.

To stop the instance execution process while the execution plan is running, click on the Stop current instance execution button. This button is visible both at multi-stage execution plan and multi-stage plan instance level.
When clicking the Stop current instance execution button at execution plan level, the stage that is currently running stops. The process of creating and delivering messages is cancelled and the messages that remain to be sent to the recipients are no longer sent.
The Stop current instance execution button that stops running the multi-stage execution plan instance, can be used regardless of the multi-stage execution plan status.

After the multi-stage execution plan starts running, a summary showing the statuses of the execution stage instances that are running is displayed.

Use the Refresh button to manually update the running statuses of the execution plan.

NOTE  
The execution plan form is automatically updated once the execution plan starts running and the execution plan instance is created.
FieldDescription
Campaign NameThe name of the stage.
Campaign Code The code of the campaign.
Stage NameThe name of the stage.
StatusThe status of the stage:
  • Not Started
  • Started
  • Running
  • Completed
  • Cancelled
Start DateThe start date of the multi-stage execution plan instance.
End DateThe end date of the multi-stage execution plan instance.

Multi-Stage Execution Plan Instances

This section displays the history log of every execution plan run. If, for example, the execution plan has a scheduled recurrence, then every recurrence log is displayed.

Double-click on a record for additional details. A summary of the execution plan is showed:


FieldDescription
NameThe name of the multi-stage execution plan instance composed from the multi-stage execution plan name and and the time the instance began to run.
Parent Execution Plan The parent multi-stage execution plan name.
Execution StatusThe multi-stage execution plan instance status.
Finished AtThe date and time the multi-execution plan instance finished running.
Execution TreeA snapshot of the execution tree.

Execution Log

This section displays the actions taken along with the associated stage and ending dates.

FieldDescription
DateThe date the execution plan started.
Time The time the execution plan started
EventThe stage instances events created. For example: Stage Instance Created, Activities/ Actions Created, Queue Items Created, etc.
StageHyperlink to the stage.
CampaignHyperlink to the campaign.
DetailsDetails regarding the execution plan.

Campaign Stage Instances

This section displays information regarding the campaign stage instances. The below data is available.

FieldDescription
CampaignThe name of the stage.
StageThe code of the campaign.
Start DateThe start date of the stage instance.
Activity DateThe date of the campaign activity.
CompletedIf true, the stage is completed.
End DateThe end date of the execution plan.
Activity Creation DateThe date the activity is created.
Activity Finish DateThe date the activity is finished.
Has ErrorsIf true, errors occurred when running the execution plan.
Run LogThe run log of the execution plan.
HINT  
To view information regarding campaign stage instances or to pause, resume, or cancel the delivery of the messages generated by a stage instance, select a record from the list and open it. For more details, see the Campaign Stage Instances (Actual Run) section.