Comparing Casebook Versions in Studio


You can run a report to show the differences between two Casebook Definitions or two Casebook Definition versions. This illustrates added, removed, and changed design components. You can also compare two different versions across two different vaults.

By comparing versions, you can more easily identify changes and required actions across versions. For example, you may want to compare the current version in your production vault to a newer version in your development vault. You can use the comparison report to identify all the changes and share that information with a study administrator.

The report includes any changes to values in the Properties panel or other object fields, for example, changing an Item Type from EDC to Read-Only. The report does not include the changes to the following properties:

  • ID
  • Version Number
  • Private Key
  • Created By
  • Created Date
  • Last Modified By
  • Last Modified Date
  • Status
  • Study

Accessing Studio

To access the Studio study design and configuration area, click the Studio tab in the primary navigation bar.

Access Studio from the Studio tab

Once you click the Studio tab, Vault opens the My Studies page, a listing of Studies in your vault. By default, this page shows automated deployment studies. You can select the Manual radio button to show your manual deployment Studies (those studies created prior to the 19R3 release that have not been upgraded to automatic deployments), or navigate to those manual studies directly from the breadcrumb menu.

Use the Automatic and Manual buttons to switch the deployment types
Use the Automatic and Manual buttons to switch the deployment types

From the My Studies page, you can click a Study Master to open the Study Instances page. Then, you can click a Study Instance to open Studio for that instance. For manual deployment Studies, clicking the Study opens the Studio area for that study right away.

How to Compare Single Versions

To compare casebook versions:

  1. Navigate to the Study containing the version you want to compare.
  2. From the Actions menu, choose Compare Single Casebook Versions. Compare Versions action

  3. In the Select First Version dialog, click to select the version you want to compare another version to. Select First Version dialog

  4. Click Next.
  5. In the Select Second Version dialog, choose Current vault to select another version from the current vault, or choose Another vault to choose a version from a different vault.
  6. To compare in the Current vault:
    • Choose a Study.
    • Click to select a version to compare against. Select Second Version dialog to select from the Current Vault
  7. To compare in Another vault:
    You can only compare between vaults that are on the same POD. You can’t compare between a general release vault and a limited release vault.
    • Enter your User Name, Password, and the URL (the DNS entry for the target vault).
    • Click Connect.
    • If you have access to more than one vault in the target domain, select a Vault.
    • Select a Study.
  8. Click Next.
  9. In the Select Options dialog, you can configure additional options for your comparison report:
    • Select Exclude Order to include changes to layout order in the report.
    • Select Include “Same” records (only show differences) to include records that are unchanged between versions
    • Select checkboxes to indicate which worksheets to exclude from your report. The options available depend on your vault’s configuration. Select Options dialog for Compare Versions
  10. Click Submit.
  11. Vault begins the job. When finished, Vault sends you an email notification with a link to download the job log and any relevant output files.
  12. Click Close.

About the Output File

When the version comparison job finishes, Vault generates an Excel™ file containing your report. You can download this output file from the email notification.

The Excel™ workbook contains the following worksheets:

Worksheet Description
Summary

Contains high-level details about your casebook version, including the number of definitions that changed between the two versions you’re comparing.

Schedule

Displays all definition object records and their difference status (either Same or Modified) in the order that they appear in your study’s schedule, including multiple rows for reused definitions.

Form Impact

Displays a row for each Form in the Study and a column for each Event, with a marker indicating which Events contain which Forms. This worksheet does not use difference statuses or present and not present. Instead, this worksheet highlights changed markers in pink.

Detail

Displays all definition object records and their difference status. Each object record only displays once per study, even if you reuse it.

Item Group Defaults

Displays details about the Default Data configuration for each repeating Item Group and the difference status.

Codelist and Unit

Displays all codelist and unit definitions in the Study, their items, and their difference status.

Rules

Displays a list of all Rules within your study, including rule configuration details and the difference status.

Because rules aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.

Study Settings

Displays the study’s settings, including settings from the Study Configuration record and the study’s Signature Definition, and their difference status.

Because Review Plans aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.

Coding Configuration

Displays coding configuration details from Medical Coding Item Definition object records and their difference status.

Views

Displays the View Set Definition configurations between the two studies and their difference status.

Because views aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.

Reviews

Displays Review Plan Item Definitions, grouped by Review Plan, and their difference status.

Because Review Plans aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.

How Vault Indicates Changes Across Versions

Vault notes changes between casebook versions in two ways: by setting a difference status and by indicating “Present” or “Not Present”.

Difference Statuses

When a record is unchanged between casebook versions, Vault marks it as Same in the comparison report. If a record changed, Vault marks it as Modified. For example, if you updated the Short Label of a Form Definition in your new version, Vault would mark it as Modified.

