To prepare Compass:

1. Create a Standard User for Compass.

2. Select the API Access check box on the Compass User Creation page.

3. Define the cohort definitions for your Compass query.

To prepare Vault CRM:

1. Create or load your Analytic Product Groups, based on the cohort definitions, to define your market and the associated products you plan to visualize in the data. This includes your company’s products and any competitor products you want to compare them to.

2. Ensure each account for which you want to see data has a value in the matchid__v or npi__v field on the account__v object. The Match ID or NPI are required to match the Vault CRM account to the Compass claim.

To configure Vault CRM to Integrate Compass Data:

1. Log into Vault CRM.

2. Create an integration user for Vault CRM.

3. Grant the user the following permissions:

   Object	Object Permissions	Object Types	Fields	Field Permissions
   account__v	R	n/a	npi__v matchid__v	Read
   territory__v	R	n/a	name__v	Read
   account_territory__v	R	n/a	account__v territory__v	Read
   analytics_product_group__v	R	n/a	parent_product_group__v company_product_group__v market__v	Read

4. Navigate to Admin > Configuration

   

5. Select Data Engine Administration in the Application Configurations section.
   
6. Select Edit.
   
   

7. Enter the Compass User account credentials.

8. Select Connect. The Compass Instance ID is populated if the entered credentials are correct.

9. Enter the Vault CRM integration user credentials.

10. Select Save. The Compass Instance ID is populated when the user information is saved.

11. Select Validate Credentials to verify the Vault CRM user account credentials.

To configure Compass to integrate data with Vault CRM:

1. Log into the Compass Portal as the Compass user.

2. Define the query job in Compass. Ensure the following settings:

• Veeva Compass Patient
• Returned Records - select Exact Match
• Delivery Schedule - select Daily
• Time Frame for Qualification Criteria - enter dates from the 25 months prior to the current month, for example, From: 01/01/2021 To: 02/01/2023
• Time Frame for Returned Records - ensure the Return transactions for the same time frame used to identify qualified patients check box is selected
• Delivery Location - select Vault CRM
• Time Frame for Deliveries - select Last 3 months
• Schema - customers upgraded to Vault CRM 25R1.0 or later can select a data schema version:
• Patient Schema V2 (to be retired April 2026)
• Patient Schema V3

New customers on Vault CRM 25R1.0 or later use Patient Schema V3.

• Veeva Compass Prescriber
• Delivery Location - select Vault CRM
• Frequency of Delivery - select Monthly
• Time Frame for the Data - select Last 12 months
• Schema - customers upgraded to Vault CRM 25R1.0 or later can select a data schema version:
• Prescriber Schema V1 (to be retired April 2026)
• Prescriber Schema V2

New customers on Vault CRM 25R1.0 or later use Prescriber Schema V2.

• Veeva Compass Zip
• Delivery Location - select Vault CRM
• Frequency of Delivery - select Monthly
• Time Frame for the Data - select Last 12 months
• Schema - customers upgraded to Vault CRM 25R1.0 or later can select a data schema version:
• Zip Schema V1 (to be retired April 2026)
• Zip Schema V2

New customers on Vault CRM 25R1.0 or later use Zip Schema V2.

To configure Vault CRM to Integrate Compass Data:

1. Ensure Configuring X-Pages is complete.

2. Ensure Configuring X-Pages Studio is complete and an X-Pages Studio domain has been created.

Several X-Pages Studio page templates are available for content creators to start with when creating an X-Page that displays Compass patient data and aggregated prescription and medical claim data at the HCP and product level:

• Using the Diagnosed Patient Page Template - Available August 21, 2025
• Using the Market Trend Page Template - Available August 21, 2025
• Using the Compass Prescriber Data Page Template - Available August 21, 2025

Content developers can create and deploy a custom X-Page that uses the queryDataEngine method and the getAlignedTerritories function. See the Veeva Javascript Library for more information.