The REST API Seeds configuration guidelines can be found here.

The ServiceNow Salesforce connector Seeds “type” must always be specified as “servicenow”“salesforce”.

The ServiceNow Salesforce connector Seeds “seed” can be any string.

The Properties specific to the ServiceNow Salesforce connector Seeds are described below.

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

ServiceNow

Salesforce Seed Properties

Field	Required	Default	Multiple	Notes	Example
properties	No	-	No	Configuration object

includeArticlesNofalseNoIf set to true, knowledge articles will be crawled and, optionally, attachments for those articles can be crawled too.true / falsearticlesDisplayUrlBaseNo"/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_criteriaISEMPTYuseKAFieldListNofalseNoIf true, include metadata fields for the Knowledge Article table.short_description,sys_updated_on,number,sys_id,sys_updated_by,sys_created_by,textuseUserCriteriaForArticlesNotrueNoIf true, the crawl will query the User Criteria table. If the security option is Use User Criteria, this option is overridden to true.true / falseuseParallelProcessingNotrueNoIf 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 / 4includesANo-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 / falseincludeArticlesAttachmentsRegexNofalseNoIf set to true, include/exclude patterns filtering will be allowed for articles' attachments.true / falseuseMimeTypeNofalseNoIf set to true, the connector will match the patterns using the mime type of the attachment instead of the file name.true / falseincludedArticlesAttachmentsFileNameNo-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 / falseuseEmptyRolesNotrueNoIf true, the crawl will use Roles=Null as filter for the documents. true / falseuseUserCriteriaForCatalogNotrueNo 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 / falseuseParallelProcessingNotrueNoIf 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 / falseuseCatFieldListNofalseNoIf true, include metadata fields for Catalog Item table.sys_id,sys_updated_on,sys_name,short_description,sys_updated_by,sys_created_by,descriptionincludeCatalogModelFieldsNofalseNoIf set to true, includes the key fields of the model associated to the catalog item.true / falsecatalogItemsSecurityNoPublicNo

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).


useQueriesFile (true)	No	True		Use file for queries
useLocalQueryFile	No	True		Check to specify a local file or disable to specify an uploaded resource file.
queriesFile	No	false	No	Use this field to specify where the Queries File will be placed. If not, a default Queries File will be used.	${appbundle.home}/config/sQueries.txt
includeResource	No		No	The include resource file to use.
queries	True		True	type: Name of the Object query: The query to use for the specified Object
crawlStandardTypes	No	true	No	Select to crawl Standard Objects from Salesforce	Fetch only Standard Objects configured in the Queries section
crawlArticles	No	false	No	Select this option to crawl Knowledge Articles from Salesforce
articleTypes	No	true	No	Salesforce Knowledge Article Types
articleStatesList	No	Draft, Online, Archive	No	The article states to be crawled.
genericKA	Yes	-	No	Choose Generic for fetching Only standard data or Custom KA	Generic: Fetch Only standard data from the Knowledge Articles Specific: Specify the custom types to be crawled.
typeArtType	No	-	Yes	The name of the custom article type	ex. Custom_kav
enableTls	No	true	Yes	Mark the checkbox if you need the TLS 1.1 and 1.2 for new versions of Salesforce
addAcls	No	true	No	Mark the checkbox if you need to add ACLs to documents
fetchAttachment

patternFieldCatalogYes-NoThe field to be used when including/excluding catalog items: 2 = Catalog Title, 3 = Short Description.
2 / 3includesCNo-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 / falseincludeCatalogItemsAttachmentsRegex

No

false

No

If

set to

true, include

/exclude patterns filtering will be allowed for catalog items'

attachments.

true / false

useMimeTypeForCatalog

includeAttachment

No

false

NoIf set to true, the connector will match the patterns using the mime type of the attachment instead of the file name.true / falseincludedCatalogItemsAttachmentsFileNameNo-YesThe patterns to be used to include catalog attachments for the crawl.

yes

Specify regex URL patterns to exclude

"includeAttachment

"includedCatalogItemsAttachmentsFileName

": [ { "pattern": ".*

filter1.*" }, { "pattern": ".*filter2.*

png[^/]$" } ]

excludedCatalogItemsAttachmentsFileName

excludeAttachment

No

-

Yes

The patterns to be used

Specify regex URL patterns to exclude

catalog attachments for the crawl.

"

excludedCatalogItemsAttachmentsFileName

excludeAttachment": [ { "pattern": ".*

filter1.*" }, { "pattern": ".*filter2.*" }

txt[^/]$" } ]

Usage example

Code Block

theme	RDark
title	POST /aspire/_api/seeds

{
	"seed": "servicenowsalesforce_seed",
	"type": "ServiceNowsalesforce",
	"description": "ServiceNowSalesforce Test Seed",
	"connector": "02ab6c29-61e3-42ff-9c4f-52811d0c2c38",
	"connection": "e3f76fd9-9517-430a-9064-9cf447473ddd",
	"workflows": [],
	"tags": [],
	"properties": {
		"seed": "servicenow_seed",
		"includeArticles": true,
		"articlesDisplayUrlBase": "/kb_view.do?sysparm_article=",
		"useKBSecurity": false,
		"patternField": "1",
		"includesA": [
			{
				"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.*"
			}
		],
		"includeCatalogItemsAttachments": true,
		"includeCatalogItemsAttachmentsRegex": true,
		"useMimeTypeForCatalog": false,
		"includedCatalogItemsAttachmentsFileName": [],
		"excludedCatalogItemsAttachmentsFileName": [
			{
				"pattern": "*.2021.*"
			},
			{
				"pattern": ".*2022.*"
			}
		]
	}
}

...

    "useQueriesFile":false,
    "queries":[
         {
            "type":"KnowledgeArticle__kav",
            "query":"SELECT Id, SystemModstamp, Title, PublishStatus, (SELECT DataCategoryName, DataCategoryGroupName  FROM DataCategorySelections) FROM KnowledgeArticle__kav WHERE IsLatestVersion = true "
         }
      ],
---
If useQueriesFiles is true
"useLocalQueryFile":true,
"queriesFile":"c:\\dev\\sQueries.xml",
---
    "crawlStandardTypes":true,
    "crawlArticles":true,
    "articleTypes":true,
    "articleStatesList":[
         "Draft",
         "Online",
         "Archived"
      ],
    "genericKA":"Specific",
    "specificTypes":[
         {
            "typeArtType":"KnowledgeArticle__kav"
         }
      ],
   "enableTls":true,
   "addAcls":true,
   "fetchAttachment":true,
   "includeAttachment":[
     {
       "pattern":".*png.*"
     }     
   ],
   "excludeAttachment":[
    ] 
}

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Salesforce Seed Properties

Usage example

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Salesforce Seed Properties

Usage example