salesforce.knowledge.search

type: meya.salesforce.knowledge.component.search
class: SalesforceKnowledgeSearchComponent
path: /meya/salesforce/knowledge/component/search.py
signature: -

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

locale

str

"en-US"

The locale of the articles to be retrieved. Usually this should be set to the user's locale.

page_size

int

null

The maximum number of returned articles to be returned.

page_number

int

null

The specific page number to retrieve when a search query is broken up into multiple pages of articles. This allows you to page through the list of articles.

channel

SalesforceKnowledgeChannel

null

Gives the possibility to select different scopes depending on the situation.

order

SalesforceKnowledgeOrder

null

Articles ordering, 'ASC' or 'DESC'.

sort

SalesforceKnowledgeSort

null

Articles sort.

article_body_field_name

str

null

This is the specific field name you set in Salesforce to contain the body of an article. When this is set, the api will automatically fetch all body content for a list of articles in a search result. However, if it's not defined then the api will NOT fetch the article body content.

integration

SalesforceKnowledgeIntegrationRef

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

soql_query

str

Salesforce Object Query Language (SOQL) query string. Check https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm for more details.

Examples

Basic

triggers:
  - keyword: meya.salesforce.knowledge.component.search
steps:
  - type: meya.salesforce.knowledge.component.search
    integration: integration.salesforce_knowledge
    soql_query: STRING

Full

triggers:
  - keyword: meya.salesforce.knowledge.component.search
steps:
  - type: meya.salesforce.knowledge.component.search
    spec: '?'
    locale: STRING
    page_size: 123
    page_number: 123
    channel: App|Pkb|Csp|Prm
    order: ASC|DESC
    sort: LastPublishedDate|CreatedDate|Title|ViewScore
    article_body_field_name: STRING
    integration: integration.salesforce_knowledge
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    soql_query: STRING