How to Configure the Veeva Vault Connector Using Web.config

You can configure the following settings to customize the functionality of your Veeva Vault connector.

Setting Description
ThrottleSleepMinutes and BurstLimit

The Burst Limit and Throttle Sleep Minutes settings can be modified to change the way the connector behaves when approaching the Veeva Vault API call quota. The connector monitors the remaining requests available under the current Veeva Vaultburst limit. The connector stops issuing requests if the number of requests available under the burst limit drops below the configured value. 

To change these settings, do the following:

  1. Open the web.config file in a text editor.
  2. Change the values of the settings BurstLimit and ThrottleSleepMinutes. 
    • The default value for BurstLimit is 100 tries per five minute period.
    • The default value for Throttle Sleep Time is 1 (minute).
RequestTimeoutValue

This setting allows you to specify the amount of time that a request will last before it times out. This should be used if you experience timeouts during crawls or jobs, to allow more time for Veeva Vault to respond.

To change these settings, do the following:

  2. Open the web.config file in a text editor.

  3. Change the requestTimeoutValue value.  The default value for this setting is 300000 (300 seconds).

PageSizeLimit This setting specifies the maximum number of records per page used by security API calls. To modify the API page size, open the web.config file, and change the value. The default value is 1000.
SessionCacheExpiration

This setting specifies the value that sets the session cache expiration time. This can be modified according to the setting selected in Veeva Vault.

To change these settings, do the following:

  1. Open the web.config file in a text editor.
  2. Change the values of the settings SessionCacheExpiration. 
    • The default value is 20 minutes.
ApiLimitExceededSleepMinutes

When the API call quota is exceeded, this setting specifies the amount of time that the connector will stop making requests to Veeva and sleep before retrying. Unlike the Throttle Sleep Minutes setting, which triggers when the number of used calls approaches the limit, this setting is only called when the limit is already reached.

To change these settings, do the following:

  1. Open the web.config file in a text editor.
  2. Change the values of the settings ApiLimitExceededSleepMinutes. 
    • The default value is 5 minutes.
VeevaVaultClientID

This setting specifies the format of the ClientId in a Veeva Vault API request header. This allows the customization of the requests that the Veeva Vault connector makes, so they can be easily found.

To change these settings, do the following:

  1. Open the web.config file in a text editor.
  2. Change the values of the settings VeevaVaultClientID. 
    • The default value is BAInsight-connector-%connid%.
RenditionStates

This setting enumerates the document states that have the Viewable Rendition option enabled. For these states, the connector will try to get the rendition instead of the actual file when retrieving the binary data during indexing.

To change these settings, do the following:

  1. Open the web.config file in a text editor.
  2. Change the values of the settings RenditionStates. 
    • The default value is Approved Effective, Approved, and Effective.
ElectronicSignaturesApprovedStatuses

This setting enumerates the electronic signature action states that are meant to be fetched from the audit log. For these states, the connector will try to retrieve electronic signature information.

To change these settings, do the following:

  1. Open the web.config file in a text editor.
  2. Change the values of the settings ElectronicSignaturesApprovedStatuses. 
    • The default value is Approved Effective, Approved, Effective, and Approve changes & release.