Loading
Mail Delivery Issue Impacting Email to Salesforce UsersRead More
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            OmniOut (Managed Package)

            You are here:

            1. Salesforce Help
            2. Docs
            3. Omnistudio for Managed Packages

            OmniOut (Managed Package)

            For the managed package runtime, run LWC Omniscripts and Flexcards off-platform on third-party websites with OmniOut for Omniscripts and OmniOut for Flexcards. Display Omniscripts and Flexcards and connect to Salesforce from a content management system's (CMS) external website. Run an Omniscript or Flexcard on your external site by adding the component to the OmniOut project, integrating OmniOut into your application, and deploying your application to your CMS.

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

            Required Versions

            • OmniOut for Omniscripts is available beginning with Vlocity Insurance and Health Summer '20 and CME Summer '20.

            • OmniOut for Flexcards is available beginning Summer '21.
            Note
            Note

            CMS configuration is separate from OmniOut. Complete your CMS configuration before using OmniOut.

            Before You Begin

            • Ensure you have a Content Management System built.

            • Install Node and npm.

              Use Node version 18.20.4 to 22.11.0 with OmniOut. See Installing Node.

            • Download Visual Studio Code. See Visual Studio Code.

            1. Download the OmniOut static resource from Salesforce and open it in Visual Studio Code. See Download the OmniOut Static Resource (Managed Package).
            2. Install dependencies for the OmniOut project. See Install OmniOut Dependencies (Managed Package).
            3. (Optional for Omniscripts only) Add any nested custom LWCs that exist in your Omniscript before adding an Omniscript to OmniOut. See Include Nested Custom LWCs in Your OmniOut Omniscript (Managed Package).
            4. Download and add your component to the OmniOut project. To add an Omniscript, see Add an Omniscript Lightning Web Component to OmniOut (Managed Package). To add a Flexcard, see Add a Flexcard LWC to OmniOut (Managed Package).
            5. To enable a Salesforce API connection, create a Connected App. See Create a Connected App for OmniOut (Managed Package).
            6. (Optional for Omniscripts only) Configure OmniOut to use multi-language Omniscripts. See Configure Multi-Language in OmniOut for Omniscripts (Managed Package).
            7. To view and test your component, run OmniOut in development mode. See Run OmniOut in Development Mode (Managed Package).
            8. (Optional) Control where your component directs users by using the Navigate Action on a Flexcard or Omniscript. For Omniscripts, see Navigate to a URL from an Omniscript in an OmniOut App (Managed Package). For Flexcards, see Navigate to a URL from a Flexcard in an OmniOut App (Managed Package).
            9. Deploy your OmniOut application by performing one of the following tasks:
              If you aren’t deploying to Adobe Experience Manager See Move OmniOut into Your App (Managed Package).
              (Omniscripts only) To add OmniOut for Omniscripts to an Adobe Experience Manager application See Add Omniscripts to Adobe Experience Manager (Managed Package).
            10. (Optional) Include custom style sheets in your OmniOut project. See Add Custom Style Sheets to Your OmniOut Application (Managed Package).
            11. Build a connection in your application. See Connect Your OmniOut App (Managed Package).
            • Download the OmniOut Static Resource (Managed Package)
              For the managed package runtime, download the OmniOut Static Resource from your Salesforce Org. The OmniOut static resource includes JS, HTML, CSS, and other files necessary for Omniscripts and Flexcards to run outside of Salesforce.
            • Install OmniOut Dependencies (Managed Package)
              For the managed package runtime, configure and install the OmniOut dependencies using a command-line-tool. Install the tools necessary to build your OmniOut app and view it locally.
            • OmniOut Supported Components (Managed Package)
              For the managed package runtime, as of Summer '24, certain Salesforce and Omnistudio Lightning web components are supported with OmniOut and off-platform. To ensure that your Omnistudio implementations work with OmniOut, use only the supported components.
            • Include Embedded Components in Your OmniOut Project (Managed Package)
              Include an Omniscript embedded in a Flexcard or a Flexcard embedded in an Omniscript in your OmniOut project.
            • Include Nested Custom LWCs in Your OmniOut Omniscript (Managed Package)
              For the managed package runtime, map nested custom Lightning web components in your Omniscript to include them in your OmniOut project. Lightning web components that override or map to an Omniscript element are automatically downloaded with the off-platform Omniscript LWC.
            • Add an Omniscript Lightning Web Component to OmniOut (Managed Package)
              For the managed package runtime, download and configure an Omniscript to use it off-platform in OmniOut. Download your Omniscript LWC from the LWC Omniscript Designer, add the component folder to the OmniOut project, and configure files for HTML and CSS.
            • Add a Flexcard LWC to OmniOut (Managed Package)
              For the managed package runtime, download and configure a Flexcard to use it off-platform in your OmniOut project. Download your Flexcard LWC from the Flexcard Designer, add the component folder to the OmniOut project, and configure files for HTML and CSS.
            • Create a Connected App for OmniOut (Managed Package)
              For the managed package runtime, enable the external connection to interact with Salesforce by configuring a Connected App in Salesforce. Create a Connected App to make external calls from OmniOut. Connected Apps provide OmniOut with an access token that enables proxies and login authentication to work.
            • Configure Multi-Language in OmniOut for Omniscripts (Managed Package)
              For the managed package runtime, display multi-language Omniscripts in OmniOut using custom labels. Access custom labels in your Omniscript directly from Salesforce or use custom labels defined in local files. Control which language displays by using a language code.
            • Run OmniOut in Development Mode (Managed Package)
              For the managed package runtime, view and test your Omniscript and Flexcard before adding it to your application by running it in development mode. Use a jsForce connection to request data from your org.
            • Navigate to a URL from an Omniscript in an OmniOut App (Managed Package)
              For the managed package runtime, direct users to different URLs from an Omniscript in an OmniOut app using the Navigate Action. Configure endpoints in the Navigate Action and create redirects for the URLs in your OmniOut app. OmniOut supports all Navigate Action types, including URL generation and browser location updates. Application authors must decide how to handle the generated URLs based on the project's unique requirements.
            • Navigate to a URL from a Flexcard in an OmniOut App (Managed Package)
              For the managed package runtime, direct users to different URLs from a Flexcard in an OmniOut app using the Navigate action type. OmniOut for Flexcards supports only the Web Page target type. Application authors must decide how to handle the generated URLs based on the project's unique requirements.
            • Move OmniOut into Your App (Managed Package)
              For the managed package runtime, generate a compiled dist folder to move OmniOut into your app project before deploying your app to a content management system.
            • Add Omniscripts to Adobe Experience Manager (Managed Package)
              For the managed package runtime, add Omniscripts to Adobe Experience Manager using OmniOut. Omniscripts hosted in AEM require a Salesforce connection to send data between servers.
            • Add Custom Style Sheets to Your OmniOut Application (Managed Package)
              For the managed package runtime, include custom styling in your OmniOut project by using style sheets. Custom stylesheets aren’t included in the Omniscript or Flexcard off-platform download metadata. You must add them to your application before building the dist folder.
            • Connect Your OmniOut App (Managed Package)
              For the managed package runtime, OmniOut connects your CMS to Salesforce through a proxy or directly. Configure a connection object to connect to the Salesforce Connected App. Connections are unique to your app's requirements and must be configured outside the scope of OmniOut.
            • OmniOut Support for Native Mobile (Managed Package)
              For the managed package runtime, you can use OmniOut to run OmnScripts on native mobile apps for both iOS and Android with a few exceptions for select settings, actions, and functions.
             
            Loading
            Salesforce Help | Article