| | |
| Property name | Type used | Effect |
|---|
| Enabled | Boolean | Indicates whether the task is enabled or not: - True if the task scheduling is enabled.
- False otherwise.
|
| InProgress | Boolean | Indicates whether the task is currently run: - True if the task is currently run.
- False otherwise.
This property is available in read-only. |
| Hour | Character string | Execution time of scheduled task. If the Property Time UTC is to True, this Time is in UTC (Universal Time) format. 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.
|
| TimeUTC | Boolean | - True (value per Default) if the Time is expressed in Time UTC, i.e. in universal time (properties Time 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 property 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 property 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 odd 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. If the Property Time UTC is to True, this Time is in UTC (Universal Time) format. 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 odd month.
|
| Password | Character string | User password. |
| Name | Character string | Task name. This name is used to differentiate the tasks associated with the same procedure. If this property is not filled, the name of the task will correspond to the full name of the procedure (for example: MySet.ProcedureName). |
| ProcedureName | Character string | Name of procedure to run. This property is read-only and it is used to retrieve the name of the procedure associated with the task (to display it in a specific screen for example). |
| Parameter | Array | Parameters that will be transmitted to the scheduled task during its execution. Each one of the parameters must be able to be transformed by Serialize (the serialization used is a binary serialization). |
| Procedure | Procedure name | Procedure that will be run by the scheduled task. This name has the following format:- for a procedure found in a set of procedures: <Name of set of procedures>.<Procedure name>.
- for a procedure found in a component: <Component name>.<Name of set of procedures>.<Procedure name>.
This property does not accept: - The local procedures. A local procedure only exists in the context of the call to its parent procedure. This context will not exist anymore during the call to the scheduled task.
- A Procedure variable (except if this one identifies a procedure belonging to a set of procedures).
|
| User | Character string | Indicates the user of the operating system who will run the task. If this value is not filled, the user that will be used is the default user of the application (site or webservice). |