Show TOC

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

Use

You define table parameters in dynamic function calls. You can use table parameters to transfer values of a table column from a PI sheet to a function module. The function module can change the contents of the table and return the result to the PI sheet.

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.

Note Note

Note that an existing variable can only be transferred if it comes from a repeated date request (table). You can also output a variable within a repeated data request only. The variable refers to the entire table column.

If the function call is executed outside the table, all values of the table column are transferred to the function module.

End of the note.

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 table parameters, you specify the following information in the process instruction:

  • All required table parameters of the function module

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

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

    Table 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 variables 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.

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

Characteristic

Meaning

Allowed Values

PPPI_TABLE_PARAMETER

Table Parameters

Table 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 .