API di piattaforma > Servizi Core > Jamio Schedule

Service

Method

CronScheduleProcess

Description

Schedules process invocations through a Cron expression.

Input
Name	Description	Type	Optional
serverAddress	Server address for an external Domain (or "" for the current Domain)	String	Y
token	The session token (for the current session in the current Domain may be null or empty)	String	Y
tenantId	The tenant id (if null or empty, the tenant id of the current session is used)	String	Y
name	The schedule name	String	Y
startTime	Optional scheduling start time	DateTime	Y
cronExpression	Cron expression string (required)	String
endTime	Optional scheduling end time	DateTime	Y
processModelReference	The process model reference (required)	Reference
inputs	Optional process inputs	Dataset	Y
linkedResource	Optional resource reference	Reference	Y
Output
Name	Description	Type	Optional
returnValue	The schedule registration identifier	String

Remarks

When scheduled process is started, if the execution of the process is not allowed (for example because the maximum number of process instances has been exceeded) the process is queued until the situation that causes the block is resolved and then subsequently rerun. In this scenario, the scheduled process will start at different times than the scheduled ones.

Cron expressions are comprised of 5 required fields and one optional field separated by white space.

The fields respectively are described as follows:

Minutes: 0-59, special characters: , - * /

Hours: 0-23, special characters: , - * /

Day of month: 1-31, special characters: , - * ? / L W

Month: 1-12 or JAN-DEC, special characters: , - * ? /

Day of week: 1-7 or SUN-SAT, special characters: , - * ? / L #

Year (optional): 1970-2199, special characters: , - * ? /

The '*' character is used to specify all values. For example, "*" in the minute field means "every minute".

The '?' character is allowed for the day-of-month and day-of-week fields.It is used to specify 'no specific value'.

This is useful when you need to specify something in one of the two fields, but not the other.

The '-' character is used to specify ranges.

For example "10-12" in the hour field means "the hours 10, 11 and 12".

The ',' character is used to specify additional values.

For example "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday".

The '/' character is used to specify increments.

For example "0/15" in the minutes field means "the minutes 0, 15, 30, and 45". And "5/15" in the minutes field means "the minutes 5, 20, 35, and 50". Specifying '*' before the '/' is equivalent to specifying 0 is the value to start with. Essentially, for each field in the expression, there is a set of numbers that can be turned on or off. For minutes the numbers range from 0 to 59. For hours 0 to 23, for days of the month 0 to 31, and for months 1 to 12. The "/" character simply helps you turn on every "nth" value in the given set. Thus "7/6" in the month field only turns on month "7", it does NOT mean every 6th month, please note that subtlety.

The 'L' character is allowed for the day-of-month and day-of-week fields. This character is short-hand for "last", but it has different meaning in each of the two fields.

For example, the value "L" in the day-of-month field means "the last day of the month" - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month"; for example "6L" means "the last friday of the month". You can also specify an offset from the last day of the month, such as "L-3" which would mean the third-to-last day of the calendar month. When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing/unexpected results.

The 'W' character is allowed for the day-of-month field.This character is used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th.If the 15th is a Sunday, the trigger will fire on Monday the 16th.If the 15th is a Tuesday, then it will fire on Tuesday the 15th.However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days.

The 'L' and 'W' characters can also be combined for the day-of-month expression to yield 'LW', which translates to "last weekday of the month".

The '#' character is allowed for the day-of-week field. This character is used to specify "the nth" XXX day of the month.

For example, the value of "6#3" in the day-of-week field means the third Friday of the month (day 6 = Friday and "#3" = the 3rd one in the month). Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month. Note that if you specify "#5" and there is not 5 of the given day-of-week in the month, then no firing will occur that month. If the '#' character is used, there can only be one expression in the day-of-week field ("3#1,6#3" is not valid, since there are two expressions). The legal characters and the names of months and days of the week are not case sensitive.

Notes:

- Support for specifying both a day-of-week and a day-of-month value is not complete (you'll need to use the '?' character in one of these fields).

- Overflowing ranges is supported - that is, having a larger number on the left hand side than the right. You might do 22-2 to catch 10 o'clock at night until 2 o'clock in the morning, or you might have NOV-FEB. It is very important to note that overuse of overflowing ranges creates ranges that don't make sense and no effort has been made to determine which interpretation CronExpression chooses. An example would be "0 0 14-6 ? * FRI-MON".

Examples:

"0 0 12 * * ?": at 12:00 PM (noon) every day

"0 * 14 * * ?": every minute starting at 2:00 PM and ending at 2:59 PM, every day

"0 15 10 ? * MON-FRI": at 10:15 AM every Monday, Tuesday, Wednesday, Thursday and Friday

"0 10,44 14 ? 3 WED": at 2:10 PM and at 2:44 PM every Wednesday in the month of March

"0 0/5 14,18 * * ?": every 5 minutes starting at 2:00 PM and ending at 2:55 PM, AND every 5 minutes starting at 6:00 PM and ending at 6:55 PM, every day

"0 15 10 ? * 6#3": at 10:15 AM on the third Friday of every month

"0 15 10 ? * 6L 2002-2005": at 10:15 AM on every last friday of every month during the years 2002, 2003, 2004, and 2005

A cron expression can be generated with an easy to use online interface.