Study Deployment in Vault CDMS
You can move your study’s design and configuration from your development environment, through user acceptance testing (UAT) and training, and ultimately into your production environment via a process called “deployment”.
A deployment moves your study design and configuration from one environment to another. This process duplicates the Study, design definition records, the study schedule, form design, coding configuration, and more from a source environment to a target environment.
Automated & Manual Deployments
With the 19R3 release (December 2019), we released the “Automated Deployments” feature. Prior to this feature, a Studio user had to manually export an XML file containing the study design and configuration from their source environment and then manually import it into the target environment. Following that export and import, that user and a lead data manager had to perform additional configuration tasks before a study could be used in the target environment.
With automated deployments, a deployment administrator maintains multiple study “environments” for a study (development, UAT, training, and production). They can easily move a study design version as a “study package” from environment to environment with a single action , without the need to manually export and import any files.
How Automated Deployments Work
With automated deployments, your Study will typically exist on two separate vaults. One vault will contain your development, UAT, and training environments (your organization may choose to store UAT and training in additional vaults). The other vault is your “production” environment, where study execution and data collection will take place.
You create your study design in your development environment. When you’re ready, you can stage it to UAT to test your design. You can continue to iterate on your design by creating new versions in your development environment and re-staging to UAT.
When ready, you can stage from UAT and into your training environment to begin training your staff on the study’s design.
Lastly, you can publish your study design to your production environment to begin study execution.
How Manual Deployments Work
Manual deployments work similarly to automated deployments, except it is a manual process. Instead of using the deploy action, like automated deployments, you must manually export and import your study design as an XML file to move it from vault to vault
Upgrading from Manual to Automated Deployments
All Studies created after the 19R3 release are automatically on the new, automated deployment model. Any Studies create prior to the 19R3 release remain on the manual deployment model (export and import), unless the study undergoes an upgrade process with Veeva Services. Learn more about upgrading to automated deployments here.
TO upgrade your Study, it must be published in production with no pending changes in development. Your Study is also eligible for upgrade if it is still in development and has never been published to production.
Consider the following before upgrading:
- Your vaults must be connected before you can use deployments. Work with Veeva Services to perform this configuration.
- To be able to create new Studies, one of your vaults must be designated as the primary development environment. Work with Veeva Services to perform this configuration.
- If the new Study has an existing production environment, select it during Study creation. While a deployment administrator can create other environments (development, UAT, and training) after a Study is created, they can’t create a production environment.