Skip to content

JSON Schemas

Report template development is much easier when using JSON schemas for validation as well as code completion and tooltips. A full JSON schema is available for report template, report options and external component files.

Schema URLs

The following URLs can be used to enable JSON schema validation for report template development.

File Type File Extension Schema URL
Report Templates *.rpt.json https://reporting.jhaea.com/schemas/ReportSchema.json
External Options *.opt.json https://reporting.jhaea.com/schemas/ReportOptionsSchema.json
External Components *.cmp.json https://reporting.jhaea.com/schemas/ExtCmpSchema.json

Add the following item as the first element of your JSON file to set the schema:

{
    "$schema": "https://reporting.jhaea.com/schemas/ReportSchema.json"
}

Once the schema has been set, you can take advantage of code completion, JSON validation and tooltip features.

Schema Feature Examples

Code completion shows all available options for a specific element in a Report Template:

!Code Completion

Tooltips display helpful information about each option and setting in a Report Template:

!Tooltips