Working with the Dynamic Template Designer > Dynamic Template Designer Quick Start
Version 9.1
Dynamic Template Designer Quick Start
A basic use case simply can be to list values for various entities of an enterprise object. For example, list the allocated and available capacity of arrays.
Visit our YouTube channel to watch product overviews and demonstration videos featuring specific product areas:
Learn by Example
To view advanced capabilities that have been incorporated into existing, out-of-the-box reports, go to the Explorer and search for these reports:
For Capacity Manager: LUN Utilization Summary
For Backup Manager: Job Summary
The following quick-start example requires the following tasks:
Create a Basic Report Template
Format Fields
Create a Calculated Field
Configure Table Column Totals
Define the Scope Selector
Generate a Report and View the Automatically Generated Help
Create a Basic Report Template
1. To begin making a report template, see Select an Enterprise Object.
2. Start by opening the folder in the left panel and drag fields into the Selected Field panel at the right. See Design a Report Template with the Dynamic Template Designer and Configure Fields.
Note that when you drag fields into the right panel, an Alias name is assigned. See Alias Names for Fields.
3. Enter the mandatory fields shown at the top of the window and save the report template
This step alone can produce a very basic report.
4. Click Save to save this initial version of the report template.
This example produces a report similar to the following:
As you can see, these results would benefit from additional formatting, hyperlinks to other reports, totals at the bottom of the numeric columns, and perhaps even additional table columns with values calculated from other fields. For example, totals would be useful at the bottom of the table and perhaps an additional column with calculated values would add value.
Basic formatting will be covered in this example, however, additional details can be found in:
Configure Fields
Configure Drilldowns
Add a Group to Create a Double Header in a Tabular Report
Apply Functions to Fields
Create Fields with the Field Builder
Format Fields
1. Double-click a numeric field. For this example, we’ll double-click the column that has the Capacity caption.
Change the Caption from Capacity to Array Capacity.
For the Formatter, select Decimal and make sure the Formatter Pattern is blank.
See also, Configure Fields.
Later, you may want to configure this field to get a total of the capacity of all the arrays in the report.
Figure 7.1 Dynamic Template Field Configuration
2. Tip: If you don’t know if a field is numeric, hover over a header in the Selected Field panel to view the list of columns to select. For this example, select Data Type.
Create a Calculated Field
For this example, it would be useful to have a Total Usable column, derived from fields we have already included in the template. The calculation for total usable capacity will be defined as:
Usable Internal + Usable External - Virtualized Capacity = Total Usable Capacity
1. Click Create Field at the bottom of the Dynamic Template Designer window.
2. In the Expression box, enter the calculation for total usable capacity: ${C+D-E}
Note that all expressions need to be enclosed in braces, with the following format: ${}
3. Click OK to launch the Field Configuration window where you can configure a Caption that will display Total Usable in the rendered report.
Configure Table Column Totals
1. Double-click a capacity field, such as Array Capacity.
2. In the Field Configuration window, select Sum from the Total/Subtotal drop-down list.
Figure 7.2 Configure Table Column Totals
3. Click OK.
4. Repeat these steps for any numeric column where you want to see a total at the bottom of the tabular report.
Define the Scope Selector
This set of steps lets you select items that will appear in the Scope Selector when the report is run.
1. At the bottom of the Dynamic Template Designer window, click Define Scope Selector.
Figure 7.3 Scope Selector Components for an Array Enterprise Object
Note that some entries may be already selected and cannot be deselected. This is because those scope elements are required for the selected enterprise object.
In this example, we’ve selected Byte Size. This lets the user select the units in the Advanced Options of the Scope Selector, as shown in the following screen shot.
Scope selectors are specific to an enterprise object.
Figure 7.4 Scope Selector Components for a Host Enterprise Object
Generate a Report and View the Automatically Generated Help
APTARE StorageConsole relies on an underlying data dictionary that contains detailed descriptions of not only enterprise objects, but also the attributes/characteristics of those objects. When you create a report template, the help is automatically derived from the data dictionary.
1. Use Quick Search at the top of the window and enter the name of the report template: Array Capacity Overview.
2. Select the report template from the search results and the report will render.
3. Click Help at the top right of the APTARE StorageConsole window.
The auto-generated help window appears.