A2v10 Platform documentation
UK


Reports

An A2v10 report refers to either an external report (Stimulsoft) reporting system is supported), or an file that is uploaded in an xml or json format.

The reports object describes the reports possible at the current endpoint. Object property names are the names of the reports. Each property represents object of the following structure:


Properties of the report object

Name Type Description
source string Optional. Data source. If not specified, taken from the parent item.
schema string Optional. Name of the SQL schema. If not specified, taken from the parent item.
model string Name of the model. If not specified, taken from the parent item.
procedure string Name of the stored procedure for building a report. If not specified, based on the model name with the '.Report'" suffix.
parameters object Object, the static parameters that are passed to the model download stored procedure. The property name is the name of the parameter, the value is the value of the parameter.
type enum Report type. Possible values:
  • stimulsoft - default. Stimulsoft report. You must specify the value of the report property;
  • xml - xml format report;
  • json - json format report.
Please note. Json reports are often used during the debugging process to make sure that the data model for the xml report is formed correctly.
report string Only for the Stimulsoft reports. Report file name without extension. The .mrt extension will be added.
name string Name (title) of the report. In export mode, this name specifies the name of the file to be exported. You can use macros. Details are below.
encoding string Only for xml reports. Xml file encoding. Represents any valid encoding. The most commonly used is 'utf-8', 'utf-16' or 'windows-1251'.
xmlSchemas string[] Only for xml reports. An array of strings that specify xml schemas for building/validating of the xml reports. Schema file names are specified without the extension (the .xsd extension will be added) and relative to the current folder (you can use ../ to access the parent folder.)
validate boolean Only for xml reports. Whether to check the report for compliance with the xml-schemas specified in the xmlSchemas array.
variables object Object to be passed to the stimulsoft report as the Variables. Used if you want to change the behavior of the report form depending on external conditions.

More about macros

You can use macros in the report file name to access the properties of the current model. A macro is the full name of a property (from the root element) in a data model in double parentheses.

Example:

	

Please note! Stimulsoft libraries are NOT part of the platform. You need to purchase a separate license to work with reports.