Show TOC

 Definition of Changing Parameters Locate this document in the navigation structure

Use

You define changing parameters in function calls and input validations for the following changing parameters of the function module or check function:

  • Required changing parameters

  • Optional changing parameters for which you do not want to use the default value defined in the function module

To the parameter, you assign the variable whose value you want to transfer from the PI sheet to the function module. After the function has been carried out, the system returns the parameter value to this variable.

Changing parameters of function calls are displayed in the PI sheet.

You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet. However, note the following:

  • The function can be carried out more than once in the PI sheet.

  • The function may change the parameter value.

Prerequisites

The variable you assign to the parameter has been defined in a preceding process instruction of the same PI sheet or for the entire process order (see Use of Variables ).

Features

When defining a changing parameter, you specify the following information in the process instruction:

  • A text for the parameter (in function calls)

In the PI sheet, the text is displayed before the parameter value.

In input validations, you need not define a text since the parameter values are not displayed in the PI sheet.

  • The parameter name

  • The variable for the parameter value

To enter this information, you assign the following characteristics to the process instruction:

Characteristic

Meaning

Allowed Values

PPPI_INPUT_REQUEST

Text

(in function calls only)

Any short text (see also Using Text Symbols )

PPPI_CHANGING_PARAMETER

Changing parameters

Changing parameters of the function module

Characteristic for the variable that has the same data type as the parameter (see below)

Variable for the parameter value

Name of an existing variable

Notes on Variable Assignment

You can only transfer the value of a variable to a parameter if it has the same data type as the parameter in the function module.

The data type of a variable is identical to that of the value to which it refers.

Depending on the data type, you must use one of the following characteristics to assign the variable in the process instruction:

Characteristic for Variable

Data Type

PPPI_DATE_VARIABLE

Date

PPPI_TIME_VARIABLE

Time

PPPI_FLOAT_VARIABLE

Floating point number

PPPI_STRING_VARIABLE

Alphanumeric value