# Using Object Workflows This article explains how to start a workflow, manage an in-progress workflow, and complete tasks as a workflow participant. This article refers to workflow tasks. Vault also includes a _User Task_ object class to track ad hoc work. For information on user tasks, see Working with User Tasks. ## Starting a Workflow for a Single Object Record To start a workflow for a single object record: 1. From the object record **Actions** menu, select the workflow start action. 2. Vault presents the workflow start dialog with all of the information and fields required to start the workflow. 3. Provide the required information and click **Start**. See details [below][2] for assigning users. ## Starting a Workflow for Multiple Object Records You can start an object workflow from Object Tabs, Related Lists, Favorites, Saved Views, Reports, or any other object record list page. To start a workflow for multiple object records: 1. From the **Actions** menu, select **Start Workflow**. You can include up to 100 object records of the same object in the workflow. 2. Conditional: If there are no workflows that are active and valid for all of the selected object records, Vault redirects you to the [_Advanced Start Workflow_][8] page. 3. In the start dialog, select a specific workflow from the **Workflow** drop-down. Vault only displays workflows that are active and valid for the selected object records. 4. Optional: Click [**Advanced Start Workflow**][8] for additional multi-record workflow options. 5. Click **Continue**. 6. 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. 7. Assign users and groups to roles. 8. Fill in any required field values or variables. 9. Click **Start**.
### Starting Advanced Workflows {#advanced-start-workflow-obj} The _Advanced Start Workflow_ option allows you to select object records to include in a workflow based on the workflows available in the record's lifecycle state. You can use this option to break up large amounts of records into smaller subsets to send on their own workflows. Or, you can bulk move records through state changes and action steps when no tasks exist on a workflow. A **Finish + Start Next Workflow** is available in this scenario to help you cycle through each workflow for the subset of records. _Advanced Start Workflow_ is also available in the _Start Next Workflow_ dialog for workflows configured with _Display start next workflow dialog_ when workflow ends on the _End_ step. This action initiates a new multi-record workflow that includes all documents, remaining and removed, from the original workflow that just ended. To use the _Advanced Start Workflow_ options: 1. Click **Advanced Start Workflow** in the **Start Workflow** dialog. All records on the object record list are included. 2. Optional: Unselect records to exclude from the workflow on the **Refine Selection** page. 3. Click **Next**. 4. On the **Choose Workflow** page, select the workflow to apply to your selected records. This page displays the object's lifecycle and groups each workflow under lifecycle states. Each state displays the number of your selected records in the state and available for inclusion in the workflow. 5. Click **Next**. 6. On the **Edit Details** page, edit workflow _Start_ step details, such as the description, roles, and due date. If no _Start_ step is configured on the workflow, skip this step. 7. Click **Next**. 8. A confirmation summary displays the workflow details and records included in the workflow. Review and click **Finish** to start the multi-record workflow. 9. Optional: If changes are needed, click **Back** to return to a previous step and make edits. Vault saves your previous selections. 10. Optional: Click **Finish + Start New Workflow** to return to the **Refine Selection** page. Repeat the process for any records not included in the original workflow. Vault returns you to the initial view where the workflow was started and displays a green banner at the top of the page with a success notification.
### Object Workflow Limitations You cannot start an object workflow in the following situations: * If any of the selected records is already in an active workflow or merge process. Auto-start object workflows bypass this limitation, which allows an object record to exist in multiple active workflow instances. * If there are more than 100 records selected * If a record 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 records don't meet the specified conditions ## How to Assign Users to Workflows {#assign} When assigning users as workflow participants, keep in mind that Vault does not check whether the object uses Dynamic Access Control or whether the users you select have the necessary access to the object record. It is possible to assign tasks to users who cannot complete them. To assign users: 1. Select the checkbox next to each participant group to whom you would like to assign the task. Participant groups with asterisks are required. The task may have been configured to restrict workflow owners from receiving it. 2. Choose users or user groups for each participant group by entering the names/email addresses or clicking the down arrow to select from a list. Only the first 100 users/groups appear in the list. To see more options, start typing the user name/email address or group name. Groups appear in the list with a special icon. If an Admin configures a limit on the number of users that can be assigned to a workflow participant control, you will encounter an error if this limit is exceeded. This limit applies when assigning users at the start of a workflow and when the workflow is active. 3. Optional: If you've selected a group, hover over the group name to see a list of users (up to 30) in that group. 4. Optional: To expand the group to its individual members, click the plus (**+**) icon. When you do this, Vault treats the group members as individual users and allows you to remove some members. ### Adding Participants to Active Workflows {#add-participants} On active workflows which do not use the **Use custom action to define participants** control on the _Start_ step, you can add participants where a role has current tasks, future tasks, or future notifications directly from the workflow's **Actions** menu. If a workflow uses the **Use custom action to define participants** control on the _Start_ step, you may see a read-only list of participants when you start the workflow, but you will not be able to add participants. If a workflow uses the **Allow workflow initiator to select assign to all or make available** control in the _Start_ step, you cannot change the assignment type when adding participants. Vault assigns required and optional tasks to new participants, unless the task is available to any user and has already been accepted. If a workflow uses the **Allow workflow task owners to select participants** control in the _Start_ step, only task owners can add workflow participants during task completion. To add users: 1. Navigate to the **Workflow Timeline** section of the object record details page, **Home > Active Workflows**, or an object workflow report. 2. From the workflow **Actions** menu, select **Add Participants**. 3. In the dialog, add the users or groups to the appropriate participant groups. You can add participants to optional participant groups that were not selected when the workflow started. You cannot remove any users already in a participant group, or add users to groups assigned to workflow steps that have already been completed. 4. Click **Submit**. Vault sends the task notification as it adds active tasks to the new users' **My Tasks** view. ### Adding Participants through Role-Based Assignment {#role-based-assignment} On workflows with the **Use roles as participants** control on the start step, you can also add users to active workflows via Sharing Settings: 1. Navigate to the object record details page, and then to **Sharing Settings**. 2. In the **Access via Manual Assignment** panel, click **+ Add**. 3. Select the **Role** to which you want to add a user. 4. Select one or more **Users and Groups**. 5. Click **Save**. Vault adds the selected users and groups as participants in the active workflow. If there is an active task, Vault creates tasks and assigns them to the new users. Admins can also configure workflows so that certain workflow participant groups only allow users who are already in specific roles on the object record. In this configuration, you are only able to select allowed users. ## Viewing Workflow Participants {#view-participants} Workflow owners and participants can view all workflow participants via the _View Participants_ action. This action is available from the _Actions_ menu in the Workflow Timeline, Active Workflows list, the lifecycle stages chevron, and the _Actions_ column in workflow history reports. This action is also only available to users with access to Timeline Views, the active workflows list, and the _Application: User: View User Information_ permission. The _View Participants_ action opens a dialog that displays a row for each participant in the workflow including columns for their participant group, participant type, related tasks, the user who added them, and the date and time they were added. Each user, user group, role, or user reference field defined in the Participants control or added to the workflow via the _Add Participant_ action is displayed as an individual participant row. ### Participant Types Participants can fall under the following types: * **User**: Refers to all Vault users including the workflow owner. The text "Inactive" displays next to the user's name if they are inactive. The text "No Workflow Access" displays next to users without the _Application: Workflow: Participate_ permission. * **Role**: Refers to users added to the workflow via the _Use roles as participants_ control. * **Group**: Refers to Vault user groups added to the workflow. * **User Reference Field**: Refers to users added to the workflow via the _Use user reference field as participant_ control. Hover over a role, group, or user reference field in the _Name_ column to display the users currently in the role, group, or user reference field value. This hovercard displays current users in the role, group, or user reference field at the time of viewing the hover card. Inactive users and users without the _Application: Workflow: Participate_ permission are excluded from the hovercard. Hover cards are not available for completed or cancelled workflows. ### Related Tasks Click **View Tasks** in the _Related Tasks_ column to view the number of tasks related to a participant. Hover over the number to view the task label and status: * **Completed**: Refers to completed and canceled tasks instances, and _Task_ steps that were active when a workflow is canceled. * **Active**: Refers to assigned or available, active tasks. * **Potential**: Refers to _Task_ steps in the workflow configuration that are assigned to a participant group but have not been reached yet in the workflow process execution. In some cases, the workflow may never reach Potential tasks due to workflow business logic. Potential tasks are only based on the workflow configuration and not the workflow execution logic. View Workflow Participants Dialog ## Understanding Workflow Segregation of Duties Your Admin may configure Segregation of Duties policies on the workflow. If so, you must be aware of some considerations when completing the workflow, such as when starting the workflow, adding workflow participants, and completing tasks. ### Starting the Workflow The workflow will fail to start if Segregation of Duties policies are in place and the following scenarios occur: * A single user is added to multiple participant groups with assigned tasks in the start step dialog * A single user or user group is added to a participant group with assigned tasks and the user's role is restricted from completing tasks in the workflow * A participant group in the start step is missing users due to the workflow not assigning tasks to users because of the Segregation of Duties policies ### Completing Tasks Vault will apply restrictions to workflow tasks depending on the Segregation of Duties policies in place. See below for considerations when Segregation of Duties are in place: * **Task Assignment**: The workflow will not assign multiple tasks to each user or user group or users with a restricted role upon activation. * **Task Reassignment**: You cannot reassign a task to a user who is already assigned or completed a task or configured with a restricted role. However, you can reassign a user continuing iterations of the same task if _Users in this workflow can only complete one task_ is enabled. * **Task Acceptance**: Vault will prevent a user from accepting a task if they've already accepted, assigned, or completed another task or configured with a restricted role. * **Task Completion**: If _Users in this workflow can only complete one task_ is enabled, users cannot move on to another task after completing the one they're assigned. However, they can complete the same task again in situations where a verdict rejects the task completion. You will encounter an error dialog if you complete a task and the next task in the workflow is missing users from its participant group. However, the error dialog will allow you to add valid users to the participant group if your permissions allow you to add users to the workflow. ### Workflow Segregation of Duties {#workflow-segregation-of-duties} Workflow Segregation of Duties provide configuration options that improve role compliance in a workflow. Details ## Assigning & License Type Restrictions You cannot select users with the license type _Read-Only User_ for roles on a workflow. Vault hides these users in workflow participant fields. If you assign tasks to a group, Vault skips assignment for these users, but assigns the task normally to other users in the group. ## How to Complete Assigned Tasks Workflows can include various workflow tasks. Depending on the workflow configuration, tasks you complete may be assigned directly to you or available for you to accept. If you complete two or more of the same tasks within the workflow, for example, if another user reassigns a duplicate task to you, Vault overwrites your comments from the original task with the comments you provide when you complete the duplicate task. ### Assigned Tasks Any tasks assigned to you appear in **Home/Tasks > My Tasks** and in the details page for the specific object record. Click the **Complete** button. In the task dialog, fill in any required fields or other information and click **Complete**. If you enter information in a task completion dialog, but an error occurs that prevents task completion, Vault retains that information for the next time you try to complete the task. However, if you then edit and save any object record fields in the meantime, Vault no longer retains your updates in the task completion dialog. This functionality prevents accidental overwriting of any purposeful changes made to your document fields with the information retained in the task completion dialog. This functionality applies only to tasks with field prompts for single verdicts that apply to all items in the workflow.
### Accepting Tasks Workflow owners can also assign a task to multiple users and request that any one of the assigned users accept and complete the task. These tasks appear in **Home/Tasks > Available Tasks**. Click the **Accept** button. The task now appears in **Home/Tasks > My Tasks** and in the details page for the specific object record. 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. ### Reassign Tasks {#reassign_tasks} To reassign a task: 1. Navigate to the **Workflow Timeline** section of the object record detail page. 2. From the task's **Actions** menu, select **Reassign**. 3. In the dialog, select the new user from the **New task owner** picklist. 4. Click **Continue**. 5. Vault notifies the new task owner of the reassignment and adds the task to the **My Tasks** view for the new owner. The previous task owner also receives a notification of the reassignment. This notification occurs for reassigned workflow tasks. Different notifications occur for reassigned user tasks.
## How to Provide eSignatures On some workflows, completing a task or selecting a specific verdict requires you to electronically sign. You do this by entering your login credentials (username and password) for the Vault. Note that Vault prevents you from using saved passwords for compliance reasons. Even if you've saved your password in your browser or a password manager, you'll have to type the password to provide an eSignature. ## How to Provide Capacities Sometimes, you'll also need to select a "capacity" when completing a task, which indicates why or in what context you are completing it. For example, a reviewer from an organization's regulatory compliance department might select _Regulatory_ as their capacity. ## Task Dates If a task has a due date, Vault displays the date alongside the task. Some views (**Home > My Tasks** and **Workflow Timeline** in the object record details) also display a status icon that indicates if a due date is within the next week or has already passed. ### Updating Task Due Dates To update a task due date: 1. Navigate to the **Workflow Timeline** section of the object record detail page. 2. From the task _Details_ **Actions** menu, select **Update Task Due Date**. 3. In the dialog, select a new date in the **Task Due Date** field. 4. Click **Update**. Vault notifies the task owner of the updated due date.
## Workflow Due Dates You can update a workflow due date in the **Timeline View** or **Active Workflows View** by using the **Actions** menu. The **Active Workflows** home page also displays a status icon that indicates if a due date is coming soon or overdue. ### Workflow Due Date {#workflow-due-date-demo} ### Updating Workflow Due Dates To update the workflow due date: 1. Navigate to the workflow's **Timeline View** or **Active Workflows View**. 2. Select **Update Workflow Due Date** from the workflow's **Actions** menu. 3. In the Update Workflow Due Date dialog, enter the new date. 4. Click **Update**. Vault updates the workflow and notifies the workflow owner. If any tasks in the workflow are configured with the workflow due date, Vault updates those due dates and notifies the task owners.
## Canceling Tasks You may sometimes need to cancel a workflow task, for example, if one of the assigned reviewers is on vacation and cannot complete a review. Canceling a task prevents the workflow from becoming stuck by allowing you to complete the workflow or move on to the next task. ### How to Cancel Tasks To cancel an open workflow task: 1. Navigate to the **Workflow Timeline** section of the object record details page. 2. Use the **Actions** menu on an individual task to select **Cancel Task**. 3. In the dialog, click **Continue**. ## Canceling Workflows {#canceling-workflows} 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: 1. Navigate to **Home > Active Workflows** or to the **Workflow Timeline** section of the object record details page. 2. Click on the **Actions** menu and select **Cancel Workflow**. 3. If prompted, provide a comment for the cancelation. 4. In the dialog, click **Continue**. ### Workflow Cancel State By default, the object record returns to the state it was in when the workflow started. However, an Admin can change this setting to either any available lifecycle state or prompt the workflow to remain in the state it was canceled in. If a canceled workflow moves a record to a state with a **Start Workflow** entry action, Vault does not start the workflow. **Start Workflow** entry actions will not execute if the previous workflow was canceled. Your Admin may also configure the workflow to skip any entry actions upon cancelation. In this case, **Start Workflow** will not initiate. ## Replacing the Workflow Owner {#replacing-workflow-owner} If you have the _Replace Workflow Owner_ permission, 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. All users with the _Start Workflow_ permission are available as replacement owners. * Click **Submit**. Vault reassigns current tasks that were assigned to the workflow initiator participant group to the new owner, and all future tasks will be assigned to the new owner. Vault notifies the previous and new workflow owners of the replacement. ## 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: 1. Navigate to **Home > Active Workflows** or to the **Workflow Timeline** section of the object record details page. 2. From the workflow's **Actions** menu, choose **Email Participants**. 3. In the dialog box, choose the **Recipients** of the email. You can choose individual workflow participants or an available [participant group][7]. 4. In the **Message** field, enter a message. 5. To include yourself as a recipient, select the **Send a copy to myself** checkbox. 6. Click **Send**. ### Participant Groups {#participant-group} 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. * **Incomplete Task Owners**: Users who have not yet completed an assigned task. Future tasks are not included. ## Related Permissions {#permissions} The following permissions control various workflow actions: |Type|Permission Label|Controls| |--- |--- |--- | |Security Profile|Object: Read|Ability to view an object record; you must have this permission and an object role with View permission to initiate a workflow on a specific object record or to view an assigned task on that record. If you have an assigned task on a record you cannot access, you won't see the task in **Home** > **My Tasks**, but will receive notifications and reminders for it.| |Security Profile|Application: Workflow: Start|Ability to initiate a workflow.| |Security Profile|Application: Workflow Administration: Reassign|Ability to reassign a workflow task to a different user without canceling the workflow. 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: Update Participants|Ability to add participants to active workflow and assign them a workflow task without canceling the workflow. 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: Cancel|Ability to cancel an open workflow task via the _Cancel Task_ action or stop an active workflow via the _Cancel Workflow_ action and remove all outstanding tasks from participants' lists. 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: Update Workflow Dates|Ability to update all workflow dates or specific task due dates, even if you are not the workflow owner. 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|Ability 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.| |Security Profile|Application: User: View User Information|Ability to see user information to assign workflow tasks.| [2]: #assign [7]: #participant-group [8]: #advanced-start-workflow-obj [9]: #canceling-workflows