// Use when testing or validating OmniStudio components — OmniScript preview, Integration Procedure step debugging, DataRaptor field-mapping validation, and end-to-end UTAM-based automation. NOT for Apex unit testing or standard Flow debugging.
[HINT] Download the complete skill directory including SKILL.md and all related files
| name | omnistudio-testing-patterns |
| description | Use when testing or validating OmniStudio components — OmniScript preview, Integration Procedure step debugging, DataRaptor field-mapping validation, and end-to-end UTAM-based automation. NOT for Apex unit testing or standard Flow debugging. |
| category | omnistudio |
| salesforce-version | Spring '25+ |
| well-architected-pillars | ["Reliability","Operational Excellence"] |
| triggers | ["How do I test my OmniScript before deploying it to users?","Integration Procedure is returning an error — how do I debug which step is failing?","DataRaptor is not mapping fields correctly, how do I test it without deploying?","OmniScript Preview passes but users get errors in production","How do I set up automated testing for OmniStudio components in a CI/CD pipeline?"] |
| tags | ["omnistudio","testing","omnistudio-testing-patterns","integration-procedure","datarapter","utam","debugging"] |
| inputs | ["OmniScript or Integration Procedure component name and version","Runtime type: Package Runtime (managed package) or Standard/Core Runtime","Test user context: admin, community guest, named permission set user","Named Credentials or external callout details if testing Integration Procedures"] |
| outputs | ["Test execution plan for OmniScript Preview, IP Test Execution, and DataRaptor Preview","Debug analysis of vlcStatus, errorMessage, and step timing from IP test runs","UTAM test scaffold for end-to-end automation (if required)","Checklist of Preview-mode gaps that require environment-level verification"] |
| dependencies | [] |
| runtime_orphan | true |
| version | 1.0.0 |
| author | Pranav Nagrecha |
| updated | "2026-04-12T00:00:00.000Z" |
This skill activates when a practitioner needs to test, validate, or debug OmniStudio components — OmniScripts, Integration Procedures, or DataRaptors — before or after deployment. It covers the three built-in manual test surfaces Salesforce provides, their known gaps, and what end-to-end automated testing actually requires.
Gather this context before working on anything in this domain:
OmniScript Preview is an in-designer tool accessible from the OmniScript designer canvas. It renders the script using the designer's admin security context — not the target user's context — and skips Navigation Actions (Save/Navigate steps). It validates JSON structure, conditional rendering logic, and basic step sequencing, but it cannot test permission-controlled data access, FLS-gated fields, or Experience Cloud guest-user behavior. Preview is mandatory as a first-pass gate but must never be treated as final sign-off.
Integration Procedure (IP) designers include a per-step test execution panel that accepts a JSON input payload and returns the full step response including vlcStatus (success/error/warning), errorMessage, responseSize, and step timing. Each step can be tested in isolation by providing mock input — this allows identification of which step in a multi-step IP is failing without deploying and running the full chain. Named Credentials are evaluated at test execution time, making this the correct tool for testing IP callouts — but it still runs as the admin user.
DataRaptor Extract, Transform, and Load components all have a Preview/Test tab in their designer. Extract Preview accepts a record ID and returns field-mapped output; Transform Preview accepts a JSON input and shows the transformed output; Load Preview simulates a write operation. These are essential for validating field mapping formulas before wiring a DataRaptor into an Integration Procedure or OmniScript. DataRaptor Preview uses the admin context like the other tools.
UTAM (UI Test Automation Model) is Salesforce's open-source framework for describing UI component interactions in a JSON page-object format that compiles into Selenium WebDriver commands. For OmniStudio, UTAM page objects exist for the runtime components (OmniScript elements, step navigation, submit actions). End-to-end testing with UTAM runs against a fully deployed org in the target user's security context, making it the only approach that catches permission gaps and Navigation Action behavior. UTAM page objects for managed-package HTML differ from Standard Runtime HTML — use the correct page object library for the org's runtime.
When to use: Any OmniScript with Integration Procedure callouts, multiple steps, and role-based conditional fields targeting non-admin users (e.g., Experience Cloud guests, community users with restricted profiles).
How it works:
vlcStatus is success and review timing for any step exceeding 5 seconds.Why not Preview alone: Preview always runs as admin, skips Navigation Actions, and does not test Named Credentials in the real user context. Skipping step 4 is the most common production defect path.
When to use: An IP is failing in production or staging and the error message from the OmniScript output is vague (e.g., "Integration Procedure Error" without step detail).
How it works:
vlcStatus of error with a populated errorMessage pinpoints the failure; warning status may continue execution but silently produce partial data.| Situation | Recommended Approach | Reason |
|---|---|---|
| First-pass validation of OmniScript logic and rendering | OmniScript Preview | Fast, no deployment needed, validates JSON and conditional logic |
| Debug a failing IP step in isolation | IP Test Execution (per-step) | Pinpoints the exact step with vlcStatus + errorMessage, no redeployment needed |
| Validate DataRaptor field mappings | DataRaptor Preview/Test tab | Tests Extract/Transform/Load in isolation with real record IDs or mock JSON |
| Test with real user permissions and Navigation Actions | Deploy to sandbox + UTAM or manual test as target user | Preview and IP test always run as admin; only real user context catches permission gaps |
| CI/CD pipeline automated regression | UTAM with deployed sandbox | Only option for automated browser-level validation; requires maintained page objects |
| Validate Named Credential connectivity | IP Test Execution | Named Credentials are evaluated at IP test execution time; Preview does not call them |
Step-by-step instructions for an AI agent or practitioner working on this task:
vlcStatus, errorMessage, and timing. Resolve any step with a non-success status before testing the full IP end-to-end.Run through these before marking work in this area complete:
Non-obvious platform behaviors that cause real production problems:
warning continues execution but drops data — A step that returns vlcStatus: "warning" does not abort the IP — execution continues to the next step. However, the step's output may be partial or empty, silently producing corrupted downstream data. Treat all non-success statuses as failures during testing.vlocity_ins or vlocity_cmt namespace HTML structure; Standard Runtime uses the native structure. Using the wrong UTAM page object library against the wrong runtime produces false test failures. Always confirm the org's runtime before selecting UTAM page objects.| Artifact | Description |
|---|---|
| Test execution plan | Step-by-step test sequence for DataRaptor, IP, and OmniScript in-designer tools |
| IP debug analysis | JSON breakdown of each step's vlcStatus, errorMessage, and timing from IP test runs |
| Preview gap checklist | List of scenarios Preview cannot validate that require deployed-runtime testing |
| UTAM scaffold (if applicable) | Starter page object and test runner configuration for automated browser testing |