Archive workflow instances
The action is used for archiving selected workflow instances in order to better manage the available database disk space, and thus increase the system performance.
The archive workflow instances action has three operating modes (see Retention mode) – two of them collect workflow instances on external storage devices (database or network location), the third removes them completely.
For more information on this subject, see Archiving.
1. Retention mode
Choose a method of archiving workflow instances. All three methods involve permanently deleting the archived instances from the content database.
- Move to archive database – saves workflow instances onto a separate archive database,
- Move to an external network location – exports workflow instances to a .zip file and saves them in an external network location,
- Remove from content database – workflow instances are deleted from the content database without being saved anywhere.
2. Packaging mode
When exporting workflow instances to an external network location, the instances are packed into .zip files which also contain an .xml file detailing the instances’ history, and a .pdf file which represents the last layout of the form. There are two available methods of creating .zip files:
- Instances of the main workflow and its subworkflows in one package – instances of the main workflow are packaged together with instances of their subworkflows,
- Instances of the main workflow and each subworkflow packaged separately – instances of the main workflow, and instances of each subworkflow are packaged separately (one subworkflow, one package).
3. Priority
Defines the priority with which the task is placed in the archive queue. Priority can be set between 1 and 10, where 1 is the highest priority and 10 the lowest.
If the Nighttime checkbox is selected, the workflow instances will be put in queue with a special priority of 11, and will only be processed during night hours.
The current archive queue can be found in the Archive workflow instances queue tab.
4. Selection criteria
Method for selecting workflow instances to be processed. Workflow instances that meet the defined criteria are added to the archive queue.
- Archive only current workflow instance – the current workflow instance is added to the processing queue,
- Select workflow instances using SQL – select a larger group of workflow instances to process using an SQL query. The first fetched column should return the IDs of instances to be queued.
To construct a query, you can use the Variables editor on the right.
5. Variables editor
Dynamically generated tree containing all variables that may be used in the current location of Designer Studio. Information on how to use variables in WEBCON BPS, as well as a list of variables can be found here.
For detailed information on archiving, see the dedicated ARTICLE on our technical blog.