Sign in

Schedule formats

  • Updated

VersaLex displays scheduling information in a proprietary format. The REST API uses the same format for the schedule attribute. This section is intended to help you understand what is displayed in the Scheduler UI and to help you use schedule data in an API.

Schedules and their formats are based on either date and time or the occurrence or an event.
Note: Schedule formats are case insensitive, except for timezone.

Date/time-based schedule format

Data for date/time-based schedules use a single general format with variations for one-time, weekly, and monthly schedules.

[on file polling][for timezone] schedule
on file polling
Runs schedule when there are files available to send or check.
This parameter is not valid if the action type being scheduled is JavaScript.
for timezone
Indicates the timezone to be considered when the schedule is evaluated for execution by the server.
timezone is expressed in the format used in the tz database, Area/Location. For example: America/Chicago or Asia/Tokyo. If no timezone is specified as part of a schedule string, this value defaults to the timezone in which the server is located.
schedule
A schedule consists of series of parameters (described below) that indicate when an action should be executed.
You can create the following types of schedules:

One-time schedule

 

on date @time

Parameters

date
Expressed in yyyy/mm/dd format and must be in the future. A date specified is affected by the timezone in question.
time
Expressed using a 24-hour clock format, HH:mm[:ss] (where seconds are optional) and must be in the future. The time you specify is affected by the timezone in question. For example, a user is in Chicago (CST) at 10:00 on 12/18/2020 and tries to make a schedule for America/New_York on 12/18/2020 @10:30. This will not work because the time specified is already in the past.

Examples

for America/Chicago on 2018/08/01 @08:00
Schedule set to run on August 1, 2018 in the America/Chicago timezone at 0800 hours.
on 2018/09/10 @14:30:30
Schedule set to run September 10, 2018 in the timezone in which the server is located at 1430 hours and 30 seconds.

Weekly schedule

This is the format the product uses to display weekly schedule information. You can also use this format to programmatically schedule actions continuously.

on day1[day2][day3-day4] @start-time[[/interval]-stop-time][,start-time[[/interval]-stop-time]] [+on day5[day6-day7] @start-time[[/interval]-stop-time]][,start-time[[/interval]-stop-time]]

Alternatively, you can use the following syntax to schedule actions to run continuously:

continuously

Parameters

day
Specifies a day or days of the week on which you want the action to be executed.
When specifying a weekly schedule, days are expressed as two-letter abbreviations that represent the day of the week. For example, Su for Sunday, Mo for Monday, Tu for Tuesday, and so on. You can specify a range of days of the week by delimiting the start and end days in the range using a hyphen (-).
Day ranges must be distinct and cannot overlap.
start-time
interval
stop-time
Indicates the time (or time range) of day an action should be executed.
start-time is the beginning of the range.
interval is how often the action is executed.
stop-time is the end of the range.
All three are expressed in HH:mm[:ss] format, where seconds are optional.
You cannot specify duplicate or overlapping times. For example, on We @00:00-01:00,00:30 is not allowed.
continuously
Runs the action continuously. This is a shortcut for and equivalent to specifying Su-Sa @00:00-24:00.
Note: Continuous scheduling is actually semi-continuous. The minimum period of processing continuous operations is governed by the Options > Other > Autosend Check Every setting. The default value is 5 seconds. See Other system options.
Note: Scheduling an action to run continuously could impact your system performance. It is recommended that you schedule actions to run at a longer frequency than the default, for example, 30 seconds.
on file polling continuously
Run the action only when there are files available to send or check. This is a shortcut for and equivalent to specifying on file polling Su-Sa @00:00-24:00.
Note: Continuous scheduling is actually semi-continuous. The minimum period of processing continuous operations is governed by the Options > Other > Autosend Check Every setting. The default value is 5 seconds.

Examples of weekly schedules

on file polling for Asia/Tokyo Mo @17:00
Sets the schedule to run on Mondays at 1700 hrs in the timezone for Tokyo, only when files are available to send/check.
on file polling Mo-Fr @17:00
Sets the schedule to run on Monday through Friday at 1700 hrs in the timezone in which the server resides, only when files are available to send/check.
on MoWe-Fr @17:00
Sets the schedule to run on Monday and Wednesday through Friday at 1700 hrs.
on Mo-Fr @00:00-24:00
Sets the schedule to run on Monday through Friday, running continuously.
on Su-Sa @09:00/00:02:30-17:00
Sets the schedule to run on Sunday through Saturday from 0900 to 1700 hrs, running every 2 minutes and 30 seconds.
on Su-Sa @09:00/00:02:30-17:00,18:00/00:00:30-22:00
Sets the schedule to run on Sunday through Saturday from 0900 to 1700 hrs, running every 2 minutes and 30 seconds, and from 1800 to 2200, running every 30 seconds.
on Mo-We @09:00/01:00-12:00+on Th-Sa @13:00/01:00-17:00
Sets the schedule to run on Monday through Wednesday between 0900 hrs and 1200 hrs with a recurrence interval of 1 hr and Thursday through Saturday between 1300 hrs and 1700 hrs with a recurrence interval of 1 hr.
continuously
Sets the schedule to run on Sunday through Saturday, running continuously.
on file polling continuously
Sets the schedule to run on Sunday through Saturday, running continuously, only when files are available to send/check.

