Getting Started
After installation and first login, you’ll land on the dashboard. This guide walks you through the main areas of the application and shows how to create your first report.
Interface
Section titled “Interface”The application consists of a sidebar on the left and the main content area on the right.
Sidebar:
- Reports — List of all reports with folders
- Data Sets — Reusable queries
- Data Sources — Connections to databases and APIs
- Environments — Deployment stages (e.g. TEST, PROD)
- Schedules — Automated report execution
- Users & Groups — User management (admins only)
- Audit Log — Change log (admins only)
- License — License status and activation
At the bottom of the sidebar you’ll find the Environment Switcher, which lets you switch between Base Config and your configured environments.
First Report — Step by Step
Section titled “First Report — Step by Step”1. Create a Data Source
Section titled “1. Create a Data Source”Navigate to Data Sources and click New Data Source.
- Enter a name (e.g. “Sales DB”)
- Select the type (e.g.
jdbcfor a SQL database) - Fill in the connection parameters (host, port, database, credentials)
- Click Test Connection to verify the connection
- Save the data source
2. Create a Data Set
Section titled “2. Create a Data Set”Navigate to Data Sets and click New Data Set.
- Enter a name (e.g. “Revenue by Customer”)
- Select the data source you just created
- Write your query, e.g.:
SELECT customer, revenue FROM v_revenue_summaryWHERE country = {{param.country}}
- Click Run to test the query. Detected parameters appear as input fields above the Run button.
- Save the data set
3. Create a Report
Section titled “3. Create a Report”Navigate to Reports and click New Report.
- Enter a name
- The report designer opens with a blank page
- Add panels:
- Text panel for titles and descriptions
- Table panel for data tables — select your data set
- Image panel for logos or images
- Position and style the panels via drag & drop
- Define report parameters if your data sets use parameters
4. Export PDF
Section titled “4. Export PDF”Click Export PDF in the report designer. The report is rendered as a PDF with live data.
Next Steps
Section titled “Next Steps”- Data Sources — Configure connections in detail
- Data Sets — Queries with SQL, REST and GraphQL
- Reports — The report designer in detail
- Versioning — Versions and snapshots
- Environments & Deployments — Set up deployment stages