Professional Documents
Culture Documents
iserver-2021-administrator-guide-workflow-1
iserver-2021-administrator-guide-workflow-1
Administrator Guide
Workflow
iServer 2021 Administrator Guide – Workflow
If you have any queries, you can contact the Orbus Software by email:
support@orbussoftware.com
2
iServer 2021 Administrator Guide – Workflow
Contents
1 Workflow administration ............................................................................................................................................................................ 5
1.1 Glossary of terms ................................................................................................................................................................................................................ 5
3 Using workflows.................................................................................................................................................................................................... 25
3.1 Submitting content to a workflow ........................................................................................................................................................... 25
3
iServer 2021 Administrator Guide – Workflow
4
iServer 2021 Administrator Guide – Workflow
1 Workflow administration
This user guide provides an overview of the features and functions of the iServer Workflow
module, as well as a step-by-step guide on how to set up, configure, and use iServer
workflows and feedback.
Term Explanation
Initiating user The iServer user that initiates a workflow either by manual
submission or by activating a workflow trigger.
Approval workflow A workflow that sets the field iServer Approval Status,
available once the Item Approval option is enabled.
5
iServer 2021 Administrator Guide – Workflow
6
iServer 2021 Administrator Guide – Workflow
If you have pending workflow actions, upon login, you can view a blue header with
a shortcut to My Actions. By selecting Open My Actions, a list view appears in the repository
with all the workflows that require your action, or all the workflows where you are
an initiating user.
7
iServer 2021 Administrator Guide – Workflow
The Completed Workflows section provides a similar list view showing all completed
workflows in the system.
Note: Expanding the filters of the workflow list views allow you to alter the
results. There are several filters available specifically for Workflows
(See Appendix B: Workflow View filters)
Items in the repository that are in the Approval Workflow and the Pending Approval state
are tagged with a workflow indicator icon.
Items that are in any other workflow that is not an Approval Workflow are tagged with a
green cyclical workflow indicator in Visio.
8
iServer 2021 Administrator Guide – Workflow
With the Workflow Administration permission enabled, you can do the following:
Note: In Portal, feedback templates are available to all Portal users whereas
Workflow templates are only available to users with iServer or Portal
Contributor license.
9
iServer 2021 Administrator Guide – Workflow
• Notification Workflows
These workflows don’t require decision steps or decision makers.
You can set up feedback workflows to use the out-the-box workflow email notifications
by adding users into the Notifications section of the workflow template.
Alternatively, you can add the Send Email action to one of the workflow states and
configure a custom email notification.
See Appendix C: Check Out Notification for Processes.
• Automation Workflows
You can configure workflow templates to automate system tasks. These types of
workflows are not required to change the approval status of content. System actions
that workflows can automate include:
• Setting an attribute value: administrators can select any custom attribute and
predefine the value the workflow populates this attribute with
• Discard check out of content
• Lock content
• Approval Workflows
These workflows are defined by a template with one or more decisions that change the
approval status of items that are submitted to it.
On the Start step, select the Set Approval Status workflow action and set the item
status to Pending Approval. Repository items in the Pending Approval status have an
indicator icon.
10
iServer 2021 Administrator Guide – Workflow
To ensure users provide comments when submitting repository content to this workflow,
you can select the Require comment upon submission check box.
You can use workflow Tags to assign categorization and priority to any workflows based on
the template. These tags are added by default; however, you can edit them when initiating
the workflow.
Several triggers are available to activate a workflow. For details and use cases for each
trigger, see Workflow Triggers.
You can define whether the workflow templates are available for use in Portal by selecting
the Portal check box. Then Portal Contributors can initiate workflows based on the workflow
template in Portal.
11
iServer 2021 Administrator Guide – Workflow
You can configure the Item Criteria in a similar way to how you configure the iServer view
filters. The item criteria limit what content the workflow template can be used for.
In the preceding example, you can submit only BPMN 2 Model diagrams in the Business
Process Repository folder to this template as a workflow.
If any state of the workflow changes the approval status of repository content i.e. if it uses
the Set Approval Status action, then the workflow template becomes an approval workflow
and receives an additional item criterium that appears dimmed—iServer Approval Status
must not equal Pending Approval.
12
iServer 2021 Administrator Guide – Workflow
This additional item criterium ensures that repository items cannot be submitted to more
than one approval workflow at a time.
To validate the workflow criteria, select Send Criteria to View. This generates a list view
using the workflow criteria allowing the administrator to check which repository items can
be submitted to the workflow.
13
iServer 2021 Administrator Guide – Workflow
To add decision states to the workflow template for user validation and input:
Now you can view the decision state under the Overview section and you can change
the Name of the decision state if necessary.
2. To specify who can make a decision in the workflow, under Decision Makers, select one
of the following:
3. If at the time of defining the template you are not sure who should decide, you can
select one of the following:
• To allow a decision maker to assign another decision maker for that decision step
or decide by themselves, select the Current decision can be forwarded check box.
Ensure the decision maker is selected.
14
iServer 2021 Administrator Guide – Workflow
• If the workflow template contains more than one decision and you want to allow a
decision maker to choose the decision maker for the next workflow step, then for all
decision steps, select the Let user choose a decision maker check box.
15
iServer 2021 Administrator Guide – Workflow
4. Under Decision, in the green box, enter the question to ask in the decision step.
5. To add decision outcomes for each decision, select ‘+’ (2) and enter the response. You
can add as many numbers of decision outcomes as needed.
6. To configure actions for each decision outcome, under the outcome, select ‘+’ (1). Each
decision outcome must have the Move to State action populated.
In the example, the first decision outcome moves the workflow to the next decision state,
called ‘Document Approval’, whereas the second decision outcome moves the workflow to
the ‘End’ state.
If you want a decision maker to provide a comment when selecting the decision outcome,
select the Require Comment option next to each decision outcome.
16
iServer 2021 Administrator Guide – Workflow
When you configure a workflow template for any type of workflow, you can add which users
receive email notifications about the workflow in the Notifications section.
You can add individual users, profile groups, AD group, and the user or profile list attributes
to receive notifications.
Notification Explanation
17
iServer 2021 Administrator Guide – Workflow
Note: To receive notifications, all users need to have their email addresses
filled in iServer user administration. If there are any users without email
addresses configured, the administrator receives a notification about
the email address missing for the user.
You can configure custom emails to be sent by a workflow as part of a state using
the Send Email action in any workflow state.
18
iServer 2021 Administrator Guide – Workflow
The error with the preceding example template is that there is no decision maker
configured for the decision step ‘Document Review’. You cannot save the template when it
is in an error state.
Note: The flexible nature of the workflow tool makes it possible for
administrators to configure conflicting workflows and workflow states. For
example, a state where one workflow is triggering another, which moves back
to the first one. This could cause a loop that will be aborted by the system
after several cycles to avoid any impact on system performance.
19
iServer 2021 Administrator Guide – Workflow
You can find feedback templates in the Administration menu in the iServer repository.
You can configure feedback templates with Criteria potentially making them available for
specific repository items only.
You can configure feedback templates to send feedback to specific users such as the user
who created or last modified the repository items (using the Created by or Modified by
user options in the template). In this case, the user can access this feedback by going to
the My Feedback section on the iServer start page.
Activating Item Approval also enforces approval-based visibility in iServer and Portal,
allowing to hide unapproved content from users who do not have permission to view it.
20
iServer 2021 Administrator Guide – Workflow
The implications of enabling Item approval in the repository include the following:
• All lists in the repository automatically receive system attributes called iServer Approval
Status and Approved by. When an item is submitted to an approval workflow, the
iServer Approval Status is automatically changed to ‘Pending Approval’ by default.
When a decision maker approves the item, the Approved by field displays the name of
the decision maker.
• All checked in content at the time of enabling this option is set to Approval Status—
Approved.
• Checked out content is automatically set to Approval Status—Draft.
• If a new version is created for a document or an object, the Approval Status changes
to Draft, unless the Allow items to be edited after approval option is selected.
You can save and check in content regardless of the Item Approval option. You cannot
check in only items that are in the Pending Approval state.
Additionally, the workflow administrator can specify which repository content is subject to
iServer Item Approval. Filters are available for location, object type, document type, and
general type. You can set filters in the same way as to view filters. For more information, see
the Search filters section of the User guide iServer application.
21
iServer 2021 Administrator Guide – Workflow
If Allow items to be edited after approval option is selected, and a new version is created
for a document or an object, the Approval Status remains Approved.
• To automatically approve all items and set their state to ‘Approved’, select Yes.
• To leave items in the ‘Draft’ state and later submit them all to an approval workflow,
select No. This might be useful when you don’t want any approval workflows to be in
progress during the upgrade.
22
iServer 2021 Administrator Guide – Workflow
System Administrators can override the value set for the Approval Status system attribute
in the Properties section of any repository item. This allows system administrators to bypass
workflow approval by manually setting the status to ‘Approved’.
23
iServer 2021 Administrator Guide – Workflow
24
iServer 2021 Administrator Guide – Workflow
3 Using workflows
3.1 Submitting content to a workflow
After you configure workflow templates, you can submit repository content to a workflow
based on the conditions defined in the template.
Automatically triggered workflows are recorded as if a user initiates the workflow by acting
trigger. For example, the user who performed the paste initiates a workflow triggered by a
copy-paste operation. This user becomes the initiating user of the workflow.
To initiate a workflow, select the content from the repository and on the Items tab, expand
the Workflow option, and select the relevant workflow template. Workflows are also
available from the shortcut menu.
Note: When you submit objects and documents to an approval workflow, objects
and documents are automatically checked in, if they are currently checked out.
25
iServer 2021 Administrator Guide – Workflow
Users with the Portal Contributor license can initiate workflows from the Portal in a similar
way: by selecting the repository items and selecting the Workflow option on the toolbar.
Note: Workflows that require user approval can only be initiated using
the ‘Submitted’ trigger.
When you initiate a workflow, if there are no decision makers configured in the workflow
template, but an initiating user is enabled to choose a decision maker, you can specify the
Decision makers for the workflow.
Figure 33 - My Actions
In My Actions, you can view the workflows including the name of the workflow, the current
state, and history information such as the created date and user.
26
iServer 2021 Administrator Guide – Workflow
You can view properties of each of the repository items in the workflow in the Temporary
pane by selecting an item and selecting View Properties on the Home tab.
You can also view Workflows and Feedback associated with a repository item in
the Workflow and Feedback sections in the Properties pane.
27
iServer 2021 Administrator Guide – Workflow
In the following example, the decision maker decides if the application records submitted
to this workflow are complete. The decision maker can select the relevant outcome: Yes,
Complete or No, Incomplete.
The decision maker can view the actions that are performed as a result of each decision
outcome by expanding the possible outcomes (using the expand arrow).
Depending on the workflow template configuration, a decision maker may select decision
makers:
A decision might be routed incorrectly and instead of aborting the workflow, you can
add the correct users, profiles, AD groups, or any user in a user or profile list attribute
value to the current decision step. The selected decision makers receive the "Workflow
Requiring Action" notification.
28
iServer 2021 Administrator Guide – Workflow
At the decision step where you are a decision maker, you can choose the decision
maker for the next decision step to ensure the workflow is directed to the correct users,
profiles, or groups.
If there are multiple items in the workflow, there is an option to either provide a single
attribute value for all workflow items using Apply value to all or Apply individual values
for each.
When you select the decision outcome, populate any required values (comments or
attribute values), and select decision makers, to save the decision and progress
the workflow, select Save. The workflow is also no longer available in the My Actions section
for the user if no further input is required.
29
iServer 2021 Administrator Guide – Workflow
You can add general comments not specific to any state or decision to the workflow in
the Comments section. This section displays any previous state comments and a timeline
of information relating to workflow, including the date and time of when each
decision state.
To add general comments, in the Comment box, enter your comment and select Add.
30
iServer 2021 Administrator Guide – Workflow
Workflow comments also support attachments, rich text, hyperlinks, and images. In
the following example, an image of the process flow is added as a comment. This may be
useful if decision makers wish to communicate required updates to content to get
approval for example.
Alternatively, decision makers can add Microsoft Office or PDF document attachments to a
workflow by using the paperclip icon in the comment box header.
31
iServer 2021 Administrator Guide – Workflow
System administrators can also abort approval workflows. Cancelled workflows appear in
the Completed Workflows section with the Aborted state.
You can view a history of cancelled workflow on the Comments tab of the workflow
properties pane.
Workflow administrators can also purge individual workflows from this list, or purge all
completed workflows from the system in iServer Options > Purge.
For more information on iServer options and how they influence workflows, see iServer
Administrator guide.
32
iServer 2021 Administrator Guide – Workflow
4 Submitting feedback
4.1 Submitting new feedback
To submit a repository item to new feedback, ensure you configured a feedback template
for the item. To submit feedback for a repository item, select the item, and on the Items tab,
select Feedback. A drop-down list contains available feedback types.
After you select a feedback type, enter a name for the feedback record and description.
33
iServer 2021 Administrator Guide – Workflow
You can view the feedback associated with a repository item in the Feedback section of
the Properties pane.
34
iServer 2021 Administrator Guide – Workflow
35
iServer 2021 Administrator Guide – Workflow
Set Approval Adding this action to any step in a A process analyst would like
Status workflow template makes it an to submit a completed
Approval workflow. This action also target-state process diagram
adds additional criteria for the for approval to business unit
template ensuring items are not leaders.
already pending approval. The best
practice for approval workflows is
to Set Approval Status = Pending
Approval as part of the start step
and configuring Approved and
Draft states further on in the flow.
Move to State This action moves the workflow to An approval workflow should
the next state. The Move to State progress from the Start state
action is not valid on the End or to a Review decision, and
Aborted states as these represent then to an Approve decision
the end of a workflow. Decisions step.
can move to previous states.
Lock/ Unlock Item This action locks or unlocks the An administrator would like
items in the workflow. There are any approved repository
scenarios where this action may content locked to prevent
cause error states, for example, if further changes.
items are checked out they cannot
be locked. The workflow provides an
error notification in these cases.
Discard Check Non-approval workflows can be set A process analyst would like
Out to discard a check out of repository to automatically discard any
content. changes made to the
approved baseline processes.
36
iServer 2021 Administrator Guide – Workflow
37
iServer 2021 Administrator Guide – Workflow
Workflow Decision Maker (Profile) Returns a list of workflows where the selected profile
is a decision maker
Workflow Decision Maker (User) Returns a list of workflows where the selected user is
a decision maker
Workflow Notification (Profile) Returns a list of workflows where the selected profile
is notified of changes to the workflow
Workflow Notification (User) Returns a list of workflows where the selected user is
notified of changes to the workflow
38
iServer 2021 Administrator Guide – Workflow
39
iServer 2021 Administrator Guide – Workflow
40
iServer 2021 Administrator Guide – Workflow
41
iServer 2021 Administrator Guide – Workflow
42
iServer 2021 Administrator Guide – Workflow
43
iServer 2021 Administrator Guide – Workflow
44
iServer 2021 Administrator Guide – Workflow
45
iServer 2021 Administrator Guide – Workflow
46