Edit a Template - GermainUX Docs

ServiceManagement

Availability8.6.0 or later

Charts and Graphs

Render results as charts

Tables

Formatted report tables

Calls to Action

Trigger actions from alerts

Template Context Data

Objects available to templates

Template Editor for Alerts and Reports The GermainUX Template Editor defines the content, formatting, charts, tables, links, and actions included in alerts and reports.

Open a Template

Method	Navigation
From an SLA	Go to Germain Workspace > Left Menu > Analytics > SLAs, select an SLA, and click Edit Template.
From the Templates page	Go to Germain Workspace > Left Menu > System > Templates and select a template.
From a report	Go to Germain Workspace > Left Menu > Automation > Report, select a report, and click Edit Template or View Template.

When editing a report template, use View to preview the generated report and verify the result.

Charts and Graphs

Report templates can render query results as charts. In these examples, context.at(0) refers to the first report result set. The .inline(800, 400) method embeds a chart at 800 × 400 pixels.

Area Chart

Example data:

Series	2023-08-01	2023-08-02	2023-08-03	2023-08-04	2023-08-05
area1	4,000	1,700	2,000	3,500	5,500
area2	2,000	2,000	2,000	3,000	3,000
area3	12,000	17,000	9,000	12,000	13,000

Use DATE for the horizontal axis, VALUE for the vertical axis, and NAME to identify each series:

${charts.area("Area Example", context.at(0), "DATE", "VALUE", "NAME").inline(800, 400)}

Bar Chart

Example data:

NAME	VALUE
Chrome	55
Safari	5
Firefox	25
Edge	12

${charts.bar("Bar Example", context.at(0), "NAME", "VALUE").inline(800, 400)}

Histogram

The following expression renders SESSION_DURATION with a bucket size of 10 and uses BROWSER to identify the series:

${charts.histogram("Histogram Example", context.at(0), 10, "SESSION_DURATION", "BROWSER").inline(800, 400)}

Pie Chart

${charts.pie("Pie Chart", context.at(0), "NAME", "VALUE").inline(800, 400)}

Ring Chart

${charts.ring("Ring Chart", context.at(0), "NAME", "VALUE").inline(800, 400)}

Trend Chart

The following expression creates a daily trend using DATE, VALUE, and NAME. The trend chart automatically fills gaps in the timeline:

${charts.trend("Trend Example", context.at(0), "day", "DATE", "VALUE", "NAME").inline(800, 400)}

Links to GermainUX

Use the ${links} shortcut variable to direct recipients to a GermainUX dashboard, drill-through view, or Analysis screen.

Dashboard with a Predefined Time Range

<a href="${links.predefinedTimeRange("Last 7 days", "AUTO").dashboard("My Dashboard")}">
  Open dashboard
</a>

Drill-Through for a KPI and Time Range

<a href="${links.timeRange("2024-03-09T00:00:00Z", "2024-03-10T00:00:00Z").drillthrough("CPU Usage")}">
  Open drill-through
</a>

Analysis Screen for a Specific Data Point

<a href="${links.rca("CPU Usage", "65ef2a134e72ab2d1c000060")}">
  Open analysis
</a>

Link-Building Order

Build methods in the same order as the corresponding GermainUX navigation path:

#PredefinedTimeRange(Today,AUTO)/Filter(Color,%3D%3D,RED,%7B%7D)/Drillthrough(User%20Click)

.predefinedTimeRange(...)
.filter(...)
.drillthrough(...)

Tables

GermainUX provides utility functions for generating formatted tables from report results.

Simple Result Table

${
    tables.result(context.at(0))
        .columns("TIMESTAMP", "NAME", "COLOR", "VALUE")
}

Custom Table Styles

${
    tables.result(context.at(0))
        .tableStyle("padding: 5px; border: 1px solid #ddd;")
        .oddRowStyle("background-color: rgb(0, 139, 201); color: #fff; font-style: italic;")
        .evenRowStyle("background-color: #fff; font-weight: bold;")
        .columns("TIMESTAMP", "NAME", "COLOR")
}

Custom Column Labels

${
    tables.result(context.at(0))
        .textColumn("TIMESTAMP", "Day")
        .textColumn("NAME", "Server Type")
        .textColumn("COLOR", "SLA Color")
        .textColumn("VALUE", "Threshold")
}

Number Formatting

This example limits the fractional part to three digits and appends a percent sign:

${
    tables.result(context.at(0))
        .textColumn("VALUE", "Original")
        .numberColumn("VALUE", "Formatted", "%.3f %%")
}

Date and Time Formatting

${
    tables.result(context.at(0))
        .dateTimeColumn("TIMESTAMP", "Date + Time")
        .dateColumn("TIMESTAMP", "Date")
        .timeColumn("TIMESTAMP", "Time")
}

Duration Formatting

${
    tables.result(context.at(0))
        .textColumn("duration", "Unformatted")
        .durationColumn("duration", "Formatted")
}

Drill-Through Link with a Custom Time Range

