Cloud

Build 24.0.9175
  • Veeva Vault
    • Getting Started
      • Establishing a Connection
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Views
        • AuditHistory
        • DocumentRelationships
        • DocumentRoles
        • DocumentUserActions
        • Lifecycles
        • ObjectRelationships
        • ObjectRoles
        • ObjectTypes
        • ObjectWorkflows
        • ObjectWorkflowTasks
      • Stored Procedures
        • CreateDocument
        • CreateDocumentVersion
        • UpdateDocument
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • AuthScheme
        • URL
        • User
        • Password
        • OpenIDConnectProfileID
      • Connection
        • APIVersion
      • Azure Authentication
        • AzureTenant
      • SSO
        • SSOLoginURL
        • SSOProperties
        • SSOExchangeUrl
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • ColumnNamesLocale
        • MaxRows
        • Pagesize
        • PseudoColumns
        • QueryPassthrough
        • Timeout
        • UseDisplayNames
        • UseSimpleNames

Veeva Vault - CData Cloud

Overview

CData Cloud offers access to Veeva Vault across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Veeva Vault through CData Cloud.

CData Cloud allows you to standardize and configure connections to Veeva Vault as though it were any other OData endpoint, or standard SQL Server/MySQL database.

Key Features

  • Full SQL Support: Veeva Vault appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to Veeva Vault in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Veeva Vault

Establishing a Connection shows how to authenticate to Veeva Vault and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Veeva Vault through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to Veeva Vault by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Veeva Vault

In order to connect to your Veeva Vault account, you first need to set the Url connection property to the host you see in the address bar after logging in to your account.

For example: https://myvault.veevavault.com.

Authenticating to Veeva Vault

The Cloud supports the following authentication methods:

  • Veeva Vault user credentials
  • OpenID Connect with the Azure AD Authentication Provider
  • Okta SSO

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 AzureAD. The following sections assume that you have done so.

Okta

The Cloud supports the Okta SAML 2.0 flow. Before you can authenticate via Okta SSO, you must configure your Veeva Vault and Okta instances as described in Veeva Vault's Okta SSO guide.

