Scroll

Parameters

Parameters are used throughout the Exago application to store values. Although parameters can be created and given a default value in the Administration Console, parameters are designed to be set at runtime through the API.

In Exago parameters can be used to:

  • Pass values to Web Services, .NET Assemblies, or custom SQL Data Objects.
  • Set tenant values to assure security in a multi-tenant environment.
For more information see Data Objects.
  • Pass values into cells and formulas of a report. To display a non-hidden parameter in a cell type ‘=@ParameterName@’.
NOTE. Parameters ARE case sensitive.
  • Pass values into custom functions. For more information see Custom Functions.
  • Create a custom dropdown list of values for user selection on a report prompt.

All existing Parameters are listed in the Main Menu under Data. All the parameters that are added or edited will be displayed in a Tab entitled 'Parameters'.

  • To add a new parameter click ‘Parameters’ in the Main Menu then click the 'Add' button.
  • To edit a parameter either double click it or select it and click the 'Edit' button.
  • To delete a parameter select it and click the 'Delete' button.
  • To save changes click the ‘OK’ button or press the ‘Apply’ button.

 

Each Parameter has the following properties:

Name

A name for the parameter. Prompting parameters are sorted alphabetically by name unless otherwise specified or unless there are dropdown parameters with dependencies.

Type

The type of parameter being used.

Value

The default value of a parameter. This is intended to be overwritten at runtime through the API. Date values should be entered in yyyy-MM-dd format.

Hidden

Check hidden to disable this parameter from being used by users in cells and formulas.

Prompt Text

Give non-hidden parameters a prompt text to query the user for a value at the time of report execution. Leave blank to use the default value.

Parameter Dropdown Object

Optional Data Object for populating the parameter as a drop-down selection list. Only applicable with prompting parameters. Commonly used in conjunction with programmable data objects (such as stored procedures).

Stored Procedure Parameters

A list of preexisting Exago parameters to be used as variables for a selected stored procedure.

Value Field

A column from the data object or custom SQL that sets that actual value of the parameter at runtime.  This represents a set of values that are not displayed to the end user but are instead used when parameter values are required in custom SQL or stored procedures, or other server side processing.

Display Value Field

A column from the data object or custom SQL that sets the display value of the parameter for the dropdown selector.  This represents the set of values that should be presented to the end user when they are executing or scheduling a report.

Display Type

The display value data type.


Hidden Article Information

Article Author
Alex Agoado
created 2015-12-30 17:29:49 UTC
updated 2016-06-30 16:02:07 UTC

Labels
parameters, prompt for value, dropdown,
Have more questions? Submit a request