Veeva Vault Connection Details
Introduction
Connector Version
This documentation is based on version 23.0.9039 of the connector.
Get Started
Veeva Vault Version Support
The connector leverages versions 21.1 and later of the VeevaVault API to enable bidirectional access to VeevaVault data.
Establish a Connection
Connect to Veeva Vault
In order to connect to your Veeva Vault account, you will first need to specify the URL
connection property to the host you see in the address bar after logging in to your account, ex. https://myvault.veevavault.com
.
OpenID Connect with Microsoft Entra ID
OpenID Connect with Microsoft Entra ID is a connection type that goes through OAuth. Set the AuthScheme
to AzureADOpenID
and the OpenIDConnectProfileID
connection property to the ID of your Open ID Connect profile, which can be found by navigating to Admin > Settings > OAuth 2.0 / OpenID Connect Profiles
and expanding the details of your OpenID Connect Profile.
Authenticate to Veeva Vault
There are two authentication methods available for connecting to your Veeva Vault data source, Basic and OAuth 2.0 / OpenID Connect with the Microsoft Entra ID Authentication Provider.
User Credentials
Set the AuthScheme
to Basic
and set the User
and Password
to your user login credentials.
OpenID with Microsoft Entra ID
OpenID Connect with Microsoft Entra ID is a connection type that goes through OAuth. Set the AuthScheme
to AzureADOpenID
. The following sections assume that you have done so.
Desktop Applications
Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom Microsoft Entra ID App. Get an OAuth Access Token
You are ready to connect after setting one of the below connection properties groups depending on the authentication type.
Authenticating using a Client Secret
OAuthClientId
: Set this to the Client ID in your app settings.OAuthClientSecret
: Set this to the Client Secret in your app settings.CallbackURL
: Set this to the Redirect URL in your app settings.InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
. .- Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the
Scope
property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
Authenticating using a Certificate
OAuthClientId
: Set this to the Client ID in your app settings.OAuthJWTCert
: Set this to the JWT Certificate store.OAuthJWTCertType
: Set this to the type of the certificate store specified byOAuthJWTCert
.CallbackURL
: Set this to the Redirect URL in your app settings.InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
. .- Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the
Scope
property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
to be persisted across connections.
Create a Custom Microsoft Entra ID App
Create a Microsoft Entra ID Application
Veeva Vault supports user-based authentication using Microsoft Entra ID. This authentication is OAuth-based.
To connect to Veeva Vault via the Web, you must always create a custom application, as described here.
Custom OAuth applications are useful if you want to:
- Control branding of the authentication dialog.
- Control the redirect URI that the application redirects the user to after the user authenticates.
- Customize the permissions that you are requesting from the user.
Authenticate With Microsoft Entra ID
In <https://portal.azure.com>:
-
In the left-hand navigation pane, select
Microsoft Entra ID > App registrations
. -
Click
New registration
. -
Enter a name for the application.
-
Specify the types of accounts this application should support:
- For private use applications, select
Accounts in this organization directory only
. - For distributed applications, select one of the multi-tenant options.
- For private use applications, select
Note
If you select Accounts in this organizational directory only
(default), when you establish a connection with Veeva Vault connector you must set AzureTenant
to the ID of the Microsoft Entra ID Tenant. Otherwise, the authentication attempt fails.
-
Set the redirect URI to
http://localhost:33333
(default) OR, if you want tospecify a different port, specify the desired port and set
CallbackURL
to the exact reply URL you just defined. -
To register the new application, click
Register
. An application management screen displays. Record these values for later use. (You will use theApplication (client) ID
value to set theOAuthClientId
parameters, and theDirectory (tenant) ID
value to set theAzureTenant
parameter.) -
Navigate to
Certificates & Secrets
. SelectNew Client Secret
for this application and specify the desired duration. After the client secret is saved, the Azure App Registration displays the key value. This value is displayed only once, so record it for future use. (You will use it to set theOAuthClientSecret
.) -
If you have specified the use of permissions that require admin consent, you can grant them from the current tenant on the API Permissions page.
Update Your Custom Microsoft Entra ID App
When to use a Custom Microsoft Entra ID App
Prior to using the app that you have previously created to configure the Microsoft Entra ID Authentication Provider for your Veeva Vault data source, you would need to update it to include a redirect URL. This way, the connector can retrieve the verifier code from the opened browser tab and complete the flow. To do this and to obtain the OAuth values for your app, the OAuthClientId
and OAuthClientSecret
, you can follow the steps as below.
Steps to update your Custom Microsoft Entra ID App
Follow the steps below to add a redirect URL and to obtain the OAuth values for your app, the OAuthClientId
and OAuthClientSecret
.
-
Log in to
https://portal.azure.com
. -
In the left-hand navigation pane, select Microsoft Entra ID, then App Registrations and click on the app you have previously created to configure the Azure
AD Authentication Provider.
-
From the Overview section, you can copy the Application (client) ID which corresponds to the
OAuthClientId
property. -
In the Certificates & Secrets section, you can optionally define a new app authentication type or use the already existing one. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate, but you can also create an application secret.
Option 1 - Upload a certificate
: In the Certificates & Secrets section, select Upload certificate and select the certificate to upload from your local machine.Option 2 - Create a new application secret
: In the Certificates & Secrets section, select New Client Secret for the app and select its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once, and it is used as theOAuthClientSecret
.
-
In the Authentication section, under the Redirect URIs of the existing Web platform, you can add a new redirect URL to something such as
http://localhost:33333
, the connector's default. Or, set a different port of your choice and setCallbackURL
to the exact reply URL you defined. -
Save your changes.
Important Notes
Configuration Files and Their Paths
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features
This section details a selection of advanced features of the Veeva Vault connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Veeva Vault and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views
The Veeva Vault connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Documents WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration
Customize the SSL Configuration
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Data Model
The Veeva Vault connector models Veeva Vault objects as relational views. A Veeva Vault object has relationships to other objects; in the views, these relationships are expressed through foreign keys. The following sections show the static endpoints of the Veeva Vault API.
However, the rest of the views are dynamically determined, using the metadata exposed on the Veeva Vault API. All vault objects will be exposed by the Veeva Vault connector. However, we only only list views in the help for types we can determine at design time all available columns. Examples of Veeva objects availabe with the Veeva Vault connector but not displayed in the help include:
Documents
(Query the available documents, VQL is used when possible for this object.)Users
(Query the exisiting users, VQL is used when possible for this object.)Groups
(Query the exisiting groups, VQL is used when possible for this object.){Every Vault Object}
(Query any vault object on its own view. VQL is always used to query Vault Object's views.)
About Veeva Vault Query
Veeva Vault Query (VQL) is a query language similar to SQL. It is available to use via the Veeva Vault API. When the query can be handled server-side, the provider transforms SQL to VQL and sends it to Veeva Vault. Optimizing in this way decreases the execution time, since the filtering will be done server-side.
Also, the provider supports QueryPassthrough, which means that you can write a VQL query and directly send it to Veeva Vault. This can be done by setting QueryPassthrough connection property to true.
Views
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Veeva Vault Connector Views
Name | Description |
---|---|
AuditHistory | Retrieve complete audit history for a single document or for a single object record. |
DocumentRelationships | Returns all relationships per each document. |
DocumentRoles | Manually retrieve assigned roles on a document and the users and groups assigned to them. |
DocumentUserActions | Retrieve all available user actions on specific versions of multiple documents or binders. |
Lifecycles | Retrieve brief details for the available lifecycles. |
ObjectRelationships | Returns all relationships per each object. An ObjectName is required to query this view. |
ObjectRoles | Manually retrieve assigned roles on an object record and the users and groups assigned to them. |
ObjectTypes | Returns brief details of all types an object can be. |
ObjectWorkflows | Retrieve the workflows of an object or the workflows of an user. |
ObjectWorkflowTasks | Retrieve the workflows of an object or the workflows of an user. |
AuditHistory
Retrieve complete audit history for a single document or for a single object record.
View Specific Information
Either the DocumentId column or the ObjectName and ObjectRecordId columns must be specified in order to query this view.
The connector will use the Veeva Vault API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the connector.
DocumentId
supports the=
operator.ObjectName
supports the=
operator.ObjectRecordId
supports the=
operator.StartDate
supports the=
operator.EndDate
supports the=
operator.
For example, the following queries are processed server-side:
SELECT * FROM AuditHistory WHERE DocumentId = '8'
SELECT * FROM AuditHistory WHERE ObjectName = 'product__v' AND ObjectRecordId = '00P000000000601'
SELECT * FROM AuditHistory WHERE DocumentId = '3258' AND StartDate = '2020-01-01T01:13:36' AND EndDate = '2020-01-06T01:3:32'
Columns
Name | Type | Description |
---|---|---|
DocumentId | String | Identifier of the document. |
ObjectName | String | The object Name. |
ObjectRecordId | String | Identifier of the object record. |
Id [KEY] | String | Identifier of the audit record. |
Timestamp | Datetime | The time and date of the preformed action. |
UserName | String | The name of the user responsible for the preformed action. |
FullName | String | The full name of the user responsible for the preformed action. |
Action | String | The name of the action performed on the object record or on the document. |
Item | String | The type and name of the affected record or the number field value of the affected Document. |
FieldName | String | The name of the affected field. |
OldValue | String | The previous field value before the executed action. |
NewValue | String | The actual field value after the executed action. |
ObjectLabel | String | The label of the affected object. |
MigrationMode | Bool | Indicates that the object record was created using the X-VaultAPI-MigrationMode header with a specified state__v value. |
WorkflowName | String | The name of the workflow that preformed the action. |
TaskName | String | The name of the preformed workflow task. |
Verdict | String | The verdict of the workflow task action. |
Reason | String | The reason of the workflow task action verdict. |
Capacity | String | The approval capacity of the workflow that preformed the action. |
SignatureMeaning | String | The reason a signature was required for any manifested signature. |
ViewLicense | String | Returns a value of View-Based User only when the user is assigned that license type. Otherwise, returns an empty string. |
JobInstanceId | String | The ID of the Job Instance that preformed the action. |
Version | String | The version of the affected Document. |
DocumentUrl | String | The URL of the affected Document. |
EventDescription | String | Description of the action that occurred. |
Pseudo-Columns
Pseudo-column fields are used in the WHERE clause of SELECT statements and offer more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
StartDate | Datetime | Specify a start date to retrieve audit history. This date cannot be more than 30 days ago. IIf not stated, defaults to the vault's creation date. |
EndDate | Datetime | Specify an end date to retrieve audit history. This date cannot be more than 30 days ago. If not stated, defaults to today's date. |
DocumentRelationships
Returns all relationships per each document.
View Specific Information
DocumentId, MajorVersion and MinorVersion must be specified in order to query this view. To find these values, you can execute the following query:
SELECT version_id FROM Documents
And version_id values are of this pattern: {DocumentId}_{MajorVersion}_{MinorVersion}
Some query examples:
SELECT * FROM DocumentRelationships WHERE SourceDocumentId = '122' AND MajorVersion = 1 AND MinorVersion = 0
SELECT * FROM DocumentRelationships WHERE SourceDocumentId = '101' AND MajorVersion = 0 AND MinorVersion = 1
Columns
Name | Type | Description |
---|---|---|
Id [KEY] | Integer | The ID of the relationship. |
SourceDocumentId | Integer | Identifier of the source document. |
TargetDocumentId | Integer | Identifier of the target document. |
Type | String | Type of the relationship. |
CreatedDate | Datetime | The datetime of when the relationship was created. |
CreatedBy | Integer | Identifier of the user who created the relationship. |
MajorVersion | Integer | Major version of the source document. |
MinorVersion | Integer | Minor version of the source document. |
DocumentRoles
Manually retrieve assigned roles on a document and the users and groups assigned to them.
View Specific Information
The connector will use the Veeva Vault API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the connector.
DocumentId
supports the '=' and 'IN' operators.
For example, the following queries are processed server side:
SELECT * FROM DocumentRoles WHERE DocumentId = '100'
SELECT * FROM DocumentRoles WHERE DocumentId IN ('99', '98', '876', '873', '867', '1')
It is recommended to specify DocumentId, otherwise the provider will make a request per each document, causing the execution of the query to take some time.
Columns
Name | Type | Description |
---|---|---|
DocumentId [KEY] | String | Identifier of the document. |
Name [KEY] | String | Name of the role. |
Label | String | Label of the role. |
AssignedUsers | String | Comma-separated list of user Ids. |
AssignedGroups | String | Comma-separated list of group Ids. |
AvailableUsers | String | Comma-separated list of user Ids. |
AvailableGroups | String | Comma-separated list of group Ids. |
DefaultUsers | String | Comma-separated list of user Ids. |
DefaultGroups | String | Comma-separated list of group Ids. |
DocumentUserActions
Retrieve all available user actions on specific versions of multiple documents or binders.
View Specific Information
DocumentId, MajorVersion and MinorVersion must be specified in order to query this view. To find these values, you can execute the following query:
SELECT version_id FROM Documents
And version_id values are of this pattern: {DocumentId}_{MajorVersion}_{MinorVersion}
Some query examples:
SELECT * FROM DocumentUserActions WHERE SourceDocumentId = '122' AND MajorVersion = 1 AND MinorVersion = 0
SELECT * FROM DocumentUserActions WHERE SourceDocumentId = '101' AND MajorVersion = 0 AND MinorVersion = 1
Columns
Name | Type | Description |
---|---|---|
DocumentId | String | Name of the action. |
Name | String | Name of the action. |
Label | String | Label of the action. |
ActionType | String | Type of the action. |
Lifecycle | String | Name of the lifecycle. |
State | String | State before the action is initialized. |
MajorVersion | Integer | Major version of the source document. |
MinorVersion | Integer | Minor version of the source document. |
Lifecycles
Retrieve brief details for the available lifecycles.
View Specific Information
The connector will use the Veeva Vault API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the connector.
Lifecycle
supports the=
operator.Role
supports the=
operator.
For example, the following queries are processed server side:
SELECT * FROM Lifecycles WHERE lifecycle = 'draft_to_effective_lifecycle_supporting__c'
SELECT * FROM Lifecycles WHERE Role = 'qa__vs'
Columns
Name | Type | Description |
---|---|---|
Lifecycle | String | Name of the lifecycle. |
Role | String | Role of the user that can use the lifecycle. |
AllowedUsers | String | Comma-separated list of names of the allowed users. |
AllowedGroups | String | Comma-separated list of names of the allowed groups. |
AllowedDefaultUsers | String | Comma-separated list of names of the default allowed users. |
AllowedDefaultGroups | String | Comma-separated list of names of the default allowed groups. |
ObjectRelationships
Returns all relationships per each object. An ObjectName is required to query this view.
Columns
Name | Type | Description |
---|---|---|
RelationshipName | String | Name of the relationship. |
RelationshipLabel | String | Label of the relationship. |
RelationshipType | String | Type of the relationship. |
Field | String | Type of the relationship. |
RelatedObjectName | String | Name of the object in the relationship. |
RelatedObjectLabel | String | Label of the object in the relationship. |
ObjectName | String | Name of the object. |
ObjectRoles
Manually retrieve assigned roles on an object record and the users and groups assigned to them.
View Specific Information
ObjectName and RecordId must be specified in order to query this view.
Note
In this provider vault objects are exposed as views. And the keys of these views corresponds to RecordId.
Some query examples:
SELECT * FROM ObjectRoles WHERE ObjectName = 'product__v' AND RecordId = '00P000000000201'
SELECT * FROM ObjectRoles WHERE ObjectName = 'activity__v' AND RecordId = '0AC000000001D27'
Columns
Name | Type | Description |
---|---|---|
RecordId [KEY] | String | Name of the role. |
ObjectName [KEY] | String | Name of the role. |
Name | String | Name of the role. |
Users | String | Comma-separated list of user Ids. |
Groups | String | Comma-separated list of group Ids. |
AssignmentType | String | Type of the assignment. |
ObjectTypes
Returns brief details of all types an object can be.
View Specific Information
No available server-side filters for this view.
Columns
Name | Type | Description |
---|---|---|
Name | String | The ID of the relationship. |
Object | String | Identifier of the source document. |
Label | String | Identifier of the target document. |
Active | Boolean | Type of the relationship. |
ObjectWorkflows
Retrieve the workflows of an object or the workflows of an user.
View Specific Information
ObjectName and RecordId or UserId must be specified in order to query this view.
Note
In this provider vault objects are exposed as views. And the keys of these views corresponds to RecordId here.
The connector will use the Veeva Vault API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the connector.
UserId
supports the '=' and 'IN' operators.ObjectName
supports the=
operator.RecordId
supports the=
operator.Status
supports the=
operator.
For example, the following queries are processed server-side:
Some query examples:
SELECT * FROM ObjectWorkflows WHERE UserId IN (SELECT id FROM Users)
SELECT * FROM ObjectWorkflows WHERE UserId IN ('1069977', '115731')
SELECT * FROM ObjectWorkflows WHERE UserId = '1069977'
SELECT * FROM ObjectWorkflows WHERE UserId = '349101' AND Status = 'completed__v'
SELECT * FROM ObjectWorkflows WHERE ObjectName = 'product__v' AND RecordId = '00P000000000201'
Columns
Name | Type | Description |
---|---|---|
Id [KEY] | String | Identifier of the workflow. |
Label | String | Label of the workflow. |
Status | String | Status of the workflow. |
Initiator | String | Identifier of the user who initiated the workflow. |
StartedDate | Datetime | Datetime when the workflow started. |
DueDate | Datetime | Datetime when the workflow is due. |
CompletedDate | Datetime | Datetime when the workflow was completed. |
RecordId | String | Identifier of the record of the object. |
ObjectName | String | Name of the object. Required if UserId not specified. |
UserId | String | Identifier of the user. Required if ObjectName not specified. |
ObjectWorkflowTasks
Retrieve the workflows of an object or the workflows of an user.
View Specific Information
ObjectName and RecordId or AssigneeId must be specified in order to query this view.
Note
In this provider vault objects are exposed as views. And the keys of these views corresponds to RecordId.
The connector will use the Veeva Vault API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the connector.
AssigneeId
supports the '=' and 'IN' operators.ObjectName
supports the=
operator.RecordId
supports the=
operator.Status
supports the=
operator.
For example, the following queries are processed server-side:
Some query examples:
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId IN (SELECT id FROM Users)
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId IN ('1069977', '115731')
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId = '1069977'
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId = '349101' AND Status = 'completed__v'
SELECT * FROM ObjectWorkflowTasks WHERE ObjectName = 'product__v' AND RecordId = '00P000000000201'
Columns
Name | Type | Description |
---|---|---|
Id [KEY] | String | Identifier of the workflow task. |
WorkflowId | String | Identifier of the workflow the task is in. |
Label | String | Label of the workflow task. |
Status | String | Status of the workflow task. |
Instructions | String | Instructions to follow. |
CreatedDate | Datetime | Datetime when the task was created. |
DueDate | Datetime | Datetime when the task is due. |
AssignedDate | Datetime | Datetime when the task was assigned. |
RecordId | String | Identifier of the record of the object. |
ObjectName | String | Name of the object. Required if UserId not specified. |
AssigneeId | String | Identifier of the user. Required if ObjectName not specified. |
Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Veeva Vault.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Veeva Vault, along with an indication of whether the procedure succeeded or failed.
Veeva Vault Connector Stored Procedures
Name | Description |
---|---|
CreateDocument | Create a single document. |
CreateDocumentVersion | Add a new draft version of an existing document. You can choose to either use the existing source file, or a new source file. These actions will increase the document's minor version number. This is analogous to using the Create Draft action in the UI. Note that not all documents are eligible for draft creation. For example, you cannot create a draft of a checked out document. |
DownloadDocumentFile | Download a document file. |
GetOAuthAccessToken | Gets the OAuth access token from the Microsoft Entra ID Authentication Provider. |
GetOAuthAuthorizationURL | Gets the Microsoft Entra ID authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to the Microsoft Entra ID Authentication Provider. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with the Microsoft Entra ID Authentication Provider. |
UpdateDocument | Update editable field values on the latest version of a single document. |
CreateDocument
Create a single document.
To find the API names of the Documents table, get the Description column for the table Documents:
SELECT Description FROM [sys_tablecolumns] WHERE TableName = 'Documents'
The Description column will contain the API names of the Documents table. Now, use these API names to update a document, for example:
EXEC CreateDocument File = 'C:/Users/Public/document1.docx', Type__v = 'Promotional Piece', Subtype__v = 'Advertisement'
Input
Name | Type | Required | Description |
---|---|---|---|
File | String | False | Optional. The filepath of the source document. For example, C:/Users/Public/Desktop/document.docx . The maximum allowed file size is 4GB. |
FileName | String | False | The file name including extension to be used for File or Content input. FileName is optional for File input, and required for Content input. |
\* | String | False | In the stored procedure's parameters, add the API name of any field values that are required to create a document. |
Result Set Columns
Name | Type | Description |
---|---|---|
ResponseStatus | String | Whether the document was created successfully. |
ResponseMessage | String | The message of the response. |
Id | String | The ID of the document. |
CreateDocumentVersion
Add a new draft version of an existing document. You can choose to either use the existing source file, or a new source file. These actions will increase the document's minor version number. This is analogous to using the Create Draft action in the UI. Note that not all documents are eligible for draft creation. For example, you cannot create a draft of a checked out document.
EXEC CreateDocumentVersion File = 'C:/Users/Public/document2.docx', DocumentId = '514', CreateDraft = 'uploadedContent', Description = 'This is a description', suppressRendition = 'true'
Input
Name | Type | Required | Description |
---|---|---|---|
DocumentId | String | True | The document ID field value. |
File | String | False | Optional. If createDraft=uploadedContent, use this parameter to include the new document source file. If your target document is a placeholder, use this parameter to upload a source file and create a new draft version of the document. |
FileName | String | False | The file name including extension to be used for File or Content input. FileName is optional for File input, and required for Content input. |
CreateDraft | String | False | latestContent - Create a new draft version from the existing document in the vault. This does not require uploading a file. This is analogous to the Copy file from current version option in the Create Draft UI. uploadedContent - Create a new draft version by uploading the document source file. This requires uploading a new source file with an additional file body parameter. The maximum allowed file size is 4GB. This is analogous to the Upload a new file option in the Create Draft UI. The allowed values are latestContent, uploadedContent. The default value is latestContent. |
Description | String | False | Optional. Add a Version Description for the new draft version. Other users may view this description in the document's Version History. Maximum 1, 500 characters. |
SuppressRendition | String | False | Set to true to suppress automatic generation of the viewable rendition. If omitted, defaults to false. The default value is false. |
Result Set Columns
Name | Type | Description |
---|---|---|
ResponseStatus | String | Whether the document was created successfully. |
ResponseMessage | String | The message of the response. |
MajorVersionNumber | String | The major version number of the document. |
MinorVersionNumber | String | The minor version number of the document. |
DownloadDocumentFile
Download a document file.
Example:
EXEC DownloadDocumentFile DocumentId = '1234', DownloadLocation = 'C:/Users/Public/cover.png'
Note about LockDocument: The user who checked the document out and the Document Owner can check it back in. If the user or Document Owner is not available then a Vault Owner or Administrator must undo the checkout. Otherwise, the document cannot progress.
Input
Name | Type | Required | Description |
---|---|---|---|
DocumentId | String | True | Required. The document ID field value. |
DownloadLocation | String | False | Optional. The location where to download the file. For example, C:/Users/Public/Desktop/document.docx |
LockDocument | String | False | Optional. Set to true to Check Out this document before retrieval. |
Result Set Columns
Name | Type | Description |
---|---|---|
Success | String | Whether the document was downloaded successfully. |
FileData | String | File data that will be outputted encoded in Base64 if the DownloadLocation and FileStream inpus are empty. |
FileName | String | The name of the file that was downloaded if included in the response. |
GetOAuthAccessToken
Gets the OAuth access token from the Microsoft Entra ID Authentication Provider.
Input
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. The allowed values are APP, WEB. |
Verifier | String | False | The verifier token returned by the Microsoft Entra ID Authentication Provider after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
State | String | False | Any value that you wish to be sent with the callback. |
Prompt | String | False | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
Result Set Columns
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from the Microsoft Entra ID Authentication Provider. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL
Gets the Microsoft Entra ID authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to the Microsoft Entra ID Authentication Provider.
Input
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | True | The URL that Microsoft Entra ID Authentication Provider will return to after the user has authorized your app. |
State | String | False | Any value that you wish to be sent with the callback. |
Prompt | String | False | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
Result Set Columns
Name | Type | Description |
---|---|---|
URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
RefreshOAuthAccessToken
Refreshes the OAuth access token used for authentication with the Microsoft Entra ID Authentication Provider.
Input
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | The refresh token returned with the previous access token. |
Result Set Columns
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from the Microsoft Entra ID Authentication Provider. |
OAuthRefreshToken | String | The refresh token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
UpdateDocument
Update editable field values on the latest version of a single document.
To find the API names of the Documents table, get the Description column for the table Documents:
SELECT Description FROM [sys_tablecolumns] WHERE TableName = 'Documents'
The Description column will contain the API names of the Documents table. Now, use these API names to update a document, for example:
EXEC UpdateDocument DocumentId = '123', name__v = 'new name', product__v = 'new product'
Input
Name | Type | Required | Description |
---|---|---|---|
DocumentId | String | True | Required. The document ID field value. |
\* | String | False | In the stored procedure's parameters, add the API name of any editable field values that you wish to update. |
Result Set Columns
Name | Type | Description |
---|---|---|
ResponseStatus | String | Whether the document was updated successfully. |
Id | String | The ID of the document. |
System Tables
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables
The following tables return database metadata for Veeva Vault:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Documents table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Documents'
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns
Describes the primary and foreign keys.
The following query retrieves the primary key for the Documents table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Documents'
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:veevavault:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
sys_information
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
Columns
Name | Type | Description |
---|---|---|
Product | String | The name of the product. |
Version | String | The version number of the product. |
Datasource | String | The name of the datasource the product connects to. |
NodeId | String | The unique identifier of the machine where the product is installed. |
HelpURL | String | The URL to the product's help documentation. |
License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
Location | String | The file path location where the product's library is stored. |
Environment | String | The version of the environment or rumtine the product is currently running under. |
DataSyncVersion | String | The tier of Sync required to use this connector. |
DataSyncCategory | String | The category of Sync functionality (e.g., Source, Destination). |
Advanced Configurations Properties
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The scheme used for authentication. Accepted entries are Basic and Microsoft Entra IDOpenID. |
URL | The host you see in the Url after you log in in Veeva Vault. |
User | The Veeva Vault user account used to authenticate. |
Password | The password used to authenticate the user. |
OpenIDConnectProfileID | The ID of your OAuth2.0 / Open ID Connect profile. |
Property | Description |
---|---|
APIVersion | The version of the Veeva Vault API used. |
Property | Description |
---|---|
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
ColumnNamesLocale | Configure the language of the column names. Works only on the views that represent Vault Objects. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Veeva Vault. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryPassthrough | Whether or not the provider will pass the query to Veeva Vault as-is. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseDisplayNames | If set to false, the provider will use api names for some operations. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
Authentication
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The scheme used for authentication. Accepted entries are Basic and Microsoft Entra IDOpenID. |
URL | The host you see in the Url after you log in in Veeva Vault. |
User | The Veeva Vault user account used to authenticate. |
Password | The password used to authenticate the user. |
OpenIDConnectProfileID | The ID of your OAuth2.0 / Open ID Connect profile. |
AuthScheme
The scheme used for authentication. Accepted entries are Basic and Microsoft Entra IDOpenID.
Possible Values
Auto
, Basic
, AzureADOpenID
Data Type
string
Default Value
Auto
Remarks
- Auto: Lets the driver decide automatically based on the other connection properties you have set.
- Basic: Set this to authenticate using the Basic authentication schema. You need to specify the User and Password connection properties for this schema.
- Microsoft Entra IDOpenID: Set to authenticate using OpenID Connect authentication schema with the Microsoft Entra ID authentication provider.
URL
The host you see in the Url after you log in in Veeva Vault.
Data Type
string
Default Value
""
Remarks
The host you see in the Url after you log in in Veeva Vault.
User
The Veeva Vault user account used to authenticate.
Data Type
string
Default Value
""
Remarks
Together with Password, this field is used to authenticate against the Veeva Vault server.
Password
The password used to authenticate the user.
Data Type
string
Default Value
""
Remarks
The User and Password
are together used to authenticate with the server.
OpenIDConnectProfileID
The ID of your OAuth2.0 / Open ID Connect profile.
Data Type
string
Default Value
""
Remarks
The ID of your OAuth2.0 / Open ID Connect profile. This connection property is required only when using the Microsoft Entra IDOpenID AuthScheme.
Connection
This section provides a complete list of connection properties you can configure.
Property | Description |
---|---|
APIVersion | The version of the Veeva Vault API used. |
APIVersion
The version of the Veeva Vault API used.
Data Type
string
Default Value
21.1
Remarks
The Veeva Vault API version used by default is '21.1'.
Versions 21.1 and later are supported.
Azure Authentication
This section provides a complete list of Azure authentication properties you can configure.
Property | Description |
---|---|
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
AzureTenant
The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
Data Type
string
Default Value
""
Remarks
The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory ID in the Azure Portal > Microsoft Entra ID > Properties.
Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.
The AzureTenant
is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant
to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.
OAuth
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values
OFF
, GETANDREFRESH
, REFRESH
Data Type
string
Default Value
OFF
Remarks
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId
The client ID assigned when you register your application with an OAuth authorization server.
Data Type
string
Default Value
""
Remarks
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret
The client secret assigned when you register your application with an OAuth authorization server.
Data Type
string
Default Value
""
Remarks
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken
The access token for connecting using OAuth.
Data Type
string
Default Value
""
Remarks
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type
string
Default Value
%APPDATA%\VeevaVault Data Provider\OAuthSettings.txt
Remarks
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\VeevaVault Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
CallbackURL
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type
string
Default Value
""
Remarks
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
Data Type
string
Default Value
""
Remarks
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken
The OAuth refresh token for the corresponding OAuth access token.
Data Type
string
Default Value
""
Remarks
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn
The lifetime in seconds of the OAuth AccessToken.
Data Type
string
Default Value
""
Remarks
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type
string
Default Value
""
Remarks
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
JWT OAuth
This section provides a complete list of JWT OAuth properties you can configure.
Property | Description |
---|---|
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTCert
The JWT Certificate store.
Data Type
string
Default Value
""
Remarks
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert
. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert
is used in conjunction with the OAuthJWTCertSubject
field in order to specify client certificates. If OAuthJWTCert
has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
Property | Description |
---|---|
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
OAuthJWTCertType
The type of key store containing the JWT Certificate.
Possible Values
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type
string
Default Value
USER
Remarks
This property can take one of the following values:
Property | Description |
---|---|
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
OAuthJWTCertPassword
The password for the OAuth JWT certificate.
Data Type
string
Default Value
""
Remarks
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
OAuthJWTCertSubject
The subject of the OAuth JWT certificate.
Data Type
string
Default Value
*
Remarks
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
SSL
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type
string
Default Value
%APPDATA%\VeevaVault Data Provider\Schema
Remarks
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\VeevaVault Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type
string
Default Value
""
Remarks
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type
string
Default Value
""
Remarks
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type
string
Default Value
""
Remarks
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
ColumnNamesLocale | Configure the language of the column names. Works only on the views that represent Vault Objects. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Veeva Vault. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryPassthrough | Whether or not the provider will pass the query to Veeva Vault as-is. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseDisplayNames | If set to false, the provider will use api names for some operations. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
ColumnNamesLocale
Configure the language of the column names. Works only on the views that represent Vault Objects.
Data Type
string
Default Value
""
Remarks
For the views that represent Vault Objects, use this property to configure the language of the column names. For example, ColumnNamesLocale=de
will return the column names in German. Note, if you are using QueryPassThrough, this property won't work.
MaxRows
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type
int
Default Value
-1
Remarks
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other
These hidden properties are used only in specific use cases.
Data Type
string
Default Value
""
Remarks
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Pagesize
The maximum number of results to return per page from Veeva Vault.
Data Type
int
Default Value
1000
Remarks
The Pagesize
property affects the maximum number of results to return per page from Veeva Vault. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type
string
Default Value
""
Remarks
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
QueryPassthrough
Whether or not the provider will pass the query to Veeva Vault as-is.
Data Type
bool
Default Value
false
Remarks
Whether or not the connector will pass the query to Veeva Vault as-is. These queries should use proper VQL syntax.
Veeva Vault supports a set of queries that are not specified in the regular SQL-92 standard; to execute these queries simply set QueryPassthrough
to true. This will pass the query directly to Veeva Vault without parsing it internally.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type
int
Default Value
60
Remarks
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UseDisplayNames
If set to false, the provider will use api names for some operations.
Data Type
bool
Default Value
true
Remarks
If set to false, the connector will use api names for some operations. This property is used for custom modules: The API name for custom modules is different from a custom module name in the Veeva Vault UI. For example, if you create a Potentials custom module in Veeva Vault, the connector will make the underlying requests to the API name; for example, CustomModule_1.
Set this property to false to use the api name in SQL queries.
UserDefinedViews
A filepath pointing to the JSON configuration file containing your custom views.
Data Type
string
Default Value
""
Remarks
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Documents WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.
UseSimpleNames
Boolean determining if simple names should be used for tables and columns.
Data Type
bool
Default Value
false
Remarks
Veeva Vault tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames
makes the connector easier to use with traditional database tools.
Setting UseSimpleNames
to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.