---
schema_version: "1"
id: 5df278136d860fdb025d1b225b430d5104865f4b6145e44ca9bb39ff919b1e54
title: Knowledge Options Properties Reference (Managed Package)
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_knowledge_options_properties_reference.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_knowledge_options_properties_reference.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 7c25eb47bb4945b8d18e09c159d33d4ba7d4948259636447a2c3558fc06a4155
description: 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.
products:
  - Omnistudio
release: "264"
---
# 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](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US).

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
      <colgroup>
        <col>
        <col>
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d166529e49">
            <p style="margin-bottom:0;">Property</p>
          </th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d166529e55">
            <p style="margin-bottom:0;">Definition</p>
          </th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e49 ">
            <p style="margin-bottom:0;"> Enable Knowledge </p>
          </td>

          <td data-label="Definition" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e55 ">
            <p style="margin-bottom:0;">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.</p>
          </td>

        </tr>
      </tbody>
    </table>

## Setup panel

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

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d166529e100">
              <p style="margin-bottom:0;">Property</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d166529e106">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;"> Display Outside Omniscript </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p style="margin-bottom:0;">Enables launching Knowledge base articles outside of an Omniscript using
                the Vlocity Omniscript Knowledge Base component in a Community or
                Lightning page.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;"> Use Lightning Knowledge </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p style="margin-bottom:0;">Integrates Lightning Knowledge with Omniscript. Lightning Knowledge must
                be enabled in your org.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;">Filter Knowledge Search by Record Type </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p>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.</p>
              <p>If you also specify fields in Field API Name, Omnistudio only searches
                those fields for the listed record types.</p>
              <p style="margin-bottom:0;">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. </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;"> Article/Record Type API Name </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p style="margin-bottom:0;">The Article Type API name for Classic Knowledge or the Record Type API
                name when Use Lightning Knowledge is enabled. Specify
                the&nbsp;<strong class="uicontrol">Name</strong>&nbsp;field of the RecordType object.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;"> Field API Name </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p>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
                <kbd>Title,namespace__richText__c,Summary</kbd>.
              </p>
              <p style="margin-bottom:0;">The Omniscript preview displays these fields.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;"> Lightning Knowledge Object API Name </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p style="margin-bottom:0;">If Use Lightning Knowledge is enabled, enter the Lightning Knowledge
                object's API name, such as
                <kbd>namespace__Knowledge__kav</kbd>.
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e100 ">
              <p style="margin-bottom:0;"> Label </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e106 ">
              <p style="margin-bottom:0;">The text displayed above the Knowledge component, such as
                <kbd>Suggested Articles</kbd>.
              </p>
            </td>

          </tr>
        </tbody>
      </table>

## Properties panel

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

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d166529e265">
              <p style="margin-bottom:0;">Property</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d166529e271">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e265 ">
              <p style="margin-bottom:0;"> Language </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e271 ">
              <p style="margin-bottom:0;">Select the language for the articles.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e265 ">
              <p style="margin-bottom:0;"> Public Status </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e271 ">
              <p style="margin-bottom:0;">The type of article to display. Enter <kbd>Online</kbd>,
                <kbd>Archived</kbd>, or <kbd>Draft</kbd>.
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e265 ">
              <p style="margin-bottom:0;"> Keyword </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e271 ">
              <p style="margin-bottom:0;">The text to search for. This keyword can be literal text, such as
                <kbd>Service Disconnect</kbd>. Or enter merge fields for
                variable data. For example, enter <kbd>%RouterType%</kbd> to
                use the input value of a Text element whose <strong class="uicontrol">Name</strong>
                is RouterType.
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e265 ">
              <p style="margin-bottom:0;"> Data Category Criteria </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e271 ">
              <p style="margin-bottom:0;">Filter Knowledge articles by their data category in a SOQL query. For
                example, enter <kbd>Troubleshooting__c AT (Router__c</kbd>)
                to show articles from the sub-category <code>Router</code> under the parent category <code>Troubleshooting</code>. The WITH DATA CATEGORY clause isn’t
                required in the query.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e265 ">
              <p style="margin-bottom:0;"> Record Type Filter </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d166529e271 ">
              <p>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 <kbd>FAQ,INFO</kbd>.</p>
              <p style="margin-bottom:0;">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.</p>
            </td>

          </tr>
        </tbody>
      </table>