You can configure safety views in Veeva Safety Signal by defining data parameters such as SQL queries and filter criteria. Vault uses this configuration when running Signal Calculations to detect Product-Event Combinations (PECs) for different data sources (for example, Safety or pharmacovigilance data). Safety views are organised in a structured hierarcy to facilitate data analysis across a broader population as well as for a more targeted subset.

After completing the configurations in this article, you can add filters to support safety views.

About Safety Views

Signal includes the following safety views:

  • Principal Views: Contain the largest collection of data and preconfigured parameters. For example, a Principal View might include data for all postmarket Cases with the Drug product type. Vault derives all Filter Views and Signal Views from a Principal View. Principal Views are important as some statistical methods and calculations require a complete dataset.
  • Supporting Views: Provisioned by your Veeva Representative to support Principal Views. This view type provides a subset of data for Principal Views to use in report generation, for example, expectedness information.
  • Filter Views: Contain a subset of data from a specified Principal View and filters. For example, a Filter View might filter on a Product Family with a given start date. Vault derives a Filter View from a Principal View. Filter Views offer more specific analyses and can detect adverse events within a Product Family from a given period.
  • Signal Views: Contain the most specific subset of data in the view hierarchy. For example, a Signal View might return Case counts for all pediatrics in this quarter. Vault derives a Signal View from a Principal View and a Filter View.

About Dynamic Parameter Mapping

When running Signal Calculations, Vault can dynamically map filter values from certain object fields. For example, instead of filtering for Cases with a fixed Product Family value, Vault can filter for Cases using the Product Family from the Signal Reporting Period. You must appropriately configure Workbench View Parameters to use this functionality.

Configuration Overview

Configuring your Vault to use safety views involves the following steps:

  1. Configure object layouts
  2. Create safety views
  3. Run and preview the configuration
  4. Configure Admin permissions

Configuring Object Layouts

You must configure the following object layouts: 

Configuring the Workbench View Object Layouts

To allow users to enter filter values that can be queried by SQL on Signal Calculations associated with safety views, update the Principal View and Filter View object type layouts on the Workbench View object by inserting the Workbench View Parameter related object section and populating fields as follows:

  • Section Label: Enter View Parameters
  • Creation Option: Select Create record in pop-up dialog

Configuring the Workbench View Parameter Object Layout

To support dynamic parameter mapping, update the Workbench View Parameter object layout by adding the Default Value Object and Default Value Object Field after the Safety Object Reference field.

Creating Safety Views

To create a safety view:

  1. Navigate to Business Admin > Objects > Workbench Views.
  2. Select Create.
  3. In the Create Workbench View dialog, specify the type of view you want to create and then select Continue.
  4. Complete the following information about the safety view in the Details section:
    • Name: Enter a Name for the safety view.
    • API Name: Enter an API Name for the safety view. The API Name cannot include spaces and must end in __c.
    • Description: Enter a Description for the safety view.
    • Data Source: Select a Data Source from the drop-down or use the Advanced Search (binoculars-icon) icon to use filters and refine your search.
    • View Tag: Select a tag from the picklist to organize this safety view. Add values to the Workbench View Tag picklist as needed.
    • Signal Case Series Enabled: This checkbox appears only for the Signal View type and is for creating Signal Case Series-enabled views.
  5. Select Save.

Next, configure the following sections according to your business needs: 

Dependent Views

Signal Views and Filter Views are always dependent on another safety view, meaning they derive their data and configuration parameters from the specified safety view. The safety view on which the Signal or Filter View is dependent is known as a dependent view. A Signal View is usually dependent on a Principal View, a Filter View, or both. A Signal View can also be dependent on other Signal Views and multiple Filter Views. A Filter View is always dependent on a Principal View.

Principal Views are the basis for Filter and Signal Views to add filters and configuration and, therefore, are not dependent on any views.

The following illustration demonstrates an example of a safety view hierarchy. The hierarchy always starts with a Principal View. In this example, a Principal View leads into two Filter Views. Each Filter View subsequently leads into two Signal Views.

