Managing Study Environments & Deployments


You can create and manage study environments from the Deployments listing page in EDC Tools.

About Study Environments

Study environments represent your Study as it exists in different stages of development. There are four (4) types of environments: Development, UAT (user acceptance testing), Training, and Production. You’ll build your study in your development environment, test it in one or more UAT environments, train staff on it in your training environment, and ultimately execute your study from your production environment.

Your environments may be spread across multiple vaults. Your development environment exists in a “control center” vault. Your UAT and training environments may be housed in that same vault or on a separate vault. Your production environment is most likely to be on a separate vault from your development environment.

Study environments are tracked using the Study Instance object.

Prerequisite: Before you can create Study Environments, a study designer must create a Study Master in Studio.

Accessing EDC Tools

To access the EDC Tools administration area, click the Tools tab in the primary navigation bar, and then click EDC Tools.

Access EDC Tools from the Tools Tab

By default, once you open EDC Tools, Vault displays a list of automated deployment Studies. You can use the Automatic and Manual radio buttons to switch between these listings. Select Manual to access your manual deployment Studies.

Select Automatic or Manual

For manual deployment Studies, click on the Study to open EDC Tools for that Study. For automatic deployment Studies, click on the Study to open the Deployments page. From here, you can click on an Environment to open EDC Tools for that study environment.

Once you’ve entered the EDC Tools area, select your Study if you have access to more than one Study. To return to the study list, click Back to Study Listing.

Viewing Study Environments

Once you open your Study Master in Tools > EDC Tools, Vault shows a listing of all Environments for that Study Master. From here, you can initiate deployments and create additional environments.

Latest Casebook Version vs. Build Number

The Latest Casebook Version column displays the latest Casebook Definition version that exists in that environment. The Study Build Number represents both version changes and changes to versionless objects that you move between environments. For example, if you add a new Review Plan to your study design, Vault does not require you to create a new version. However, Vault will increment the build number by one (1).

Use Latest Casebook Version to identify which version of the Study exists, but use Study Build Number to track unversioned changes across environments.

How to Create Study Environments

You can create new Study Environments for your study as needed from EDC Tools. Note that there are limits on how many Study Environments you can have of each type.

To create a new Study Instance:

  1. Navigate to Tools > EDC Tools.
  2. Click your Study Master’s Name in the Study Listing.
  3. From the Actions menu, choose an action to create an environment:
    • + Development: Create a new development-type environment.
    • + UAT: Create a new UAT-type environment.
    • + Training: Create a new training-type environment.
  4. In the Create Environment dialog, select a Vault to create your Study Environment in.
  5. Click Continue.
  6. In the Create Environment confirmation dialog, click Create.

Vault creates a new Study Environment. You can now use this environment for development, UAT, or training.

Available Environment Actions

Hover over an environment in the list to show the Actions menu. You can perform environment-level actions using this menu.

The following actions are available in the environment-level Actions menu:

Environment Actions menu

  • Deploy: Use this action to deploy the latest casebook version in this environment to another environment. Learn more.
  • Restore: Use this action to restore an environment from another.
  • Delete study data: Use this action to delete study execution data in this environment. Note that this option is not available for production environments. Learn more.
  • Rename: Use this action to rename a study environment.
  • Delete: Use this action to delete a study environment.
  • Lock: Use this action to lock a study environment. Learn more.

How to Restore an Environment

To restore from production:

  1. Navigate to EDC Tools > Deployments for your study.
  2. Locate your the environment you want to restore in the list of Environments.
  3. Hover over the environment to display the Actions menu.
  4. From the Actions menu, select Restore. Vault opens the Restore Study Design dialog. Restore action

  5. Select a Source Environment to restore from. Restore Study Design dialog

  6. Optional: Enter a Reason for Change.
  7. Click Restore. Vault begins a job to restore your environment from your chosen source environment. When finished, Vault sends you an email notification.

How to Rename an Environment

To rename an environment:

  1. Navigate to Tools > EDC Tools.
  2. Click to open the Study Master containing the environment you want to rename.
  3. Locate the Environment in the list.
  4. Hover over the Environment to display the Actions menu.
  5. From the Actions menu, select Rename.
  6. Enter a new Name.
  7. Click Continue.
  8. In the Rename Environment confirmation dialog, click Rename.

Vault renames your Environment. This changes the Label of the environment’s Study Instance record, but not the API Name.

How to Delete an Environment

To delete an environment:

  1. Navigate to Tools > EDC Tools.
  2. Click to open the Study Master containing the environment you want to delete.
  3. Locate the Environment in the list.
  4. Hover over the Environment to display the Actions menu.
  5. From the Actions menu, select Delete.
  6. In the Delete Environment dialog, click Delete. Vault begins a job to delete your Environment. When finished, Vault sends you an email notification.

Environment Type Limits

The following limits apply for study instances:

Type Limit
Development 2
UAT 5
Training 2
Production 1

Deployment History

You can use the Deployment History to view a listing of all deployment events related to your Study. See Using Deployment History for details.

Deployment History action

Which permissions control your access depends on when your vault was created. If your vault uses the Role by Study feature, see the first section, Role by Study Permissions. If your vault does not use the CDMS Role by Study feature, see the second section, Profile Permissions.

Role by Study Permissions

Users with the CDMS Deployment Administrator study role can perform the actions described above by default. If your vault uses custom Study Roles, your role must grant you the following permissions:

Type Permission Label Controls
Functional Permission EDC Tools Tab

Ability to access the EDC Tools tab

Functional Permission Manage Study Deployments

Ability to create and manage study Environments and deploy Studies from EDC Tools

Learn more about Study Roles.

Profile Permissions

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


Last Updated: