Submitting an Omniscript to the Vlocity Application Object (Managed Package)

For the managed package runtime, to create a Post to Object Action element:

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

  1. From the Omniscript, create the last Element with Type as Post to Object Action.
  2. If the Element will launch from inside a Step, place it inside a Step or Block. It will render as a button. If the Element will launch in between steps (remotely), place it at the same level as the Step (no Parent Element), after the final Step that you are collecting data from.
  3. If the Element is a button, the Property Set contains:
    • controlWidth—controls the width of the button

    • label—label on the button

    • restPath—/NS/v1/application. NS = Name space of the package.

    • restMethod—POST

    • postNameTemplate—the name of the Omniscript in the object. Supports merge fields—for example, %text1% Medical Application %date1%.

    • remoteTimeout—the timeout for the request, in milliseconds. If left blank, defaults to 30,000 (30 seconds. Maximum 120,000 (120 seconds).

    • validationRequired—whether to check the validation of the script or step before the Omniscript posts. Enter Submit to validate the entire script or Step to validate only the step that the button is on. Leave blank to bypass validation.

    • redirectPageName—custom redirect page name. Upon success, the script navigates to this page. Leave null to bypass the redirect page.

    • redirectTemplateURL—HTML template of the redirect page. The provided template is vlcApplicationAcknowledgeV2.html.

    • redirectPreviousLabel—the label of the previous button on the redirect page.

    • redirectPreviousWidth—the width of the previous button on the redirect page.

  4. If the Element runs remotely (in between steps):
    • label—heading of the Action block.

    • restPath—/NS/v1/application. NS = Name space of the package.

    • restMethod—enter POST.

    • postNameTemplate—the name of the Omniscript in the object. Supports merge fields—for example, %text1% Medical Application %date1%.

    • remoteTimeout—the timeout for the request, in milliseconds. If left blank, defaults to 30,000 (30 seconds. Maximum 120,000 (120 seconds).

    • inProgressMessage—message displayed while the action is being executed.

    • postMessage—message displayed upon success.

    • failureNextLabel—label of the continue button if the action fails.

    • failureAbortLabel—label of the abort button if the action fails.

    • failureAbortMessage—confirmation message displayed after user clicks abort button.

    • validationRequired—whether to check the validation of the script before Raptor is invoked. Default is Submit. Leave blank to bypass validation.

    • redirectPageName—custom redirect page name. Upon success, the script navigates to this page. Leave null to bypass the redirect page.

    • redirectTemplateURL—HTML template of the redirect page. The provided template is vlcApplicationAcknowledgeV2.html.

    • redirectNextLabel—label of the next button on the redirect page.

    • redirectNextWidth—width of the next button on the redirect page.