Setting The Task Scheduler
The following table describes the fields on the Task Scheduler tab in the Business Central Server Administration Tool.
Task Scheduler processes tasks and other processes on a schedule. For more information about Task Scheduler, see Task Scheduler.
Settings | Key Name | Description |
Default Task Scheduler Session Timeout | DefaultTaskSchedulerSessionTimeout | Specifies a time-out for background sessions that are created by calls to the TaskScheduler.CreateTask method that do not set a time-out parameter. If the session exceeds the specified time, it is canceled. The value has the format hh:mm:ss. Default : 12:00:00 INTRODUCED IN: Release 18 |
Enable Task Scheduler | Enable Task Scheduler | Specifies whether the server instance starts with the task scheduler enabled. When enabled, the server instance processes scheduled tasks. Default: Enabled |
Run Retry Exceptions | TaskSchedulerExecutionRetryExceptions | Specifies a list of exceptions that will cause the task scheduler to retry the task if the exception occurs during the execution of the task's main code unit. The main unit of code is the unit of code that is started by calling the TaskScheduler.CreateTask method. The value is a semicolon-separated list in a format such as: Exception1; Exception 2; Exception 3. To specify an exception error code, use the following format instead: Exception1:ErrorCode1; Exception 2: Kód_chyby2. INTRODUCED IN: Version 19.0 |
Maximum number of concurrent running jobs | TaskSchedulerMaximumConcurrentRunningTasks | Specifies the maximum number of tasks that can run at the same time on a server instance. The value you specify will depend on the hardware (CPUs) of the deployment environment and what you want to prioritize: client performance or scheduled tasks (such as job queue entries). This setting is especially important when the server instance is used for both scheduled tasks and client services. If many tasks are running at the same time, client response times may slow down. In this case, you can decrease the value. However, if the value is too low, scheduled tasks may take longer than required to process. If you have a dedicated server instance for scheduled tasks, this setting is less important with respect to client performance. Default value: 10 |
System Job Start Time | TaskSchedulerSystemTaskStartTime | Specifies the time of day after which system tasks can run. The time is based on the time zone of the computer running the server instance. The value has the format hh:mm:ss. Default: 00:00:00 |
System Job End Time | TaskSchedulerSystemTaskEndTime | Specifies the time of day after which system tasks cannot run. The time is based on the time zone of the computer running the server instance. The value has the format hh:mm:ss. Default: 23:59:59 |
not available | MaxTaskSchedulerSessionTimeout | Specifies the maximum amount of time that scheduled tasks can run before they are canceled. If a scheduled task is created with a timeout that is greater than the setting, an error similar to the following error is returned, and the job is not created: A scheduled task cannot be created because the N timeout exceeds the maximum timeout value. The value has the format hh:mm:ss. Default: 48:00:00 INTRODUCED IN: Version 22MaxTaskSchedulerSessionTimeout |