Running a Flow as a Scheduled Job
- 15 May 2023
- 2 Minutes to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
Running a Flow as a Scheduled Job
- Updated on 15 May 2023
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
To capture or transform data on a regular basis, Flows can be set to run on an hourly, daily, weekly, or monthly schedule using the Scheduled Jobs feature.
Example
The following example will demonstrate how to configure a Scheduled Job Flow to run an existing Flow using a TimeSpan schedule.
- In the Decisions Studio, navigate to System > Jobs And Events > Scheduled Jobs and click NEW SCHEDULED FLOW.
- On the New Scheduled Flow window, enter "Example Scheduled Job" in the Name field under the SCHEDULED JOB INFO category. Under Flow Job Information, click PICK OR CREATE FLOW. Click PICK and select an existing Flow to use.
- Under Schedule Configuration, in the Calendar drop-down dialog, select the TimeSpan Schedule option. A TimeSpan schedule sets a job to run regularly, with the interval defined between each instance.
- Navigate to the CALENDAR INFORMATION category under TimeSpanSchedule Information, select Immediately in the RunWhen drop-down list. To set the time span between each job, use the slider control or enter a value in the Seconds, Minutes, Hours, Days. Select SAVE once complete.
- The Scheduled Job will appear on the SCHEDULED JOBS page in a list. Right-click the name of the Job to access options in the action menu.
Schedule Job Properties
Once a scheduled job is created, users are able to edit the scheduled job to view more properties. To view these properties, right-click a scheduled job and select Edit Schedule Job.
Edit Scheduled Job Settings
| Property | Description |
|---|---|
| Start Date | Sets the job's start date/time |
| Specify Expiration | Sets the job's desired Expiration date |
| Run Job on Startup | Configures the Schedule job to start once the User logs into the Decision Instance |
| Schedule Job Name | Specifies the Schedule Job name to distinguish between other jobs |
| Description | Contains the Schedule Job Description to further distinguish between other jobs |
| No. of Attempts | Sets the number of times a schedule job will run if there are any failures (default is 0 which represents infinite attempts) |
| Assign Failure to User | Allows users to select an assigned user that will receive a task when there is a failed job |
| Requeue Failed Action | Allows the failed action to be added back into the queue of scheduled jobs |
| Create Task on Job Failure | Allows a task to be assigned to the Assign Failure to User user when the job fails |
| Respect Schedules In Folder | Allows the job to be configured based on existing schedules in a folder. The Pick Folder with Schedule option displays for user to pick the desired folder. |
EDIT JOB INFO and Flow Input Data
Flow Input Data allows a user the ability to declare input data for selected Scheduled Job Flows that are configured to expect it.
| Property | Description |
|---|---|
| PICK OR CREATE FLOW | Specifies the Flow that runs during the scheduled time |
| Input Data | Declares data to be supplied as input to the Flow (option will display only if selected Flow expects input) |
EDIT CALENDAR INFO Settings
This section contains the configuration settings for the selected Calendar setup when the Schedule job was created. This section will vary based on which Calendar selection was made. This example has the TimeSpan Schedule configuration settings displayed.
The different Calendar selections are:
- Daily Schedule
- First Day of Month Schedule
- Last Day of Month Schedule
- Monthly Schedule
- Specified Job Schedule
- Time Span Schedule
- Weekly Schedule
- Yearly Schedule
ADVANCED
Under the advanced category, there will be a text box that allows users to override the name of the queue.
Was this article helpful?
