Page History
ServiceNow
Salesforce Seed Properties
| Field | Required | Default | Multiple | Notes | Example | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| properties | No | - | No | Configuration object | ||||||||||
| 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 | "/kb_view.do?sysparm_article="No | The include resource file to use. | "/kb_view. | do?sysparm_article="||||||||||
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 | |||||||||
| useKAFieldListcrawlArticles | No | false | No | Select this option to crawl Knowledge Articles from Salesforce | ||||||||||
| articleTypes | 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 | |||||||||
| 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. | |||||||||
| typeArtTypeincludedArticlesAttachmentsFileName | 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 | |||||
| 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 | No | false | No | If true, include | ||||||||||
| 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 | |||||||||
| useMimeTypeForCatalogincludeAttachment | 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 | yes | Specify regex URL patterns to exclude | "includeAttachment | includedCatalogItemsAttachmentsFileName | No | - | Yes | The patterns to be used to include catalog attachments for the crawl. | "includedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]png[^/]$" } ] |
| excludeAttachmentexcludedCatalogItemsAttachmentsFileName | No | - | Yes | The patterns to be used Specify regex URL patterns to exclude catalog attachments for the crawl. | "excludedCatalogItemsAttachmentsFileNameexcludeAttachment": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } txt[^/]$" } ] |
Usage example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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":[
]
} |
Overview
Content Tools