Search Salesforce Knowledge (Salesforce) v3.0.9 Help ​

Searches for articles in Salesforce Knowledge that match filter criteria.

How can I use the Step? ​

You can use the Step to find specific articles that match your search criteria in Salesforce Knowledge. The Step lets you filter through large amounts of data and retrieve only the relevant information.

How does the Step work? ​

You authorize the Step and specify the search criteria for the articles you want to retrieve. The Step takes these inputs and requests the Salesforce API to fetch the matching articles (see Output example).

To learn more about Salesforce Knowledge, review the Salesforce Knowledge Help and Resources.

Prerequisites ​

Before you get started, you must do the following:

  • Obtain the Consumer Key and Consumer Secret of the Salesforce Connected App you want to authorize the Step with. For more information about creating and configuring a Connected App, see Create a Connected App documentation.

Authorization ​

To authorize the Step, you can inherit authorization from a previous Step, select existing authorization or create a new one.

Here are the steps to create a new Salesforce authorization:

  1. For Select authorization in the current Step, choose the Create a new authorization option from the dropdown.

  2. In the Add an authorization popup, do the following:

    • For Your Connected Apps, select an existing Connected App or click Add a new Connected App and provide the required details in a popup:

      • Name this Connected App: Connected App name.
      • Environment: Environment choice for the Connected App in Salesforce. Either production or sandbox.
      • Consumer Key: Consumer Key for Connected App in Salesforce (see Prerequisites).
      • Consumer Secret: Consumer Secret for Connected App in Salesforce (see Prerequisites).
      • Callback URL: OAuth 2.0 redirect URL. You must use it as Callback URL when creating Connected App on Salesforce.

    • Name your new authorization.

    • Choose where to save the authorization.

    • Authorize the Step by clicking Authorize now or pasting the authorization URL into a web browser.

Once the Step is authorized, all related settings are automatically updated, and you can continue with the Step settings.

Search parameters ​

Construct search and response parameters based on the POST properties from the Search with Parameters in the Request Body documentation.

The following field is required:

  • Query (q)

Response parameters ​

The inputs for this section contain a range of parameters to help you tailor the response output to your needs. All the fields are optional.

Advanced settings ​

You can use this section to configure the following parameter:

  • API version: The Salesforce API version for requests. The value must be in the format 50 or 50.0 and contain at least two characters. The default API version is 50, and the minimum supported version is 37.

Merge field settings ​

The Step returns the result as a JSON object and stores it in the Merge field variable. So you can use the retrieved data in subsequent Steps or other Flows.

Output example ​

The output includes an array of article objects that match search criteria and specified response parameters.

json
{
  "matches": []
}
{
  "matches": []
}

Error Handling ​

By default, the Handle error toggle is on, and the Step handles errors with a separate exit. If any error occurs during the Step execution, the Flow proceeds down the error exit.

If the Handle error toggle is disabled, the Step does not handle errors. In this case, if any error occurs during the Step execution, the Flow fails immediately after exceeding the Flow timeout. To prevent the Flow from being suspended and continue handling errors, you can place the Flow Error Handling Step before the main logic or your Flow.

Reporting ​

After the Step completes, it generates a report that includes its execution status and other details. You can customize the report by adjusting the Step's log level and adding tags.

Log level ​

By default, the Step's log level matches that of the Flow. You can change the Step's log level by selecting an appropriate option from the Log level dropdown.

Tags ​

Tags provide a way to classify and search for sessions based on their attributes. To create a new tag, specify its category, label, and value. You can then use tags to filter and group the sessions in the report.

Service dependencies ​

  • flow builder v2.28.3
  • event-manager v2.3.0
  • deployer v2.6.0
  • library v2.11.3
  • studio v2.64.1
  • authorizer 2 service v2.1.6
  • salesforce data provider

Release notes ​

v3.0.9

  • Add API version selection to the Step UI

v3.0.7

  • Update error handling
  • Add Merge field settings to collapsible

v3.0.6

  • Implemented Authorization Manager v1.1.0
  • Add Step migration

v3.0.3

  • Update Authorization Manager v1.0.5
  • Add dynamic instance_url

v3.0.2

  • Update Authorization Manager v1.0.4

v3.0.1

  • Update UI