Guides
Start typing to search…

Managing templates

Templates are reusable configurations that define the structure and format of generated reports. In this section, you’ll learn how to manage templates via the Midaz Console.


Accessing the Templates page

To open the Templates page, click the Manage Templates button on the Smart Templates page (Figure 1). You can also click the Templates tab.

Figure 1. Button to access the Templates page.


The Templates page will open (Figure 2).

  • If you have any templates previously created, they will be displayed either as a list or a grid.

Figure 2. The main Templates page.


Available actions

From the Holders page, you can:


Adding a template

Before you can generate any reports, you must upload a .tpl file to the Console. This file must be created beforehand, outside the Console.

This section shows how to upload a pre-existing template to make it available for report generation in Midaz.

📘

Note

If you need help building a template file, check out our Template examples section.

To add a template:

  1. Go to the Templates page and click the New Template + button (Figure 3).

Figure 3. The button to create a new template


  1. The Template Details form will open.
  2. Specify the following information:
    1. A name for the template.
    2. The output format (CSV, XML, HTML or CSV).
    3. The .tpl file you created.
  3. Click Create Template to upload the template.

If anything goes wrong, an error message will appear within the form.

❗️

Important

Only .tpl files are accepted, with a maximum size of 5MB. The Console doesn’t support editing or generating .tpl files, only uploading and managing them.


Updating a template

Need to update a template’s name, output format, or replace the uploaded file? This section walks you through how to update a template directly from the Console.

📘

Note

The Console doesn't allow you to modify the content of the .tpl file. To update the structure or logic of a template, you must edit the file locally and re-upload it.


To edit a template:

  1. On the Templates tab, locate the template you want to update.
  2. Click the three dots ( ) on the Actions column and select Edit (Figure 4).

Figure 4. The option to edit a template from the Actions menu.


  1. A form will open in a side sheet, pre-filled with the current metadata.
  2. Update the necessary information and click Save to apply your changes.
  3. If the request fails, an error message will be shown in the form.
⚠️

Attention

Replacing a .tpl file affects all future reports generated with that template. Reports already created will not be impacted.


Deleting a template

To remove a template from the Console:

  1. On the Templates tab, find the template you want to delete.
  2. Click the three dots ( ) on the Actions column and select Delete Template (Figure 5).
  3. Confirm the action in the dialog that appears.

Figure 5. The option to delete a template from the Actions menu.


❗️

Important

Deleting a template cannot be undone. However, reports already generated using that template will remain available in the Reports tab.

Updated 7 days ago