Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ver

The REST API Connection configuration guidelines can be found here.

The ServiceNow Salesforce Connector's Connection type must always be specified as “servicenow”“salesforce”.

The Properties specific to the ServiceNow Salesforce  Connector's Connection are described below.


Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

ServiceNow Connection Properties


FieldRequiredDefaultMultipleNotesExample
propertiesYes-NoConfiguration object
hostserverYes-NoServiceNow Salesforce server url to be crawled (to be specified without protocol).“myserver.service-now.com”https://na15.salesforce.com
authRESTEndpointpageSizeYes-NoNumber of elements per page to be retrieved with the connection.2000
ignoreScanErrorNofalseNoIf set to true, a crawl will stop when a scan error is found.true
cacheEntireUserTableNofalseNoIf set to true, the entire sys_user is cached, rather than every user being cached when necessary.true
The Salesforce login url to be usedhttps://login.salesforce.com/services/oauth2/token
apiVersionNofalseNoApi version of the Salesforce server57.0
idleConnectionTimeout Yes3600000NoMaximum time (in milliseconds) to keep an idle connection open.3600000
maxConnectionsYes100NoMaximum number of connections to be opened.100
maxConnectionsPerRouteYes10NoMaximum number of connections opened for the same target.10
connectionTimeoutYes15000NoMaximum time (in milliseconds) to wait for the connection.15000
socketTimeoutYes15000NoMaximum time (in milliseconds) to wait for a socket response.15000
throttlingRateYes5000NoTime period (in milliseconds) to throttle the connection.5000
throttlingConnectionRateYes500NoMaximum number of connections used during the throttling period.500
maxRetriesYes3NoMaximum number of retries a failed document.3
retryWaitTimeYes5000NoTime (in milliseconds) to wait before a retry.5000
proxyHostYes

Proxy hostname
proxyPortYes8080
Proxy Port8080
proxySchema
http
Proxy Schemahttp
proxyUsernameYes

Proxy Username
proxyPasswordYes

Proxy PasswordcountWithStatsNotrueNoIf set to true, the Aggregate API will be used to get counts of rows from the Knowledge and Category tables.false

Create example


Code Block
themeRDark
titlePOST /aspire/_api/connections
{
	"type": "servicenowsalesforce",
	"description": "ServiceNowSalesforce Test Connection",
	"credential": "e1664b70-b6ca-42c9-bfa1-7d76a18dd8e1",
	"properties": {
		"hostserver": "myserver.service-now.com""https://na46.salesforce.com/",
		"authRESTEndpoint": https://login.salesforce.com/services/oauth2/token,
		"apiVersion": 57.0,
		"pageSizeidleConnectionTimeout ": 3600000,
		"maxConnections": 1000,
 		"maxConnectionsPerRoute": 10,
		"ignoreScanError"connectionTimeout": 15000,
	    "socketTimeout": false15000,
		"cacheEntireUserTablemaxRetries": false3,
		"countWithStatsretryWaitTime": true5000

	}
}

...