saf-signal-safety-view-hierarchy

Although a Signal View may not always include a Principal View in the Dependent Views section, a Signal View must ultimately be associated with one unique Principal View through other dependent views. In the above example, Signal Views A.1 and A.2 are not directly associated with the Principal View but are associated with it through Filter View A. If a safety view is not associated with any or is associated with more than one Principal View, Vault prevents you from adding filters to the safety view.

Creating a Dependent View

To add a dependent view:

  1. In the Dependent Views section of the safety view, select Create.
  2. In the Create Workbench View Dependency dialog, select a dependent view.
  3. Select Save or Save + Create to add another dependent view.

Vault adds the selected views to the Dependent Views section and generates a name for each. The current view is now dependent on these selected safety views.

SQL Editor

SQL offers elaborate queries for parsing through data. You or your Veeva Representative can provide and input queries in the SQL Editor section. The queries are based on Amazon Redshift SQL, which is a subset of PostgreSQL 9.x. For more information on the available SQL functions, refer to Amazon Redshift and PostgreSQL. You can enlarge the SQL Editor section by selecting the Full Screen (maximize-sql-icon) icon.

Only Principal Views and Signal Views contain SQL. When previewing a Filter View, this view inherits queries from the associated Principal View.

The SQL query provides references for the fields specified in the safety view’s Workbench View Columns section. If you run a preview of the safety view without any Workbench View Columns, all fields returned by the SQL query will be displayed in the preview.

The safety view can also leverage another safety view by referencing the safety view’s API Name in the SQL Editor section, for example, select * from ${safety_view_api_name__c}. You must also create a dependent view for the safety view you are referencing.

Consider the following SQL limitations and restrictions:

  • Vault does not perform timeout checks when running SQL. Long-running queries will be terminated by Amazon Redshift. Related performance issues are identified through logged server errors.
  • The query size limit is 32,000 characters.

SQL Editor Search Panel

You can open the SQL Editor search panel by using the  Ctrl + f or Cmd + f keyboard shortcut, as applicable. Using the search panel, you can find or replace specific texts and syntax elements. The panel also includes the following settings:  

  • Match case: Select this checkbox to make your keyword case sensitive.
  • Regexp: Select this checkbox to use regular expressions.
  • By word: Select this checkbox to search for whole words only. For example, if your keyword is filter, Vault excludes elements such as filterview.

View Columns

The View Columns are required for the safety view’s SQL to run successfully. The fields you add to a safety view’s View Columns section determine the fields to which you can apply filters. The View Columns section is usually populated in the Principal View to inform the filters in the subsequent Filter Views.

Supported field types include:

  • Text
  • Date
  • DateTime
  • Number
  • Yes/No
  • Object
  • Picklist
  • Multi-Value Picklist
  • MedDRA

Creating View Columns

To populate the View Columns section:

  1. In the View Columns section, select Create.
  2. Complete the following fields in the Create Workbench View Column dialog:
    • Name: Enter the Name of the view column.
    • API Name: Enter the API Name of the view column. This value must match the name of the column returned by the SQL query.
    • Column Type: Select a field type option from the drop-down.
    • Optional: Picklist: If you selected the Picklist column type, select a picklist option from the drop-down.
    • Optional: Safety Object Reference: The Safety Object Reference and Safety Object Constraint fields allow you to restrict the values that appear when filtering on this object. For example, you can restrict the Controlled Vocabulary object to display only Drug Roles. Enter the API name of the object associated with this view column field.
    • Optional: Safety Object Constraint: The Safety Object Reference and Safety Object Constraint fields allow you to restrict the values that appear when filtering on this object. For example, you can restrict the Controlled Vocabulary object to display only Drug Roles. Enter VQL to configure a reference constraint to restrict the object values.
    • Optional: Signal Case Series Key: This field is for Signal Views that should be executed as Signal Case Series. Ignore this field if it is not applicable. For more information, see Configure Safety Views for Signal Case Series.
    • Optional: Case Version Key: This field is for Signal Views that should be executed as Signal Case Series. Ignore this field if it is not applicable. For more information, see Configure Safety Views for Signal Case Series.
  3. Select Save.
  4. Repeat the steps above to add additional columns.
  5. Optional: To delete a field, select the Actions menu next to the field and then select Delete.

