Creating a Report Template

Creating a Report Template

Summary

A Report Template is a reusable blueprint that defines what a report contains. When you create a template, you choose which sections to include and arrange them in the order that makes sense for your audience. Every report generated by a subscription is built from one of these templates.

Think of a template as the answer to: "What should this report show, and in what order?" The subscription answers the follow-up questions: "When should it run, and who should receive it?"

Accessing Report Templates

1. Open the Admin Console.
2. Select Reporting.
3. Select Report Templates from the breadcrumb navigation.

The template list displays the following for each entry:

• Template — The name and description entered when the template was created.
• Report Sections — Displays the count of how many sections the template contains.
• Created By — The user who created the template.
• Subscriptions — Whether the template has active subscriptions attached to it.

To open or edit a template, select the options menu (three vertical dots) at the end of the row.

Creating a New Template

Step 1 — Open the Create Template form

1. Go to Admin Console → Reporting → Report Templates.
2. Select [+ New Template] button in the upper right corner.

The Create Template panel opens.

Step 2 — Enter template details

Both fields are required before you can save.

• Template Name — Give your template a clear, specific name. Including the environment and frequency helps others find and reuse it.
  Examples: Weekly DB Health — Production or Monthly Cost Review — All Environments
• Description — Explain what this report is for and who the intended audience is. This description appears in the template list and helps other users understand the purpose at a glance.

Step 3 — Add report sections

Select + Add Section drop-down to open the section picker. A searchable list of all available section types appears. Check the box next to each section you want to include.

Tip: Use the Search box at the top of the section picker to quickly find a section by name.

Available sections:

Step 4 — Arrange sections

Once sections are added, they appear as numbered cards below the section picker. Use the up and down arrows on each card to reorder them. The order here determines how sections appear in the finished report.

To remove a section, select the X on its card.

Step 5 — Save the template

Select Save. The template will now appear in the Report Templates list and be available for use in subscriptions.

Examples of Templates You Might Create

• Weekly DB Health — Production: Alerts, failed jobs, collection health, and new top queries for your production environment.
• Monthly Cost Review: Top databases by growth, untagged resources, and instance list for finance and leadership.
• Incident Review Package: Alerts, configuration changes, and collection health for a post-incident debrief.

Editing a Template

1. Go to Admin Console → Reporting → Report Templates.
2. Open the options menu (three vertical dots) on the template row and select Edit.

The Edit Template panel opens with two tabs:

• Template — Update the name, description, and sections, including reordering or removing sections.
• Properties — View read-only metadata about the template: who created it, when it was last modified, and how many active subscriptions are using it.

Deleting a Template

There are two methods available to delete a template

1. Click the 3 vertical dots at the end of a template row
   1. Select the Delete option in the list
2. Open the Edit Template panel for the template you want to remove.
   1. Select Delete (bottom left, highlighted in red).
   2. Confirm the deletion.

Related Topics

• Creating a Report Subscription
• Report History
• Reporting Overview