For new and deleted records, Vault marks those records’ Difference as either New or Deleted.

By default, Vault does not include same, or unmodified, records in the report. If you select the Include “Same” records (only show differences) checkbox, your comparison report will include both records with the Same and Modified difference statuses. Reports with this option only show records that were modified.

Present & Not Present

You may also add or remove certain records between versions. Vault indicates this difference using Present and Not Present for each record in the first and second version you’re comparing.

For example, if you added a new form to your study, Vault would mark the form as Not Present in the first version and Present in the second version. If you removed a form, Vault would mark the form as Present in the first version and Not Present in the second version.

Reuse in the Schedule Worksheet

In the Schedule worksheet of the report, if you reuse a component in your study, for example, a Vitals form, Vault only lists that reused component in its entirety once. For each reuse, Vault will list the record and any unique information for that instance, but for the remainder of the record’s information, Vault will list it as All From Above.

Comparing Against Standards Libraries (Form-based Comparison)

Your organization might include a “study” that contains only Forms and their Items, to represent a library of standard forms for use in other studies.

You can compare your version against this library study to easily evaluate the Forms. When initiating the comparison, select the Exclude Event Group and Event Differences (show only form differences) checkbox and select the following checkboxes to exclude these sections: Rules, Study Settings, Coding Configuration, and Review Plans.

This option is only available for single version comparison, not full study comparison.

How to Compare Studies (All Versions)

In addition to comparing single casebook versions, you can also compare two Studies, with all of their respective versions, at once. This is especially useful for comparing your Study to a “standards” Study, to verify that you have all of the intended Forms in your design.

  1. Navigate to the Study that you want to compare to another Study.
  2. From the Actions menu, choose Compare Full Study (All Versions). Vault automatically selects the current Study and opens the Select Second Version dialog. Compare Full Study (All Versions)

  3. In the Select Second Version dialog, choose Current vault to select another Study from the current vault, or choose Another vault to choose a _Study _from a different vault.
    • To compare in the Current vault, choose a Study.
    • To compare in Another vault, enter your User Name, Password, and the URL (the DNS entry from the target vault). Click Connect, select a Vault (if you have access to more than one vault on the target domain), and select a Study.
  4. Click Next.
  5. In the Select Options dialog, you can configure additional options for your comparison report:
    • Select Exclude “Order” in the Schedule tab to exclude include changes to layout order in the report.
    • Select Include Skip “Same” records (show Modified and Same records) to include records that are unchanged between versions
    • Select checkboxes to indicate which worksheets to exclude from your report. The options available depend on your vault’s configuration.
  6. Click Compare.
  7. Vault begins the job. When finished, Vault sends you an email notification with a link to download the job log and any relevant output files.
  8. Click Close.

About the Output Files

Vault creates one Excel™ workbook for each version, and then another workbook to contain “versionless” object record comparisons (such as study settings and Review Plans).

Worksheet Description
Version Workbooks
Summary Contains high-level details about your casebook version, including the number of definitions that changed between the two versions you’re comparing.
Schedule Displays all definition object records and their difference status (either Same or Modified) in the order that they appear in your study’s schedule, including multiple rows for reused definitions.
Form Impact Displays a row for each Form in the Study and a column for each Event, with a marker indicating which Events contain which Forms. This worksheet does not use difference statuses or present and not present. Instead, this worksheet highlights changed markers in pink.
Detail Displays all definition object records and their difference status. Each object record only displays once per study, even if you reuse it.
Item Group Defaults Displays details about the Default Data configuration for each repeating Item Group and the difference status.
Codelist and Unit Displays all codelist and unit definitions in the Study, their items, and their difference status.
Versionless Workbook
Study Settings

Displays the study’s settings, including settings from the Study Configuration record and the study’s Signature Definition, and their difference status.

Because Review Plans aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.

Review Plans Displays Review Plan Item Definitions, grouped by Review Plan, and their difference status.
Views

Displays the View Set Definition configurations between the two studies and their difference status.

Because views aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.

Rules <p>Displays a list of all Rules within your study, including rule configuration details and the difference status.</p><p>Because rules aren’t versioned, Vault only shows differences for rules when comparing Studies, for example, comparing your Study in your UAT vault and your Production vault.</p>
Coding Configuration Displays coding configuration details from Medical Coding Item Definition object records and their difference status.

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 standard Vault Owner or Design security profiles can perform the actions described above by default. If your vault uses custom security profiles, you must have the permissions described in the Profile Permissions table.

Profile Permissions

Users with the Vault Owner security profile are automatically able to perform the actions described above.

If your vault uses custom security profiles, you must have the following permissions:

Type Permission Controls
Security Profile Tabs: Studio Ability to access the Studio tab in Vault EDC

Learn more about permissions sets.


Last Updated: