Working with the Dynamic Template Designer > Configure Fields
   
Version 9.1.01
Configure Fields
Prerequisite: Design a Report Template with the Dynamic Template Designer.
Once fields have been added to a report template, a number of special treatments can be configured to customize the way the data will be represented in a report.
1. Double-click a Selected Field to access the Field Configuration window.
This Field Configuration window presents lists of values that can be selected to configure formatting. Only values relevant for the selected field will be listed and some options may be grayed out if they are not relevant to the selected field.
 
Label
Description
Caption
This is the text that will be displayed as a field label or a table column header in a report. To replace the default caption with one customized for your reports, simply overwrite the default text.
Type:
Display as Table
Display as Table
• Hidden - Use this option when configuring a drilldown to another report template. The field will not be displayed in the report, but is required to access the necessary details to link to the sub-report template. There will be cases where the UI will automatically add hidden fields to the report template, to ensure satisfactory performance.
• Column - Lists a column of values in a tabular report.
• Checkbox - Include/exclude selectors will be displayed in a column in a tabular report.
• Exclude - There will be cases when a field will be needed only for filtering purposes and you do not want this field to be included in the selected fields for the report.
Type:
Display as Bar Chart
Display as Bar Chart
• Caption - Define this field to be the x-axis values.
• Bar - Configure the field to be represented as a bar and set its color.
• Line - Configure the field to be represented as a line and select the shape to denote its value in the line: rectangle, circle, diamond, or none.
• % Line - Configure the field to be represented as a % line and select the shape to denote its value in the line: rectangle, circle, diamond, or none.
• Legend - Define the labels and colors to be displayed in the bar chart’s legend. See Bar Chart Legend Configuration to determine if you should use a dynamic or static bar chart type.
• Hidden - Use this option when configuring a drilldown to another report template. The field will not be displayed in the report, but is required to access the necessary details to link to the sub-report. There will be cases where the UI will automatically add hidden fields to the report template, to ensure satisfactory performance.
• % Bar - Define the field to be a % bar in the chart.
• Exclude - There will be cases when a field will be needed only for filtering purposes and you do not want this field to be included in the selected fields for the report template.
Type:
Display as Pie Chart
Display as Pie Chart
• Caption - Enter the caption associated with the pie slice.
• Pie - Configure the field to be a pie slice and set its color.
• Hidden - Use this option when configuring a drilldown to another report template. The field will not be displayed in the report, but is required to access the necessary details to link to the sub-report template. There will be cases where the UI will automatically add hidden fields to the report template, to ensure satisfactory performance.
• Exclude - There will be cases when a field will be needed only for filtering purposes and you do not want this field to be included in the selected fields for the report template.
Formatter
The formatter list includes only values relevant for the attribute. For example, numeric attributes have only numeric formatters listed, such as Number, Currency, and File Size. See Valid Formatter Patterns.
Formatter Pattern
Enter a specific pattern for the formatter to customize the default format. Example: KiB GB or KB::_
Alignment
The default value provides the most common usage. For example, numeric values typically should be right-aligned so that decimal points line up. However, other options can be selected from the list.
Wrap
Select Yes if you want long values/text for this attribute to wrap in the space provided in the report. When No is selected, the data will extend horizontally.
Total/Subtotal
Total/Subtotal Options: Null, Sum, Average, Minimum, Maximum.
Use this configuration to aggregate the values, such as all the backup job sizes for a backup server. In its simplest form, this aggregation is used to display grand totals for all the data displayed in a report.
To enable subtotals for a set of fields:
• Configure Total/Subtotal with a Null value and set Column Break to Yes for one or more fields in the report template.
• Once you configure subtotal, you can no longer create grand total rows at the end of the tabular report template.
* Never configure Total/Subtotal and Column Break = Yes for the same field.
Column Break
Select Yes if you want to list subtotals at the end of a group of related fields. Note that when you use subtotals, the sort order is automatically determined. All fields with a Column Break selection are sorted in the relevant ascending order and this sort order cannot be changed. Be sure not to remove or modify this sort order.
Example: You could create a tabular report for client, server, and kilobytes. Then, you could subtotal on server to aggregate the kilobytes per server.
* Never configure Total/Subtotal and Column Break = Yes for the same field.
Drill Down to
Select the report to which this field will link.
This takes you to the Drilldown Configuration window. See Configure Drilldowns.
Drilldown Condition
A drilldown condition lets you control cases where a drilldown doesn’t make sense to be displayed, for example, null or 0 values for a field. For example, you wouldn’t want to drill down on a Job ID for a row if the value of Job ID returned from the database is Null or 0 (zero).
Example: ${row['B'] != '0'}
where B is the alias name
In this example, the drilldown link will appear only when the returned value is not zero.
Example: Configure a drilldown on field D and enter a drilldown condition as shown in the following example. In this example, if the row where the value of the field aliased as A is NULL, the value in column D will not have a drilldown URL enabled.
${row[‘A’] != ''}
Example: Multiple conditions can be configured.
${row[‘C'] != '' && row['E'] == ''}
Style
Use this option to configure the background color of a cell in a tabular report.
Example:
${row['C'].data == 'Partial' ? 'yellowBackground' : row['C'].data == 'Failed' ? 'redBackground' : '' }
where C is the alias of the selected field.
Group By
This is applicable only for Date fields in Bar and Pie Chart reports. A date field is required for the Group By option. If only one date field is specified, it is used as the default for the Group By configuration.
Select Yes to configure the Group By report scope selector element for a field.
If you configure a date field as a caption, the Group By is automatically selected.
Graphics Tool Tip
Enter a description to be displayed when a user hovers the mouse over an image in a report; for example, bar lines in charts and even images in table columns.
Example: Available: ${row['Q1']}
where Q1 is the alias name.
Comma-delimited ID Name Formatter
For text fields only.
Use this option if data returned for a field has multiple values that need to be separated by commas. Only the names will be shown in the rendered report and the IDs will be used for drilldowns, if drilldowns are configured.
Tool Tip
This is the description supplied by the Data Dictionary for this field. You can overwrite or supplement this text. This description will be displayed when a user hovers the mouse over the field or table column label in a report. It will also be incorporated into the context-sensitive help that is displayed from the Help button.
Valid Formatter Patterns
In the Field Configuration window, the Formatter selector requires additional details provided in the Formatter Pattern box. Note that only Formatters relevant to the selected report template field will be made available for selection.
Use the following table to determine valid formatting patterns.
Formatter Name
Data Type
Valid Patterns
Description
Date
Date
N/A
Date formats are derived from the user's profile.
Date+TimeZone
Date
N/A
Date formats are derived from the user's profile.
Date Group By
Date
N/A
Used in charts and graphs to format the legend, based on the “group by” that is selected. Puts the optimum date format for that group by.
Time Elapsed
Number
(SEC)|(MIN)|(HR)|(DAY)
Displays time in a more readable format, converting minutes to hours, where relevant. For example, 120 min would be displayed as 2 hrs.
Time Duration
Number
N/A
Formats a time value that is in milliseconds to the following format: hh:mm:ss
Applicable only for fields that denote time duration; for example: finish_date minus start_date
Cron Schedule
Number
Varchar2
N/A
Presents a standard cron expression in a user-readable form. For example, */30**** will display as “Every 30 minutes.”
Numeric
Number
N/A
Format derived from the user’s profile.
Decimal
Number
% converts to % format
Otherwise, leave as null.
Formats the value with the number of decimal places specified in the user’s profile; can also be used for percentages.
Speed
Number
N/A
Formats speed values. N/A if speed = 0.
Currency
Number
N/A
Format derived from the user’s profile.
File Size
Number
(KiB)|(MiB)|(GiB) is the input data type
Formats the file size unit of measure to what is most applicable to the selected field value. For example, 2048 MB would become 2 GB
File Size No Label
Number
Units::Units
For APTARE StorageConsole Backup Manager only. Formats the file size to the most relevant unit of measure, but omits the unit label. Applicable for byte size data.
Unit Converter
Number
KB::TB
KB::_ (for dynamic output)
Determines the value to be used when converting from one unit to another, for example, from KB to GB. The “division by” value is determined from the user’s profile settings, either 1000 or 1024.
Char Substitute
Number
Varchar2
Date
<value_to_replace>::<replacement_value>
Replaces specified characters in a string value. For example, if the database returns "Host1, Host2" this formatter could be used to replace the "," with "<br/>"
Null Substitute
Number
Varchar2
Date
<string>
Replaces null values with a user-supplied string.
Percentage
Number
number1:number2:number3
Data values from 0 to number1 will render Green color in the percentage bar. Values between number1 and number2 will render Yellow color and values between number2 and 100 will render Red color. The values number1 and number2 should always be between 0 and 100. The number3 parameter determines the size of the % bar in pixels.
Display a % bar (thermometer) in a chart.
Full Name
Number
N/A
For File Analytics only. Converts a shortcut name to a full name for NetApp, CIFS, and WinFS.
Yes/No
Varchar2
N/A
Translates Y/N to Yes/No.
Status Icon
Varchar2
Number
Example:
0|Green,2|Red,1|Yellow,*|White
If the value = 0, the circle icon will render in green.
Displays status icons depending on the data, which could render in red, yellow, blue, green and white.