Type 0: Definition of Import Parameters (SAP Library

Type 0: Definition of Import Parameters

Use

Note that by import parameters we mean the import parameters of the PI sheet or cockpit (PPPI_IMPORT_PARAMETER), this means, the values that are transferred from the function module to the PI sheet or cockpit. From the function module's point of view, they are export parameters.

You define import parameters (export parameters of the function module) in dynamic function calls. To the import parameter, you assign the variable whose value you want to transfer from the function module to the PI sheet or cockpit.

You can display the variable in the PI sheet or cockpit.
You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet or cockpit. Note, however, that the function may be carried out more than once in the course of PI sheet or cockpit maintenance.

Prerequisites

If you want to transfer the value of a variable from the function module to the PI sheet or cockpit, the variable must be defined in the same PI sheet or cockpit. With PI sheets, the variable may also have been defined for the entire process order.

For more information on how to use system variables and variables in general, see:

Using Variables in Browser-Based PI Sheets and Cockpits

Using System Variables in Browser-Based PI Sheets

Activities

When defining import parameters, you specify the following information in the process instruction:

The export parameters of the function module

If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed;
See also Type 0: Optional Parameter Transfer.

The parameter name for each parameter to be passed on

The variable for each parameter value to be passed on;
You can only pass on the value of a variable to a parameter if it has the same data type as the parameter in the function module.

To enter this information, you assign the following characteristics to the process instruction in the order specified below:

Characteristic	Meaning	Allowed Values
PPPI_IMPORT_PARAMETER	Import parameters	Export parameters of the function module
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE	Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time	Variable of data type: < Alphanumerical value < Floating point number < Date < Time
PPPI_OPTIONAL_PARAMETER	Optional parameter transfer	< Parameter transfer not optional < Parameter transfer optional

If you want to display the variable value in the PI sheet or cockpit, you must define an output field. For more information, see Type 0: Definition of Output Fields for Variable Values.