Browsing Views

Views are virtual tables based on the result set of a CQL statement. A View can combine a View with other Views and Forms to create View Listings. Each view contains rows and columns, where the fields are from one or more real tables in the study database. A View Listing always shows up-to-date data, decorations, and access to the associated queries. Each time you open a view, Workbench recreates the data, using the view’s CQL statement.

You may use views to clean data from at the domain level, for example, cleaning all data related to vital signs. EDC study designers often break out domain data into multiple Forms (for ease in data entry or for maximizing rule efficiency). So, your Study may use Views to collect that data into a single View.

Prerequisites

Required Permissions

Users with the standard CDMS Data Manager, CDMS Lead Data Manager, and CDMS Super User study roles can perform the actions described below by default. If your vault uses custom Study Roles, your role must grant the following permissions:

Type Permission Label Controls
Functional Permission Workbench Tab

Ability to access and use the Data Workbench application, via the Workbench tab
Functional Permission Browse View

Ability to access the Views tab within Workbench and browse Views. Ability to save a View as a Check

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

Learn more about Study Roles.

Accessing Views

You can access views from the Views area of CDB. You can navigate to the Views area from the Navigation Drawer () or, after you select your Study, from the Study menu () on the Studies page.

From the Views page, you can click a view’s Title to open the View. You can also open a View from the View menu:

  1. Navigate to Views for your Study.
  2. Locate the View that you want to open in the list.
  3. Hover over the Title to show the View menu.
  4. From the View menu, select Open.

Search for a View

You can search for a specific view, using the Title, Category, Objective, Description, and Source columns. This search uses “contains”.

To search:

  1. Navigate to your Study in Workbench.

  2. In the top navigation bar, click Search ().

  3. By default, Workbench searches across all object types. You can select and clear checkboxes in the Type drop-down to change which objects Workbench is searching.

  4. Select the Column to search. The default is Title.
  5. Enter your Search Text.
  6. Click Search or press Enter to search.
  7. Click the view Title in the Results section to open it.

Workbench shows your search results in the Results section of the Search panel.

Click Close () to close the Search panel.

Sort & Filter the View List

You can sort and filter the Views page by the following columns:

  • Title
  • Category
  • Objective
  • Created On
  • Created By
  • Modified On
  • Modified By
  • Last Uploaded

If a column already has a sort or filter applied, Workbench shows the Sort icon ( for ascending or for descending) and the Filter icon (filter_list). You can click these in the Column Header to edit the sort or filter. You can also sort and filter columns that don’t already have a sort and filter.

How to Sort

To sort the Views page:

  1. Navigate to the Views page for your Study.
  2. Locate the column you want to sort by.
  3. In that column, hover to show the Sort & Filter button.
  4. Click Sort & Filter (filter_list).
  5. Click to expand Sort by.
  6. Select Ascending or Descending for the sort order.

How to Filter

To filter the Views page:

  1. Navigate to the Views page for your Study.
  2. Locate the column you want to sort by.
  3. In that column, hover to show the Sort & Filter button.
  4. Click Sort & Filter (filter_list).
  5. Click to expand Condition.
  6. Select an Operator. Workbench uses the entered Value and chosen Operator to compare the values within the column. Learn more about the available comparison operators in the CQL Reference.
  7. If required, enter a Value compare values against. Note that you can only use a static value and not a function. For dates, use the YYYY-MM-DD format.
  8. Click OK.

How to Reset a Filter

To reset (remove) a filter from a column, open the Sort & Filter menu and click Clear.

Hide View Columns

You can hide and show columns as needed without removing them from your view using the Hide Columns option.

This setting persists across the object and Study until you unhide the columns.

CDB represents hidden columns with an orange, dotted line. CDB shows one dotted line for each set of hidden columns (columns next to each other that are all hidden).

To hide a column:

  1. Navigate to your view.
  2. Hover over the Column Header to show the Sort & Filter menu (filter_list).

  3. Click Hide Column.

  4. CDB hides the column. Hidden columns are indicated by a dotted orange line. Click Unhide Columns to show all hidden columns.

Show the CQL for a View

To show the CQL for a view:

  1. Navigate to Views for your Study.
  2. Locate the View that you want to check in the list.
  3. Hover over the Title to show the View menu.
  4. From the View menu, select Show CQL.

Favorite Views

You can mark viewss as favorites to easily access them later from the Favorites menu.

To mark a views as a favorite:

  1. Navigate to the views that you want to favorite.

  2. Click Add to Favorites ().

  3. You can now access it from the Favorites menu ().

To remove it from your favorites, click Remove from Favorites (), or click Remove () for it in the Favorites menu.

To access your favorites, click to open the Favorites menu () in the top navigation bar after selecting a Study.

You can click the linked Object Name to open that views.

You can filter the list of objects by type.

Browsing View Data

View Header

The View page’s header displays the Category and Associated Forms for the view. The Category is automatically set to layers View , and CDB generates the list of Associated Forms based on the Forms referenced in the FROM clause.

Datasheet

Each view represents the results of a CQL query or set of queries. Workbench displays those results in the Datasheet of the view. Depending on the size of the data set, you may have to scroll horizontally to view all data for a row.

Resizing Columns

To set column widths:

  1. Hover over the line between two columns.
  2. Click and drag the line to resize the columns.

Pagination

CDB displays up to 50 rows per page in a listing. Use the left and right Arrow buttons to move between pages. To go directly to a page, enter the Page Number and press Enter.

Review CQL in the CQL Editor

You can review the CQL statement for a View in the CQL Editor, as well as the reference CQL statement for the listing the View was created from.

To open the CQL Editor, click CQL Editor. You can drag the orange border of the CQL Editor to change the size of the panel. Click Pop Out () to open the CQL Editor in a separate browser window.

Click CQL Editor and Reference CQL to switch between the two CQL statements in the editor.

Pin Columns in a View

You can pin columns in your view so that those columns remain visible even when you scroll to the right.

To pin columns:

  1. Navigate to the View you want to work with.
  2. Click push_pin Columns.
  3. Select a Number of columns to pin. This is a count of columns from the left, the leftmost column being 1.
  4. Click outside of the Pin Columns menu to close it.

Workbench pins the columns, showing a bolded border on the right side of the rightmost pinned column.

Generate CSV for a View

You can download a view as a CSV file.

To generate a CSV for a view:

  1. Navigate to Views for your Study.
  2. Click to open the View you want to download.
  3. From the View menu (), select Generate CSV.
  4. Workbench shows a toast notification at the bottom of the screen when your CSV file is ready to download. Click the CSV generated link to download.

Workbench also allows you to download the most recently generated CSV file from the Views listing. Click Download () in the Lastest Download column.