Sandbox Environment - Updating Active Studies and Surveys

Modified on Thu, 4 Sep at 10:48 AM

Learn how the Sandbox Environment is used for seamless testing and deployment of updates in active studies and surveys.


TABLE OF CONTENTS


In clinical research, ensuring study integrity while making necessary amendments is crucial. The Sandbox Environment provides a secure, controlled space for testing changes before applying them to a live study or survey. This feature allows project configurators to create a mirror environment of an active project, where they can test updates, enroll test subjects, and validate workflows - without impacting real data.


With the sandbox, users can:

  • Safely test amendments before rolling them out.
  • Ensure compliance and accuracy by preventing unintended changes.
  • Conduct user acceptance testing (UAT) in a realistic setup.
  • Easily apply approved changes to the active project when ready.


The sandbox remains synchronized with the active study or survey, ensuring an up-to-date testing environment. Once the changes are validated, users can either publish them directly to the active project or discard the sandbox if modifications are no longer needed. In the following sections, the sandbox environment is explained with a focus on the study module; however, the same principles apply to Climedo’s survey module.


1. How to use the sandbox?


1.1. Creating a sandbox environment


Navigate to the General Step 1 of the Study Settings of an active study. Click "Create Sandbox" to generate a sandbox environment that mirrors the settings of the active study. 

Please note that the initial creation of a sandbox may take up to a few minutes, depending on project complexity.
Confirm the creation of the sandbox environment in the pop-up.



Good to know: A sandbox can be created at any time for an active project by collaborators with the appropriate management rights (Please refer to section 3 below!). It mirrors the settings of the active study, including all configuration steps such as 1. General, 2. Forms, 3. Access - Roles, 4. Workflows, 5. Trigger Events, and 6. Translations.



1.2. Identifying the sandbox environment


A banner or visual indicator is shown on all screens to clearly distinguish the sandbox from the active study. This applies to all setting screens, as well as ePRO and self-registration screens for sandbox test subjects.
Users can seamlessly switch between active and sandbox settings/views using the top navigation bar.




1.3. Modifying study settings in the sandbox


Project configurators can make updates over an undefined timeline and save changes incrementally.

This includes all settings, incl. 

  • General settings
  • Access - roles
  • Forms - all options
  • Workflow - all options
  • Trigger Events - all options
  • Translations



Specifics

  1. Study Status: In the sandbox environment, the study status cannot be changed. As a result, this property is not visible within the sandbox.
  2. Access: 
    • Roles (role right settings in step 2) can be updated, created, and deleted within the sandbox. However, the addition, removal, or modification of collaborators and sites is only partially possible, as these changes are not part of an amendment.
    • When a sandbox is created, all available collaborators and sites are mirrored from the active study. (However, only users with the respective managament right in the active study have access to the sandbox. Please refer to section 3 below.) While a sandbox is open or active for a study, you can still add or update collaborators and sites in the active study without affecting the sandbox environment.
    • Sandbox access permissions (see section 3. below) determine which users can access and manage the sandbox. These users will be visible as active in the sandbox and site affiliations and role assignments can be modified for these collaborators for testing purposes only.
    • This means: Upon publishing changes, all role and site affiliation updates made in the sandbox will be reset, meaning these modifications will not be transferred to the active study. (For example, assume that in the active study you have the 'Project Manager' role, but in the sandbox you have assigned yourself the 'Investigator' role for testing purposes. Once the sandbox has been published, you will retain the 'Project Manager' role in the active study.)
  3. eConsent - eConsent setup in the sandbox follows specific rules. Please refer to eConsent setup specifics here for details.
  4. Randomization: 
    • The randomization list can only be updated in the sandbox, and if no subjects have been randomized yet in the active study.
    • If there are already randomized subjects in the active study, modifications in the sandbox are restricted to extending the randomization list.
    • For more details, see randomization specifics here.



1.4. Testing the updated study in the sandbox environment


