Show TOC

 Type 0: Definition of Export Parameters Locate this document in the navigation structure

Use

Caution Caution

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

End of the caution.

You define export parameters (import parameters of the function module) in dynamic function calls and input validations that are carried out using a check function.

Prerequisites

If you want to transfer the value of a variable to the function module, the variable must be defined in the same PI sheet or in the same 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:

Activities

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

  • All required import parameters of the function module

    Import parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.

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

    Import parameters are optional if the Optional indicator has been set. They do not need to be specified in the process instruction.

  • 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 variable, constant, or message characteristic for each parameter value to be transferred;

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

Notes on Parameter Value Assignment

  • If the value is available in the process order, you enter it as a fixed value in the form of:

  • A constant

    The characteristic you use to define the constant also determines the constant’s data type.

  • A message characteristic

    If you want to use a message characteristic, the characteristic must have the same data type as the parameter in the function module. You may want to use a message characteristic if the characteristic value is assigned in the order.

  • If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable . The variable has the same data type as the value to which it refers. In the process instruction, you must assign the variable to the appropriate characteristic depending on the data type.

Note Note

If the export 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.

End of the note.

  • In input validations, you use variable SY_VALUE or X to transfer the input value to be checked. The variable always refers to the value entered immediately before.

Export Parameters of Type Table

A function module can have export 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

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

You can use export parameters of type Table to transfer a table variable from the PI sheet to a function module. This means that the variable you want to transfer to 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_EXPORT_PARAMETER

Export parameters

Import parameters of the function module

< PPPI_STRING_CONSTANT or

< PPPI_FLOAT_CONSTANT or

< PPPI_DATE_CONSTANT or

< PPPI_TIME_CONSTANT or

< PPPI_STRING_VARIABLE or

< PPPI_FLOAT_VARIABLE or

< PPPI_DATE_VARIABLE or

< PPPI_TIME_VARIABLE or

< <Message characteristic>

Value transfer in constant:

< Alphanumeric value

< Floating point number

< Date

< Time

Value transfer in variable:

< Alphanumeric value

< Floating point number

< Date

< Time

For value assignment through message characteristic:

< Message characteristic

Any fixed value of data type:

< Alphanumeric value

< Floating point number

< Date

< Time

Existing variable of data type:

< Alphanumeric value

< Floating point number

< Date

< Time

Any message characteristic

PPPI_OPTIONAL_PARAMETER

Optional parameter transfer

< Parameter transfer not optional

< Parameter transfer optional