Monthly schedule

This is the format the product uses to display monthly schedule information.

in m1[m2][m3-m4] on day d1[,d2][,d3-d4] @start-time[[/interval]-stop-time][,start-time[[/interval]-stop-time]][+in m5[m6][m7-m8] on day d6[,d7][,d8-d9] @start-time[[/interval]-stop-time][,start-time[[/interval]-stop-time]]

Parameters

m
A month in which the action should be executed.
You can specify any number on months individually or you can specify a range of months.
d
Specifies a day of the month on which you want the action to be executed.
When specifying a monthly schedule, days are expressed as numerical values that represent the day of the month. You can specify a range of days of the month by delimiting the start and end days in the range using a hyphen (-).
Day ranges must be distinct and cannot overlap.
Note: You can also specify days as first Monday, second Tuesday, every Thursday, and so on, rather a specific day of the month. See One-time schedule for more information.
start-time
interval
stop-time
Indicates the time (or time range) of day an action should be executed.
start-time is the beginning range.
interval is how often the action is executed.
stop-time is the end of the range.
All three are expressed in HH:mm[:ss] format, where seconds are optional.
You cannot specify duplicate or overlapping times. For example, on We @00:00-01:00,00:30 is not allowed.

Examples of monthly schedules

in JanFebJul-Sep on day 1,8-15 @08:00
Sets the schedule to run in Jan, Feb, and Jul through Sep on 1st and 8th through 15th days at 0800 hrs.
on file polling in JanFebJul-Sep on day 1,8-15 @08:00+in Oct-Dec on day 1,8-15 @08:00
Sets the schedule to run only when files are available in Jan, Feb, and from Jul through Sep on the1st, the 8th through 15th days at 0800 hrs and from Oct through Dec on the 1st and the 8th through 15th at 0800 hrs.
in JanFebJul-Sep on day 1,8-15 @09:00/01:00-17:00
Sets the schedule to run in Jan, Feb, and Jul through Sep on 1st and 8th through 15th days between 0900 hrs and 1700 hrs recurring every hour.
in JanFebJul-Sep every day @08:00
Sets the schedule to run in Jan, Feb, and Jul through Sep every day at 0800 hrs.
in JanFebJul-Sep every monday @08:00
Sets the schedule to run in Jan, Feb, and Jul through Sep every Monday at 0800 hrs.
in JanFebJul-Sep on the first day @08:00

Sets the schedule to run in Jan, Feb, and Jul through Sep on the 1st day at 0800 hrs.

in JanFebJul-Sep on the last friday @08:00
Sets the schedule to run in Jan, Feb, and Jul through Sep on the last Friday at 0800 hrs.

Continuous schedule 

You can set a schedule to run continuously by specifying that it should run Sunday through Saturday without specifying an interval.

This schedules the action to run as often as is allowed by the Autosend Check Every setting, whose default value is 5 seconds. See Other system options.

Note: Scheduling an action to run continuously could impact your system performance. It is recommended to schedule actions to run at a longer frequency than the default, for example, 30 seconds.

Event-based schedule format

Event-based schedules use a single format.

[on new file arrives [success|failure]] [,on user session ends [success|failure]]

Parameters

new file arrives [success | failure]
Runs schedule when a new file arrives.
Specify success or failure to add a dependency on whether the file arrives successfully or unsuccessfully, respectively.
If you do not specify success or failure, the schedule runs whether the file arrives successfully or not.
You can combine this parameter with the user session ends parameter in any order.
user session ends [success | failure]
Runs schedule when the user's session ends.
Specify success or failure to add a dependency on whether the session ends successfully or unsuccessfully, respectively.
If you do not specify success or failure, the schedule runs whether the session ends successfully or not.
You can combine this parameter with the new file arrives parameter in any order.
Valid only for JavaScript actions.

Examples

on new file arrives success
Runs the action when a new file arrives successfully.
on user session ends failure
Runs the action when the user session ends unsuccessfully.
on user session ends failure,on new file arrives
Runs the schedule when the user session ends unsuccessfully or when a new file arrives (whether successfully or not).

Related articles

Comments

0 comments

Please sign in to leave a comment.