Salesforce Dictionary - Free Salesforce GlossarySalesforce Dictionary
Full OmniStudio entry
How-to guide

Getting started with OmniStudio

OmniStudio setup depends on the license. Industries Cloud orgs have it enabled by default; Sales/Service Cloud orgs need the add-on activated. Builders work in the OmniStudio app (separate from standard Setup).

By Dipojjal Chakrabarti · Founder & Editor, Salesforce DictionaryLast updated May 16, 2026

OmniStudio setup depends on the license. Industries Cloud orgs have it enabled by default; Sales/Service Cloud orgs need the add-on activated. Builders work in the OmniStudio app (separate from standard Setup).

  1. Verify the license and enable OmniStudio

    Setup, OmniStudio Settings (Industries Cloud) or Setup, Installed Packages (Sales/Service Cloud). Industries Cloud licenses include OmniStudio; add-on licenses require activation. The OmniStudio app appears in the App Launcher once enabled.

  2. Build DataRaptors first

    Most OmniStudio projects start with data mapping. Build Extract DataRaptors for the data you need to read; Load DataRaptors for writes. Test each DataRaptor in isolation before composing them into Integration Procedures.

  3. Build an Integration Procedure

    Sequence the DataRaptors, callouts, and conditional logic into a server-side orchestration. Test the IP via the Test Procedure tab; verify input and output JSON match expectations.

  4. Build the OmniScript

    Drag-and-drop the user-facing flow: input steps, conditional branches, embedded actions. Reference the Integration Procedure for server-side work. Style the OmniScript to match Lightning Experience or Experience Cloud branding.

  5. Embed in the Lightning experience

    Add the OmniScript or FlexCard to a Lightning record page via App Builder. For Experience Cloud, embed via the OmniStudio component on a community page. Test end-to-end in sandbox before production deploy.

Key options
Component typeremember

OmniScript (guided flow), FlexCard (record display), DataRaptor (data mapping), Integration Procedure (server-side orchestration), Document Generation. Pick per task.

Deployment targetremember

Lightning Experience record page, Experience Cloud site, embedded iframe on an external website. Each target has different styling and security considerations.

DataRaptor typeremember

Extract (read), Transform (reshape JSON), Load (write), Turbo Extract (high-performance read for FlexCard). Pick based on read/write needs and performance requirements.

Licensing modelremember

Included with Industries Cloud licenses; add-on per-user license for Sales/Service Cloud. Pricing changes the cost-benefit math significantly.

Gotchas
  • OmniStudio is a separate skill set from Salesforce Flow and Apex. Existing Salesforce developers take 4-8 weeks to ramp on OmniScript and DataRaptor patterns.
  • Integration Procedures are slower at runtime than equivalent Apex. Performance-sensitive use cases may require falling back to native code.
  • Document Generation in OmniStudio is functional but basic. Compare against Conga or DocuSign Gen before committing to OmniStudio-only document workflows.
  • Add-on licensing for Sales/Service Cloud is meaningful per-user cost. Justify with use cases that genuinely require OmniStudio''s capabilities.
  • Force-fitting OmniStudio onto simple use cases produces brittle, slow implementations. Flow is often the right choice; OmniStudio is the right choice when Flow runs out of capability.

See the full OmniStudio entry

OmniStudio includes the definition, worked example, deep dive, related terms, and a quiz.