There are four types of workflow configurations:
- Batch
- Real-Time
- Task
- System Task
Batch Workflow
A batch workflow processes input that originates in a specific source, often a file. The workflow creates batches from the data and processes them one by one.
In a batch workflow data is collected by a single collecting agent in a transaction-safe manner: a single batch is collected (only once) and is fully processed by the workflow before the next batch is collected.
A batch workflow:
- Processes batches, one at a time
- Is started either manually or by a scheduled trigger
Stops either when it finishes processing the input, or when aborted
Note!
If the workflow aborts, the current batch can be reprocessed.
Real-Time Workflow
Real-time workflows are applicable in systems where instant processing requests need to be addressed as they occur.
In real-time workflows most of the collecting agents communicate in a two-way manner; they receive requests and provide replies.
A real-time workflow:
- Can have more than one collecting agent
Can process several UDRs simultaneously. See 3.1.2 Multithreading.
Note!
Due to multithreading in real-time workflows, unlike batch workflows:
The order of UDR processing cannot be guaranteed.
Only global MIMs are used.
- Once started, is always active. A real-time workflow is started either manually or by a scheduled trigger, and stops either manually or due to an error.
- Processes in memory. Transaction safety must be handled prior to collection and after distribution.
- Real-time workflow error handling rarely leads to aborting the workflow. Errors are registered in System Log and the workflow continues to run.
Note!
Real-time workflows may use the Inter Workflow or Kafka agents to forward data to a batch workflow.
Task Workflows
Task workflows are single agent workflows that execute user defined SQL or shell scripts.
System Task Workflows
is delivered to you with System Task workflows included. System Task workflows and workflow groups that include System Task workflows enable you to perform background routines such as log- and run-time data clean up from the platform.
System Task workflows include:
Alarm Cleaner
Archive Cleaner
Configuration Cleaner
ECS Maintenance
Statistics Cleaner
System Backup
System Log Cleaner
This section includes information about:
Opening a System Task Workflow
Modifying a System Task Workflow Configuration
Opening a System Task Workflow
You open a System Task Workflow from the workflow configuration.
To open a System Task, double-click a System Task workflow or workflow group in the Configuration Browser pane.
Modifying a System Task Workflow Configuration
You modify all the System Task Workflow configurations at template level. The workflow properties are all set to Final and cannot be modified.
- You can modify a System Task configuration, including its scheduling criteria, but you cannot create or remove a System Task configuration.
- The Archive Cleaner Workflow lets you modify only its scheduling criteria. For further information see Scheduling in 3.2.2 Managing a Workflow Group .
To Modify a System Task Workflow:
- Open the System Task Workflow that you want to modify.
- Double-click the agent icon.
The agent's configuration dialog opens.
- Perform the changes and click .
- Save the workflow.
The Alarm Cleaner workflow enables you to periodically delete old Alarm messages from the database.
To configure the Alarm Cleaner System Task workflow, enter the number of days that define a period during which an alarm message should remain in the database.Archive Cleaner
The Archive Cleaner System Task enables you to remove old archived files from the file system. Archive Cleaner operates according to data that it receives from the Archive profiles.
Note!
You can modify only the scheduling criteria of the Archive Cleaner. See 9.8.2 Archive Profile. Since scheduling can only be applied to workflow groups, you modify the Archive Cleaner scheduling from the workflow group configuration.
Configuration Cleaner
Enables you to specify the maximum age of an old configuration before it is removed. Configuration Cleaner is executed in every space. See 2. Configuration .
When the Configuration Cleaner is applied, every space is included. For further information on configuration spaces, see the Configuration Spaces documentation.
Note!
You cannot remove the most recent configuration with the Configuration Cleaner, only historical ones.
To configure the Configuration Cleaner:
- Select a configuration type from the table and then click the entry in the Keep column; a drop-down list appears.
- Select one of the following: Always, Days, or Versions.
The Configuration Cleaner System Task
| Item | Description |
|---|---|
Type | The icon representation of the configuration type. |
Name | The name of the configuration type. |
Keep | Select the time unit with which you specify how long old configurations should remain in the system.
|
Value | Specifies the number of days or versions that represent the period during which configurations are kept. |
ECS Maintenance
Enables you to remove old ECS data from the file system. For information about the ECS Maintenance System Task workflow see 9.24.3 ECS_Maintenance System Task.
Statistics Cleaner
Enables you to remove old statistics data that has been collected by the Statistics server and stored in the database.
The Statistics Cleaner System Task
| Item | Description |
|---|---|
Minute Level Records | Specifies the number of days during which a minute-level record should be kept in the database. |
Hour Level Records | Specifies the number of days during which an hour-level record should be kept in the database. |
Day Level Records | Specifies the number of days during which a day-level record should be kept in the database. |
System Backup
. A backup file is saved on the host machine where the platform application is installed. $MZ_HOME/backup/yyyy_MM, where yyyy_MM is translated to the current year and month. The system saves a backup file and names it according to the following format: backup_<date>.zip.System Backup also enables you to specify the maximum age of backup files before they are removed from the host disk.The System Backup configuration dialog box is made up of two tabs:
System Backup: Lets you enable the backup option
Cleanup: Lets you configure the time during which a backup should be kept on disk before it is deleted
The System Backup System Task workflow
| Item | Description |
|---|---|
Enable System Backup | Select this check box to enable the system backup. The default value is On. |
Use Encryption | Select this check box to enable encryption of the backup. |
Password | Enter a password. |
The System Backup Cleaner System Task - the Cleanup tab
| Item | Description |
|---|---|
Imported Files | Every time the System Importer imports a configuration to the system, |
System Backup Files | Defines the maximum age of system backup files before they are removed from the host disk. |
System Log Cleaner
The System Log Cleaner deletes the System Log periodically. You set the frequency values for deleting different message types, on the System Log Cleaner dialog box.
The System Log Cleaner System Task
| Item | Description |
|---|---|
Error/Disaster | Enter the maximum age of Error and Disaster messages before they are removed from the database. Max value: 99 days Default value: 30 days |
Warning | Enter the number of days during which Warning messages should be kept in database. Max value: 99 days Default value: 20 days |
Information | Enter the number of days during which Information messages should be kept in the database. Max value: 99 days Default value: 10 days |