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=" |
| useKBSecurity | No | false | No | If set to true, ACLs for articles and attachment are retrieved (requires server configuration). | true / false |
| patternField | Yes | - | No | The field to be used when including/excluding articles: 0 = Article Number, 1 = Title. | 0 / 1 |
| 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 |
| includeCatalogModelFields | No | false | No | If set to true, includes the key fields of the model associated to the catalog item. | true / false |
| 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 nclude/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.*"
}
]
}
}
Overview
Content Tools
Copyright © 2024 Accenture
