Versions Compared

Key

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


The REST API Seeds configuration guidelines can be found here.

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

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

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


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

ServiceNow

Salesforce Seed Properties


FieldRequiredDefaultMultipleNotesExample
propertiesNo-NoConfiguration object
useQueriesFile (true)NoTrue
Use file for queries
useLocalQueryFileNoTrue
Check to specify a local file or disable to specify an uploaded resource file.
queriesFileNofalseNoUse 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 
includeResourceNo
NoThe include resource file to use.

queries


True
True

type: Name of the Object

query: The query to use for the specified Object


crawlStandardTypes NotrueNoSelect to crawl Standard Objects from Salesforce  Fetch only Standard Objects configured in the Queries section
crawlArticlesNofalseNoSelect this option to crawl Knowledge Articles from Salesforce
articleTypesNotrueNoSalesforce Knowledge Article Types
articleStatesListNoDraft, Online, ArchiveNo

Article The article states to be crawled.


genericKAYes-NoChoose 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.

typeArtTypeNo-YesThe name of the custom article typeex. Custom_kav
enableTlsNotrueYesMark the checkbox if you need the TLS 1.1 and 1.2 for new versions of Salesforce
addAclsNotrueNoMark the checkbox if you need to add ACLs to documents
fetchAttachmentNofalseNoIf true, Include include attachments.true / false
includeAttachmentNofalseyesSpecify regex URL patterns to exclude"includeAttachment": [ { "pattern": ".*png[^/]$" } ]
excludeAttachmentNo-YesSpecify regex URL patterns to exclude"excludeAttachment": [ { "pattern": ".*txt[^/]$" } ]

Usage example


Code Block
themeRDark
titlePOST /aspire/_api/seeds
{
	"seed": "salesforce_seed",
	"type": "Salesforcesalesforce",
	"description": "Salesforce Test Seed",
	"connector": "02ab6c29-61e3-42ff-9c4f-52811d0c2c38",
	"connection": "e3f76fd9-9517-430a-9064-9cf447473ddd",
	"workflows": [],
	"tags": [],
    "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":[
    ] 
}