The sandbox environment allows users to thoroughly test study updates before applying them to the active study. This ensures that all changes function as intended and meet compliance and quality standards. Users can perform various User Acceptance Testing (UAT) actions, including:

  • Enrolling test subjects to verify participant workflows.
  • Validating implemented changes to confirm their correctness.
  • Simulating workflow processes, such as data entry, monitoring activities, (S)AE actions, and exports.
  • Etc.

⚠️ It is important to note that certain project modules and functionalities are deactivated in the sandbox. Features that are not amendment-related, such as documents & files, dashboards, or reports, remain locked to maintain a focused testing environment.



1.5. Reverting or discarding the sandbox changes


If the changes made in the sandbox are no longer needed, users have the option to discard the sandbox, effectively resetting the environment. Only project configurators with the appropriate permissions (Publish or Create management rights – see section 3. below) can perform this action.



Key Considerations:

  • Discarding the sandbox does not impact the live study. The active study remains unchanged.
  • Once discarded, all changes made and saved in the sandbox are permanently lost. A confirmation popup will appear before finalizing this action.
  • Important: Test subjects created within the sandbox are not discarded or deleted. They will remain available if the sandbox is re-created, ensuring continuity for future testing.
  • It is suggested to set all test subjects to the subject status dropped to prevent any future scheduled ePROs or eConsent reminders to be sent out.
  • In the study overview in the sandbox tile, click on Open subject overview to create or view the test patients.


2. Publishing updates to the active study


2.1. Publishing the sandbox updates


Once all changes have been successfully tested, users can publish the changes. Only authorized users with the appropriate permissions can approve and apply these changes (see section 3 below).

Please note that the publishing action applies all updates made in the sandbox sequentially, meaning the amendments are processed step by step. As a result, the publishing process may take some time, depending on:

  • The number of updates made in the sandbox.
  • The complexity of the study setup.
  • The number of enrolled subjects affected by the changes.

Once published, all modifications from the sandbox are applied to the active study, including updates to study settings, subjects, and user roles, triggering the amendment process.


Important Considerations:

  • Changes may affect subjects, so it is strongly recommended to export study data before proceeding.
  • All role and site affiliation updates made in the sandbox are for testing purposes only and will be reset upon publishing or discarding the sandbox. These modifications will not be transferred to the active study, ensuring that any changes made to collaborators' roles or site assignments remain isolated within the sandbox and do not affect the live study setup.
  • If the publishing process fails due to rare issues, a clear error message will be displayed, providing guidance on the next steps.
  • Upon successful publishing, the publisher will receive an email confirmation with all details, including a timestamp and any comments added during the publishing process.
  • After publishing, users can re-create a sandbox at any time for future study updates.



3. Sandbox-specific management rights


There are two dedicated study management rights for managing the sandbox - "Create" and "Publish":


Create SandboxGrants a collaborator the ability to create a sandbox environment for active studies or surveys. This right is linked to the Study Management permission for "Study Settings," which enables access to sandbox creation. Additionally, users with either Create or Publish Sandbox rights can discard the sandbox.
Publish SandboxGrants a user the ability to publish changes from the sandbox to the active study or survey. This right is independent of other permissions, ensuring that only authorized users can finalize and push project updates. Additionally, users with either Create or Publish rights can discard the sandbox.


In order to access the sandbox environment from either the study card or the general setup, a user must have at least one of the following management view rights for the active study, which must be obtained before the sandbox is created: Collaborators, Roles, Sites, Input Forms & Fields, Study Settings, Randomization, or eConsent. Users who do not hold any of these rights will not see the sandbox access option. Once inside the sandbox, users can only view, update, or perform actions based on their assigned management rights, which apply uniformly across active studies/surveys and the sandbox environment.


View a detailed overview of the all management rights here.



Video


Take a look at our video tutorial on how to use the sandbox.







✉️ Still have questions? Feel free to contact your Customer Success Manager or email us at support@climedo.de.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article