Previous  Next          Contents  Index  Navigation  Glossary  Library

Control the Behavior of Request Parameters

The behavior of parameters in programs running individually may differ from when those programs are run as part of a request set.

See:

Behavior of Program Parameters

Behavior of Parameters in Request Set

You define how a program's parameters behave when you define the program using the Concurrent Programs form.

Using the Request Set form, you can also define how a program's parameters behave when the program is run as part of a request. In addition, you can define parameters in different programs in a request set to all share the same value by labeling them as Shared Parameters. See: Sharing Parameters in a Request Set.

Warning: Modifying a concurrent program's definition by adding new or deleting existing parameters, or changing a parameter's value set can prevent the program from running. See: Warnings for Modifying Program Definitions.

Not Displaying Parameters

Using the Concurrent Programs form or the Request Set form, you can set a parameter so it does not display to an end user. Because parameters that do not display cannot be modified, setting a parameter to not display:

Warning: Set defaults for required parameters before setting the Display field to No. Otherwise the Submit Requests form returns an error when attempting to submit the program.

If you define a parameter to not display, then the parameter does not appear when the program is run using the Submit Requests form, nor does it appear in the Request Set form.

If you define a parameter to not display, using the Request Set form, then the parameter does not appear on the Submit Requests form when the program is run as part of a request set.

Viewing displayed parameters after a request is submitted

After a request is submitted to run a concurrent program, the program's parameters may be displayed in the Details block of the Concurrent Requests form.

When a parameter is set to not display, it does not appear in the Details block of the Concurrent Requests form.

These displayed parameter values exactly match the values that the concurrent manager passes to the concurrent program, and may or may not correspond to the displayed value that the user chose.

For example, in the Submit Requests form, the user may choose "Oracle General Ledger" as a parameter, but the corresponding application ID displays in the Concurrent Requests form.

Suggestion: If your users encounter errors when running a program, you can look at the exact values that the concurrent program uses to help you diagnose the problem.

Setting Default Values for Parameters

Parameter default values can be changed by users when they submit a program or request set to run.

You can set a default value for a parameter using the:

Entering erroneous default values

If the Default Type or Default Value for a parameter is incorrect, when the program is being set to run using the Submit Requests form, a window displays along with an error message.

If the parameter is not displayed, you receive an error message. You cannot update a field that is not displayed.

Warning: Be careful when entering the default type and default value, because these values are not validated with the value sets for your parameters. If you enter incorrect values, they do not appear as defaults when you run this request set using the Submit Requests form.

Preventing modification of parameter values in a Request Set

If a parameter is displayed in the Request Set form and there is no default value provided by the program's definition, you can define a default value or have the parameter inherit a shared value, and then prevent end users from modifying that value.

Set the Modify field in the Request Set form to No if you want to show the value for a parameter but not allow changing it when the request set is run using a Standard Submission form. You can set a value for the parameter using a default value or a shared parameter.

If the Display field is set to No, the Modify field automatically defaults to No, and you cannot update it.

Caution: Set defaults for required parameters before turning Modify to No. Otherwise the Submit Requests form returns an error when attempting to submit this report.

Changing responsibility to see changes take effect

Modifying parameter behavior, for example, changing whether a parameter is displayed to the end user, takes effect immediately after you commit your change. However, some changes do not appear to you unless you change responsibility or select your current responsibility again.

Behavior of Program Parameters

Parameter Details Concurrent Programs form Run Requests form
Required Yes Parameter requires a value (entered by user or a default).
Display Yes Parameter is displayed.
  No Parameter is not displayed, and cannot be modified.
Default Type & Value Yes - Default Type and Value entered. A default value displays, and can be changed by the user.
  No default entered. No default value is displayed.

Behavior of Parameters in Request Set

Parameter Details Concurrent Programs form Request Set form Run Requests form
Required Yes Parameter does not require a value. Parameter requires a value.
Display Yes Parameter is displayed. - Display set to Yes. Parameter is displayed.
    Parameter is displayed. - Display set to No. Parameter is not displayed.
  No Parameter not displayed. Parameter not displayed.
Modify n/a Yes Value can be modified.
  n/a No Value cannot be modified.
Default Type & Value Yes - Default Type and Value entered. Default Type and Value cannot be modified. Default values can be changed by the user.
  No default entered. Yes - a Default Type and Value can be entered. Default values can be changed by the user.
    No - Default Type and Value are not entered. No default value is displayed.

Warnings for Modifying Program Definitions

Action Form Used Warning
Changing the number of columns or rows in a report program. Concurrent Programs - Report Information region. Some report programs are written to produce a precise output. Changing the output definition could prevent the program from running, or produce poor results.
     
Setting print style to Dynamic. Concurrent Programs - Report Information region - Style field. Dynamic print style informs the program to generate its output based on output dimensions that may vary. Special coding within a program is required to support the Dynamic print style.
     
Changing the number of parameters in a program definition. Concurrent Programs - Parameters window. Programs are defined to expect x number of parameters. If you add a new parameter (x + 1), the program will ignore it. Deleting a parameter can cause a program not to run.
     
Changing Value Sets. Concurrent Programs - Argument Details region - Value Set field. Programs expect values of a certain type and length. Programs may not operate if value set is changed.
     
Changing tokens. Concurrent Programs - Argument Details region - Token field. Programs expect values of a certain type and length. Program may not operate if expected token is not received.
     
Defining a concurrent executable or program's execution method as Immediate. Concurrent Program Executables - Execution Method field. Concurrent Programs - Executable Information region - Method field. Concurrent programs whose execution method is Immediate must be registered with the program library FNDLIBR. Application developers can register programs with program libraries, System Administrators cannot.

See Also

Copying and Modifying Program Definitions

Concurrent Program Parameters

Example of modifying a program's parameters

Concurrent Program Details Report


         Previous  Next          Contents  Index  Navigation  Glossary  Library