Loading
Prepare for Email to Become the Default Login ExperienceRead More
Salesforce Enforces New Security Requirements in Summer 2026Read More
Customize Omniscript Error Messages (Managed Package)

Customize Omniscript Error Messages (Managed Package)

For the managed package runtime, the error message handler enables you to replace default error messages from remote apex calls with more user-friendly error messages when errors occur in Omniscript. The Error Messages handler property is available in File elements, Image elements, all Action elements, Omniscript Script Configuration, and Setup.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Note
Note

Error Messages set in the Setup or Script Configuration properties apply to any matching error returned by an element, while Error Messages set in an Action’s properties only render for that Action.

Error Message Type

Description

Default Error Message

A default message that returns when no Custom Error Messages are matched or defined. The Default Error Message property is not available in Script Configuration or Setup.

Custom Error Messages

Messages that are returned based on the defined path and value. Custom Error Messages are configured using the following fields:

  • Path: A merge field path that locates the original default value inside an error object.

  • Value: The original error message, including spaces, that will be replaced by the text defined in the Message field. This value must match the original error exactly.

  • Message: The custom message that will replace the error text defined in the Value field.

  • Set the Default Error Message on an Omniscript Element (Managed Package)
    For the managed package runtime, replace a Default Error Message with a user-friendly error message when a remote apex call error occurs in your Omniscript. A default message returns when no custom error messages are matched or defined. Update the default error messages for Image, Action, and File elements.
  • Set a Custom Error Message That Returns as an Object (Managed Package)
    For the managed package runtime, set a Custom Error Message for an error that returns as an object. A Custom Error Message returns based on a defined path and value. Set custom error messages for File elements, Image elements, all Action elements, Omniscript Script Configuration, and Setup.
  • Set a Custom Error Message That Returns as a String (Managed Package)
    For the managed package runtime, set a Custom Error Message for an error that returns as a string. A Custom Error Message returns based on a defined path and value. Set custom error messages for File elements, Image elements, all Action elements, Omniscript Script Configuration, and Setup.
 
Loading
Salesforce Help | Article