Help ELMA BPM Platform
×
Menu

Adding a Parameter

There are two ways to add a parameter:
Fill in the required fields in the opened dialog box (fig. 1) and click OK.
Adding a parameter dialog window contains the Common (fig. 1) and Advanced (fig. 2) tabs. The Advanced tab will be displayed once you select the data type of the parameter being configured.

Common tab

In fig. 1 you can see the Common tab.
Fig. 1. Create parameter dialog box
Displayed Name * – name of the parameter, displayed in the list of report parameters on the Parameters tab, on the Data Sources tab and on the report form in Web Application. This field is required.
Type * parameter type. This field is required. Note, that you cannot change the parameter type after publishing the report and restarting the server.
Required field – when you check this box, this parameter becomes a required field in Web Application.
Description – parameter description. It is displayed in the object documentation.
"Data Structure" unit
Property Name * – unique name of the parameter. By default the parameter name is generated automatically when you fill in the Displayed Name * field. You can fill in this field manually, if necessary. This field is required.
Additional fields, displayed on this tab, depends on the parameter type.

Advanced tab

This tab has the Display Settings tab (fig. 2) with the Filter Form field:
Show – the parameter being configured will be displayed on the report parameters input form in web application. By default, this box is checked.
Read only – the parameter being configured will be available only for reading on the report parameter input form in web application. This box is displayed if the Show box is checked.
Fig. 2. Create parameter dialog box. Advanced tab
Depending on the parameter type, the Settings unit might be displayed on this tab. The displayed fields also depend on the type of the selected parameter (fig. 3).
Fig. 3. Example of the Settings unit for the parameter of the String type
The fields of the tab are described in the respective Help page.

Copyright © 2006–2019 ELMA