Adding Custom Objects to the Deployment Whitelist


You can include custom Vault object configuration in your deployment. To do so, you must add the object to the deployment whitelist from System Tools > Custom Objects.

Prerequisites

To deploy a custom vault object, that object must be fully-configured in such a way that it meets all requirements for deployment. See details below.


The following permissions are required to perform the actions described below.

Role by Study Permissions

Users with the standard CDMS Deployment Administrator study role or the Vault Owner security profile can perform the actions described below by default. If your study uses custom Study Roles, you must have the following permissions:

Type Permission Label Controls
Standard Tab System Tools Tab

Ability to access the Tools > System Tools tab

Functional Permission Manage Study Deployments

Ability to create and manage study Environments and deploy Studies from EDC Tools, as well as manage and deploy vault-level configuration from Tools > System Tools

If your Study contains restricted data, you must have the Restricted Data Access permission to view it.

Learn more about Study Roles.

Profile Permissions

Users with the standard EDC Deployment Administrator study role or the Vault Owner security profile can perform the actions described below by default.


Custom Object Configuration Requirements

For custom vault objects to be eligible for deployment, they must have the following configuration:

  • The object must be a custom object ā€œ__cā€ namespace (this is automatically true for any custom object).
  • The object must have an object reference field to the Study (study__v) object.
  • The object must have an object lifecycle.

How to Add an Object to the Whitelist

To add an object to the deployment whitelist:

  1. Navigate to Tools > System Tools > Custom Objects.
  2. Click Manage Custom Objects.
    Manage Custom Objects button

  3. In the Custom Objects dialog, use the Arrow buttons to move objects from the Available Custom Objects list to the Selected objects list. Any objects in the Selected objects list are included in the deployment whitelist. Custom Objects dialog

  4. Click Save.

Any objects in the Selected list are now included in the deployment whitelist. The next deployment you initiate, select the Custom Objects checkbox to include the configuration of these objects.

Vault only deploys custom object configuration, not records. Should you need to move object records in a whitelisted object from environment to environment, a Vault Owner can use Vault Loader to do so.

To add an object to the Deployment Whitelist:

  1. Navigate to Admin > Business Admin > Deployment Whitelists.
  2. Click + Create.
  3. For Component Name, enter the Name of your object. Include the ā€œ__cā€. You can get this value from Configuration > Objects.
  4. For Component Type, select Object.
  5. Select your Study.
  6. Click Save.