Adding a Connection to Veeva Vault

To add a connection to Veeva Vault:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Veeva Vault icon is not available, click the Add More icon to download and install the Veeva Vault connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting 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 Azure AD

OpenID Connect with Azure AD 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.

Authenticating 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 Azure AD Authentication Provider.

User Credentials

Set the AuthScheme to Basic and set the User and Password to your user login credentials.

OpenID with AzureAD

OpenID Connect with Azure AD is a connection type that goes through OAuth. Set the AuthScheme to AzureADOpenID. The following sections assume that you have done so.

Creating a Custom OAuth Application

Veeva Vault supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

• create and register custom OAuth application for Azure AD or Azure Service Principal

Azure AD

In portal.azure.com:

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
3. Click New registration.
4. Enter a name for the application.
5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
   • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the Id of the Azure AD Tenant when establishing a connection with the CData Sync App. Otherwise, the authentication attempt fails with an error.
   • If your application is for private use only, specify Accounts in this organization directory only.
   • If you want to distribute your application, choose one of the multi-tenant options.

6. Set the redirect url to http://localhost:33333 (the Sync App's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
7. Click Register to register the new application. An application management screen displays.
   Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
   • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
   • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Veeva Vault displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.

9. Select API Permissions > Add > Delegated permissions.
10. Save your changes.
11. 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.

Azure Service Principal

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access control to access resources in your subscription.

In portal.azure.com:

1. Create a custom OAuth AD application, as described above.
2. Use the search bar to search for the Subscriptions service.
3. Open the Subscriptions page.
4. Select the subscription to which to assign the application.
5. Open the Access control (IAM).
6. Select Add > Add role assignment. Veeva Vault opens the Add role assignment page.
7. Assign your custom Azure AD application the role of Owner.

This section details a selection of advanced features of the Veeva Vault Sync App.

User Defined Views

The Sync App 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 Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App 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.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App 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 CData Sync App. 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 CData Sync App 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 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 for CData Sync 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.

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 Sync App 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 Sync App.

• 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.

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.

Manually retrieve assigned roles on a document and the users and groups assigned to them.

View Specific Information

The Sync App 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 Sync App.

• 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.

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.

Retrieve brief details for the available lifecycles.

View Specific Information

The Sync App 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 Sync App.

• 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.

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.

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.

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.

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 Sync App 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 Sync App.

• 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.

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 Sync App 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 Sync App.

• 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.

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are Basic and AzureADOpenID.
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.

Connection

---

Property	Description
APIVersion	The version of the Veeva Vault API used.

Azure Authentication

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

OAuth

---

Property	Description
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.

JWT OAuth

---

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.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

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.

Miscellaneous

---

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.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are Basic and AzureADOpenID.
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.

The scheme used for authentication. Accepted entries are Basic and AzureADOpenID.

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.
• AzureADOpenID: Set to authenticate using OpenID Connect authentication schema with the Azure Active Directory (AzureAD) authentication provider.

The host you see in the Url after you log in in Veeva Vault.

Remarks

The host you see in the Url after you log in in Veeva Vault.

The Veeva Vault user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Veeva Vault server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

The ID of your OAuth2.0 / Open ID Connect profile.

Remarks

The ID of your OAuth2.0 / Open ID Connect profile. This connection property is required only when using the AzureADOpenID AuthScheme.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

---

Property	Description
APIVersion	The version of the Veeva Vault API used.

The version of the Veeva Vault API used.

Remarks

The Veeva Vault API version used by default is '21.1'.

Versions 21.1 and later are supported.

This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

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 > Azure Active Directory > 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.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
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.

The client Id assigned when you register your application with an OAuth authorization server.

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.

The client secret assigned when you register your application with an OAuth authorization server.

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.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

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.

The JWT Certificate store.

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:

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).

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

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.

The password for the OAuth JWT certificate.

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.

The subject of the OAuth JWT certificate.

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, [email protected]". 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.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

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.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Veeva Vault and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

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.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.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%\\CData\\VeevaVault Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

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.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

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.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

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.

Configure the language of the column names. Works only on the views that represent Vault Objects.

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.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

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

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.

The maximum number of results to return per page from Veeva Vault.

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.

This property indicates whether or not to include pseudo columns as columns to the table.

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, "*=*".

Whether or not the provider will pass the query to Veeva Vault as-is.

Remarks

Whether or not the Sync App 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.

The value in seconds until the timeout error is thrown, canceling the operation.

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 Sync App throws an exception.

If set to false, the provider will use api names for some operations.

Remarks

If set to false, the Sync App 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 Sync App 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.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.

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.

Boolean determining if simple names should be used for tables and columns.

Remarks

Veeva Vault tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App 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.