Mechanizations
Mechanizations is a standard configuration interface for adding, editing and removing MySQL stored procedures that are run at a scheduled time. Example mechanizations include the event correlation and the deletion of expired events.
Refer to the Standard Configuration Interface guide for details on interacting with the grid and form.
This user interface calls REST methods from api/event/mechanizations.
The UI path for this interface is Configuration -> Events -> Processing -> Mechanization.
Form Fields
-
Name - The name of the mechanization.
-
Description - The description of the mechanization.
-
Minutes - The minutes when the mechanization will be run. Valid entries are "*" which means every minute, numbers between 0 and 59 to run at that minute, or "*/
" can be used to indicate "Every number of minutes". Refer to the Configuring Mechanization Times section for additional information. -
Hours - The hours when the mechanization will be run. Valid entries are "*" which means every hour, numbers between 0 and 23 to run at that hour, or "*/
" can be used to indicate "Every number of hours". Refer to the Configuring Mechanization Times section for additional information. -
Days - The day of the month when the mechanization will be run. Valid entries are "*" which means every day, numbers between 1 and 31 to run on that day of the month, or "*/
" can be used to indicate "Every number of days". Refer to the Configuring Mechanization Times section for additional information. -
Months - The month when the mechanization will be run. Valid entries are "*" which means every month, numbers between 1 and 12 to run at that minute, or "*/
" can be used to indicate "Every number of months". Refer to the Configuring Mechanization Times section for additional information. -
WeekDays - The day of the week when the mechanization will be run. Valid entries are "*" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or "*/
" can be used to indicate "Every number of days". Refer to the Configuring Mechanization Times section for additional information. -
Status - The status of the mechanization.
-
Stored Procedure - The actual code of the mechanization.
Filter Clause Toolbar
-
Line Numbers - Toggle on/off line numbers.
-
Search - Search code.
-
Previous - Previous result for current search.
-
Next - Next result for current search.
-
Replace One - Search and replace code.
-
Replace All - Search and replace all in code.
Configuring Mechanization Times
Mechanizations use a cron-like syntax to determine when the mechanization is run. The scheduled time definition has a field for Minutes, Hours, Days, Months, and Days of Week. Each of these fields can be set to one or more literal value in a comma-separated list, or "*" which is interpreted as Every. The mechanization runs when the current time elements match the mechanization's scheduled time elements.
At its simplest, with every time period set to "*" (every), the mechanization will be run every minute, because the current time will always match the mechanization's scheduled time.
However, imagine every time period is set to "*" (every) except Minutes, which are set only to 30. In this case, the current time will match the scheduled time and the application will be run once every hour, at x:30.
It is possible to be overly complex, creating time criteria that very seldom match. Imagine a mechanization with time criteria set to Minutes="*", Hours="*", Days=26, Months=1, and WeekDay=1. That mechanization will not run until January 26, 2026 which is the next time since 2015 that January 26th will be on a Monday.