Report Overview

What is Report Builder?

Report Builder (also labeled Report Designer in the application) is Sumo Ledger’s custom query and reporting workspace. It lets administrators define SQL-based data views, interactive actions, and visual dashboards without changing application code. End users then browse, run, filter, and export those views from a dedicated reporting portal.

Think of Report Builder as the layer that sits between raw ledger data and the people who need to read it:

• Administrators create and maintain report definitions in Settings → My reports.
• Business and operations users open published views from the View List and interact with the results.

Report Builder integrates with the broader platform in two important ways:

1. Process workflows — A Report Stage in a process can invoke a configured view and pass process variables as report parameters (for example, account_id, boid, or transaction references).
2. Forms and actions — Query reports can expose row-level Actions that open a Form Config and pass selected row data into downstream workflows (for example, Verify Details or Approve Loan).

---

Report Builder Capabilities

Capability	Description
SQL-based queries	Write custom SELECT statements against ledger tables (for example, table_data) to retrieve operational, account, and transaction data.
Parameterized reports	Define Input Parameters (such as account_id, boid, margin_call_threshold) that filter or scope query results at runtime.
Interactive actions	Attach Actions to query rows that map result columns into Form Config schemas and trigger business processes.
Tabular rendering	Display query output in a searchable, selectable data grid with column-level filtering.
Excel export	Export the current result set to Excel from the render view.
Dashboards	Render multi-chart dashboards with date-range filters for time-series analysis.
Multi-query reports	Combine multiple query sections into a single report definition (MULTI_QUERY view type).
Access control	Restrict who can view a report section using the Viewers field.
Import and export	Move report definitions between environments using JSON import/export.
Process integration	Reference configured views from the Report Stage inside process workflows.

---

View Types

Report Builder supports three primary view types. Each appears as a label in both the View List and My reports screens.

View Type	Purpose	Typical Use
QUERY	A single SQL query rendered as a table.	Account lookups, loan lists, holdings queries, validation checks.
MULTI_QUERY	A report composed of multiple query sections.	Related datasets shown together (for example, cheque bounce details plus supporting lists).
DASHBOARD	A visual layout with charts and filters.	KPI monitoring, trend analysis, management summaries.

---

Report Builder Screens

Report Builder exposes two main experiences:

View List (End-User Portal)

The default landing page at the Report Builder URL shows all published views the current user can access. Each row displays:

• Report identifier and name
• Short description
• View type (QUERY, MULTI_QUERY, or DASHBOARD)

Clicking a row opens the Render View for that report.

My reports (Administrator Settings)

Accessible from the gear menu → Settings, the My reports page is the management console. From here, administrators can:

• Search and browse all report definitions
• Add New Report
• Import Reports (.json) and Export Selected (.json)
• Open the configuration editor for any report via the row-level gear icon

---

Typical Workflow

┌──────────────────────────────────────────┐
│ Administrator creates report in Settings │
└──────────────────────────────────────────┘
                    │
                    ▼
┌──────────────────────────────────────────┐
│ Define SQL query and parameters          │
└──────────────────────────────────────────┘
                    │
                    ▼
┌──────────────────────────────────────────┐
│ Configure actions and viewers            │
└──────────────────────────────────────────┘
                    │
                    ▼
┌──────────────────────────────────────────┐
│ Save report definition                   │
└──────────────────────────────────────────┘
                    │
                    ▼
┌──────────────────────────────────────────┐
│ View appears in View List                │
└──────────────────────────────────────────┘
                    │
                    ▼
┌──────────────────────────────────────────┐
│ User runs query or opens dashboard       │
└──────────────────────────────────────────┘
                    │
                    ▼
┌──────────────────────────────────────────┐
│ Export Excel or trigger action           │
└──────────────────────────────────────────┘

1. An administrator creates a report in Settings → My reports.
2. The administrator writes the SQL query, adds input parameters, and optionally configures actions.
3. The saved view appears in the View List for authorized users.
4. Users run the query, filter results, export to Excel, or trigger row actions.
5. Process workflows can also invoke the same view through a Report Stage.

---