You can create a schedule to enable your data flow to run automatically at specified times and intervals.
-
From the Directory, select the data flow for which you want to create a schedule, then from the details panel on the right, click Create new schedule. The Schedule a Data Flow dialog opens.
-
On the General tab, enter a Name for your new schedule.
-
Optionally, enter a Description for your schedule. When you have created your schedule, the description will be visible from the details panel.
-
Optionally, schedule a follow-up data flow to be run based on the result of the primary data flow. For more information, see Scheduling follow-up runs.
-
Select Yes to enable your data flow immediately, or select No if you want to enable your schedule later. For more information, see Enabling and disabling schedules.
- Optionally, choose where to save temporary data files by selecting a Data Location. This allows you to choose a location that is accessible to other users who are collaborating with you on a data flow, so that they can also view the run data without needing to re-run the data flow. If you leave this field blank, the default system setting will be used for the location of the temporary execution data. The default system setting is configured from the Settings collection in the Directory.
- On the Schedule tab, specify the interval between runs. Note: Dates and times should be specified, and are displayed, in the server timezone.
-
Monthly intervals reset each new year, launching a run in January followed by consecutive runs at the chosen monthly interval.
-
Weekly intervals reset each new week, launching on the chosen days.
-
Daily intervals reset each new month, launching on the first day of the month followed by consecutive runs at the chosen daily interval.
-
Hourly intervals reset each new day, launching a run at midnight followed by consecutive runs at the chosen hourly interval.
-
Minute intervals reset each new hour, launching a run on the hour followed by consecutive runs at the chosen minute interval.
-
Cron Expression. Type a Quartz Cron expression, consisting of at least five fields.
For more about Cron expressions, see http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html.
The information message that follows, displays either the summary of a valid expression, or error feedback for an invalid expression.
Note: If the Cron expression specifies, for example, a run time of less than a minute between schedules, the Information message displays a cautionary note. Although you can continue, you should expect scheduled runs to be skipped, because the previous run has not been completed yet.
-
- Enter the date to Start On and, if appropriate, the time to Start At.
- Click the Run Properties tab and enter any required run property values. You can select a Run Property Set to be associated with the schedule, and in this case any run properties defined on the associated data flow which are also defined in the selected run property set (matched by name) will be used.Tip: Default run properties and any custom run properties that you have previously created in the Designer will be visible in the Schedule a Data Flow dialog. In the Schedule a Data Flow dialog you can define a value for the run property. Default run properties can be overridden if required, see Using derived property values. If you want to create a new run property, select the Run tab of the Properties panel, see Defining properties for more information.Tip: You can create multiple schedules with different run property values to allow you to compare different versions of one data flow.
- When you have finished entering the required information, click Confirm.
The schedule is created and added to the Schedules collection and to the document list of the relevant Directory folder.