Working with the Dynamic Template Designer > Dynamic Template Scope Selector Components
  
Version 10.1.01
Dynamic Template Scope Selector Components
While creating a report template, you define enterprise objects such as storage arrays, host groups or a list of hosts to include in the report scope. Report scope simply refers to the criteria that you specify to filter the data that’s included in a report. You can select from the these filters when building a report template for an enterprise object:
• Data Domain Enterprise Object Scope Selector Components
• Host Enterprise Object Scope Selector Components
• Job Enterprise Object Scope Selector Components
• Storage Array Enterprise Object Scope Selector Components
Note that every enterprise object will have some mandatory components that are checked and greyed out. These are automatically set by the designer to ensure optimal performance and to enable components that are required for successful rendering of the data.
Also, the list of available components is specific to the enterprise object. In addition to the enterprise object components that enable report filtering, some components enable you to control graphical representation of the data; for example, Maximum Legends for Pie Chart. And, some components enabled advanced filtering, as described in Scope Selector Component - Custom Filter.
To configure the scope selector of a report template:
1. Click Define Scope Selector at the bottom of the Dynamic Template Designer window.
2. In the Scope Components window, check the components that you want to appear in the Scope Selector window when generating a report from a report template. These components restrict the scope of the report.
• Show: Check the box to include this component in the Scope Selector that is displayed when generating a report. Some scope components already are selected, as they are mandatory for the report template.
• Scope Component: Only elements that are relevant for the report template will be listed here. Some of these components provide more robust functionality. See Scope Selector Component - Custom Filter.
• Default Value: The default value for the scope component, if relevant.
• Product: This column indicates the product or subsystem to which these components are applicable. The notation, Base, means it applies to all products for that enterprise object.
• Description: Describes the component and its purpose.
Scope Selector Component - Custom Filter
The Custom Filter scope selector component provides advanced report filtering capabilities. Use this filter to define free-form fields that enable data filtering at run time. See Define a Custom Filter at Run Time.
When defining a Custom Filter for a Dynamic Template, the following rules apply:
• The Dynamic Template is restricted to one product only. For example, the Dynamic Template must be defined for a single product, such as Veritas NetBackup; only data for that product is relevant.
• Fields that contain aggregation functions will not be listed for Custom Filter selection at run time.
To configure a Dynamic Template to include the Custom Filter scope selector:
1. Once you have defined the fields to be included in the template, click Define Scope Selector to view the Scope Selector Components. At run time, the user can supply values to achieve more granular filtering.
2. Check the Custom Filter component and click OK.
When the report is run, the Scope Selector displays the fields that can be selected to specify values to filter the report results.
Define a Custom Filter at Run Time
This Custom Filter functionality in a Dynamic Template scope selector is particularly useful for bar and line charts, where it is desirable to tailor the amount of data reflected in the chart. This filter is similar to the advanced filtering that is available in tabular reports, although the operators are slightly different.
When you run a report, the system determines which fields can be filtered, based on what has been defined in the report template and the following restrictions:
• Numeric and String fields can be filtered.
• Date fields cannot be filtered.
Four filters can be defined by selecting a field name and an operator, then typing the value on which to filter. These filters are ANDed together to determine the results.
The following operations are permitted, by field type.
• Custom Filter Operators for Numeric Fields
• Custom Filter Operators for String Fields
Custom Filter Operators for Numeric Fields
Numeric-filtering operations have the following requirements and restrictions:
• For decimal and % values, the formatter rounds and truncates decimal places. Therefore, use the greater than and less than operators to find matches for these values.
Operator
Description
equals
Filters data where the value of the associated field is equal to the value entered.
not equal
Filters data where the value of the associated field is not equal to the value entered.
greater than
Filters data where the value of the associated field is greater to the value entered.
less than
Filters data where the value of the associated field is smaller than the value entered.
greater than or equal to
Filters data where the value of the associated field is greater than or equal to the value entered.
less than or equal to
Filters data where the value of the associated field is less than or equal to the value entered.
in
Looks for a match in a comma-separated list. Wildcards are not supported.
Note: Do not include spaces after the commas in the comma-separated list.
not in
Returns data for values that are not in the comma-separated list. Wildcards are not supported for values in this list.
Note: Do not include spaces after the commas in the comma-separated list.
is null
Checks for null values. This is a special operation that looks for the absence of values.
is not null
Checks for non-null values. This is a special operation that looks for values that are not null.
Custom Filter Operators for String Fields
String-filtering operations have the following requirements and restrictions:
• String comparisons are case-insensitive
• Wildcards are supported for substring matching. This is applicable for the like and not like operators. Use the * to filter on substrings, as shown in the following examples.
• Example of substring searches for arrays with the same prefix (for example, hqfin01). In this example, to look for all arrays in the hqfin group, the following wildcards could be used: like hqfin*
• When using the in operator with a comma-separated list, do not include spaces after the commas in the list.
Operator
Description
equals
Filters data where the value of the associated field is equal to the value entered.
not equal
Filters rows where the value of the associated field is not equal to the value entered.
in
Looks for a match in a comma-separated list.
Note: Do not include spaces after the commas in the comma-separated list.
not in
Returns data for values that are not in the comma-separated list.
Note: Do not include spaces after the commas in the comma-separated list.
like
Matches patterns of characters. Wildcards are supported for substring matches: *, %.
not like
Returns data for strings that are not in the pattern of characters. Wildcards are supported for substring matches: *, %.
is null
Checks for null values. This is a special operation that looks for the absence of values.
is not null
Checks for non-null values. This is a special operation that looks for values that are not null.
Data Domain Enterprise Object Scope Selector Components
The following scope selector components are specific to the Data Domain enterprise object.
Custom Filter
Define free-form fields that enable data filtering at run time. When the report is run, the Scope Selector displays the fields that can be selected to specify values to filter the report results. When the Custom Filter is selected, the report template is restricted to one product only. See Scope Selector Component - Custom Filter.
Data Point Image
Enable the display of a circle of each data point in a line chart. This allows for quick identification of roll-over information in the chart.
Group By
Enables selection of a time span to be used to group the data by: Hours, Days, Weeks, Months, Quarters, or Years. When using Group By, in general, an aggregation function, such as sum, min, or max, should be included in the report template definition.
Group Chart By
Enables selection of Chart Per Object (each chart is for a single object, with one or more metric lines) or Chart Per Metric (each chart is for one metric, with one or more objects represented as lines). This is a required scope selector component if the report template includes a field of type, Group by Object.
Hosts
Specify hosts to be included in the report scope.
Line Selector
If multiple lines are defined in a line chart template, this component enables the user to select the line to be shown in the chart.
Maximum legends for Pie Chart
Specify the maximum number of sectors for pie chart rendering.
Time Period
Provides a drop-down list to specify a time span, such as last 90 days or previous month.
Top/Bottom
Narrow the scope to the greatest/least values based on a given metric.
Host Enterprise Object Scope Selector Components
The following scope selector components are specific to the Host enterprise object.
Backup Server Type
The type of host in a backup environment, such as Client or Media Server.
Byte Size
Select the units for displayed capacity values; for example, TB or PB.
Custom Filter
Define free-form fields that enable data filtering at run time. When the report is run, the Scope Selector displays the fields that can be selected to specify values to filter the report results. When the Custom Filter is selected, the report template is restricted to one product only. See Scope Selector Component - Custom Filter.
Data Point Image
Enable the display of a circle of each data point in a line chart. This allows for quick identification of roll-over information in the chart.
Domain
The domain to which the enterprise object belongs.
Group By
Enables selection of a time span to be used to group the data by: Hours, Days, Weeks, Months, Quarters, or Years. When using Group By, in general, an aggregation function, such as sum, min, or max, should be included in the report template definition.
Group Chart By
Enables selection of Chart Per Object (each chart is for a single object, with one or more metric lines) or Chart Per Metric (each chart is for one metric, with one or more objects represented as lines). This is a required scope selector component if the report template includes a field of type, Group by Object.
Host
Name of the host, as defined in the collected product.
Host Creation Date
The date and time the host was added to the reporting database.
Host Type
Indicates how a host has been commissioned in an enterprise, such as VM Server, VM Guest, or Other.
Host Updated Date
The date and time that the host data was last updated in the reporting database.
Hosts
Specify hosts to be included in the report scope.
Line Selector
If multiple lines are defined in a line chart template, this component enables the user to select the line to be shown in the chart.
List of Client IDs
List of Client IDs for drilldown.
Make
Make of the host, such as Dell.
Maximum legends for Pie Chart
Specify the maximum number of sectors for pie chart rendering.
Model
Model of the host, such as Windows-x86.
OS Platform
Host’s OS type, such as Linux or Windows.
OS Version
Version of the host’s operating system.
Product Collected
Find hosts that have been collected from this product, such as Veritas NetBackup.
Product Group Collected
Find hosts that have been collected from this product group, such as capacity collection.
Product Group Not Collected
Find hosts that have not been collected from this product group, such as capacity collection.
Product Not Collected
Find hosts that have not been collected from this product, such as Veritas NetBackup.
Time Period
Provides a drop-down list to specify a time span, such as last 90 days or previous month.
Timezone
Enable selection of a specific time zone to normalize the report by any time zone equivalent in the world. The default setting for this parameter is the time zone setting of the location of the Data Collector. The Data Collector must be installed on a server that is in the same time zone as the subsystem from which data is collected.
Top/Bottom
Narrow the scope to the greatest/least values based on a given metric.
Job Enterprise Object Scope Selector Components
The following scope selector components are specific to the Job enterprise object. Note that some of these components are specific to a backup vendor/product.
Backup Policy Name Filter
Specify only the backup policy to be used in the report's scope.
Backup Window
Select a custom backup window to be applied to the report. Typically, backups begin at the end of the business day, but they do not finish before the end of the day-thereby skewing the success statistics for the day. To more accurately reflect backup SLA metrics, you can re-define a day with a custom backup window. These custom backup windows are defined by the Portal administrator.
By Master Server Only
This selection filters data for the NetBackup Master Server only.
Consecutive Error
Enable specification of the number of consecutive errors logged for the object, within the report's timeframe.
Custom Filter
Define free-form fields that enable data filtering at run time. When the report is run, the Scope Selector displays the fields that can be selected to specify values to filter the report results. When the Custom Filter is selected, the report template is restricted to one product only. See Scope Selector Component - Custom Filter.
Data Point Image
Enable the display of a circle of each data point in a line chart. This allows for quick identification of roll-over information in the chart.
Drives Scope
Specify physical drives to be included in the report scope.
Event Type
Enables selection of the type of backup or restore, such as Restores or Incremental Backups.
Group By
Enables selection of a time span to be used to group the data by: Hours, Days, Weeks, Months, Quarters, or Years. When using Group By, in general, an aggregation function, such as sum, min, or max, should be included in the report template definition.
Group Chart By
Enables selection of Chart Per Object (each chart is for a single object, with one or more metric lines) or Chart Per Metric (each chart is for one metric, with one or more objects represented as lines). This is a required scope selector component if the report template includes a field of type, Group by Object.
Hosts
Specify hosts to be included in the report scope.
Job Status
Enable selection of backup/restore job status to be included in a report. For example, Warning or Failed jobs.
Job Type Detail
Enable selection of specific sub-categories of a backup vendor's jobs; for example, duplication, catalog, or vault.
Libraries Scope
Specify backup libraries to be included in the report scope.
Line Selector
If multiple lines are defined in a line chart template, this component enables the user to select the line to be shown in the chart.
List of Client IDs
List of Client IDs for drilldown.
Maximum legends for Pie
Specify the maximum number of sectors for pie chart rendering.
Min Max Percentage
Specify the minimum and maximum % for HP Data Protector sessions.
Parent Job Only
Enable reporting on the status of the backup parent job only. For NetBackup, the Portal groups the jobs with the same parent-child relationship that NetBackup uses.
Session Status
For HP Data Protector, enable selection of a session status: Unknown, Completed, Completed/Failures, Failed, Completed/Errors, Aborted.
Time Period
Provides a drop-down list to specify a time span, such as last 90 days or previous month.
Timezone
Enable selection of a specific time zone to normalize the report by any time zone equivalent in the world. The default setting for this parameter is the time zone setting of the location of the Data Collector. The Data Collector must be installed on a server that is in the same time zone as the subsystem from which data is collected.
Top/Bottom
Narrow the scope to the greatest/least values based on a given metric.
TSM Scope
Include TSM backup/restore data in the report scope.
Storage Array Enterprise Object Scope Selector Components
The following scope selector components are specific to the Storage Array enterprise object. Note that some of these components are specific to a storage array vendor/product.
Array Disk Class
Specify array disk classes to be included in the report scope.
Array RAID Types
Enables selection of specific, relevant RAID types, such as RAID_5_6+P.
Array States
Specify storage array states to be included in the report scope.
Arrays Scope
Specify storage arrays to be included in the report scope.
Byte Size
Select the units for capacity values; for example, TB or PB.
Celerra VNX Volume Types
Include specific Celerra volume types, such as Slice, Stripe, Meta, Disk, and Pool, in a report.
Custom Filter
Define free-form fields that enable data filtering at run time. When the report is run, the Scope Selector displays the fields that can be selected to specify values to filter the report results. When the Custom Filter is selected, the report template is restricted to one product only. See Scope Selector Component - Custom Filter.
Data Point Image
Enable the display of a circle of each data point in a line chart. This allows for quick identification of roll-over information in the chart.
Disk Classes
Report on specific disk classes, such as enterprise fibre channel drives (ENT) or Nearline ATA drives (NL).
Disk Stages
Enable selection of specific disk states, such as Installing, Formatting, or Rebuilding.
Disk Type
Enable selection of specific disk types, such as FC, SCSI, or SATA.
Disk Usage
Enable selection of specific disk usage types, such as Unconfigured or Spare.
Extent Pool Storage Types
Enables selection of specific, relevant Extent Pool storage types, such as fixed block.
File System Types
Include specific file system types, such as Unix, Raw, and Mirror, in a report.
Group By
Enables selection of a time span to be used to group the data by: Hours, Days, Weeks, Months, Quarters, or Years. When using Group By, in general, an aggregation function, such as sum, min, or max, should be included in the report template definition.
Group Chart By
Enables selection of Chart Per Object (each chart is for a single object, with one or more metric lines) or Chart Per Metric (each chart is for one metric, with one or more objects represented as lines). This is a required scope selector component if the report template includes a field of type, Group by Object.
Hard Empty Percentage
For IBM XIV storage pools, enable the selection of a utilization % that provides an indicator of empty physical pool capacity.
Hard Near Capacity Percentage
For IBM XIV storage pools, enable selection of a utilization % that provides an indicator of reaching physical pool capacity.
Hard Over-Provisioned High Percentage
For IBM XIV storage pools, enable selection of a utilization % that provides the high-end indicator for the range of over-provisioned physical pool capacity.
Hard Over-Provisioned Low Percentage
For IBM XIV storage pools, enable selection of a utilization % that provides the low-end indicator for the range of over-provisioned physical pool capacity.
HDS DP Pool IDs
HDS dynamic provisioning pool IDs.
HDS DP Type
HDS dynamic provisioning type.
HDS Open Reserved
HDS Open Reserved.
Hosts
Specify hosts to be included in the report scope.
IBM Array Site Disk Classes
Enable specification of IBM array site disk classes in a report. For example, ENT or NL.
IBM Array Site States
Enable specification of IBM array site states in a report. For example, Assigned, Unassigned, or Unavailable.
IBM Extent Pool IDs
Unique Identifier for the IBM extent pool.
IBM Rank IDs
List of IBM rank IDs.
In Use
For EMC VNX (Celerra) SnapSure data, provide a selection to include data for checkpoints that are in use. A checkpoint is in use if a filesystem is registered in the mount table of a Data Mover.
Line Selector
If multiple lines are defined in a line chart template, this component enables the user to select the line to be shown in the chart.
LUN Status
Enable selection of the LUN status to be included in the report. For example, Allocated but Unused or Allocated but undiscovered.
Maximum Legends for Pie Chart
Specify the maximum number of sectors for pie chart rendering.
Qtree Status
Enable selection of the NetApp Qtree status to be included in the report. For example, Snap Vaulted or Read Only.
RAID State
Enable selection of one or more array states, such as partner, zeroing, or reconstructing.
RAID Status
Enable selection of one or more raid status, such as normal, copying, reconstruct.
RAID Type
RAID type.
Rank Array States
Enable specification of IBM Rank states in a report. For example, Below, Exceeded, or Full.
Rank RAID Types
Include specific IBM Rank RAID types, such as fixed block, in a report.
Rank Status
Select an IBM rank status for report filter; for example, normal, configuring, unassigned, or reserved.
Security Style
Enable selection of the NetApp security style to be included in the report. For example, Unix, NTFS, or Mixed.
Session ID
Unique Identifier for the HPDP Session
Snapshot Busy
Choose to report data for NetApp Snapshot busy state: Yes or No.
Snapshot Only
Snapshot Only
Soft Near Capacity Percentage
For IBM XIV storage pools, enable selection of a utilization % that provides an indicator of reaching virtual (thin-provisioned) pool capacity.
Space Guarantee
Select a space guarantee for NetApp volumes; for example, volume, file, or none.
Thin-Provisioned
Included thin-provisioned array storage in the report scope.
Time Period
Provides a drop-down list to specify a time span, such as last 90 days or previous month.
Top/Bottom
Narrow the scope to the greatest/least values based on a given metric.
Volume Styles
Include specific volume style, such as flex, striped, infinitevol.
Volume Type
Select a NetApp volume type, such as flex or trad.