Versions Compared

Key

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


The REST API Seeds configuration guidelines can be found here.

Azure Identity Connector Seeds "type" The ServiceNow connector Seeds “type” must always be specified as "azure-identity"“servicenow”.

Azure Identity Connector Seeds "seed" The ServiceNow connector Seeds “seed” can be any string.

The Properties specific to the Azure Identity Connector to the ServiceNow connector Seeds are described below.


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

Azure Identity Credentials

ServiceNow Seed Properties


FieldRequiredDefaultMultipleNotesExample
propertiesNo-NoConfiguration object
lowerCase

includeArticlesNofalseNoIf set to true
, all extracted identities are stored in lowercase
, knowledge articles will be crawled and, optionally, attachments for those articles can be crawled too.true / false
articlesDisplayUrlBaseNo"/kb_view.do?sysparm_article="NoThe base display URL for articles."/kb_view.do?sysparm_article="

security


NoPublicNo

Public: Only public items will be crawled. Articles with Public Knowledge Base, and if Can Read or Can Contribute fields are set, should be only public User Criteria values. If Cannot Read is set, the item will not be crawled.

Knowledge Base: ACLs for articles and attachments will be the sys_id of the Knowledge Base  (requires server configuration).

User Criteria: ACLs for articles and attachments will be the sys_id of the Can Read, Cannot Read or Can Contribute  (requires server configuration).

Public

Use User Criteria

Use Knowledge Base

useCustomSearchQuery NofalseNoIf checked, include a ServiceNow compliance valid query string. The connector will send it to ServiceNow as it is, and the result depends on the glide.invalid_query.returns_no_rows property on your ServiceNow server. Check with your administrator.workflow_state=published^active=true^can_read_user_criteriaISEMPTY^cannot_read_user_criteriaISEMPTY
useKAFieldListNofalseNoIf true, include metadata fields for the Knowledge Article table.short_description,sys_updated_on,number,sys_id,sys_updated_by,sys_created_by,text
useUserCriteriaForArticlesNotrueNoIf true, the crawl will query the User Criteria table. If the security option is Use User Criteria, this option is overridden to true.true / false
useParallelProcessingNotrueNoIf true, the scan will query the minimum number of fields to start processing in parallel, then the populate will complete the item's metadata.
patternFieldYes-NoThe field to be used when including/excluding articles: 0 = Article Number, 1 = Short Description, 4 = Knowledge Base Name.
0 / 1 / 4
includesANo-YesThe patterns to be used to include articles for the crawl."includesA": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludesANo-Yesthe patterns to be used to exclude articles for the crawl."excludesA": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
includeKAItemsAttachmentsNofalseNoIf set to true, knowledge articles' attachments will be crawled.true / false
addEveryoneGroup
includeArticlesAttachmentsRegexNofalseNoIf set to true,
adds an "Everyone" group for all user identities
include/exclude patterns filtering will be allowed for articles' attachments.true / false
addEveryoneExceptExternalGroup
useMimeTypeNofalseNoIf set to true,
adds the "Everyone except external users" group for all user identities.
the connector will match the patterns using the mime type of the attachment instead of the file name.true / false
includedArticlesAttachmentsFileNameNo-YesThe patterns to be used to include article attachments for the crawl."includedArticlesAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludedArticlesAttachmentsFileNameNo-YesThe patterns to be used to exclude article attachments for the crawl."excludedArticlesAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
includeCatalogItemsNofalseNoIf set to true, catalog items will be crawled.true / false
useEmptyRolesNotrueNoIf true, the crawl will use Roles=Null as filter for the documents. true / false
useUserCriteriaForCatalogNotrueNo If true, the crawl will use the User Criteria table to validate Available and NotAvailable fields. If the security option is Use User Criteria, this option is overridden to true.true / false
useParallelProcessingNotrueNoIf true, the scan will query the minimum number of fields to start processing in parallel, then the populate will complete the item's metadata.true / false
useCatFieldListNofalseNoIf true, include metadata fields for Catalog Item table.sys_id,sys_updated_on,sys_name,short_description,sys_updated_by,sys_created_by,description
includeCatalogModelFieldsNofalseNoIf set to true, includes the key fields of the model associated to the catalog item.true / false
catalogItemsSecurityNoPublicNo