View Parameters

When users apply filters to Signal Calculations, the data set can change before the safety view SQL queries them. Using view parameters, users can enter filter values on the Signal Calculation that can then be referenced directly by the safety view’s SQL. View parameters appear in the Filters section under the Criteria subsection of the Signal Calculation.

Creating or Adding Workbench View Parameters

To create Workbench View Parameters:

  1. In the Workbench View Parameters section, select Add.
  2. In the Search: Workbench View Parameter dialog:
    1. Filter for and select existing parameters.
    2. Select Create. Complete the applicable fields and then select Save or Save + Create to save the record and create another.
  3. Select OK.

Workbench View Parameter Fields

The following fields may be available:

Field Description
Name Enter a name for the Workbench View Parameter.
Description Enter a description for the Workbench View Parameter.
API Name Enter an API name for the Workbench View Parameter ending in __c.
Optional Select Yes if the parameter is not required for the report to run. Leave this field as No if the parameter is required.
Column Type Select a field type option from the drop-down.
Allow user to select multiple values If the Column Type is either Picklist or Object, you may select Yes to allow users to select multiple values for this Workbench View Parameter. Otherwise, select No.
Picklist Reference This field allows you to restrict the values that users may enter. Enter the API Name of the desired picklist.
Safety Object Constraint The Safety Object Reference and Safety Object Constraint fields allow you to restrict the values that appear when filtering on this object, for example, restricting the Controlled Vocabulary object to display only Drug Roles. Enter the API Name of the object associated with this view column field.
Safety Object Reference The Safety Object Reference and Safety Object Constraint fields allow you to restrict the values that appear when filtering on this object, for example, restricting the Controlled Vocabulary object to display only Drug Roles. Enter VQL to configure a reference constraint to restrict the object values.
Default Value Object

This field is required if you populate the Default Value Object Field.

Enter the API name of the object from which Vault will dynamically obtain the filter value for this Workbench View Parameter during scheduled or ad-hoc Signal Calculation runs. For example, if a Signal Calculation Run has a Product Family criteria filter (inherited from the safety view’s Workbench View Parameter) and you want Vault to retrieve the filter value from the Product Family field on the Signal Reporting Period object, enter the API name safety_investigation_reporting_period__v.

You can reference the following standard objects only: 

  • Signal Reporting Period (safety_investigation_reporting_period__v)
  • Signal Product Profile (signal_product_profile__v)

For an example on configuring safety views with this field to use dynamic parameter mapping, see the section below.

Default Value Object Field

This field is required if you populate the Default Value Object.

Enter the API name of the object field from which Vault will dynamically obtain the filter value for this Workbench View Parameter during scheduled or ad-hoc Signal Calculation runs. For example, if a Signal Calculation Run has a Product Family criteria filter (inherited from the safety view’s Workbench View Parameter) and you want Vault to retrieve the value from the Product Family field on the Signal Reporting Period object, enter the API name product_family__v.

You can reference any custom or standard field on the specified Default Value Object. 

For an example on configuring safety views with this field to use dynamic parameter mapping, see the section below.

Workbench View Parameters for Dynamic Parameter Mapping

If you want to configure Workbench View Parameters to dynamically map filter values from Signal Reporting Period and Signal Product Profile object fields instead of filtering for Cases with a fixed value, you must: 

  1. Create Workbench View Parameters.
  2. Add Workbench View Parameters to the appropriate safety views.
Creating Workbench View Parameters

To create Workbench View Parameters for dynamic parameter mapping: 

  1. Navigate to Business Admin > Objects > Workbench View Parameters and select Create.
  2. The table below describes example configuration for different parameter mapping scenarios. Use the table as guidance to complete the Workbench View Parameter fields.
