OmniStudio
OmniStudio is the Salesforce declarative development toolkit originally built by Vlocity (acquired by Salesforce in 2020) for building guided customer experiences, complex data orchestration, and document generation without writing Apex.
Definition
OmniStudio is the Salesforce declarative development toolkit originally built by Vlocity (acquired by Salesforce in 2020) for building guided customer experiences, complex data orchestration, and document generation without writing Apex. It ships standard with Industries Clouds (Financial Services Cloud, Health Cloud, Communications Cloud, Energy and Utilities Cloud, Public Sector Solutions) and is available as an add-on for Sales Cloud and Service Cloud. The toolkit includes OmniScript (guided flows), DataRaptor (data mapping), FlexCard (presentation layer), Integration Procedures (server-side orchestration), and Document Generation.
OmniStudio targets developer-grade complexity through admin-friendly tools. Where Salesforce Flow handles linear automation, OmniStudio handles branching guided journeys with sophisticated UI, multi-step data transformations, and external system orchestration. A loan application that pulls credit data from three external systems, calculates risk, displays a custom UI per applicant tier, and generates a PDF disclosure document is the canonical OmniStudio use case. Salesforce Flow alone would struggle; pure Apex would take 10x the development time.
What OmniStudio is and where it fits relative to Flow, Apex, and Lightning Web Components
OmniScript and guided customer flows
OmniScript is the user-facing guided flow tool. Build a multi-step journey (loan application, claim filing, onboarding) with conditional branching, dynamic field validation, embedded actions, and a polished UI that matches Salesforce Lightning styling. OmniScripts are mobile-responsive and can be embedded in Experience Cloud sites, Lightning record pages, or external websites. The tool sits somewhere between Salesforce Flow Screen Flows (simpler) and a custom-built LWC (more flexible but slower to build).
DataRaptor and the data mapping engine
DataRaptor is the declarative data-mapping tool. Four types: Extract (read from Salesforce), Transform (reshape JSON), Load (write to Salesforce), Turbo Extract (high-performance read). DataRaptors handle the mapping layer between Salesforce data and OmniScript inputs/outputs, between external API responses and Salesforce records, between flat structures and nested. They are the equivalent of SOQL plus a JSON transformation library, packaged into a declarative interface. Building DataRaptors well is the highest-leverage OmniStudio skill.
FlexCard and the dynamic presentation layer
FlexCard is the OmniStudio presentation component. Build a record card (Account summary, Customer 360 view, Policy details) that pulls data from multiple sources, renders dynamic content based on context, and offers inline actions. FlexCards can embed in any Lightning record page or Experience Cloud site. They overlap with Lightning Record Pages and custom LWC in capability; FlexCards win on speed of build, LWC wins on UI flexibility for non-card-style layouts.
Integration Procedures and server-side orchestration
Integration Procedures are server-side declarative orchestration. They sequence DataRaptors, external HTTP callouts, and Apex actions into a single named server-side flow that OmniScripts and FlexCards invoke. They are essentially the OmniStudio equivalent of an Apex controller method. Complex business logic that would take 200 lines of Apex often takes 10 declarative steps in an Integration Procedure. The trade-off: Integration Procedures are slower at runtime than equivalent Apex and harder to debug for developers used to stack traces.
Document Generation and contract output
OmniStudio includes a Document Generation feature that produces PDFs, Word documents, or HTML from templates using data pulled via DataRaptors. Used heavily in Financial Services Cloud (mortgage disclosure documents, account opening forms) and Health Cloud (consent forms, care plans). The feature is functional but limited compared to standalone document tools (Conga, DocuSign Gen, Nintex DocGen); for high-volume document generation, most orgs combine OmniStudio with one of those AppExchange products.
Licensing and the Industries Cloud dependency
OmniStudio ships included with Industries Cloud licenses. For Sales Cloud or Service Cloud, it is sold as an add-on at a meaningful per-user cost. The pricing model is what determines adoption; mid-market orgs running standard Sales Cloud rarely justify the OmniStudio add-on because Flow and Apex cover their needs. Enterprise orgs running Industries Cloud get OmniStudio bundled, so they use it whether or not it is the best tool for the job.
When OmniStudio is right and when it is not
Right fit: guided customer journeys with branching, complex data orchestration across external systems, document generation as part of a flow, Industries Cloud deployments. Wrong fit: simple Sales Cloud automation (Flow is better), highly custom UI that does not fit the OmniScript pattern (LWC is better), high-performance batch processing (Apex is better). The toolkit is powerful but opinionated; force-fitting use cases produces brittle implementations.
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).
- 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.
- 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.
- 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.
- 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.
- 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.
OmniScript (guided flow), FlexCard (record display), DataRaptor (data mapping), Integration Procedure (server-side orchestration), Document Generation. Pick per task.
Lightning Experience record page, Experience Cloud site, embedded iframe on an external website. Each target has different styling and security considerations.
Extract (read), Transform (reshape JSON), Load (write), Turbo Extract (high-performance read for FlexCard). Pick based on read/write needs and performance requirements.
Included with Industries Cloud licenses; add-on per-user license for Sales/Service Cloud. Pricing changes the cost-benefit math significantly.
- 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.
Trust & references
Cross-checked against the following references.
- OmniStudio OverviewSalesforce Help
- OmniStudio ComponentsSalesforce Help
Straight from the source - Salesforce's reference material on OmniStudio.
- OmniScript OverviewSalesforce Help
- DataRaptor OverviewSalesforce Help
About the Author
Dipojjal Chakrabarti is a B2C Solution Architect with 29 Salesforce certifications and over 13 years in the Salesforce ecosystem. He runs salesforcedictionary.com to help admins, developers, architects, and cert/interview candidates sharpen their fundamentals. More about Dipojjal.
Test your knowledge
Q1. What is OmniStudio?
Q2. What was OmniStudio formerly called?
Q3. Where is OmniStudio used?
Discussion
Loading discussion…