Timers#
Administration.Timer
A Timer is an object in the MES system that will trigger the execution of a Rule after a certain predefined amount of time has elapsed.
A Timer is identified by a unique name and is defined by a specific recurrence and contains two Rules:
- A Rule that will be executed when the recurrence time is reached.
- An error Rule that will be run if the original Rule fails.
Additional information can be viewed in each Timer page, including:
- Start date
- Number of times the Timer has been executed
- Expire Date
- Recurrence information
- Type
- Frequency
Browsing existing Timers#
The default page in the Administration menu page group lists all the available Timers. By selecting a Timer, you will open the Timer details.
System Timers#
| Table | Description | Scope |
|---|---|---|
| AutomaticClockOutCheckOut | This time will be run to automatically checkout and clockout employees. | General |
| ClearNotifications | This timer will run automatic clear notifications. | General |
| PurgeAttachmentsTemporaryFileShareTimer | This timer will be run to periodically purge the outdated files from the attachments temporary folder. | General |
| RemindTasks | This timer will run remind tasks. | General |
| RetryIntegrationEntry | This timer will be run to send Integration Entries to the processing queue again. | Integration Entry |
| SapConnectionMonitor | This timer will be run to verify SAP connection status. | Integration Entry |
| SynchronizeDataPlatformConsumers | This timer will be run to periodically check if the configurations of DataPlatform consumers on the Frameworks are updated. | General |
| SynchronizeEmployeeQualificationsAndCertifications | This timer will run to synchronize qualifications and certifications. | General |
| SynchronizePlanTimeFrames | This timer will run automatic plan synchronization. | General |
| TemporaryFolderMonitorTimer | This timer will be run to periodically purge the temporary folder. | Geneal |
| TerminateAutomationJobsInErrorTimer | This timer will be run to periodically terminate AutomationJobs that are left in error state for more than the configured amount of time. | General |
Creating a Timer#
CmfTimer.Create
To create a new Timer, select Create on the top ribbon, and then follow the wizard as described below.
Step 1 - General data#
- Provide a name for the Timer.
- Optionally, provide a description of the Timer.
- Select whether the Timer is enabled or disabled.
-
Select a scope for the Timer. Scope can be one of the following:
- General
- Integration Entry
- Maintenance Management
- Order Management
- Time Constraints
-
Select a Start date after which the Timer will be active.
- Select the Rule that will run after the recurrence period is elapsed.
- Select the number of times the Timer will be able to run.
-
Select the mode the Timer will follow upon terminating the execution of the Rule. Available options are:
- Always - Timer execution is terminated every time it is executed regardless of the outcome of the Rule.
- None - Timer will keep running even after the completion of the Rule.
- On Success - Timer will only stop executing if the Rule is executed successfully.
-
Optionally, select a date for the Timer to expire and no longer be enabled.
-
Choose the type of recurrence to apply to the Timer, along with the value for the Recurrence Frequency. The Recurrence can be:
- Daily
- Defined Seconds - Recurrence Seconds must also be defined if this option is set.
- Monthly
- One Time - Recurrence Frequency not available for this option.
- Weekly
- Yearly
-
Optionally, define a Rule to be executed in case of an error. If desired, a distribution list can be configured to receive an email notification of the error.
- Select Create to complete the operation.
Info
If Execution Times is set to 0, the Timer will run indefinitely (provided Recurrence is not set to One Time).
Info
If the Terminate Execution Mode is set to On Success or Always, the Timer will only be Terminated when the number of times it has run is equivalent to the value set to Execution Times.
Editing a Timer#
CmfTimer.Edit
A Timer can be edited from within the main details page by selecting the Edit button on the top ribbon.
Warning
Editing a Timer will only change future executions and it will not delete the historical data.
Terminating a Timer#
CmfTimer.Terminate
It is possible to terminate an existing Timer by selecting it from the list and then selecting the Terminate button.
Unterminating a Timer#
CmfTimer.Unterminate
It is possible to unterminate an existing Timer by selecting it from the list and then selecting the Unterminate button.