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 | 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 | No | false | No | If true, include attachments. | true / false |
| includeAttachment | No | false | yes | Specify regex URL patterns to exclude | "includeAttachment": [ { "pattern": ".*png[^/]$" } ] |
| excludeAttachment | No | - | Yes | Specify regex URL patterns to exclude | "excludeAttachment": [ { "pattern": ".*txt[^/]$" } ] |
Usage example
POST /aspire/_api/seeds
{
"seed": "salesforce_seed",
"type": "salesforce",
"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":[
]
}
Overview
Content Tools
Copyright © 2024 Accenture
