Registration & Dossier Management provides the Requirement Hierarchy Viewer for the Registration and Registration Item objects, which displays all active related Requirements in a hierarchical structure, allowing users to review and adjust the records, nested order, and matched documents before generating a Dossier Binder for a root Requirement.
Configuration Overview
Configuring your Vault to use the Requirement Hierarchy Viewer involves the following steps:
- Configure the viewer
- Configure actions, including the Reorder and Upload actions
- Configure user permissions
Note: Depending on your Vault’s creation date and which features are currently enabled and configured, some of the steps described in this article may be unavailable or already complete in your Vault.
Configuring the Viewer
To configure the viewer on the Registration and Registration Item objects:
- Navigate to Admin > Configuration > Objects > [Object] > Layouts > [Layout].
- Insert the Requirement Viewer control section with the slider (
) icon. - Optional: Enter a Section Label.
- Optional: Enter a Section Name.
- Optional: In the Show the section only in these lifecycle states field, select one (1) or more lifecycle states. This option only appears if the object uses a lifecycle.
- Optional: Enter Section Help that users will see on object records.
- Optional: Select the Expand the section by default checkbox so that the section is always open when users open the applicable object records.
- Optional: Select up to 15 supported fields to display in the section. Drag and drop the fields to determine the order columns are displayed to users:
- Grid Columns for RIR: Fields on the Requirement object, which display to the left of any EDL Item fields you add below.
- Grid Columns for EDL Items: Fields on the EDL Item object, which display to the right of any Requirement fields you add above.
- Click Done.
- If applicable, remove the pre-configured related object section for the Requirement object.
- Click Save when you are finished updating the layout.
You cannot insert multiple Requirement Viewer sections to an object’s layout.
Supported Fields
Vault supports the following object field types in the Grid Columns for RIR and Grid Columns for EDL Items fields:
- Date
- Lifecycle State
- Name
- Number
- Object (excluding references to the Document object)
- Object Type
- Picklist
- Text (excluding Long Text and Rich Text)
- Yes/No
- Formula (so long as the return type is Date, Icon, Number, Text, or Yes/No)
- Lookup (so long as the type is a supported type listed above)
The viewer always includes the Requirement’s Name field as the first column in the grid, so you cannot add it to the Grid Columns for RIR field.
Configuring Actions
From within the viewer, users can execute actions on records and documents, including actions you’ve configured on the Requirement object. The following actions are available for users to select in the viewer:
- Add Matched Documents
- Remove Document
- Exclude Document
- Lock Version
- Unlock Version
Note: The Add Matched Documents action differs from the Add Documents record action on the EDL Item object. The Add Matched Document action is only available in the viewer, and users cannot remove or exclude documents using this action.
You can also add the following actions, which are only available on records in the viewer:
Configuring the Reorder Action
You can configure the Reorder action on the Requirement object to allow users to reorder requirements directly in the viewer using the Move Up and Move Down options from a record’s Actions menu. When a user selects either option for any descendant Requirement in the viewer, they can move that record up or down within the same parent record. These options are only visible on Requirements in the viewer. Users will not see these options when they access Requirements outside of the viewer.
To configure the Reorder action, assign the action to the Requirement object and do one (1) of the following:
- Select the Available in All Lifecycle State checkbox to apply atomic action security defaults for the applicable lifecycle states.
- Add the action as a user action to the applicable states of the Requirement object lifecycle.
From within the viewer, users can also execute any record actions you’ve configured on the Requirement object.
Configuring the Upload Action
You can configure the Upload action on the EDL Item and Requirement objects to allow users to upload documents directly in the viewer. When a user uploads a document with this action, Vault adds it as a matched document to the record on which they ran the action and to your document library.
To configure the Upload action, assign the action to the object and do one (1) of the following:
- Select the Available in All Lifecycle State checkbox to apply atomic action security defaults for the applicable lifecycle states.
- Add the action as a user action to the applicable states of the Requirement object lifecycle.
When users run this action, Vault does not apply any default Sharing Settings you’ve configured for the document type. We recommend configuring DAC to control user access to uploaded documents.
Note: Document upload will fail if the user selects a document for which you’ve configured multiple lifecycles and does not populate the Document Lifecycle Name field on the parent Requirement.
Configuring User Permissions
You must ensure users have the appropriate read and create permissions to access the appropriate objects and object fields in addition to the permissions outlined below:
The viewer displays data and documents based on the following permissions on the Requirement object:
- Requirement object: Read permission, including Read permission on the following fields:
- Parent Request Requirement, Registration Item, and Registration Objective.
- Any fields included in the Grid Columns for RIR field on the Requirement Viewer section on the Registration Objective and Registration Item objects, including objects referenced in any object fields.
- If you configure DAC for the Requirement object, ensure users have permission to view all parent records. Vault does not display the viewer to users that do not have permission to view all applicable parent records.
- EDL Item object: Read permission, including Read permission on the following fields:
- Requirement.
- Any fields included in the Grid Columns for EDL Item field on the Requirement Viewer section on the Registration Object and Registration Item objects, including objects referenced in any object fields.
- If your Vault utilizes Atomic Security on fields, users must have Read permission on the appropriate lifecycle states for the applicable fields.
- The viewer only displays matched documents for which users have a document role with View Document permission for the applicable lifecycle states.
- Users can only open documents for which they have a document role with View Content permission for the applicable lifecycle states.
Executing Actions
To execute actions in the viewer, users must have the following permissions:
- Execute permission on the applicable actions.
- Edit permission on the EDL Item object.
- The applicable EDL-related permissions.
- If you configure DAC for the EDL Item object, users will not see actions for any record they do not have permission to edit.
Add Matched Documents Action
To run the Add Matched Documents action, users must have the following permissions:
- To add a previously excluded document using the Add Matched Documents action, users must also have Execute permission on the Include Document action.
- If users execute the Add Matched Documents action on a steady state document linked to an EDL with automatic document version locking, the action locks the document even if the user does not have Execute permission on the Lock Version action.
Reorder Action
To run the Reorder action, users must have the following permissions:
- Requirement object: Edit
- Reorder action on the Requirement object: Execute
Upload Action
To run the Upload action, users must have the following permissions:
- Execute permission on the applicable actions.
- Create Document permission for the applicable document types.
- Read permission on any object records referenced in the document’s fields.
Related Permissions
You can complete all the steps in this article with the standard System Administrator or Vault Owner security profile. If your Vault uses custom security profiles, your profile must grant the following permissions:
| Type | Permission | Controls |
|---|---|---|
| Security Profile | Admin: Configuration: Objects: Create, Edit | Ability to create and modify Vault objects. |
| Security Profile | Admin: Security: Permission Sets: Edit | Ability to modify permission sets for users. |