Knowledge Options Properties Reference (Managed Package)

For the managed package runtime, Knowledge Options properties are configurable from the Setup and Properties panels in the Omniscript Designer. Enable Knowledge in your Omniscript to allow users to view and search for articles from your Salesforce Knowledge articles.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Property	Definition
Enable Knowledge	Integrate Salesforce Knowledge with Omniscript. You must enable this property in the Properties panel for each Step that displays the Knowledge component and in the Setup panel.

Setup panel

These properties are unique to the Knowledge Options section in the Setup panel.

Property	Description
Display Outside Omniscript	Enables launching Knowledge base articles outside of an Omniscript using the Vlocity Omniscript Knowledge Base component in a Community or Lightning page.
Use Lightning Knowledge	Integrates Lightning Knowledge with Omniscript. Lightning Knowledge must be enabled in your org.
Filter Knowledge Search by Record Type	Enables searching only the knowledge articles of the types that you specify in the Article/Record Type API Name or the Record Type Filter property for a step. If you also specify fields in Field API Name, Omnistudio only searches those fields for the listed record types. For example, Louise enabled Filter Knowledge Search by Record Type and listed FAQ and BLOG in the Record Type Filter property. Then, she entered Title and Description for the Field API Name for both record types. When users search, they don't see results for GUIDE or INFO record types. They also don't see BLOG or FAQ articles that have the search terms only in the Summary field but not in the Title or Description fields.
Article/Record Type API Name	The Article Type API name for Classic Knowledge or the Record Type API name when Use Lightning Knowledge is enabled. Specify the Name field of the RecordType object.
Field API Name	The API names of one or more fields that are displayed when you open the details. Each field is displayed as a single column section. For multiple fields, enter a comma-separated list with no spaces, such as `Title,namespace__richText__c,Summary`. The Omniscript preview displays these fields.
Lightning Knowledge Object API Name	If Use Lightning Knowledge is enabled, enter the Lightning Knowledge object's API name, such as `namespace__Knowledge__kav`.
Label	The text displayed above the Knowledge component, such as `Suggested Articles`.

Properties panel

These properties are unique to the Knowledge Options section in the Properties panel when you select a Step.

Property	Description
Language	Select the language for the articles.
Public Status	The type of article to display. Enter `Online`, `Archived`, or `Draft`.
Keyword	The text to search for. This keyword can be literal text, such as `Service Disconnect`. Or enter merge fields for variable data. For example, enter `%RouterType%` to use the input value of a Text element whose Name is RouterType.
Data Category Criteria	Filter Knowledge articles by their data category in a SOQL query. For example, enter `Troubleshooting__c AT (Router__c`) to show articles from the sub-category `Router` under the parent category `Troubleshooting`. The WITH DATA CATEGORY clause isn’t required in the query.
Record Type Filter	If Use Lightning Knowledge or Filter Knowledge Search by Record Type is enabled, enter the Record Type's API name to filter the record types queried by the Step. For multiple Record Types, enter a comma-separated list with no spaces, such as `FAQ,INFO`. If you list a record type for a step, the search includes all the fields for that record type unless the Omniscript setup has Filter Knowledge Search by Record Type enabled and Field API Name lists specific fields. The search then uses only the fields specified in the Omniscript setup.