Timer

note

Modifying this entity requires certain user authorization. For more information, see User Groups.

A Timer creates one or more Events of a specified Event type at either a specified time of day (on weekday(s) and/or day(s) of month) or after a specified time interval.

Timer-related information, for example when a Timer will be triggered next, can be viewed in the System monitor.

note

Modifying the settings of a Timer requires a Server restart for the changes to take effect.

Properties

Name	Type	Description
Active	Boolean	Specifies whether the Timer is active or not.
Created	DateTime	Date and time when the Timer was created. Automatically generated by the system.
Description	String	A brief description of the purpose of the Timer.
Entity type	EntityType	Specifies the entity type. The property is Read-only and is only displayed in filter listings to identify the entity type. It can be used for example when filtering on entities with a filter containing an 'All' part. For more information, see Entity filters.
ID	Guid	The entity ID of the Timer. Automatically generated by the system.
IsUTC	Boolean	Specifies whether the Timer uses UTC (true) or iCore system time zone (false). Default: True. For more information, see Working with dates and times.
Last fired	Nullable<DateTime>	The last date and time that the Timer was activated. Automatically generated by the system.
Modified	DateTime	Date and time of the latest modification of the Timer. Automatically generated by the system.
Name	String	Name of the Timer.
Valid days of month	IEnumerable<Int32>	The days of month that the Timer is active.
Valid days of week	IEnumerable<DayOfWeek>	The weekdays that the Timer is active.
Valid from	TimeSpan	The time of the day when the Timer is to be activated. If property IsUTC is checked, the date format will include the suffix "Z" (i.e. HH:MMZ) to indicate that the Timer is valid in UTC.
Valid to	TimeSpan	The time of the day when the Timer is to be deactivated. If property IsUTC is checked, the date format will include the suffix "Z" (i.e. HH:MMZ) to indicate that the Timer is valid in UTC.
When	TimerInterval	The Timer may be set to go off with a certain interval or at a fixed time. Every Specifies that the Timer is to fall out with a certain interval. Type an interval number and select a time unit. (Second, Minute or Hour). At Specifies that the Timer is to fall out at a fixed time. Type the time in format HH:MM. If property IsUTC is checked, the date format will include the suffix "Z" (i.e. HH:MMZ) to indicate that the Timer is valid in UTC. For example, if the Timer is set to expire every hour, the first occasion will be one hour after the system has started. It will not expire immediately at start-up.

The lower pane of the Timers section contains Timer events:

	Name	Type	Description
	Event parameters	String	The Event parameters to be attached to the generated Event.
	Event type	IEventType	The type of Event to be generated. See also Event type.
	Modified	DateTime	Date and time of the latest modification of the Timer event.
	Priority	Byte	The priority to be assigned to the generated Event. See also Event.

Remarks

If a Timer is set to go off at a specific interval, for example every hour, it is possible to set interval for when the Timer is allowed to trigger. This is useful for recurring service windows like nightly backups or downtime of any resource needed for processing.

See Also

Working with dates and times

Entities

Event
Event type