ServiceNow Seed Properties
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| properties | No | - | No | Configuration object | |
| includeArticles | No | false | No | If set to true, knowledge articles will be crawled and, optionally, attachments for those articles can be crawled too. | true / false |
| articlesDisplayUrlBase | No | "/kb_view.do?sysparm_article=" | No | The base display URL for articles. | "/kb_view.do?sysparm_article=" |
security | No | Public | No | 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 | No | false | No | If 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 |
| useKAFieldList | No | false | No | If true, include metadata fields for the Knowledge Article table. | short_description,sys_updated_on,number,sys_id,sys_updated_by,sys_created_by,text |
| useUserCriteriaForArticles | No | true | No | If 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 |
| useParallelProcessing | No | true | No | If true, the scan will query the minimum number of fields to start processing in parallel, then the populate will complete the item's metadata. | |
| patternField | Yes | - | No | The field to be used when including/excluding articles: 0 = Article Number, 1 = Short Description, 4 = Knowledge Base Name. | 0 / 1 / 4 |
| includesA | No | - | Yes | The patterns to be used to include articles for the crawl. | "includesA": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| excludesA | No | - | Yes | the patterns to be used to exclude articles for the crawl. | "excludesA": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| includeKAItemsAttachments | No | false | No | If set to true, knowledge articles' attachments will be crawled. | true / false |
| includeArticlesAttachmentsRegex | No | false | No | If set to true, include/exclude patterns filtering will be allowed for articles' attachments. | true / false |
| useMimeType | No | false | No | If set to true, the connector will match the patterns using the mime type of the attachment instead of the file name. | true / false |
| includedArticlesAttachmentsFileName | No | - | Yes | The patterns to be used to include article attachments for the crawl. | "includedArticlesAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| excludedArticlesAttachmentsFileName | No | - | Yes | The patterns to be used to exclude article attachments for the crawl. | "excludedArticlesAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| includeCatalogItems | No | false | No | If set to true, catalog items will be crawled. | true / false |
| useEmptyRoles | No | true | No | If true, the crawl will use Roles=Null as filter for the documents. | true / false |
| useUserCriteriaForCatalog | No | true | No | 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 |
| useParallelProcessing | No | true | No | If 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 |
| useCatFieldList | No | false | No | If true, include metadata fields for Catalog Item table. | sys_id,sys_updated_on,sys_name,short_description,sys_updated_by,sys_created_by,description |
| includeCatalogModelFields | No | false | No | If set to true, includes the key fields of the model associated to the catalog item. | true / false |
| catalogItemsSecurity | No | Public | No | 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). | |
| patternFieldCatalog | Yes | - | No | The field to be used when including/excluding catalog items: 2 = Catalog Title, 3 = Short Description. | 2 / 3 |
| includesC | No | - | Yes | The patterns to be used to include catalog items for the crawl. | "includesC": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| excludesC | No | - | Yes | The patterns to be used to exclude catalog items for the crawl. | "excludesC": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| includeCatalogItemsAttachments | No | false | No | If set to true, catalog items' attachments will be crawled. | true / false |
| includeCatalogItemsAttachmentsRegex | No | false | No | If set to true, include/exclude patterns filtering will be allowed for catalog items' attachments. | true / false |
| useMimeTypeForCatalog | No | false | No | If set to true, the connector will match the patterns using the mime type of the attachment instead of the file name. | true / false |
| includedCatalogItemsAttachmentsFileName | No | - | Yes | The patterns to be used to include catalog attachments for the crawl. | "includedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
| excludedCatalogItemsAttachmentsFileName | No | - | Yes | The patterns to be used to exclude catalog attachments for the crawl. | "excludedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ] |
Usage example
POST /aspire/_api/seeds
{
"seed": "servicenow_seed",
"type": "ServiceNow",
"description": "ServiceNow 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.*"
}
]
}
}
Disable checkingPremium suggestionsDisable checkingPremium suggestions
Overview
Content Tools
Copyright © 2024 Accenture
