|
||
Task display name |
Sets a name for the task that is shown in the administration interface. |
Task name |
Sets a unique name that serves as an identifier for the scheduled task, for example in the API. You can leave the (automatic) option to have the system generate an appropriate code name based on the display name. |
Task assembly name |
Specifies the name of the assembly where the task is implemented. |
Task class name |
Specifies the exact class (including any namespaces) that defines the functionality of the scheduled task. |
Task interval |
Sets the time interval between two executions of the task.
This does not ensure that the task will be executed at the exact time, only that it will be considered ready for execution. The precise execution time depends on the general settings of the scheduler. |
Task data |
Additional data provided to the task's class. This field can be accessed from the code of the task, so you may use as a parameter to easily modify the task without having to edit its implementation. |
Task condition |
Allows you to enter an additional macro condition that must be fulfilled in order for the scheduler to execute the task.
You can write any condition according to your specific requirements. For details about available macro options and syntax, refer to the Development -> Macro expressions chapter.
Clicking on the edit icon () opens the Macro condition editor, which allows you to build conditions through a graphical interface. The Clear condition () action removes the current content of the condition field. |
Task enabled |
This field must be enabled in order for the task to be scheduled. |
Delete task after last run |
Indicates if the system should delete the task after its final run (applicable if the task is set to run only once). |
Run task in separate thread |
Indicates if the scheduler should execute the task in a separate thread to improve application performance.
You cannot access context data (information about the current page, user, etc.) in the code of tasks that are executed in a separate thread. |
Use external service |
If enabled, the task is processed by the Scheduler Windows service instead of the web application. If the Use external service setting in Site Manager -> Settings -> System is disabled, even tasks with this option enabled are processed by the application itself. Only some of the default scheduled tasks support this option. The ones that do not have it available in their editing interfaces must be processed by the application itself.
You cannot define the task in the App_Code folder if you wish to use the external service. To run a custom task externally, you must add a new assembly to your project and then define the task class there. |
Run individually for each site |
This option is only available for global tasks. If enabled, the scheduler executes the task repeatedly as a site‑specific task, once for each running site in the system. The task automatically runs within the context of the corresponding site.
This can be useful if you wish to manage a task in a single location instead of creating a separate one for every site. |
Server name |
Sets the name of the web farm server where the task is executed. This field is applicable only if your application is running in a Web farm environment.
To add a new task for all web farm servers currently registered in the system, check the Create tasks for all web farm servers box below the field. |
Use context of user |
If the scheduled task needs to access data from the user context in its code (e.g. to check permissions), you can use this property to choose which user is provided. The scheduler always executes the task within the context of the selected user.
In most cases, the user context does not affect the functionality of the task, and you can leave the (default) option — the context of a public user is used. |
Executions |
Shows how many times the task has been executed. You can reset this counter back to 0 by clicking Reset. |
Additional resource:
•Developer's Guide -> Development -> Scheduler -> Overview
•Developer's Guide -> Development -> Scheduler -> Scheduling custom code