---
schema_version: "1"
id: 95f0f6625dbadbc35022ff18d87c32ad38dbbd2547469892c00e35196a77307a
title: Configure Omniscript Settings
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_set_up_an_omniscript_8598.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_set_up_an_omniscript_8598.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 368103f5a075bf83f61c0f7315ff27a7734c36ae0669ee74b60b42862df9bcdd
description: Configure optional settings for your Omniscript in the Setup panel of the Omniscript Designer, such as making your Omniscript reusable or enabling logging.
products:
  - Omnistudio
release: "264"
---
# Configure Omniscript Settings

Configure optional settings for your Omniscript in the Setup panel of the Omniscript Designer, such as making your Omniscript reusable or enabling logging.

## Default Setup Properties

Default setup properties apply to your entire Omniscript and aren’t included in each element’s properties.

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio-264-0-0-production-enus/f526eaa8-ae05-487a-8944-4bb99b0b78ac/images/icon_note.png)

Note

After updating or configuring Omniscripts, allow 15–20 minutes for updates to appear, even after clearing your cache. If you see any errors or if old versions load, contact Salesforce support to enable the **Template API** setting. This helps updates show up faster and more reliably.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col style="width:25%">
          <col style="width:50%">
          <col style="width:25%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d20818e53">
              <p style="margin-bottom:0;">Default Setup Property</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d20818e59">
              <p style="margin-bottom:0;">Description</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d20818e65">
              <p style="margin-bottom:0;">Task Documentation</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Enable reusable</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">If checked, enables the Omniscript to be embedded in another Omniscript.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_embed_an_omniscript_in_another_omniscript_20581.htm&amp;release=264.0.0&amp;type=5" title="An Omniscript can be reused in one or more existing Omniscripts. Reusing Omniscripts enables you to build a variety of smaller scripts and then piece them together into one or more parent scripts. Embedded Omniscripts behave just like other Omniscript elements.">Embed an Omniscript in Another Omniscript</a>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Enable SEO</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Makes your Omniscript's URL available to search engines.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_enable_seo_for_omniscripts_10257.htm&amp;release=264.0.0&amp;type=5" title="Make Omniscripts in Communities appear in online searches by enabling SEO.">Enable SEO for Omniscripts</a>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Set the currency code</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Overrides the default currency by configuring the currency code field.
                By default, Omniscript uses the org default currency in single-currency
                orgs and the user's currency in multi-currency orgs. </p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_configure_an_omniscript_s_currency_code_9255.htm&amp;release=264.0.0&amp;type=5" title="Override an org's default currency in an Omniscript by setting the Omniscript's Currency Code.">Configure an Omniscript's Currency Code</a>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Fetch picklist values at script load</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">If selected, enables picklist values to be retrieved at script load. If
                deselected, picklists are fetched at design time. Sometimes, the Omniscript
                can’t retrieve the picklist values because it reached the Apex CPU limits.
                In that case, deselect the checkbox and reactivate the Omniscript. If you
                later add more values, deactivate and reactivate the Omniscript to refresh
                the data.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_populating_picklist_values_from_apex_21650.htm&amp;release=264.0.0&amp;type=5" title="You can populate Select, Multi-select, and Radio elements from a Callable Apex class. The values for the element are obtained during the Omniscript's activation.">Populating Picklist Values in Omniscript Inputs from Apex</a>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Seed data JSON</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Enables the Omniscript to be seeded with JSON data on launch. The property
                doesn’t allow for referencing other data with the
                <code>%element%</code> syntax or use of expressions.
                For more robust functionality, see
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_set_values_in_an_omniscript_22132.htm&amp;release=264.0.0&amp;type=5" title="Use the Set Values action to set element values in subsequent steps, rename JSON nodes, create dynamic values, and concatenate data. Set Values actions use merge fields to access JSON data in other Omniscript elements.">Set Values in an Omniscript</a>.
              </p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_seed_data_into_an_omniscript_10173.htm&amp;release=264.0.0&amp;type=5" title="Prefill Omniscript fields with data or add hidden nodes to the Omniscript Data JSON using the Seed Data JSON property in the Omniscript's Setup section.">Seed Data Into an Omniscript</a>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Enable unload warning</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Triggers a <strong class="uicontrol">Leave Site?</strong> warning when reloading,
                navigating away, or closing the window.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">None available</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Enable logging metrics</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Sends data to Salesforce about which Omniscript elements are used at runtime.
                The data doesn't include hidden actions and steps, and it doesn't collect user
                data.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">None available</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Enable logging metrics for hidden actions and steps</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Sends data to Salesforce about which Omniscript hidden actions and steps
                are used at runtime. The data doesn't collect user data. By default, the
                property isn't selected due to possible decreased performance.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">None available</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Default Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e53 ">
              <p style="margin-bottom:0;">Set the console tab title and icon</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e59 ">
              <p style="margin-bottom:0;">Applies text and an icon to the console tab where the Omniscript is embedded.
                These settings apply only if the Omniscript owns the entire tab or subtab.
                They aren't used if the Omniscript is embedded on a page with other components.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e65 ">
              <p style="margin-bottom:0;">None available</p>
            </td>

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

