Automaton
Last updated
ProcMan Admin Guide V6.0.0
Last updated
A new Automaton schedule entry can be created by clicking the New button. After that a Form is displayed allowing making the schedule definition.
In the selection box Type the type of the scheduled command can be selected. Depending on the selected type additional options are displayed in the form. Currently supported command types are described later in this chapter.
The field Name has to be filled with the name of the new schedule. The name can contain simple alphanumerical characters (ä, š, ô, etc. are not allowed), underscores, dots and spaces. Spaces at the beginning and the end are ignored. After submitting the form the name is converted into uppercase.
The field Description can be filled with a textual description of the new schedule. It is a free text, which can contain any printable characters. It also can be left empty.
The field Communication id (Universal Interface configuration) has to be filled with an id of a well specified configuration of the HWM Universal Interface in the file etc/hwm_universal_interface_config.php. This setting is essential for the possibility to execute the scheduled command by the Automaton.
The field Interval (seconds) has to be filled by the interval in which the scheduled command will be periodically executed by the Automaton.
The check-box Enabled specifies whether the schedule is considered by the Automaton or not. If a schedule is not enabled it behaves like if it would not be defined at all.
The dialog can be left by clicking the Cancel button or by clicking another menu item.
The definition can be saved by clicking the Save button.
Currently supported types of scheduled commands (selection box Type):
The check box Search for activities with fulfilled autoexec condition in all processes and execute them has to be checked when the scheduled command shall trigger all autoexecuted activities in the work list which have fulfilled preconditions (proper status and fulfilled autoexecution condition) for an execution.
In the fields Execute only activities with action name matching one of the specified patterns one or several action name patterns can be specified, to limit the scheduled command only to trigger autoexecuted activities with fulfilled preconditions to those, for which the action name is matching at least one of the specified patterns. Additional pattern fields can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row. The pattern strings can contain wildcards: asterisk (*) and question mark (?). Asterisk means any string even an empty. Question mark means any character.
In the fields Execute only activities with action name not matching one of the specified patterns one or several action name patterns can be specified, to limit the scheduled command only to trigger autoexecuted activities with fulfilled preconditions to those, for which the action name is not matching any of the specified patterns. Additional pattern fields can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row. The pattern strings can contain wildcards: asterisk (*) and question mark (?). Asterisk means any string even an empty. Question mark means any character.
If the check box Execute activities regardless if their autoexec condition is fulfilled or not is checked, the check of the fulfilled precondition for triggering of the autoexecuted activities considers only the proper status of the activity and not whether the in the process definition specified autoexecution condition is fulfilled or not.
If the check box Execute final activities regardless if the predecessor process is completed or not is checked, also autoexecuted activities which are final activities of processes are triggered even when the pre-processes of the processes are not complete yet.
In the fields Search for activities with fulfilled autoexec condition in specified processes and execute them one or several process ids (numbers) can be specified to limit the triggering only to autoexecuted activities of the specified processes. Additional fields can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row.
In the fields Exclude activities of the specifed processes from execution one or several process ids (numbers) can be specified to avoid the triggering of autoexecuted activities of the specified processes. Additional fields can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row.
In the fields Execute the specified activities if their autoexec condition is fulfilled one or several activity ids (numbers) can be specified to limit the triggering only to the specified autoexecuted activities. Additional fields can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row.
In the fields Exclude the specified activities from execution one or several activity ids (numbers) can be specified to avoid the triggering of the specified autoexecuted activities. Additional fields can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row.
This type allows defining scheduled commands for cleaning up old files (e.g. old logs).
In the fields File specification one or several file paths have to be specified. Additional file specifications can be added by the plus (+) buttons and removed by the minus (-) buttons at the end of the table row. The file path strings can contain wildcards: asterisk (*) and question mark (?). Asterisk means any string even an empty. Question mark means any character. When the File Sweeper is running, it looks for files to be deleted, only in the file paths specified here.
In the field Time specification a relative time has to be specified. This information means for the File Sweeper, that only files older than the specified time shall be deleted. The time can be specified here using the key words like yesterday/today/tomorrow. Further entries consisting of an integer number and key words second(s)/minute(s)/hour(s)/day(s)/week(s)/month(s)/year(s) are allowed. So for example the specification -1 week means delete all files older than one week. Entries of this type can be sequenced. For example the specification -3 months -2 days means delete all files older than 3 months and 2 days. Beware that any specification pointing a time in the future will delete all files, found based on the File specification.
An Automaton schedule entry can be edited by selecting it in the table of schedule entries in the main Automaton dialog (checking the check-box at the beginning of the table row) and clicking the Edit button in the main Automaton dialog. Alternatively a global definition can be edited also by clicking on the name in the table of schedule entries in the main Automaton dialog. After that a form for editing the selected schedule appears. This form is the same like the form for a new schedule entry except, that the field Type is read-only and cannot be changed.
An existing Automaton schedule entry can be used as a base for a new one by selecting it in the table of schedule entries in the main Automaton dialog (checking the check-box at the beginning of the table row) and clicking the Copy button in the main Automaton dialog. After that the form for a new schedule entry prefilled with the settings from the selected schedule entry appears. Beware that at least the name of the schedule entry must be changed before the new schedule entry can be created.
One or more schedule entries can be deleted by selecting them in the table of schedule entries in the main Automaton dialog (checking the check-box at the beginning of the table rows) and clicking the Delete button in the main Automaton dialog. An alternative to the deleting of a schedule entry is to disable it.
This type allows defining scheduled commands for triggering of autoexecuted activities (see chapter ). Normally it is enough to define one scheduled command of this type which handles all autexecuted activities. However in some cases it might be useful to define several scheduled commands of this type for different autexecuted activities, e.g. for to have the possibility to enable/disable them separately, or for to set different intervals for the triggering of such activities.
