Salesforce Docs Portal

Open Knowledge Base Articles Outside an Omniscript (Managed Package)

For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, launch Knowledge base articles outside of an Omniscript using the Vlocity Omniscript Knowledge Base component in a Community or Lightning page.

Before you begin:

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

  1. Configure the fields that query the Knowledge base.
  2. (Optional) Define Knowledge base queries at the step level.

The Vlocity Omniscript Knowledge Base component renders Knowledge base articles side by side with an Omniscript or as a standalone component. When opening Knowledge Base articles from an Omniscript, Omniscript passes specific information into the component to search the Knowledge base and render articles.

  1. In your Omniscript's Setup panel, expand Knowledge options, and select Enable Knowledge.
  2. Select Lightning Knowledge, and configure the remaining fields.
  3. Confirm Display Outside Omniscript is enabled.
  4. If needed, configure Knowledge Options on the Step level.
  5. Deploy the Omniscript by clicking Activate Version.
  6. Open the Lightning App Builder and create a page with a layout containing at least two regions. See Lightning App Builder.
  7. From the Lightning page, drag the deployed LWC Omniscript component into the page.
  8. From the Components section, drag the Vlocity Omniscript Knowledge Base component to where you want it displayed.
  9. In the omniscriptKey field, enter the name of the LWC Omniscript component using the syntax type_SubType_Language.
  10. If needed, in the layout field, enter newport to render the Knowledge base article with the Newport Design System styling.
  11. Save the Lightning page and test the Omniscript on the Lightning page to preview the behavior.