Remote Action Properties (Managed Package)

For the managed package runtime, this page contains information on Remote Action Properties.

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

Properties

Description

Remote Class

Vlocity Open Interface class.

Remote Method

Vlocity Open Interface method.

Remote Options

Additional class invocation options. The following options are predefined, but you can also pass options specific to the class.

  • InvocableInputKey —— Specifies a JSON map as Invocable Action input.
  • reserialize —— If true, reserializes the class output.
  • useStandardRuntime —— If true, forces the Apex class to run in the Omnistudio standard runtime, even if the Managed Package Runtime is enabled in Omnistudio Settings in Setup.

Extra Payload

Sends additional Key/Value pairs. Supports merge field syntax.

Invoke Mode

Configures the response behavior of the action:

  • Default — Blocks the UI with a loading spinner.

  • Non-Blocking — Runs asynchronously, and the response is applied to the UI. Pre and Post Omnistudio Data Mapper transforms and large attachments are not supported. When Invoke Mode is set to non-blocking, elements using default values will not receive the response because the element loads before the response returns. To map the response to an element, you must set Response JSON Node to VlocityNoRootNode and Response JSON Path to the name of the element.

  • Fire and Forget — Runs asynchronously with no callback to the UI. Pre and Post Data Mapper transforms and large attachments are not supported. A response will still appear in the debug console but will not be applied to the Data JSON.

Send Only Extra Payload

Enables the action to send Extra Payload's Key/Value pairs without including the Omniscript's data JSON.

Show Toast On Completion

Displays a message when the subordinate remote action completes.

Use Continuation

Enables a subordinate Integration Procedure that calls long-running actions to use Apex continuations.