Skip to main content
ComponentsEngineWorkspace
Availability2014.1 or later

Reports Overview

Scheduled and event-driven reports

Create a Report

Step through the wizard

Add Queries to a Report

Combine multiple query results

Configure the Report Template

Control layout and format

​
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:
  • Define the report and its execution method.
  • Add one or more data queries.
  • Configure the report template.

​
Create a Report

  1. Go to GermainUX Workspace > Automation > Report.
  2. Click + to open the Report wizard.
  3. Configure the report details.
  4. Choose whether the report runs on a schedule or as a triggered action.
  5. Click Finish.
  6. When prompted, click the provided link to add queries to the report.

​
Report Settings

​
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 2024-10-01.

​
Trigger the Report as an Action

To generate the report in response to an event:
1

Disable Run on Schedule

2

Complete and save the report

3

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:

​
Choose a Query Type

Click + next to the template name, and then select a query type.

​
Scripted Query

Use a Scripted Query when the report requires multiple queries, custom processing, or advanced logic.
1

Select the query time range. Leave it blank if the script will define the interval programmatically

2

Write the JavaScript used to query the GermainUX Datamart

3

Use autocomplete to discover available functions and variables

4

Use the Fact Model glossary to identify the fields available for each data model

5

Click Refresh Preview to validate the results

6

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.
1

Complete the required fields

2

Add any necessary filters or constraints

3

Click Refresh Preview to display the results in a table

4

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.
1

Select the target data source

2

Enter the SQL query

3

Click Refresh Preview to validate the results

4

Click Save

Ensure that custom queries follow your organization’s database access, performance, and data-security policies.

​
Remove a Query

To remove a query:
  1. Click the Close icon on its query tab.
  2. 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.

​
Get Help

Contact GermainUX Support

The Germain Team can help you set this up.

Can't find what you need?

Search all GermainUX docs with Ctrl + K, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.