1. App Builder User's Guide
  2. Managing Workflows and Tasks
  3. Creating a Workflow
  4. Creating a Workflow Parameter

20.2.1 Creating a Workflow Parameter

Create a workflow parameter by right-clicking on the workflow and selecting Create Parameter.

A workflow parameter is an input for the workflow. APEX passes parameters to the workflow instance when the workflow starts. A parameter applies to all versions of a workflow, and the value of a parameter does not change during the workflow runtime.

To create a workflow parameter:

  1. Right-click on the workflow and choose Create Parameter.
    Create Version and Create Parameter are options on the Workflow context menu. Create Activity, Create Variable, and Create Participant are options on the Workflow Version context menu.
  2. Define the parameter attributes:
    1. Static ID - The unique name of the parameter.
    2. Label - The user-friendly label for the parameter.
    3. Data Type - Allowable data types are VARCHAR2, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, NUMBER, BOOLEAN, CLOB.
    4. Direction - The direction of the parameter as defined in the workflow. Select In, Out, or In/Out.
      Note that Out parameters do not appear in the Page Process Component Parameters section when the workflow is used in a page process. Out parameters only appear when the workflow is used in the Invoke Workflow activity of another workflow.
    5. Value - Specify whether the parameter is required and must always be set.
    6. Session State Format Mask - Only applicable for some data types. For more information, see item-level help.
    7. Application Format Masks - Only applicable for some data types. For more information, see item-level help.
  3. Under Value:
    1. If the parameter is required, turn on the Required toggle.
    2. Set the Default Value.

Parent topic: Creating a Workflow