parameter

Report parameter definition

...

Syntax:

parameter Name ParameterDatatype QueryFlags {
[ DefaultValue ] [ Reference ] [ EnumerateMethod ] [ ValidateMethod ] [ StatusText ] PropertyArray
}

Name

Name of report parameter

Syntax:

<Identifier>

Restrictions:

The name must start with an uppercase letter and can only contain letters and numbers
The name should be given in mixed casing, starting with a capital letter.
Parameter names must be unique within the report

ParameterDatatype

Parameter datatype

Syntax:

#ParameterDatatype

Text - Text
Number - Number
Date - Date
Enumeration - Enumeration

QueryFlags

Flag that control the report order dialog

parameter Genre Enumeration<Genre> MW-BL {
}

Position	Type	Description
1	Mandatory	M = Mandatory. Any other character than M will be interpreted as not mandatory (i.e. optional).
2	Ranges	W = Allow functions as values with >,<,>=,<=,!= operators. Any other character than W will be interpreted as no custom validation and disallow >,<,>=,<=,!= operators.
3	Single value	S = Single value only. Any other character than S will be interpreted as not single (i.e. multiple values allowed). Multiple values are separated by ';' in the input.
4	Between	B = Between operator allowed. Any other character than B will be interpreted as not allowed.
5	Wildcards	L = Wildcards allowed (i.e. '%' and '_'). Any other character than L will be interpreted as not allowed.

Note: It's highly recommended to use a '-' character to indicate an unused option.

DefaultValue

Default value in report order dialog

Syntax:

default <String> ;

Note: When a PL/SQL method is used, assumes a single OUT parameter.

Reference

Logical unit reference

Syntax:

lov <String> ;

Optional. Reference to logical unit, or to a specific view, to be used for list of values.

Note: It is important to differentiate between LU-name and view name. If the entire name is uppercase or if it contains underscores, it is assumed to be a view, else the view is obtained by checking the corresponding logical unit.

EnumerateMethod

List of values method

Syntax:

enumerate <String> ;

Optional. Populates a drop down menu in the report order dialog for this parameter field.

Note: Assumes a single OUT parameter, and that the output values are 'field separator' separated.

ValidateMethod

Validation method

Syntax:

validate <String> ;

Optional. Performs a call to allow special validation of user input.

Syntax is: 'pkg.method' and assumes a single IN parameter. Values are validated by simply returning without exception.

StatusText

Status text

Syntax:

statustext <String> ;

Status text that is shown in the report order dialog when the user is prompted for this parameter value.

This page is generated from IFS Developer Studio at 2021-08-13 08:48.