Dynamic Mapping Scenario View Parameter Details Default Value Object Default Value Object Field
Map start date filter values from the Signal Reporting Period object’s Start Date
  • Name: Enter  Signal Reporting Period > Start Date
  • API Name: Enter  signal_reporting_period_start_date__c
  • Column Type: Select Date
  • Allow user to select multiple values: Select No
  • Optional: Select No
Enter safety_investigation_reporting_period__v Enter start_date__v
Map end date filter values from the Signal Reporting Period object’s End Date
  • Name: Enter  Signal Reporting Period > End Date
  • API Name: Enter  signal_reporting_period_end_date__c
  • Column Type: Select Date
  • Allow user to select multiple values: Select No
  • Optional: Select No
Enter safety_investigation_reporting_period__v Enter end_date__v
Map Product Family filter values from the Signal Reporting Period object’s Product Family
  • Name: Enter  Signal Reporting Period > Product Family
  • API Name: Enter  signal_product_family__c
  • Column Type: Select Object
  • Allow user to select multiple values: Select No
  • Optional: Select No
Enter safety_investigation_reporting_period__v Enter product_family__v
Adding Workbench View Parameters to Safety Views

After creating Workbench View Parameters for dynamic parameter mapping, you must add the view parameters to the appropriate safety views. The following table describes example configuration:

Dynamic Mapping Scenario Safety View View Parameters Filters
Return Cases with an Approval Date within the Signal Reporting Period start and end date range [Principal View] Add the Signal Reporting Period > End Date view parameter Add the following filter: Approval Date > is in the range (parameter) > [blank] - Signal Reporting Period > End Date

Return Cases with:

  • An Approval Date within the Signal Reporting Period start and end date range
  • A Product Family matching that of the Signal Reporting Period’s
[Interval Filter View]

Add the following view parameters: 

  • Signal Reporting Period > Start Date
  • Signal Reporting Period > End Date
  • Signal Reporting Period > Product Family

Add the following filters: 

  • Approval Date > is in the range (parameter) > Signal Reporting Period > Start Date - Signal Reporting Period > End Date
  • Product Family > equals (parameter) > Signal Reporting Period > Product Family
Return Cases with a Product Family matching that of the Signal Reporting Period’s [Cumulative Filter View] Add the Signal Reporting Period > Product Family view parameter Add the following filter: Product Family > equals (parameter) > Signal Reporting Period > Product Family

Filters

You can add filters in the Filters section of the safety view. Filters you add to the safety view also appear on associated Signal Calculation Run records. You can add safety view filters only if the View Columns section is populated on either the current safety view or on the associated Principal View.

Filter Fields Mapping

When scheduled Signal Calculations run, Vault can populate filter values based on either Workbench View Parameters or filter field mapping using view column API names.

When applying filters for view columns, Vault uses Signal Reporting Period fields as follows:

Signal Reporting Period Field View Column Filters Considerations
Start Date
  • reporting_period_start_date
  • case_approval_date
  • approval_date
  • new_info_date
  • receipt_date
  • case_adverse_event_onset_date
  • inactive_date
Filters must use the is after or is in the range operator.
End Date
  • reporting_period_end_date
  • case_approval_date
  • approval_date
  • new_info_date
  • receipt_date
  • case_adverse_event_onset_date
  • inactive_date
Filters must use the is before, is in the range, or equals operator.
  • datasheet_active_start_date
  • datasheet_active_end_date
  • meddra_criteria_active_start_date
  • meddra_criteria_active_end_date
Filters must use the is before or is after operator.
Product Family
  • product_family_id
Applies to the Object column type.
  • product_family_name
Applies to the Text column type.

Running and Previewing Configuration

You can generate a preview of the safety view by selecting Run in the Run Preview section. After you run the preview, Vault executes the SQL for this safety view and returns a list of up to 100 records. The output is displayed in a table format based on the view columns’s Column Type. Optionally, you can select the column header to sort the records returned by the run. If the SQL is invalid, Vault returns an error. Run Preview also times out after 300 seconds.

Configuring Admin Permissions

You must ensure Admins have Edit permissions to the Default Value Object and Default Value Object Field fields on the Workbench View Parameter object.