Skip to main content

Configuring a Report Template

This tutorial guides you through the creation and configuration process of a report template. As an example, you will create a report template of the report type Cluster Table that shows all the databases of an application and their major properties.

Step 1: Create a custom report​

In Txture, you need to create the custom report before you can convert it into a report template. For this exercise, let's start by creating a cluster table report called "Databases Used" that displays all databases used by a specific application instance.

  1. Navigate to Reports via the main menu and click the + New Report button.

  2. Choose the type Cluster Table.

  3. In the Filters section, add a single asset by entering the query Add Asset. Confirm with enter and choose an application instance asset from the repository. Alternatively, you can use the + Add Asset button underneath the Filters. Ensure that the asset you select matches the asset type of placeholder you intend to create. We will replace this asset with a placeholder in a later step.

  4. In the next step, find related Database assets. Use the query Add neighbords via uses Database. Via a click on the uses dropdown make sure that only the Application Instance uses Database link is selected.

  5. Next, filter to only get results for Databases. Use Filter Type is Database.

  6. In the Content tab we can further configure the Cluster Table. Set the vertical axis filter to "Related to type Application Instance".

  7. In the last step we can configure our columns. Click on the Edit Columns button and add the properties "Technology", "Technology Variant", "Capacity Total" and "Capacity Used".

  1. Finally, save your report.

Step 2: Convert the report into a template​

  1. Now that we have configured our cluster table report "Databases Used", we can convert it into a report template. To do this, open the burger menu in the upper-right corner and select Create a template.
  2. Give it a descriptive name like "Database Used".
note

If you want to use the report templates for a dashboard or make them generally available for other users in your instance, do not forget to set the Visibility to "Public".

  1. Next, click on the application instance asset since we want to replace this asset with a placeholder. To do so, use the option +Replace with new Placeholder.

  2. Next, we need to congifure the placeholder:

  • Name: Specify a name for the placeholder - typically it does make sense to give it the name of the asset type that got replaced by the placeholder.
  • Placeholder for a single asset checkbox: Use this checkbox to restrict the placeholder to a single asset or leave it unchecked to allow multiple asset selections.
  • Asset Restriction: Specify an asset restriction to ensure users always select assets of the correct type. In our example, we always want to see the Databases that are linked to Application Instances. The Application Instance is our starting asset for the query. Thus, we need to allow only assets of type Application Instance for the placeholder.

Step 3: Use the report template​

There is more than one way to create a report from a template in Txture.

  • Creating a report from the reports menu: In the Reports section, go to the Template area and select the desired report template. Use the Select assets button to specify the variable for which you want to generate the output.

  • Creating a report directly from an asset: When you click on an asset, the sidebar displays its properties and offers the option to generate a report using that asset. In the Reports section or via the New report button, you'll see all report templates that are available for the asset type of your selected asset. sTo create a report, simply select a template.