Flow Parameters

Flow parameters supply the information required to successfully complete the tasks in a flow pattern.

A flow pattern has both task action parameters and flow parameters.
  • Task action parameters control how the application processes a task and how the task relates to other tasks in the flow pattern.
  • The flow parameters include those task parameters that the application can't derive without manual entry. Flow parameters are a subset of task action parameters. They supply the information required to successfully complete the tasks in the flow pattern.

A parameter is defined in the application database using a Base Flow Parameter Name. If the parameter name, exposed in the UI at the flow-level, matches the Base Flow Parameter Name, then the list of values are defaulted directly. The Base Flow Parameter Name isn't exposed on the UI.

The values of some task parameters can't be derived or defaulted, and you must make a manual entry. The other parameters are defaulted or are derived. You can add new flow parameters from the list of available task parameters, or update the details of the existing flow parameters.

If required, edit a base flow parameter and rename it. You can see the edited parameter name on the flow submission page when you submit the flow.

Consider the following while reviewing and editing parameters.

Display and Display Formats

This table lists the options to control the format and availability of the flow parameter on the UI.

Flow Parameter Display Factors

Option Purpose
Display Use Display to control the availability of the flow parameter on the UI. The options include:
  • Required - Display the parameter on the UI and it's required for you to enter a value during flow submission.
  • No - Derive or default the parameter value, the parameter isn't displayed on the UI.
  • Yes - Display the parameter on the UI, but it's optional for you to enter a value during flow submission.
Display Format Identifies the type of data displayed on the UI, such as a date or text, or choice list
This table displays the display format options that you can use for the different types of flow parameters.

Display Formats of Flow Parameters

Display Format Code Usage
Date D Use this format for a Date parameter. Use the date picker to enter an input value.
Choice List L Use this option to display a list of values coming from a value object. The values includes a specific code and meaning.
Lookup Choice List LK Use this option to display a list of values defined in a lookup.
Number N Use this option to enter only numbers, such as 0, 1, -1, 0.5
Positive Number PN Use this option to enter only non-decimal, positive numbers, such as 0, 1, 2, 3.
Smart LOV LOV Use this option as an advanced version of List Of Values supporting user-defined values based on dependency, view criteria, display, and storage attributes backed by a value object.
Text T Use this option to enter any text.
Value Set ORA_VALUESET Use this option to display a list of values defined within a value set.
Typed Search TS Use this option to display a list of values defined by a value set using lazy loading support.
WebCenter Content File UCM Use this option to upload files to the UCM server and pass the UCM ID to the process.
Integer INT Use this option to enter only non-decimal numbers, such as -1, 0, 1, 2, 3.
Positive Rational Number PRN Use this option to enter positive numbers including decimal, such as 0, 1, 2, 2.5, 3, 3.5.

When defining your flow parameter, use the Display value options to determine if the parameter should be displayed on the UI and if a parameter value is required when you submit the flow.

Sequence

Sequence numbers determine and control the order in which the the application processes and displays the parameters on the UI for you to enter a value.

For example, if you have two lookups and the values of the second lookup depends on the first lookup. You must set the first lookup to a lower sequence number than the second one.

In the case of hidden parameters, they're processed after a required or dependent parameter is processed.

Usage

A parameter can receive information or generate information that subsequent tasks can use. For example, for the Calculate Payroll task, the Payroll Process parameter for the Submit task action generates an output value for the payroll action ID. The Retry task action can use this payroll action ID.
  • Receive Information
  • Generate information that subsequent tasks can use

For example, for the Calculate Payroll task, the Payroll Process parameter for the Submit task action generates an output value for the Payroll Action ID. The Retry task action can uses this Payroll Action ID.

Positive Number Validation for Check Numbers

When you use the Generate Check Payments task, you can only enter positive, whole numbers for the Start Check Number and End Check Number parameters.

By default the positive number validation is enabled on these two check number parameters and this validation takes place when the parameters are submitted. The validation ensures that these two parameters only take positive numbers without any decimals, alpha characters, special characters, or comma separators. If you enter an alpha-numeric Start Check Number and submit the flow, an error message displays asking you to enter a positive whole number in the Start Check Number or End Check Number field.

For user-defined flows, use the Positive Number display format type for these two parameters to enable positive number validation.