Types of Report Parameters in Arnica WebReport

May 24, 2024 by Igor Lozhkin
Report parameters in Arnica WebReport can be prompted or not prompted (hidden). There are several variations of these types. The complete set of parameter types is listed below:

Prompted parameters - unconditionally-prompted parameters are always displayed in prompt dialog. Parameters can accept user-entered values. Users cannot disable presentation of this parameter in the prompt dialog. Report engine can use this value in internal processing and it displays the parameter and its value in read-only mode on the report output page above the data table.   Parameters of this type can be used in reports where designers predefine a set of parameters for users without possibility to customize choices visible on the screen.

Prompted parameters (allow user customization, prompted by default) - this type of prompted parameters are conditionally displayed in the prompt dialog. Parameter can accept a user-entered value. Users can enable or disable presentation of this parameter in the prompt dialog, however this parameter is displayed by default when user runs the report for the first time. Report engine can use this parameter in internal processing and displays the parameter and its value in read-only mode on report output page above the data table.  This type of parameter can be used in reports, which allow users to customize parameter/filter selection which is relevant to their business use.

Prompted parameters (allow user customization, not prompted by default) - this type of prompted parameters are conditionally displayed in the prompt dialog. Parameter can accept user-entered values. Users can enable or disable presentation of this parameter in the prompt dialog, however this parameter is hidden by default when the user runs the report for the first time. Report engine can use this parameter in internal processing and displays the parameter and its value in read-only mode on report output page above the data table.   This type of parameter can be used in reports, which allow users to customize parameter/filter selection which is relevant to their business use.

Not Prompted parameters (never displayed) - these are hidden parameters  - they are never displayed in the prompt dialog. Parameter cannot accept user-entered values. Users cannot enable presentation of this parameter in the prompt dialog. Report engine can use this value in internal processing but never displays the parameter and its value on the report output page above the data table.   This type of parameter should be used in background data filters, which are hidden from users to securely create data scopes to be presented by the report. 

Not Prompted parameters (displayed on output page) - these are hidden parameters  - they are never displayed in the prompt dialog. Parameter cannot accept user-entered values. Users cannot enable presentation of this parameter in the prompt dialog. Report engine can use this value in internal processing, however it displays the parameter and its value in read-only mode on the report output page above the data table.   This type of parameter should be used in background data filters to securely create data scopes to be presented by the report. 


report_parameters.png