## Setup Properties

Setup property sections include sets of properties that apply to a specific configuration, such as displaying Knowledge Base articles in your Omniscript.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col style="width:25%">
          <col style="width:50%">
          <col style="width:25%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d20818e339">
              <p style="margin-bottom:0;">Setup Property</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d20818e345">
              <p style="margin-bottom:0;">Description</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d20818e351">
              <p style="margin-bottom:0;">Task Documentation</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Setup Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e339 ">
              <p style="margin-bottom:0;">Step Chart Options</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Hide the step chart or choose where to display it relative to your
                Omniscript.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_step_chart_options_9289.htm&amp;release=264.0.0&amp;type=5" title="Hide or move an Omniscript's Step Chart using Step Chart Options.">Configure Step Chart for an Omniscript</a>
              </p>
            </td>

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

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Enable cancel functionality and configure how the cancel behavior
                executes.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_configure_omniscript_cancel_options_9325.htm&amp;release=264.0.0&amp;type=5" title="Navigate users to different Salesforce experiences after canceling an Omniscript by configuring cancel options. Omniscript's cancel functionality enables users to cancel an Omniscript from a Step by clicking a cancel link. The cancel link directs the user to a Salesforce experience set in the cancel options.">Configure Omniscript Cancel Options</a>
              </p>
            </td>

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

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Enable users to save an Omniscript for later use.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_save_and_resume_an_omniscript_9465.htm&amp;release=264.0.0&amp;type=5" title="Enable users to save and resume Omniscripts by using Omniscript's Save Options property. Users can bookmark links, launch a saved instance from an object page, or email the link. Configure custom URLs to resume saved Omniscript instances in different domains. For example, a customer can initiate an Omniscript inside of an Experience Cloud page, and then a customer service representative can resume the Omniscript inside of the Service Console.">Save and Resume an Omniscript</a>
              </p>
            </td>

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

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Enable Knowledge Articles to be displayed in or alongside your Omniscript.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_integrate_salesforce_knowledge_with_omniscript_9810.htm&amp;release=264.0.0&amp;type=5" title="Enable users to search and view Salesforce Knowledge Articles when using an Omniscript. Configure Omniscript Knowledge Options to search for articles based on static values and dynamic inputs from Omniscript fields, or a query from a simple search bar.">Integrate Salesforce Knowledge with Omniscript</a>
              </p>
            </td>

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

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Set a default error message or simplify error messages for users.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_customize_omniscript_error_messages_10378.htm&amp;release=264.0.0&amp;type=5" title="The error message handler enables you to replace default error messages from remote apex calls with more user-friendly error messages when errors occur in Omniscript. The Error Messages handler property is available in File elements, Image elements, all Action elements, and Setup.">Customize Omniscript Error Messages</a>
              </p>
            </td>

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

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Pass information using Pub/Sub, windowPostMessage, and Session Storage.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_messaging_framework_11452.htm&amp;release=264.0.0&amp;type=5" title="Communicate between an Omniscript, windows, Lightning web components, and Omniscript elements with window post messages, session storage messages, and PubSub messaging.">Messaging Framework for Omniscripts</a>
              </p>
            </td>

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

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e345 ">
              <p style="margin-bottom:0;">Customize the design of your Omniscript using custom style sheets, design
                tokens, and a scroll animation.</p>
            </td>

            <td data-label="Task Documentation" class="slds-cell-wrap" style="vertical-align:top;" headers="d20818e351 ">
              <p style="margin-bottom:0;">
                <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_style_omniscripts_18959.htm&amp;release=264.0.0&amp;type=5" title="Add custom styling to Omniscripts by using static resources, overriding global stylesheets, or using SLDS design tokens. View the behavior of each customization option in this page's table, and choose the solution that meets your requirements.">Custom Styles for Omniscripts</a>
              </p>
            </td>

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