Report
Report() returns output from a Quintessence report.
ReportAsync() runs the report in the background, which is especially useful for larger reports since Excel stays responsive until the data is ready.
Qx.Report(Report, Headers, Arg1, Arg2, Arg3 … Arg16)- In Excel with Quintessence addin versions prior to 25.1, use:
Report() - In the Quintessence Editor (Studio) using Quintessence language, use:
Report() - In the Quintessence Editor (Studio) using Python language, use:
Qx.Report()
ⓘ See parameter descriptions
| Report | The name of a Quintessence report. |
| Headers (optional) | This parameter is required for ReportAsync(). For Report(), the value may be left blank. |
| Arg1, Arg2, … Arg16 | The parameter values, in order, as defined in the report configuration. |
Remarks:
- Unless changed by an administrator, the default parameters are:
- Headers:
True
- Headers:
Examples:
The examples provided below are based on fictitious data for illustrative purposes only.
> Example 1: Calling a report
A report named Get Location, which takes five parameters, is set up in Quintessence. The parameters are listed below.
| Parameter name | Parameter type | Cell location in Excel |
start_date | Date | B2 |
price | Number | B3 |
location | Text | B4 |
in_africa | True/False | B5 |
countries | Array | B6:C7 |
This report can be called from Excel using the formula below.
=Qx.Report(“Get Location”, True, B2, B3, B4, B5, B6:C7)