Show TOC

Export parameters

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

When defining an export parameter, you also specify the following information in the process instruction:

The variable always refers to the input value that immediately precedes it. It must have been defined in the process instruction.

Enter this information by assigning the following characteristics to the process instruction:

Characteristic Meaning Allowed values
PPPI_EXPORT_PARAMETER Export parameter Import parameter of the
function module
Char. for variable (1)/
Parameter value Value to be exported:
constant (2) with Constant or
data type of parameter variable (3)

(1) Characteristics for variables:

Depending on the data type of the parameter, use one of the following characteristics to assign the variable:

Characteristic for variable Data type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value

(2) Characteristics for constants:

Depending on the data type, you can use the following standard characteristics to define a constant:

Characteristic for constant Data type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value

However, you can also use any other characteristic whose data type is identical to that of the parameter. You may want to do this, for example, if you do not want to assign the value to be exported manually but want to use automatic characteristic value assignment.

(3) Using variables in process instructions:

You can only use a variable in a process instruction if:

  • The variable has been defined in a preceding process instruction and is valid for the PI sheet or the entire process order
  • Its data type is suitable for what you want to use the variable for

If a variable refers to table entries, specific rules apply (see below).

Validity of variables

A variable is valid for the entire process order if it has been defined in a process data request or process data calculation formula using characteristic PPPI_GLOBAL_VARIABLE.

A variable is valid within the PI sheet if:

  • It has been defined in a process data request or process data calculation formula using characteristic PPPI_VARIABLE
  • It has been defined in a dynamic function call or an input validation

Data type of variables

The following table lists the data type a variable must have to be able to use it for specific purposes.

Using variables Required data type
In check formula (input validation) NUM
In check function (input validation) Identical to parameter
In calculation formula NUM
As default value Identical to input value
As output value Any
As values of message Identical to mess. characteristic
characteristics
In dynamic function call Identical to parameter

The data type of a variable depends on the characteristic that was used to define the variable (see table below). It is identical to the data type of the characteristic or parameter to which the variable refers.

Variable definition using Data type of variable
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
PPPI_VARIABLE and Identical to data type of charact. PPPI_GLOBAL_VARIABLE to which the variable refers

Reference to table entries

Variables that have been defined in a repeated data request refer to an entire table column. If you want to refer to a specific table entry, you must extend the table name. The following rules apply:

<Variable name>_1 -> Value in 1st table line
<Variable name>_2 -> Value in 2nd table line
etc. etc.
<Variable name>_SUM -> Sum of the values in table column
<Variable name>_COUNT -> Number of values in the table column