diff --git a/docs/system-admin-documentation/advanced-features/maintenance-tasks.md b/docs/system-admin-documentation/advanced-features/maintenance-tasks.md index 2d75c1320e178c56461e703dc85da50ae0b64d68..8eed453ee0defc2e246331b73c7f475a16c3adaf 100644 --- a/docs/system-admin-documentation/advanced-features/maintenance-tasks.md +++ b/docs/system-admin-documentation/advanced-features/maintenance-tasks.md @@ -26,35 +26,15 @@ DSS but not in both environments. The following properties are common for all maintenance tasks: -| Property Key | Description | -|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| class | The fully-qualified Java class name of the maintenance task. The class has to implement IMaintenanceTask. | -| 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. -Crontab syntax: -cron: <second> <minute> <hour> <day> <month> <weekday> -Examples: -cron: 0 0 * * * *: the top of every hour of every day. -cron: */10 * * * * *: every ten seconds. -cron: 0 0 8-10 * * *: 8, 9 and 10 o'clock of every day. -cron: 0 0 6,19 * * *: 6:00 AM and 7:00 PM every day. -cron: 0 0/30 8-10 * * *: 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day. -cron: 0 0 9-17 * * MON-FRI: on the hour nine-to-five weekdays. -cron: 0 0 0 25 12 ?: every Christmas Day at midnight. -Non-crontab syntax: -Comma-separated list of definitions with following syntax: -[[<counter>.]<week day>] [<month day>[.<month>]] <hour>[:<minute>] -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). -Examples: -6, 18: every day at 6 AM and 6 PM. -3.FR 22:15: every third friday of a month at 22:15. -1. 15:50: every first day of a month at 3:50 PM. -SAT 1:30: every saturday at 1:30 AM. -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). | +|Property Key|Description| +|--- |--- | +|class|The fully-qualified Java class name of the maintenance task. The class has to implement IMaintenanceTask.| +|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.Crontab syntax: `cron: <second> <minute> <hour> <day> <month> <weekday>` Examples:cron: 0 0 * * * *: the top of every hour of every day.cron: */10 * * * * *: every ten seconds.cron: 0 0 8-10 * * *: 8, 9 and 10 o'clock of every day.cron: 0 0 6,19 * * *: 6:00 AM and 7:00 PM every day.cron: 0 0/30 8-10 * * *: 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day.cron: 0 0 9-17 * * MON-FRI: on the hour nine-to-five weekdays.cron: 0 0 0 25 12 ?: every Christmas Day at midnight.Non-crontab syntax:Comma-separated list of definitions with following syntax:[[<counter>.]<week day>] [<month day>[.<month>]] <hour>[:<minute>]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).Examples:6, 18: every day at 6 AM and 6 PM.3.FR 22:15: every third friday of a month at 22:15.1. 15:50: every first day of a month at 3:50 PM.SAT 1:30: every saturday at 1:30 AM.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