Build OmniScripts in the Industry Cloud-specific designer (OmniStudio Designer). Confirm OmniStudio is licensed and provisioned in your org before starting; OmniScript ships as part of Communications Cloud, Health Cloud Industries, FSC Industries, and similar packages.
- Open the OmniStudio Designer
Launch the OmniStudio Lightning app. Navigate to the OmniScripts tab. Click New OmniScript and provide a Type (the use case category), Sub-Type (variant), Language, and Name.
- Drag elements onto the canvas
Build the workflow step by step. Start with a Step element, drag input elements into it for the first form. Add Action elements for integration calls. Add Conditional View elements where the flow should branch. Save frequently; the designer auto-saves but explicit saves are safer.
- Wire up Integration Procedures
For any server-side work (look up customer info, validate eligibility, submit the final transaction), drag an Integration Procedure Action element and select the IP to invoke. Pass JSON parameters from the OmniScript runtime into the IP via the Send JSON Path field.
- Preview and test
Click the Preview button to launch the OmniScript in a sandbox runtime. Walk through every path, including the conditional branches. Confirm the runtime JSON object accumulates correctly as the user advances through steps.
- Activate and embed
Once tested, click Activate. The OmniScript version becomes available for use. Embed it on a Lightning record page using the OmniScript LWC component, or on an Experience Cloud site through the Builder. Confirm the embedded component renders correctly for the user persona that will run the OmniScript.
High-level category (Account, Order, Quote, Claim). Used in the OmniScript namespacing and as a filter in the designer.
Specific variant within the type (NewBusiness, Switch, Renewal). The Type plus Sub-Type combination identifies the OmniScript.
The locale of the OmniScript (en_US, fr_FR, ja_JP). Each language version is a separate OmniScript record.
Which version is currently exposed for use. Default is 0 until the script is activated.
The opening Step element. Every OmniScript must contain at least one Step.
- OmniScript JSON paths are case-sensitive. A typo between customerInfo.firstName and customerinfo.firstname breaks the binding and the form renders empty values.
- Embedding an inactive OmniScript on a Lightning page renders a blank component with no error. Always confirm the version is Active before debugging UI issues.
- Integration Procedures called from OmniScript share the standard Apex governor limits per OmniScript step. Avoid heavy SOQL or long-running callouts inside a step; break work across multiple steps if needed.
- Conditional View elements hide elements visually but the JSON values still exist. To genuinely exclude data from submission, use the Conditional Submit option on the element, not just visual hiding.