After following those steps, set the following to connect:

  • AuthScheme: OKTA
  • User: the username of the Okta account to use for Okta SSO.
  • Password: the password of the Okta account to use for Okta SSO.
  • SSOLoginURL: the "Identify Provider Login URL" associated with your Veeva Vault single sign-on profile. This is the value you copied from "Identity Provider Login URL" in the View Setup Instructions screen from the "Veeva Vault" app integration menu in Okta (step 8 in the linked Veeva Vault Okta SSO guide above).
    • This should look like: https://dev-XXXXXXXXX.okta.com/app/veeva_vault/XXXXXXXXXXXXXXX/sso/saml
  • SSOExchangeUrl: the "Vault SSO Login URL" associated with your Veeva Vault single sign-on profile. After you have created a single sign-on profile in Veeva Vault (step 12 in the linked Veeva Vault Okta SSO guide above), you can find this in Veeva Vault by navigating to Admin > Settings > SAML Profiles > (click your SAML profile's label) > SAML Single Sign-on Configuration.
    • This should look like: https://login.veevavault.com/auth/saml/consumer/_XXXXXXXXXXXXXXXX

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

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.

CData Cloud

Data Model

The CData Cloud 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 are exposed by the Cloud. However, the Cloud only lists views for which it can determine all available columns at design time. Examples of Veeva objects available with the CData Cloud but not displayed in the help include:

  • Documents (Query the available documents, VQL is used when possible for this object.)
  • Users (Query the existing users, VQL is used when possible for this object.)
  • Groups (Query the existing 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 is done server-side.

If you set the QueryPassthrough connection property to True, the Cloud executes VQL queries directly against the Veeva Vault API.

CData Cloud

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.

CData Cloud - Veeva Vault 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.

CData Cloud

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

  • 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.
OnBehalfOf String If the action completed by the user represents a different user, this field displays the name of the delegating user.
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. If 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.

CData Cloud

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.

CData Cloud

DocumentRoles

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

View Specific Information

The Cloud 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 Cloud.

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

CData Cloud

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.

CData Cloud

Lifecycles

Retrieve brief details for the available lifecycles.

View Specific Information

The Cloud 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 Cloud.

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

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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

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

CData Cloud

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

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

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud 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.

CData Cloud - Veeva Vault 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.
UpdateDocument Update editable field values on the latest version of a single document.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

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.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

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.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA 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_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll 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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates 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.

CData Cloud

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.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

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


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are Basic, AzureAD, AzureADOpenID and OKTA.
URLThe host you see in the Url after you log in in Veeva Vault.
UserSpecifies the user ID of the authenticating Veeva Vault user account.
PasswordSpecifies the password of the authenticating user account.
OpenIDConnectProfileIDThe ID of your OAuth2.0 / Open ID Connect profile.

Connection


PropertyDescription
APIVersionThe version of the Veeva Vault API used.

Azure Authentication


PropertyDescription
AzureTenantIdentifies the Veeva Vault tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

SSO


PropertyDescription
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeUrlThe URL used for consuming the SAML response and exchanging it for service specific credentials.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL


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

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous


PropertyDescription
ColumnNamesLocaleConfigure the language of the column names. Works only on the views that represent Vault Objects.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
PagesizeSpecifies the maximum number of results to return from Veeva Vault, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryPassthroughWhether or not the provider will pass the query to Veeva Vault as-is.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseDisplayNamesIf set to false, the provider will use api names for some operations.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.
CData Cloud

Authentication

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


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are Basic, AzureAD, AzureADOpenID and OKTA.
URLThe host you see in the Url after you log in in Veeva Vault.
UserSpecifies the user ID of the authenticating Veeva Vault user account.
PasswordSpecifies the password of the authenticating user account.
OpenIDConnectProfileIDThe ID of your OAuth2.0 / Open ID Connect profile.
CData Cloud

AuthScheme

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

Possible Values

Basic, AzureAD, AzureADOpenID, OKTA

Data Type

string

Default Value

"Basic"

Remarks

  • Basic: Set this to authenticate using the Basic authentication schema. You need to specify the User and Password connection properties for this schema.
  • AzureAD: Set to authenticate using OpenID Connect authentication schema with the Azure Active Directory (AzureAD) authentication provider.
  • AzureADOpenID: Set to authenticate using OpenID Connect authentication schema with the Azure Active Directory (AzureAD) authentication provider. (Deprecated)
  • OKTA: Set this to perform SSO authentication through OKTA. All identity providers require the following common connection properties. [SSOLoginURL/SSOExchangeUrl]

CData Cloud

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.

CData Cloud

User

Specifies the user ID of the authenticating Veeva Vault user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

CData Cloud

Password

Specifies the password of the authenticating user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

CData Cloud

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 AzureAD AuthScheme.

CData Cloud

Connection

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


PropertyDescription
APIVersionThe version of the Veeva Vault API used.
CData Cloud

APIVersion

The version of the Veeva Vault API used.

Data Type

string

Default Value

"24.2"

Remarks

The default version of the Veeva Vault API is 24.2.

Versions 21.1 and later are supported.

CData Cloud

Azure Authentication

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


PropertyDescription
AzureTenantIdentifies the Veeva Vault tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
CData Cloud

AzureTenant

Identifies the Veeva Vault tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

Data Type

string

Default Value

""

Remarks

A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.

To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.

Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.

CData Cloud

SSO

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


PropertyDescription
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeUrlThe URL used for consuming the SAML response and exchanging it for service specific credentials.
CData Cloud

SSOLoginURL

The identity provider's login URL.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

CData Cloud

SSOProperties

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Data Type

string

Default Value

""

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. This is used with the SSOLoginURL.

SSO configuration is discussed further in .

CData Cloud

SSOExchangeUrl

The URL used for consuming the SAML response and exchanging it for service specific credentials.

Data Type

string

Default Value

""

Remarks

The CData Cloud will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Veeva Vault.

CData Cloud

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
CData Cloud

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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

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

CData Cloud

Logging

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


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

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


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Cloud

Miscellaneous

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


PropertyDescription
ColumnNamesLocaleConfigure the language of the column names. Works only on the views that represent Vault Objects.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
PagesizeSpecifies the maximum number of results to return from Veeva Vault, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryPassthroughWhether or not the provider will pass the query to Veeva Vault as-is.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseDisplayNamesIf set to false, the provider will use api names for some operations.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.
CData Cloud

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.

CData Cloud

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

Pagesize

Specifies the maximum number of results to return from Veeva Vault, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

1000

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

CData Cloud

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

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

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

CData Cloud

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175