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 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:
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] > Page Layouts > [Page Layout].
- Click Add Section and select 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: For Grid Columns, select up to 15 Requirement supported fields to display in the section. Drag and drop the fields to determine the order columns are displayed to users.
- Click Done.
- If applicable, remove the pre-configured related object section for the Requirement object.
- Click Save when you are finished updating the page layout.
You cannot add multiple Requirement Viewer sections to an object’s page layout.
Supported Fields
Vault supports the following Requirement object field types in the Grid Columns field:
- 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 Requirement Hierarchy Viewer always includes the Name field as the first column in the grid, so you cannot add it to the Grid Columns field.
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.
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 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.
- 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.
To reorder Requirements in the viewer, users must have the following permissions:
- Requirement object: Edit
- Reorder action on the Requirement object: Execute
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. |