Public: Only public catalog items will be crawled. If Available For field is set, terms with empty Role should only be public User Criteria values. If No Available For is set, the item will not be crawled.

User Criteria: ACLs for catalog items and attachments will be the sys_id of the Available For and No Available For  (requires server configuration).



patternFieldCatalogYes-NoThe field to be used when including/excluding catalog items: 2 = Catalog Title, 3 = Short Description.
2 / 3
includesCNo-YesThe patterns to be used to include catalog items for the crawl."includesC": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludesCNo-YesThe patterns to be used to exclude catalog items for the crawl."excludesC": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
includeCatalogItemsAttachmentsNofalseNoIf set to true, catalog items' attachments will be crawled.true / false
includeCatalogItemsAttachmentsRegexNofalseNoIf set to true, include/exclude patterns filtering will be allowed for catalog items' attachments.true / false
useMimeTypeForCatalogNofalseNoIf set to true, the connector will match the patterns using the mime type  of the attachment instead of the file name.true / false
includedCatalogItemsAttachmentsFileNameNo-YesThe patterns to be used to include catalog attachments for the crawl."includedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludedCatalogItemsAttachmentsFileNameNo-YesThe patterns to be used to exclude catalog attachments for the crawl."excludedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
true / falseuserRegexNo-NoRegular expression to filter users to add if the "addEveryoneExceptExternalGroup" is set to true.".*companyAGroup.*"

Usage example


Code Block
themeRDark
titlePOST /aspire/_api/credentialsseeds
{
	"seed": "testSeedservicenow_seed",
	"type": "azure-identityServiceNow",
	"description": "AzureIdentitySeedServiceNow Test Seed",
	"connector": "b3aee82802ab6c29-06ff61e3-4a0542ff-b6a59c4f-29c22f79255552811d0c2c38",
	"connection": "57218d6be3f76fd9-62ed9517-485e430a-9dac9064-8423d06dddfg9cf447473ddd",
	"workflows": [],
	"tags": [],
	"properties": {
		"seed": "servicenow_seed",
		"includeArticles": true,
		"articlesDisplayUrlBase": "/kb_view.do?sysparm_article=",
		"useKBSecurity": false,
		"patternField": "1",
		"includesA": [
			{
				"lowerCase": true"pattern": ".*Sales.*"
			}
		],
		"excludesA": [
			{
				"pattern": ".*Technology.*"
			}
		],
		"includeKAItemsAttachments": true,
		"includeArticlesAttachmentsRegex": true,
		"useMimeType": false,
		"includedArticlesAttachmentsFileName": [],
		"excludedArticlesAttachmentsFileName": [
			{
				"pattern": ".*2021.*"
			},
			{
				"pattern": ".*2022.*"
			}
		],
		"includeCatalogItems": true,
		"includeCatalogModelFields": false,
		"patternFieldCatalog": "2",
		"includesC": [
			{
				"pattern": ".*Sales.*"
			}
		],
		"excludesC": [
			{
				"pattern": ".*Technology.*"
			}
		],
		"addEveryoneGroupincludeCatalogItemsAttachments": true,
		"addEveryoneExceptExternalGroupincludeCatalogItemsAttachmentsRegex": true,
		"useMimeTypeForCatalog": false,
		"userRegex"includedCatalogItemsAttachmentsFileName": [],
		"excludedCatalogItemsAttachmentsFileName": [
			{
				"pattern": "*.2021.*"
			},
			{
				"pattern": ".*companyBGroup2022.*"
			}
		]
	}
}



Disable checkingPremium suggestionsDisable checkingPremium suggestions