Types of steps
The types of steps that can make up a workflow include base system steps, user steps, and automated steps.
Base system steps
These steps are created automatically for each workflow. Base system steps cannot be deleted or renamed. They can be partially edited (for example to allow imports into the step or to add script functions). The base system steps are:- Initial
- A workflow always starts with an Initial step. Only one instance of an Initial step exists per workflow. When you check out an entry, the entry will arrive in the Initial step, where it will be rerouted according to the mapped next step.
- Success
- If entries reach the Success step in a workflow, the system attempts to check the entries into the catalog or hierarchy that is connected to the collaboration area for the workflow.
- Failure
- If entries reach the Failure step in a workflow, the system drops the entries from the collaboration area.
- Fixit
- This step is used to repair entries which have timed out or were invalid when a performer tried to move them out of a step. The collaboration area administrator can edit all checked out attributes, fix any errors, and check in the entry or abandon the entry by "dropping" it from the collaboration area.
User steps
These are steps where a performer can interact with the entry before selecting an exit value. The user steps are:- And approval
- This step requires all of the performers to approve an entry before it moves to the next step on the APPROVE exit value. If one approver rejects the entry, it will move out on the REJECT exit value. The collaboration area administrator may unilaterally approve or reject the entry.
- Or approval
- This step requires only one of the performers to approve a record before it moves to the next step on the APPROVE exit value. If one approver rejects the entry, it will move out on the REJECT exit value. The collaboration area administrator may also approve or reject the entry.
- Dispatch
- Use this step to determine which next step is to be taken; by selecting an appropriate exit value. Typically, no editing is done in this step; achieved by leaving the editable and required attribute collections blank.
- General
- This step modifies a set of entries. You can modify this step to perform any of the user steps. The Reserve To Edit feature is disabled by default. This step has no limitations.
- Modify
- This step modifies a set of entries. You can modify this step to perform any of the user steps. The Reserve To Edit feature is enabled by default. This step has no limitations.
Automated steps
These steps are automated and will perform logic and trigger an exit on an exit value without any performer interaction. The automated steps are:- Automated
- This step automates a task. The logic of this step is captured in the IN() and OUT() functions of the script.
- Wait
- Use this step if you want entries to wait for a user or script to move them to the next step. This step can also be used for checking entries back into the source container at a specific date. For example, if you want the entries to be merged with your source container only on November 15, you insert a wait step with a deadline of November 15 before the Success step. User logic is captured in the TIMEOUT function of the script. When the deadline triggers, the entry will exit on the TIMEOUT exit value.
- Make Unique
- This step removes every other copy of a entry in other branches of the workflow (usually after a split). This step ensures that a entry that reaches this step is in this step and this step only. You can organize your workflows so that users can check out one attribute of an item into a collaboration area in one workflow (for example, English short description), and check out another attribute of the same item into a different collaboration area in another workflow (for example, French short description).
- Merge
- A merge step ensures all of the incoming steps are completed for
that entry. This step merges several steps after a split. If
x
steps point to the merge step, thenx
copies of the entry must go through the merge step before this entry can move to the next step. Use the condenser step to reduce the number of incoming steps.Note: The Admin user can move items out of a merge step even when all of the inputs to the merge have not arrived. - Condenser
- A condenser step needs only one of its incoming steps to be complete for the entry to trigger an exit. This step reduces the number of entries that point to a merge step. You reduce the number of entries that point to a merge step by pointing several steps to the condenser.
- Interim Checkout
- This step reverses the changes that were done to attributes in this workflow. The values of these attributes are gathered from the main catalog when a entry enters this state.
- Interim Checkin
- This step allows you to apply the changes to the entry in the collaboration area back to the source container, similar to checkin. But unlike checkin, it does not remove the entry from the collaboration area. Instead, further processing can be done on the item in the collaboration area and it can be later checked-in.
- Nested workflow
- This step includes another valid workflow as a step, which must
be specified when the step is added. A nested workflow is a workflow
that is contained within another workflow as a nested workflow step.
The Initial, Failure, and Success steps of the nested workflow are created as extra automated steps within the main workflow. All user steps and any other automated steps are also added as extra steps to the main workflow. Entries entering the nested workflow step will enter the Initial step of the nested workflow.
The exit values for this step are the same as the termination exit values for the included nested workflow. An entry arriving at the Failure step of the nested workflow exits the nested workflow step on the FAILURE exit value. An entry arriving at the Success step of the nested workflow exits the nested workflow step on the SUCCESS exit value. If there is more than one copy of an entry in the nested workflow, a make unique operation is performed on exiting the nested workflow step. Any extra copies of an entry within the nested workflow will be deleted, however, copies of the entry in other steps of the outer workflow, will be unaffected. If the nested workflow step has a timeout deadline, a make unique operation is performed and the entry is moved out on the TIMEOUT exit value for the nested workflow step, regardless of its current location within the nested workflow.
Workflows can be nested to multiple levels, however, a cyclic workflow (A nests B which nests A) is not supported.