Request parameters with the current definition are saved in the DialogParameter table. All a request property's parameters are grouped together internally as a parameter set (DialogParameterSet). The parameter settings defined in the Manager are saved as default parameters. During the request, fixed parameter values can be entered in the Web Portal. These values are saved per request in parameter subsets. If the request has not entered a value, the parameter value from the default parameter set is used.
IMPORTANT: If the parameter settings in the default parameter set are changed and, as long as the requester has not entered their own values, the changes are passed on to all the requests in the shopping cart that use this parameter set.
NOTE: The Inherited value can be selected for various parameter settings. This does not affect request parameters. The parameter settings' default values apply that are shown next to the input fields.
There are three tabs for editing the parameter settings, the value definition, and scripts for calculating the values. The actual parameter values are shown next to the fields and menus.
Table 10: General parameter settings
Parameter name |
Parameter name. |
Parameter type |
Type of parameter. Permitted values are:
-
Fixed: Fixed parameter values are used. On the Value definition tab, enter the parameter value.
-
User prompt: The user must select a parameter value in the user prompt during the request.
-
Calculation: The parameter value is calculated during the request. On the Value calculation tab, enter the table column and the condition for calculating the value.
Other settings are shown or hidden depending on the type. |
Display name |
User friendly name for the parameter. To display language dependent display names, translate the given text with the button. |
Description |
Text field for additional explanation.Translate the given text with the button. |
Sort order |
Position of the parameter in the request property view in the Web Portal. |
Mandatory parameter |
Specifies whether this is a mandatory parameter. This parameter must have a value in it in order to make the request. |
Viewable |
Specifies whether the parameter is shown in the request in the Web Portal. |
Can be overwritten |
Specifies whether the parameter value can be overwritten during the request. |
Table 11: Value definition
Data type |
Parameter data type. |
Date add-on |
Additional information about calculating date and time data for displaying in the user interface. The value can be edited if the Date data type is selected. |
Value range |
Specifies whether the report parameter value has to be within a given range. If Yes, additional fields appear. |
Multivalue |
Specifies whether the parameter accepts multiple values. If Yes, users can select multiple value from a list. |
Multiline |
Specifies whether the parameter contents can have multiple lines. If Yes, line breaks are permitted. |
Data source |
Type of data source. Permitted values are:
-
None: The user can give any value.
-
Table: The user selects a value from a specified table column.
-
List of permitted values: The user selects a value from a predefined list.
You may require additional data depending on the data source. |
Table column (query) |
Additional data for the data source Table.
Table column for selecting the parameter value. The user can select a value from this table column. If the parameter is multi-value, you can select several values from this column as well. |
Display pattern |
Additional data for the data source Table.
Display pattern for table elements in lists in %column% notation. The ?? operator is permitted. This means, when one column's value is empty, another column's value is displayed.
Example: %column1??column2??column3% |
Type of display |
Specifies how data for the value query is displayed. For example, data from a hierarchical table can be displayed either hierarchically or in a list without a hierarchy.
Permitted values are:
-
Hierarchical: (Default) The data is displayed hierarchically.
-
List: The data is displayed in a list.
-
Inherited: The setting is inherited. |
Condition (query) |
Additional data for the data source Table.
Limiting condition (Where clause) for selecting the parameter value using a table column. The user can select a value from the result set. If the parameter is multi-value, you can select several values from this result set as well.
You can reference other parameters in the condition using the following syntax:
$PC(<Parametername>)$ |
List of permitted values |
Additional data for the data source List of permitted values.
List of values permitted in this parameter in the value=display name notation. If an = is no given, the entry counts as both value and display name.
Example: 1=internal 2=external
To display language dependent display names, translate each display name using the button. |
Overwrite empty value |
Specifies whether an empty parameter value overwrites the default value.
If this option is disabled, the default value is overwritten if a parameter value is not given. |
Parameter value |
Parameter value If a value range is given, the Parameter value (from) and the Parameter value (to) are displayed. |
Example value |
Example of the parameter.
If a value range is given, the Example value (from) and the Example value (to) are displayed. |
Default value |
Default value of the parameter. This is used if the user does not specify a parameter value and the Overwrite empty value option is not set.
If a value range is given, the Default value (from) and the Default value (to) are displayed. |
Table 12: Scripts for calculating values
Table column (calc.) |
Additional input for Calculated parameter type.
Table column for selecting the parameter value. The parameter value is calculated during the request. |
Condition (calc.) |
Additional input for Calculated parameter type.
Limiting condition (where clause) for selecting the value through a table column. The parameter value is calculated during the request. If the parameter is multivalue as well, several values may be found.
If a condition is not given and the parameter is not multivalue, the first value is used that is determined by the table column. If the parameter is multivalue and a condition is not given, all determined values are used. |
Valuation script |
Script in VB.Net syntax for modifying the parameter value. The script can be used as a formatting script and the existing parameter value modified or reset the parameter value. |
Validation script |
Script in VB.Net syntax for checking permitted values of parameters. Create a script that checks the user input. |
Data dependencies script |
Script in VB.Net syntax. The script allows parameter settings to be configured depending on the data. It is run during initialization and when values are changed. For example, the script can be used to dynamically determine whether a parameter is read-only or mandatory.
Example:
The P2 parameter should be a mandatory field when the P1 parameter has the value Mandatory field. The following script must be stored with the P1 parameter:
ParameterSet("P2").IsMandatory = (Value IsNot Nothing AndAlso Value.ToString() = "Mandatory") |