SchedulingHelper Class

Global class providing Scheduler methods.

Inheritance Hierarchy

System.Object
  CMS.Scheduler.SchedulingHelper

Namespace: CMS.Scheduler
Assembly: CMS.Scheduler (in CMS.Scheduler.dll) Version: 12.0.0

Syntax

public static class SchedulingHelper

The SchedulingHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	mLogFile	Logs file path.
Public field Static member	MONTHS_FIRST	First day of the month.
Public field Static member	MONTHS_FOURTH	Fourth day of the month.
Public field Static member	MONTHS_LAST	Last day of the month.
Public field Static member	MONTHS_SECOND	Second day of the month.
Public field Static member	MONTHS_THIRD	Third day of the month.
Public field Static member	PERIOD_DAY	Day period.
Public field Static member	PERIOD_HOUR	Hour period.
Public field Static member	PERIOD_MINUTE	Minute period.
Public field Static member	PERIOD_MONTH	Month period.
Public field Static member	PERIOD_ONCE	Once period.
Public field Static member	PERIOD_SECOND	Second period.
Public field Static member	PERIOD_WEEK	Week period.
Public field Static member	PERIOD_YEAR	Year period.

Properties

	Name	Description
Public property Static member	EnableScheduler	If true (default value), running of scheduler is enabled.
Public property Static member	LogFile	Logs file.
Public property Static member	LogTasks	If true, executed tasks are logged into file.
Public property Static member	RunSchedulerWithinRequest	If true, the scheduler tasks are executed within the standard requests (at the end of requests). The default settings is true (scheduler is executed within the request).
Public property Static member	ServiceInterval	Gets windows service interval (in seconds).
Public property Static member	UseAutomaticScheduler	If true, the automatic version of scheduler is used (standalone thread and scheduler handler). The default settings is false (scheduler is executed by the activity of the requests).
Public property Static member	UseExternalService	Indicates if the windows service should be used.

Methods

	Name	Description
Public method Static member	ApplicationInterval	Gets application scheduler interval.
Public method Static member	Clear	Clears the enabled status of the scheduler so it can reload
Public method Static member	DecodeInterval	Decodes interval string from database.
Public method Static member	EncodeInterval	Encodes interval for save it to database.
Public method Static member	GetFirstRunTime	Returns date and time when the very first scheduling moment occurs based on the current date and time and the scheduling pattern.
Public method Static member	GetNextTime	Returns date and time when the next scheduling moment occurs based on the current date and time and the scheduling pattern.
Public method Static member	IsAnyTaskRunning	Returns true if there are any currently running tasks.
Public method Static member	IsExternalTaskTooLate	Returns true if externally handled task did not execute for more than certain amount of times.
Public method Static member	LogTask	Logs task.
Public method Static member	RunEndRequestScheduler	Attempts to run the scheduler request based on scheduler configuration.
Public method Static member	RunSchedulerRequest	Runs the request to the scheduler page.