Versions Compared

Key

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


The REST API Connection configuration guidelines can be found here.

ServiceNow Amazon S3 Connector's Connection type must always be specified as "servicenows3".

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


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

ServiceNow Connection Properties


FieldRequiredDefaultMultipleNotesExample
propertiesYes-NoConfiguration object
hostregionYes-NoThe AWS region where the s3 storage is located."us-east-2"
useGlobalEndpointNotrueNoSet to true to use the global endpoint (if set to false, the connection might fail, depending on the bucket region).true / false
s3StorageClassServiceNow server to be crawled (to be specified without protocol)."myserver.service-now.com"pageSizeYes-NoYesNumber of elements per page List of storage classes to be retrieved with the connection.2000

[ "Standard",             "ReducedRedundancy"]

indexContainersignoreScanErrorNofalseNoIf set to true, a crawl will stop when a scan error is found  folders will be indexed.
true / false
cacheEntireUserTablescanRecursivelyNofalsetrueNoIf set to true, the entire sys_user is cached as opposed to every user being cached when necessarydiscovered items are scanned recursively.true / false
countWithStatsscanExcludedItemsNotruefalseNoIf set to true, the Aggregate API will be used to get counts of rows from the Knowledge and Category tables.scans excluded container items so documents inside them can be processed.true / false
includesNo[]YesList of regular expressions to match documents to be included in the crawl.[".*sales.*", ".*finance.*"]
excludesNo[]YesList of regular expressions to match documents to be excluded from the crawl.[".*food.*", ".*drinks.*"]false

Create example


Code Block
themeRDark
titlePOST /aspire/_api/connections
{
	"type": "servicenows3",
	"description": "ServiceNowAmazon TestS3 Connection Test",
	"credential": "e1664b705af67012-b6cac59a-42c944ad-bfa191b5-7d76a18dd8e1c1122d963f25",
	"properties": {
		"hostregion": "myserver.service-now.com"us-east-2",
		"useGlobalEndpoint": true,
		"pageSizes3StorageClass": 1000[
			"Standard",
			"ReducedRedundancy",
			"IntelligentTiering",
			"StandardInfrequentAccess",
			"OneZoneInfrequentAccess",
			"Glacier",
			"DeepArchive"
		],
		"ignoreScanErrorindexContainers": false,
		"cacheEntireUserTable"scanRecursively": true,
		"scanExcludedItems": false,
		"includes": [],
		"countWithStatsexcludes": true[]
	}
}