NetBackup IT Analytics User Guide
- Introduction
- Understand the Portal
- About the Admin tab
- Explore your inventory
- Hierarchy toolbar to organize your data
- Show objects
- Use attributes to organize your data
- Pin reports - saving reports with inventory objects
- Assign attributes in the inventory list view
- Get acquainted with reports
- About badging
- Generate and maintain reports
- Select Report Scope
- Group hosts by attributes
- Search for hosts in the report Scope Selector
- Backup Manager advanced scope selector settings
- Solution reports scope selector settings
- Units of Measure in Reports
- Customize report filter logic
- Sort columns in reports
- Convert tabular report to chart
- Distribute, share, schedule, and alert
- Scheduling Exported Reports and Dashboards
- Organize reports
- Work with the dynamic template designer
- Dynamic Template Designer Quick Start
- Converting to a Homogeneous, Product-Specific Template
- Dynamic Template Function Configurations
- Create Fields with the Field Builder
- Scope Selector Component - Custom Filter
- Configure a Bar Chart Dynamic Template
- Steps to Create a Bar Chart Dynamic Template
- Configure an Area/Stacked Area Chart Dynamic Template
- Line Charts for Performance Metrics
- Line Chart Field Requirements
- One Object Per Line Chart, One or More Metrics Per Chart
- Multiple Objects Per Line Chart, One Metric Per Chart
- Example of a Stacked Bar Chart Dynamic Template
- Create a Sparkline Chart in a Tabular Dynamic Template
- Adding or Editing Methods
- Validate and Save a Method
- Work with the SQL template designer
- Database Published Views
- Create a SQL Template
- Configure SQL Template Scope Selector Components
- Sample SQL Queries
- Configure SQL Template Scope Selector Components
- Format the SQL Template Output
- Configure a Table in the SQL Template Designer
- Advanced SQL Report Template Options
- Export/Import SQL Templates
- Pipelined functions for report query building
- APTlistOfDates
- aptStringConcat
- getServerAttributeValue
- getObjectAttributeValue
- getChildServerGroupContextById
- getServerGroupContextById
- secsToHoursMinSecs
- APTgetTapeDriveStatusName
- getFullPathname
- listJobSummaryAfterRestart
- listJobSummaryAfterRestartNBW
- listJobSummaryAfterRestart for NetWorker Backup Jobs
- listOfBackupWindowDates
- listChargebackCatByVOLSDetail
- listChargebackCatByNcVolDetail
- listChargebackCatByFSDetail (for HNAS)
- listChargebackCatByFSDetail (for EMC Isilon)
- listChargebackByLUNSummary
- listChargebackByLUNDetail
- listChargebackCatByLUNSummary
- listChargebackCatByLUNDetail
- Alert configuration
- Manage hosts, backup servers, and host groups
- Manage attributes and objects
- Provide Portal access and user privileges
- Setting / Resetting passwords
- Managing user group home pages (Administrator)
- Configure master schedules and backup windows
- Add, edit, and move policies
- Add/Edit a threshold policy
- Capacity Chargeback policy types
- Solutions administration
- Manage and monitor data collection
- About data collection tasks
- Add/Edit data collectors
- Review collectors and collection status
- Upgrade Data Collectors
- Work with Capacity Manager host data collection
- Host Access Privileges, Sudo Commands, Ports, and WMI Proxy Requirements
- Host access requirements
- Manage credentials
- Configure host discovery policies to populate the host discovery and collection view
- Discovery processes
- Validate host connectivity
- Search and export in host discovery and collection
- Propagate probe settings: Copy probes, paste probes
- Discovery policies for Veritas NetBackup
- About Discovery types
- View and manage system notifications
- Customize with advanced parameters
- Use cases for advanced parameters
- Access control advanced parameters
- General Data Collection advanced parameters
- Cloud data collection advanced parameters
- Host discovery and collection advanced parameters
- Backup Manager advanced parameters
- Capacity Manager advanced parameters
- File Analytics advanced parameters
- Virtualization Manager advanced parameters
- Manage your Portal environment
- Analyze files
- Troubleshoot the Portal
- Retrieving log files
- Debug
- Attribute inheritance overrides
- Understanding report data caching
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. |
Group by TimePeriod Start/End Formatter | Date | [S|E]::[D|H|M|S|0|Y|T] S is used to calculate start date when End date is provided based on "group by". E is used to calculate End date when Start date is provided based on "group by". D-> Day H-> Hour M-> Minute S-> Second O- Month Y- Year T- Epoch Time in Milliseconds | Allows the framework to calculate the finish time based on the start time and "group by" selected. |
Date Group By | Date | N/A | Used in charts and graphs to format the legend, based on the "group by" that is selected in the scope selector at run time. This formatter determines 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. |
Numeric String | String | N/A | Treats numbers as a string without formatting. This allows sorting to be done numerically. |
Custom Number | Number | Enables users to define their own number format which is not tied to the setting in their user 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 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. Note that for line charts, if you select Unit Converter for a line, it only formats the mouse-over, not the Y-axis label. |
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 would be replaced 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. |
Truncate | Varchar | Number | Truncates a string with ellipsis. The maximum size of the string is 28 characters. Use the pattern to override the maximum size. When using the Truncate formatter, it is recommended to complete the Tool Tip field. |