salesforce.knowledge

type: meya.salesforce.knowledge.trigger
class: SalesforceKnowledgeTrigger
path: /meya/salesforce/knowledge/trigger/trigger.py
signature: expect

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

bot

BotRef

null

Bot used to evaluate this trigger

action

TriggerActionEntry
ActionComponentSpec

Action executed if this trigger matches

when

typing.Any

Custom condition for when to evaluate this trigger

confidence

Real

null

Custom confidence override value for trigger matches

expect

Expect

null

Examples

Basic

triggers:
  - integration: integration.salesforce_knowledge
    when: ANY
    expect: salesforce_knowledge
steps:
  - say: STRING

Full

type: meya.salesforce.knowledge.trigger
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
bot: element.name
action: COMPONENT
when: ANY
confidence: 123
expect: salesforce_knowledge