${
    tables.result(context.at(0))
        .dateTimeColumn("TIMESTAMP", "Timestamp")
        .linkColumn(
            tables.link(links.drillthrough("My KPI"))
                .timeRange("TIMESTAMP", 0, 60000),
            "Link"
        )
}

Drill-Through Link with a Custom Filter

${
    tables.result(context.at(0))
        .textColumn("COLOR", "Color")
        .linkColumn(
            tables.link(
                links.predefinedTimeRange("Last 7 days", "AUTO")
                    .drillthrough("My KPI")
            ).filter("color", "==", "COLOR"),
            "Link"
        )
}

Calls to Action

A call to action (CTA) allows an alert recipient to trigger a configured GermainUX action by clicking a link. Examples include:

Starting, stopping, or restarting an application, service, server, or database
Creating a ticket in an external system
Updating a database
Executing SQL, a script, an SSH command, or a local program
Generating a report

An alert can contain multiple customized action links.

Action-Link Parameters

Parameter	Required	Description
`id`	Yes	Name of the configured GermainUX action to execute.
`server`	No	Server identifier or hostname passed to the action.
`database`	No	Database identifier or connection reference passed to the action.
`app`	No	Application or service identifier passed to the action.

<a href="${workspaceUrl}action.jsp?q=trigger&id=actionname&server=serverName">Run server action</a>

<a href="${workspaceUrl}action.jsp?q=trigger&id=actionname&database=databaseName">Run database action</a>

<a href="${workspaceUrl}action.jsp?q=trigger&id=actionname&app=appName">Run application action</a>

Only provide action links to authorized recipients. GermainUX permissions and the target system’s security controls should determine whether an action can execute.

Service-Restart Example

<#if context.fact?? && context.fact.name?? && context.fact.system?? && context.fact.system.hostname??>
<div><strong>This alert includes a restart action:</strong></div>
<div>
  <a href="${workspaceUrl}action.jsp?q=trigger&id=restartservice&app=${context.fact.name!}&server=${context.fact.system.hostname!}">
    Restart service "${context.fact.name!}" on "${context.fact.system.hostname!}"
  </a>
</div>
</#if>

Variable	Description
`${workspaceUrl}`	Automatically contains the URL of the GermainUX server. Do not modify it.
`${context.fact.name!}`	Name of the affected service.
`${context.fact.system.hostname!}`	Hostname of the affected system.

This example executes the restartservice action and passes the service name through app and the hostname through server. The <#if> condition prevents GermainUX from generating the link when any required value is missing. It checks:

context.fact
context.fact.name
context.fact.system
context.fact.system.hostname

Template Context Data

Templates can reference the following root objects:

Object	Type	Description
`customerName`	String	Customer associated with the alert or report.
`environmentName`	String	Environment associated with the alert or report.
`alertType`	String	Type of alert being generated.
`alertGroup`	String	Alert distribution group.
`context`	Object	Type-specific data available to the template.
`firstOccurred`	Date	Date and time when the condition first occurred.
`occurrences`	Integer	Number of occurrences associated with the alert.

The structure of context depends on alertType. Each alert type can expose different objects, but the structure remains consistent for alerts of the same type.

SLA Alert Context

For SLA alerts, context.fact can contain one of these fact types:

Fact Type	Type
`AVAILABILITY`	Object
`EVENT`	Object
`METRIC`	Object
`NETWORK_LATENCY`	Object
`TRANSACTION`	Object
`UX_EVENT`	Object
`UX_METRIC`	Object
`UX_TRANSACTION`	Object

Note: Statistical SLA alerts do not provide a fact object.

Fact Definitions

See Data Model and Facts for the fields available to each fact type.

Get Help

Contact GermainUX Support

The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

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.

Charts and Graphs

Tables

Calls to Action

Template Context Data

​Open a Template

​Charts and Graphs

​Area Chart

​Bar Chart

​Histogram

​Pie Chart

​Ring Chart

​Trend Chart

​Links to GermainUX

​Dashboard with a Predefined Time Range

​Drill-Through for a KPI and Time Range

​Analysis Screen for a Specific Data Point

​Link-Building Order

​Tables

​Simple Result Table

​Custom Table Styles

​Custom Column Labels

​Number Formatting

​Date and Time Formatting

​Duration Formatting

​Drill-Through Link with a Custom Time Range

​Drill-Through Link with a Custom Filter

​Calls to Action

​Action-Link Parameters

​Service-Restart Example

​Template Context Data

​SLA Alert Context

​Fact Definitions

​Get Help

Contact GermainUX Support

Can't find what you need?

Open a Template

Charts and Graphs

Area Chart

Bar Chart

Histogram

Pie Chart

Ring Chart

Trend Chart

Links to GermainUX

Dashboard with a Predefined Time Range

Drill-Through for a KPI and Time Range

Analysis Screen for a Specific Data Point

Link-Building Order

Tables

Simple Result Table

Custom Table Styles

Custom Column Labels

Number Formatting

Date and Time Formatting

Duration Formatting

Drill-Through Link with a Custom Time Range

Drill-Through Link with a Custom Filter

Calls to Action

Action-Link Parameters

Service-Restart Example

Template Context Data

SLA Alert Context

Fact Definitions

Get Help