EATON Visual Data Center Visual Capacity Optimization Manager Visual Power Manager User Guide
- June 9, 2024
- EATON
Table of Contents
Visual Data Center Visual Capacity Optimization Manager Visual Power
Manager
Visual Data Center Visual Capacity Optimization Manager
Product Information
The Visual Data Center Visual Capacity Optimization Manager is a software tool that enables users to manage their data center infrastructure more effectively. The tool is designed to help users optimize their data center’s capacity, improve energy efficiency, and reduce operating costs.
The software includes various features that allow users to monitor and manage their data center infrastructure in real-time. This includes the ability to view power usage, temperature, and humidity levels, as well as the status of individual devices and systems.
The software also includes a web-based interface that provides users with easy access to all of the features and functionality of the tool. This interface is designed to be easy to use, with intuitive navigation and simple controls.
Product Usage Instructions
To use the Visual Data Center Visual Capacity Optimization Manager, users must first log in to the application using their username and password. Once logged in, users can access all of the features and functionality of the tool through the web-based interface.
The interface is divided into several sections, including a navigation panel, banner functions, and a content area. The navigation panel allows users to navigate through the various features of the tool, while the banner functions provide quick access to key functions such as search and help.
The content area displays information about the data center infrastructure, including detailed information about individual devices and systems. Users can use this information to monitor usage levels, identify areas where energy efficiency can be improved, and make adjustments as needed.
Overall, the Visual Data Center Visual Capacity Optimization Manager is a powerful tool that can help organizations optimize their data center infrastructure, improve energy efficiency, and reduce operating costs. By providing real-time monitoring and management capabilities, the tool enables organizations to make data-driven decisions that can have a significant impact on their bottom line.
Visual Data Center Visual Capacity Optimization Manager
Visual Power Manager*
Web Interface User Guide Release 6.9.0
Version 1 Dec 2022
- VCOM and VDC contain all the features described in this document. Not all features described in this document are available in Visual Power Manager Pro and Visual Power Manager Essential. VPM-Pro has a subset of the features in VCOM. VPM-Essential has a subset of the features available in VPM-Pro.
Eaton
Proprietary and Confidential
www.Eaton.com/VCOM
LEGAL NOTICE
Copyright © 19992021. Eaton All rights reserved. The contents of this
document constitute valuable proprietary and confidential property of Eaton
and are provided subject to specific obligations of confidentiality set forth
in one or more binding legal agreements. Any use of this material is limited
strictly to the uses specifically authorized in the applicable license
agreement(s) pursuant to which such material has been furnished. Any use or
disclosure of all or any part of this material not specifically authorized in
writing by Eaton is strictly prohibited.
2
Contents
Contact Support
For your convenience, Eaton provides one site where you can access the
information that you need for our DCIM products. You can access the resources
listed below by going to https://support.optimumpathinc.com.
· Online and telephone contact information for technical assistance and
customer services · Product and documentation downloads · Other helpful
resources appropriate for your product
3
Contents
Contents
Contents…………………………………………………………………………………………………………………………………….. 4 1. Introduction
………………………………………………………………………………………………………………………….. 17
1.1. HTML5 Web Interface………………………………………………………………………………………………………. 17 1.2.
Application Overview……………………………………………………………………………………………………….. 17 1.3. Web
versus 3D Client……………………………………………………………………………………………………….. 18 1.4. Accessing
the Web Interface …………………………………………………………………………………………….. 19 2.
Login…………………………………………………………………………………………………………………………………….. 20 2.1. Logging In
to the Application…………………………………………………………………………………………….. 20 2.2. Login
Issues…………………………………………………………………………………………………………………….. 20
2.2.1. Incorrect User/Password Combination ………………………………………………………………………… 20
2.2.2. Account Already Logged on System …………………………………………………………………………….. 21
2.2.3. License Quota Overage ……………………………………………………………………………………………… 21 2.2.4.
Grace Period for Licenses …………………………………………………………………………………………… 21 2.3. Logging
Out of the Application ………………………………………………………………………………………….. 21 2.4. Session
Timeouts …………………………………………………………………………………………………………….. 21 3. Page Layout
Overview…………………………………………………………………………………………………………….. 23 3.1. Components
…………………………………………………………………………………………………………………… 23 3.2. Navigation
Panel……………………………………………………………………………………………………………… 23 3.2.1. Application
Logo……………………………………………………………………………………………………….. 24 3.2.2. Feature Menus
…………………………………………………………………………………………………………. 24 3.2.3. Navigation Tree
………………………………………………………………………………………………………… 25 3.2.4. Devices
Navigator……………………………………………………………………………………………………… 25 3.2.5. Favorites
List…………………………………………………………………………………………………………….. 25 3.2.6. Minimize
Button……………………………………………………………………………………………………….. 26 3.2.7. Main Menu
Item……………………………………………………………………………………………………….. 26 3.3. Banner Functions
…………………………………………………………………………………………………………….. 26 3.3.1. Alarm Counters
………………………………………………………………………………………………………… 27 3.3.2. Personal Menu
…………………………………………………………………………………………………………. 27 3.3.3. Search
……………………………………………………………………………………………………………………… 29 3.3.4. Help
………………………………………………………………………………………………………………………… 30 3.4. Content
Area…………………………………………………………………………………………………………………… 31
4
Contents
3.4.1. Standard Table Features ……………………………………………………………………………………………. 31 3.4.2. Search String Formats ……………………………………………………………………………………………….. 34 3.4.3. Select and Arrange Table Columns ……………………………………………………………………………… 35 3.5. Table Item Detail Page……………………………………………………………………………………………………… 36 4. Home Menu Group Page ………………………………………………………………………………………………………… 37 4.1. Location …………………………………………………………………………………………………………………………. 37 4.2. Graphs……………………………………………………………………………………………………………………………. 37 4.3. My Workflow Items …………………………………………………………………………………………………………. 37 4.4. My Audits……………………………………………………………………………………………………………………….. 37 4.5. PUE………………………………………………………………………………………………………………………………… 37 4.6. 10 Most Recent Reports …………………………………………………………………………………………………… 37 4.7. 10 Most Frequent Alarms Within the Last 24 Hours …………………………………………………………….. 38 4.8. 10 Most Recent Events …………………………………………………………………………………………………….. 38 5. Data Analysis Menu Group ……………………………………………………………………………………………………… 39 5.1. BI Dashboard Menu Item………………………………………………………………………………………………….. 39 5.1.1. My Dashboards ………………………………………………………………………………………………………… 39 5.1.2. Dashboards………………………………………………………………………………………………………………. 45 5.1.3. Charts ……………………………………………………………………………………………………………………… 48 5.2. Graphs Menu Item…………………………………………………………………………………………………………… 55 5.2.1. Graph Table List………………………………………………………………………………………………………… 55 5.2.2. Create Graphs…………………………………………………………………………………………………………… 56 5.2.3. Graphs Reflect Alarm Level Colors ………………………………………………………………………………. 67 5.3. Reports Menu Item………………………………………………………………………………………………………….. 68 5.3.1. Reports List………………………………………………………………………………………………………………. 69 5.3.2. My Reports ………………………………………………………………………………………………………………. 75 5.3.3. Recent Reports …………………………………………………………………………………………………………. 75 5.3.4. User Defined Reports ………………………………………………………………………………………………… 75 5.3.5. Scheduled Reports ……………………………………………………………………………………………………. 79 5.4. Capacity Plans Menu Item ………………………………………………………………………………………………… 81 5.4.1. Manage Capacity Plans ……………………………………………………………………………………………… 81 5.4.2. Modify Capacity Plans ……………………………………………………………………………………………….. 81 5.4.3. Analyze Plan Results………………………………………………………………………………………………….. 82 5.4.4. Export Capacity Plan Results ………………………………………………………………………………………. 82
5
Contents
5.5. Power Project Plans Menu Item ………………………………………………………………………………………… 82
5.5.1. Creating a New Power Project Plan …………………………………………………………………………….. 83
6. Alarms Menu Group……………………………………………………………………………………………………………….. 85 6.1.
Alarm Panel Menu Item……………………………………………………………………………………………………. 85 6.2. Traps
……………………………………………………………………………………………………………………………… 86 6.3. Smart Alarms
………………………………………………………………………………………………………………….. 86 6.3.1. Smart Alarm Menu
……………………………………………………………………………………………………. 87 6.3.2. Create new Smart Alarm
……………………………………………………………………………………………. 87 6.3.3. Smart Alarm trigger rules
…………………………………………………………………………………………… 89 6.4. Service Levels
(SLA)………………………………………………………………………………………………………….. 90 6.4.1. SLA Records Tab
……………………………………………………………………………………………………….. 90 6.4.2. SLA Rules Tab
…………………………………………………………………………………………………………… 91 6.4.3. Create new SLA Rules
………………………………………………………………………………………………… 91 6.4.4. Recalculate SLA Value
……………………………………………………………………………………………….. 93
7. Calendar ……………………………………………………………………………………………………………………………….. 96 8. Rights
Access Menu Group ……………………………………………………………………………………………………… 97
8.1. Companies Menu Item …………………………………………………………………………………………………….. 97 8.1.1.
Companies Function Tiles…………………………………………………………………………………………… 98
8.2. Departments Menu Item ………………………………………………………………………………………………… 100 8.2.1.
Departments Function Tiles ……………………………………………………………………………………… 101
8.3. User Groups Menu Item …………………………………………………………………………………………………. 103 8.3.1.
User Groups List ……………………………………………………………………………………………………… 103 8.3.2. User Group
Form…………………………………………………………………………………………………….. 104
8.4. Users Menu Item …………………………………………………………………………………………………………… 107 8.4.1. User
Form ………………………………………………………………………………………………………………. 107
8.5. Owners Menu Item………………………………………………………………………………………………………… 111 8.5.1.
Owners Form………………………………………………………………………………………………………….. 111
8.6. Current Users Menu Item ……………………………………………………………………………………………….. 112 9.
Groups Menu Group …………………………………………………………………………………………………………….. 114
9.1. Create New Groups ……………………………………………………………………………………………………….. 115 9.1.1.
Devices Tab…………………………………………………………………………………………………………….. 116
10. Devices Menu Group…………………………………………………………………………………………………………… 117 10.1.
Devices Menu Item………………………………………………………………………………………………………. 117
6
Contents
10.1.1. Managing Device Table Fields …………………………………………………………………………………. 117 10.1.2. Exporting Devices ………………………………………………………………………………………………….. 118 10.1.3. Device Form………………………………………………………………………………………………………….. 118 10.1.4. Device Central for Existing Devices ………………………………………………………………………….. 121 10.2. Types Menu Item …………………………………………………………………………………………………………. 131 10.2.1. Types Form …………………………………………………………………………………………………………… 131 10.3. Manufacturers Menu Item ……………………………………………………………………………………………. 133 10.3.1. Manufacturers Form ……………………………………………………………………………………………… 133 10.4. Product Lines Menu Item ……………………………………………………………………………………………… 135 10.4.1. Product Lines Form ……………………………………………………………………………………………….. 135 10.5. Models Menu Item ………………………………………………………………………………………………………. 137 10.5.1. Model Form ………………………………………………………………………………………………………….. 137 10.6. Consumable Types Menu Item ………………………………………………………………………………………. 141 10.7. Manage Menu Item ……………………………………………………………………………………………………… 142 10.7.1. Upload Jobs Tab ……………………………………………………………………………………………………. 142 10.7.2. Configuration Tab………………………………………………………………………………………………….. 143 10.7.3. Firmwares…………………………………………………………………………………………………………….. 146 10.7.4. Certificates …………………………………………………………………………………………………………… 147 11. Maintenance Menu Group ………………………………………………………………………………………………….. 149 11.1. Calendar Menu Item …………………………………………………………………………………………………….. 149 11.2. Service Schedules Menu Item ……………………………………………………………………………………….. 149 11.2.1. Devices Tab…………………………………………………………………………………………………………… 149 11.2.2. Schedules Tab……………………………………………………………………………………………………….. 150 11.3. Service History Menu Item ……………………………………………………………………………………………. 150 11.4. Warranty Menu Item ……………………………………………………………………………………………………. 151 12. Virtual Devices Menu Group………………………………………………………………………………………………… 152 12.1. Disable BLDC-C…………………………………………………………………………………………………………….. 152 12.1.1. VMware VCenter Menu Item ………………………………………………………………………………….. 152 12.1.2. VMware Hosts Menu Item ……………………………………………………………………………………… 152 12.1.3. VMware Guests Menu Item ……………………………………………………………………………………. 152 12.1.4. Virtual Groups Menu Item ……………………………………………………………………………………… 152 12.1.5. Action History Menu Item ………………………………………………………………………………………. 153 12.2. Enable BLDC-C……………………………………………………………………………………………………………… 153
7
Contents
12.2.1. VM Connectors Menu Item…………………………………………………………………………………….. 153 12.2.2. VM Clusters Menu Item …………………………………………………………………………………………. 156 12.2.3. VM Hosts Menu Item …………………………………………………………………………………………….. 157 12.2.4. VM Guests Menu Item …………………………………………………………………………………………… 158 12.3. Action History Menu Item …………………………………………………………………………………………….. 160 13. Racks Menu Group……………………………………………………………………………………………………………… 161 13.1. Rack Manager Menu Item …………………………………………………………………………………………….. 161 13.1.1. Racks List Tab ……………………………………………………………………………………………………….. 162 13.1.2. Devices List Tab …………………………………………………………………………………………………….. 162 13.1.3. Models List Tab …………………………………………………………………………………………………….. 163 13.1.4. Rack View …………………………………………………………………………………………………………….. 163 13.1.5. Rack Capacity Table……………………………………………………………………………………………….. 168 13.1.6. Properties Table ……………………………………………………………………………………………………. 168 13.1.7. Adding Devices to Rack ………………………………………………………………………………………….. 169 13.1.8. Moving Devices to another rack ……………………………………………………………………………… 170 13.1.9. Removing Devices from Rack ………………………………………………………………………………….. 170 13.1.10. Print Rack Configurations……………………………………………………………………………………… 170 13.2. Audit Manager …………………………………………………………………………………………………………….. 170 13.2.1. Audit Form……………………………………………………………………………………………………………. 171 13.2.2. Executing an Audit…………………………………………………………………………………………………. 172 14. Connections Menu Group ……………………………………………………………………………………………………. 173 14.1. Cables Menu Item………………………………………………………………………………………………………… 173 14.1.1. Edit Cables ……………………………………………………………………………………………………………. 174 14.2. Fiber Cables ………………………………………………………………………………………………………………… 174 14.2.1. Create New Fiber Cables ………………………………………………………………………………………… 175 14.3. Port Mapping Menu Item ……………………………………………………………………………………………… 176 14.3.1. Cable Form …………………………………………………………………………………………………………… 177 14.4. Port Type…………………………………………………………………………………………………………………….. 178 14.4.1. Port Types Form ……………………………………………………………………………………………………. 178 14.5. Cable Types…………………………………………………………………………………………………………………. 179 14.5.1. Cable Types Form ………………………………………………………………………………………………….. 179 14.6. Port Settings ……………………………………………………………………………………………………………….. 180 14.6.1. Port Settings Form…………………………………………………………………………………………………. 180
8
Contents
14.7. Port Allocations Menu Item…………………………………………………………………………………………… 181
14.7.1. Port Allocations Object Form ………………………………………………………………………………….. 181
14.8. Network Layers……………………………………………………………………………………………………………. 183 14.8.1.
Devices Tab…………………………………………………………………………………………………………… 183
15. Discovery Menu Group ……………………………………………………………………………………………………….. 184 15.1.
Discovery Information Tiles …………………………………………………………………………………………… 184 15.1.1.
Discovery Status Tile ……………………………………………………………………………………………… 184 15.1.2.
Discovery Agents Tile …………………………………………………………………………………………….. 184 15.1.3.
Discovery Process Tile ……………………………………………………………………………………………. 184 15.1.4. Jobs
Manager Tile………………………………………………………………………………………………….. 185 15.1.5. Devices
Tile…………………………………………………………………………………………………………… 185 15.2. Jobs Manager
Tab………………………………………………………………………………………………………… 185 15.2.1. Discovery Job Form
……………………………………………………………………………………………….. 186 15.3. Devices Tab
…………………………………………………………………………………………………………………. 188 15.3.1. Device Status Defined
……………………………………………………………………………………………. 189 15.4. Logs Tab
……………………………………………………………………………………………………………………… 189
16. Monitoring Menu Group……………………………………………………………………………………………………… 190 16.1.
General Overview ………………………………………………………………………………………………………… 190 16.2. Monitoring
Templates Menu Item …………………………………………………………………………………. 191 16.2.1. Create new
Monitoring Templates ………………………………………………………………………….. 191 16.2.2. Import
Monitoring Templates…………………………………………………………………………………. 197 16.2.3. Export
Monitoring Templates …………………………………………………………………………………. 198 16.3. Triggers Menu
Item ……………………………………………………………………………………………………… 198 16.3.1. Create New Triggers
………………………………………………………………………………………………. 199 16.3.2. Import
Triggers……………………………………………………………………………………………………… 201 16.3.3. Export Triggers
……………………………………………………………………………………………………… 201 16.4. Actions Menu Item
………………………………………………………………………………………………………. 201 16.4.1. Create New
Actions……………………………………………………………………………………………….. 202 16.5. Probes Menu Item
……………………………………………………………………………………………………….. 216 16.5.1. Probe Configuration
Form………………………………………………………………………………………. 216 16.6. RDG Servers
………………………………………………………………………………………………………………… 217 16.6.1. Create New RDG Server
…………………………………………………………………………………………. 219 16.7. CSV
Mapping……………………………………………………………………………………………………………….. 220
9
Contents
16.7.1. Phase 1: Creating a CSV Mapping Template ……………………………………………………………… 220 16.7.2. Phase 2: Create a Monitoring Template …………………………………………………………………… 222 16.7.3. Phase 3: Configure Monitoring for the Device…………………………………………………………… 222 16.8. Data Mapping Menu Item …………………………………………………………………………………………….. 223 16.8.1. Before Data Mapping …………………………………………………………………………………………….. 223 16.8.2. Data Mapping Steps ………………………………………………………………………………………………. 224 16.9. MIB Browser Menu Item ………………………………………………………………………………………………. 225 16.9.1. SNMP Walk…………………………………………………………………………………………………………… 226 17. Workflow Menu Group ……………………………………………………………………………………………………….. 228 17.1. My Activity Menu Item …………………………………………………………………………………………………. 228 17.1.1. My Workflow Items……………………………………………………………………………………………….. 228 17.1.2. My Projects…………………………………………………………………………………………………………… 228 17.1.3. My Tasks………………………………………………………………………………………………………………. 228 17.1.4. My Work Orders……………………………………………………………………………………………………. 229 17.1.5. My Events …………………………………………………………………………………………………………….. 229 17.2. Projects Menu Item ……………………………………………………………………………………………………… 229 17.2.1. New Button ………………………………………………………………………………………………………….. 230 17.2.2. Project Form …………………………………………………………………………………………………………. 230 17.3. Tasks Menu Item …………………………………………………………………………………………………………. 234 17.3.1. Actions Tab …………………………………………………………………………………………………………… 235 17.3.2. Rights Access Tab (Task)…………………………………………………………………………………………. 236 17.3.3. Approvals Tab (Task) ……………………………………………………………………………………………… 236 17.3.4. Comments Tab ……………………………………………………………………………………………………… 236 17.4. Steps for Creating and Completing a Project (Regular) ……………………………………………………… 237 17.4.1. Create Project……………………………………………………………………………………………………….. 237 17.4.2. Create Tasks …………………………………………………………………………………………………………. 237 17.4.3. Add Actions to Tasks ……………………………………………………………………………………………… 237 17.4.4. Back to Project ……………………………………………………………………………………………………… 240 17.4.5. Define Project Approvers ……………………………………………………………………………………….. 241 17.4.6. Submit the Project for Approval ……………………………………………………………………………… 241 17.4.7. Approve Project…………………………………………………………………………………………………….. 242 17.4.8. Plan the Actions…………………………………………………………………………………………………….. 242 17.4.9. Submit the Actions ………………………………………………………………………………………………… 244
10
Contents
17.4.10. Define the Task Approvers ……………………………………………………………………………………. 245 17.4.11. Submit Task for Approval ……………………………………………………………………………………… 245 17.4.12. Approve Task………………………………………………………………………………………………………. 245 17.4.13. Create Work Order ………………………………………………………………………………………………. 246 17.4.14. Assign the Work Order and Add Actions…………………………………………………………………. 247 17.4.15. Submit Work Order for Deployment………………………………………………………………………. 248 17.4.16. Start SLA | Stop SLA Timer (optional) …………………………………………………………………….. 249 17.4.17. Complete Work Order ………………………………………………………………………………………….. 249 17.4.18. Completing the Project ………………………………………………………………………………………… 249 17.5. Steps for Creating a Quick New Project…………………………………………………………………………… 250 17.5.1. Enable Quick New Project Function …………………………………………………………………………. 250 17.5.2. Create the Quick New Project – Basic Information …………………………………………………….. 250 17.5.3. Devices ………………………………………………………………………………………………………………… 251 17.5.4. Connections………………………………………………………………………………………………………….. 254 17.6. Work Orders ……………………………………………………………………………………………………………….. 254 18. Integrations Menu Group ……………………………………………………………………………………………………. 256 18.1. Camera Studio Menu Item ……………………………………………………………………………………………. 256 18.1.1. Create Camera Devices ………………………………………………………………………………………….. 256 18.1.2. Managing Camera Groups………………………………………………………………………………………. 257 18.1.3. Viewing Camera Groups…………………………………………………………………………………………. 257 18.1.4. Camera Controls……………………………………………………………………………………………………. 257 18.1.5. Viewing Single Cameras …………………………………………………………………………………………. 258 18.1.6. Troubleshooting Camera Images …………………………………………………………………………….. 259 18.2. ITSM Integration Menu Item …………………………………………………………………………………………. 259 18.2.1. Synched Devices Function Tile ………………………………………………………………………………… 259 18.2.2. Configuration Function Tile …………………………………………………………………………………….. 260 18.2.3. Model Map Function Tile ……………………………………………………………………………………….. 262 18.2.4. Attribute Map Function Tile ……………………………………………………………………………………. 264 18.2.5. ITSM Service Now Integration Specifics ……………………………………………………………………. 266 18.2.6. ITSM CSV Integration Specifics………………………………………………………………………………… 268 18.2.7. ITSM RFCode CenterScape Integration Specifics ……………………………………………………….. 269 18.3. Eaton Predict Pulse Menu Item ……………………………………………………………………………………… 272 18.3.1. Settings Function Tile …………………………………………………………………………………………….. 272
11
Contents
18.3.2. Devices Function Tile……………………………………………………………………………………………… 273 18.3.3. Attributes Function Tile………………………………………………………………………………………….. 274 19. Import | Export Menu Group……………………………………………………………………………………………….. 276 19.1. Import Central Menu Item ……………………………………………………………………………………………. 276 19.1.1. Import Wizard ………………………………………………………………………………………………………. 276 19.1.2. Import Devices Spreadsheet …………………………………………………………………………………… 278 19.1.3. Import Locations Spreadsheet ………………………………………………………………………………… 285 19.2. Export PDU Menu Item…………………………………………………………………………………………………. 290 19.2.1. Edit the PDU Spreadsheet ………………………………………………………………………………………. 290 19.3. Export History ……………………………………………………………………………………………………………… 292 20. Settings Menu Group ………………………………………………………………………………………………………….. 293 20.1. Attribute Manager Menu Item ………………………………………………………………………………………. 293 20.1.1. Attribute Form………………………………………………………………………………………………………. 293 20.2. Unit Manager Menu Item ……………………………………………………………………………………………… 294 20.2.1. Unit Manager Form ……………………………………………………………………………………………….. 294 20.3. Applications Menu Item ……………………………………………………………………………………………….. 294 20.3.1. Application Form …………………………………………………………………………………………………… 295 20.4. System Settings Menu Item…………………………………………………………………………………………… 295 21. Branch Circuit Monitoring……………………………………………………………………………………………………. 299 21.1.1. Create PDU Device ………………………………………………………………………………………………… 299 21.1.2. Creating Panels and Breakers………………………………………………………………………………….. 299 21.1.3. Create a Monitoring Template for the Panels …………………………………………………………… 302 21.1.4. Connecting Breakers to Rack PDU Devices ……………………………………………………………….. 302 21.1.5. Activating Monitoring for Branch Circuit Data…………………………………………………………… 303 21.1.6. Viewing Panel Schedules ………………………………………………………………………………………… 304 21.1.7. PDU Floor Device Dashboard Attribute Map …………………………………………………………….. 306 22. Device Dashboards……………………………………………………………………………………………………………… 307 22.1. PDU Rackmount Device Dashboard………………………………………………………………………………… 307 22.1.1. Buttons ………………………………………………………………………………………………………………… 307 22.1.2. Capacity Tables……………………………………………………………………………………………………… 308 22.1.3. Phase Table ………………………………………………………………………………………………………….. 308 22.1.4. Outlets Table ………………………………………………………………………………………………………… 308 22.1.5. PDU Rackmount Device Dashboard Attribute Map ……………………………………………………. 310
12
Contents
22.2. Rack Device Dashboard ………………………………………………………………………………………………… 311 22.2.1.
Manage Button……………………………………………………………………………………………………… 311 22.2.2. Current
(Amps) Capacity Charts ………………………………………………………………………………. 311 22.2.3. Power
………………………………………………………………………………………………………………….. 312 22.2.4.
Environment…………………………………………………………………………………………………………. 312 22.2.5. Locks
……………………………………………………………………………………………………………………. 312 22.2.6. Rack Device
Dashboard Attribute Map …………………………………………………………………….. 313
22.3. Rack Group Dashboard …………………………………………………………………………………………………. 314 22.3.1.
Capacity Chart ………………………………………………………………………………………………………. 314 22.3.2. RU
Fragmentation Chart ………………………………………………………………………………………… 314 22.3.3. 7-Day Rack
Group Power Consumption Chart …………………………………………………………… 314 22.3.4. Power By
Racks (W) Chart ………………………………………………………………………………………. 314
22.4. UPS Floor Device Dashboard …………………………………………………………………………………………. 315
22.4.1. Buttons ………………………………………………………………………………………………………………… 315 22.4.2. Input
……………………………………………………………………………………………………………………. 315 22.4.3. Output
…………………………………………………………………………………………………………………. 315 22.4.4.
Battery…………………………………………………………………………………………………………………. 315 22.4.5. Segments
……………………………………………………………………………………………………………… 316 22.4.6. Contact
………………………………………………………………………………………………………………… 316
22.5. UPS Rackmount Device Dashboard ………………………………………………………………………………… 317
22.5.1. Buttons ………………………………………………………………………………………………………………… 317 22.5.2. Input
……………………………………………………………………………………………………………………. 317 22.5.3. Output
…………………………………………………………………………………………………………………. 318 22.5.4.
Battery…………………………………………………………………………………………………………………. 318 22.5.5. Segments
……………………………………………………………………………………………………………… 318 22.5.6. Contact
………………………………………………………………………………………………………………… 319 22.5.7. UPS Rackmount Device
Dashboard Attribute Map…………………………………………………….. 320
22.6. Server Device Dashboard………………………………………………………………………………………………. 322 22.6.1.
Hardware Configuration…………………………………………………………………………………………. 322 22.6.2. Capacity
……………………………………………………………………………………………………………….. 323 22.6.3. OS & Software
Configuration ………………………………………………………………………………….. 323 22.6.4. Network
Configuration…………………………………………………………………………………………… 323 22.6.5. Resource
Consumption ………………………………………………………………………………………….. 324
13
Contents
22.6.6. Environmental ………………………………………………………………………………………………………. 324 22.6.7. Port Status ……………………………………………………………………………………………………………. 324 22.7. Switch Device Dashboard ……………………………………………………………………………………………… 325 22.7.1. Network Configuration…………………………………………………………………………………………… 325 22.7.2. Capacity ……………………………………………………………………………………………………………….. 326 22.7.3. Port Status ……………………………………………………………………………………………………………. 326 22.8. Transfer Switch Rackmount Device Dashboard………………………………………………………………… 327 22.8.1. Buttons ………………………………………………………………………………………………………………… 327 22.8.2. Active Source………………………………………………………………………………………………………… 328 22.8.3. Output …………………………………………………………………………………………………………………. 328 22.8.4. Configuration………………………………………………………………………………………………………… 328 22.8.5. Environment…………………………………………………………………………………………………………. 328 22.8.6. Contact Sensors…………………………………………………………………………………………………….. 329 22.8.7. Capacity ……………………………………………………………………………………………………………….. 329 22.8.8. Transfer Switch Rackmount Device Dashboard Attribute Map ……………………………………. 330 22.9. Access Control Device Dashboard ………………………………………………………………………………….. 331 22.9.1. Creating the Device and Configuring Monitoring ………………………………………………………. 331 22.9.2. Mounting an Access Control Device on a Rack ………………………………………………………….. 332 22.9.3. Access Control Device Dashboard……………………………………………………………………………. 333 22.9.4. TZ Gateway Lock Dashboard …………………………………………………………………………………… 334 22.10. Power Bus Bar Device Dashboard ………………………………………………………………………………… 334 22.10.1. Infeed Data…………………………………………………………………………………………………………. 335 22.10.2. Outlets ……………………………………………………………………………………………………………….. 335 22.10.3. Power Bus Bar Device Dashboard Attribute Map …………………………………………………….. 336 23. Navigation Tree ………………………………………………………………………………………………………………….. 338 23.1. Tree Nodes………………………………………………………………………………………………………………….. 339 23.2. Creating Locations (Navigation Tree Nodes) ……………………………………………………………………. 341 23.2.1. Add Cities Button ………………………………………………………………………………………………….. 342 23.2.2. Import Button……………………………………………………………………………………………………….. 342 23.2.3. Add Child Button …………………………………………………………………………………………………… 342 23.2.4. Add Sibling Button…………………………………………………………………………………………………. 343 23.2.5. Delete Button ……………………………………………………………………………………………………….. 343 23.2.6. New Building Form ………………………………………………………………………………………………… 343
14
Contents
23.2.7. New Floor Form…………………………………………………………………………………………………….. 343 23.2.8. New Area Form …………………………………………………………………………………………………….. 344 23.3. Tree Node Function Tiles ………………………………………………………………………………………………. 344 23.3.1. View Function Tile …………………………………………………………………………………………………. 344 23.3.2. Site Data Function Tile …………………………………………………………………………………………… 344 23.3.3. Capacity Function Tile ……………………………………………………………………………………………. 345 23.3.4. Graphs Function Tile ……………………………………………………………………………………………… 345 23.3.5. Attributes Function Tile………………………………………………………………………………………….. 345 23.3.6. Alarms Panel Function Tile ……………………………………………………………………………………… 345 23.3.7. Calendar Function Tile……………………………………………………………………………………………. 345 23.3.8. Racks Function Tile ………………………………………………………………………………………………… 345 23.3.9. Devices Function Tile……………………………………………………………………………………………… 345 23.3.10. Ports Function Tile……………………………………………………………………………………………….. 346 23.3.11. Network Function Tile ………………………………………………………………………………………….. 346 23.3.12. Work Order Function Tile……………………………………………………………………………………… 346 23.3.13. Connectivity Function Tile …………………………………………………………………………………….. 346 23.3.14. Links Function Tile ……………………………………………………………………………………………….. 346 23.4. Floor Node ………………………………………………………………………………………………………………….. 347 23.4.1. View Function Tile (Floor) ………………………………………………………………………………………. 347 23.4.2. Design Function Tile – Creating a Floorplan ………………………………………………………………. 350 23.4.3. Deploy Function Tile – Placing Devices on the Floorplan …………………………………………….. 357 23.4.4. Racks Function Tile ………………………………………………………………………………………………… 366 24. Creating and Configuring Traps ……………………………………………………………………………………………. 367 24.1. Create Attributes for Traps……………………………………………………………………………………………. 367 24.2. Create Trap Data Elements……………………………………………………………………………………………. 367 24.2.1. Traps Defined Manually …………………………………………………………………………………………. 367 24.2.2. Traps Imported from MIB ………………………………………………………………………………………. 369 24.2.3. Traps Imported via Excel ………………………………………………………………………………………… 369 24.3. Define Trigger for Trap …………………………………………………………………………………………………. 370 24.3.1. Define Trap Triggers Manually ………………………………………………………………………………… 370 24.3.2. Define Trap Triggers via Import ………………………………………………………………………………. 371 24.4. Define Recovery Rules for Trap ……………………………………………………………………………………… 371 24.5. Define Custom Messages for Trap………………………………………………………………………………….. 372
15
Contents
24.6. Configure Trap Forwarding……………………………………………………………………………………………. 372 24.7.
Generate Trap to 3rd Party Application……………………………………………………………………………. 373
24.7.1. Forward Alarm Trap OIDs……………………………………………………………………………………….. 373 24.8.
Trap Troubleshooting …………………………………………………………………………………………………… 374
24.8.1. Device Configurations ……………………………………………………………………………………………. 374 24.8.2.
Probe Server Configuration SNMP Version 3 Only…………………………………………………… 374
24.8.3. Get Number of Traps Coming into Server …………………………………………………………………. 376
24.8.4. Trap Events in the Device Alarm Tile………………………………………………………………………… 377
24.8.5. Traps Function Tile ………………………………………………………………………………………………… 378 24.8.6.
Monitoring Menu Group > Traps Menu Item ……………………………………………………………. 379 24.8.7.
Calendar ………………………………………………………………………………………………………………. 379
16
Contents
1. Introduction
Visual Capacity Optimization Manager (VCOM)/Visual Data Center (VDC) 6.0 marks the introduction of the new HTML5 web interface which provides an enhanced user experience for our users. The HTML5 redesign includes a streamlined and consistent interface to allow users to manage and monitor devices in a much more efficient way. As we progress with more releases of the application, we will include an increasing number of pages and features in the HTML5 interface while the version 5.x web interface is converted to this new technology.
1.1. HTML5 Web Interface
Please reference the VDC Converting from v5.x to v6.x document for a clear
explanation of which functions of the web interface are using the updated
HTML5 interface and which functions are still using the Flash interface from
prior releases of the application. The VDC Converting from v5.x to v6.x
document also instructs users on where to find the HTML5 equivalent features
to the previous Flash interface.
This guide provides instructions to users for the current version of the web
interface. As subsequent releases are provided, this guide will be updated to
include the new instructions for the HTML5 pages. The web interface can be
accessed through the Google Chrome/Microsoft Edge web browser.
The Web Administration User Guide provides detailed instructions to help you
implement and maintain the application using the web interface of the
application. A detailed review of the features and functions of the web
interface are provided in the sections below.
1.2. Application Overview
The application portal lets you access a wide array of data information from several disparate sources in one consolidated interface. The power of this aggregation is the simplicity it provides to operators to monitor and control both Facilities and IT devices in the data center environment. Since this application is vendor neutral, any device can be included in the interface and monitoring capabilities.
The application provides the following features for data center operators:
· Visual Navigation and Information to multiple floorplans · Navigation to
Main Data Center floorplans or Remote IT closets · Real-time data metrics
related to any device in the system · Historical trend analysis for metrics
defined for devices · Reporting capabilities for user, device, performance and
executive reporting requirements. · Integration to third-party software
solutions. For example, Power Strip controls, IP Camera
Systems, Card Access Security Systems, Other Vendor Support and Maintenance
portals, thirdparty Monitoring applications, and more are supported. ·
Complete Design management of navigation and floorplans. Administrators can
assign new devices to floorplans and customize the images and menu links
associated with them. · Full featured Rack Builder. This feature permits
administrators to create online graphical representations of their rack
layouts. Key information related to devices and racks can then be
17
Introduction
viewed individually or at the rack level to understand the Weight, Power and
physical characteristics of that rack. · Port mapping capabilities for both
power and network ports. · Complete Administrator command of the Access
Control Rights of users on the system. Floorplans, Devices and Reports are all
controlled by standard User and User Group access rights in the System
Administrator area of the application.
1.3. Web versus 3D Client
The application provides both a web and 3D client interface to use for
performing actions and managing devices. This User Guide defines the functions
which are contained in the web interface. For information on the client
features please consult the related Visual Data Center 3D Client User Guide.
The following is a high-level list of functions that are available in the web
interface:
· Access Rights Control Manage user rights to view, modify, create delete
certain components of the application.
· Alarms View all alarm information for locations and devices. · Calendar
View and manage calendar events for all devices and users in the system. ·
Camera Studio Allows users to configure and manage camera interfaces. ·
Device management Add and remove devices from the application. Update
attributes and
device settings. · Device placement Assign, remove and relocate devices on
floorplans. · Device Data Viewing View all data related to a device
including alarms, graphs, trend charts,
port mappings and more. · Discovery Define discovery jobs which will poll
networks and create devices based on network
discovery. · Firmware Bulk upload firmware files to supported device types
and models. · Monitoring profiles Define the data points to monitor for
devices. · Navigation Tree Build and configure the navigation tree for all
locations managed by the
application. Create floorplans to assign devices to the floor. · Network and
Power Paths Create one-line summary of the network, a power tree of a
facility,
or both. This feature allows logical and physical definitions. · Port Mapping
Define and manage port connections for power and network ports. · Project
Wizard Create work order-based device actions and assign tasks to users of
the
application. · Rack Building Place devices within racks. · Reports View
all reports related to device performance and application information. · Root
Cause | Impact Analysis Analyzes the port connections to determine impacts
and
dependencies for devices connected on the power and network paths. · Services
View and manage calendar events and warranty data for all devices in the
system. · User management Add, modify and delete all users in the
application, and reset passwords.
18
Introduction
1.4. Accessing the Web Interface
The web interface is designed with an easy-to-use framework that is consistent
throughout the application. The web interface can be accessed in one of two
ways:
· Direct Web Access You can type the URL directly into a browser and login
with your standard user/password combination. The available functions
presented to the user will be based on the user’s access rights permission
levels for the application instance.
· Access from 3D Client Interface You can click the Web Interface icon on
the main page of the 3D client interface to display a separate web browser
window with the web interface to the application. Note: Since the user is
already logged into the 3D client, the application will perform an
encapsulated logon to the web interface with the current client user
credentials
19
Introduction
2. Login
The Web interface is a web-based portal that is accessible through a standard
web browser. If you do not know the URL to access the login page for the
application login, please contact your company system administrator for this
information. Some companies allow access to the login page from remote
locations. Others restrict access to internal computing devices or allow
access through the company virtual private network (VPN).
2.1. Logging In to the Application
Follow these steps to log into the application:
1. Access the URL for the application in a supported browser. The application
must be accessed using the URL configured during installation. Attempting to
access the application with only the IP Address will be rejected with a
message that ask users to use the URL provided during installation.
2. Enter the username in the Login field. 3. Enter your password in the
Password field. 4. Choose the language to be used for labels, buttons and
other strings presented in the
application. 5. Select the Remember Me checkbox to automatically populate the
Username field when the
login page is accessed again. When the browser cache is cleared this name will
be purged and users will need to fill this field in again. 6. Select the Sign
In button or press Enter to Login.
If you successfully log into the application, the main portal interface
appears with a series of tabs for accessing the application features.
2.2. Login Issues
There are a series of issues which could prevent a successful login to the
application. This User Guide assumes that the application web server and
database are functioning properly. Detailed Technical Support related to the
actual processes and database is not covered in the scope of this document.
2.2.1. Incorrect User/Password Combination
If you submit the incorrect Username and Password combination, a pop-up window
with message “Username/password combination is not valid.” will display.
Click OK to return to the login screen and try to enter the Username and
Password combination again. Please note that repeated login failures will
result in a locked account which needs to be unlocked by an administrator. The
number of allowed failed attempts can be configured in the application.
20
Login
2.2.2. Account Already Logged on System
Logins are restricted to a single concurrent logon session for each user
account. If another computer has already logged on to the portal with a user
and password combination, you are asked if you want that user to log out.
· Clicking the Yes button continues the login process on the current device
and displays the application portal interface. The remote who user already
logged in with that account will have their session terminated. In addition,
no other functions are allowed against the database by that other user.
· Clicking the No button returns you to the Login prompt and lets you try to
log in with a different set of login credentials.
Note: The same username can be logged into the 3D client, web interface and
mobile device at the same time without forcing session terminations on those
devices.
2.2.3. License Quota Overage
When logging into the web interface the application checks the system usage
and compares the usage to the license quotas purchased by the customer. If
there is an excessive number of licenses consumed, then the access to the web
interface will be restricted to the admin account only. This user will be
granted access to the web interface to purge excessive quota items or purchase
additional licenses to apply to the server. Once the quota check complies,
then standard login functionality is restored for all users.
2.2.4. Grace Period for Licenses
In some cases, users will receive a warning message related to the quota usage
in the application. There is a Grace Period which allows users a period of
time to address quota overages prior to the system shutdown. The message
clearly indicates the amount of time remaining to address license issued
before the system is locked to administrators only.
2.3. Logging Out of the Application
To log out of the session, select the Logout menu item on the Personal menu
and confirm the message to log out of the application. This will return the
user to the Login page of the web interface.
2.4. Session Timeouts
The maximum inactive login session duration is managed with a configuration setting defined on the server. Please reference the Administration Guide for instructions on how to access and update this
setting using the vdctools command. When the maximum inactive session time has been reached then
21
Login
the user will be prompted to supply the password to continue with a function.
The session and page functions will be maintained, and the selected function
will be executed.
Note: If the web interface has an active window opened on the browser page,
then the sessions will not timeout. This feature is designed to assist with
NOC users who will open and view dashboards for long periods of time with no
other application access.
22
Login
3. Page Layout Overview
The application page layout is designed to optimize usability and efficiency
for completing common tasks and accessing information related to locations and
devices. Please use this section of the documentation to review the details of
the main page components to help improve your ability to navigate the features
and information in the application.
Please note that the user’s working session is maintained in a single browser
tab. New browser tabs are not automatically spawned to support the access of
new information. Instead, users can easily navigate back through page history
using tools provided in the application.
3.1. Components
The following components are arranged on the application interface. These
components are consistently available to users throughout the working session
to allow easy access to key functions and data.
1. Navigation Panel used to access Feature Menus, Navigation Tree, Devices
Navigator, or Favorites List defined by users.
2. Banner Alarm Indicators, User Menu, Search Widget and Help Widget are
available in the Banner.
3. Content Area displays the content associated with the Navigation Panel
selection.
3.2. Navigation Panel
The Navigation Panel is the key component for users to access pages with features and data maintained in the application. Several functions are available to assist users in easily finding key content in the application.
23
Page Layout Overview
3.2.1. Application Logo
- The application logo serves as a toggle button to fully hide or show the Navigation Menu. This action will provide full screen capability for the main data content and tables when needed by the user.
3.2.2. Feature Menus
- Feature Menus is the default view presented to the user when logged into the application. This contains the core set of menu groups and items which are accessed by users to manage the application. Each of the Menu Groups and Menu Items is defined in detail in this User Guide.
3.2.2.1. Menu Groups
Common functions and pages are grouped together in the Feature Menus’ navigation panel to facilitate access and use by the users. In some cases, the Group name serves as the only page for that group and will launch the content when selected by the user. The following Menu Groups are available in the application.
Note: Details of Main Menu Items and the functions of each page are defined in this User Guide in other sections.
Main Menu Group
Description
Home Data Analysis Alarms Calendar Rights Access
Groups Devices
Default view of the application interface which shows the World Map and location navigation tree for accessing floorplan views with devices. Access to defined graphs, trend charts and report features. Opens the alarm panel for a detailed view of alarm conditions of devices managed in the application. Full audit history of devices and users managed in the application. All actions and changes to the application can be viewed in this tool. Access to features needed to control rights access to locations and devices managed in the application. This feature manages all User provisioning activity for the application. Defines Device Groups and Rack Groups in the application. These are used for rights access and reporting purposes in other parts of the application. Central set of menu items to manage devices in the application including Firmware uploads to the devices.
24
Page Layout Overview
Maintenance Virtual Devices Racks
Connections Discovery Monitoring Workflow Integrations Import | Export
Settings
View and manage calendar events, service and warranty data for all devices in the system. Set of dashboards to manage virtual devices including VMware VCenter, VMware Hosts, VMware Guests, Configuration Groups and Action History. Allows users to manage placement of devices on Racks and to manage Audit services of IT devices mounted to the Racks using the Mobile Asset Manager application. Provides features related to port mapping and the analysis of the connected devices. Menu group to manage tools for discovering devices. Allows users to define monitoring profiles, notification triggers and escalation actions for all data to be collected from devices. Tools for creating projects with tasks and generating work orders. Allows configuration management for integrations with third-party applications or data sources. Allows user to access bulk import tools for various configuration options in the application and to view the history and audit details of these import activities. Provides a series of system level attribute and list management capabilities for the user to define configurable options available in the application.
3.2.3. Navigation Tree
- The Navigation tree is where you create and display all the sites managed
in the application. These are visible as nodes for countries, cities,
buildings, floors, areas, and devices. The navigation tree is used to browse,
manage, and modify the nodes in the tree.
Note: Details are in the Navigation Tree section of this document.
3.2.4. Devices Navigator
- The Devices Navigator provides users with an easy way to search and find
devices to access the Device Central page. This feature organizes the devices
based on the Device Type or the Lifecycle Status. The Search filter allows
users to filter the grouped list by entering a string to use for matching
against the device attributes. The search filter will execute a “contains”
search against the Device Name, Asset Tag and Serial Number fields.
If user selects the device type air conditioner, the Devices Table List will be presented with a full list of all devices which match that type. If user expands the Type list and selects a specific device, the user will be directed to the device’s Device Central page.
3.2.5. Favorites List
- The Favorites List provides a list of folders and shortcut links to pages defined by the user as Favorites. This Favorites List is defined individually for each user and there is no sharing of Favorites between users or groups in the application. There are two methods a user can perform to define a Favorite to this Favorites List:
· Mouse over the Feature Menu Item and click on the Star icon · Click the
Create Favorite menu item in the List Options menu
25
Page Layout Overview
3.2.6. Minimize Button
6) The Minimize button will toggle between expanding and collapsing the
display of the Navigation Panel between icon only and icon plus description
views. This feature will allow users to utilize more screen space for the
Content Area information and tables when needed. This feature is only
available on the Main Menu view of the Navigation Panel.
3.2.7. Main Menu Item
7) Under each of the Menu Groups is a series of menu items which provide users
access to the specific function or information for the application. When
selected, the component of the application will display the related data
tables, forms, dashboards, etc. for use by the user.
For Menu Groups which have multiple Menu Items, an expand/collapse icon is
available to the right of Menu Group name. This icon serves as a toggle button
to expand and collapse the menu group to show the underlying menu items. Only
one menu group can be expanded at a time.
3.3. Banner Functions
The Banner Widgets provide access to common features needed by the user
regardless of the pages being accessed in the Main Data view. The following
functions are available to the user in this part of the interface.
26
Page Layout Overview
3.3.1. Alarm Counters
The alarm counters provide an up-to-date count of alarm conditions reported in the application. This set of icons is interactive, so the user can click an icon to open the Alarm panel and view only the selected alarm types. The icons in this Header Function represent the following alarm conditions:
· Red Critical · Yellow Warning · Blue Unreachable · Purple – Minor ·
Lite Blue – Information · Aqua – Exceptions
Data collection, thresholds and other alarm related rules are all managed in
the Monitoring Main Menu Group of the Feature Menus. The alarm counts are only
related to devices and locations for which the user has access as defined in
the User Rights section of the Navigation Tree.
3.3.2. Personal Menu
The Personal Menu allows users to customize their application experience with a series of options designed to tailor the behavior and views of the application based on user preferences. In addition, this menu allows users to Logout of their current session for the application.
3.3.2.1. Personal Settings
Selecting the Personal Settings menu option presents the following options for users to manage the application:
Personal Settings Item Auto Align Number of Generic Entries per Page Unit
Location Path Display Format
Port Mapping Default Search Option Rack Capacity Error Message Navigation Tree
Group Device Basic Information Default Selected Tile on Location Details Page
Default Selected Tile on Rack Details Page
Description When set to ON users can place Racks on the floorplan and they
will auto align with a nearby Rack. Controls the number of items to present in
a list for each page. By default, this value is set to 10 for new users.
Allows the user to control the units listed for attributes and values in the
application. Option available are Metric and US (Imperial). Allows the user to
select location path display format. Short path – Area, Floor, Building. Full
Path – Area, Floor, Building, City, State, Country. Default is Short Path.
Allows the user to set the default search option for port mapping. Default is
Ports in Same Rack. When set to On users will be notified about space, power
and port capacity issues for racks when rackmount devices are placed into rack
locations. Allows the user to set the default Group By option of the
navigation tree. Options are World, Country, State, City, Campus, Building.
Allows the user to select Collapse or Expand for device basic information
display. Allow the user to set the default display tile on location details
page.
Allow the user to set the default display on the device details page.
27
Page Layout Overview
Floor View Default Layer
Allow the user to set the default display layer on the floor view page.
Following changes, users must logout and then log back into the application
for these updated setting to take effect.
3.3.2.2. Notification Settings
The Notification Settings feature allows users to manage the times they will
receive alarm notifications from the application to either their SMTP (Email)
or SMS (Phone) addresses. This feature is useful for preventing overnight
notifications from being sent to resources that work during the days.
By default, if there are no Notification Settings defined, the user will receive ALL notifications destined for their user account or user group. The following options are available for users as they define a new Notification Settings Profile:
Notification Setting Option Status Method
Send To Days Time Range Severity
Description When set to ON the notification setting is enabled and notifications destined for this user will need to match the options defined in the notification profile. Defines if this rule will deliver notifications to the user SMTP (Email) or SMS (Phone) information. The Email and Phone settings are managed on the Users page in the Rights Access Main Menu Group. Allows the user to define the Email address or Phone Number to use for delivery of the SMTP or SMS message. Defines which days the notification rule will allow the selected messages to be delivered to the user. Defines the time range on the selected days to allow the messages to be routed to the user. Allows the user to manage the delivery of notification messages based on Severity. A detailed review of the alarm levels is in the Alarms section of this document.
28
Page Layout Overview
Event
Allows user to control whether Event based Actions will deliver emails when initiated by Calendar events which match the rule.
3.3.2.3. Password Reset
The Password Reset feature is the primary option for users to change their
password for accessing the application. Users must enter their Current
Password and New Password to make the change. Note: The following rules are
required for passwords created by users:
· Minimum 8 characters · At least 1 Upper Case letter · At least 1 Lower Case
letter · At least 1 Number · The new password shall not contain the user’s
username. The check is not case-sensitive. · The new password shall not repeat
with the previous five password.
When the Confirm Password is being entered, the application will check to
ensure it matches the New Password. The Change Password button will not be
enabled until the New Password and Confirm Password fields are populated with
compliant passwords and match.
3.3.3. Search
The Search function supports users to easily find Attributes, Devices and
Cables which are defined in the application. Users can enter text in the
search field at the top of the page and click the search icon to conduct the
search operation. The system performs a “contains” search against defined
objects in the application. Search looks in the following attributes: Device
name, Asset Tag, Serial Number, and IP Address.
By default, all the Search categories are enabled. Users can deselect the blue checkboxes at the top of the page to limit the search against a specific list of objects. Once run, the matching search results will
29
Page Layout Overview
be listed below the search criteria, and they will be grouped based on the
type of object. Click the + icon next to the object group to expand the list
and view the results in the standard item list table.
The search results table behaves like all tables displaying the number or rows
set for the number of generic entries per page. The pagination tool on the
lower right is used to navigate through all the results. Further filtering of
the list can then be performed using the column filter fields at the top of
each column to find specific items in the list which are not currently
displayed.
3.3.4. Help
The Help icon serves as a toggle to show/hide the contents of the Help menu. In the Help menu, there are multiple categories of support topics available for the user to access:
Help Topic File Download
Documentation and Videos Support Portal
About the Application
Description 3D installation client files and Model Request Spreadsheet are
available for users to download here. Links to an online repository with the
documentation set and videos.
Link to the support portal so users can log into the portal to access more
detailed Knowledgebase topics or manage support tickets. A window with the
server’s software version and licensing information.
Eaton Privacy Policy Certificate Signing Request
Links to the Eaton Data Protection and Privacy Notice. Generate and download the CSR certificate. This certificate can be used for MQTT monitoring and configuration upload.
30
Page Layout Overview
3.4. Content Area
The content area displays the data, dashboards, tables, forms, etc. as users
choose pages from the menu items and feature icons available in the Navigation
menu and Header Functions. This content area has been designed to help ease
the user experience for navigating the different features of the application.
Some key notes related to the content page are below:
· All pages are displayed in this content component of the application. There
are no newly spawned pages or tabs of the browser which could make navigation
difficult to track.
· Standard tables and forms are used where possible, so users have a
consistent user experience as they access different features. A description of
the key aspects of these tables and forms is provided in the section below.
· A Back button is available to easily allow users to return to the previous
pages which have been recently accessed.
3.4.1. Standard Table Features
Many of the pages and features of application result in a list of items
presented to the user. These lists will be displayed in a common table format
with consistent and repeatable behavior. The usability of these features is
very important to master and simplify the management of data in these tables
on the various pages of the application. The following table provides an
overview of the features which are built into these table views:
Table Feature 1 – Back Button 2 – Table Menu 3 – Functional Buttons
4 – Filter Options
5 – Select All Checkbox
Description Allows the user to return to recent pages viewed. Easy access for users to manage the table. Options available on this menu are defined in Section 3.4.1.1. Table Menu of this user guide. Buttons related to the content provided on the page will typically be located on the top, right of the page. Specific buttons and features will be defined in the sections related to each feature. Allows users to define complex filters to limit the records displayed in the table. These filters can be saved and easily accessed in the Table Menu. This feature is defined in Section 3.4.1.2. Filter Options of this user guide. Allows users to easily select all records in the table for bulk processing with a functional button on the page.
31
Page Layout Overview
6 – Sort Order
7 – Column Filter Fields
8 – Links to Objects 9 – Pagination 10 Select and Arrange Table Columns
Click the column heading to sort by that field. Clicking the column heading a
second time will reverse the sort order of that column. An icon next to the
column name will indicate which field is used for Sort Order and which
direction is currently being viewed. Allows for easy filtering of the records
in the table. Strings entered in the column filter fields are used to run a
“contains” search for the values in the field. Only records which match the
search will be presented. Multiple column filters can be used in combination
to filter the table list. Some values in the table result will be represented
with a hyperlink to the object. Click the hyperlink to jump to the object page
to view more detail, troubleshoot, etc. the object of interest. Standard
pagination tools are provided on all tables. Note: The number of entries per
page can be set in the Personal Settings menu for each user.
Some tables have a gear icon indicating that the columns shown in the table
can be selected and rearranged. This feature is defined in Section 3.4.3.
Select and Arrange Table Columns of this user guide. Note: Not all tables have
these features.
3.4.1.1. Table Menu
The Table Menu options may differ on some tables based on content or allowed functions, but the following list defines the standard menu items contained in this common feature on the tables.
Table Menu Item Filter Export
Refresh List
Create Favorite
Description Displays a list of saved Filter views. Allows users to export the table to a supported export file type. If the table records are filtered, the exported records will match the filtered view. This action will force a full refresh of the table. If filters are applied to the table, they will remain after the Refresh List action is performed. Adds the current page to the Favorites list. User will be prompted for the Favorite name and folder. If filters are applied to the table view, they will be included in the Favorite.
3.4.1.2. Filter Options
The filter option located above the tables allows users to define simple or
complex filter rules to limit the records presented in the table. These
filters can then be saved and reused easily on subsequent views of the table.
As filters are defined and applied to the table, a breadcrumb is created from
All records and then progresses based on the filter criteria applied in the
filters. Users can click any level of the breadcrumb to easily return to a
previous view of the table.
32
Page Layout Overview
3.4.1.2.1. Creating a Simple Filter Clicking the filter icon reveals the fields and actions available to the user to define a new filter.
1. The first field will contain a list of columns presented in the table.
Users can select one of the columns and define a filter for that column.
2. The second field provides a list of operators to apply to the selected
column. Examples of these operators are equals, contains, starts with, etc.
3. The third field allows users to enter the criteria to match based on the
operator defined in the second field.
4. Click the Run button to execute the filter rule against the records in the
table. The breadcrumb will display the filter rule applied to the table.
3.4.1.2.2. Creating a Compound Filter
If users would like to apply multiple column filter criteria with multiple
levels of OR logic, they can use the following steps.
33
Page Layout Overview
· Follow the steps in the section above to define a simple filter rule. ·
Click the AND|OR options at the end of the first criteria row to show another
row. · Define filter criteria for the next column. · Choose additional AND|OR
columns to assign to the filter rule. · Click the Run button to execute the
filter rule against the records in the table. The breadcrumb
will display the filter rule applied to the table.
3.4.1.2.3. Sorting Filtered Tables
When the filter icon is selected, a row is presented to the user to define the
sort order of the records. Users can choose the column of the table to sort
and the sort direction (Ascending or Descending) to sort the records.
To include additional sort criteria, users can select the Add Sort button at
the top of the filter tool. This action will provide an additional sort option
for the user to define. Several sort criteria options can be defined as needed
to provide primary, secondary, and other sort orders to the records presented
in the table.
Note: The first sort criteria defined, which is on the top of the sort
criteria options if multiple options are defined, is the primary sort order.
The second sort criteria defined is the secondary sort order, etc.
3.4.1.2.4. Saving Filter Rules
For common filter options that users will need to run repeatedly on table
data, the filter rules can be saved so they can be easily generated on
subsequent views of the table. Once the various filter options are fully
defined, users can select the Save button at the top of the filter tool to
define the filter shortcut. This shortcut will be saved to the Filter menu
located in the Table Menu at the top of the page.
Note: The filter is only saved for the table being viewed. Other tables will
have different fields and data and will maintain their own set of filter
shortcuts in the Table Menu.
3.4.2. Search String Formats
Format String
Description Contains the string anywhere in the field, case insensitive
34
Page Layout Overview
- !String String String String*String =String !=String
Wildcard Does not contain the string Starts with string Ends with string Begins and ends with string but unknown text in middle Equals exactly Does not equal
3.4.3. Select and Arrange Table Columns
Some tables have a settings icon found at the bottom left of the table.
Selecting this icon opens a list of columns which can be selected and re-
ordered for the table. In the Select Table Columns window, the table on the
left lists the columns available to be added to the current table. The list of
columns on right are the ones defined for the current table. The following
actions can be taken with this list of columns:
· Add columns to the table Select the checkbox next to the column in the
list on the left and click Submit.
· Remove columns from the table Click the Trash icon next to the column name
on the list on the right.
· Change Order of columns on table Click the Up | DOWN arrow icons next to
the column name in the list on the right to set the order of columns on the
current table.
Note: A horizontal scroll bar will be added if too many fields are selected to
fit on the page.
Select Table Columns Feature 1 Available Columns 2 Selected Columns 3
Move Column Arrows
4 Alias
Description The table on the left lists the available columns for the current table. Note: The column filter fields operate the same as they do in a regular table. Displays the list of selected columns for the current table in the order they will appear. Click on the up and down arrows to move a column in relation to the other columns in the table. The top entry will be on the left followed by the other columns to the right. Displays the column’s alias if it has.
35
Page Layout Overview
5 Link To
6 – Sort Order 7 Trash Icon 8 Submit Button
The column can link to other pages in the application. The user can select the page to link to from the drop-down menu. Selects the sort order for the column. Clicking on the trash icon removes the column from the current table. Saves the column order information and updates the current table.
3.5. Table Item Detail Page
When users are presented with a Table List there are typically hyperlinks to
view the details of one or more items in the list. By clicking the links,
users can view the Table Item Detail page for the object. The detail pages can
be comprised of different types of data, but the standard components of the
Table Item Detail page are defined below.
Table Item Detail Feature 1 – Back Button 2 – Table Menu 3 Functional
Buttons
4 Form Data 5 Table List Tabs
6 Table List 7 – Column Filter Row
Description Allows the user to return to recent pages viewed. Easy access for users to manage the table. Options available on this menu are defined in this section of the user guide. Buttons related to the content provided on the page will typically be located on the top, right of the page. Specific buttons and features will be defined in the sections related to each feature. The top portion of this page typically has attributes which can be defined for the selected object. The lower portion of this page may have various Table Lists available for the user to view. If multiple table lists are available, then there will be a series of table list tabs to allow the user to change table list views. List of items related to the Table List Tab. The first row of each table list lets you enter a name to filter the column. You can enter names in multiple columns to refine the list results.
36
Page Layout Overview
4. Home Menu Group Page
The Home Menu Group displays the home page that contains a summary of key activity in the application related to the logged-in user. The following information is available for users in the Home view.
4.1. Location
Users can set a default location which filters the information listed in the data tables on this Home page based on the chosen location. By default, the location is World. Users can choose a different location with the dropdown menu. Click the Set as Default button to set the personal settings for this feature to use the selected location on each subsequent login session.
4.2. Graphs
Items listed in the Graphs table are those related to the location specified
at the top of the page.
Users can set one of the graphs from the table list as a default graph. Next
time when users enter the Home page, they can see the details of the default
graph directly.
To set a graph as a default graph:
1. Click the “Play” button under the Actions column/Select a graph from the
dropdown list. 2. Click the “Set As Default” button.
4.3. My Workflow Items
Items listed in the My Workflow Items table are related to the Workflow activities. Tasks, Work Orders and Authorizations assigned to the user appears in this list for easy review.
4.4. My Audits
Audits which are created by the user in the Audit Manager feature are listed in the My Audits table. Users can easily track the status of their Audits and jump to the Audits page by clicking the icon next to the table name.
4.5. PUE
The PUE trend chart shows the PUE value for the select Location at the top of the Home page. The default trend duration is for the current day. Users can choose the calendar icon and select other predefined or custom intervals to view the historical PUE values of the selected location.
4.6. 10 Most Recent Reports
A listing of the reports which were run by the logged-in user appears in this section of the Home page. The table provides a link to the Reports page by clicking the icon next to the table title. Each report is also a hyperlink to quickly re-generate the report output to PDF format.
37
Home Menu Group Page
Note: If the report is run from the Home page reports sections, the contents
of the report are filtered based on the original filters run on the actual
reports page.
4.7. 10 Most Frequent Alarms Within the Last 24 Hours
This section displays the Alarm Triggers which have had the highest count of
alarm conditions in the most recent 24-hour interval. The list of alarms is
filtered based on the Location which is defined at the top of the Home page.
The icon next to the table title will take the user to the Alarm page to
investigate all Triggers and Alarms in the application.
4.8. 10 Most Recent Events
The Most Recent Events table displays the 10 most recent events from the
Calendar tool of the application. The icon next to the table title takes the
user to the Calendar page to view the full set of historical events tracked in
the application.
38
Home Menu Group Page
5. Data Analysis Menu Group
The Data Analysis Menu Group allows users to access features that analyze the
objects and data created in the application. The items available to users in
this group permit the visual analysis in the forms of graphs, trend charts,
etc. as well as the generation and delivery of standard reports.
5.1. BI Dashboard Menu Item
The Business Intelligence (BI) Dashboard Menu consists of various dashboards
and visualization charts that demonstrate the data center’s current asset
status. The powerful BI tools utilize the existing data imported by users to
generate live charts that enable users to observe and realize the real-time
status, development trends, and potential risks of assets visually and
efficiently in the data center and help users to make better decisions. All
charts and dashboards can be customized by users.
5.1.1. My Dashboards
There are several pre-defined dashboards under the My Dashboards tab,
including Asset, Cable, Network Port, Panel, Power Port, Rack, and Space.
Charts under these dashboards are also preset, but users can always edit them
by clicking the pencil icon on the top-right corner.
1. Displays the name of the current dashboard, its status, and a button to favorite or unfavorite
the dashboard.
2. Pre-defined dashboards
3. The button to edit and manage the current dashboard’s charts and components. Users can add,
delete, and move charts in the dashboard.
4. The button that to maximize the page.
5. The button to reach more functions includes:
a. Refresh dashboard: Manually refresh the current dashboard.
39
Data Analysis Menu Group
b. Save as: Save as a new dashboard or overwrite the current dashboard. c. Set
auto-refresh interval: Set an auto-refresh interval for the current dashboard.
The
refresh frequency options are Don’t refresh/10 seconds/30 seconds/1 minute/5
minutes/30 minutes/1 hour. d. Download as image: Download the current
dashboard as a .jpg file. e. Remove in my dashboard: Remove the current
dashboard from the My Dashboards tab. 6. The Settings – Alerts & reports
button allows users to receive alarm notifications and email reports on
schedule.
Schedule alarm notifications For example: I’d like to receive an email
notification once the PUE value is larger than 2. Go to the “Alerts” tab.
Select the button “+ ALERT”.
1. Enter the basic information such as alert name, owners and the description
if needed. 2. Alert condition
a. Select a database b. Enter the SQL Query as the alarm trigger condition.
Note: the SQL query can only
return an integer. c. Select an operation. d. Set a value that works with the operation to evaluate the value returned by SQL. 3. Alert condition schedule
a. Select a time schedule. Options are Minute, Hour, Day, Week, Month, Year.
In the above example, if the alarm is not solved, you will receive the
notification every hour.
b. Select a time zone.
4. Schedule settings a. Enter the number of days that the alert will be stored in the log. b. Enter the number of seconds that the alert job is allowed to run before it results in
an automatic timeout.
40
Data Analysis Menu Group
c. Enter the number of seconds that should pass before the alert can trigger
relative to when a pervious alert was triggered.
5. Message content a. Select the dashboard or chart you’d like to receive
with the notification.
6. Notification method a. Click “+ Add notification method”. Select a
delivery method. b. Enter the email address.
Schedule a report
Go to the “Reports” tab. Select the button “+ REPORT”.
In the Report tab, users can set to send a dashboard or a chart on schedule
without the triggering condition. The configuration details are the same as
above.
7. The button to reach more functions includes: a. Force refresh: Refresh the current chart. b. Enter full screen: Maximize the current chart.
5.1.1.1. Cable
Chart Cable Category
Cable Type
Cables
Filter Color Source Port Type Destination Port Type
Description A pie chart displays the number and proportion of different cables. Options are Network Cable and Power Cable. A bar chart displays the number of cables of each cable type. The x-axis represents the cable types, such as Generic Power Cable, Cat 5e, Cat 6, etc. The y-axis represents the cable count. A table displays all cables’ information, including Category, Type, Source Device, Source Port, Source Port Type, Destination Device, Destination Port, and Destination Port Type. Description Filter cables based on the cable color. Filter cables based on their source port type. Filter cables based on their destination port type.
41
Data Analysis Menu Group
5.1.1.2. Device
Chart Lifecycle
Device Group
Count by Device Type
Server Racks Total Device Server – Enclosure PDU – Rackmount UPS – Rackmount
Filter Building Floor Area
Description A pie chart displays the number and proportion of devices’ at each lifecycle stage. Options are Operational, Available, and Reserved Procurement. A bar chart displays the number of devices within each device group. The x-axis represents the device group, which are Public and Private. The y-axis represents the device count. A bar chart displays the number of devices of each device type. The x-axis represents the device type, such as UPS, AC, PDU, etc. The y-axis represents the device count. Displays the total count of servers. Displays the total count of racks. Displays the total count of devices. Displays the total count of the enclosure server. Displays the total count of the rackmount PDU. Displays the total count of the rackmount UPS. Description Filter devices in a particular building from all data center locations. Filter devices on a particular floor from all data center locations. Filter devices in a particular area from all data center locations.
5.1.1.3. Network Port
Chart Switch Network Ports
Patch Panel Network Ports
Copper Network Ports
Fiber Ports
Total Switch Ports Total Switch Ports Usage Total Patch Panel Ports Filter
Building Floor Area
Description A stacked bar chart displays the number and proportion of used and available switch network ports. A pie chart displays the number and proportion of used and available patch panel network ports. A bar chart displays the number and proportion of used and available switch and patch panel network ports that are made by copper. A bar chart displays the number and proportion of used and available switch and patch panel network ports that are made by fiber. Displays the total count of the switch ports. Displays the percentage of the switch ports that have already been used. Displays the total count of the patch panel ports. Description Filter network ports in a particular building from all data center locations. Filter network ports on a particular floor from all data center locations. Filter network ports in a particular area from all data center locations.
5.1.1.4. Panel
Chart Power Consumed (kWh) Power Consumed by Time Total Cost Power Consumed
(kWh) Filter Building Floor
Description
A bar chart displays the power consume of each department.
A bar chart displays the daily power consume.
Displays the total accumulated cost of power.
Displays the total accumulated power.
Description
Filter power panels in a particular building from all data center locations.
Filter power panels in a particular floor from all data center locations.
42
Data Analysis Menu Group
Company Department
Filter power panels based on companies. Filter power panels based on departments of companies.
5.1.1.5. Power Port
Chart Power Port Usage
Breakers by Company &Dept
Circuits by Company & Dept
Total RPDU Power Ports Used RPDU Power Ports Total RUPS Power Ports Used RUPS
Power Ports Breakers Created Circuits Created Filter Building Floor Area
Description A bar chart displays the number and proportion of used and available power port of three types of devices, including PDU Rackmount, Transfer Switch Rackmount, and UPS Rackmount. A bar chart displays the number of breakers of each company and its associated department. A bar chart displays the number and proportion of used and available circuits of each company and its associated department. Displays the total count of RPDU power ports. Displays the count of used RPDU power ports. Displays the total count of RUPS power ports. Displays the count of used RUPS power ports. Displays the total count of breakers. Displays the total count of circuits. Description Filter power ports in a particular building from all data center locations. Filter power ports on a particular floor from all data center locations. Filter power ports in a particular area from all data center locations.
5.1.1.6. Rack
Chart Rack Front U Usage
Rack Rear U Usage
Weight Usage
Front U Total Rear U Total Power Usage
Filter Building Floor
Description A bar chart displays the number and proportion of used, remain, and reserved front units of each rack group. A bar chart displays the number and proportion of used, remain, and reserved rear units of each rack group. A bar chart displays the number and proportion of used, remain, and reserved weight of each rack group. Displays the total count of front units for all rack groups. Displays the total count of rear units for all rack groups. A pie chart displays the number and proportion of available and used racks’ power usage. Description Filter racks in a particular building from all data center locations. Filter racks on a particular floor from all data center locations.
5.1.1.7. Site Data
Chart Current PUE
Historical PUE
Description
Displays the latest PUE value of the day. The value is refreshed every 15
mins. Note: This value might be different with the value in the Site Data
Function Tile Location Navigation Tree due to the data from the Navigation
Tree is refreshed every 5 mins. A line chart displays the PUE value for each
past day.
43
Data Analysis Menu Group
Power Capacity U Space Utilization
Cooling Utilization
Rack Count by Rack Category Rack Count by Rack Group Raised Floor Space
Utilization
Filter City Building Floor Area
Three-line charts display the actual power, derated power and power utilization per day. Five time series columns display the U Space Used, U Space Reserved, U Space Remaining, U Space Total, and U Space Utilization per day. Three-line charts display the cooling capacity, cooling required, and cooling utilization per day. Displays the count of each rack category of selected location. Displays the count of each rack group of selected location An area chart displays the Provisioned Floor Space, Sellable Floor Space, and Common Floor Space per day. Description Filter the data in a particular city from all data center locations. Filter the data in a particular building from all data center locations. Filter the data on a particular floor from all data center locations. Filter the data in a particular area from all data center locations.
5.1.1.8. Space
Chart Space Usage by Floor & Area
Power Usage
Weight Usage Total Area (m2) Raised Area (m2) Solid Area (m2) Common Area (m2)
Sellable Area (m2) Provisioned Area (m2) Filter Building Floor Area
Description A bar chart displays the area and proportion of used, remain, and reserved space of each data center floor and area. A pie chart displays the number and proportion of used and available space’s power usage. A pie chart displays the number and proportion of used and available space’s weight. Displays the number of total areas. Displays the number of raised areas. Displays the number of solid areas. Displays the number of common areas. Displays the number of sellable areas. Displays the number of provisioned areas. Description Filter space data in a particular building from all data center locations. Filter space data on a particular floor from all data center locations. Filter space data in a particular area from all data center locations.
5.1.1.9. Power Quality (ITIC) Report
This system dashboard is not displayed in “My Dashboards” tab by default. Users can find it in the “Dashboards” tab and select the “Add to my dashboard” in button to add this dashboard to the “My Dashboards” tab.
Chart ITIC Event Count by Month Top 10 Devices with Most ITIC Events ITIC Event Details Filter Time Range Device ITIC Event ITIC Event Category
Description Displays the number of ITIC events occur each month. Displays the top 10 devices with the most ITIC events.
Displays the event details in table.
Description
Filter the ITIC events occurred in a certain time range.
Filter the ITIC events occurred on a particular device.
Filter the ITIC events occurred on a particular ITIC event.
Filter the ITIC events occurred on a particular ITIC event category.
44
Data Analysis Menu Group
Severity Level Channel
Filter the ITIC events occurred on a particular severity level. Filter the ITIC events occurred on a particular channel.
5.1.2. Dashboards
The dashboard tab displays both system’s pre-defined and user-created
dashboards. Users can create new dashboards and manage existing dashboards in
this tab.
The table list contains the following fields:
Table List Column Name Status Created by Modified by Last modified Owners Actions
Description Displays the name of the dashboard. Displays the status of the dashboard. Displays the person who creates the dashboard. Displays the last person who modified the dashboard. Displays the period that the dashboard has been modified. Displays the dashboard owner. Displays three options delete, export, and edit. The icons are only visible when the mouse hovers on.
5.1.2.1. Create New Dashboards
Click the Dashboard button on the top right corner to create a new dashboard
design panel.
45
Data Analysis Menu Group
1. Enter the dashboard name. 2. Component configuration panel: Drag components into the display area to design a dashboard.
3. Charts panel: Drag charts into the dashboard to complete the design. The Charts panel lists both system’s pre-defined and user-created charts.
46
Data Analysis Menu Group
4. Users can undo and redo the previous actions and clear the dashboard if
needed. 5. Click the Save button once finishing the design. 6. Click the
button to publish the dashboard if needed. 7. Click the button to favorite the
dashboard if needed. 8. Click the button to maximize the page if needed. 9.
Click the more button if needed. The button includes:
a. Save as: Save as a new dashboard or overwrite the current dashboard. b.
Refresh dashboard: Manually refresh the current dashboard. c. Set auto-refresh
interval: Set an auto-refresh interval for the current dashboard. The
refresh frequency options are Don’t refresh/10 seconds/30 seconds/1 minute/5
minutes/30 minutes/1 hour. d. Set filter mapping: Configure filter scopes –
which charts are applied or not. e. Edit dashboard properties: Edit the
dashboard properties such as dashboard title, access right, and color scheme.
f. Add to my dashboard: Add the current dashboard to the My Dashboards tab.
5.1.2.2. Delete Dashboards
1. Hover the mouse on the action column of the chart you want to delete. Click the rubbish bin
icon to delete the dashboard.
2. Enter DELETE in the text field to confirm the deleting action.
47
Data Analysis Menu Group
3. Click the delete button to delete the dashboard. Click the Bulk select
button to delete multiple dashboards at once.
5.1.2.3. Export Dashboards
Click the Export button in the action column, and a JSON file is automatically
downloaded.
5.1.2.4. Edit Dashboards
The Edit button in the action column gives users a quick way to edit dashboard
properties such as dashboard title, access right, and color scheme.
To edit the dashboard details, such as layout, charts, etc., users need to
click the dashboard name to enter the configuration panel to make changes.
5.1.2.5. Filter & Search
There are four filters available: Owner, Created by, Status, and Favorite.
Users can type the keyword in the search text field as well.
5.1.3. Charts
Charts tab displays all created charts. Users can create new charts and manage
existing charts in this tab.
48
Data Analysis Menu Group
The table list contains the following fields:
Table List Column Name Visualization Dataset Created by Modified by Last modified Actions
Description Displays the name of the chart. Displays the visualization type of the chart. Displays the dataset used to create the chart. Displays the person who creates the chart. Displays the last person who modified the chart. Displays the period that the chart has been modified. Displays two options delete or edit. The icons are only visible when the mouse hovers on.
5.1.3.1. Create New Charts
Click the Chart button on the top right corner to create a new chart design
panel. The design panel consists of three areas. The detailed configuration
instructions are listed below.
49
Data Analysis Menu Group
5.1.3.1.1. Dataset 1. Click the ··· button to choose the correct dataset that
contains the data you need for the chart. The associated metrics and columns
of the dataset are displayed accordingly. Note: Ignore the warning message and
click Proceed.
5.1.3.1.2. Data
2. Choose the chart type. Options are Filter Box, Table, Big Number, Pie
Chart, Bar Chart, and Gauge Chart.
3. Filter the time range of data if needed. The filter is applied to the time
attribute column in the dataset. It is possible that TIME COLUMN is empty if
there are no time attributes in the dataset.
50
Data Analysis Menu Group
4. Define metrics to apply aggregate functions on the dataset. a. SAVED: metrics pre-defined in the system. Available to see after selecting the dataset. b. SIMPLE: i. COLUMN: choose the column that you want to aggregate data. All columns from the dataset that can be applied to an aggregate function are available. ii. AGGREGATE: apply the aggregate function to that column. Available options are AVG, COUNT, COUNT_DISTINCT, MAX, MIN, SUM. c. CUSTOM SQL: write user-defined SQL functions if you can’t find a proper aggregate function from the SIMPLE configuration panel.
5. Apply filters to the chart by columns or by metrics.
a. SIMPLE:
i. Choose the column you want to filter.
ii. Select one of the operations you would like to apply. Options are equals, not
equal to, >, <, >=, <=, IN, NOT IN, LIKE, IS NOT NULL, IS NULL.
iii. Enter the filter value. It can be either numeric or non-numeric value.
b. CUSTOM SQL: write user-defined SQL functions if you can’t set a filter from the SIMPLE
section.
51
Data Analysis Menu Group
6. Click the dropdown list to choose one or many columns to apply the group
by function. 7. Break down series by a segmented column.
Note: The Series column must contain the Breakdown column. 8. Limit the rows
of data that are used to display. Options are 10, 50, 100, 250, 500, 1000,
5000,
10000, 50000. 9. Apply sort functions to the chart. The configuration panels
are the same as in step 4. 10. The system sorts the value ascending by
default. Click the checkbox to sort value descending. 11. The y-axis legend
changes to percentage format. Note: While the clicking button blocks the pop-
up selection window, users can toggle the zoom-out icon to enlarge the window
size.
5.1.3.1.3. Customize The CUSTOMIZE panel allows users to customize the charts’
appearance.
1. Click the dropdown list to change the chart color. 2. Select/unselect the checkbox to enable or disable the chart legend. 3. Select the checkbox to show the bar value on the chart. Vise versa.
52
Data Analysis Menu Group
4. Select the checkbox to change the bar chart style to the stacked bar. 5.
Select the checkbox to sort the bar chart by the x-axis. 6. Click the dropdown
list to select the format of the y-axis. 7. Enter the y-axis label in the text
field. 8. Select the checkbox to enable the extra control. Extra control works
on the multi-bar chart and
gives options to manage the chart format as a stacked bar chart or side-by-
side bar chart. 9. Select the checkbox to display the minimum and maximum
boundary of the y-axis value. 10. Set the y-axis boundary manually. 11. Enter
the x-axis label in the text field. 12. Click the dropdown list to choose the
bottom margin. Options are auto, 50 ,75, 100, 125, 150,
200. The larger the number, the more space in the bottom. 13. Click the
dropdown list to choose the x-axis tick layout. Options are auto, flat, 45o,
staggered. 14. Select the checkbox to reduce the x-axis tick.
5.1.3.1.4. Chart & Data
1. Click the Run query button or the Run button on the top right corner to
apply the configuration setting and observe the chart changes. Some
configuration steps take run effect automatically, and users do not need to
click the Run button manually.
2. Name the chart by clicking the edit icon. 3. Click the Save button to save
the chart once finished. 4. The data used to generate the chart is listed in
the Data area. Users can copy these data by
clicking the Clipboard button.
53
Data Analysis Menu Group
5.1.3.2. Delete Charts
1. Hover the mouse on the action column of the chart you want to delete.
Click the rubbish bin icon to delete the chart.
2. Enter DELETE in the text field to confirm the deleting action. 3. Click
the delete button to delete the chart. Click the Bulk select button to delete
multiple charts at once.
5.1.3.3. Edit Charts
The Edit button in the action column gives users a quick way to edit chart
properties such as chart name, description, cache timeout, and access right.
To edit the chart details such as type, aggregate functions, etc., users need
to click the chart name to enter the configuration panel to make changes.
5.1.3.4. Filter & Search
There are five filters available, which are Owner, Created by, Viz type,
Dataset, and Favorite. Users can type the keyword in the search text field as
well.
54
Data Analysis Menu Group
5.2. Graphs Menu Item
The Graphs option allows users to assemble data in the application into
dashboards using a variety of available components. These Graphs can then be
associated with Monitoring Templates to apply them to multiple devices. For
previously defined Graphs, users can view the data as it relates to devices in
the application and make edits to the Graph definitions.
5.2.1. Graph Table List
The initial view presented when the Graphs menu item is selected is a list of
defined Graphs.
The table list contains the following fields:
Table List Column Actions Name
Type Monitoring Template Components Last Updated By Last Updated Table List
Button New Delete
Description Runs the Graph to show actual data as configured with the components. Name of the Graph. Selecting this link will open the definition of the Graph and allow user to make edits. Shows the type of Graph defined. Options are Template or Specific Devices. Lists the Monitoring Template associated with the Graph. Number of Graph components defined in the view. Last user to update and save the Graph. Time the Graph was last updated and saved. Description Create a New Graph to be viewed by users. Deletes the selected Graphs from the list.
55
Data Analysis Menu Group
5.2.2. Create Graphs
Select the New button at the top of the Graph Table List page to create a New
Graph configuration form. The following screen is presented to the user with
the functions defined below. The top of the page contains fields for standard
form data to define attributes of the Graph and the bottom of the page
represents the Graph canvas where components can be placed, aligned, and
defined to create the Graph view.
5.2.2.1. New Graph Properties
When defining a new Graph, there are properties defined with the Graph which
manage where and how a user may access the Graph for viewing live data related
to devices managed in the application.
1. Name: Name of the Graph. This is visible at the device level so users can
launch the Graph to view real time data.
2. Type: User can choose from two options to manage availability of the Graph
· Template Graph is associated with a Monitoring Template. Monitoring
Templates are applied to devices defined in the Monitoring Template.
Components of the Template option are only associated to an Attribute and not
to a specific device. · Specific Devices Each component of the Graph will
specify the Device and Attribute of the device. These Graphs will be
associated with devices that have components included in the Graph. There is
no association of a Specific Device Graph with a Monitoring Template.
3. Monitoring Type: If Type is set to Template, then this property is used to
associate the Graph to an existing Monitoring Template.
4. Description: Description of the graph.
5.2.2.2. Add Components
After filling the mandatory fields, users can click the Add Component button
to create a new component on the Graph.
56
Data Analysis Menu Group
5.2.2.2.1. Add a Template Component
When adding a component for a Template: 1. users need to choose from the list
of Attributes defined on the Monitoring Template. Multiple Attributes can be
selected from this list to add multiple attributes to the Graph in one step.
Note: Selecting a Table attribute will only enable the Table component option.
2. Click Next to choose the component type.
3. Choose the component type of the attributes you choose. The available
component types are described in Section 3.2.2.3. Component Type. If users
select multiple attributes at once in the previous page, all the selected
attributes will be applied on the same component type.
4. Enter the title of this graph. If users left this field empty, the
attribute name will be used as the title.
57
Data Analysis Menu Group
Note: If users enter the title in this field and select multiple attributes in
the previous page, this title will be applied to all attribute graphs. 5.
Users can preview the graph of the selected attribute in the Data field on the
right. 6. The buttons on the bottom right perform the following tasks:
a. Previous Go back to the previous Select Attribute page. b. Submit
Submit the graph. c. Cancel Cancel this operation.
A device link/location link is displayed under the graph’s name which allows
users to easily jump to the device/location detailed page.
5.2.2.2.2. Add a Specific Devices Component When adding a component for a specific device:
58
Data Analysis Menu Group
1. Select the checkboxes Select Devices or Select Locations. 2. Select the devices from the device list or locations from the location list. 3. Click Next to select attributes.
4. Select the attributes of the device or the attributes of the location. 5. Click Next to select the desired type of component.
6. Choose the component type of the attributes you choose. The available
component types are described in Section 3.2.2.3. Component Type. If users
select multiple attributes at once in the previous page, all the selected
attributes will be applied on the same component type.
7. Enter the title of this graph. If users left this field empty, the
attribute name will be used as the title. Note: If users enter the title in
this field and select multiple attributes in the previous page, this title
will be applied to all attribute graphs.
59
Data Analysis Menu Group
8. Users can preview the graph of the selected attribute in the Data field on
the right. 9. The buttons on the bottom right perform the following tasks:
a. Previous Go back to the previous Select Attribute page. b. Submit
Submit the graph. c. Cancel Cancel this operation.
5.2.2.3. Component Type
The Graph is comprised of one or more graphical components to display data
related to a device. Graphs are accessed from the Device Central page for a
selected device, so the data displayed in the Graph is related to the device
from which the Graph is generated. If the Graph is based on specific devices,
then the components will show the data related to the defined device and
attribute combination.
The following components are available for users to add to a Graph.
5.2.2.3.1. Circular Gauge
The Circular Gauge provides a value for a single attribute of data related to
a device. The attribute must be numeric to be properly used with this
component.
Property Name Title Minimum | Maximum
Description String to be displayed on the top left of the component when viewed in a Graph. The smallest and largest values to be displayed on the gauge.
60
Data Analysis Menu Group
5.2.2.3.2. Trend Chart
The Trend Chart displays historical time series data of one or more attributes
of data related to the device. The attribute must be numeric to be properly
used with this component.
Property Name Title Default
Description String to be displayed on the top, left of the component when viewed in a Graph. Default time interval to be displayed with the trend chart when viewed on a Graph. Users may change this interval by clicking the calendar icon on the trend chart component.
5.2.2.3.3. Table
The Table component allows users to present table data which is commonly
reported with SNMP Table and Table Column OID attributes. This option is only
enabled when Tabular Column data attributes are selected.
61
Data Analysis Menu Group
Property Name Title Display Setting
Description String to be displayed on the top, left of the component when viewed in a Graph. Selecting the checkbox to display the diagram in small size. This option will change the height of the Table component.
5.2.2.3.4. Number Gauge
The Number Gauge will display the device name, attribute, value and unit for
the device and attribute associated to the component. The only property
managed with this component is the Label which will appear on the top, left of
the component when viewed in a Graph.
5.2.2.3.5. Percentage Gauge
The Percentage Gauge will show the value of the attribute compared to a
minimum and maximum range defined with the graph component. A bar indicator
will show the percentage of the actual value of the attribute with the defined
minimum and maximum values.
62
Data Analysis Menu Group
Property Name Label Default
Description String to be displayed on the top, left of the component when viewed in a Graph. Default time interval to be displayed with the trend chart when viewed on a Graph. Users may change this interval by clicking the calendar icon on the trend chart component.
5.2.2.4. Add Alarm Component
Click the Add Alarm Component button to create a new alarm component on the
Graph. Then the following configuration page will show.
1. Select the checkboxes Select Devices or Select Locations. 2. Select th