Create a Report

Reports can be executed as an action (for example, triggered by an SLA breach), or can be setup to run on a schedule. To setup a report, we first create a report, then add queries and finally, setup a template.

Creating a Report

1. In the side menu navigate to Automation > Report.

2. Click the plus icon to create a new report. You should see a wizard as below:

3. Complete the first page of the wizard and click Next:

   1. Name: The name of this report

   2. Distribution List: who this report will be sent to

   3. Report Template: The template to be used to generate the report content (you can create a new empty template or use an existing one)

   4. Attach result: If selected, the raw results will be attached to the report

4. Now we need to configure when the report will run. We can either run on a fixed schedule, or we can setup the report to run as an action (for example, when an SLA is breached).

5. Here is an example of how to configure a report to run daily at 9:00am:

6. If you want to run the report as an action, deselect the ‘Run on Schedule’ checkbox and add the report as an action to any configuration that allows running actions (e.g. SLA).

7. Complete the wizard by clicking Finish.

8. When the wizard completes, you will get a link to add queries to your report, click the link

Adding Queries to a Report

Once you click the link, you will be taken to a new view that allows to add/edit/preview queries.

A report can have one or many queries to query data that can then be visualized in a report by configuring a Template. To add/edit/remove queries for a report you can either:

1. Create a new Report and follow the link at the end of the wizard.

2. Find an existing Report by going to Automation > Report, select a Report and click on any of the queries.

Choose a Query

1. Click the blue plus button at the top of the page, next to the template name

2. You will be offered 4 choices for queries:

   1. Simple Query - This is a query against the Germain UX Datamart generated by selecting values from dropdowns, it is the easiest to configure and great for simple use cases.

   2. ES Query - An ElasticSearch query that can be configured to run against the Germain UX Datamart or any other ElasticSearch datastore. The query is written in SQL.

   3. SQL Query - A SQL query that can be configured to run against the Germain UX Datamart or any other Relational Database. The query is written in SQL.

   4. Scripted Query - A query against the Germain UX Datamart that is configured by providing a JavaScript script. This is great if your use case is too complex to use the options above.

3. Select an option

Simple Query

To add a Simple Query:

1. Complete the required fields and add any additional constraints that you would like.

2. Once completed, click the Refresh Preview button to display the result of your query as a table below.

3. When happy with the changes, click the save button in the actions panel.

The following example shows how to configure a report that will show a count of user sessions grouped by the browser type (e.g. Chrome, Firefox, Edge, etc):

ES Query

To add an ES/Elasticsearch Query:

1. Select the Datastore to use, either check Use Datamart or select a configured Elasticsearch Database and password.

2. Write the SQL to query the datastore - you will be provided with autocomplete options for table name inside the SQL editor.

3. You can use the database glossary on the right side to investigate what fields are available in a particular index:

3. Once you have written your SQL, you can click the Refresh Preview to preview the results and check that they meet your requirements. The example provided above shows the same query as our example in the Simple Query case.

4. When happy with the changes, click the save button in the actions panel.

SQL Query

This is very similar to the ES Query case. The only difference is that instead of querying an Elasticsearch index, the query will run against a Relational Database table.

Scripted Query

To add a Scripted Query:

1. Select the time interval to run the query on, or leave empty if you want to create this programmatically.

2. Write the script to query the Germain UX Datamart - you will be provided with autocomplete options the available functions and variables.

3. You can use the Fact Model glossary on the right side to investigate what fields are available in a particular fact model:

4. Once you have written your script, you can click the Refresh Preview to preview the results and check that they meet your requirements. The example above selects the timestamp and browser of each user session in the last 7 days. We can configure the script to perform multiple queries or any other logic written in JavaScript

5. When happy with the changes, click the save button in the actions panel.

Remove a Query

To remove a query, click the close icon on the query tab and confirm the dialog:

Editing the Template

When you have configured your queries and saved the changes, you can configure the report template by clicking the button in the actions panel. For more information about editing the Template, see our documentation here.

Feature Availability: 2024.2 or later