Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be "veeva-vault". | "veeva-vault" |
description | Yes | - | No | Name of the credential object. | "Veeva Vault Credential" |
throttlePolicy | No | - | No | Throttle policy ID that will affect all seeds that use this credential. | "4f07e6c5-d2e9-48d8-a55d-094917508c0f" |
properties | Yes | - | No | Configuration object | |
username | Yes | - | No | Username for the crawl account | |
password | Yes | - | No | Password for the crawl account | "password" |
{ "type": "veeva-vault", "description": "Veeva Vault Credential", "throttlePolicy": "4f07e6c5-d2e9-48d8-a55d-094917508c0f", "properties": { "username": "[email protected]", "password": "encrypted:5A1765DE0C17E1BDD019D61D9E5A2809A0A4F0B4792DD7D4DEF12B7ADA34A043" } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the credential to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
description | Yes | - | No | Name of the credential object. | "Veeva VaultCredential" |
throttlePolicy | No | - | No | Throttle policy ID that will affect all seeds that use this credential. | "4f07e6c5-d2e9-48d8-a55d-094917508c0f" |
properties | Yes | - | No | Configuration object | |
username | Yes | - | No | Username for the crawl account | |
password | Yes | - | No | Password for the crawl account | "password" |
{ "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065", "type": "veeva-vault", "description": "Veeva Vault Credential", "throttlePolicy": "4f07e6c5-d2e9-48d8-a55d-094917508c0f", "properties": { "username": "[email protected]", "password": "encrypted:5A1765DE0C17E1BDD019D61D9E5A2809A0A4F0B4792DD7D4DEF12B7ADA34A043" } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be veeva-vault | veeva-vault |
description | Yes | - | No | Name of the connection object. | "MyVeeva VaultConnection" |
credential | No | - | No | Id of the credential that applies to this connection object. | "d42e1872-02c8-4a90-a714-44f15577389a" |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
properties | Yes | - | No | Configuration object | |
baseUrl | Yes | - | No | The DNS of the vault for which you want to generate a session. | "https://my-veeva-vault-repo.com" |
baseVersion | Yes | - | No | The Vault REST API version. | "v21.3" |
pageSize | Yes | 500 | No | The response page size. | 500 |
throttlingConnectionRate | Yes | 1000 | No | Burst Limit is the number of API calls that your vault can receive within a fixed 5-minute period. | 1000 |
maxRetries | Yes | 3 | No | The number of connections retries. | 3 |
apiLimitWait | Yes | 60000 | No | The waiting time before retry in milliseconds for API LIMIT Errors (in milliseconds). | 60000 |
maxAPILimitRetries | Yes | 3 | No | The number of retries for API Limit errors. | 3 |
{ "type": "veeva-vault", "description": "Veeva Vault Test Connector", "credential": "d42e1872-02c8-4a90-a714-44f15577389a", "throttlePolicy": "", "routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "properties": { "baseUrl": "https://my-veeva-vault-repo.com", "baseVersion": "v21.3", "pageSize": 500, "throttlingConnectionRate": 1000, "maxRetries": 3, "apiLimitWait": 60000, "maxAPILimitRetries": 3 } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
description | No | - | No | Name of the connection object. | "MyConnection" |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
properties | Yes | - | No | Configuration object | |
baseUrl | Yes | - | No | The DNS of the vault for which you want to generate a session. | "https://my-veeva-vault-repo.com" |
baseVersion | Yes | - | No | The Vault REST API version. | "v21.3" |
pageSize | Yes | 500 | No | The response page size. | 500 |
throttlingConnectionRate | Yes | 1000 | No | Burst Limit is the number of API calls that your vault can receive within a fixed 5-minute period. | 1000 |
maxRetries | Yes | 3 | No | The number of connections retries. | 3 |
apiLimitWait | Yes | 60000 | No | The waiting time before retry in milliseconds for API LIMIT Errors (in milliseconds). | 60000 |
maxAPILimitRetries | Yes | 3 | No | The number of retries for API Limit errors. | 3 |
{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "type": "veeva-vault", "description": "Veeva Vault Test Connector", "credential": "d42e1872-02c8-4a90-a714-44f15577389a", "throttlePolicy": "", "routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "properties": { "baseUrl": "https://my-veeva-vault-repo.com", "baseVersion": "v21.3", "pageSize": 500, "throttlingConnectionRate": 1000, "maxRetries": 3, "apiLimitWait": 60000, "maxAPILimitRetries": 3 } }
For the creation of the Connector object using the Rest API check this page
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
seed | Yes | - | No | This value must be veevavault_seed | veevavault_seed |
type | Yes | - | No | The value must be veeva-vault. | veeva-vault |
description | Yes | - | No | Name of the seed object. | "My Veeva Vault Seed" |
connector | Yes | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
connection | Yes | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
properties | Yes | - | No | Configuration object | |
seed | Yes | - | No | This value must be veevavault_seed | veevavault_seed |
attachments | Yes | - | No | Select if you want to get attachment for the resulting objects from the VQL query | true |
renditions | Yes | - | No | Select if you want to get renditions for the resulting objects from the VQL query | false |
queries | Yes | - | Yes | The seed to be crawl as VQL queries | [{"query": "SELECT id FROM documents"},{"query": "SELECT id FROM products__c"}] |
{ "type": "<Connector Type>", "seed": "directory", "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31", "description": "<connector>_Test_Seed", "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b", "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"], "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag1", "tag2"], "properties": { "seed": "veevavault_seed", "attachments": false, "renditions": true, "queries": [ { "query": "SELECT id FROM documents" }, { "query": "SELECT id FROM products__c" } ] } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the seed to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
seed | No | - | No | <seed description> | |
description | No | - | No | Name of the seed object. | "MyVeeva VaultSeed" |
connector | No | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
connection | No | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
workflows.add | No | [ ] | Yes | The ids of the workflows to add. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
workflows.remove | No | [ ] | Yes | The ids of the workflows to remove. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
routingPolicies.add | No | [ ] | Yes | The ids of the routingPolicies to add. | ["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
routingPolicies.remove | No | [ ] | Yes | The ids of the routingPolicies to remove. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"] |
tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag3"] |
tags.add | No | [ ] | Yes | The tags to add | ["tag4"] |
tags.remove | No | [ ] | Yes | The tags to remove | ["tag2"] |
properties | Yes | - | No | Configuration object | |
seed | Yes | - | No | This value must be veevavault_seed | veevavault_seed |
attachments | Yes | - | No | Select if you want to get attachment for the resulting objects from the VQL query | true |
renditions | Yes | - | No | Select if you want to get renditions for the resulting objects from the VQL query | false |
queries | Yes | - | Yes | The seed to be crawl as VQL queries | [{"query": "SELECT id FROM documents"},{"query": "SELECT id FROM products__c"}] |
{ "id": "2f287669-d163-4e35-ad17-6bbfe9df3778", "seed": "<seed example>", "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31", "description": "<connector>_Test_Seed", "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b", "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"], "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag", "tag2"], "properties": { "seed": "veevavault_seed", "attachments": false, "renditions": true, "queries": [ { "query": "SELECT id FROM documents" }, { "query": "SELECT id FROM products__c" } ] } }