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:
For more information see Data Objects.
NOTE. Parameters ARE case sensitive.
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'.
Each Parameter has the following properties:
A name for the parameter. Prompting parameters are sorted alphabetically by name unless otherwise specified or unless there are dropdown parameters with dependencies.
The type of parameter being used.
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.
Check hidden to disable this parameter from being used by users in cells and formulas.
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.
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).
A list of preexisting Exago parameters to be used as variables for a selected stored procedure.
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.
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.
The display value data type.