Bench Report Templates¶
The Templates page allows you to apply report templates to an existing report or create a new template from an existing report.
Templates list¶
The templates page uses a layout with the list on the left and edition on the right. The list features all the usual possibilities as described in the dedicated section about lists.
Actions¶
Several actions can be done in the Templates page:
Create Template¶
Click on Create Template to open the report selector and create a template based upon one of them.
Note
If the template has an empty description, then the report description will be kept upon applying the template.
Warning
A template is not an exact copy of the report it comes from. Everything that is specific to one test result is removed, so that the template can be applied to any other result: the region and load generator filters, and the monitoring connections that only existed for that run - typically the load generator hosts and JVMs. A metric that has nothing left to filter on is dropped, and a report item that loses all of its metrics is dropped with it. The dialog tells you what will not be part of the resulting template before you confirm.
When you create a template, you can use the variables inside blocks of text or the report description, this way the current value for each test will be used every time you apply the template:
| Variable | Description |
|---|---|
| $COMPANY_NAME$ | Company name as provided in your account page |
| $PROJECT_NAME$ | Name of the project of the report where the template is applied |
| $PROJECT_DESCRIPTION$ | Description of the project of the report where the template is applied |
| $REPORT_NAME$ | Name of the report where the template is applied |
| $REPORT_DATE$ | Date of the report where the template is applied |
| $REPORT_DESCRIPTION$ | Description of the report where the template is applied. This is useful to keep the previous description before we override it in a block of text for instance. |
| $RESULTS$ | Result summary in the following format: Result X: $REPORT_NAME$ - XX users for XX min. |
| $SLA_PROFILES()$ | List of SLA profiles applied to this report. If multiple results inside this report, you can provide a resultId. |
Apply Template¶
Open a template menu and click on Use Template on Report to open a dialog that lets you use the selected template for an existing report:
Note
Report templates can also be used when launching a load test.
Warning
The configuration of the selected Report is overridden by the configuration of the Template.
Configure Template¶
Click on Configure to update the following template configurations:
Delete Template¶
Click on Delete Template to remove a template. A confirmation dialogs is opened:
Warning
This operation cannot be undone!