OmniScript Debugging Methods

// Get all OmniScript step elements on the page
// For Standard Runtime (omnistudio namespace):
document.querySelectorAll('runtime_omnistudio-omniscript-step')

// For Vlocity/Managed Package Runtime:
document.querySelectorAll('vlocity_cmt-omniscript-step')

// Get the first OmniScript step and access its JSON data:
let osStep = document.querySelector('runtime_omnistudio-omniscript-step');
console.log(osStep.jsonData);

// Pretty print the entire JSON payload:
JSON.stringify(osStep.jsonData, null, 2)

// Step 1: Open DevTools (F12) > Elements tab
// Step 2: Use element selector and find omniscript-step element
// Step 3: Right-click > "Store as global variable" (creates temp1)

// Step 4: Access the JSON data in Console:
temp1.jsonData

// Step 5: Get formatted JSON output:
JSON.stringify(temp1.jsonData, null, 2)

// Step 6: Copy to clipboard:
copy(JSON.stringify(temp1.jsonData, null, 2))

// If you have a custom LWC in the OmniScript, access via:
this.omniJsonData           // Returns the parsed JSON object
this.omniJsonDataStr        // Returns JSON as string

// Example in connectedCallback:
connectedCallback() {
    console.log('Full OmniScript Data:', this.omniJsonData);
    console.log('Specific field:', this.omniJsonData.Step1.FieldName);
}

// Push data back to OmniScript:
this.omniUpdateDataJson({ myField: 'newValue' });

// Apply response from external call:
this.omniApplyCallResp({ responseData: myData });

1. Open DevTools (F12) > Network tab
2. Clear existing requests before triggering the action
3. Trigger the OmniScript action (button click, step navigation)
4. Filter by "Fetch/XHR" to see API calls
5. Look for ApexAction requests containing:
   "aura?r=XXX&aura.ApexAction.execute=1"
6. Click the request > Payload tab > Form Data
7. Find "message" field containing the JSON payload
8. Copy and use a JSON formatter to decode

The Debug Log includes two entries for each element:

NAME        - Shows the OUTPUT of the element
NAMEDebug   - Shows the INPUT for the step

Example:
AccountExtract      - Output data from DataRaptor
AccountExtractDebug - Input parameters sent to DataRaptor

If you don't see expected outputs, review the debug entry
to find what's wrong with the input data.

1. Go to Setup > Debug Logs
2. Click "New Trace Flag"
3. Select Traced Entity Type:
   - User: Monitor specific user's activity
   - Apex Class: Log events for specific Apex class
   - Apex Trigger: Log events for specific trigger
   - Automated Process: For platform events and async processes
4. Set Debug Level (determines logging granularity)
5. Set Start Date and Expiration Date
6. Click Save

global with sharing class MyOmniScriptAction implements Callable {

    // Required method for Callable interface
    public Object call(String action, Map<String, Object> args) {
        Map<String, Object> input = (Map<String, Object>)args.get('input');
        Map<String, Object> output = (Map<String, Object>)args.get('output');
        Map<String, Object> options = (Map<String, Object>)args.get('options');

        // Add debug statements
        System.debug('Input: ' + JSON.serialize(input));

        return invokeMethod(action, input, output, options);
    }

    public Boolean invokeMethod(String methodName, Map<String, Object> input,
            Map<String, Object> output, Map<String, Object> options) {

        if (methodName == 'myAction') {
            // Your logic here
            System.debug('Executing myAction');
            output.put('result', 'Success');
            return true;
        }

        return false;
    }
}

global with sharing class OmniScriptDebugHelper implements Callable {

    /**
     * Debug helper class that prints all OmniScript input parameters
     * to the debug log exactly as received. Use this in Remote Actions
     * to see the complete data payload from OmniScript.
     */

    public Object call(String action, Map<String, Object> args) {
        Map<String, Object> input = (Map<String, Object>)args.get('input');
        Map<String, Object> output = (Map<String, Object>)args.get('output');
        Map<String, Object> options = (Map<String, Object>)args.get('options');

        return invokeMethod(action, input, output, options);
    }

    public Boolean invokeMethod(String methodName, Map<String, Object> input,
            Map<String, Object> output, Map<String, Object> options) {

        // Print the complete input JSON exactly as received
        System.debug('========== OMNISCRIPT DEBUG START ==========');
        System.debug('Method Name: ' + methodName);
        System.debug('----------------------------------------');
        System.debug('COMPLETE INPUT JSON:');
        System.debug(JSON.serializePretty(input));
        System.debug('----------------------------------------');
        System.debug('OPTIONS:');
        System.debug(JSON.serializePretty(options));
        System.debug('========== OMNISCRIPT DEBUG END ==========');

        // Return the input back to OmniScript for verification
        output.put('debugInput', input);
        output.put('debugMethod', methodName);
        output.put('debugTimestamp', System.now());

        return true;
    }
}

import { OmniScriptBaseMixin } from 'omnistudio/omniscriptBaseMixin';

export default class MyCustomComponent extends OmniScriptBaseMixin {

    connectedCallback() {
        super.connectedCallback();

        // Access OmniScript data JSON
        console.log('OmniScript Data:', this.omniJsonDataStr);

        // Parse the JSON data
        const omniData = JSON.parse(this.omniJsonDataStr);
        console.log('Parsed Data:', omniData);
    }

    renderedCallback() {
        // Debug after render
        console.log('Component rendered');
    }

    handleClick() {
        // Update OmniScript data
        this.omniUpdateDataJson({
            myField: 'newValue'
        });

        console.log('Data updated');
    }
}