If a user does not provide the input parameters within the timeout period, the user interaction returns an exception. You can define the exception behavior in a scripted function.

About this task

If you do not define the action for the workflow to take if the user interaction times out, the workflow ends in the Failed state. Defining the exception behavior is a good workflow development practice.

Prerequisites

  • Add a user interaction element to the workflow schema.

  • Set the security.group and timer.date attributes for the user interaction.

  • Define the external input parameters of the user interaction.

Procedure

  1. Click the Edit icon (Edit icon) of the User Interaction element in the workflow schema.
  2. Click the Exception tab.
  3. Click Not set for the output exception binding.
  4. Click Create parameter/attribute in workflow to create an exception attribute to which to bind the user interaction.

    The Parameter information dialog box opens.

  5. Create an errorCode attribute.

    An errorCode attribute has the following default properties:

    • Name: errorCode

    • Type: string

    • Create: Create workflow ATTRIBUTE with the same name

    • Value: Type an appropriate error message.

  6. Click OK to close the Parameter information dialog box.
  7. Drag a scriptable task element over the user interaction element in the workflow schema.

    A red dashed arrow, which represents the exception link, appears between the two elements. The scriptable task element binds automatically to the errorCode attribute from the user interaction.

  8. Double-click the scriptable task element and provide an appropriate name.

    For example, Log timeout.

  9. In the Scripting tab of the scriptable task element, write a JavaScript function to handle the exception.

    For example, to record the timeout in the Orchestrator log, write the following function:

    System.log("No response from user. Timed out.");
  10. Link and bind the scriptable task element that handles exceptions to the element that follows it in the workflow.

    For example, link and bind the scriptable task element to a Throw exception element to end the workflow with an error.

Results

You defined the exception behavior if the user interaction times out.

What to do next

Create the dialog box in which users provide input parameters. See Create the Input Parameters Dialog Box for the User Interaction.