Element details

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

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
locale	The locale of the articles to be retrieved. Usually this should be set to the user's locale.	○	○	"en-US"	str
page_size	The maximum number of returned articles to be returned.	○	○	null	int
page_number	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.	○	○	null	int
channel	Gives the possibility to select different scopes depending on the situation.	○	○	null	SalesforceKnowledgeChannel
order	Articles ordering, 'ASC' or 'DESC'.	○	○	null	SalesforceKnowledgeOrder
sort	Articles sort.	○	○	null	SalesforceKnowledgeSort
article_body_field_name	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.	○	○	null	str
integration		◉	○		SalesforceKnowledgeIntegrationRef
context	Send context data with this component's event.	○	○	{}	dict
sensitive		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
soql_query	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.	◉	○		str

Usage reference

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:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    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