Configuring Reason for Change

Health authorities may require your organization to capture a reason for change when a user corrects fields on records associated with certain key processes. Vault QMS supports the ability for Admins to require users to provide a Reason for Change upon updating one or more fields when the object record is in a particular lifecycle state. Additionally, Admins can require users to provide a clarifying comment when selecting a particular reason. Upon saving, Vault captures the reason for the change, the affected fields, the user who made the change, and when the change was made.

For example, if an Internal Audit record is in the In Audit lifecycle state and a user needs to update the Starting Date field, an Admin can configure Vault to prompt them to provide a reason for the change and comments before saving the record.

This article provides guidance on configuring this in your Vault in addition to limitations to using this feature.

Supported Objects

You can create a Reason for Change configuration for any standard or custom object.

Configuration Overview

Complete the following configuration steps to use the Reason for Change feature in your Vault:

  • Add the valid reasons for changing fields to the Reason for Change picklist.
  • Configure a field on objects that will be used by the Reason for Change feature to capture a user’s changes. This field is not displayed to users.
  • Create Reason for Change configurations for the desired objects and object types.
  • Update permission sets assigned to users who edit records for the desired objects.
  • Modify the page layout for the desired objects or object types to accommodate the Reason for Change feature.
  • Add the Reason for Change History section to the page layout for the objects or object types. When a user provides a reason for change, Vault creates an entry in the record’s Reason for Change History section. This section allows users to see all the Reasons for Change made to a record.

Configuring a Reason for Change Capture Field

The Reason for Change feature requires a Long Text field on the objects that use the feature. Standard objects that were supported in 24R3 already have a standard field named Reason for Change Capture. Admins must configure a similar Long Text field for all other standard or custom objects. If the object uses object types, ensure that the field is added to each object type that will use the Reason for Change feature.

Creating Reason for Change Configurations

Complete the following steps in your Vault to create Reason for Change configurations for the desired objects and object types.

To create a Reason for Change configuration:

  1. Navigate to Admin > Configuration > Reason for Change Configurations.
  2. Click Create.
  3. Provide a Label, Status, and optional Description.
  4. Select an Object from the drop-down and an Object Type if applicable. You are required to select an Object Type if the selected object has two (2) or more object types.
  5. Select the appropriate Reason for Change Capture field in the Capture Field.
  6. Under the Field Criteria section, select up to 30 standard or custom fields that should require a reason for change. Inactive, formula, and lookup fields are not available for selection. Select which lifecycle states should require a reason for change for the chosen fields. Click the plus (+) icon to add field and lifecycle state combinations or the minus (-) icon to remove field and lifecycle state combinations.
  7. Optional: Under the Picklist Comment Criteria section, select the Reason for Change picklist values that should require the user to provide a free text Comment.
  8. Click Save.

Limitations

The following limitations apply when you create Reasons for Change configurations:

  • You can define a single Reason for Change configuration for each specific object and object type.
  • The drop-down in the Field Criteria section only displays fields that are editable through the UI and active for the selected object type. If you update a Reason for Change configuration and a selected field has become inactive, Vault clears the field upon saving.
  • Once a field is included in a Reason for Change configuration, you cannot remove it from an object type.

Updating Permission Sets for Reason for Change Configurations

For each permission set that enables users to edit the objects or object types in a Reason for Change configuration, assign the View permission for the Reason for Change object. For each object that should be editable from this permission set, assign the View permission for the Reason for Change object control.

Configuring Object Page Layouts

To accommodate the Reason for Change feature, you must add the Reason for Change application control to the object or object type’s page layout. This control is not visible to an end user, but it must be in the page layout in order to display the Reason for Change dialog when a user saves a record.

The Reason for Change Capture field specified in a Reason for Change configuration’s Capture Field is not intended to be viewed or edited by users, so you should not include it in an object’s page layouts.

Add the Reason for Change History section to the layout for the objects or object types. This Reason for Change History section allows users to see all the reasons for change made to a record.

You must have a security profile with the following permissions to configure Reasons for Change:

Type Permission Label Controls
Security Profile Object: Reason for Change Ability to view, create, edit, or delete Reason for Change configuration components.