Salesforce Connection Properties
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| properties | Yes | - | No | Configuration object | |
| server | Yes | - | No | Salesforce server URL to be crawled (to be specified without protocol). | https://na15.salesforce.com |
| authRESTEndpoint | Yes | - | No | The Salesforce login URL to be used | https://login.salesforce.com/services/oauth2/token |
| apiVersion | No | false | No | API version of the Salesforce server | 57.0 |
| idleConnectionTimeout | Yes | 3600000 | No | Maximum time (in milliseconds) to keep an idle connection open. | 3600000 |
| maxConnections | Yes | 100 | No | Maximum number of connections to be opened. | 100 |
| maxConnectionsPerRoute | Yes | 10 | No | Maximum number of connections opened for the same target. | 10 |
| connectionTimeout | Yes | 15000 | No | Maximum time (in milliseconds) to wait for the connection. | 15000 |
| socketTimeout | Yes | 15000 | No | Maximum time (in milliseconds) to wait for a socket response. | 15000 |
| throttlingRate | Yes | 5000 | No | Time (in milliseconds) to throttle the connection. | 5000 |
| throttlingConnectionRate | Yes | 500 | No | Maximum number of connections used during the throttling period. | 500 |
| maxRetries | Yes | 3 | No | Maximum number of retries of a failed document. | 3 |
| retryWaitTime | Yes | 5000 | No | Time (in milliseconds) to wait before a retry. | 5000 |
| proxyHost | Yes | Proxy hostname | |||
| proxyPort | Yes | 8080 | Proxy Port | 8080 | |
| proxySchema | http | Proxy Schema | http | ||
| proxyUsername | Yes | Proxy Username | |||
| proxyPassword | Yes | Proxy Password |
Create example
POST /aspire/_api/connections
{
"type": "salesforce",
"description": "Salesforce Test Connection",
"credential": "e1664b70-b6ca-42c9-bfa1-7d76a18dd8e1",
"properties": {
"server": "https://na46.salesforce.com/",
"authRESTEndpoint": https://login.salesforce.com/services/oauth2/token,
"apiVersion": 57.0,
"idleConnectionTimeout ": 3600000,
"maxConnections": 1000,
"maxConnectionsPerRoute": 10,
"connectionTimeout": 15000,
"socketTimeout": 15000,
"useThrottling":false,
"maxRetries": 3,
"retryWaitTime": 5000,
"useProxy":[
true
],
"proxyHost":"127.0.0.1",
"proxyPort":8080,
"proxySchema":"http",
"proxyUsername":"proxyUser",
"proxyPassword":"encrypted:577376F6E341A1F41A1156545494A5F1867C1A98C7F2E1478AEE5F30B0463709",
"includes":[
],
"excludes":[
]
}
}
Overview
Content Tools
Copyright © 2024 Accenture
