Introduction
Licensed Modules
APTARE IT Analytics Components
Portal Server Software
Reporting Database
Data Collectors
Understanding the Portal
Portal Access
Portal Overview
Navigating with Search
Valid Entries for Search
Search Results View: Narrowing the Scope
Filtering Data in Management Grids
Valid Entries for Filtering
Advanced Filtering
Customizing Advanced Filter Logic
Saving Advanced Filters (Inventory)
Advanced Filtering Examples
Advanced Filter Operators
Clearing Advanced Filters
Deleting Saved Advanced Filters
Selecting Columns on Management Pages
Detecting Alerts in the Inventory
About the Inventory Tab
About the Reports Tab
Reports Tab Keyboard Shortcuts
Reports Tab Basics
Templates, Reports, and Dashboards Overview
About the Alert Tab
About the Admin Tab
Exploring Your Inventory
Inventory Privileges
Getting Started with the Inventory Navigator
Using the Hierarchy Toolbar to Organize Your Data
Inventory Object Limits
Show Objects
Resetting Inventory Defaults
Host Groups
Using Attributes to Organize Your Data
Using Host Groups to Organize Your Data
Creating Custom Object Lists
Working with the Inventory Reports View
Accessing Inventory Reports
Choosing Reports to Display
Filtering within Available Reports by Category
Pinning Reports - Saving Reports with Inventory Objects
Inventory Reports and the Action Menu
Working with the Inventory List View
Filtering the Inventory List View
Managing Objects in the Inventory List View
Assigning Attributes in the Inventory List View
Setting Attribute Values in the Inventory List View
Importing Host Attribute Values
Exporting Objects from the Inventory List View
Deleting Objects using the Inventory List View
Customizing Columns in the Inventory List View
Getting Acquainted With Reports
Reports and Templates
Cloud Reports and Templates
Report Library
Report Orientation
Shared Reports and Dashboards
About Dashboards
Working in the Reports Tab
New Badge
About Caching
Sections in the Reports Navigation Panel
About Badging
About the Action Bar
Reports Tab Keyboard Shortcuts
Customizing Your View Panel
Folder Types
Report Template Icons
Navigating through Reports
Generating and Maintaining Reports
Report Scope
Selecting Report Scope
Configuring Report Scope with Attributes
Group Hosts by Attributes
Searching for Hosts in the Report Scope Selector
Report Scope Selections
Alert Scope Selector Settings
Amazon Web Services (AWS) Scope Selector Settings
Backup Manager Scope Selector Settings
Backup Manager Advanced Scope Selector Settings
Capacity Manager Scope Selector Settings
Host Scope Selector Settings
Solution Reports Scope Selector Settings
System Health Check Scope Selector
Generating Reports
Generating Reports from the Cloud
Units of Measure in Reports
Advanced Filtering for Tabular Reports
Customizing Report Filter Logic
Sorting Columns in Reports
Refreshing and Setting Refresh Intervals
Modifying Reports
Interacting with Reports
Working with Topology
Adding a Note to a Backup Job Details Report
Using New and Updated User Report Templates
Using New and Updated System Report Templates (Super User Only)
Saving Reports
Saving Cloud Reports
Deleting Reports
Distributing, Sharing, Scheduling, and Alerting
Exporting Reports and Dashboards
Known Limitations for Donut Charts
Scheduling Exported Reports and Dashboards
Emailing Reports and Dashboards
Scheduling Emailed Reports and Dashboards
Viewing and Managing Your Scheduled Reports
Schedule Types
Deleting Scheduled Reports and Dashboards
Setting Up Alerts for Tabular Reports
Configuring an Alert
Deleting Report-Based Alerts
Sharing Reports, Dashboards and Folders
Working with Shared Reports
Organizing Reports
Working with Dashboards
Understanding Dashboard Icons
About Cached Reports on Dashboards
Creating New Dashboards and Adding Reports
Adding Reports to an Existing Dashboard
Saving a Dashboard with a Different Name
Editing the Scope for a Report on a Dashboard
Expanding a Report to Full Size on a Dashboard
Setting the Layout on a Dashboard
Deleting a Dashboard
Removing Reports from Dashboards
Creating a Custom Report Folder
Creating Shortcuts to Reports and Templates
Managing My Home Pages
User Home Pages and User Group Home Pages
Working with the Dynamic Template Designer
Dynamic Template Designer Overview
Dynamic Template Designer Cheat Sheet
Modify an Out-of-the-Box Dynamic Template
Examples of Dynamic Templates
Dynamic Template Designer Quick Start
Steps to Create Dynamic Templates
Working with Enterprise Objects and Fields
Select an Enterprise Object
Configure General Dynamic Template Designer Components
Converting to a Homogeneous, Product-Specific Template
Add Fields and Methods to a Dynamic Template
Alias Names for Fields
Conditions When Hidden Fields are Included by Default
Dynamic Template Field Configuration
Valid Formatter Patterns
Examples of Dynamic Templates Containing Graphics Tool Tips
Dynamic Template Designer Example
Dynamic Template Drilldown Configuration
Custom Drilldowns
Drilldown Parameters
Examples of Dynamic Templates Containing Drilldowns
Dynamic Template Designer Example
Using Groups in Dynamic Templates
Add a Group to Create Separate Line Charts in a Report
Add a Group to Create a Double Header in a Tabular Report
Dynamic Template Function Configurations
Examples of Dynamic Templates Containing Functions
Dynamic Template Designer Example
Create User-Defined Fields with the Field Builder
Create Fields with the Field Builder
Configure a Static Filter
Filter on Date Fields
Static Filter vs. Tabular Report Filter
Configure the Field Sort Order
Return Unique Results
Dynamic Template Scope Selector Components
Scope Selector Component - Custom Filter
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
Customize and Export Dynamic Templates
Exporting/Importing Dynamic Templates Containing Custom Attributes
Save a Dynamic Template After Edits
Format the Dynamic Template Output
Configure a Bar Chart Dynamic Template
Steps to Create a Bar Chart Dynamic Template
Examples of Bar Chart Dynamic Templates
Dynamic Template Designer Example
Configure an Area/Stacked Area Chart Dynamic Template
Configure a Donut Chart Dynamic Template
Example of a Donut Chart Dynamic Template
Configure a Horizontal Bar Chart Dynamic Template
Example of a Horizontal Bar Chart Dynamic Template
Configure a Horizontal Stacked Bar Chart Dynamic Template
Example of a Horizontal Stacked Bar Chart Dynamic Template
Configure a Line Chart Dynamic Template
Line Charts for Performance Metrics
Steps to Create a Line Chart Dynamic Template
Line Chart Field Requirements
One Object Per Line Chart, One or More Metrics Per Chart
Multiple Objects Per Line Chart, One Metric Per Chart
Format Line Chart Fields
Line Chart Scope Selections
Examples of Line Chart Dynamic Templates
Dynamic Template Designer Example
Configure a Pie Chart Dynamic Template
Examples of Pie Chart Dynamic Templates
Dynamic Template Designer Example
Configure a Stacked Bar Chart in a Dynamic Template
Example of a Stacked Bar Chart Dynamic Template
Configure a Table Dynamic Template
Examples of Tabular Dynamic Templates
Dynamic Template Designer Example
Create a Sparkline Chart in a Tabular Dynamic Template
Configure Chart Axes
Using Methods in Dynamic Templates
Overview of Method Creation
System Methods
Stand-Alone Methods
Viewing Methods
Adding or Editing Methods
Tokens for Methods
Exception Tables for a Method’s Join Clause
Validate and Save a Method
Delete a Method
Troubleshooting Dynamic Templates
Working with the SQL Template Designer
SQL Template Designer Overview
Database Published Views
Access the Database Published Views from the CLI
Access the Database Published Views from the SQL Template Designer
Steps to Create SQL Templates
Create a SQL Template
Configure SQL Template Scope Selector Components
Construct the SQL Query
Help for Database Views
Accessing the Published Database Views from the CLI
Special Characters in SQL Queries
Sample SQL Queries
Use Functions in Queries
Format the SQL Template Output
Number, Size, Date, and Time Formatting
Alignment, Aggregation, Bar Type, and Bar Type Color
Area, Line or Column Sparkline Format for a SQL Tabular Report Template
Configure a Bar Chart SQL Template
Example of a Bar Chart SQL Template: Host CPU Performance
Configure a Donut Chart SQL Template
Example of a Donut Chart SQL Template: NetBackup Job Size by Job Type
Configure a Gauge Chart SQL Template
Example of a Gauge Chart SQL Template: Allocated Capacity
Configure a Horizontal Bar Chart SQL Template
Example of a Horizontal Bar Chart SQL Template: Host CPU Performance
Configure a Horizontal Stacked Bar Chart SQL Template
Example of a Horizontal Stacked Bar Chart SQL Template: Available/Allocated Capacity
Configure an Area Chart SQL Template
Example of Area Chart SQL Template: Allocated Available
Configure a Pie Chart SQL Template
Example of a Pie Chart SQL Template: Job Size by Job Type
Configure a Pivot Table SQL Template
Example of a Pivot Table SQL Template: NetBackup Job Size
Configure a Stacked Bar Chart SQL Template
Example of a Stacked Bar Chart SQL Template: Host CPU Performance
Configure a Table in the SQL Template Designer
Example of a Table SQL Template: Host Group Membership List
Example of a Table SQL Template: Exposed Clients
Save and Share Report Templates
Advanced SQL Report Template Options
Creating Drilldowns
Using SQL Templates for Drilldowns
Creating Mouse-over Hovers
Adding an External Reference
Inventory Report Configuration
Edit a Custom Report Template
Exporting/Importing SQL Templates
Export a SQL Template
Import a SQL Template
Pipelined Functions for Report Query Building
General Functions
APTlistOfDates
aptStringConcat
collectString
getLicenseClientDetail
getServerAttributeValue
getObjectAttributeValue
getChildServerGroupContextById
getServerGroupContextById
secsToHoursMinSecs
Functions
APTgetJobTypeName
APTgetTapeDriveStatusName
getFullPathname
listJobSummaryAfterRestart
listJobSummaryAfterRestartNBW
listJobSummaryAfterRestart for NetWorker Backup Jobs
listOfBackupWindowDates
listOfBackupWindowDates (by Backup Window ID)
Policy Auditing Functions
listClientChanges
listPathnameChanges
listPolicyChanges
listScheduleChanges
Capacity Functions
listChargebackCatByVOLSDetail
listChargebackCatByNcVolDetail
listChargebackCatByFSDetail
listChargebackCatByFSDetail
listChargebackByLUNSummary
listChargebackByLUNDetail
listChargebackCatByLUNSummary
listChargebackCatByLUNDetail
Finding a Host Group ID
Alerting
Alert Rules
Scheduled Rules vs. Run Time Rules
Alert Rules Sample Set
Managing Alert Policies
Adding/Editing an Alert Policy
Copying an Alert Policy
Deleting a Alert Policy
Managing Alert Notifications
Adding an Alert Notification Delivery Method
Deleting an Alert Notification Delivery Method
Report-Based Alerts
Editing the Notifications for Report-Based Alerts
Running a Report-Based Alert On-Demand
Deleting a Report-Based Alert
Detecting Alerts in the Inventory
Suppressing Alert Notifications
Viewing Suppressed Alerts
Managing Hosts, Backup Servers and Host Groups
About Hosts, Backup Servers and Host Groups
Planning Your Host Group Hierarchy
Managing Host Groups
Adding Host Groups and Sub‑Groups
About Host Group Operations
Adding Host Groups
Automated Tool to Create Host Groups
Host Group Membership
Renaming Host Groups
Deleting Host Groups
Moving Host Groups
Finding a Host Group ID
Assigning a User Home Host Group
Managing Backup Servers
NetBackup Master Servers
About the Master Servers Group
Identifying Inactive Clients (For Veritas NetBackup)
Managing Hosts and Backup Servers
Adding and Editing Hosts and Backup Servers
Importing Hosts
Decommission/Recommission Hosts and Backup Servers
Deleting Hosts
Managing Attributes and Objects
About Attributes
Attribute Example
Host Groups vs Attributes
Bulk Load Utilities and Attributes
System Attributes
Attribute Inheritance
Managing Attributes
Setting Attributes on Hosts
Adding Attributes
Editing or Renaming Attributes
Deleting Attributes
Attribute Naming Rules
Examples of Attributes and Values
Understanding the Attribute Management View
Attribute Management View (Top-Level Domain)
Attribute Management View (Sub-Domain)
Export/Import Dynamic Templates with Custom Attributes
Export a Dynamic Template that Contains Attributes
Import a Dynamic Template that Contains Attributes
About Object Maintenance
Product-Specific Objects for Reporting
Maintaining Objects
Assign Attributes Using Object Maintenance
Search for Objects by Type in Object Maintenance
Customize Library Objects
Permanently Remove Devices, Libraries and Drives
Providing Portal Access and User Authentication
Providing User Access to the Portal
Creating Portal User Accounts
About User Types
Selecting User Groups for Users
Working with User Groups
Creating User Groups
Assigning Users to User Groups
About User Privileges
Assigning User Privileges
Setting User Group Privileges
Enabling New Product Report Templates
Enabling Cloud Privileges
Granting Access to Template Designers
Enabling All Privileges in a Category
Managing Users and User Groups
Searching for Users and User Groups
Editing User Accounts
Impersonating User Accounts
Setting/Resetting Passwords
Account Lockout
Managing User Group Home Pages (Administrator)
Removing Portal Users
Deactivating User Accounts
Configuring Master Schedules and Backup Windows
About Master Schedules
Configuring Master Schedules
About Custom Backup Windows
Custom Backup Window Requirements
Configuring Custom Backup Windows
Adding and Editing Policies
Adding/Editing a Cloud Policy to Share Performance Statistics
Configure Community Performance Profiling
Adding/Editing a Threshold Policy
Adding/Editing a Capacity Billing and Usage Policy
Capacity Chargeback Policy Types
Adding/Editing a Backup SLA Policy
Adding/Editing a SAN Fabric Chargeback Policy
APTARE IT Analytics Billing and Chargeback Policies
Adding/Editing a Billing and Chargeback Policy
Solutions Administration
Storage Optimization Solution Overview
Understanding the Value of Storage Optimization Historical Data
Configuring Storage Optimization Rules
Enabling Storage Optimization Rules
Storage Optimization Rule Prerequisites and Logic
Risk Mitigation Solution Overview
Configuring Risk Mitigation Rules
Managing and Monitoring Data Collection
Data Collection Overview
Data Collection Component Configuration
About Data Collection Tasks
Data Collector Installation Summary
Updating the Local Hosts File for Data Collection
Managing Data Collectors and Collection Policies
About Validation and Status
Adding/Editing Data Collectors
Enabling/Disabling Data Collectors
Enabling and Disabling Data Collection Policy Schedules
Reviewing Collectors and Collection Status
Deleting a Data Collector
Upgrading Data Collectors
Monitoring Data Collection Status
Organizing the Collection Status View
Quick Filters
Viewing Data Collection Status
Troubleshooting Data Collection Status
Using Reports to Monitor Data Collection Status
Working with Capacity Manager Host Data Collection
Understanding the Host Data Collection Process
Host Resources Prerequisites and Configurations
Host Access Privileges, Sudo Commands, Ports, and WMI Proxy Requirements
Host Access Requirements
Command Path Verification
Host Discovery and Collection Configuration Steps
Host Discovery and Collection Setup Overview
Host Discovery and Collection Maintenance Overview
Before Discovering Hosts
Configure/Search
Manage Credentials
Manage WMI Proxy
Manage Paths
Manage Access Control
Host Management
Configure Host Discovery Policies to Populate the Host Discovery and Collection View
Execute and Monitor Host Discovery
Validate Host Connectivity
Show Errors
Filter the Host Discovery and Collection window - Hide/Unhide, Remove
Search and Export in Host Discovery and Collection
Export in Host Discovery and Collection
Configure and Edit Host Probes
Propagate Probe Settings: Copy Probes, Paste Probes
Discovery Policies for Veritas NetBackup
Task Overview: Configuring and Monitoring Discovery Policies
Discovery Policies Overview
About Discovery Types
Activate a Discovery License
Create and Edit Discovery Policies
Exclude Devices from Discovery Policies
Activate Discovery Probes in the NetBackup Data Collector Policy
Monitor Discovery Processes
View Client Protection Status
Reset Discovery Data
Viewing and Managing System Notifications
Viewing System Alerts
Deferring or Suppressing Notifications
Customizing with Advanced Parameters
Overview
Use Cases for Advanced Parameters
Domain/Collector
Operating System
Host
Commands
Adding an Advanced Parameter
Advanced Parameters by Function and Product
Access Control Advanced Parameters
ACCESS_CONTROL_FALLBACK_STRINGS
ACCESS_CONTROL_PASSWORD_PROMPT
ACCESS_CONTROL_SKIP_COMMAND_OUTPUT
ACCESS_CONTROL_TTY_REQUIRED
ACCESS_CONTROL_TTY_REQUIRED_ERROR
ACCESS_CONTROL_TTY_REQUIRED_NUM_LINES_SKIP
General Data Collection Advanced Parameters
COMMAND_TIMEOUT
DATARCVR_READ_TIMEOUT
LOGGING_LEVEL
METACOLLECTOR_MAX_THREADS
METACOLLECTOR_MIN_THREADS
PATH_CONTROL_PARAM
SSH_ALTERNATE_PKG_USE
SSH_CHANNEL_WAIT_TIME
SSH_CIPHERS
SSH_DEBUG
SSH_PORT
STDOUT_ERROR
STDOUT_FILTER_LIST
TELNET_REPLY_DISCARD_MESSAGE
THREAD_IDLE_TIMEOUT
WMI_PROXY_VERSION_TIMEOUT
Cloud Data Collection Advanced Parameters
Amazon Web Services (AWS)
AWS_BILLING_LOOKBACK_MONTHS
Microsoft Azure
AZURE_BACKUP_LOOKBACK_DAYS
AZURE_BACKUP_LOOKBACK_OVERRIDE_DAYS
AZURE_BILLING_LOOKBACK_DAYS
Host Discovery and Collection Advanced Parameters
APP_DISK_PATH
HBAVERIFY_NUM_DELAY_SECS
HOST_CONNECTION_PROTOCOL
HOST_CONNECTION_TIMEOUT
HOST_SOCKET_TIMEOUT
IGNORE_FILE_SYSTEMS
IS_EMULEX_MAPPING_STRICT_CHECKING
NUM_HBAVERIFY_RUN
STRICT_HOST_KEY_CHECKING
USE_VIO_RESTRICTED_SHELL
Backup Manager Advanced Parameters
COMMVAULT_OLDEST_JOB_HOURS
MMINFO_MOVE_BACKWARD_MIN
NBU_DUP_JOB_PARTIAL_STATUS_OVERRIDE
NO_AVAMAR_CLI
RMAN_BACKUP_LOOKBACK_DAYS
RMAN_BACKUP_LOOKBACK_OVERRIDE
SUPPRESS_KERBEROS_PROMPT
USE_ALT_NBU_INCL_EXCL
USE_NTML_V2
VEEAM_BACKUP_LOOKBACK_DAYS
VEEAM_BACKUP_LOOKBACK_DAYS_OVERRIDE
Capacity Manager Advanced Parameters
EMC_MULTIPATH_OFF
EMC_VMAX_INCLUDE_ALL_MASKINGVIEWS
HDS_HTM_JPCCTRL_PATH
REMOTE_RAID_AGENT
SYMSTAT_COUNT
SYMSTAT_INTERVAL_SECONDS
File Analytics Advanced Parameters
FA_CLEAN_UP_TEMPORARY_FILES
AFS_PATH_EXCLUDE_DIRECTORY_NAME
FA_HOST_CAPTURE_REMOTE_SHARES
FA_HOST_DIRECTIVE
Virtualization Manager Advanced Parameters
VMWARE_COLLECT_UNUSED_PROPERTIES
VMWARE_DATASTORE_TIMEOUT_SECONDS
Managing Your Portal Environment
Root Folder and Domains
Adding/Configuring a Domain
Configure Alerting for a Domain
Community Performance Statistics for a Domain
Managing Your Profile
Changing Your Login Password
Analyzing Files
File Categories
Adding/Editing File Categories
File List Export
File List Export Output in CSV Format
Troubleshooting the Portal
Support Tools
Requesting a Support Package
File Selector Wildcards
Retrieving Log Files
Archiving Script
Debugging
Debugging Level Scope
Login Errors
Adding Notes to Failed Jobs
Host Name Processing - Filters and Aliases
Changing the Portal Server’s IP Address
Changing the Port for Portal Server Communication
Determine Report Rendering Statistics
Clearing the Inventory and Report Cache
Attribute Inheritance Overrides
Override Inherited Attribute Values
Understanding Report Data Caching
How Reports and Caching Work Together
Storing and Purging Data
Disabling Optimistic Caching with portal.properties
Introduction
Inventory
GlobalSearch
userAdvSearch
PanelHelp
AddNewObjectList
SelectReports
ObjectAttribute
ImportHostAttribute
reportDesigner
scopePicker
filter
notes
exportNow
exportSchedule
scheduleExpressionBuilder
emailNow
emailSchedule
scheduledReports
alert
share
sharedReports
dashboard
SetDashboardDisplay
manage_hmpage
RDMainDesigner
RDObjectSelect
RDFieldConfigure
RDDrilldown
RDDrilldownParameter
RDFunctionBuilder
RDFieldBuilder
RDFilter
RDOrderBy
RDScopeSelect
DTDCustomFilter
RDSave
RDConfigureChart
RDMethodDesign
reportTemplateDesigner
reportTemplateDesignerImport
Select_MonitorRule
Manage_MonitorPolicy
Add_MonitorPolicy
Alert_Notification
Add_AlertNotification
Report_Based_Alerts
Edit_ReportBased_Alerts
serverGroups
serverGroupAdministration
AddNewHostGroup
ServerAdministration
addServer
AddHost
EditHost
ImportHost
attributes
attributeAdministration
HostAttribute
AddAttribute
NewEditAttribute
objectMaint
manageusers
userPrivileges
selectUserGroup
userGroupAdministration
userGroupMembers
aboutPrivileges
userGroupPrivileges
privileges
EditUserAccount
passwordSet
manage_grouphmpage
add_hmpg_usergroup
editMasterSchedule
masterSchedules
backupWindowAdministration
aptareCommunity
threshold
thresholds
capacityChargebackRules
slaGroupPolicies
sanFabricChargeback
billingUsagePolicies
StorageOptOverview
EditStorageOptCategory
RiskMitOverview
EditRiskMitigateCategory
dataCollectorPolicy
CollectorsView
dataCollector
dataCollectorUpgrader
CollectionStatus
hostInventoryTab
manageCredentials
manageWMI
managePaths
manageAccess
dataCollectorHost
discoveryAdministration
discoveryAdministrationEdit
systemNotifications
advancedParameters
newDomain
domainAdministration
MyProfile
fileCategories
massiveDataExport
collectorLogs
Debug
AdminTab
ExplorerReports
OCNMain