Wiki source code of Time Listener
Last modified by Rabie Chettahi on 2022/06/13 13:18
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | = Definition = | ||
| 6 | |||
| 7 | Time Listener or the cron is to define a specific time to start automatically a scenario. | ||
| 8 | |||
| 9 | = Icon = | ||
| 10 | |||
| 11 | [[image:2021-03-24 17_25_27-iXPath _ Scenario.png]] | ||
| 12 | |||
| 13 | |||
| 14 | = Cron Expression = | ||
| 15 | |||
| 16 | A cron expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows: | ||
| 17 | |||
| 18 | |=Field Name|=Mandatory|=Allowed Values|=Allowed Special Characters | ||
| 19 | |Seconds|YES|0-59|, - * / | ||
| 20 | |Minutes|YES|0-59|, - * / | ||
| 21 | |Hours|YES|0-23|, - * / | ||
| 22 | |Day of month|YES|1-31|, - * ? / L W | ||
| 23 | |Month|YES|1-12 or JAN-DEC|, - * / | ||
| 24 | |Day of week|YES|1-7 or SUN-SAT|, - * ? / L # | ||
| 25 | |Year|NO|empty, 1970-2099|, - * / | ||
| 26 | |||
| 27 | So cron expressions can be as simple as this: ##* * * * ? *## | ||
| 28 | |||
| 29 | or more complex, like this: ##0/5 14,18,3-39,52 * ? JAN,MAR,SEP MON-FRI 2002-2010## | ||
| 30 | |||
| 31 | = Special characters = | ||
| 32 | |||
| 33 | * ##*## (//“all values”//) - used to select all values within a field. For example, “*” in the minute field means //“every minute”//. | ||
| 34 | * ##**?**## (//“no specific value”//) - useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my trigger to fire on a particular day of the month (say, the 10th), but don’t care what day of the week that happens to be, I would put “10” in the day-of-month field, and “?” in the day-of-week field. See the examples below for clarification. | ||
| 35 | * ##**-**## - used to specify ranges. For example, “10-12” in the hour field means //“the hours 10, 11 and 12”//. | ||
| 36 | * ##**,**## - used to specify additional values. For example, “MON,WED,FRI” in the day-of-week field means //“the days Monday, Wednesday, and Friday”//. | ||
| 37 | * ##**/**## - used to specify increments. For example, “0/15” in the seconds field means //“the seconds 0, 15, 30, and 45”//. And “5/15” in the seconds field means //“the seconds 5, 20, 35, and 50”//. You can also specify ‘/’ after the ‘**’ character - in this case ‘**’ is equivalent to having ‘0’ before the ‘/’. ‘1/3’ in the day-of-month field means //“fire every 3 days starting on the first day of the month”//. | ||
| 38 | * ##**L**## (//“last”//) - has different meaning in each of the two fields in which it is allowed. 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.// | ||
| 39 | * ##**W**## (//“weekday”//) - 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. | ||
| 40 | |||
| 41 | >The 'L' and 'W' characters can also be combined in the day-of-month field to yield 'LW', which translates to *"last weekday of the month"*. | ||
| 42 | |||
| 43 | >The legal characters and the names of months and days of the week are not case sensitive. ##MON## is the same as ##mon##. | ||
| 44 | |||
| 45 | = Examples = | ||
| 46 | |||
| 47 | Here are some full examples: | ||
| 48 | |||
| 49 | |~*~*Expression~*~*|~*~*Meaning~*~* | ||
| 50 | |##0 0 12 * * ?##|Fire at 12pm (noon) every day | ||
| 51 | |##0 15 10 ? * *##|Fire at 10:15am every day | ||
| 52 | |##0 15 10 * * ?##|Fire at 10:15am every day | ||
| 53 | |##0 15 10 * * ? *##|Fire at 10:15am every day | ||
| 54 | |##0 15 10 * * ? 2005##|Fire at 10:15am every day during the year 2005 | ||
| 55 | |##0 * 14 * * ?##|Fire every minute starting at 2pm and ending at 2:59pm, every day | ||
| 56 | |##0 0/5 14 * * ?##|Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day | ||
| 57 | |##0 0/5 14,18 * * ?##|Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day | ||
| 58 | |##0 0-5 14 * * ?##|Fire every minute starting at 2pm and ending at 2:05pm, every day | ||
| 59 | |##0 10,44 14 ? 3 WED##|Fire at 2:10pm and at 2:44pm every Wednesday in the month of March. | ||
| 60 | |##0 15 10 ? * MON-FRI##|Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday | ||
| 61 | |##0 15 10 15 * ?##|Fire at 10:15am on the 15th day of every month | ||
| 62 | |##0 15 10 L * ?##|Fire at 10:15am on the last day of every month | ||
| 63 | |##0 15 10 L-2 * ?##|Fire at 10:15am on the 2nd-to-last last day of every month | ||
| 64 | |##0 15 10 ? * 6L##|Fire at 10:15am on the last Friday of every month | ||
| 65 | |##0 15 10 ? * 6L##|Fire at 10:15am on the last Friday of every month | ||
| 66 | |##0 15 10 ? * 6L 2002-2005##|Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005 | ||
| 67 | |##0 15 10 ? * 6#3##|Fire at 10:15am on the third Friday of every month | ||
| 68 | |##0 0 12 1/5 * ?##|Fire at 12pm (noon) every 5 days every month, starting on the first day of the month. | ||
| 69 | |##0 11 11 11 11 ?##|Fire every November 11th at 11:11am. | ||
| 70 | |||
| 71 | (% class="wikigeneratedid" id="Hsource:A0http:2F2Fwww.quartz-scheduler.org2Fdocumentation2Fquartz-2.3.02Ftutorials2Fcrontrigger.html" %) | ||
| 72 | source : [[http:~~/~~/www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html>>http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html]] | ||
| 73 | |||
| 74 | = Configuration = | ||
| 75 | |||
| 76 | == 1-Time Listener configuration == | ||
| 77 | |||
| 78 | |||
| 79 | [[image:2021-03-24 17_42_09-iXPath _ Scenario.png]] | ||
| 80 | |||
| 81 |