Document workflows allow you to send one or more documents out for a wide variety of processes, such as review and approval, with up to 100 documents on a single workflow instance. This article explains how to start document workflows, manage in-progress workflows, and complete tasks as a participant. See About Document Workflows for general information.
To start a workflow for a single document:
- From the Library or document tabs, select the workflow start action from an individual document’s Actions menu.
- Vault displays the workflow start dialog with all of the required information and fields to start the workflow. Provide the required information and click Start. See below for details on assigning users.
Note that you cannot start a document workflow if the selected document is already in an active workflow.
To start a workflow for multiple documents:
- From the Actions menu, select Start Document Workflow. You can include up to 100 documents in the workflow.
- In the start dialog, select a specific workflow from the Document Workflow drop-down. Vault only displays workflows that are active and valid for the selected documents.
- Click Continue.
- If prompted, provide a Description. Vault uses this value as the Name for the Envelope record. If the value is not editable, an Admin has configured the workflow to use auto-naming for Envelope records.
- Assign users and groups to roles. See below for details on assigning users.
- Fill in any required field values or variables.
- Click Start.
Note that some document workflows are only available on specific document lifecycle states. Some document workflows are restricted to a single document only.
When starting a document workflow from the Library or a document tab, Vault includes all documents in your current view. For example, if you start a workflow from Favorites, Vault will include all documents within your favorites in the document workflow. If you perform a search or apply filters before starting the workflow, Vault includes only the matching documents.
When starting a document workflow from the Cart, Vault includes all documents in your cart. This allows you to select the documents you wish to include in the document workflow envelope.
When starting a workflow from a binder, workflow tasks and verdicts apply to the binder itself and not its contents. If the workflow allows for multiple verdicts, each binder included in the workflow receives only one verdict. Vault provides a link to view binder contents on the task page, as you cannot view binder contents within the workflow viewer.
When starting a document workflow from a binder section, Vault includes all documents in that particular section.
You can start a document workflow from the Content Plan Hierarchy Viewer in RIM Submissions Vaults. Vault includes up to 100 documents matched to active Content Plan Item records in your current filtered grid view when you start the workflow.
Document Workflow Limitations
You cannot start a document workflow in the following situations:
- If any of the selected documents is already in an active workflow
- If there are more than 100 documents selected
- If a document workflow is associated with a specific lifecycle, the workflow may only allow documents in a certain state or with certain fields configured. You will not be able to start the workflow if one or more documents don’t meet the specified conditions
When starting a workflow, the start dialog prompts you to assign users to participant groups, which are then responsible for workflow tasks. Depending on the workflow configuration, Vault may assign tasks to each participant in a group or assign a single task as an “available task”. With an available task, one of the users in the participant group must “accept” the task. The user who accepts the task becomes the task owner.
How to Assign Users
To assign users:
- Select the checkbox next to each participant group to which you would like to assign the task. Participant groups with asterisks are required.
- Select participants for each participant group. You can select users and user groups from the drop-down list or enter the name of each participant. If more than 100 users and user groups are available, you may need to type the user/group name to find the participants you need.
Note: If the workflow configuration uses the Roles allowed to participate setting, you can only select a user if that user is in one of the defined roles on each document in the envelope.
In some workflows, Admins configure constraints for a participant group based on roles. For example, only users who have the Approver role on all workflow content documents would be available when assigning the Approver participant group task. Vault automatically filters to only show allowed users and user groups.
Some workflow configurations restrict task owners from receiving the task.
How to Add Participants to an Active Workflow
Once the workflow has started, you can still add participants to the workflow using the workflow’s Actions menu. To do this, you must have the correct access on all documents in the workflow.
When assigning users or user groups to a participant group, by default, you cannot select more than 5,000 users. However, an Admin can configure a limit on the number of users that can be assigned to a workflow participant control. If this limit is exceeded, you will encounter an error upon attempting to start a workflow.
Completing Assigned Tasks
Within a document workflow, you may have tasks that require you to provide a task verdict for each document in the workflow envelope. If your task requires verdicts, you must select those individually. You can easily see which documents you have viewed in the multi document viewer. The titles of documents that you have not yet viewed appear in bold while viewed document titles appear unbolded.
How to Complete Tasks
To complete assigned tasks:
- After starting a document workflow, navigate to Home > My Tasks.
- Click the Complete or Continue button to open the document workflow viewer.
- If you have an available task: In the workflow header, click Accept. Note that once you have accepted a task, you can click undo acceptance to release it. Once released, the task is again available to any of the assigned users.
- If your workflow prompts for verdicts: For each document, click Provide verdict on the left side of the viewer and select a verdict from the dialog. If comments are required, enter them in the text box. If a reason or capacity is required, select from the drop-down list. If document field values are required, enter or select values as prompted. Click Apply to save your selection and close the dialog. Alternatively, click Apply & Next to proceed to the next available document.
- Click the Complete button in the workflow header.
- A confirmation dialog opens. Review the message and click Complete to proceed.
- If your workflow prompts for an eSignature: Enter your user name and password to provide an eSignature.
In some cases, your workflow envelope may have a large number of content documents. To view a more manageable subset of content documents within your workflow envelope, you can filter them based on any of the document metadata fields.
The document workflow task page includes the Timeline View option to provide a bird’s-eye view of workflow-related events and verdict information.
Accessing Timeline View
To open this view within a document workflow task page, click the Timeline View button from the layout selector toolbar.
Actions in Timeline View
From Timeline View, you can click View Workflow History Report for a workflow row to review the workflow and task details using a report. You can also use the Actions menus on active workflows and tasks to access related options such as Cancel Workflow, Cancel Task, Add Participants, Update Due Date, and Reassign.
To set or update a task due date:
- Navigate to the workflow’s Timeline view.
- From the task Details Actions menu, select Update Task Due Date.
- In the dialog, select a new date in the Task Due Date field.
- Click Update.
Vault notifies the task owner of the updated due date.
When you remove a document from a document workflow, Vault uses the Workflow Cancel State to move the document to an appropriate lifecycle state. If the envelope contains only a single document, you cannot remove it.
- Hover over the document’s name in the list on the left side of the viewer.
- Click the X icon.
- In the confirmation window, click Continue to confirm. This action is not reversible.
If there was a verdict in a completed task before you remove a document, verdicts for removed documents remain visible in Workflow Timeline views.
Sometimes it is necessary to stop an active workflow and remove all outstanding tasks from participants’ lists.
How to Cancel Workflows
To cancel an in-progress workflow:
- Navigate to Home > Active Workflows or to the Workflow Timeline view.
- Click on the Actions menu and select Cancel Workflow.
- If prompted, provide a comment for the cancellation.
- In the dialog, click Continue.
Workflow Cancel State
When you cancel a workflow, the workflow content returns to the state it was in before the workflow started.
If you have the correct permissions, you can replace the owner of an active workflow:
- From the workflow’s Actions menu, choose Replace Workflow Owner.
- In the dialog, select a user to replace the current workflow owner. Only users with permissions to start this type of workflow are available as replacement owners.
- Click Submit.
Vault notifies the original and new workflow owner of the action. Vault reassigns all current tasks that were assigned to the Workflow Owner participant group to the new owner, and all future tasks will be assigned to the new owner.
Emailing Workflow Participants
This action allows you to send an email to one or many workflow participants to remind them of approaching or past due task due dates or to notify them of workflow changes.
To email workflow participants after the workflow has started:
- Navigate to Home > Active Workflows, the Timeline View of the Doc Info page, or the Active Workflows panel.
- From the workflow’s Actions menu, choose Email Participants.
- In the dialog box, choose the Recipients of the email. You can choose individual workflow participants or an available participant group.
- In the Message field, enter a message.
- To include yourself as a recipient, select the Send a copy to myself checkbox.
- Click Send.
When emailing workflow participants, you may see the following recipient groups available for selection:
- Available Task Owners: Users who have a task available to accept.
- Completed Task Owners: Users who have completed the current or previous task.
- Pending Task Owners: Users or groups who have accepted an available task, but have not yet completed it. Future tasks are not included.
- Incomplete Task Owners: Users who have not yet completed an assigned task. Future tasks are not included.
The following permissions control various workflow actions:
|Security Profile||Application: Workflow Administration: Cancel||Ability to remove documents from a workflow. If your vault uses Atomic Security for Active Workflow Actions, users must have both this permission and Remove Content: Execute through Atomic Security.|
|Security Profile||Application: Workflow Administration: Update Workflow Dates||Ability to update task due dates. If your vault uses Atomic Security for Active Workflow Actions, users must have both this permission and access through Atomic Security.|
|Security Profile||Application: Workflow Administration: Email Participants||Grants permission to email workflow participants. If your vault uses Atomic Security for Active Workflow Actions, users must have both this permission and access through Atomic Security.|
|Security Profile||Application: Workflow Administration: Replace Workflow Owner||Ability to replace the workflow owner. By default, only administrator profiles such as Vault Owner, System Administrator, and Business Administrator have this permission.|