Create OmniStudio OmniScript
sf_create_omniscriptCreates an OmniStudio OmniScript guided flow for data collection or process execution using Type, SubType, and label. Script is inactive initially, with elements configured in the designer.
Instructions
Creates an OmniStudio OmniScript — a guided interaction flow for collecting data or performing processes.
OmniScripts are identified by Type + SubType + Language (e.g. AccountOpening / Personal / English). The fullName becomes Type_SubType_Language.
The script is created inactive with the specified elements. Complex element configuration (branching logic, custom LWC overrides, remote actions) should be finalized in the OmniScript Designer after creation.
isLwcEnabled: true deploys the script as a Lightning Web Component (recommended for performance). isOmniScriptEmbeddable: true allows embedding this script inside other OmniScripts.
Use sf_activate_omniscript to activate after creation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | OmniScript type, e.g. 'Account', 'Claims' | |
| label | Yes | ||
| subType | Yes | OmniScript sub-type, e.g. 'Create', 'Edit' | |
| elements | No | Script elements; complex structures are set via the OmniScript designer | |
| language | No | Language label, default English | English |
| scriptName | No | Ignored — fullName is derived from type_subType_language | |
| description | No | ||
| isLwcEnabled | No | Use LWC runtime (recommended for new scripts) | |
| isOmniScriptEmbeddable | No | Allow embedding in OmniStudio cards |