Report Parameters View
The Report Parameters view is used to create all the parameters that must be passed to the 3rd party report in order to execute it and produce a report output file.
Report Parameter Features
Almost all reports you run that are based on data, or queries, from the LemonEdge platform are going to require some parameters to be passed to the report. This parameter setup screen allows you to create those parameters, allow them to be visible (or not) for selection to the user before running the report, or provide default values/formulas for them.
This ensures you get a LemonEdge setup screen to correctly select values that are passed as parameters to the report service to correctly execute the report, providing a seamless experience for the user.
If you are basing your report on any query created from our reporting suite, then they are likely to require the following standard parameters as a minimum:
- Account - The account id to run this query under. Not visible to the user, can't be bypassed and is automatically populated by the system at run time.
- Canvas - The canvas this query is to run within. Not visible to the user, can't be bypassed and is automatically populated by the system at run time depending what canvas the user is operating in.
- Team - The team to use to run this query for permission checking. Not visible to the user, can't be bypassed and is automatically populated by the system with the team the user is currently running in
- As Of - A date/time to run this query "as of" in the past. Visible to the user, is optional, and allows them to run the query using the current data or the data as of any point in the past.
The system also has the following special report parameter values, that should be hidden as they are always automatically provided a value from the system, you can't specify it:
| Name | Value Passed | Description |
|---|---|---|
| @databaseName | The current name of the connected database | The name of the database the user is connected to. Can never be changed, the system will always provide the value if this parameter is configured in the report. |
| @databaseServer | The current name of the connected sql server instance | The name of the sql server instance the user is connected to. Can never be changed, the system will always provide the value if this parameter is configured in the report. |
Report Parameter Properties
The parameters for your Report have the same functionality as SQL Wrapper Parameters [see here]. Specifically for Reports they have the following properties:
| Name | Description |
|---|---|
| [Required] Name |
The user friendly name for this parameter |
| Description | A user friendly description for this parameter that is shown as a tooltip to the user |
| SQLType | The underlying sql type for this parameter in the function or procedure it writes for you. This should match the underlying sql type of the field itself if you are mapping it to one. i.e. if this holds an ID to a record then it should be of type uniqueidentifier. |
| IsNullable | Indicates if the field can be left blank with no input from the user |
| Max Length | If the field is a type of text field (nvarchar, etc) this indicates the max length for that field. Leaving this blank would be the equivalent of varchar(max) - presumably unnecessary for a text input parameter though. |
| Precision | If this field is a decimal this holds the precision value. i.e decimal(16,8) |
| Scale | If this field is a decimal this holds the scale value. i.e. decimale(16,8) |
| Visible | Indicates if this parameter should be visible to the user. By default some system parameters are not visible, such as those for permissions. This gives you the ability to make a field invisible and auto populate the value through formulas. |
| EntityType | If this field maps to a field in the system you can specify the entity type of that field here. Doing so will mean the system will understand automatically how to display a control for this parameter. For instance if you select Tasks as Entity Type and ID as Entity Property Name, the system will provide a popup of all available tasks for this parameter. |
| Entity Property Name | The property this field maps to within the selected EntityType. |
| Format | Applies any formatting to the display of this control. [see here for more info] |
| [Required] [Key] Param Name |
The unique parameter name. Must begin with an '@' symbol. |
| Required | Indicates if the user must enter a value for this parameter |
| Default Value | Provides a hardcoded default value for this parameter |
| Formula Value | Provides a formula that can be run at execution time to determine a default value for this parameter |
Commands
Note
A Report has the standard set of commands and functions when being viewed from a grid. See our standard grid functionality.