Type 0: Definition of Import Parameters (SAP Library

Type 0: Definition of Import Parameters

Use

Caution

Note that by import parameters we mean the export 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.
In addition, you can 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. In 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 transfer when the function call is executed;
See also: Type 0: Optional Parameter Transfer.

The parameter name for each parameter to be passed on

The variables for each parameter value to be transferred;
You can only transfer the value of a variable to a parameter if the variable has the same data type as the parameter in the function module.

Note

If the import parameter is typed with reference to a table type, you can transfer an entire table from the PI sheet to the function module. In this case, you must have defined a repeated data request (table) as the output. If you have defined a simple data request, the system only outputs the value of the first table line. The system can only process single-column tables.

Import Parameters of Type Table

A function module can have import parameters that are typed with reference to a table type. A function module can, by comparison, also have concrete table parameters that you define using characteristic PPPI_TABLE_PARAMETER.
See also: Type 0: Definition of Table Parameters

Import parameters of type Table are defined in the same way as simple import parameters using characteristic PPPI_IMPORT_PARAMETER. The system automatically recognizes that these parameters are typed with reference to a table type.

You can use import parameters of type Table to transfer a variable to a table variable of the PI sheet. This means that the variable to which you want to transfer the value from the function module must be defined within a repeated data request (table).

Characteristic Definition

To enter this information, you assign the following characteristics to the process instruction in the sequence 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: < Alphanumeric value < Floating point number < Date < Time	Variable of data type: < Alphanumeric 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 .