| | |
| Property name | Type used | Effect |
|---|
 Versions 20 and laterEnabled  New in version 20Enabled | Boolean | - True if the task scheduling is enabled,
- False otherwise.
|
Versions 23 and laterAtStart New in version 23AtStart AtStart | Integer constant | Indicates whether the task must be done when starting the HFSQL server as well as its execution mode: - hBlocking: The task is locking. The HFSQL server will not be accessible during the task execution.
- hBackgroundTask: The task is not locking. The HFSQL server will be accessible during the task execution. The task is run in background task.
- No: The task must not be run when starting the server (default value).
|
| Description (*) | Character string | Description associated with the scheduled task. The description of scheduled task corresponds to an empty string by default.
This property is optional. |
| Hour | Character string | Execution time of the scheduled task in UTC format (universal time). Execution time of scheduled task. If ..TimeUTC is set to True, this time is in UTC format (universal time). The possible values are: - a digit included between 0 and 23.
- a list of numbers separated by commas: used to specify several hours.
- an interval. For example, "9-13".
- a star ("*") to specify the entire range.
- an interval with a step, "*/2" for example to perform the task at every even hour.
|
Versions 19 and laterTimeUTC New in version 19TimeUTC TimeUTC | Boolean | - True (default value) if the time is expressed in UTC time, which means in universal time (..Hour and ..Minute),
- False otherwise.
|
| DayOfWeek | Character string | Number of the day for which the scheduled task must be run ("2" for example). This number is included between 1 and 7 (1 = Monday, 2 = Tuesday, ...).
This parameter can also correspond to:- a list of numbers separated by commas: used to specify several days.
- an interval. For example, "1-3" (the task is scheduled for Monday, Tuesday and Wednesday).
- a star ("*") to specify the entire range.
- an interval with a step, "*/2" for example to perform the task on every even day of the week.
- the day of the week in letters ("monday", "tuesday", "wednesday", "thursday", "friday").
|
| DayOfMonth | Character string | Number of the day for which the scheduled task must be run ("31" for example). This number is included between 0 and 31.
This parameter can also correspond to:- a list of numbers separated by commas: used to specify several months.
- an interval. For example, "9-13" (the task is scheduled from the 9th to the 13th of the month).
- a star ("*") to specify the entire range.
- an interval with a step, "*/2" for example to perform the task on every even day of the month.
|
| DayOfMonthOrDayOfWeek | Boolean | Used to manage the execution of a scheduled task by specifying the number of the day in the week or the number of the day in the month. Example: execution every Monday 1st day of month.
This property can correspond to:- True to run the scheduled task every Monday AND the first day of the month (cumulated conditions).
- False to run the task on Monday 1st (exclusive conditions).
|
| Minute | Character string | Minutes of the execution time of the scheduled task in UTC format (universal time). Minutes of the execution time of the scheduled task. If ..TimeUTC is set to True, this time is in UTC format (universal time). The possible values are: - a digit included between 0 and 59.
- a list of numbers separated by commas: used to specify several minutes.
- an interval. For example, "9-13".
- a star ("*") to specify the entire range.
- an interval with a step, "*/2" for example to perform the task at every even minute.
|
| Month | Character string | Number of the execution month of scheduled task ("11" for example). The possible values are:- a digit included between 1 and 12.
- a list of numbers separated by commas: used to specify several months.
- an interval. For example, "9-11".
- a star ("*") to specify the entire range.
- an interval with a step, "*/2" for example to perform the task on every even month.
|
| NumberExecution | Integer | Number of times the task must be run. This property can also correspond to the Infinite constant. |
| Parameter | Array | Parameters of the stored procedure that will be run by the scheduled task. See "How to handle the parameters passed to the stored procedure?" for more details. |
| Procedure | Character string | Name of the stored procedure that will be run by the scheduled task.
This property has the following format: <Database Name>:<Name of Set of Procedures>.<Name of Stored Procedure>.
To perform a backup, this property must correspond to "HBackup". |
Versions 20 and laterUser New in version 20User User | Character string | User who created the scheduled task.
This property is read-only. |
The properties followed by a star (*) are optional.