The Report Portal is a web application that lets you browse, run, and subscribe to reports built with Report-SQL scripts. You don't need to know ETL-SQL syntax to use it — this guide covers everything from first login to managing your own subscriptions.

1. Logging In
2. Navigating the Portal
3. Browsing Folders & Reports
4. Running a Report
5. Viewing & Exporting Results
6. Subscribing to a Report
   • 6.1 Report Parameters
7. Managing Your Subscriptions
   • 7.1 Editing Parameters
8. Changing Your Password

Navigate to the portal URL provided by your administrator (for example, http://yourserver:5000 for the default HTTP port). You will be redirected to the login page.

Enter your username and password, then click Sign In.

Once logged in, the portal issues a short-lived access token (default: 60 minutes) and a longer-lived refresh token (default: 7 days). The refresh token silently re-authenticates you in the background, so you are unlikely to be asked to log in again within a week of normal use.

The portal has two main areas accessible from the top navigation:

The Reports page shows a folder tree in the left sidebar. Click a folder to expand it and see its sub-folders and reports.

• Folders you do not have access to are not shown.
• A stale indicator appears next to a report name when the source script has been modified since the last snapshot was built.

Click a report name to open it.

When you open a report, the portal loads the most recent snapshot — a pre-built result set stored on the server. If no snapshot exists yet, the report panel shows a Run button.

Click Run (or Refresh) to execute the report's underlying ETL-SQL script now. Execution happens asynchronously; a progress indicator appears while the job runs. When complete, the snapshot is updated and the result is displayed.

If a report declares parameters, an input form appears above the result panel. Fill in the values and click Run — the parameter values are passed to the script at execution time.

A report can contain multiple visuals — charts, tables, KPI cards, and text blocks. They are arranged by the page and container layout defined in the Report-SQL script.

Interactive ECharts visualisations. Hover over data points for tooltips. Use the chart toolbar (top-right of each chart) to:

• Download the chart as a PNG image
• Switch between chart view and the underlying data table

Paginated data tables. Click a column header to sort. Use the search box above the table to filter rows client-side.

Use the Export menu on any report to download the full result:

A subscription delivers a report to your email inbox on a schedule.

1. Open a report.
2. Click the Subscribe button (envelope icon).
3. Fill in the subscription form:

4. If the report declares parameters, a Parameters section appears below the delivery options. Fill in a value for each parameter (see 6.1 Report Parameters).
5. Click Save.

Some reports are written with INPUT parameters — values that control what data is included each time the report runs (e.g. date range, region filter). When you subscribe, you can set a value for each parameter that will be used every time your subscription fires.

A RELDATE parameter lets you say "yesterday" or "last month" instead of picking a specific date. The expression is stored as-is and resolved to an actual date each time your subscription fires — so "D-1" always means the day before the run, not the day before you subscribed.

Quick-pick buttons cover the most common values:

You can also type any valid expression directly in the text field — for example W-1 (start of last week), ME-1 (last day of last month), or N-2H (exactly 2 hours ago). Enter a fixed ISO date (2026-01-01) to pin the subscription to a specific date that never changes.

An empty field means no value (NULL) is passed for that parameter. Most report writers interpret a NULL parameter as "no filter" — meaning the report will return all data for that dimension. Check the report's description or ask your administrator if you are unsure.

Open My Subscriptions from the user menu (top-right). The list shows all subscriptions you own, with their schedule, next run time, and last delivery status. A compact parameter summary is shown for each subscription (e.g. @start=D-1 @end=D @region=—), where — indicates a null/unset value.

• Pause / Resume — toggle active state without deleting the subscription.
• Edit Parameters — opens a form pre-populated with your saved parameter values. Click the parameter summary text directly to open it quickly. Changes take effect on the next scheduled run.
• Delete — removes the subscription and cancels any pending scheduled job.
• History — shows the last delivery attempts with timestamps and any error messages.

Click Edit Parameters (or the parameter summary text) on any subscription row. The same per-type controls used in the Subscribe form appear, pre-populated with your saved values. Make your changes and click Save. The updated values are used on the next scheduled run — there is no need to recreate the subscription.

1. Click your username in the top-right corner and choose Change Password.
2. Enter your current password, then your new password twice.
3. Click Save.

Passwords must be at least 8 characters and contain at least one digit.