The create a schedule wizard

This section describes in detail the pages you use when you create a schedule.

The following table describes the fields you use when you schedule runs of Campaign flowcharts, eMessage mailings, Contact Optimization sessions, external scripts, and API calls.
Table 1. Fields in the create a schedule wizard
Field Description
Select a task type The type of object to be scheduled. The following options are available.
  • External task - script

    Allows you to schedule invocation of tasks defined in batch or shell scripts external to HCL® Marketing Software.

    Only if you have applied Marketing Platform FixPack 10.0.0.1, the script must be listed in a whitelist file located in the conf directory under your Marketing Platform installation. Also, the script must be on the web application server where Marketing Platform is deployed.

  • External task - API

    Allows you to schedule invocation of APIs external to HCL Marketing Software.

    Only if you have applied Marketing Platform FixPack 10.0.0.1, the API must be listed in a whitelist file located in the conf directory under your Marketing Platform installation.

  • Campaign flowchart

    Allows you to schedule invocation of Campaign flowcharts. Selecting this option takes you to the Campaign list page where you select a campaign, optionally set flowchart override parameters, and schedule the flowchart run.

  • Contact Optimization session

    Allows you to schedule invocation of Contact Optimization sessions. Selecting this option takes you to the Contact Optimization sessions list page where you select a session and schedule the session.

  • eMessage mailing

    Allows you to schedule invocation of eMessage mailings. Selecting this option takes you to the eMessage mailings list page where you select and schedule the mailing.

  • Marketing Operations bulk deactivation

    Allows you to schedule bulk deactivation of projects in Marketing Operations. Selecting this option takes you to the Marketing Operations Administrative Settings page where you click Deactivation Administration and schedule the bulk deactivation.

  • Alert

    Allows you to schedule alerts for users of HCL Marketing Software. Selecting this option opens a window where you set the message title, message body, and severity. After you click Schedule this alert, you can create a schedule for the alert.

    Users can manage their notification subscriptions based on severity.

  • Notification

    Allows you to schedule notifications for users of HCL Marketing Software. Selecting this option opens a window where you set the message title, message body, and severity. After you click Schedule this notification, you can create a schedule for the notification.

    Users can manage their notification subscriptions based on severity.
Schedule name Enter a name for the schedule.
Scheduler group If you have created one or more throttling groups, you can associate this schedule with a group to limit the number of runs of this schedule that can execute at the same time. Throttling groups configured on the Configuration page appear as options in this field
Description Enter a description for the schedule.
Run parameters

Used when you schedule APIs and scripts.

Only if you have applied Marketing Platform FixPack 10.0.0.1, a whitelist prerequisite applies to any external tasks that you create to schedule API calls or scripts. Before you can schedule an external task, you must add the API or script to a whitelist located in the conf directory under your Marketing Platform installation.

  • For API schedules, enter the URI, plus any parameters in the format shown in the examples.

    API with no parameters: http://example.com

    API with parameters: http://www.example.com/tickets?fields=id&state=open&sort=updated_at

    Currently, there is no support for Marketing Platform tokens in the URI.

  • For script schedules, enter the full path to the script on the Marketing Platform server, plus any parameters in the format shown in the examples. Specify the parameter names between double number signs (##) followed by a space.
    • Windows™ examples

      Script with no parameters: C:\Scripts\ExecuteDatabaseJob.bat

      Script with parameters:

      C:\Scripts\RunETLJobs.bat ##username## ##password## ##db_table##

    • UNIX™ examples

      Script with no parameters: /opt/ExecuteDatabaseJob.sh

      Script with parameters:

      /opt/RunETLJobs.sh ##username## ##password## ##db_table##

Execution of these tasks is asynchronous. Marketing Platform does not track success or failure of script and API tasks. Status indicates only whether they are launched successfully.

On successful completion, send a trigger If you want runs of this schedule to send a trigger when the run completes successfully, enter the trigger text here. Other schedules can be set to listen for this trigger.
On error, send a trigger If you want runs of this schedule to send a trigger when the run fails, enter the trigger text here. Other schedules can be set to listen for this trigger.
Search tags / keywords Enter any tags you want you associate with the schedule for use in searches. Separate multiple entries with commas.
Schedule status Whether the schedule is enabled or disabled. Disabling a schedule applies only to future or queued runs of that schedule. Any run currently underway is not affected. The default status is Enabled.
Select time zone If you select an option other than the server default, the Start, End, and Last updated columns on the Schedule management page show both the server default time and the time in the selected zone.
When to start Select one of the following options to specify the first time the schedule runs. The start time applies only to the first run; it defines the time when a schedule is first eligible to run. The actual first run might be after the start date if any of the following conditions are present.
  • The schedule is configured to wait for a trigger.
  • The schedule is a member of a throttling group.
  • The schedule uses a recurrence pattern.
  • Now
  • On a date and time - Select a date and time.
  • On a trigger - Select an existing trigger or enter a new one. If you enter a new one, you must configure a schedule to send this same string on success or failure.
  • On a trigger after a date - Select an existing trigger or enter a new one, and select a date and time. If you enter a new trigger, you must configure a schedule to send this same string on success or failure.
  • On completion of other tasks - Select from a list of existing schedules. The schedule runs only when the selected other schedules have finished their runs.
Number of runs

Select one of the following options to specify the number of runs.

  • Run once only - The schedule runs one time. It is eligible to execute the run on the start date and time you specify.
  • Stop after n occurrences - Runs stop after the specified number of runs have occurred (whether the runs succeed or fail) or the end date arrives, whichever is first.
  • Stop by a date and time - Runs are initiated as many times as defined until the specified end date and time is reached. A run might execute after this time if the run execution has been delayed due to throttling constraints.
  • On completion of other tasks - The schedule runs only when all the other tasks selected for this option complete successfully.
When you click the Set up recurrences button, you can select one of the following options.
  • Use a pre-defined recurrence pattern - Select a pattern from the list. The Marketing Platform provides a set of pre-defined patterns, and you can create your own by adding properties on the Configuration page.
  • Use a simple custom recurrence pattern - Select an interval.
  • Use a cron recurrence expression - Enter a valid cron expression.