Skip to content
Snippets Groups Projects
Commit d914b100 authored by Marco Del Tufo's avatar Marco Del Tufo
Browse files

Update maintenance-tasks.md

parent 02664e82
No related branches found
No related tags found
1 merge request!40SSDM-13578 : 2PT : Database and V3 Implementation - include the new AFS "free"...
......@@ -32,8 +32,8 @@ The following properties are common for all maintenance tasks:
|execute-only-once|A flag which has to be set to true if the task should be executed only once. Default value: false|
|interval|A time interval (in seconds) which defines the pace of execution of the maintenance task. Can be specified with one of the following time units: ms, msec, s, sec, m, min, h, hours, d, days. Default time unit is sec. Default value: one day.|
|start|A time at which the task should be executed the first time. Format: HH:mm. where HH is a two-digit hour (in 24h notation) and mm is a two-digit minute. By default the task is execute at server startup.|
|run-schedule|Scheduling plan for task execution. Properties execute-only-once, interval, and start will be ignored if specified.<br /><br />**Crontab syntax:** <br />`cron: <second> <minute> <hour> <day> <month> <weekday>`<br /><br />Examples:<br />`cron: 0 0 * * * *`: the top of every hour of every day.<br />`cron: */10 * * * * *`: every ten seconds.<br />`cron: 0 0 8-10 * * *`: 8, 9 and 10 o'clock of every day.<br />`cron: 0 0 6,19 * * *`: 6:00 AM and 7:00 PM every day.<br />`cron: 0 0/30 8-10 * * *`: 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day.<br />`cron: 0 0 9-17 * * MON-FRI`: on the hour nine-to-five weekdays.<br />`cron: 0 0 0 25 12 ?`: every Christmas Day at midnight.<br /><br />**Non-crontab syntax:** <br /><br />Comma-separated list of definitions with following syntax:<br /><br />`[[<counter>.]<week day>] [<month day>[.<month>]] <hour>[:<minute>]` <br /><br />where `<counter>` counts the specified week day of the month. `<week day>` is `MO`, `MON`, `TU`, `TUE`, `WE`, `WED`, `TH`, `THU`, `FR`, `FRI`, `SA`, `SAT`, `SU`, or `SUN` (ignoring case). `<month>` is either the month number (followed by an optionl '.') or `JAN`, `FEB`, `MAR`, `APR`, `MAY`, `JUN`, `JUL`, `AUG`, `SEP`, `OCT`, `NOV`, or `DEC` (ignoring case). <br /><br />Examples: <br /><br />`6, 18`: every day at 6 AM and 6 PM. <br /><br />`3.FR 22:15`: every third friday of a month at 22:15. <br /><br />`1. 15:50`: every first day of a month at 3:50 PM. <br /><br />`SAT 1:30`: every saturday at 1:30 AM. <br /><br />`1.Jan 5:15, 1.4. 5:15, 1.7 5:15, 1. OCT 5:15`: every first day of a quarter at 5:15 AM.|
|run-schedule-file|File where the timestamp for next execution is stored. It is used if run-schedule is specified. Default: `<installation folder>/<plugin name>_<class name>` |
|run-schedule|Scheduling plan for task execution. Properties execute-only-once, interval, and start will be ignored if specified.<br /><br />**Crontab syntax:** <br /><br />`cron: <second> <minute> <hour> <day> <month> <weekday>`<br /><br />Examples:<br /><br />`cron: 0 0 * * * *`: the top of every hour of every day.<br /><br />`cron: */10 * * * * *`: every ten seconds.<br /><br />`cron: 0 0 8-10 * * *`: 8, 9 and 10 o'clock of every day.<br /><br />`cron: 0 0 6,19 * * *`: 6:00 AM and 7:00 PM every day.<br /><br />`cron: 0 0/30 8-10 * * *`: 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day.<br /><br />`cron: 0 0 9-17 * * MON-FRI`: on the hour nine-to-five weekdays.<br /><br />`cron: 0 0 0 25 12 ?`: every Christmas Day at midnight.<br /><br />**Non-crontab syntax:** <br /><br />Comma-separated list of definitions with following syntax:<br /><br />`[[<counter>.]<week day>] [<month day>[.<month>]] <hour>[:<minute>]` <br /><br />where `<counter>` counts the specified week day of the month. `<week day>` is `MO`, `MON`, `TU`, `TUE`, `WE`, `WED`, `TH`, `THU`, `FR`, `FRI`, `SA`, `SAT`, `SU`, or `SUN` (ignoring case). `<month>` is either the month number (followed by an optionl '.') or `JAN`, `FEB`, `MAR`, `APR`, `MAY`, `JUN`, `JUL`, `AUG`, `SEP`, `OCT`, `NOV`, or `DEC` (ignoring case). <br /><br />Examples: <br /><br />`6, 18`: every day at 6 AM and 6 PM. <br /><br />`3.FR 22:15`: every third friday of a month at 22:15. <br /><br />`1. 15:50`: every first day of a month at 3:50 PM. <br /><br />`SAT 1:30`: every saturday at 1:30 AM. <br /><br />`1.Jan 5:15, 1.4. 5:15, 1.7 5:15, 1. OCT 5:15`: every first day of a quarter at 5:15 AM.|
|run-schedule-file|File where the timestamp for next execution is stored. It is used if run-schedule is specified. Default: <installation folder>/<plugin name>_<class name>|
|retry-intervals-after-failure|Optional comma-separated list of time intervals (format as for interval) after which a failed execution will be retried. Note, that a maintenance task will be execute always when the next scheduled timepoint occurs. This feature allows to execute a task much earlier in case of temporary errors (e.g. temporary unavailibity of another server).|
## Feature
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment