Workflow Manual / Version 2512.1
Table Of Contents
These are the predefined action classes which can be executed after a process completed or was aborted.
They are used with the element <FinalAction> and by specifying the name of the action class
as the class attribute.
ArchiveProcessFinalAction
Use this action to archive data of the process after it completed or was aborted and before it gets
destroyed in the Workflow Server. If the
RegisterPendingProcess action was used before to add the process to some users'
lists of pending processes, then these users can view the completed process in
Studio's Control Room.
The action can store the process data to a MongoDB database. To configure it,
set the properties mongodb.client-uri, mongodb.prefix and
repository.caplist.connect in the Workflow
Server. See Section 6.1, “Configuration Reference” for a description of these
properties.
The Workflow Server will retry the execution of this action
in case of communication problems with the MongoDB database. The exception classes that
trigger a retry are defined in the configuration property
workflow.server.archive.retry-exception, which is described in
Table 3.32, “Workflow Server Properties” in Deployment Manual.
By default, all user-defined variables of the process and its tasks are stored in the archive. Workflow
variables that hold intermediate or computed data (such as intermediate results, temporary data, or other
transient processing state) may not be relevant when reviewing completed processes in the archive.
Archiving such variables unnecessarily increases the database storage of the archive. To control which
user-defined variables are persisted in the archive, add either <IncludeVariable> or
<ExcludeVariable> child elements to the <FinalAction> element:
<IncludeVariable name="..."/>: only the listed variables are archived.<ExcludeVariable name="..."/>: all variables except the listed ones are archived.
Include and exclude configurations are mutually exclusive; specifying both is an error that is detected when
the workflow definition is parsed. Task-level variables are referenced using the dot-syntax
TaskName.variableName. When no <IncludeVariable> or
<ExcludeVariable> elements are configured, all variables are archived.
Excluded variables are not written to the archive. For an archived process, such variables appear unset or empty.
|
Attribute |
Type |
Default |
Description |
|---|---|---|---|
|
|
NMTOKEN |
(unlimited) |
The maximum number of processes to show in the list of finished processes in Studio's Control Room. This attribute should be set to the same value for all ArchiveProcessFinalAction and ArchiveProcess actions in different workflow definitions, because all processes are stored in the same list. |
Table 4.33. Attributes of the ArchiveProcessFinalAction
Example:
<FinalAction class="ArchiveProcessFinalAction"
maxProcessesPerUser="100"/>
Example 4.21. Example of the ArchiveProcessFinalAction
The following example excludes two process-level variables from the archive. All other user-defined variables (and all internal variables) are still archived:
<FinalAction class="ArchiveProcessFinalAction"
maxProcessesPerUser="100">
<ExcludeVariable name="intermediateResult"/>
<ExcludeVariable name="temporaryData"/>
</FinalAction>
Example 4.22. Example of the ArchiveProcessFinalAction with excluded variables
