📊 Reports Overview
GermainUX reports can run automatically on a schedule or as actions triggered by events such as SLA breaches.
Creating a report involves three main steps:
|
Step |
|---|
|
Define the report and its execution method. |
|
Add one or more data queries. |
|
Configure the report template. |
📃 Create a Report
-
Go to GermainUX Workspace > Automation > Report.
-
Click + to open the Report wizard.
-
Configure the report details.
-
Choose whether the report runs on a schedule or as a triggered action.
-
Click Finish.
-
When prompted, click the provided link to add queries to the report.
⚙️ Report Settings
|
Field |
Description |
|---|---|
|
Name |
Unique name for the report. |
|
Distribution List |
Users or groups that will receive the report. |
|
Report Template |
Template used to generate the report content. Select an existing template or create a new one. |
|
Attach Result |
Attaches the report’s raw query results when enabled. |
|
Run on Schedule |
Enables automatic report generation according to the configured schedule. |
📅 Schedule the Report
Enable Run on Schedule, and then configure the desired execution frequency and time.
For example, configure the schedule to generate and distribute the report every day at .
⚡ Trigger the Report as an Action
To generate the report in response to an event:
-
Disable Run on Schedule.
-
Complete and save the report.
-
Add the report as an action to an SLA or another configuration that supports actions.
The report will then be generated whenever the associated condition occurs.
🔎 Add Queries to a Report
A report can contain one or more queries. Their results can be combined and presented through the report template.
You can access the Query Editor in either of these ways:
|
Option |
Instructions |
|---|---|
|
New report |
Follow the query-configuration link displayed after completing the Report wizard. |
|
Existing report |
Go to Automation > Report, select the report, and open one of its queries. |
📋 Choose a Query Type
Click + next to the template name, and then select a query type.
|
Query type |
Description |
|---|---|
|
Simple Query |
The easiest way to query the GermainUX datastore. No SQL knowledge is required. Supports relational and Elasticsearch datastores. |
|
SQL Query |
Runs a custom SQL query against a relational database. |
|
Scripted Query |
Uses JavaScript and GermainUX Java services and data-model classes for complex reporting logic. Supports the GermainUX Datamart with relational or Elasticsearch storage. |
📄 Scripted Query
Use a Scripted Query when the report requires multiple queries, custom processing, or advanced logic.
-
Select the query time range. Leave it blank if the script will define the interval programmatically.
-
Write the JavaScript used to query the GermainUX Datamart.
-
Use autocomplete to discover available functions and variables.
-
Use the Fact Model glossary to identify the fields available for each data model.
-
Click Refresh Preview to validate the results.
-
Click Save when the query produces the expected output.
For example, a Scripted Query could return the timestamp and browser associated with every user session recorded during the previous seven days.
✨ Simple Query
Use a Simple Query to build a report without writing SQL or JavaScript.
-
Complete the required fields.
-
Add any necessary filters or constraints.
-
Click Refresh Preview to display the results in a table.
-
Review the results and click Save.
For example, a Simple Query can count user sessions and group them by browser, such as Chrome, Firefox, or Edge.
🗄️ SQL Query
Use an SQL Query when the report must retrieve data directly from a relational database.
-
Select the target data source.
-
Enter the SQL query.
-
Click Refresh Preview to validate the results.
-
Click Save.
Ensure that custom queries follow your organization’s database access, performance, and data-security policies.
🗑️ Remove a Query
To remove a query:
-
Click the Close icon on its query tab.
-
Confirm the removal.
📁 Configure the Report Template
After configuring and saving the report queries, click the template button in the action panel to define how the results will be presented.
The template controls the report’s content, structure, formatting, and links. For configuration instructions, see Template Editor for Alerts and Reports.
Feature Availability: