HPE Trueview. Administration and Configuration Guide Release 8.1 First Edition

Transcription

1 HPE Trueview Administration and Configuration Guide Release 8.1 First Edition

2 Notices Legal notice Copyright 2016 Hewlett Packard Enterprise Development LP Confidential computer software. Valid license from HPE required for possession, use or copying. Consistent with FAR and , Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice. The only warranties for HPE products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HPE shall not be liable for technical or editorial errors or omissions contained herein. Printed in the US Trademarks Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Oracle and Java are registered trademarks of Oracle and/or its affiliates.

3 Contents 2 Contents Notices... 1 Preface About this guide Document history Chapter 1 Product Description Overview Trueview implementation Inventory Discovery & Reconciliation Trueview Security Object Model Chapter 2 Trueview Basics Logging in Logging out License information Version User preferences Password tab Language tab Navigating Trueview Trueview modules / menus / submenus Opened items Trueview screen Icons and their functions in the find object panel Action buttons and their functions in the find object panel Icons and their functions in the objects detail / configuration screen Working in Trueview screens Creating an object Opening an object Deleting an object Modifying an Object Save query & load query Exporting objects Export option Chapter 3 System Jobs Viewing requests in the job queue Job s detail / configuration screen Job details section Job parameters section Job participating items section Messages section Staging Viewing Upload Data Upload Data details / configuration screen Upload Data details section... 66

4 Contents Payload section Creating Upload Data Logs Audit Operation Chapter 4 Administration Security Users Importing User Account Creating User Account Reset User Account User Groups Creating a User Group Domains Creating a Domain Manage objects in a Domain Privileges Schedules Viewing Schedules Creating a Schedule Schedule details Details Schedule screen tabs and sections Reconciliation Modes Action Icon options Running a Schedule manually Locking / modifying a Schedule Unlocking a Schedule Project Templates Creating a Project Template Project Template tabs Description tab Tasks tab Job Aid tab Interface Color configuration Enumerations Creating an Enumeration Adding Items to an Enumeration Provisioning Enumerations CMDB NE types Configuring Adapters for Pre-defined NE types Creating User Defined NE types NE Type Capabilities Configuring Ports / Interfaces Configuring Communication Details NE configuration NE Icons tab

5 Contents Communication tab Rules Number management Number Pool Telephone number Configuring Telephone Number parameters CoS (Class of Service) Create a CoS CoS Parameters Capacity Link Capacity management NFV Capacity management Bandwidth profile Creating a Bandwidth Profile Import Notifications configuration Events configuration System Parameters tab Directories tab Event Handlers tab User Interface tab Authentication tab Scheduling tab Reconciliation tab Languages tab Loading a Language Pack with the LangImp Tool Configuring Default and Supported Languages Syslog tab Parameters for Syslog Server Parameters for Processing Syslog Message Document Management tab Failed Synching with Solr Arbor connector Workbench Reports Creating a Report Definition Packages Creating a Package Installing a Package Copying a Package Importing a Package Exporting a Package Updating a Package Customization Packages Viewing Package Details/Configuration Installing Additional Packages from the Package Workbench Uninstalling a Package

6 Contents Exporting an Installed Package Appendix A Exporting files Appendix B Glossary

7 List of tables 6 List of tables Table 1: Document history Table 2. NE Upload & Reconciliation modes Table 3. Trueview object Reconciliation Status Table 4. Icons and their functions in the Find Object panel Table 5. Action buttons and their functions in the Find Object panel Table 6. Icons and their functions in the Object detail / configuration screen Table 7. Fields used to define and filter Jobs in the Find Jobs screen Table 8. Jobs status conditions / options Table 9. Job Participating Item section fields Table 10. Message details Table 11. Fields used to define and filter Upload Data in the Find Upload Data screen Table 12. Upload Data details section fields Table 13. Fields available in the Find Users screen Table 14. Domain Fields and their Purpose Table 15. Privileges Available for Trueview Objects Table 16. Fields used to Define and Filter Schedules in the Find Schedules Screen Table 17. Schedule details Table 18. Schedule Tasks and Related Operations Table 19. Scheduling and Frequency Details in the Calendar Tab Table 20. List of Participating Items Displayed as per the Selected Task Table 21. Tasks that required to be configured with the Parameters and their Values Table 22. Details Displayed in the Jobs Tab Table 23. Modes and their Behavior for NE Upload and Reconciliation Operations Table 24. Action icon commands Table 25. Colors Available for the Objects/Attributes Table 26. Default Colors for Attributes under General Tab

8 List of tables 7 Table 27. Default Colors for Attributes under Alarms Tab Table 28. Default Colors for Attributes under Circuits Tab Table 29. Enumeration Fields Table 30. List of Default System Enumerations and their Descriptions Table 31. Adapter Types and Categories Table 32. NE Types Screen Buttons and their Functions Table 33. Communication Configuration Attributes Table 34. NE Icons Attributes Table 35. Communication Pool settings Table 36. Telephone Number Management Configuration Details Table 37. Ethernet Link Capacity Attributes Table 38. Bandwidth Profile Details Table 39. Configuration Server Details Table 40. Event Categories Table 41. Parameter Tab Configuration Settings Table 42. LangImp command-line switches Table 43. Parameters for Syslog Server Table 44. Document Management Tab Fields Table 45. Report Build-in Definitions Table 46. Report Definition Fields Table 47. Buttons and their Functions Available in the Report Template Tab Table 48. Criteria Tab Fields Table 49. Buttons and their Functions Available in the Reports Tab Table 50. Reports Tab Fields Table 51. Bean Fields Subtab Fields Table 52. Entity Fields Subtab Fields Table 53. Customization Package Fields

9 List of figures 8 List of figures Figure 1. Trueview components Figure 2. Components and operations in Discovery & Reconciliation Figure 3. Trueview Security Object Model Figure 4. Trueview login screen Figure 5. Error message for invalid login credentials Figure 6. Trueview logout link Figure 7. License information menu option Figure 8. Trueview license information Figure 9. Viewing Version information Figure 10. Trueview version Figure 11. User preferences Figure 12. User configuration screen - Password tab Figure 13. Password changed confirmation message Figure 14. User configuration screen - Languages tab Figure 15. Trueview module / menu / submenu Figure 16. Dashboard module Figure 17. DCM module Figure 18. Project module Figure 19. Services module Figure 20. Documents module Figure 21. Views module Figure 22. Reports module Figure 23. CMDB module Figure 24. System module Figure 25. Admin module Figure 26. Opened items... 36

10 List of figures 9 Figure 27. Find Object screen Figure 28. Searching with wildcards Figure 29. Opening a new selection window Figure 30. New Selection window - Object selected in the New Selection window Figure 31. Object selected using Select icon Figure 32. Object cleared using Clear icon Figure 33. Creating an object Figure 34. Selecting an Object in the Select type screen Figure 35. Object's detail / configuration screen Figure 36. Selecting Object through Open button Figure 37. Clicking and Opening an Object Figure 38. Deleting an Object Figure 39. Confirmation message for deleting an Object Figure 40. Object's detail / configuration screen - Selecting an Object to modify Figure 41. Modifying an Object Figure 42. Creating a query Figure 43. Save query screen Figure 44. Loading the query Figure 45. Load saved query screen Figure 46. Search query is loaded Figure 47. Export / objects Figure 48. Export screen Figure 49. Object details exported in an Excel format Figure 50. Exporting objects in a File type format Figure 51. Object details exported in a File type format Figure 52. File type format file opened in an Excel file format Figure 53. ing the object details Figure 54. Select screen... 53

11 List of figures 10 Figure 55. Recipients selected Figure 56. Jobs Figure 57. Find jobs screen Figure 58. Selecting a Job to view its details Figure 59. Job details section Figure 60. Job parameters section Figure 61. Job participating items section Figure 62. Item's detail / configuration screen Figure 63. Show All Messages Figure 64. Message filtered and displayed using wildcard search Figure 65. How NE Upload & Reconciliation operations interact in a clustered, multi-server Trueview environment Figure 66. Staging Figure 67. Find Upload Data screen Figure 68. Selecting a Staging File to view its details Figure 69. Staging File's detail / configuration screen Figure 70. Upload Data section Figure 71. Payload section Figure 72. Find Upload Data screen Figure 73. Audit logs Figure 74. Operation logs Figure 75. Admin module Figure 76. Security module Figure 77. Find Users screen Figure 78. Find Users screen Figure 79. Select Customer for the New Users screen Figure 80. Associating newly imported users with the customer Figure 81. Application displaying the message for successfully importing the selected users Figure 82. Application displaying the message for importing existing users... 75

12 List of figures 11 Figure 83. Authentication tab Figure 84. Find Users screen Figure 85. User's detail / configuration screen Figure 86. Find Users screen - Selecting a user Figure 87. User's detail / configuration screen Figure 88. Assigning a Managed User to a User Group Figure 89. Managed User is assigned to a User Group Figure 90. Domains tab Figure 91. Existing User Password details Figure 92. Resetting User Password Figure 93. Password Reset confirmation message Figure 94. Reset Password screen - Force User to Change Password Figure 95. Password changed successfully Figure 96. User Logging into the Application with the new password Figure 97. User Configuration screen - User prompted to change password details Figure 98. Password changed successfully Figure 99. Find Users Groups screen Figure 100. User's detail / configuration screen Figure 101. Find User Groups screen - Selecting User Group(s) Figure 102. User Group's details / configuration screen Figure 103. Assigning a User Group to a User Figure 104. User Group Assigned to a User Figure 105. Find User Groups screen - Selecting a User Group Figure 106. User Group's detail / configuration screen Figure 107. Find User Groups Screen Selecting a User Group Figure 108. User Groups Detail/Configuration Screen Figure 109. Assigning a User Group to a Domain Figure 110. User Group Assigned to the Domain... 91

13 List of figures 12 Figure 111. Find Users Groups Screen Figure 112. Domain's Detail/Configuration Screen Figure 113. Domain is Created and Added to the List Figure 114. Objects Added to the Parent Domain Figure 115. Adding Network Elements to a Domain Figure 116. Object Selection Screen Parent Domain Objects are displayed for Selection Figure 117. Objects Added to the Domain Figure 118. Privileges Available in Trueview Figure 119. Schedules Figure 120. Find Schedules screen Figure 121. Find Schedules Screen Figure 122. New Schedule Screen Figure 123. Details Section Figure 124. Calendar tab Figure 125. Frequency - One time Figure 126. Frequency - Daily Figure 127. Scheduler Events for Daily Frequency and Interval Figure 128. Frequency - Weekly Figure 129. Scheduler Events for Weekly Frequency and Interval Figure 130. Frequency - Monthly Figure 131. Scheduler Events for Month Frequency and Interval End of Month Check Box Cleared Figure 132. Scheduler Events for Month Frequency and Interval End of Month Check Box is selected Figure 133. Time Frames Figure 134. Time Frame Screen Figure 135. Time Frame Added to the List Figure 136. Participating Items Tab Figure 137. Participating Items Adding Screen Figure 138. Participating Items Added to the List

14 List of figures 13 Figure 139. Participating Items Tab Figure 140. Participating Items Adding Screen Figure 141. New Query Created Figure 142. Configuration Tab Figure 143. Editing a Parameter- Using Select Button Figure 144. Parameter is edited Figure 145. Editing a Parameter- Using OK Button Figure 146. Parameter is edited Figure 147. Resetting a Parameter Figure 148. Parameter Value is reset to default Value Figure 149. Parent Schedule Figure 150. Dependent Schedule with a Parent Schedule Figure 151. Parent Schedule and Dependent Schedule are Successfully Executed Figure 152. Dependent Schedules displayed once the Parent Schedule Task is executed Figure 153. Notification Tab Figure 154. Select Users Screen is Displayed when Users is selected from the Recipient List Figure 155. Recipient is Selected and Added to the List Figure 156. Jobs Tab Displaying Results of the Executed Tasks Figure 157. Action Icon Figure 158. Scheduler events Figure 159. Running a Schedule Manually Figure 160. Schedule is Unlocked and Executed Figure 161. Schedule Status Displayed in Jobs Screen Figure 162. Find Schedule Screen Figure 163. Schedule in Unlocked Fields are Disabled from Modifying the Schedule Figure 164. Locking a Schedule to modify it Figure 165. Schedule is Unlocked Figure 166. Schedule in Locked Fields are Enabled for Modifying the Schedule

15 List of figures 14 Figure 167. Find Schedules Screen Figure 168. Unlocking a Schedule Figure 169. Schedule is Unlocked Figure 170. Task Status of the Schedule in the Job s Detail/Configuration Screen Figure 171. Messages Generated for the Scheduled Job in the Job s Detail/Configuration Screen Figure 172. Find Project Templates Screen Figure 173. Select Project Type Screen Figure 174. Error Displayed for Selecting a used Project Type Figure 175. Project Template Created Figure 176. Description Tab Figure 177. Tasks Tab Figure 178. Add Task Screen Figure 179. Project Task is Created and Added to the Project Template Figure 180. Updating Tasks Figure 181. Update Task Screen Figure 182. Re-Ordering the Task Figure 183. Task is Re-Ordered Figure 184. Job Aid tab Figure 185. Color Changed for an Attribute Figure 186. Defined Color Configuration for Circuits Figure 187. Color Configurations Displayed for Circuit Attributes Figure 188. Find Enumerations Screen Figure 189. Creating Enumeration Figure 190. Find Enumerations Screen Figure 191. Enumeration s Detail/Configuration Screen Figure 192. Add/Modify Enumeration Item Screen Figure 193. Item Added to Enumeration Figure 194. Default System Texts Available in Provisioning Enumerations

16 List of figures 15 Figure 195. System Texts are displayed in the Provisioning Status List Figure 196. Defining a Custom Text Figure 197. Edit Provisioning Status Enumeration Screen - Defining a Custom Text Figure 198. Custom Text is created Figure 199. Custom Text is displayed in the Provisioning Status List Figure 200. NE Types Screen - Installing an NE Type through an Adapter Figure 201. Select File Screen - Selecting NE Type Adapters Figure 202. Success Message for Installing Adapters Figure 203. Configured Adapters for Pre-Defined NE Type Figure 204. Configuring Adapters for Pre-Defined NE Types Figure 205. Installing Adapters from Adapters Tab Figure 206. Select File Screen Selecting Adapters to be added to the NE Type Figure 207. Adapters Added to the NE Type Figure 208. Creating a NE Type without an Adapter Figure 209. NE Type Screen Figure 210. Communication Tab Appears after Saving the NE Type Figure 211. Configuring Ports for Layer1 NE Types Figure 212. Defining Port Details Figure 213. Configuring Interfaces for Layer2/Layer3 NE Types Figure 214. Defining Interface Details Figure 215. NE Type Created with Layer1/Layer2/Layer2 Capability Figure 216. Port is created with Ethernet Signal Support Figure 217. Network Element is created for the NE Type Figure 218. NE Type Defined Ports are Created and Displayed under the Unequipped Ports Tab Figure 219. : NE Type Defined Interfaces are Created and Displayed under the Interfaces Tab Figure 220. Configuring NE Type Communication Attributes Figure 221. NE Configuration Screen NE Icons Tab Figure 222. Upload Icon Screen - Uploading a SVG Icon

17 List of figures 16 Figure 223. SVG Icon Uploaded into Trueview Figure 224. Removing a Used NE Icon Figure 225. NE Icons Tab - Assigning an Icon to a NE Type Figure 226. Add Assignment Screen Assigning an Icon to a NE Type Figure 227. Icon Assigned to the NE Type Figure 228. NE Icons Tab Updating a NE Icon Figure 229. Upload Icon Screen - Updating a NE Icon Figure 230. NE Icon Updated Figure 231. Communication Tab Figure 232. Facilities/Circuits Rules Figure 233. Links Rules Figure 234. Network Rules Figure 235. Number Management Configuration for Number Pools Figure 236. Telephone Number Management Configuration Figure 237. Find Classes of Service Screen Figure 238. CoS Parameters Figure 239. Applicable Service Types Figure 240. Select Service Type Screen Figure 241. CoS Assigned to the Service Type Figure 242. Class of Service Attributes Figure 243. Select Attribute Name Screen Figure 244. CoS Assigned to Additional Attribute Figure 245. Bandwidth Profile Templates Figure 246. Select Bandwidth Profile Screen Figure 247. CoS Assigned to Bandwidth Profile Figure 248. Link Capacity Management Configuration Defaults Figure 249. Capacity CoS Objects Displayed under Capacity Management Tab for L2 Ethernet Link Figure 250. Find Bandwidth Profiles Screen

18 List of figures 17 Figure 251. Bandwidth Profile Template Screen Figure 252. Bandwidth Profile Name Auto Generated Figure 253. Sample Entity File for Customer Type Import Entity Figure 254. Import Entity Screen Figure 255. Import Entity Request Creation Message Figure 256. Job Queue Creation for the Import Entity Figure 257. Job Details for Import Entity Job Parameters Figure 258. Job Details for Import Entity Job Participating Items and Messages Figure 259. Successfully Imported Entities Displaying in the Pertaining Screen Figure 260. Notifications Figure Server Configuration Screen Figure Server Configuration Section Figure Configuration Server Created Figure 264. Events Configuration Screen Figure 265. Events Configuration Details Screen Figure 266. Events section Figure 267. Select Users Screen - Selecting the Users to Configure with the Events Figure 268. Users/Contacts/Groups Configured to the Events Figure 269. System Configuration Grouped Under Various Tabs Figure 270. Directories Tab Figure 271. Event Handlers Tab Figure 272. Changing the Browser Title Figure 273. Browser Title Changed Figure 274. Trueview Looking for Custom Styles Figure 275. Trueview Looking for Advanced Custom Styles Figure 276. Authentication Tab Opening a Server Figure 277. Server Details Figure 278. Scheduling Tab

19 List of figures 18 Figure 279. Reconciliation Tab Figure 280. Languages Tab in the User Configuration Submenu Figure 281. Entering the Languages in Trueview Figure 282. Language Pack Spreadsheets Figure 283. Language Pack Spreadsheets Figure 284. Settings Default Language to Blank Figure 285. Syslog Tab Figure 286. Create Syslog Pattern Screen Figure 287. Syslog Pattern Created Figure 288. Document Management Tab - Solr Configuration Figure 289. Testing Solr Connectivity Figure 290. Arbor Connector Figure 291. Workbench Figure 292. Available Report Definitions for use in Trueview Figure 293. Find Reports Screen Figure 294. Report Definition s Detail/Configuration Screen Figure 295. Upload Report Template Screen Figure 296. Report Template Tab - Jaspersoft ireport Template Uploaded in the Application Figure 297. Criteria Tab Figure 298. Reports Tab Figure 299. Report's Detail/Configuration Screen Figure 300. New Report Created and Added to the List Figure 301. Reports Tab Opening a Report Figure 302. Report s Details Screen Creating a Query Figure 303. Select Links for Report Screen Figure 304. Add/Modify Query Screen Figure 305. Selecting the Query Figure 306. Select Links for Report Screen - Testing the Query

20 List of figures 19 Figure 307. Data Source Tab Figure 308. Field Definition Figure 309. Package Workbench Screen Figure 310. Package Definition Detail/Configuration Screen Figure 311. Customization Packages Detail/Configuration Screen Figure 312. Custom Metadata Screen Figure 313. New Metadata Added to the List Figure 314. Privileges Tab Figure 315. Custom Privilege Screen Figure 316. New Privilege Created and Added to the List Figure 317. Privileges Tab Figure 318. Custom Workflow Screen Figure 319. New Workflow Created and Added to the List Figure 320. Scripts Tab Figure 321. Custom Script Screen Figure 322. New Script Created and Added to the List Figure 323. Installing a Package from Package Workbench Screen Figure 324. Installing a Package through Action Menu Figure 325. Copying a Package Figure 326. Select Package to Copy Screen Selecting a Package to Copy Figure 327. Package is Copied and Displayed for Modification Figure 328. Newly Copied Package in Added in the List Figure 329. Importing a Package Figure 330. Import Customization JAR File Screen Figure 331. Import Packages Screen Figure 332. Renaming a Package and Importing Figure 333. Exporting a Package from Package Workbench Screen Figure 334. Exporting a Package through Action Menu

21 List of figures 20 Figure 335. Customization - Packages Figure 336. Installed Packages Screen Figure 337. Package s Detail/Configuration Screen Figure 4-264: Install Packages Screen Figure 339. Select Packages to Install Screen Installing Additional Packages Figure 340. Installing a Package from Package Workbench Screen Figure 341. Uninstalling a Package through Action Menu Figure 342. Exporting a Package from Package Workbench Screen Figure 343. Exporting a Package through Action Menu Figure 347. Internet Explorer menu bar Figure 348. Internet Explorer Security tab Figure 349. IE Security settings

22 Preface 21 Preface About this guide The purpose of this guide is to provide application administrators with an understanding of the various parameters used in Trueview. The main modules described in this guide include the Administration, Security, and Configuration modules. For more information about other modules available in Trueview, please refer to the Trueview User Guide. Document history Table 1: Document history Edition Date Description /04/2017 First official version.

23 Product Description 22 Chapter 1 Product Description 1.1 Overview For telecommunications service providers, HPE Trueview is a comprehensive software solution that provides access, provisioning, service-fulfillment and service-assurance capabilities. The modular nature of the application permits its utilization in all aspects of the network, from core to access environments. Trueview maps customers to their services and network devices, thereby enabling proactive customer engagement and improved customer service. By design, network- and service-facing resources are separated, allowing flexibility in dealing with new services, network devices, and technologies. This approach provides quick business transformation wins with minimal customization or data migration, resulting in low total cost of ownership. Provisioning of multiple vendor products and network technologies is supported with minimal training investment. Automated and predictable flow-through provisioning of services from planning to implementation is delivered in one solution. HPE Trueview is architected as an open-standards-based, extensible and scalable three-tier software platform. Depending on your license agreement, you may not be able to access all the modules and features described in this manual, but modules can be added on later as needed if licensing requirements change. Please contact TRUEVIEW Product Support for more information. The following figure illustrates Trueview components. Figure 1. Trueview components.

24 Product Description 23 A full installation of HPE Trueview comprises the following modules, and allows you to perform the following activities. Dashboard Provides an overview of the reconciliation status of Network Elements and Links stored in the Trueview database. DCM (Device Configuration Management) Device Configuration & OS Backup operations. Device Configuration & OS Restore operations. Importing Device Configuration & OS operations. Projects Manages the Projects and Tasks related to your Service Order Management/Customer Service. Manages the Projects that is taking place within the Service Provider. Allows you plan, assign and complete the Tasks to track the Service Request workflow at any point of time in Trueview. Manage a collection of Trueview Inventory objects that are involved in a specific activity or process. Apply actions to Inventory objects associated with a Project. Services Allows managing Customer Facing Services provided to the customers. Define Physical Site Locations and reference them to Customers. Documents Allows to upload/download/modify/compare documents. Views Facilitate grouping of Links, Network Elements, Networks, Multipoint Services or any combination of these elements for organizational purposes. Views may be created as Public or Private to control access by other users. Edit mode allows participating elements and/or queries to be set up for Views. Read-only screen displays the contents of a selected View. Views can be nested within other Views. Trace equipment based on their Physical Connections. Reports Generating Reports using Report Definitions provided with Trueview. CMDB Define Customer entities with multiple Locations and Services. Define Service Provider entities. Define and configure Network Elements based on Adapters. Manage Virtual Network Elements, Virtual Machines and Servers. Support for Multiple Cards in the same Slot of a Network Element. Configure connectivity to external Element Managers in the live network. Support for TMUX functionality. Define Physical Connections. Define Circuits, Facilities, Networks, and Services using Network Elements defined in Resource Management. Allow Circuits to share channels the system ensures that only one Circuit can be active on a given channel at any particular point in time. Define multiple design versions for Circuits and Services. Configure Circuits with Dual Homed Network Segments. Configure Ethernet Services over Ethernet Networks and MPLS Networks. Configure VRF, route targets and route distinguishers for IP VPN Services. Configure protocol and routing configurations of underlying IP Links. Configure capacity management for both Layer 2 and Layer 3 Services. Define Virtual Machines and assign Resources. Number Pool definition and management for the following: IPv4 Addresses IPv6 Addresses VLAN Numbers VPLS VPN ID s VPWS VC ID s Manage Telephone Numbers using TN Pools.

25 Product Description 24 System Monitor the status of Jobs executed by the Trueview application. View and/or simulate uploaded equipment configurations in the Upload Stage. Generate or view an Audit trail of selected operations in the Audit Logs. Displays Statistical information about the Systems using Trueview. Displays Users Sessions in Trueview. Create User Defined Scripts to perform Custom Tasks. Displays the Syslog Messages received from the Devices for Trueview to process each Syslog Message and compare it with a list of predefined patterns. If the message matches one of the patterns, it is processed. Otherwise, the message is discarded. Admin Configure and manage Users and User Groups. Assign Users to Customer-specific User Groups so that their view of the network is restricted. Create Domains to facilitate grouping of Network Elements. Define Privilege levels for accessing Trueview features. Create and modify Schedules for performing upload, provisioning, and reconciliation operations. Create Project Templates to facilitate the configuration of similar Project. Configure default and alternative Calendars for Project. Modify color configurations for alarms, VLAN paths, link availability, circuits, upload states, etc. Define custom enumerations for Trueview selection fields, such as report categories, location types, Project types, connection capacity, etc. Provisioning Enumerations for circuit provisioning status. Create User defined NE Types. Use the NE Configuration tool to install and configure Access Adapters for use with Trueview, upload and assign custom icons to represent defined Network Elements, and define connection pool settings for Network Elements. Rules for Service in Trueview. Specify system parameters for managing Telephone Numbers. Define Bandwidth Profiles, Classes of Service, Capacity and Provisioning Enumerations for circuit provisioning status and Rules for Service in Trueview. Support for Server Groups and Connectors. Configure system parameters, multilingual support, authentication settings, user-interface styles and more. Create and modify custom Report Definitions and custom screen Packages with the Workbench. Manage custom screen Packages using the Customization menu. Trueview supports service and design capabilities for the following technologies: Physical (L1) network and service design DWDM SONET/SDH TDM/PDH (including Fractional T1) VCAT (FICON, Ethernet, Fast Ethernet, GigE, 10 GigE) Ethernet ROADM OTN Ethernet (L2) network and service design with support for Unimplemented Ethernet Links Ethernet Links over Layer 1 Circuits Ethernet Networks Ethernet Services, e.g. ELINE (point-to-point), ELAN (multipoint-to-multipoint) VLAN and QinQ Service configurations VPLS and VPWS Service configurations over MPLS Redundancy configuration, e.g. using HSRP Traffic conditioning Link capacity management IP (L3) network and service design with support for

26 Product Description 25 IP links (configured for OSPF, IS-IS, BGP, RIP, or static protocols) L3 VPN (VRF, Route Distinguishers and Route Targets) OSPF, IS-IS and BGP Networks IP capacity management The Number Pools and TN Pools features provide management and automated assignment of numbers for IPv4 Addresses, VLAN numbers, VPLS VPN ID s, VPWS VC ID s and Telephone Numbers. Access Adapters are used for secure, centralized interaction with large-scale managed Network Elements. Provisioning Adapters handle Trueview functionality for communication with physical Network Elements in a live network. These Adapters are modules developed by HPE and are modeled on actual Network Elements. For integration capability with external applications, Trueview has a web-services interface known as ESI through which data is exchanged via XML-formatted transmissions over HTTP. Reports on devices and services configured in Trueview may be generated from predefined templates. The reports are created as HTML, Excel or Adobe PDF files which display automatically in a separate browser tab or window. NOTE: If you are using the Internet Explorer browser and are having issues viewing reports in a new browser tab or window, refer to Appendix A. Users who have acquired a license for Discovery features benefit from additional functionality which allows Trueview to upload and reconcile configuration information from the service provider s live network to the network modeled in Trueview. Since Trueview uses actual network configurations instead of legacy data to reconcile information, users can have confidence in the accuracy of the data modeled in the application. Accurate network data is essential in order for providers to make intelligent business decisions to optimize services and increase customer satisfaction. The following figure illustrates the components and operations that are used to perform Discovery & Reconciliation in Trueview.

27 Product Description 26 Figure 2. Components and operations in Discovery & Reconciliation IMPORTANT: In a clustered Trueview environment with multiple servers, a Staging component is used to store data from remote servers before it is reconciled with the main server. In a single-server environment, the Staging component is not required. NE Upload & Reconciliation operates on physical Network Elements and some logical properties of Network Elements in one of two modes: Table 2. NE Upload & Reconciliation modes Mode Description Behavior REPORT This mode adds discovered cards to slots, if applicable, but does not automatically place the cards in service. No shelves or racks are created if discovered. When a card is discovered in the network that does not match any card in the slot, the discovered card is added to the slot. Its Operational Status is set to Installed/Maintenance. Its Reconciliation Status is set to In Sync. The discovered card is added as a component to the built-in NE Reconciliation Project, with a component action of Put in service. When this component action is executed, a card swap will be performed on any nonmatching In Service cards. The Reconciliation Status of any other nonmatching cards in the slot is set to Out of Sync.

28 UPDATE This mode adds discovered cards to slots, if applicable, and automatically places the cards in service. Shelves and Racks are not created in Report mode. Product Description 27 For In Sync cards, the NE Reconciliation Project is checked to see if identical cards exist as Components; if any are found, they are removed from the Project since they no longer need to be reconciled. When a card is discovered in the network that does not match the existing card in the slot, the discovered card is added to the slot if it does not already exist. Its Operational Status is set to Installed/Maintenance. Its Reconciliation Status is set to In Sync. The discovered card is put into service through the NE Reconciliation Project. The activation is logged in the project history. If activation was successful, the card is then removed from the Project Components. If activation was not successful, the component action for the card changes to Manual Correction. The Reconciliation Status of any other nonmatching cards in the slot is set to Out of Sync. For In Sync cards, the NE Reconciliation Project is checked to see if identical cards exist as Components; if any are found, they are removed from the Project since they no longer need to be reconciled. For more information on Project, refer to the Trueview User Guide. For connectivity and services, Reconciliation also operates in one of two modes: Report This mode reports on differences between the live network and the model. Update This mode creates new connections and services in the model, updates existing connections and services in the model depending on whether there are dependencies (Circuits riding on Facilities, a service riding on another service, etc.), and reports on all actions. NOTE: Reconciliation is not performed for Physical Connection objects. For Reconciliation operations, the software uses actual network configurations, not legacy data, as the basis of all functions, thus reducing errors and costly rework. The Reconciliation Status of a Trueview object indicates whether the object in the database has been compared with the live network and whether its configuration is the same or different from the live network. The table below summarizes the different values a Trueview object can have for its Reconciliation Status: Table 3. Trueview object Reconciliation Status Label Description

29 Product Description 28 Unknown In Sync Out Of Sync The object was manually created and no Reconciliation operation has been performed against the live network. Reconciliation has been performed and the Trueview object configuration has been compared and is synchronized with the live network settings. Reconciliation has been performed and the Trueview object configuration has been compared. The settings did not match those found in the live network. When a Network Element is uploaded, the Cards installed in the Network Element will appear with a colored triangle to indicate their Reconciliation Status. Refer to the Trueview User Guide for more details. For more information on how to upload a single Network Element, refer to the Trueview User Guide. 1.2 Trueview implementation Trueview is designed for deployment on a web server such as WebLogic or JBOSS. Users can access the application via the Mozilla Firefox or Microsoft Internet Explorer web browser. This method of implementation requires minimal support since no client software installation is needed and all environment configurations are performed at the server location. Data for the Trueview application is stored in an Oracle or PostgreSQL database. For demonstration purposes, the database software and supporting applications may be installed on a single machine, provided adequate system resources are available. In a multi-user networked production environment, Oracle or PostgreSQL should be installed on a separate database server. LDAP or Microsoft Active Directory servers are typically used to centralize user account management and enhance security in large organizations. Trueview supports multiple LDAP server connections and container authentication which handles user authentication at the web-server level instead of the application level. This facilitates deployment of the application in a single sign-on environment. User Group membership and Privileges for the application are defined in the Trueview database. A complete Trueview implementation consists of several modules that interact to provide the following full-featured OSS product: Inventory The core of Trueview is the CMDB module. This module stores all Network Element and Connectivity information and provides GUI access for users to define Network Elements, Connectivity, Networks and Services. The CMDB module does not connect directly to a live network. Discovery & Reconciliation Discovery and Reconciliation performs Upload and Reconciliation operations to upload configuration data from a live Network Element or other system to Trueview and maintain the synchronization between the network and Trueview. Since Trueview uses actual network configurations instead of legacy data to reconcile information, users can have confidence in the accuracy of the data modeled in the application. Accurate network data is essential in order for providers to make intelligent business decisions to optimize services and increase customer satisfaction. Uploads may be initiated manually or may be scheduled. Three operational modes are supported: Update Report For Layer 1 equipment, Facilities or Links between equipment must be created manually. The Reconciliation Engine can then be used to create Circuits.

30 Product Description 29 Reconciliation in Layer 2 equipment automatically creates Links and Services based on information retrieved in the Upload mode. 1.3 Trueview Security Object Model Access to all Trueview objects and modules are controlled through the use of User Groups and Privileges. The following diagram illustrates Security-related Trueview objects and their relationships to each other. Figure 3. Trueview Security Object Model

31 Trueview Basics 30 Chapter 2 Trueview Basics 2.1 Logging in The Trueview Administrator assigns a Username, Password, User Group, and appropriate Privileges for users to access the system. Since the application utilizes a web client, the administrator must also provide a Uniform Resource Locator (URL) and port number to access the login screen. Trueview has been tested with Mozilla Firefox 18 and Microsoft Internet Explorer 9. To logon to Trueview: 1. Open a web browser window with the designated URL and port number to display the login screen. 2. Enter the assigned Username and Password. 3. Click Login or press Enter in your keyboard to access the system. Figure 4. Trueview login screen Trueview displays the following error messages if there is an issue with your user id/password. Figure 5. Error message for invalid login credentials If the problem persists, contact your Trueview Administrator.

32 Trueview Basics 31 A User must be assigned to a User Group and Privileges must be configured for that User Group before the User can access Trueview modules. If the User does not belong to any User Group with Privileges assigned to it, the User is not allowed to access any of the Trueview modules. If you cannot access the modules you need please contact your Trueview Administrator and have your User Group Privileges verified. 2.2 Logging out To log out of the application, click Logout in the upper-right corner of the dashboard. The application navigates to the Trueview login screen. This link can be triggered from any screen within the application. Figure 6. Trueview logout link NOTE: If you click the browser s back button, the application automatically logs out and returns to the login screen. When you log off, the data that has been entered into the application but not been saved is lost. Activation or upload functions that have been queued will continue to completion as background processes. 2.3 License information Trueview will not run without a valid license. To view your Trueview license information, click About->License in the upper-right corner of the screen. The application displays the Trueview License information. Figure 7. License information menu option Based on the license agreement, the Trueview License Information window displays the customer, license expiry date (if applicable), enabled application modules and license type. Click Close to close the window.

33 Trueview Basics 32 Figure 8. Trueview license information If you see any license error messages, please contact your Trueview Administrator to verify product installation or contact HPE Product Support. For more information on licenses, please contact HPE Product Support. 2.4 Version To view your Trueview version, click About->Version in the upper-right corner of the screen. The application displays the Trueview version information. Figure 9. Viewing Version information Figure 10. Trueview version 2.5 User preferences Click About -> User Preferences to navigate to the User Configuration screen.

34 Trueview Basics 33 Figure 11. User preferences The User Configuration screen has two tabs which allow you to configure your language settings and change your password. Password tab Trueview allows changing your Password details. To change the Password, 1. Enter the Current Password, New Password and Confirm Password. 2. Click Change Password. The Password is changed and the application displays a confirmation message. Figure 12. User configuration screen - Password tab Figure 13. Password changed confirmation message This screen mandatorily appears for Users on logon to Trueview if the Administrator has selected the Force User to Change Password check box while resetting the User s Password. The User has to reset the Password details in order to logon to Trueview. This scenario is applicable in case if the User forgets the Password, and requests the Administrator to grand permission for the User to reset the Password again. For more information about Resetting Password see Reset User Account. Language tab Trueview supports up to three languages in addition to English. For more information about Languages, see Languages tab.

35 Trueview Basics 34 Figure 14. User configuration screen - Languages tab 2.6 Navigating Trueview Trueview modules / menus / submenus Trueview application consists of modules, menus and submenus. To navigate to a screen in Trueview, click a module/menu/submenu. Figure 15. Trueview module / menu / submenu Depending on the modules installed and configured during product installation, license agreement as well as the user privileges configured by the Trueview Administrator; Trueview lists the modules/menus/submenus. Consequently, some modules/menus/submenus may not be available to all users as they appear in this Guide. If you have license to use all application modules, the following modules/menus/submenus will be available in the Trueview application.

36 Trueview Basics 35 Figure 16. Dashboard module Figure 17. DCM module Figure 18. Project module Figure 20. Documents module Figure 21. Views module Figure 19. Services module Figure 22. Reports module Figure 24. System module Figure 23. CMDB module

37 Trueview Basics 36 Figure 25. Admin module Opened items In Trueview, you can open multiple items from the various modules/menus/submenus without closing them. Trueview displays a breadcrumb sort of display of your opened items. Click the Opened Items icon at the left corner of your screen. The application displays your opened items. Click X icon to close the item. Figure 26. Opened items 2.7 Trueview screen A Trueview screen is usually divided into two panels: Find Object: The Find Object panel at the top displays a group of search filters that can be used to find an object in Trueview. Search results: The Search Results panel below displays the results of the search performed. Once an object is opened, the Find Object panel displays the Object Details and the Search Results panel displays the Object s Configuration. By clicking a module/menu/submenu, the Find Object screen pertaining to that module/menu/submenu is displayed. Search fields are provided at the top of the screen where criteria can be specified to filter the output.

38 Trueview Basics 37 Figure 27. Find Object screen Icons and their functions in the find object panel Table 4. Icons and their functions in the Find Object panel Icon Purpose Select Icon: Opens a new selection window and generates a list of available object types for the current search field. If a field has this icon next to it and if you wish to use that field as a search parameter, click the Select icon in order to search for and select a particular object to use as a filter. In the other search fields, the wildcard character * can be used to substitute for one or more characters. Clear Icon: Clears the search criteria. Search fields can be cleared or reset to their default values by clicking the Clear icon available next to the search field or by clicking the Clear button available below the search fields. NOTICE: Searches are case-sensitive.

39 Trueview Basics 38 Figure 28. Searching with wildcards Figure 29. Opening a new selection window

40 Trueview Basics 39 Figure 30. New Selection window - Object selected in the New Selection window Figure 31. Object selected using Select icon

41 Trueview Basics 40 Figure 32. Object cleared using Clear icon Action buttons and their functions in the find object panel These are the common buttons available in the find object panel in the most of the screens. Some more buttons are also available in some screens which are explained in the pertaining screens. Table 5. Action buttons and their functions in the Find Object panel Button Purpose Searches for the objects. Click the Search button without entering any search criteria to display all existing objects in the search results. Clears the screen. Creates the Object. Opens the Object. Deletes the Object. Copies and creates a similar Object. Displays default reports for the selected Object. Allows exporting/ the objects. Saves the search criteria that can be used to retrieve the search results later instead of re-entering the same search criteria again. Loads the saved search criteria to retrieve the search results.

42 Trueview Basics 41 Icons and their functions in the objects detail / configuration screen Table 6. Icons and their functions in the Object detail / configuration screen Icons Purpose Click this icon to display a list of options that can be performed in a particular screen. This icon deletes the currently open object. This icon refreshes the currently open object. If changes have been made to the object without being saved, a warning message may appear saying that changes will be lost if the object is refreshed. This icon should be used whenever changes are made to a related object in a different screen and if you wish to return to the first Object s Detail/Configuration screen. For example, when you create a Circuit terminating on two Network Elements and then makes changes to one of the Network Elements, you should refresh the open Circuit object before making further changes to the Circuit. Refreshing the browser, for example, clicking the browser Refresh button while working in Trueview IMMEDIATELY returns you to the initial Trueview screen after login. All unsaved information is discarded. To refresh the data in a Trueview screen, click the Refresh icon, as applicable. This icon saves the current settings for a particular object. This icon closes the current Object s Detail/Configuration screen. Click this icon to export the details in an excel format to your local folder. Working in Trueview screens This section explains about some common actions that you use to come across in the Trueview application in the various screens Creating an object To create an object: 1. Click Create. The application allows you to enter/select the required details.

43 Trueview Basics 42 NOTE: For some objects, once you click the Create button, the application displays a Select Type screen and you might be required to select the pertaining details. Post selecting the details, the application navigates you to the Object s detail / configuration screen. For some objects, once you click the Create button, the application directly displays the Object s detail / configuration screen where you can enter the object details. Figure 33. Creating an object

44 Trueview Basics 43 Figure 34. Selecting an Object in the Select type screen 2. Enter the object details in Object s Detail/Configuration screen. 3. Click the Save icon in the upper-right corner of the screen. Figure 35. Object's detail / configuration screen Opening an object Trueview objects can be opened in two ways: Select the object from the grid, and click Open. In some cases (for example: Network Elements, Circuits, and Services), multiple objects up to a maximum number of 10 can be selected and opened simultaneously. If more than 10 objects are selected, only the first ten objects are opened and a corresponding error message is displayed for the remainder.

45 Trueview Basics 44 Click the object in the grid. You can select and open only one object at a time. Figure 36. Selecting Object through Open button

46 Trueview Basics 45 Figure 37. Clicking and Opening an Object Deleting an object To delete an object: 1. Select the object, and click the Delete button.

47 Trueview Basics 46 Figure 38. Deleting an Object 2. The application displays a confirmation message. 3. Click Yes. Figure 39. Confirmation message for deleting an Object In some cases, you might not be able to delete an object if you do not have the appropriate privileges or if the object is being referenced by other objects in the application. In such cases, a corresponding error message will appear. NOTE: If a dependency exists between two different objects, it may not be possible to delete an object unless the dependency is removed or the other object is deleted also. For example, a Customer object cannot be deleted if it is associated with a User Group. A corresponding error message will appear if an object cannot be deleted due to a dependency Modifying an Object To modify an object, 1. Select the object, and click the Open button. The application displays the Object s Detail/Configuration screen.

48 Trueview Basics 47 Figure 40. Object's detail / configuration screen - Selecting an Object to modify 2. Do the required changes, and click the Save icon in the upper-right corner of the screen. Figure 41. Modifying an Object NOTE: To modify an existing Connection object in Trueview (such as a Circuit or Ethernet Service), the Connection object MUST be deactivated (i.e. placed out of service) before changes can be performed Save query & load query If you are going to do a similar sort of search often, you can save the criteria as a query and execute it whenever you require. To save and load the query: 1. Enter the search criteria.

49 Trueview Basics Click Save Query. The application displays the Save Query screen. Figure 42. Creating a query 3. Enter the Name, and select the Type. 4. Click Save. Figure 43. Save query screen 5. To load the query, click Load Query. The application displays the Load Saved Query screen displaying all the saved queries.

50 Trueview Basics 49 Figure 44. Loading the query 6. Select the Query, and click Load. Figure 45. Load saved query screen The application loads the search criteria which you saved as a query. Figure 46. Search query is loaded

51 Trueview Basics Exporting objects Trueview allows you to export/ the objects. The caption of the Export button varies as per the screen. The available Export button captions are Excel Export (All) / Export / Export (result) etc. The Excel Export (All) and the Export (result) options allow you to export and the objects. The Export option does not allow you to export and all the Objects, but only to export individual Scripts. To export/ the objects: 1. Apply the search criteria and list the objects. 2. Click Excel Export (All)/Export (result). The application displays the Export screen. Figure 47. Export / objects 3. Select the Export Format type. The available types are HTML, Excel and CSV.

52 Trueview Basics 51 Figure 48. Export screen 4. Click OK. The application exports the object details to your local folder. Figure 49. Object details exported in an Excel format You can also export the object details in a File type format. 1. Do not select any Export Format. 2. Click OK. The application exports the object details in a file type format to your local folder.

53 Trueview Basics 52 Figure 50. Exporting objects in a File type format Figure 51. Object details exported in a File type format You can open this file in an Excel format. Figure 52. File type format file opened in an Excel file format To the object details: 1 Select the Export Format. 2 Select the Only check box. 3 Select the Recipients.

54 Trueview Basics 53 Figure 53. ing the object details 4 Click Add. The application displays the Select screen. This screen differs based on the recipients. 5 Search and select the recipients. Figure 54. Select screen 6 Click OK. The application s the object details to the recipients.

55 Trueview Basics 54 Figure 55. Recipients selected You can also mail the object details in the file format to the recipients Export option The Export option is available only for CMDB -> Scripts. The Export option allows you to export individual scripts or all the Scripts as a zip file. Select a Script, and click Export to export the Script in the same format to your local folder that is, Groovy, Java etc.). Select multiple Scripts, and click Export to export the Scripts as a zip file to your local folder.

56 System 55 Chapter 3 System The System module allows you to perform the following activities. Monitor the status of Jobs executed by the Trueview application. View and/or simulate uploaded equipment configurations in the Upload Stage. Generate or view an Audit trail of selected operations in the Audit Logs. 3.1 Jobs The Jobs menu allows you to monitor and manage tasks initiated from the Admin -> Schedules menu or from other menus in Trueview. When multiple commands are issued to a specific Network Element, the Job engine manages access to that device to maximize the connection success rate. Task requests can be issued from different menus in Trueview. Jobs cannot be explicitly created from the Jobs screen. On receiving a task request, Trueview s Job Controller assigns a Job ID and the task is entered into a queue. Requests are processed on a first-come, first-served basis, but the application can be configured to execute a certain number of tasks simultaneously by adjusting the Job Controller settings in the Scheduling tab of the Admin -> System menu. For more information about Scheduling Tab, see Section Scheduling tab. A single Job entry can contain actions of multiple Network Elements or objects. Depending on the privilege assigned to a user s User Group, a user s view of the Jobs listed in the Find Jobs screen can be restricted to: User s Jobs only ( Job View By User privilege) User s own Jobs and those Jobs performed by users belonging to the same User Group(s) ( Job Restricted by User Groups privilege) Unrestricted view of all Jobs executed by all users ( Job Unrestricted privilege). For more information on Privileges, see Section Domains. Viewing requests in the job queue To view the requests in the job queue, 1. Click System -> Jobs. The application displays the Find Jobs screen.

57 System 56 Figure 56. Jobs 2. Enter the search criteria, and click Search. Alternatively, you can also click Search without entering any search criteria to list the available requests in the job queue. Figure 57. Find jobs screen NOTE: A Job must have a status of Success, Cancelled, Partial Failed, or Completed before it can be deleted.

58 System 57 NOTICE: A Job must have a status of Processing, Resumed, or Suspended before it can be cancelled. Once a Job has been cancelled, it cannot be reactivated. If one of the subtasks for the Job is being executed at the time the Job is cancelled, that process will run until it reaches a cancellation point which is dependent on that task s implementation. All other pending items for that Job will be cancelled. If the task was not running at this point, then it will not be executed. The following table explains about the various fields used to define and filter jobs in the Find Jobs screen. Table 7. Fields used to define and filter Jobs in the Find Jobs screen Label User Schedule Server ID Status Operation Type Submitted Date From - To Processed Date From - To Description Name of the user who initiates the Job. The name of the Schedule with which the Job is associated. Schedules are created, modified and managed in the Admin -> Schedules menu. The Server ID in which the Job was executed and saved. Status of the Job request. For more details see Table 8. Jobs status conditions / options Operation Type of the Job. This is based on the Task and Operation selected when the Schedule was created. For more information on Creating a Schedule, see Section Creating a Schedule. The date range during which a specific Job request was sent to the queue to be processed. Click the From or To fields. In the pop-up window, enter the desired date and time. If no time is specified, the default time will be 00:00:00. The date range during which a specific Job completed processing. Click the From or To fields. In the pop-up window, enter the desired date and time. If no time is specified, the default time will be 00:00:00. A Job will result in one of several status conditions during execution. The following table explains the various status conditions. Table 8. Jobs status conditions / options Status New Processing Success Failed Partial Failed Cancelled Suspended Suspend Requested Resumed Inactive Completed Description A Job has been added to the queue, but no commands have been executed. The commands for this Job are currently being processed. All commands have completed successfully. The Job commands have failed. Some of the commands for this Job have failed. The execution of this Job has been cancelled. Used primarily for Upload operations. If the task is set to operate in a specific Time Frame and is unable to complete, it will be placed in Suspended mode until the next Time Frame is available. When a task is awaiting completion of a process thread before entering Suspended mode, it will display this status. Indicates that the task was previously suspended and has now become active again. This is an internal status generated by the system when a task is waiting for a preceding task as well as any dependencies to complete before it is executed. The task has been completed. Jobs with a Status of Cancelled, Success, Failed, Partial Failed, or Completed can be deleted from the Jobs list after processing has completed. When a Job is deleted, historical information about the Job is also deleted.

59 System 58 An Upload-related Job that does not use the Upload Stage can be cancelled with the Cancel Job button. Only Upload Jobs that are processing, suspended or resumed can be canceled. When this button is selected, Trueview waits for any running processes to be completed and aborts any remaining processes associated with the Job. To view the job details, Select a Job from the grid, and click Details. The application displays the Job s Detail/Configuration screen. Alternatively, you can also click a job to display its Detail/Configuration screen. Figure 58. Selecting a Job to view its details Job s detail / configuration screen The Job s Details/Configuration screen is divided into the following sections: Job Details Job Parameters Job Participating Items Messages Job details section The Job Details section displays information about the selected Job. You are not allowed to edit any details in this section.

60 System 59 Figure 59. Job details section The following table explains about fields displayed in the Job Details section. Label Job ID Status Operation Type User Submitted Date Processed Date Schedule Server ID Description ID Assigned by the Job Controller when the Job request is submitted. Status of the Job request. For more details see Table 8. Jobs status conditions / options. Operation Type of the Job. This is based on the Task and Operation selected when the Schedule was created. For more information on Creating a Schedule, see Section Creating a Schedule. Name of the user who initiates the Job. Date and time the Job was submitted to the queue. Date and time the Job was competed. The name of the Schedule with which the Job is associated. Schedules are created, modified and managed in the Admin -> Schedules menu. The Server ID in which the Job was executed and saved Job parameters section The Job Parameters section displays the parameters that were configured during Schedule creation. For more information about Configuring Job Parameters, see Section , Configuration Tab. Figure 60. Job parameters section

61 System Job participating items section The Job Participating Items section displays a list of Trueview objects that are either involved in the Job/affected by the Job. Select a participating item/element to display its pertaining Job Messages in the Messages section displayed below Job Participating Items section. Figure 61. Job participating items section Click the item / element to display its detail / configuration screen. Figure 62. Item's detail / configuration screen

62 System 61 The following table explains about the fields displayed in the Job Participating Item section. Table 9. Job Participating Item section fields Label Element Element Type Status Element Id Description The name of the Element that participated in the Job. Type of Element that participated in the Job, such as Network Element. The Status of the action performed on the Element.. For more details see Table 8. Jobs status conditions / options. Unique ID assigned to the Element when it is created Messages section Messages are generated while a Job is executed. Messages generally represent a transaction log of events that occurred during the Job s execution. Two types of Messages are displayed in this section: Messages that are specific to the Job Messages that are specific to the Participating Items involved in the Job There are two ways to display/view the messages Show all messages Select the Show All Messages check box to display all Messages related to the Job as well as the Participating Items involved in the Job. Figure 63. Show All Messages You can also filter and display the messages through Message Pattern by entering any part of a message in the Search by Message Pattern field. The wildcard character * can be used to substitute for one or more characters in the Message Pattern. To do this,

63 System Enter any part of the Message enclosed by a *. 2. Click Search. The application displays the pertaining messages in the grid. Figure 64. Message filtered and displayed using wildcard search NOTICE: Searches are case-sensitive Messages filtered through Participating Item Select a participating item/element to display its pertaining Job Messages. For more information about messages filtered through participating item, see Section Job participating items section. The following table explains about the fields displayed for the Messages. Table 10. Message details Label Element Type Description The name assigned to the Element when it is created in Trueview. If a Message is not specifically related to any Element, this field will remain blank. Type of information reported for the selected task. The available options are, Info Reconciliation Error Reconciliation Category General outcome of the reconciliation operation performed on the object specified in the selected Job (if applicable). The available options are, Not Applicable New new object found Out of Sync Not Found object is not found Reconciliation Action The reconciliation action performed on the element. The available options are, No Action Created a new object is created Updated an existing object is updated Removed an object is removed Replaced an existing object is replaced with a new object

64 System 63 Message Message ID Log message. This message contains additional details about the object and results of the Job execution. Unique identifier for the message. NOTE: All scheduled jobs messages are stored in one of the three archive tables, upon them being deleted. The three tables are requestmessagearchive, requestelementarchive, requestarchive. The user must manually manage these tables directly through SQL. 3.2 Staging The Staging feature is used to store uploaded equipment configurations across different geographic locations using local or remote servers. One Staging is used per clustered Trueview environment. The uploaded XML equipment configurations are retrieved when the NE Upload Schedule runs from the Administration module. The configurations are referred to as Upload Data or Payloads. They are then used to reconcile Trueview objects in the system database when the NE Reconciliation Schedule is performed. For more information about Schedules, see Section Schedules. The following diagram explains how the NE Upload and Reconciliation operations interact in a clustered, multi-server Trueview environment. Figure 65. How NE Upload & Reconciliation operations interact in a clustered, multi-server Trueview environment

65 System 64 Viewing Upload Data The Find Upload Data screen displays all Upload Data retrieved from equipment when the NE Upload Schedule is run. The records shown in this screen is useful for monitoring and debugging issues that may arise during an NE Reconciliation operation. To view the uploaded data, 1. Click System -> Staging. The application displays the Find Upload Data screen. Figure 66. Staging 2. Enter the search criteria, and click Search. Alternatively, you can also click Search without entering any search criteria to list the available uploaded data in the application. Figure 67. Find Upload Data screen The following table explains about the various fields used to define and filter Upload Data in the Find Upload Data screen.

66 System 65 Table 11. Fields used to define and filter Upload Data in the Find Upload Data screen Label Name Type NE Type Source Reconciliation Status Upload Start Date (From) Upload Start Date (To) Created Date (From) Created Date (To) Description Name of the Staging File associated with the upload data. Type of the Staging associated with the upload data. Type of Network Element associated with the Upload Data. Source of the Upload Data (usually a server ID). This field indicates if the Payload has been processed by a reconciliation operation. The available options are: Never Reconciled, In Progress or Reconciled. Indicates the day and time from when the NE Upload process was started. Indicates the day and time up to when the NE Upload process was started. Indicates the day and time from when the Upload Data is created and stored in the database. Indicates the day and time up to when the Upload Data is created and stored in the database. To view the upload data, Select a staging file from the grid, and click Open. The application displays the Staging File s Detail/Configuration screen. Alternatively, you can also click a staging file to display its Detail/Configuration screen. Figure 68. Selecting a Staging File to view its details

67 System 66 Figure 69. Staging File's detail / configuration screen Upload Data details / configuration screen The Staging File s detail / configuration screen is divided into the following sections: Upload Data details Payload Upload Data details section The following table explains about the various fields displayed in the Upload Data details section. You are not allowed to edit any details in this section. Table 12. Upload Data details section fields Label Name Type NE Type Source Reconciliation Status Uploaded Date Upload Start Date Payload Sequence Payload Count Created By Created Date Description Name of the Staging File associated with the upload data. Type of the Staging associated with the upload data. Type of NE associated with the Upload Data. Source of the Upload Data (usually a server ID). This field indicates if the Payload has been processed by a reconciliation operation. The available options are: Never Reconciled, In Progress or Reconciled. Indicates the day and time when the Upload Data (Payload) was gathered. Indicates the day and time when the NE Upload process was started. Indicates the sequence number of the Payload when multiple Payloads are received from the same piece of equipment during a single NE Upload operation. Indicates the total number of Payloads received from a piece of equipment during a single NE Upload operation. The ID of the user who performed the NE Upload operation which retrieved the Payload. The day and time when the Upload Data is stored in the current database.

68 System 67 Figure 70. Upload Data section Payload section The Payload section displays the actual XML configuration retrieved from the equipment during the NE Upload operation. You can edit the configuration details and do the reconciliation operation in order to simulate live equipment configurations (if required for testing purposes). Figure 71. Payload section Creating Upload Data For testing purposes, Upload Data can be created in order to simulate live equipment configurations. To create Upload Data, 1. Click Create in the Find Upload Data screen. The application displays the Upload Data Detail/Configuration screen. Figure 72. Find Upload Data screen

69 System Enter the details as explained in Table 12. Upload Data details section fields. 3. Enter the upload configuration in the Payload section. 4. Click the Save icon in the upper-right corner of the screen. The application automatically creates the Created By and Created Date. The Upload Data (staging file) is created and added to the list. 3.3 Logs TIP: For more information on how to structure the XML contents of the Payload, refer to the response.xsd file included in the api\xsd directory of the received installation files. This XML structure is essential for reconciling the Network Elements in the Trueview database with the live equipment when the NE Reconciliation operation is performed. The Logs menu has two sub menus: Audit Operation These are explained below. Audit Audit Logs provide a list of audit details of the various operations done by the users in Trueview. Enter the search criteria and click Search to view the Audit Log details. Figure 73. Audit logs Operation Operation Logs display the operations done by the various users in Trueview. Enter the search criteria and click Search to view the users operation details.

70 Figure 74. Operation logs System 69

71 Administration 70 Chapter 4 Administration The Admin module provides facilities for installing and configuring resources to be used in Trueview. Figure 75. Admin module The Admin module allows you to perform the following tasks through a list of menus / submenus: Change Language configuration settings for Trueview. Configure and manage Users and User Groups. Assign Users to Customer-specific User Groups so that their view of the network is restricted. Create Domains to facilitate grouping of Network Elements. Define Privilege levels for accessing Trueview features. Create and modify Schedules for performing upload, provisioning, and reconciliation operations. Create Project Templates to facilitate the configuration of similar Project. Modify color configurations for alarms, VLAN paths, link availability, circuits, upload states, etc. Define custom enumerations for Trueview selection fields, such as report categories, location types, Project types, connection capacity, etc. Provisioning Enumerations for circuit provisioning status. Use the NE Configuration tool to upload and assign custom icons to represent defined Network Elements, and define connection pool settings for Network Elements. Rules for Service in Trueview. Specify system parameters for managing Telephone Numbers. Define Bandwidth Profiles, Classes of Service, Capacity, Provisioning Enumerations for circuit provisioning status and Rules for Service in Trueview. Support for Server Groups and Connectors. Configure system parameters, multilingual support, authentication settings, user-interface styles and more. Create and modify custom Report Definitions and custom screen Packages with the Workbench. Manage custom screen Packages using the Customization menu. 4.1 Security The Security menu allows you to do the following tasks:

72 Administration 71 User Management Manage network partitioning capabilities for Trueview If Language Packs are configured through Trueview Admin module, different users can choose to work with Trueview in different languages. User-based language settings are controlled through the User Configuration screen. Administrative language settings are controlled through the Admin -> System menu (Languages tab). User accounts can be imported from corporate LDAP or Active Directory servers or created locally. The accounts are authenticated in one of two ways: either through Trueview s own managed security mechanisms, or through an external ( unmanaged ) authentication system that communicates with Trueview to map users to a User Group based on the user s role within the external system. The type of method used by Trueview is determined by the Authentication Level specified in the Admin -> System menu. Every user must belong to at least one User Group in order to use the Trueview application; the User Group is the basis of a user s application privileges. To control access to Trueview modules, User Groups can be created and privileges can be applied to the User Groups. User Groups can also be associated with a Customer so that members of a Customer-related User Group can only see Network Elements or other users that are pertained to the Customer. In a typical operational environment, Domains can be created to subdivide the overall network into areas of responsibility as determined by organizational structure. User Groups, Network Elements, Physical Ports, Logical Interfaces and Customers can be associated with these Domains to restrict a user s view of Network Elements even further. Figure 76. Security module Users When Trueview is installed, a default user account with the username Admin is provided with all application privileges granted to this user account. Privileges for this account are locked and cannot be edited. Other user accounts created in corporate LDAP or Active Directory servers are imported into Trueview to allow access to the application. User accounts can be managed or unmanaged. Managed users are users who are imported via LDAP or Active Directory servers or created explicitly in Trueview. Unmanaged users are those who are authenticated through an external Single Sign On (SSO) mechanism.

73 Administration 72 Since Trueview is designed to interact with corporate authentication servers, user accounts from the corporate LDAP or Active Directory servers can be imported into Trueview for assignment to appropriate User Groups. Access privileges for the various modules of the application are granted at the User Group level. A user account will not provide any functionality until it is assigned to a User Group. Once a user account is assigned to a User Group, the user s visibility of Trueview objects can be further restricted, if necessary, to provide additional security and prevent unwanted visibility of certain equipment or services. This is done by associating User accounts with Customer objects or Domain objects, as well as enabling or disabling appropriate privileges for a User Group. NOTE: All user authentications are performed by the designated LDAP or Active Directory servers. If a user receives a Trueview authentication error upon login, please verify that the authentication configuration in Trueview has the correct settings based on the Security Realms configuration in the WebLogic administrative console. For information on Security Realms in WebLogic, refer to the relevant WebLogic documentation. Figure 77. Find Users screen The following table displays the search fields that are used to filter user records in the Find Users screen: Table 13. Fields available in the Find Users screen Label Username Given Name Last Name LDAP Server Customer Enabled Managed Description Account name assigned to the user login ID User s first name User s surname User s ID LDAP server where this user account is authenticated. Customer with which the user is associated (optional field). The Customer assignment can be used to restrict a user s view of the network, equipment, access privileges, etc. to only those Trueview objects which are associated with the same Customer. Indicates whether the account is enabled or disabled for use with Trueview. Indicates whether a user account was explicitly created or imported into Trueview, or authenticated through an external (single sign-on) authentication system. The value Yes indicates that the user account was either explicitly created in Trueview or

74 imported via an LDAP or Active Directory server. The value No indicates that the user account exists in an external (single sign-on) authentication system. Administration Importing User Account User accounts created in corporate LDAP or Active Directory servers can be imported into Trueview as Managed accounts to allow access to the application. If an User is a Trueview Administrator or has the User Import privilege assigned to the User Group, a list of all usernames in the selected LDAP or Active Directory server is generated when the Import button is clicked in the Find Users screen, and a search can be performed in the Import Users window. To import a managed account from a corporate LDAP or Active Directory server, 1. Click Admin -> Security -> Users. The application displays the Find Users screen. 2. Click Import. The application displays the Import Users screen. Figure 78. Find Users screen 3. Select the Exclude Existing Users check box to exclude already existing users from the import operation. 4. Select the desired LDAP server from the LDAP Server list. If only one LDAP Server is configured for authentication, then default will automatically appear in the LDAP Server list box. 5. Click Search to display the list of managed user accounts from the LDAP server. You can also enter the User Name/Last Name search criteria to filter and list the records from the LDAP server. In some cases, restrictions may be placed in an LDAP server to return only a certain number of records. Consequently, errors may result if no search filters are applied and the number of queried records exceeds the maximum number of records that the LDAP server is configured to return. An LDAP server must be configured before performing the search operation.

75 Administration 74 NOTE: Searches conducted in the Username field in the Import Users screen may not be case-sensitive because the Active Directory authentication provider allows for case-insensitive searches. Other authentication providers may or may not support case-insensitive searches. 6. Select the managed user account(s) from the list of LDAP records. 7. Click Add. Multiple accounts can be selected. 8. If the Customers module is enabled and Customer objects exist in Trueview, the Select Customer for the new users screen is displayed so that the newly imported users can be associated with a Customer, if required. This is an optional step that can be done in order to restrict the users view of Trueview objects to only those objects associated with the same Customer. If this step is not required, click Skip. Figure 79. Select Customer for the New Users screen 9. If you want to associate the newly imported users with the Customer do the following steps: 9.1. Enter the search criteria, and click Search or click Search to list the available Customers Select the customer, and click Select. Only one Customer can be selected. Figure 80. Associating newly imported users with the customer 10. The application displays a success message. Click OK.

76 Administration 75 Figure 81. Application displaying the message for successfully importing the selected users The system displays a status message with the operation results. If the Exclude Existing Users check box is cleared and if you attempt to import managed Users who already exist in the application, the application will ignore those user accounts. The application displays a message confirming how many records were imported while ignoring existing users. Figure 82. Application displaying the message for importing existing users

77 Administration Creating User Account If no corporate LDAP server or directory is available for importing user accounts, Trueview allows users to be created locally if the following conditions are met: An open-source LDAP Server is correctly configured in the Admin -> System menu (Authentication tab). For the specified LDAP server, the fields mapped to First Name Mapping and Last Name Mapping should be the only mandatory fields in the LDAP schema for the object classes defined for User Object Class. The person creating the new users is a Trueview Administrator or belongs to a User Group with the User Create privilege enabled. Figure 83. Authentication tab NOTE: If additional fields are marked as mandatory in the LDAP schema, then it is not possible to create users through Trueview. In such cases, users should be created through an external LDAP client and then imported into Trueview through the import process as explained in Section Importing User Account.

78 Administration 77 NOTE: For more information on LDAP schemas, refer to the relevant documentation for your chosen LDAP application. To create a local user, 1. Click Admin -> Security -> Users. The application displays the Find Users screen. 2. Click Create. The application displays the user s Detail/Configuration screen. Figure 84. Find Users screen 3. Enter the User information details. The Customer field can be used to associate the user with a Customer and restrict their view of Trueview objects to only those objects associated with the same Customer. Figure 85. User's detail / configuration screen 4. In the User Groups tab, assign the new User account to a User Group. The User Group determines which application privileges the user will have while using Trueview. For more information about User Groups Tab, see Section User Groups.

79 Administration If required, assign the new user s User Group to a Domain. Domains can be used to limit the user s view for certain Trueview objects. For more information about Domains Tab, see Section Domains tab. 6. Click the Save icon in the upper-right corner of the screen. The new User account is created and assigned as a member of the selected User Group. IMPORTANT: After the user account is created, click Search in the Find Users screen to refresh the list of User objects shown. The User account should be enabled before the User can logon to Trueview. The user must also be assigned to a User Group in order to access Trueview application modules User Groups tab All users must be assigned to a User Group in order to have application privileges. An individual user can be assigned to a User Group using the User Groups tab in the User s Detail/Configuration screen. If a large number of users need to be added to the same User Group simultaneously, however, a more convenient way to do this would be to add users through the Admin -> Security -> User Groups submenu. For more information see Section Users tab. NOTE: Trueview non Administrators who perform the user-group assignment can only see those User Groups that have their own User Group(s) privileges or privilege subset. Trueview Administrators can see all User Groups regardless of their assigned privileges. To assign a Managed User to a User Group, 1. Select a User from the Find Users screen for whom you wish to assign to a User Group. NOTE: You can also assign a managed user to a User Group at the time of creating a User. Once you save the user, the User Groups tab and Domains Tab are available. 2. Click Open. The application displays the user s Detail/Configuration screen.

80 Administration 79 Figure 86. Find Users screen - Selecting a user 3. Click the Users Groups tab. 4. Click Assign To. The application displays the Select User Groups screen. Figure 87. User's detail / configuration screen 5. Click Search to display the list of managed User Groups available. You can also enter the search criteria to filter and list the records from the LDAP server. 6. Select the User Group from the list, and click Assign.

81 Administration 80 Figure 88. Assigning a Managed User to a User Group 7. Click the Save icon in the upper-right corner of the screen. The Managed User is assigned to the User Group. If the user s access should be restricted to a particular Domain of Network Elements, you should associate the user s User Group with the Domain. For more information about restricting the user s access to a particular Domain, see Section Domains tab. Privileges are cumulative, that is, users will have all the privileges assigned to the various User Group(s) to which they belong. For example, if a user belongs to one User Group having no Circuit Create privileges as well as another User Group having Circuit Create privileges, the user will have the Circuit Create privilege as well as any other privileges associated with either User Group. Therefore, care should be taken when adding Users to User Groups to ensure that access restrictions are met.

82 Administration 81 Figure 89. Managed User is assigned to a User Group Domains tab In the user s Detail/Configuration screen, the Domains tab shows a read-only list of Domains to which users are assigned through their User Group. Domains are used to partition networks by organizational or operational segments; by assigning a user s User Group to a Domain, the user s view of Trueview objects can be further restricted. For more information about how to assign a User Group to a Domain, see Section Domains tab.

83 Administration 82 Figure 90. Domains tab Reset User Account Trueview Administrators or Users with User Reset Password (Admin Only) privilege can reset passwords for Users who can no longer remember their passwords or cannot logon to Trueview. To reset a user account password, 1. Open the Detail/Configuration screen of the User whose password is to be reset. 2. Click Reset Password. The application displays the Reset Password screen. 3. Enter the New Password and Confirm Password. 4. Click Reset. The application displays a confirmation message that the password is successfully changed. The password details are ed to the User s Select the Force User to Change Password check box to allow the User to change the password on logon to Trueview for the next time. 6. Click the Save icon in the upper-right corner of the screen IMPORTANT: The Force User to Change Password check box is available for selection only for LDAP servers with read/write permissions. For LDAP servers with only Read permissions, the check box is not available for selection.

84 Administration 83 Figure 91. Existing User Password details Figure 92. Resetting User Password Figure 93. Password Reset confirmation message If the Force User to Change Password check box is selected, the User on logon to the application for the next time; the application displays the User Configuration Password screen and prompts the User to reset the password details. The User cannot close the screen or access any other functions in the application until the password is changed. The new password will be in effect when the User logon to the application next time.

85 Administration 84 Figure 94. Reset Password screen - Force User to Change Password Figure 95. Password changed successfully Figure 96. User Logging into the Application with the new password

86 Administration 85 Figure 97. User Configuration screen - User prompted to change password details Figure 98. Password changed successfully User Groups Roles/User Groups with predefined privileges simplify account administration. In order for users to access Trueview, each user must be assigned to one or more User Groups. If a user does not belong to any User Group with Privileges assigned to it, the User will still be able to access the User Configuration screen in order to change their current language setting or password, but no other screens will be accessible. If a user receives a Trueview authentication error upon login, please verify that the authentication configuration in Trueview has the correct settings based on the Security Realms configuration in the WebLogic administrative console. For more information on Security Realms in WebLogic, refer to the relevant WebLogic documentation. The Trueview Administrator s User Group is created during system installation. It is automatically granted all privileges in Trueview. Privilege settings for this group are locked and cannot be edited. New User Groups may be created to satisfy various operational roles with selected privileges. Each application module has an associated list of privileges. The system administrator selects items from these lists as required to create specific roles. User Groups may be associated with Customers and Domains to further reduce the scope of access in Trueview Creating a User Group To create a new user group, 1. Click Admin -> Security -> User Groups. The application displays the Find Users Groups screen. 2. Click Create. The application displays user s Detail/Configuration screen.

87 Administration 86 Figure 99. Find Users Groups screen 3. Enter the User Group information details. 4. In the Users tab, click Add to add Users to the new group. You can select multiple users. For more information about Users tab, see Section Users tab. Figure 100. User's detail / configuration screen 5. In the Privileges tab, select the Privileges to be granted to members of this User Group. For more information about Privileges, see Section to section Privileges tab. 6. In the Domains tab, select the Domains to be accessed by members of this User Group. For more information about Domains tab, see Section Domains tab. 7. Click the Save icon in the upper-right corner of the screen. The new User Group is created. 8. Click Search to refresh the list of User Groups displayed in the Find User Groups screen. 9. For more information about how to modify or delete User Groups, see Section Working in Trueview screens Users tab Users tab allows you to assign User Groups to the User. NOTE: Trueview non Administrators and users who do not have the User Import privilege can only see the list of Users that belongs to their own User Group(s). Trueview Administrators and users who have the User Import privilege can see a list of all Users regardless of the User Group(s). To assign User Groups to a User,

88 Administration Select a User Group from the Find Users Group screen for which you wish to assign to a User. You can select multiple user groups. You can also assign a User to the User Group at the time of creating a User Group. Figure 101. Find User Groups screen - Selecting User Group(s) 2. Click Open. The application displays the User Group s Detail/Configuration screen. 3. Click the Users tab. 4. Click Add. The application displays the Users screen. Figure 102. User Group's details / configuration screen 5. Click Search to display the list of managed Users available. You can also enter the search criteria to filter and list the records from the LDAP server. 6. Select the Users from the list, and click Select.

89 Administration 88 Figure 103. Assigning a User Group to a User 7. Click the Save icon in the upper-right corner of the screen. The User Group is assigned to the User. Figure 104. User Group Assigned to a User Privileges tab Privileges are used to control user access to objects and commands in Trueview. Each Trueview module has a number of defined privileges specific to that module. To assign privileges to a User Group, 1. Select a User Group from the Find Users Group screen for which you wish to grant privileges. You can select multiple users groups. You can also grant privileges to the User Group at the time of creating a User Group.

90 Administration 89 Figure 105. Find User Groups screen - Selecting a User Group 2. Click Open. The application displays the User Group s Detail/Configuration screen. 3. Click the Privileges tab. The application displays a series of tabs. 4. Click the required tab. Each tab displays a list of access. 5. Select the required access. 6. Click the Save icon in the upper-right corner of the screen. The privileges are granted to the User Group. Figure 106. User Group's detail / configuration screen

91 Administration Domains tab Domains are created to partition the network by organizational or operational segments. This tab utilizes Domains that are created through the Admin -> Security -> Domains submenu. Members of a User Group will have access as defined by Privileges to all objects contained in a Domain when that Domain is assigned to the User Group. Domains that are associated with a Customer can also be assigned so that a user s view of the network is restricted to only those objects that belong to the Customer Domain and to the User Group of which the user is a member. To assign a User Group to a Domain, 1. Select a User Group from the Find Users Group screen for which you wish to assign to a Domain. You can select multiple user groups. TIP: You can also assign a domain to the User Group at the time of creating a User Group. Figure 107. Find User Groups Screen Selecting a User Group 2. Click Open. The application displays the User Group s Detail/Configuration screen. 3. Click the Domains tab. 4. Click Assign To. The application displays the Select Domains screen.

92 Administration 91 Figure 108. User Groups Detail/Configuration Screen 5. Click Search to display the list of managed Domains available. You can also enter the search criteria to filter and list the records from the LDAP server. 6. Select the Domains from the list, and click Assign. Figure 109. Assigning a User Group to a Domain 7. Click the Save icon in the upper-right corner of the screen. The User Group is assigned to the Domain. Figure 110. User Group Assigned to the Domain

93 Administration 92 Domains A Domain is a collection of physical and logical network resources or network objects in a network partition. The partition can include other child or sub-domains and can be created based on geographic, regional, administrative or other organizational divisions to provide a basis for managing and controlling user access and visibility of the overall network. The top level or default Domain is System, which is created when the application is installed. All Trueview network objects are assigned to the System Domain when created. User Groups, Views, Network Elements, Physical Ports, Logical Interfaces, and Customers can be associated with or removed from existing network Domains. Visibility and access to the components of a Domain are controlled by the privileges assigned to a User through the related User Group. More than one User Group can be associated with a Domain. Each Domain created must have a parent Domain and must be assigned a unique name. Only objects defined in a Parent domain can be assigned to a child domain Creating a Domain To create a new Domain, 1. Click Admin -> Security -> Domains. The application displays the Find Domains screen. 2. Click Create. The application displays Domain s Detail/Configuration screen. Figure 111. Find Users Groups Screen 3. Enter the domain details as explained in Table 14. Domain Fields and their Purpose. 4. To associate a domain with User Groups, Projects, Views, Network Elements, Physical Portals and Logical Interfaces, see Section Manage objects in a Domain. Figure 112. Domain's Detail/Configuration Screen

94 Administration Click the Save icon in the upper-right corner of the screen. The domain is created and added to the list. Table 14. Domain Fields and their Purpose Label Domain Name Parent Domain Remarks Customer Description Name assigned to the new Domain. Name of the Domain for which the current Domain is a sub-domain. The top level or default Domain is System. General comments or description for this Domain. Customer object with which the Domain is associated. Figure 113. Domain is Created and Added to the List Manage objects in a Domain You can add the User Groups, Projects, Views, Network Elements, Physical Ports and Logical Interfaces to a domain through the respective tabs displayed in the domain s Detail/Configuration screen. Only objects defined in a Parent domain can be assigned to a child domain. To add objects to a domain, 1. Click the respective tab, and click Add. The application displays the pertaining selection screen. (an example of adding Network Elements to a Domain is shown below)

95 Administration 94 Figure 114. Objects Added to the Parent Domain Figure 115. Adding Network Elements to a Domain 2. Select the Objects, and click Select. The objects are added to the domain.

96 Administration 95 Figure 116. Object Selection Screen Parent Domain Objects are displayed for Selection Figure 117. Objects Added to the Domain 3. To remove an object, select the object and click Remove. IMPORTANT: Child Domains will automatically be deleted when the Parent Domain is deleted.

97 Administration 96 Privileges In Trueview, privileges are assigned to modules based on areas of functionality within the application. Privileges are granted to User Groups by the Trueview Administrator. The following tabs are displayed based on the modules that are configured during Trueview installation. General Administration Security Configuration Resource Management Connection Management Transactions Reports Scripts Task Actions Custom Figure 118. Privileges Available in Trueview In each module, most Trueview objects have four basic types of privileges as defined in the following table. Table 15. Privileges Available for Trueview Objects Privilege Type CREATE DELETE Description User is allowed to create an object of that type. This privilege should be granted together with the Update privilege so that the user can also edit objects that they create. Create and Update privileges should be granted for Connection objects if a user has the Create New Version privilege for those objects (Circuits, Layer 2, and IP VPN Services) because multiple versions involve the creation and update of objects. User is allowed to delete an object of that type.

98 Administration 97 UPDATE User is allowed to update or modify an object of that type. This privilege should be granted together with the Create privilege since it is necessary to create objects first. Activate, Virtual Activate, Virtual Enable, De-activate, Virtual De-activate and Virtual Disable privileges also exist for Connection objects. These privileges work in conjunction with the Update privilege since a Connection object s Provisioning Status is updated as a result of these operations. Consequently, if these privileges are required, they should be granted together with the Update privilege for those objects. Create and Update privileges should be granted for Connection objects if a user has the Create New Version privilege for those objects (Circuits, Layer 2, and IP VPN Services) because multiple versions involve the creation and update of objects. VIEW If a user has the Location Update Coordinates privilege enabled, Location pins can be moved around in the Map tab of a Customer View, and the new geographic coordinates will be saved for the Location object even if the user does not have the Location Update privilege enabled. To change other attributes of the Location object, however, the user must have the Location Update privilege enabled. This is the most basic privilege for any Trueview object and must be granted to allow users to see that type of object. Consequently, most items listed in the Privileges screens follow the format of <NETPortal object> - <Privilege type>. It is up to the Trueview Administrator to determine which privileges are appropriate to assign to a given User Group. Each Access adapter has a number of commands associated with it. A system-level privilege is defined for each command and can be enabled or disabled in the Commands tab, provided that the Digital Bridge module is installed and configured with Trueview. When an adapter is installed through the Admin module, the commands associated with the adapter are automatically added to the Admin -> Security -> Privileges -> Transactions tab, where they can be enabled or disabled as required for specific User Groups. Privileges for access commands generally follow the format of <node type>/<command> - <command description>. If the Digital Bridge module is not installed or configured in Trueview, the Transactions tab will not be available. Privileges listed in the Admin -> Security -> Privileges -> Custom tab refer to privileges defined in Customization Packages. For more information see Section Privileges tab. If a user has the Report Workbench privilege enabled in the Configuration tab, the user will have the ability to modify or run any Report. NOTE: The View privilege must be allowed for all entities that should be accessed in the application. It is a minimum requirement to view the related screens. If a user has only View privileges, no information can be saved in the database. Click the Save icon in the upper-right corner of the screen to apply the privilege changes. 4.2 Schedules Schedules provide you with powerful tools for automating tasks to be performed in Trueview. Scheduled events are created in the Schedules screen and submitted to the System -> Jobs menu for automatic processing by the application. Tasks can be created for one-time execution or for repeated occurrences at user-defined intervals. For each operation, Trueview objects of the appropriate type can be selected for inclusion in the scheduled task. Operations to be performed can be selected from a drop-down list based on the type of task selected.

99 Administration 98 Once a task is created and submitted to the queue, its processing status can be monitored from the Job s Detail/Configuration screen in the System -> Jobs menu. Tasks are assigned to the Job Controller and are executed by the Job engine as they are activated (or unlocked) from Schedules. Viewing Schedules To view the schedules, 1. Click Admin -> Schedules -> Manage. The application displays the Find Schedules screen. Figure 119. Schedules 2. Enter the search criteria, and click Search. Alternatively, you can also click Search without entering any search criteria to list the available schedules in the application.

100 Administration 99 Figure 120. Find Schedules screen The following table explains about the various fields used to define and filter Schedules in the Find Schedules screen. Table 16. Fields used to Define and Filter Schedules in the Find Schedules Screen Label Name Parent Schedule Start Date End Date Task Operation Frequency Interval (# of occurrences) Enabled Description Name assigned to the scheduled task. All active schedules are listed here. Select a Parent Schedule from the list. Parent Schedule and Dependent Schedules use a parent-child relationship. Parent schedule gets executed first and after it finishes, all dependent (child) schedules start. Date from when the scheduled task should be executed. If you do not define a Time Frame, the scheduled task starts at the pre-defined Server time. Date up to when the scheduled task should be executed. Once the system reaches the End Date, the scheduled task stops. If you do not define a Time Frame, the scheduled task stops at the pre-defined Server time. Type of task to be performed by the Schedule. The task selected determines what kind of operations can be performed. Operation that the Schedule controls. The operations are listed based on the task selected in the Task list. Frequency with which the task should be performed. The available options are: ONETIME, DAILY, WEEKLY and MONTHLY. Interval is used as a multiplier of frequency. For example, if the Frequency is selected as Daily and Interval as 2, it means the Schedule is executed once in two days during the scheduled period, that is, Start Date and End Date. Status of the selected Schedule item. The available options are: No/Yes. A Schedule must be enabled before it can be unlocked for activation and also to be executed. For more information about how to Unlock a Schedule, see Section Unlocking a Schedule.

101 Administration 100 Locked Created By Server ID Indicates whether the Schedule is locked from activation or not. The available options are: No/Yes. To modify a Schedule it should be locked. For more information about how to Lock a Schedule, see Section Locking / modifying a Schedule. The name of the user who creates the Schedule. The Server ID, in which the Schedule is created, executed and saved. The Server ID and Database are configured in Admin -> System menu. Creating a Schedule To create a new schedule, 1. Click Create in the Find Schedules screen. The application displays the New Schedule creation screen. Figure 121. Find Schedules Screen 2. Enter the Schedule details as explained in Section Schedule details. 3. Click the Save icon in the upper-right corner of the screen. The schedule is created and added to the list.

102 Administration 101 Figure 122. New Schedule Screen Schedule details Details The following table explains about the various fields available in the Details section. Table 17. Schedule details Label Name* Enabled Task* Operation* Server ID Parent Schedule Description Name assigned to the scheduled task. Status of the selected Schedule item. The available options are: No/Yes. A Schedule must be enabled before it can be unlocked for activation and also to be executed. Type of task to be performed by the Schedule. The task selected determines what kind of operations can be performed. Operation that the Schedule controls. The operations are listed based on the task selected in the Task list. The Server ID, in which the Schedule is created, executed and saved. The Server ID and Database are configured in Admin -> System menu. All active schedules are listed here. Select a Parent Schedule from the list. Parent Schedule and Dependent Schedules use a parent-child relationship. Parent schedule gets executed first and after it finishes, all dependent (child) schedules start.

103 Administration 102 Figure 123. Details Section Task and Operation The Task list displays a list of tasks that can be perform by a Schedule. The Operations are listed based on the selected Task. The following table explains about the various tasks and operations listed in their pertaining list boxes. Table 18. Schedule Tasks and Related Operations Task Allowed Operations Purpose Audit Log Purge Audit Log Purge Purges Audit Log records from the database. Device Configuration Management DCM Backup OS DCM Backup Running DCM Restore OS DCM Restore Running You can set the Retention period, that is, the number of months the Audit Log details can be maintained from the Scheduled Date. All Audit Log details before the Retention Period are cleared. The default value is 12 months. Backup of OS is invoked from the Router Devices. Backup of Running Configuration is invoked from the Router Devices. For both operations, you should select one or more NE (as participating items) to perform backup / select one or more Device Group as participating items. Writes the OS to the Router Devices. Writes the Running Configuration to the Router Devices. For both operations, you should select a configuration to be restored. In addition, select one or more Network Elements to be restored. You can also select a "Device Group" (that contains a list of network elements). When restoring Running Configuration, a Configuration parameter "Copy to Startup" can be set to "true" or "false". If it is set to "true", the running configuration will be written to the NVRam (startup configuration).

104 Device Configuration Management - Cleanup Device Syslog Purge DCM Cleanup OS DCM Cleanup Running DCM Syslog Message Purge Clears the OS details in the Router Devices. Clears the Running Configuration in the Router Devices. For both the operations you can set the Retention period, that is, the number of months the OS and Running Configuration can be maintained from the Scheduled Date. All OS and Configuration details before the Retention Period are cleared. The Retention value overwrites the configuration values entered in the Admin -> System -> Parameters tab. Purges Syslog Messages from the database. Administration 103 Execute Saved Queries Execute Saved Queries Executes the Queries available in Trueview. The Schedule Execute Saved Query privilege should be enabled in the Admin -> Security -> Privileges submenu for this operation to be scheduled and executed. Query results or ed as CSV files to the users selected in the notification tab. For each CSV file one is send to the users. IP Address Assignment IP Address Assignment This process uses NE s as Participating Items, goes through all the IP Addresses of the NE s, and marks each IP Address as Used by the appropriate Interface on the NE. If a value found is already taken, the existing assignment is left alone and a message is logged that the value has already been assigned. Import Entity Import Entity Not applicable to import NE s through Scheduling. Importing NE s can be done through Admin -> CMDB -> Import menu. Layer 1 - Circuit Reconciliation (Deprecated) Circuit Reconciliation Depending on the selected Participating Items and Configuration parameters for this task, all Cross Connects in selected Network Elements are processed in order to reconcile Circuit objects in the Trueview database with Cross Connect data retrieved from live equipment. The operation can be executed in any one of the following modes. Report Update Create In CREATE or UPDATE mode, Trueview will only modify or delete Circuits that are In Service or Partially Defined.

105 Layer 1 - Circuit Reconciliation (NEW) Layer 2 Ethernet Link Reconciliation Layer 2 Ethernet Service Reconciliation Layer 1 - Circuit Reconciliation Layer 1 Circuit Reconciliation for Existing Circuit Ethernet Link Reconciliation Layer 2- Ethernet Service Reconciliation Depending on the selected Participating Items and Configuration parameters for this task, all Cross Connects in selected Network Elements are processed in order to reconcile Circuit objects in the Trueview database with Cross Connect data retrieved from live equipment. The operation can be executed in any one of the following modes. Report Update In UPDATE mode, Trueview will only modify or delete Circuits that are In Service or Partially Defined. The operation can be executed in any one of the following modes. Report Update In UPDATE mode, Trueview will only modify or delete Circuits that are In Service or Partially Defined. Layer 2 Connectivity Reconciliation creates an instance of an Ethernet Link based on either CDP or LLDP neighbor information uploaded from the network elements. The scope of the reconciliation is set by identifying the Network Elements. Networks or Views that are to be included either explicitly or by defined query. The operation can be executed in any one of the following modes. Report Update Depending on modifications done in the Configuration Tab, you can chose to run VLAN update, and chose the data which is to be reconciled based on its date, and chose a customer. The Ethernet Service Reconciliation process will reconcile all In Service versions of ELINE, ELAN, and ETREE services. Ethernet Service Reconciliation uses Ethernet Service Reconciliation Project to track Out of Sync services. If an Ethernet Service Reconciliation Project is not created prior to a user running reconciliation, the user can create the said Project. For more information about creating Administration 104

106 Project Templates, see Section 5.3, Project Templates. The operation can be executed in any one of the following modes. Report Update Administration 105 Layer 2- Ethernet Service Reconciliation for Existing Service In the report mode, there are no changes made to the In Service services. However, in the update mode reconciliation versions of the In Service services are updated to match the network and put In Service if possible. Newly discovered circuits are also put In Service. The Ethernet Service Reconciliation for Existing Service can be used to reconcile only existing services, that is, if you don't want to create new services during reconciliation. This is in contrast with "Layer 2 - Ethernet Service Reconciliation" where both existing services are reconciled and new services gets created (if it doesn't exist already) according to what's configured on the network elements (from uploaded data). Layer 2 Inner VLAN Reconciliation Inner VLAN Reconciliation The operation can be executed in any one of the following modes. Report Update In report mode, you can only generate reports for reconciling existing services, but no reconcile actions are performed. However in the upload mode, reconciliation action is performed for existing services. This process uses Network Elements as Participating Items to synchronize QinQ Ethernet Services (e.g. ELANs, ELINEs) in the Trueview database with the live network. It should be performed after Outer VLAN Reconciliation because it reconciles Services that build on Services reconciled by the Outer VLAN Reconciliation process. The operation can be executed in any one of the following modes. Report Update Based on the reconciliation mode and whether tunneling/encapsulation are enabled in the Interfaces, the process creates updates or deletes Ethernet Services. If a Customer is configured as the "Default Customer"

107 Layer 2 Outer VLAN Reconciliation Layer 3 IP Link Reconciliation Outer VLAN Reconciliation IP LINK Reconciliation parameter, then the Customer is assigned to any newly created Ethernet Services. If the "Service Parameter Update" parameter is set to Yes, key configuration data such as IP Addresses will be updated on the Interfaces regardless of the reconciliation mode. This process uses Ethernet Networks as Participating Items to synchronize Ethernet Services (e.g. ELANs, ELINEs) in the Trueview database with the live network. The process examines the Interfaces of all the Ethernet Links assigned to the Ethernet Network to capture the allowed VLAN configuration(s) and determine the Services that are traversing the Network in context. It should be performed before Inner VLAN Reconciliation because Inner VLAN Reconciliation reconciles Services that build on Services reconciled by this operation. The operation can be executed in any one of the following modes. Report Update Based on the reconciliation mode and the switchport mode configuration in the Network Elements of the Ethernet Network, the process creates, updates, or deletes Ethernet Services. If a Customer is configured as the "Default Customer" parameter, then the Customer is assigned to any newly created Ethernet Services. If the "Service Parameter Update" parameter is set to Yes, key configuration data such as IP Addresses will be updated on the Interfaces regardless of the reconciliation mode. This process uses Network Elements static information to either reconcile existing In Service IP links or create new instances of IP Links in the Trueview database with the live network. The process uses the "neighbor" configuration reported by the BGP, OSPF or IS- IS protocol that is discovered during the upload of Network Elements. The operation can be executed in any one of the following modes. REPORT UPDATE IP Link Reconciliation propagates the association protocol details based on the information uploaded from the NEs being reconciled. This information includes: Administration 106

108 Administration 107 BGP AS Number OSPF Area ISIS Area If a Customer is configured as the "Default Customer" parameter, then the Customer is assigned to any newly created IP Links. If a list of AS numbers are specified for the "AS Number(s) Parameter", then only PE routers matching one or more of the AS numbers will be considered for reconciliation. Process ID is an additional parameter that is required for OSPF link processing and must be added to the OSPF interface attributes. Layer 3 Tunnel Layer 3 Tunnel << >> Reconciliation Reconciliation Status Layer 3 VPN Reconciliation VPN Reconciliation This process synchronizes IP VPN Services in the Trueview database with the live network. The process considers all the BGP Networks in the system. The operation can be executed in any one of the following modes. REPORT UPDATE Depending on the reconciliation mode, the uploaded Route Target configurations on the PE Routers of each Network are correlated in order to create, update or delete IP VPN Services. If a Customer is configured as the "Default Customer" parameter, then the customer is assigned to any newly created IP VPN Services. NE Discovery NE Discovery This process captures XML equipment configurations from live equipment and creates new Network Elements in the Trueview database (e.g. in conjunction with an HPNA Connector). NE Purge NE Purge This operation purges Network Elements that have not been uploaded/reconciled within a specified retention period from the Trueview database. NE Reconciliation NE Reconciliation This operation reads data from the Upload Stage after an NE Upload operation identifies Network Elements that correspond to that data and reconciles the Network Elements in the Trueview database with that data. The operation can be executed in one of three modes: REPORT UPDATE NE Upload NE Upload This process captures XML equipment configurations known as Payloads from live equipment and stores them in an Upload

109 Stage. The data stored in the Upload Stage can then be used to reconcile Trueview Network Element objects later during the NE Reconciliation operation described above. This operation is recommended when multiple Trueview servers are used for clustered environments. NE Upload Data Purge NE Upload Data Purge This process allows a user to purge data that is no longer needed for reconciliation purposes. All data is purged from the Upload Stage except for the last reconciled set of Payload data, the last completed set of Payload data, or if not completed, the last Payload with an upload start date that is more recent than the last completed set of Payload data. NE Upload and Reconciliation NE Upload and Reconciliation This process captures XML equipment configurations from live equipment and directly reconciles the information with Network Elements already stored in the Trueview database during the same operation. The process can be executed in one of three modes: REPORT UPDATE This operation can also be executed using the Upload/Reconcile button on the Upload tab of a Network Element s Details/Configuration screen. Operation Log Purge Operation Log Purge Purges Operation Log records from the database. You can set the Parameter period, that is, the number of days the Operation Log details can be maintained from the Scheduled Date. All Operation Log details before the period (defined in the Parameter) are cleared. The default value is 30 days. Port Reservations Unreserve Ports This process is used for making reserved Ports that were not used by their Reservation Expiry Date available to any Customer again. The Participating Items are Network Elements. For more information on Port Reservation, refer to the Trueview User Guide. Purge Jobs Purge Jobs This operation purges Jobs from the Administration Jobs (Find Jobs screen). It is recommended to periodically run this Schedule in order to clean up the database and manage the number of Jobs shown in the Find Jobs screen. You can set the Expiration Days, that is, the number of days the Job details can be maintained from the Scheduled Date. All Job details before the Expiration Days are cleared. The default value is 30 days. Administration 108

110 Reporting Run Report Runs the report queries created in the Report Workbench. Scripting Run Script Executes the DCM Scripts Schedule screen tabs and sections The Schedule Details screen has six tabs Calendar tab You can define the time frame and frequency of execution of the Schedules in the Calendar tab. Administration 109 Figure 124. Calendar tab The following table explains about the Scheduling and Frequency details available in the Calendar tab. Table 19. Scheduling and Frequency Details in the Calendar Tab Label Start Date* End Date Frequency* Interval* Description Date from when the scheduled task should be executed. If you do not define a Time Frame, the scheduled task starts at the pre-defined Server time. Date up to when the scheduled task should be executed. Once the system reaches the End Date, the scheduled task stops. If you do not define a Time Frame, the scheduled task stops at the pre-defined Server time. If no End Date is entered, the Scheduled Task is executed until you stop it manually. Frequency with which the task should be performed. The available options are: ONETIME, DAILY, WEEKLY, MONTHLY Interval is used as a multiplier of frequency. For example, if the Frequency is selected as Daily and Interval as 2, it means the Schedule is executed once in two days during the scheduled period, that is, Start Date and End Date. The default value is 1 and is disabled if the Frequency is selected as ONETIME. Frequency Options Onetime This option allows you to select only the Start Date. The End Date and Interval (# of occurrences) are disabled. The Schedule is executed only once on the scheduled period, that is Start Date.

111 Administration 110 Figure 125. Frequency - One time Daily This option allows you to select all the features. Interval is used as a multiplier of frequency. For example, if the Frequency is selected as Daily and Interval as 3, the Schedule is executed once in three days during the scheduled period, that is, Start Date and End Date. Save the Schedule, click the Action icon and click Events to view the Scheduler Events, that is, when would be the Schedules executed based on the Start Date, End Date, Frequency and Interval that you have entered. If the End Date is not entered, the Schedule keeps executing until you stop it manually. Figure 126. Frequency - Daily Figure 127. Scheduler Events for Daily Frequency and Interval Weekly This option allows you to select all the features. The Week Days are displayed for selection. Interval is used as a multiplier of frequency. For example, if the Frequency is selected as Weekly, Interval as 2, and Week Days are selected, the Schedule is executed once in two weeks on the selected days during the scheduled period, that is, Start Date and End Date. Save the Schedule, click the Action icon and click Events to view the Scheduler Events, that is, when would be the Schedules executed based on the Start Date, End Date, Frequency and Interval that you have entered. If the End Date is not entered, the Schedule keeps executing until you stop it manually.

112 Administration 111 Figure 128. Frequency - Weekly Figure 129. Scheduler Events for Weekly Frequency and Interval Monthly This option allows you to select all the features. The End of Month check box is displayed for selection. Interval is used as a multiplier of frequency. For example, if the Frequency is selected as Monthly (End of Month check box cleared) and Interval as 2, the Schedule is executed once in two months during the scheduled period, that is, Start Date and End Date. Similarly, if the Frequency is selected as Monthly (End of Month check box is selected) and Interval as 2, the Schedule is executed once in two months on the last day of the month during the scheduled period, that is, Start Date and End Date. Save the Schedule, click the Action icon and click Events to view the Scheduler Events, that is, when would be the Schedules executed based on the Start Date, End Date, Frequency and Interval that you have entered. If the End Date is not entered, the Schedule keeps executing until you stop it manually. Figure 130. Frequency - Monthly

113 Administration 112 Figure 131. Scheduler Events for Month Frequency and Interval End of Month Check Box Cleared Figure 132. Scheduler Events for Month Frequency and Interval End of Month Check Box is selected Time frames The Time Frames section allows you to have a greater degree of control over task execution. Each Time Frame defines a specific period during which the task can be executed, enabled or disabled as required. To add a time frame, 1. Click Add in the Time Frames section. The application displays the Time Frame screen. Figure 133. Time Frames 2. Enter the Start Time (hh:mm 24H) and End Time (hh:mm 24H). 3. Select the Enabled check box to activate the timeframe. 4. Click OK. The time frame is created and added to the list.

114 Administration 113 Figure 134. Time Frame Screen NOTE: The 'End Time' applies only for Upload and Circuit Activation Schedules. For Upload, the system will stop processing at the time specified for End Time. For Circuit Activation, the system will deactivate the circuit(s) at the time specified for End Time. Figure 135. Time Frame Added to the List Participating items tab This tab allows you to add specific Participating Items that need to be associated with the Task and Schedule. To add the participating items to the task and schedule, 1. Click Add in the Participating Items tab. The application displays the Participating Items adding screen. The Participating Items differs as per the selected task. For more information about the Participating Items displayed for the various Tasks, see Table 20. List of Participating Items Displayed as per the Selected Task.

115 Administration 114 Figure 136. Participating Items Tab 2. Enter the search criteria, and click Search to list the available Participating Items of the selected Type. 3. Select the Participating Items, and click Select. The application adds the Participating Items to the list. Figure 137. Participating Items Adding Screen Figure 138. Participating Items Added to the List

116 Administration 115 Table 20. List of Participating Items Displayed as per the Selected Task Task Audit Log Purge Automated Task Execution Cloud Discovery Device Configuration Management Participating Items No Participating Items Project Task No Participating Items Network Element Device Configuration Device Configuration Management - Cleanup Entity Group Network Element Device Configuration Device Syslog Purge Execute Saved Queries IP Address Assignment Import Entity Layer 1 Circuit Provisioning Layer 1 - Circuit Reconciliation (Deprecated) Entity Group No Participating Items All Saved Queries Network Elements Entity Group Circuits Link Network Network Element Layer 1 - Circuit Reconciliation (NEW) View Link Network Network Element Layer 1 Facility Provisioning Layer 1- Facility Verify Layer 1 Service Group Provisioning Layer 2 Ethernet Link Reconciliation View Facilities Facilities Service Group Network Network Element Layer 2 Ethernet Service Reconciliation Layer 2 Inner VLAN Reconciliation Layer 2 Outer VLAN Reconciliation Layer 3 IP Link Reconciliation View Network Network Element Network Elements Ethernet Networks Network Network Element Layer 3 VPN Reconciliation View Network

117 Administration 116 Network Element NE Discovery NE Purge NE Reconciliation NE Upload NE Upload Data Purge NE Upload and Reconciliation Operation Log Purge Port Reservations Purge Jobs Reporting Scripting VSM Differential Sync VSM Sync Data Purge Queries section View No Participating Items No Participating Items No Participating Items Network Elements No Participating Items Network Elements No Participating Items Network Elements No Participating Items No Participating Items Script No Participating Items No Participating Items Frequently used search parameters can be saved as a Query. Queries are automatically updated with newly created objects that meet the Query s criteria. To save search parameters as a query, 1. Click Add in the Participating Items tab. The application displays the Participating Items adding screen. The Participating Items differs as per the selected task. For more information about the Participating Items displayed for the various Tasks, see Table 20. List of Participating Items Displayed as per the Selected Task. Figure 139. Participating Items Tab

118 Administration 117 Figure 140. Participating Items Adding Screen 2. Enter the search criteria. To verify the objects that meet the search criteria, click Search. If you are satisfied with the results and wish to save the search criteria as a Query, click Save As Query. The application displays the Add/Modify Query screen. 3. Enter the query name, and click Save. The query is saved and displayed in the Queries section. 4. To view/modify the Query, select the Query and click Details. The application displays the pertaining Participating Items adding screen displaying the Query parameters. The Query can be modified and saved with the original Query name, or as a new Query. Figure 141. New Query Created Configuration tab Some Tasks require additional parameters to be defined. For example, the Task Layer 1 Circuit Reconciliation (New) requires additional parameters specifying Reconciliation Mode, Data Rates, Age of Data, etc., need to be defined.

119 Administration 118 The Configuration tab is displayed when Tasks of this nature are selected for a Scheduling. Parameter Names and their default values appear in the Parameters section. To edit a parameter, 1. Select a Parameter, and click Edit, or click a Parameter. The application displays the pertaining Parameters screen. 2. Do the required changes, and click OK/Select (depending on the Parameter). Figure 142. Configuration Tab Figure 143. Editing a Parameter- Using Select Button

120 Administration 119 Figure 144. Parameter is edited Figure 145. Editing a Parameter- Using OK Button Figure 146. Parameter is edited To reset the parameter,

121 Administration 120 Select a Parameter, and click Reset. The application overwrites the defined value of the selected parameter with the default value (application defined value) for that parameter. Figure 147. Resetting a Parameter Figure 148. Parameter Value is reset to default Value The following table explains about the Tasks that require to be configured with the Parameters and their values. Table 21. Tasks that required to be configured with the Parameters and their Values Task Parameter Names Parameter Values Audit Log Purge Device Configuration Management Retention Period (# of month) [Default: 12 months] Copy to Startup (for Restoring Configuration only) [Specify true or false] Backup of Running Configuration before Restoring Configuration [Specify true or false] 12 False true Cause of the backup Syslog entity ID User No default value

122 Cloud Discovery Connector No default value ne.equipmentname Node Type ne.locationcode ne.targetid Group snmp.startipaddress snmp.endipaddress snmp.startipv6address snmp.endipv6address snmp.community snmp.username snmp.password snmp.privacy.password snmp.version snmp.v3.authentication snmp.v3.privacy.protocol snmp.v3.securitylevel No default value No default value No default value No default value No default value No default value No default value No default value No default value No default value No default value No default value No default value BOTH_2_AND_3 NONE NONE NONE Device Configuration Retention Period (# of month) [0: use 0 Management - Cleanup system setting] Import Entity Import File No default value. Layer 1 - Circuit Reconciliation (Deprecated) Delimiter Reconciliation Mode Data Rates No default value. REPORT The user can select from a list of all available data rates. More than one data rate can be selected. Administration 121 Do not reconcile if any data older than (days) 0 Exclude data older than (days) 0 Default Customer The user can select from a list of all available Customers. Only one Customer can be selected. If no Customer is selected, all Circuits will be reconciled. Layer 1 - Circuit Reconciliation (New) Reconciliation Mode Data Rates REPORT The user can select from a list of all available data rates. More than one data rate can be selected. Do not reconcile if any data older than (days) 0

123 Administration 122 Exclude data older than (days) 0 Additional Processing Script No default value. Layer 1 Facility Verify Facility Verify Mode REPORT Layer 2 Ethernet Link Reconciliation Reconciliation Mode Update Allowed VLANs (report mode) Do not reconcile if any data older than (days) REPORT NO 0 Exclude data older than (days) 0 Layer 2 Ethernet Service Reconciliation Default Customer Reconciliation Mode Update Service Parameters (report/create mode) The user can select from a list of all available Customers. Only one Customer can be selected. If no Customer is selected, all Circuits will be reconciled. REPORT NO Do not reconcile if any data older than (days) 0 Exclude data older than (days) 0 Default Customer The user can select from a list of all available Customers. Only one Customer can be selected. If no Customer is selected, all Circuits will be reconciled. Layer 2 Inner VLAN Reconciliation Reconciliation Mode Update Service Parameters (report/create mode) Do not reconcile if any data older than (days) 0 REPORT NO Exclude data older than (days) 0 Default Customer Reconciliation Mode The user can select from a list of all available Customers. Only one Customer can be selected. REPORT

124 Administration 123 Layer 2 Outer VLAN Reconciliation Update Service Parameters (report/create mode) Do not reconcile if any data older than (days) NO 0 Exclude data older than (days) 0 Default Customer The user can select from a list of all available Customers. Only one Customer can be selected. Layer 3 IP Link Reconciliation Reconciliation Mode REPORT Do not reconcile if any data older than (days) 0 Exclude data older than (days) 0 As Number(s) 0 Default Customer The user can select from a list of all available Customers. Only one Customer can be selected. Layer 3 VPN Reconciliation Reconciliation Mode REPORT Do not reconcile if any data older than (days) Exclude data older than (days) 0 0 Default Customer The user can select from a list of all available Customers. Only one Customer can be selected. NE Discovery Connector The Connector to use for discovering new Network Elements in a live Network. Connectors are defined in Admin -> XML configuration menu. ne.equipmentname This allows a user to select Network Elements having a specified Network Element naming pattern. ne.nodetype Here the user should enter the numeric Network Element Network Element Type as specified in the Admin -> CMDB -> NE menu (Adapters tab). ne.locationcode This parameter is currently not implemented. ne.targetid This parameter is currently not implemented. Group No default value.

125 Administration 124 snmp.startipaddress snmp.endipaddress snmp.startipv6address snmp.endipv6address snmp.community snmp.username snmp.password snmp.privacy.password snmp.version snmp.v3.authentication snmp.v3.privacy.protocol snmp.v3.securitylevel No default value. No default value. No default value. No default value. No default value. No default value. No default value. No default value. Both_2_AND_3 NONE NONE NONE NE Purge ne.equipmentname This allows a user to select Network Elements having a specified Network Element naming pattern. ne.nodetype Here the user should enter the numeric Network Element Node Type as specified in the Admin - > CMDB -> NE menu (Adapters tab). ne.locationcode ne.targetid This parameter is currently not implemented. This parameter is currently not implemented. Retention Period (days) 14 NE Reconciliation Reconciliation Mode REPORT Reconcile stage data created in the last (x) days Node name patterns The user can enter any number for x in order to filter which upload data (in a certain time frame) should be used for the operation. The user can enter Network Element name patterns in order to filter which Network Elements are reconciled (for example, all Network Elements with a prefix of xl ).

126 Node types Force Update of Physical Configuration on Node Types Stage data source patterns NE Upload and Reconciliation Upload Mode REPORT Force Update of Physical Configuration on Node Types Operation Log Purge Number of days to keep log entries before attempting to purge Purge Jobs Expiration Days 30 Here the user should enter the numeric Network Element Node Type as specified in the Admin - > CMDB -> NE menu (Adapters tab). The user can select from a list of available Network Elements Types to force update the physical configuration of all the Network Elements pertaining to the selected Network Element Type. The user can enter name patterns to filter which upload source (usually a server ID) should be used for the NE Reconciliation operation (for example, all upload data from a source having the name pattern toronto- ). The user can select from a list of available Network Elements Types to force update the physical configuration of all the Network Elements pertaining to the selected Network Element Type. 30 Reporting Select Report with Query No Default Value VSM Differential Sync Dependent Schedules tab Report Format Sync Stage Files Newer Than Time (Time in milliseconds from epoch) Re-calculate Service Paths This tab displays all dependent Schedules of a Parent Schedule. PDF 0 NO Administration 125 These dependent Schedules can be created with a Parent Schedule but not allowed to define a Calendar (no Start Date, End Date etc.,) as they are executed whenever a job from the Parent Scheduled is completed. Dependent Schedules can by multiple, but Parent Schedule can only be one.

127 Administration 126 Figure 149. Parent Schedule Figure 150. Dependent Schedule with a Parent Schedule Once you execute a Parent Schedule (automated/by clicking the Run Now option), its dependent Schedules are executed automatically once the Parent Schedule is completed.

128 Administration 127 Figure 151. Parent Schedule and Dependent Schedule are Successfully Executed Figure 152. Dependent Schedules displayed once the Parent Schedule Task is executed Notification tab Notification tab allows you to the result of the scheduled operation to a defined list of recipients. The recipients include, Users Contacts Groups

129 Administration 128 Figure 153. Notification Tab To add the recipients, 1. Select a recipient from the list, and click Add. The application displays the pertaining recipient selection screen. Figure 154. Select Users Screen is Displayed when Users is selected from the Recipient List 2. Select the recipients. The recipient is added to the list. Figure 155. Recipient is Selected and Added to the List Once the schedule is run the results are ed to the selected recipients.

130 Administration Jobs tab The Jobs tab displays the results of all executed occurrences of the Task with status information. These results are displayed once a Schedule is run irrespective of its result, that is, successful/failure. Figure 156. Jobs Tab Displaying Results of the Executed Tasks The following table explains about the details displayed in the Jobs tab. Table 22. Details Displayed in the Jobs Tab LABEL Job ID User Status Task Operation Type Submitted Date Processed Date DESCRIPTION ID number assigned to the Job by Trueview. User who submitted the Job request. Status of the operation. Specific task related to the operation requested. Type of the operation requested. Date of the Job request was submitted. Date of the Job request was processed Reconciliation Modes Reconciliation operates on Connectivity and Services in one of two modes: REPORT This mode reports on differences between the live network and the model. UPDATE This mode creates new Connections and Services in the model, updates existing Connections and Services in the model (regardless of whether they were system-created or user-created), and reports on all actions. Note that usercreated Services may be deleted during this mode. NE Upload and Reconciliation operates on physical Network Elements and some logical properties of Network Elements in one of two modes: Table 23. Modes and their Behavior for NE Upload and Reconciliation Operations Mode Basic Description Behavior REPORT This mode adds discovered cards to slots, if applicable, but does not automatically place the cards When a card is discovered in the network that does not match any card in the slot, the discovered card is added to the slot.

131 Administration 130 in service. No Shelves or racks are created if discovered. Its Operational Status is set to Installed/Maintenance. Its Reconciliation Status is set to In Sync. The discovered card is added as a component to the built-in NE Reconciliation Project, with a component action of Put in service. When this component action is executed, a card swap will be performed on any nonmatching In Service cards. The Reconciliation Status of any other nonmatching cards in the slot is set to Out of Sync. UPDATE This mode adds discovered cards to slots, if applicable, and automatically places the cards in service. Shelves and Racks are not created in Report mode. For In Sync cards, the NE Reconciliation Project is checked to see if identical cards exist as Components; if any are found, they are removed from the Project since they no longer need to be reconciled. When a card is discovered in the network that does not match the existing card in the slot, the discovered card is added to the slot if it does not already exist. Its Operational Status is set to Installed/Maintenance. Its Reconciliation Status is set to In Sync. The discovered card is put into service through the NE Reconciliation Project. The activation is logged in the Project history. If activation was successful, the card is then removed from the Project Components. If activation was not successful, the component action for the card changes to Manual Correction. The Reconciliation Status of any other nonmatching cards in the slot is set to Out of Sync. For In Sync cards, the NE Reconciliation Project is checked to see if identical cards exist as Components; if any are found, they are removed from the Project since they no longer need to be reconciled Action Icon options When you open a Schedule (Saved Schedule/Executed Schedule) you can see an Action icon at the top-right corner of the screen.

132 Administration 131 Figure 157. Action Icon The Action icon allows you to do the following functionalities. Table 24. Action icon commands Command Run Now Unlock/Lock Events Description Automatically selects the Enabled list value of a Schedule to Yes and unlocks the Schedule to be executed at the specified Start Date. Activates/deactivates the Schedule for execution. The Unlock option appears when the Schedule s Enabled list value is selected as Yes. Unlocking a Schedule allows the Schedule to be modified/executed at the scheduled Start Date as long as the Schedule is enabled. Opens the Scheduler Events screen where all planned occurrences of the current Schedule are listed. Figure 158. Scheduler events Running a Schedule manually A Schedule can be executed both manually and automatically. Once the Server date and time reaches the date and time as defined for the Schedule, the Schedule is executed automatically. To execute the Schedule manually, 1. Create and save the Schedule. 2. Click the Action icon, and click Run Now.

133 Administration 132 Figure 159. Running a Schedule Manually 3. The application unlocks and executes the Schedule, and displays a confirmation message. Click OK. Figure 160. Schedule is Unlocked and Executed You can see the status of the Schedule execution in System -> Jobs screen. A Job Id is created for the Schedule. Figure 161. Schedule Status Displayed in Jobs Screen Locking / modifying a Schedule An active Schedule must be locked before it can be modified. Once a Schedule is executed (manually/automatically) it is unlocked. Schedules that are unlocked (activated in the system) can no longer be modified. To modify a Schedule, it must be locked to prevent the system from executing the Schedule s Task before the Schedule is fully configured.

134 Administration 133 NOTE: All fields are disabled for an Unlocked Schedule. To modify an Unlocked Schedule, 1. Select the Schedule that has been executed from the Find Schedules screen, and click Open. Alternatively, you can also click the Schedule to open it. The application displays the Find Schedules screen. Figure 162. Find Schedule Screen Figure 163. Schedule in Unlocked Fields are Disabled from Modifying the Schedule 2. Click the Action icon, and click Lock.

135 Administration 134 Figure 164. Locking a Schedule to modify it 3. The application locks the Schedule and displays a confirmation message. Click OK. Figure 165. Schedule is Unlocked Once the Schedule is locked, all the fields are enabled for modifying the Schedule. 4. Modify the required details, and click the Save icon in the upper-right corner of the screen. Figure 166. Schedule in Locked Fields are Enabled for Modifying the Schedule Unlocking a Schedule Once a Schedule is created or modified, it changes to Locked mode until it is unlocked for processing by Trueview. To unlock a Schedule, 1. Select the Schedule from the Find Schedules screen, and click Open. Alternatively, you can also click the Schedule to open it. The application displays the Find Schedules screen.

136 Administration 135 Figure 167. Find Schedules Screen 2. Click the Action icon, and click Run Now. Figure 168. Unlocking a Schedule 3. The application unlocks the Schedule to be executed at the specified Start Date, and displays a confirmation message. Click OK. Figure 169. Schedule is Unlocked 4. Click the Save icon in the upper-right corner of the screen.

137 Administration 136 NOTE: While a scheduled Operation is running, the task status can be checked by navigating to the System -> Jobs screen and viewing the Job record that is associated with the Schedule. To view system Messages that are generated during the Operation, select the Job ID or open the Job s Detail/Configuration screen. While the Job is in progress (with a status of Processing ), the screen should be periodically refreshed until the task is completed in order to see all Messages as well as the final status. Figure 170. Task Status of the Schedule in the Job s Detail/Configuration Screen

138 Administration 137 Figure 171. Messages Generated for the Scheduled Job in the Job s Detail/Configuration Screen 4.3 Project Templates Trueview allows creation of Project to aid the Service Provider to manage a collection of entities/tasks that are involved in a specific activity or Project. Project Templates guides you through various steps/actions required for a specific Project type. When a Project is created, Tasks can be loaded from a Project Template (if one has been defined for the Project). Once you create a Project Template it is automatically applied to the new Project that you create having the same Project Type as the template, that is, when a Project for a specific type is created, the Tasks defined in the Project Template for that type are copied and displayed for the Project. Trueview allows creation of multiple Projects using a Project Template, but only one Project Template for a Project Type. TIP: You can define the Project Types in the Admin -> Interface -> Enumeration -> project.projecttype as enumerations. Creating a Project Template To create a new Project Template, 1. Click Admin -> Project Templates. The application displays the Find Project Templates screen.

139 Administration 138 Figure 172. Find Project Templates Screen 2. Click Create. The application displays the Select Project Type screen displaying the available Project Types in Trueview. TIP: You can define the Project Types in the Admin -> Interface -> Enumeration -> project.projecttype as enumerations. For more information about Enumerations, see Section Enumerations. 3. Select a Project Type, and click OK. The application displays the Project Details screen.

140 Administration 139 Figure 173. Select Project Type Screen Trueview allows creating only one Project Template for a selected Project Type. In case if you have already selected the Project Type for creating some other Project Templates, the application displays the following error.

141 Administration 140 Figure 174. Error Displayed for Selecting a used Project Type 4. Enter the Project ID. The Project Template screen has three tabs. Enter the tab details as described in Section Project Template tabs. 5. After entering the details in the respective tabs, click the Save icon in the upper-right corner of the screen. The Project Template is created and added to the list.

142 Administration 141 Figure 175. Project Template Created Project Template tabs Description tab Enter the Project Template description. Figure 176. Description Tab

143 Administration Tasks tab Create the list of Tasks to be performed that are related to a Project (this Project Template should be assigned to a Project). The assigned Workgroups and Users are automatically captured in the Project (under the Tasks tab) that you create using this Project Template. It is only in the Project where you can actually assign the Tasks to the Workgroups and Users. The objective of having this functionality is that one Workgroup may contain a number of users who can perform that Task. So if the Task is assigned to the Workgroup, any specific user can take over that Task and complete it. An example would be for a design task; the Workgroup responsible for Service Design may have 5 team-members. Any one of those team-members can take up the task, depending upon their availability. The Project Templates only contain a specific set of tasks that can be common for a particular exercise. 1. Click Add. The application displays the Add Task screen. Figure 177. Tasks Tab 2. Enter the Description. 3. Select the Workgroup and User to whom the Tasks should be available. 4. Select the Planned Start Date and Planned End Date. 5. Click OK. The Task is created and added to the list. 6. Click the Save icon in the upper-right corner of the screen.

144 Administration 143 Figure 178. Add Task Screen Figure 179. Project Task is Created and Added to the Project Template By default, new Tasks are added to the end of the current Task List. To add a new Task at a different location in the Task List, select the Task above which the new Task should be added, and add the new Task Updating Tasks To update the Tasks, 1. Select the Task from the list, and click Open. The application displays the Update Task screen. 2. Update the Task Description, and click OK. You are allowed to update only the Task Description.

145 Administration 144 Figure 180. Updating Tasks Figure 181. Update Task Screen Moving Tasks 1. Select the Task, and click Move Up or Move Down to re-arrange the order of the Task. The application displays the Move Task screen.

146 Administration 145 Figure 182. Re-Ordering the Task 2. Enter the No of steps to move up/move down, and click OK. The Tasks are re-ordered accordingly. Figure 183. Task is Re-Ordered Job Aid tab Enter the Job Aid details. Typically the Job Aid is a checklist of items to be done for a Project of this type and/or as a source of additional information.

147 Administration 146 Figure 184. Job Aid tab TIP: When you create a Circuit Reconciliation and Ethernet Service Reconciliation Project, follow the following format: Project ID = Circuit Reconciliation / Ethernet Service Reconciliation. Project Type = Circuit Reconciliation (predefined enumeration)/ Ethernet Service Reconciliation (predefined enumeration). Project Status = Open (predefined enumeration)/open (predefined enumeration). 4.4 Interface Color configuration Trueview displays the text and objects in colors to highlight the various attributes. The Color Configuration submenu allows the default colors to be changed by using a palette provided with the application. The following colors are available for selection for all the attributes. Table 25. Colors Available for the Objects/Attributes White Red Lime Blue Silver Maroon Green Navy Gray Yellow Cyan Magenta Black Orange Teal Purple The Color Configuration submenu displays the following tabs in which the attributes are grouped under a common object. General Alarms Circuits To modify the color for the attributes, 1. Click the respective tab, and select a color from the list for the attribute. 2. Click the Save icon in the upper-right corner of the screen. The color is saved to the attribute.

148 Administration 147 Figure 185. Color Changed for an Attribute The following tables display the default colors for the attributes under each tab. Table 26. Default Colors for Attributes under General Tab Object Attribute Default Color Link Unavailability Link Color Yellow Link Text Color Black Circuit Preplan Highlight Circuit Preplan Color Cyan Circuit Preplan Text Color Black Upload Discrepancy Upload Discrepancy Color Yellow Upload Discrepancy Text Color Black VLAN Paths Configured VLAN Path Color Cyan Assigned VLAN Path color Blue Graphical Cards Non In Service Card Color Yellow Table 27. Default Colors for Attributes under Alarms Tab Category Object Attribute Default Color Service Status Up Alarm Color No color Text Color Black At Risk Alarm Color Magenta Text Color White Down Alarm Color Red Text Color Black Alarm Severity Critical Alarm Color Red Text Color Black

149 Administration 148 Major Alarm Color Orange Text Color Black Minor Alarm Color Yellow Text Color Black Indeterminate Alarm Color Blue Text Color White Cleared Alarm Color Green Text Color White Table 28. Default Colors for Attributes under Circuits Tab Object Attribute Default Color Working Path Working Path Color Green Protection Path Protection Path Color Blue An example of how the Color Configuration works is shown for Circuits. Figure 186. Defined Color Configuration for Circuits Figure 187. Color Configurations Displayed for Circuit Attributes

150 Administration 149 Enumerations Enumerations are a list of items used in drop-down list boxes in various Trueview modules. The Enumerations screen allows value pairs (in the form of code: description ) to be created for custom Enumerations used in Trueview. An Enumeration item s Code is a unique value for that item. The Description is the label used to describe the code s value in a drop-down list box in Trueview screens. The following table explains about the various fields available in the Find Enumerations screen. Table 29. Enumeration Fields Label Name * Description * Enabled * System Required Parent Enumeration Description The name assigned to a collection of Enumeration items. It generally reflects the category or type of object that the Enumeration items represent. The description of the current Enumeration item. This description is displayed in drop-down list boxes that allow users to select one of several items. Determines whether the Enumeration is available for use. The available values are Yes and No. Indicates whether the Enumeration is required by the Trueview system for internal purposes. The available values are Yes and No. A value for No signifies that the Enumeration is a custom collection of user-defined values. Systemrequired Enumerations cannot be deleted. Indicates the name of another Enumeration to which the items of the current Enumeration should be applied. For example, since different Project types can have different status values, the Project Type Enumeration can be a parent for the Project Status Enumeration so that different Project status items apply to only certain Project type items. Category Enumeration An Enumeration can have only one Parent Enumeration, but a Parent can have many sub-enumerations. Signifies the name of a Category Enumeration which is used to link custom (user-defined) Enumeration Items to system-defined Enumeration Items. For example, if a custom Enumeration is defined for Project Status having the following user-defined items, In Design Design Approved In Implementation Provisioned each of those items can be mapped to the system-defined values of Not Started, In Progress, Complete or Other so that Trueview knows which custom items correlate to system items for Project Status. This is a particularly a useful option when different Project status values are applied to different Project types. The following table explains about the system-required custom Enumerations, their descriptions and any associated system category enumerations in Trueview. Table 30. List of Default System Enumerations and their Descriptions Enumeration Name Description Category Enumeration alarm.escalation Alarm Escalation

151 Administration 150 calendar.dayofweek calendar.holiday.name cfservice.servicetype classofservice.servicetype com.server.group connection.capacity cos.attribute.name ethernet.link.labels facility.dwdmchannelcounts location.locationtype project.component.action Day of Week Holiday Customer Service Class of Service Type COM Server Group Connection Capacity COS Attribute Name Ethernet Link Labels Shortcuts. The translation is not case sensitive. Number of Optical Channels Location Type Action Custom codes defined for user-defined (i.e. non-system required) Enumeration items can be used to apply custom action scripts for Project Components. Ethernet ETHER FastEthernet FE GigabitEthernet GE LoopBack LB projectcomponentactionenum- Category System-required categories are: Put In Service Remove From Service Delete Other Manual Correction project.projectstatus project.projecttype project.schedulestatus Project Status By selecting the Project Type Enumeration as a Parent for this Enumeration, different Project Status values can be applied to different Project Type Enumeration Items. Custom (user-defined) values can be linked to the system-defined projectstatus Category so that Trueview recognizes which custom values correlate to system values. Project Type This Enumeration is necessary in order to create Project objects through the Projects menu. Schedule Status Custom (user-defined) values can be linked to the system-defined projectschedulestatusenum Category so that Trueview recognizes which custom values correlate to system values. projectstatus System-required categories are: Not Started In Progress Complete Other System-required Enumeration Items are: Reconciliation projectschedulestatusenum- Category System-required categories are: Okay At Risk Completed Early Completed On Time

152 Administration 151 project.task.action project.task.status report.category view.tracelevel Task Action Task Status Custom (user-defined) values can be linked to the system-defined taskstatusenumcategory so that Trueview recognizes which custom values correlate to system values Report Category: a category within Trueview that a report will address. Report Categories may be defined for any area of the application where data may be collected and analyzed. Trace Level Completed Late taskstatusenumcategory System-required categories are: Not Started In Progress Complete Other Ready to Start Creating an Enumeration To create a new Enumeration, 1. Click Admin -> Interface -> Enumerations. The application displays the Find Enumerations screen. 2. Click Create. The application displays the New Enumeration creation screen. Figure 188. Find Enumerations Screen 3. Enter the required details. For more information about the Enumeration fields, see Table 29. Enumeration Fields. 4. Click the Save icon in the upper-right corner of the screen. The application displays an Items panel below the Details panel. 5. Add items to the Enumeration. For more information about adding items to the Enumeration see Section Adding Items to an Enumeration. 6. Click the Save icon in the upper-right corner of the screen.

153 Administration 152 Figure 189. Creating Enumeration Adding Items to an Enumeration To add items to an Enumeration, 1. Select an Enumeration from the Find Enumeration screen for which you wish add items. The application displays the Enumeration s Detail/Configuration screen (Items panel). TIP: You can also add items to an Enumeration at the time of creating an Enumeration. Once you save an Enumeration, the application displays an Item panel below the Details panel. You can add items in this Item panel. Figure 190. Find Enumerations Screen 2. Click Create. The application displays the Add/Modify Enumeration Item screen.

154 Administration 153 Figure 191. Enumeration s Detail/Configuration Screen 3. Enter the Enumeration Code and Description. 4. In the Enabled drop-down list box, click Yes to enable the item. 5. Click Save. The item is added to the Enumeration. TIP: Two or more Enumeration Items can have the same Category. Figure 192. Add/Modify Enumeration Item Screen 6. Click the Save icon in the upper-right corner of the screen.

155 Administration 154 Figure 193. Item Added to Enumeration CAUTION: System-required Enumerations cannot be deleted. Before deleting or disabling a custom Enumeration that is not required in the application, the Trueview Administrator is responsible for ensuring that one of the following conditions is met. Existing data that used the custom Enumeration should be migrated through database scripts to an appropriate new value. Existing appropriate objects that used the custom Enumeration should be deleted. After deleting or disabling a custom Enumeration, the corresponding value will no longer appear as an option in any dropdown list box. Provisioning Enumerations The Provisioning Enumerations submenu has default System Texts that are created at the time of implementing Trueview. These System Texts are displayed in the Circuit s Provisioning Status list and can be assigned to a Circuit in the course of Circuit Provisioning.

156 Administration 155 Figure 194. Default System Texts Available in Provisioning Enumerations Figure 195. System Texts are displayed in the Provisioning Status List The Provisioning Enumerations submenu also allows you to define your own Custom Text. Defining a Custom Text is similar to editing the System Text (but the original System Text is not changed), and displayed in the Circuit s Provisioning Status list. To define a Custom Text, 1. Select the System Text, and click Edit. Alternatively, you can also click the System Text. The application displays the Edit Provisioning Status Enumeration screen.

157 Administration 156 Figure 196. Defining a Custom Text 2. Enter the Custom Text, and click Save. The Custom Text is created. Figure 197. Edit Provisioning Status Enumeration Screen - Defining a Custom Text You can view the defined Custom Text by in the Circuit s Provisioning Status list. Once you define a Custom Text, the pertaining System Text values for all the Circuits are also changed. To remove the Custom Text, open the pertaining System Text, delete/clear the Custom Text, and click Save.

158 Administration 157 Figure 198. Custom Text is created Figure 199. Custom Text is displayed in the Provisioning Status List 4.5 CMDB NE types The NE Types submenu allows system administrators do the following operations: Configure Adapters (Configuration templates) for Trueview pre-defined NE Types. Create user defined NE Types and configure Adapters (Configuration templates) for the required NE Types. In Trueview, Adapters are the means by which the Trueview system communicates with live equipment; Adapters determine which operations can be performed with certain Network Elements. Trueview provides Adapters as separate files for Configuration and Discovery (Upload) functionality.

159 Administration 158 The following table summarizes the different types of Adapters that can be installed for a given Network Element in Trueview. Installing Adapters for a given Network Element in Trueview depends on the functions and modules installed in Trueview. Table 31. Adapter Types and Categories Functional Category Adapter Type Description Configuration Template Basic Network Element configuration file; must be loaded before any other file for this adapter. Provides local functionality such as Design and Assign. Activation/Provisioning Activation Provides Activation or Provisioning functionality so that service configuration data created in Trueview can be transferred to Network Elements in a live network, thereby implementing the service. Discovery Upload Provides Upload and Reconciliation functionality so that Network Elements in a live network can be discovered and synchronized with objects in Trueview. Surveillance Surveillance Provides Surveillance functionality so that alarms on a network can be detected and processed. This file can only be loaded if EVM is configured. Access Access Provides Access functionality so that commands can be executed on a Network Element. The following table explains the functions of the important buttons available in the NE Types screen. Table 32. NE Types Screen Buttons and their Functions Label Create Open Delete Install Update Uninstall Card Catalog Description Creates a new NE Type. Opens the selected NE Type. Deletes the selected NE Type. Installs an Adapter for use in Trueview. Opens the Select File window and displays the available Adapters. For more information about Installing an Adapter, see Section Configuring Adapters for Pre-defined NE types. This button is activated once an Adapter is selected. It loads all currently installed Adapter files located in the Adapter Home Directory into Trueview memory, provided that Adapter Names are not changed. During the course of a Trueview upgrade if Adapter files are renamed, the old Adapters are not updated and the new Adapters need to be installed. Refer to the Trueview Installation Guide, Release Notes, or other relevant documentation received for your upgrade. Removes the selected Adapter from Trueview. If Network Elements are created using the Adapter, a warning message is displayed asking the user to confirm whether the Adapter should be uninstalled. When NE Reconciliation runs and discovers cards that are missing a physical definition in the template, it will still create the cards in the intended slots, but it will also add these to the Card Catalog. The Card Catalog allows viewing these cards so that they can be easily added to the template Configuring Adapters for Pre-defined NE types Trueview is designed with multiple pre-defined NE Types. Initially when you enter into the NE Types screen, the pre-defined NE Types are not listed in the screen. Once you configure the adapters for the pre-defined NE Types, the NE Types are listed in the screen.

160 Administration 159 At this point of time, you cannot configure an Adapter for user defined NE Types. To configure Adapters for pre-defined NE Types, 1. Click Admin -> CMDB -> NE Types. The application displays the NE Types screen displaying all NE Types installed in the application. Figure 200. NE Types Screen - Installing an NE Type through an Adapter 2. Click Install. The application displays the Select File screen displaying the list of NE Types and their Adapters which are not yet installed. Initially you must first configure the template adapter for the NE Type before configuring any other adapters failing which the application shall throw an error message. 3. Select an Adapter. Multiple Adapters can be selected for a NE Type to configure multiple areas of functionality (for example: upload, activation, and surveillance functions). Surveillance Adapters cannot be installed if EVM is not configured. 4. Click Select.

161 Administration 160 Figure 201. Select File Screen - Selecting NE Type Adapters 5. The application displays a confirmation message. Click OK. The NE Type and Adapter is installed and added to the list. Figure 202. Success Message for Installing Adapters NOTE: After installing a NE Type adapter with Access functionality, the command privileges for the Adapter are automatically added to the Admin -> Security -> Privileges submenu and can be viewed in the NE Commands tab. The privileges are not configured automatically for User Groups. However, for User Groups to have access to the new NE command privileges, they can be made available or unavailable as required in the Privileges tab of each User Group in Admin -> Security -> User Groups submenu. Open the NE Type to view its configured adapters. The Adapters also display the Layer support capabilities, Virtual and Server capabilities. In the below example, both configured adapters supports Layer 1 capabilities, that is, you can select the Layer 1 check box (capability) for this NE Type. At this point of time there is no restriction in Trueview for selecting these capabilities. You can select any Layer capabilities irrespective of the adapter capabilities. Also, Trueview will not display Server and Virtual capabilities at this point of time.

162 Administration 161 Figure 203. Configured Adapters for Pre-Defined NE Type In case if you have not configured the required adapters for the pre-defined NE Types, you can configure the adapters later through the Adapters tab in the pertaining NE Type screen. This is explained below. 1. Select the pre-defined adapter from the list, and click Open. Alternatively you can also double-click the adapter to open it. Figure 204. Configuring Adapters for Pre-Defined NE Types 2. Click Install. The application displays the Select File screen.

163 Administration 162 Figure 205. Installing Adapters from Adapters Tab 3. Select the required adapters, and click Select. The adapters are added to the list. 4. Click the Save icon in the upper-right corner of the screen. Initially you must first configure the template adapter for the NE Type before configuring any other adapters failing which the application shall throw an error message. Figure 206. Select File Screen Selecting Adapters to be added to the NE Type Figure 207. Adapters Added to the NE Type

164 Administration Creating User Defined NE types Trueview also allows you to create your own NE Type and configure adapters for those NE Types. To create your own NE Type, 1. Click Admin -> CMDB -> NE Types. The application displays the NE Types screen displaying all NE Types installed in the application. 2. Click Create. The application displays the new NE Type creation screen. Figure 208. Creating a NE Type without an Adapter The NE Type screen is divided into two sections. The upper section allows you to add the NE details, and the bottom section to configure the NE details. 3. Enter the NE details. 4. Select the Status as Enabled to create new Network Elements based on this NE type; else this NE Type will not be listed while creating a new Network Element. You cannot delete a NE Type from the list once you create it, but can Disable an NE Type from the list while creating a new Network Element. 5. Click the Save icon in the upper-right corner of the screen. By default, the Adapters and Ports/Interfaces tabs are available in this screen. Once you save the NE type, a new Communication tab appears. 6. Configure the Ports and Interfaces as explained in section Configuring Ports / Interfaces. 7. Configure the Communication details as explained in section Configuring Communication Details. Figure 209. NE Type Screen

165 Administration 164 Figure 210. Communication Tab Appears after Saving the NE Type NE Type Capabilities Trueview allows you to create NE Types that supports Layer1/Layer2/Layer3 capabilities. The Layer1/Layer2/Layer3 check boxes are selected by default. 1. Select/clear the required Layer capabilities. This allows you to create Network Elements that supports the selected Layer capabilities. 2. Select the Virtual check box to create a Virtual NE Type. This allows you to create a Virtual Network Element. 3. Select Server check box to create a Virtual Server. This allows you to create a Network Element Type as a Virtual Server. CAUTION: You cannot create a NE Type as a Virtual NE and as a Server Configuring Ports / Interfaces You can configure Ports for Layer1 NE types only, and similarly configure Interfaces for Layer2 /Layer3 NE types only. Since at this point of time Trueview does not allow you to configure Adapters for user defined NE Types, you can define the ports in advance so that you shall use these ports when the NE Types are developed with Adapters supporting the required Shelves and Cards than in turn support these Ports that you have built in advance. The following process happens once you configure the Ports/Interfaces for a NE Type. If the NE Type has ports/interfaces defined, and when you create an instance (Network Element) based on this NE Type, the pertaining ports and interfaces are created for that Network Element. All such ports created will be Unequipped Ports, and displayed under the Physical Configuration -> Unequipped Ports tab in the Network Element. The ports will not associate to any cards. All such interfaces created will be displayed under Logical Configuration -> NE Interfaces tab in the Network Element. If the port has Ethernet signals only, and the type is Layer2/Layer3 capable; the application automatically creates interfaces when the NE is saved. The interface will be associated to the port. To configure the Ports, 1. Click the Ports/Interfaces tab. 2. Click Add Port. The application displays the Port Definition screen.

166 Administration 165 Figure 211. Configuring Ports for Layer1 NE Types 3. Select the required Signal Type, and enter the Port Definitions. 4. Click OK. 5. Click the Save icon in the upper-right corner of the screen. Figure 212. Defining Port Details Port Definition Details The Port Aid is optional. If you do not specify the Port Aid details; the Port Name is used. By default, the Name Start and Name Increment will be 1 (if not explicitly specified). When creating multiple ports use % in the Port Name. For example, if you enter the Port Definition as,

167 Administration 166 Name: TNP_Ports_1-% Count: 5 Name Start #: 1 Name Increment By: 1 Trueview creates the following Port Names. TNP_ports_1-1, TNP_ports_1-2, TNP_ports_1-3, TNP_ports_1-4, TNP_ports_1-5. To configure the Interfaces, 1. Click the Ports/Interfaces tab. 2. Click Add Interface. The application displays the Interface Definition screen. Figure 213. Configuring Interfaces for Layer2/Layer3 NE Types 3. Select the Interface Type, and enter the Interface Definitions. Figure 214. Defining Interface Details 4. Click OK Interface Definition Details By default, the Name Start and Name Increment will be 1 (if not explicitly specified). When creating multiple interfaces use % in the Interface Name.

168 Administration 167 For example, if you enter the Interface Definition as, Name: TNP_Interface_1-% Count: 5 Name Start #: 1 Name Increment By: 1 Trueview creates the following Interface Names. TNP_Interface_1-1, TNP_Interface_1-2, TNP_Interface_1-3, TNP_Interface_1-4, TNP_Interface_1-5. The following example displays how Ports and Interfaces are configured for a NE Type and how they are displayed when a Network Element is created based on this NE Type. Here a NE Type is created with L1/L2/L3 capability and Port with Ethernet Signal support. Figure 215. NE Type Created with Layer1/Layer2/Layer2 Capability Figure 216. Port is created with Ethernet Signal Support

169 Administration 168 Figure 217. Network Element is created for the NE Type Figure 218. NE Type Defined Ports are Created and Displayed under the Unequipped Ports Tab

170 Administration 169 Figure 219. : NE Type Defined Interfaces are Created and Displayed under the Interfaces Tab Configuring Communication Details You can configure the Communication attributes of the selected NE Type in the Communication tab.

171 Administration 170 Figure 220. Configuring NE Type Communication Attributes Default values for communication with equipment can be changed in the screen by entering the desired values in the relevant fields. Click Save to save the details. The following table explains about the Communication Configuration attributes. Table 33. Communication Configuration Attributes Attribute Adapter Name Network Element Node Type Transaction Package Maximum Response Time Out (ms) Default is ms Description The NE Type name is displayed here. Internal Trueview type code for the selected NE Type. This numeric value is used by some Schedules to determine which Network Element type to perform operations on. Type of Transaction Package selected to provide Access functionality. This field is displayed by Trueview when Access is configured. Maximum time the NE Type will wait for a response from the network.

172 Administration 171 Maximum Connection Retries Default is 3 Connection Retry Wait Time (s) Default is 120 s Wait Time Between Issuing Commands to NE (s) Default is 0 s Maximum Concurrent Connections to NE Default is -1 Maximum number of times the NE Type will try to establish a connection with a live Network Element. The delay between connections retries. The delay between successive commands sent to a live Network Element. The maximum number of concurrent connections allowed to the live Network Element. The default allows unlimited connections. NE configuration The NE Configuration submenu allows system administrators to configure custom Network Element Icons for Network Elements and system-wide connection pool settings NE Icons tab The NE Icons tab allows you to define and upload the custom icons into Trueview and to replace the custom icons that are predefined in the application. Once uploaded, you can assign the icons to specific Network Element types. IMPORTANT: Icon files should be a well-formatted SVG document with the extension.svg Adding a Custom Icon To add a Custom Icon, 1. Click Admin -> CMDB -> NE Configuration. The application displays the NE Configuration screen. 2. Click the NE Icons tab. 3. Click Add Icon. The application displays the Upload Icon screen.

173 Administration 172 Figure 221. NE Configuration Screen NE Icons Tab 4. Select a SVG icon from your local folder, and click Upload. Figure 222. Upload Icon Screen - Uploading a SVG Icon The SVG icon is uploaded and added to the list. The Used column will be blank if no icon is assigned to a NE Type.

174 Administration 173 Figure 223. SVG Icon Uploaded into Trueview The following table explains about the NE Icons attributes. Table 34. NE Icons Attributes Label Icon Name Thumbnail File Name Used Description Name to be assigned to the icon. A thumbnail image of the icon. Name of the SVG file to be used. A checkmark in this column indicates that the icon is assigned to the NE Type. If a NE Icon is marked as Used and you attempt to remove it; the application displays a warning message to take appropriate action. If you click Yes, delete, the NE Icon and pertaining assignments are deleted. An unused NE Icon can be deleted without any warning message. Figure 224. Removing a Used NE Icon Assigning an Icon to a Network Element Type To assign a custom icon to a Network Element Type,

175 Administration Select an unused icon from the list, and click Assign Icon. The application displays the Add Assignment screen. Figure 225. NE Icons Tab - Assigning an Icon to a NE Type 2. Select a NE Type from the list, and click Add. The Icon is assigned to the NE Type. The Used column displays a checkmark. All Network Elements created with the specified NE Type/Adapter displays this new custom icon in Trueview. Figure 226. Add Assignment Screen Assigning an Icon to a NE Type

176 Administration 175 Figure 227. Icon Assigned to the NE Type NOTE: NE Icons are assigned based on a NE Type, and each NE Type corresponds to an Adapter Name. If an Adapter Name changes for a particular NE Type and a NE Icon is assigned to that NE Type, the NE Icon is not displayed for that NE Type. To resolve this issue, ensure that the NE Type selected in the NE Icon Assignment matches the Adapter Name exactly. Trueview changes to the default system icon when a NE Icon Assignment is removed Updating a NE Icon Assignment To update an existing NE Icon with a new NE Icon file, 1. Select an icon from the list. 2. Click Update Icon. The application displays the Update Icon screen.

177 Administration 176 Figure 228. NE Icons Tab Updating a NE Icon 3. Select a SVG icon, and click Update. The NE Icon Assignment is updated with the new icon. Figure 229. Upload Icon Screen - Updating a NE Icon Figure 230. NE Icon Updated Communication tab The Communication tab displays system-wide settings for the Connection Pool. These settings can affect Trueview performance because they determine how often and how long the application tries to connect to Network Elements.

178 Administration 177 Figure 231. Communication Tab The following table explains about the Communication tab parameters and their default values. Table 35. Communication Pool settings Parameter Default Max. Connection Wait Time (seconds) 10 Min. Connection Idle Time (seconds) 30 Connection Idle Check Time (seconds) 5 To update the parameters, change the parameter values, and click Save. Rules This Rules submenu allows you to enable/disable certain Rules which impact the way Trueview behaves with Service objects. The Rules are categorized under three tabs. To enable a Rule, 1. Click the respective tab, and select the Rule under the appropriate category. 2. Click the Save icon in the upper-right corner of the screen. Figure 232. Facilities/Circuits Rules

179 Administration 178 NOTE: You can share the Facility Channels by selecting the Disallow sharing the facility channel checkbox. If the checkbox is selected, Circuits can share Facility Channels, but the system ensures that only one Circuit can be active on a given Channel at any particular point of time. Circuit objects can be copied so that the copied Circuit has the same Channel as the original Circuit. If the Disallow sharing the facility channel checkbox is cleared, however, Circuits can be copied, but the copied Circuit will need to be manually or automatically assigned to a different Facility Channel. Figure 233. Links Rules Figure 234. Network Rules Number management The Number Management menu has two tabs.

180 Administration 179 Number Pools Telephone Number These are explained below Number Pool Select the Undefined IPv4 Address Pool Enabled For User Input checkbox to activate the Undefined IPv4 Address Pool, that is, to enable the saved discovered IPv4 addresses. If not enabled, they are dropped. The other Pool Enforcement options are not yet implemented in the current version of Trueview. Figure 235. Number Management Configuration for Number Pools Telephone number The Telephone Number tab allows you to configure specific settings pertaining to TN Pools and Telephone Numbers in Trueview s CMDB module. For more information on TN Pools and Telephone Numbers, refer to the Trueview User Guide Configuring Telephone Number parameters To customize system parameters for TN Pools and Telephone Numbers in Trueview, 1. Enter the required details as explained in Table 36. Telephone Number Management Configuration Details. 2. Click the Save icon in the upper-right corner of the screen.

181 Administration 180 Figure 236. Telephone Number Management Configuration Table 36. Telephone Number Management Configuration Details Field Pool Enforcement Query Result Limit Short Term Aging (minutes) Long Term Aging (days) Refresh Period (seconds) Ported-In Telephone Number Pool Name Telephone Number Format Description The Pool Enforcement option is not yet implemented in the current version of Trueview The maximum number of Telephone Numbers that should be returned when searching for Available numbers in the CMDB -> Telephone Numbers -> Find Available screen. If required, you can change the Return Count value to a lesser value in the Find Available screen Numbers returned by searches in the CMDB -> Telephone Numbers -> Find Available screen must be assigned before this timeout period expires, or they will revert from Pending Assigned state back to Available state. Numbers that reach the Reservation Expiry Date enter this aging period. When querying numbers, this indicates the number of seconds the automatic aging thread should wait before the next cycle. The name of the default TN Pool created for unsubscribed Telephone Number(s) that have been ported into the system. This represents the default format used for Telephone Numbers generated from a TN Pool. This field supports non-numerical characters. CoS (Class of Service) In Trueview a CoS object represents performance assurances. The Bandwidth Profiles assigned to the CoS are used to calculate the capacity of Service-carrying Links in a Trueview Service. In order to apply a CoS to a Service, the Link Capacity Management must be enabled in the Admin -> CMDB -> Capacity screen. For more information about assigning Bandwidth Profiles/CoS objects to Ethernet or IP VPN Services, refer to the Trueview User Guide. For more information about enabling Link Capacity Management, see Section Capacity, and for information about creating Bandwidth Profiles see Section Bandwidth profile

182 Administration Create a CoS To create a CoS, 1. Click Create in the Find Classes of Service screen. The application displays the CoS creation screen. Figure 237. Find Classes of Service Screen 2. Enter the CoS Name. 3. Click the Save icon in the upper-right corner of the screen. The application enables the CoS sections. 4. Configure the CoS parameters as explained in Section , CoS Parameters. 5. Click the Save icon in the upper-right corner of the screen CoS Parameters The CoS creation screen is divided into the following three sections: Applicable Service Types Class of Service Attributes Bandwidth Profile Templates All CoS sections are enabled once you enter and save the CoS name.

183 Administration 182 Figure 238. CoS Parameters Applicable Service Types This section allows you to assign CoS to the Service Types. The available Service Types are ELINE, ELAN, ETREE and IP VPN. To assign CoS to the Service Types, 1. Click Add in the Applicable Service Types section. The application displays the Select Service Type screen.

184 Administration 183 Figure 239. Applicable Service Types 2. Select the Service Types, and click OK. The CoS is assigned to the Service Types. Figure 240. Select Service Type Screen Figure 241. CoS Assigned to the Service Type Class of Service Attributes This section allows you to assign CoS to additional attributes (such as jitter, priority, delays etc.). If required, these attributes can be used for informational purposes. To assign CoS to Additional Attributes,

185 Administration Click Add in the Class of Service Attributes section. The application displays the Select Attribute Name screen. Figure 242. Class of Service Attributes 2. Select the Attribute Name, enter the Attribute Value, and click OK. The CoS is assigned to the Additional Attributes. Figure 243. Select Attribute Name Screen Figure 244. CoS Assigned to Additional Attribute NOTE: If no value appears in the Attribute Name drop-down list, a cos.attribute.name Enumeration item must be created in the Admin -> Interface -> Enumerations submenu. For more information, see Section Enumerations Bandwidth Profile templates This section allows you to assign CoS to Bandwidth profiles. Bandwidth Profiles must first be created in the Admin -> CMDB -> Bandwidth Profile submenu. Multiple Bandwidth Profiles can be added to a CoS object. When the CoS object is later applied to an ELINE, ELAN or IP VPN Service, one of the Bandwidth Profiles can be selected as the Ingress Bandwidth Profile while the other serves as the Egress Bandwidth Profile. To assign CoS to Bandwidth Profiles,

186 Administration Click Add in the Bandwidth Profile Templates section. The application displays the Select Bandwidth Profile Template screen. Figure 245. Bandwidth Profile Templates 2. Select the Bandwidths, and click OK. The CoS is assigned to the Bandwidth Profiles. Figure 246. Select Bandwidth Profile Screen Figure 247. CoS Assigned to Bandwidth Profile Capacity Link Capacity management This Capacity submenu allows you to enable the Link Capacity Management so that CoS objects can be applied to Service objects such as ELINEs, ELANs or IP VPN Services in Trueview. Selecting the Link Capacity Management Enabled option

187 Administration 186 as Yes enables additional tabs and fields to appear for Ethernet Links, Ethernet Services and IP VPN Services so that CIR and EIR Thresholds can be calculated based on Link Capacity as well as the Bandwidth Profiles configured for the Class Of Service. The Link Capacity Management Defaults section specifies the default CIR & EIR allocations as well as CIR & EIR Thresholds for all Ethernet Links in Trueview. These default values can be manually overridden by changing the values on the Capacity Management tab of an individual Ethernet Link. For more information, refer to the Trueview User Guide. To configure Link Capacity Management Defaults, 1. Select the Link Capacity Management Enabled option as Yes. 2. Enter the default values for the various fields displayed. 3. Click the Save icon in the upper-right corner of the screen. NOTE: At this time, Capacity cannot be configured for individual IP Links. If an IP Link is riding on top of Ethernet Link(s), the Capacity provided by the Ethernet Link(s) determines the IP Bandwidth rate. Figure 248. Link Capacity Management Configuration Defaults NOTE: Changes to the default CIR/EIR allocation will trigger CIR/EIR consumption calculation on ALL Ethernet links taking one/both of these default values.

188 Administration 187 Figure 249. Capacity CoS Objects Displayed under Capacity Management Tab for L2 Ethernet Link The following table explains about the Ethernet Link Capacity Attributes required to manage the capacity consumed by a service (EVC). Table 37. Ethernet Link Capacity Attributes Field Description CIR Allocation Allocated CIR as a percentage of the capacity. Value can be greater than 100%. Only those links that have CIR Allocation defined can participate in capacity calculation as bandwidth profiles are assigned to services. For example, a link with capacity=10m, CIR Allocation=50% resembles an allocated CIR=10*50%=5M. EIR Allocation Allocated EIR as a percentage of the capacity. Value can be greater than 100%. CIR Threshold Minor CIR Threshold Major CIR Threshold Critical EIR Threshold Minor EIR Threshold Major EIR Threshold Critical Only those links that have CIR Allocation defined can participate in capacity calculation as bandwidth profiles are assigned to services. For example, a link with capacity=10m, EIR Allocation=200% resembles an allocated EIR=10*200%=20M. Minor threshold for CIR Consumed expressed as a percentage of allocated CIR bandwidth. A threshold value of zero means there is no threshold. Major threshold for CIR Consumed expressed as a percentage of allocated CIR bandwidth. A threshold value of zero means there is no threshold. Critical threshold for CIR Consumed expressed as a percentage of allocated CIR bandwidth. A threshold value of zero means there is no threshold. Minor threshold for EIR Consumed expressed as a percentage of allocated EIR bandwidth. A threshold value of zero means there is no threshold. Whenever a link is being saved and if the EIR consumed crosses this threshold, an event is sent to EVM and the user is notified. Major threshold for EIR Consumed expressed as a percentage of allocated EIR bandwidth. A threshold value of zero means there is no threshold. Whenever a link is being saved and if the EIR consumed crosses this threshold, an event is sent to EVM and the user is notified. Critical threshold for EIR Consumed expressed as a percentage of allocated EIR bandwidth. A threshold value of zero means there is no threshold. Whenever a link is being saved and if the EIR consumed crosses this threshold, an event is sent to EVM and the user is notified.

189 Administration NFV Capacity management The NFV Capacity Management is used define the Thresholds for Servers and Virtual Machines configured to receive System level threshold updates. Bandwidth profile The Bandwidth Profiles submenu allows you to configure Bandwidth Profiles in order to monitor the capacity of Servicecarrying Links, provided that the Link Capacity Management is enabled in the Admin -> CMDB Capacity submenu. In Trueview, Bandwidth Profiles are assigned to CoS objects which represent performance assurances for a Service. When the CoS object is assigned to an Ethernet Service (e.g. ELAN, ELINE) or an IP VPN Service in Trueview, the Bandwidth Profiles are used to calculate the capacity of the Service-carrying Links or of traffic-conditioning Nodes and to determine whether the service expectations have been met. In Trueview, Bandwidth Profiles can be applied at the Service level or at the Node level for Layer 2 Services, depending on a Provider s needs, but not at both levels. For Layer 3 IP VPN Services, Bandwidth Profiles can only be applied at the Service level Creating a Bandwidth Profile To create a Bandwidth Profile, 1. Click Create in the Find Bandwidth Profiles screen. The application displays the Add Bandwidth Profile Template creation screen. Figure 250. Find Bandwidth Profiles Screen 2. Enter the Bandwidth Profile details as explained in Table 4-23: Bandwidth Profile Details. 3. Click the Save icon in the upper-right corner of the screen. The Bandwidth Profile is created and added to the list.

190 Administration 189 Figure 251. Bandwidth Profile Template Screen Figure 252. Bandwidth Profile Name Auto Generated Table 38. Bandwidth Profile Details Label Name CIR * CBS * EIR * Description Name assigned to the Bandwidth Profile. You can specify the name or auto-generate a name by entering the required parameters and clicking the Generate Name button. Committed Information Rate, in Mbps: the average rate up to which services frames are delivered as per service performance objectives. Committed Burst Size, in MB: the maximum number of bytes allowed for incoming service frames to still be CIR-conformant. Excess Information Rate, in Mbps: the average rate up to which excess service frames are still admitted into the provider s network.

191 Administration 190 EBS * Coupling Color Aware Excess Burst Size, in MB: the maximum number of bytes allowed for incoming service frames to be EIR-conformant. Yes/No. When UNIs are Color Aware, the Coupling parameter allows the choice between two modes of operations of the rate enforcement algorithm and has the effect of controlling the volume of yellow service frames admitted to the network. Yes/No. Indicates whether the UNI (PE Port) is operating in Color Aware mode, recognizing color indications in service frames in order to make rate enforcement decisions. For more information about a Bandwidth Profile to a CoS object, see Section Bandwidth Profile templates Import The Import submenu allows you to import various entities into Trueview through an import file. This process helps to import large volume of data (entities) into Trueview instead of creating them manually which consumes lot of time. Trueview allows you to import the following entities into Trueview. Customer Location NE NE Location NE TCP Account The entity files are predefined with a certain syntax and structure. For more information about the Entity Files Syntax contact the Trueview Administrator. To import the entity files, 1. Click Admin -> CMDB -> Import. The application displays the Import Entity screen. 2. Select the Import File (Entity File) from your local folder. 3. Select the Delimiter used to separate the fields in the file. The available options are Tab/Comma/Custom. 4. Enter the Custom Delimiter. This field is available if you select the Delimiter as Custom, please ensure that your do not enter = (equal sign) / (vertical bar) / ^ (caret) symbols as Custom Delimiters. 5. Enter the Group for any Import NE to assign the NE s (imported as entities) to this group. 6. Click Import. The application creates a Request and initiates the JOB queue. Figure 253. Sample Entity File for Customer Type Import Entity

192 Administration 191 Figure 254. Import Entity Screen Figure 255. Import Entity Request Creation Message Figure 256. Job Queue Creation for the Import Entity 1. Click the Job ID to view the Import Entity details.

193 Administration 192 Figure 257. Job Details for Import Entity Job Parameters Figure 258. Job Details for Import Entity Job Participating Items and Messages If successfully imported, the entities are displayed in the pertaining screen.

194 Administration 193 Figure 259. Successfully Imported Entities Displaying in the Pertaining Screen 4.6 Notifications Through Notifications menu you can configure the SMTP Server details in Trueview to send to the users. You can also setup events to send notifications to the users/contacts/groups. Figure 260. Notifications

195 Administration 194 configuration In Trueview, you can send to users in the following scenarios: System events (login) Entity events (creation of a network element) Scheduled events (at the completion of a scheduled job) the results of a search the data gathered by scheduled events (Execute Saved Queries) All s which are sent to the users for the above scenarios are hardcoded in Trueview. In some cases, there are also attachments like Reports and Excel output from saved queries (Schedules). To to the users, you need configure a valid SMTP server in Trueview which is capable of sending s. To configure the Server: 1. Click Notifications -> Configuration. The application displays the Server Configuration screen. Figure Server Configuration Screen 2. Click Add. The application displays an Server Configuration section below. 3. Enter the server configuration details as explained in Table 4-24: Configuration Server Details.

196 Administration 195 Figure Server Configuration Section 4. Click Save. The configuration server details are created and added to the list. Figure Configuration Server Created Table 39. Configuration Server Details Label Name* Server Host* Description Server Configuration name. The SMTP Server to which Trueview has to connect.

197 Administration 196 Server Port* The SMTP Server Port to which Trueview has to connect, typically 587 or 465 for SSL. From Account* The address to specify as the From account in the s. Authorization Select this checkbox if you want TNP to perform a Login when Required connecting to the SMTP server. This depends on the server you want to connect with. Generally, servers are configured for authorization. Username User name for authentication/authorization with SMTP server. Password Password for authentication/authorization with SMTP server. Use SSL Select this checkbox to create a SSL socket. If you select this checkbox, the Server Port has to be the SSL port number. Active Configuration Select this checkbox to configure this Server as default for sending notifications, in case if you create multiple configurations. Events configuration You can also set up events to send notifications to the users/contacts/groups. To configure Events Notifications: 1. Click Notifications -> Events Configuration. The application displays the Events Configuration screen. Figure 264. Events Configuration Screen 2. Click Add under the Events section. 3. The application displays the Event Configuration details screen. 4. Select the event Category. The application displays its pertaining events. For more information about the Event Categories, see Table 40. Event Categories. 5. Select the Events, and click OK. The events are added to the list.

198 Administration 197 Figure 265. Events Configuration Details Screen Table 40. Event Categories Event Category System Event Entity Event Scheduled Event Provisioning Event Miscellaneous Event Events Purpose These are Events such as Login/Logout/Server Shutdown/Server Start The Events supported for entities are CREATE and DELETE. The list of entities that currently support these events are: Network Elements, Element Managers, Facilities, Circuits, Ethernet/IP links, Ethernet/IP services, Networks, Customers, CF Services, Locations, Projects, Service Requests, Tickets, Views, Contacts, Users and Groups. All Scheduled Tasks (except Execute Saved Queries and Reporting) are supported. Basically, the application sends an to the configured users when a job instance for the particular schedule type is finished (regardless of the status). The reason Execute Saved Queries and Reporting are not supported is because these two types of tasks send s of data gathered by them as attachments - so sending another at the completion of the job is not required. Currently not supported. Currently not supported. The next stage is to configure the target audience for the events where you shall define the list of users/contacts/groups who should receive an notification for the particular event. To do this, 6. Select an Event in the Events section. 7. Select a Recipient Type from the list in the Event Audience section. 8. Click Add. The application displays the pertaining selection screen.

199 Administration 198 Figure 266. Events section 9. Enter the search criteria, and click Search. Alternatively, you can also click Search without entering any search criteria to list the available Users/Contacts/Groups in the application. 10. Select the Users/Contacts/Groups, and click Select. The Users/Contacts/Groups are added to the Events. Figure 267. Select Users Screen - Selecting the Users to Configure with the Events

200 Administration 199 Figure 268. Users/Contacts/Groups Configured to the Events 4.7 System The Admin -> System menu option provides access to system-level configuration parameters and allows administrative users to configure Parameters, Home Directories for System Components, Event Handlers for objects in Trueview, User- Interface Settings, Authentication Information, Rules, Job scheduling, Reconciliation Settings, Workflow Engine Settings, Language Settings, Syslog, Service Management and Document Management. The System-Level configuration parameters are grouped under various tabs. After entering the Setting details, click the Save icon in the upper-right corner of the screen for the changes to take effect. Figure 269. System Configuration Grouped Under Various Tabs Parameters tab The Parameters tab allows you to configure the following settings.

201 Administration 200 Table 41. Parameter Tab Configuration Settings Parameter Password Encryption Visual Key Cache Size Description Indicates whether password encryption is enabled or not. When displaying data in grids, the Visual Key Cache Size determines how much data is retrieved from direct database lookups and how much is retrieved from the memory cache. The cache is built up from previous database lookups and therefore results in a faster display of data grids. The Visual Key Cache Size determines the maximum number of visual keys to be kept in memory before clearing the cache and building it up again. Although a larger size helps to speed up performance, it may not always reflect the latest updates made to the database. Visual Key Expiry (minute) The default value is This may be tuned depending on the volume of the data being processed, as well as whether Trueview is being used in a clustered environment. Determines the Visual Key expiry minutes. Web Services Timeout (seconds) Web Services URL This is the amount of time before a function call to Trueview s ESI Web Service times out. This is the URL for executing function calls to Trueview s ESI Web Service. The standard value is: <Trueview server host:port>/tnp-ws DCM External Web Services URL(*) Enter the URL for executing external function calls for DCM automation. e.g.: < File Transfer Technology FTP/TFTP Host IP FTP Username FTP Password No of months of Running Config to Keep No of months of OS File to Keep The expected function is AccessNetworkElement (NE, Command) The File Transfer Technology. Available values are TFTP/FTP/SFTP/SCP. Select TFTP/FTP for DCM operations. The IP address of the TFTP/FTP server. Username to logon to FTP server (Not applicable to TFTP server). Password to logon to FTP server (Not applicable to TFTP server). Defines the number of month to keep the backed up Configuration file. These values are used by the Scheduler Operations "DCM - Cleanup Running" & "DCM - Cleanup OS" to perform scheduled request. Defines the number of month to keep the backed up OS file.

202 Administration 201 Inventory Notification URL Triggers an Inventory Sync notification to the specified URL when the following objects/instances are created/deleted/modified in Trueview. Network Element Facility Circuit Link ELINE ELAN ETREE IPVPN Customer Generic Network Element Customer Facing Service Location Network Alarm Monitoring On Enabled Ports Only (***) Maximum Refresh Delay on Failure (minutes) If this check box is selected, Trueview will only notify the EVM server of enabled Ports consequently, EVM will only collect alarm data for the enabled Ports. Alarm data for all other Ports will be discarded by EVM. As Facilities are enabled/disabled in Trueview, the Status of the Ports changes, so Trueview notifies EVM whether to collect or discard the alarm data for those particular Ports. If EVM & Alarm Management is included in your license agreement, this setting allows the Trueview Administrator to configure the interval for automatically refreshing the graphical display in the event of errors during alarm retrieval. The recommended default value is 720 minutes (12 hours), but this value can be changed depending on a customer's environment. In the event of an error during refresh, Trueview will double the alarm refresh interval until it reaches the maximum value (in this case: 720 minutes). If Trueview succeeds in retrieving alarms during this process, the screen is refreshed, and the refresh interval is set back to the original alarm refresh interval. Sorting Limit (Maximum # of Records) If alarm retrieval keeps failing due to database or network issues, Trueview will display an error message after the maximum value of 720 minutes is reached. The screen will continue to refresh at the 720-minute interval until the refresh is manually disabled or successfully completed. All errors will be logged in the log file. Sorting Limit (Maximum # of Records)

203 Administration 202 Google Maps API Key Google Maps Premier API (Client ID) Google Maps Default Country Google Maps Icon URL Specifies the API key obtained from Google. A Google Maps API Key can be obtained by going to and logging in to your Google account. Create a project. From the Services tab, choose Google Maps API v2. This is an alternative to the Google Maps API Key listed above. It uses a Client ID as well as authorized URLs to provide access to the Google Maps API for Business. See: uide Specifies which country s map to display first when Google Maps is loaded on the relevant Map screens in Trueview. Specifies the URL of the icon to use for the Google Maps Location pin. Browser Log Level User Operation Log This field is used for browser debugging purposes. For more information, please contact OSS Support. Sorting Limit (Maximum # of Records) Directories tab The Directories tab allows you to configure the application configuration directory where system components can be found in the WebLogic server. Only the Application Config Directory field can be modified; the remaining fields are pre-configured based on the value of the Application Config Directory field. If the Application Config Directory is changed, save the new value by clicking the Save icon and then click the Refresh icon in the upper-right corner of the screen to update the remaining pre-configured fields. A server restart is required for the changes to take effect.

204 Administration 203 Figure 270. Directories Tab Event Handlers tab The Event Handlers tab allows you to configure custom event-handler scripts for system components. The scripts are injected into certain points of an object s life cycle. Custom handlers can be defined for the following object types: Network Elements, Facilities, Circuits, Links, Multipoints (ELAN and IP VPN Services), Connections (i.e. Physical Connections), Customer Services, Process, Service Requests and Tickets. Examples of functions that custom scripts could execute are: to generate the name of an object based on other values entered, or to validate fields before an object is saved. Scripts should be written in the BeanShell scripting language and must be written in a file named with the following convention: <ObjectType>EventHandler.bsh where <ObjectType> is one of the allowed objects listed above. For each object type, one file should be used to handle all events (Pre-Create, Pre-Update, etc.) to which custom scripts should be applied. The file should be stored in the eventhandling directory of the release files received for installation. Enter the following fully qualified class name into the text box associated with the event type(s) you wish to handle. This class handles the execution of the script(s). com.tieroneoss.tnp.eventinjection.tr1eventhandlerbsh

205 Administration 204 Figure 271. Event Handlers Tab User Interface tab The User Interface tab allows you to configure the User Interface Style, Browser Title, Login Logo and Header Logo for Trueview. It also allows defining the default display state for the Graphical Groups. There are several built-in User Interface Styles: Original (Default) Green Blue Purple Red Orange Custom Advanced Custom To change a built-in User Interface Style, 1. Select a value from the User Interface Style list. 2. Click the Save icon in the upper-right corner of the screen. 3. Log Off from the application, clear the browser cache and refresh the browser. 4. Log On to the application to see the new User Interface Style. The Title field allows an administrator to customize the browser title or tab name that appears when a user opens Trueview in their browser. The default setting is Trueview. To change the Title: 1. Enter the new Title. 2. Click the Save icon in the upper-right corner of the screen.

206 Administration Refresh the browser by clicking the browser s refresh button. The browser s title is changed. Figure 272. Changing the Browser Title Figure 273. Browser Title Changed When a different logo is required or a color not included in the built-in styles, it is necessary to create a custom skin consisting of a login logo, header logo, custom.css file for styles and a favorite icon to be displayed by the browser. If you select Custom from the User Interface Style list, Trueview will automatically look for the following files in the received installation files. You cannot modify these files as these values are pre-configured. /tnp-custom/login_logo.html /tnp-custom/header_logo.html Figure 274. Trueview Looking for Custom Styles

207 Administration 206 Whereas if you select Advanced Custom from the User Interface Style list, Trueview will automatically look for the following files in the received installation files. You can modify these files as required. If Advanced Custom is selected from the User Interface Style list, the path and file-name conventions used in the Custom option do not necessarily need to be used. This option is recommended if it is not possible to deploy a tnp-custom.war file. The Login Logo, Header Logo, CSS Path and Favorite Icon fields can be modified in the User Interface tab to make use of custom skin files which may be located in different directories. /tnp-custom/login_logo.html /tnp-custom/header_logo.html /tnp-custom/custom.css /tnp-custom/favicon.ico Figure 275. Trueview Looking for Advanced Custom Styles Consequently, a.war file ( tnp-custom.war ) that contains these files must be deployed in the Trueview server in the relevant custom directory for Trueview to search and locate these files. For more information, refer to the Trueview Installation Guide or Trueview Release Notes. Authentication tab The Authentication tab allows you to configure the Authentication Level, Server and Port used for LDAP authentication. The Authentication Level determines whether TNP authenticates users based on LDAP and internal security mechanisms only, or whether external role-based systems are included in the authentication process. The default option is TNP Security Only (Default) and indicates that an LDAP will be used to verify user accounts. The TNP Security and External Roles option should be selected if there is a possibility that some users will not to be explicitly created in Trueview and will be primarily authenticated using an external role-based system. To view the LDAP Server Information, 1. Click the Server. The application displays the LDAP server details below. 2. Modify if required. 3. Click the Save icon in the upper-right corner of the screen. The application saves the new settings.

208 Administration 207 Figure 276. Authentication Tab Opening a Server Figure 277. Server Details NOTE: Please ensure that the Authentication Level and Server Settings configured in this screen are aligned with the Security Realm and Authenticator Settings configured in WebLogic. Otherwise, users may receive authentication error messages when they attempt to logon and be denied access to the application. For more information about Security Realms in WebLogic, refer to the relevant WebLogic documentation. Scheduling tab The Scheduling tab allows you to configure settings for Trueview s Job Controller and Scheduler. The Job Controller Threads field determines how many tasks the Job Controller can process simultaneously in Trueview s Administration module. The number of Retries, Idle Time, and Wait Time can also be configured in this tab. In an environment where multiple Trueview servers are used, the Job Controller User field can be used to partition Jobs among servers. This field specifies the user ID of the User who has privileges to run Jobs on objects assigned to a specific Domain. Based on this field value, the Trueview server where the Job Controller is running will only execute those Jobs that the Job Controller User has privileges for. If no value is specified for this field, the server will execute Jobs regardless of the user who initiated the Job. For more information about User Privileges, see Section Privileges tab.

209 Administration 208 Figure 278. Scheduling Tab Reconciliation tab The Default Discovered NE Operational Status field allows a Trueview Administrator to set the system default value for Network Elements newly created by the NE Reconciliation or NE Discovery Schedule. Figure 279. Reconciliation Tab Languages tab In addition to English, Trueview can accommodate up to three Unicode-supported (UTF-8) languages written from left to right. NOTE: To support Unicode UTF-8 languages, the Oracle Database Character Set should be set to AL32UTF8 during installation, or the PostgreSql Database Character Set should be set to UTF-8. Depending on your license agreement, two Language Pack files and a separate stand-alone tool may be provided during deployment to assist you in loading Language Packs into Trueview: LangImp.exe: this application loads a completed Language Pack spreadsheet (.xls) into Trueview. LangPack_Dict.xls: this is a pre-formatted spreadsheet representing a Dictionary Language Pack. Dictionary Language Packs provide translations related to the Trueview GUI (i.e. form labels, drop-down lists, menu items, etc.). Up to three additional columns for multiple left-to-right language translations are provided in the spreadsheet. They can then be filled out by a translation service provider; subsequently, the spreadsheet can be loaded into Trueview using the LangImp tool. LangPack_Msg.xls: this is a pre-formatted spreadsheet representing a Message Language Pack. Message Language Packs provide translations related to error messages and exceptions. Up to three additional columns for multiple left-to-right language translations are provided in the spreadsheet. They can then be filled out by a translation service provider; subsequently, the spreadsheet can be loaded into Trueview using the LangImp tool. NOTE: Both Language Pack files and the LangImp tool can be found under the release/utils/langpack directory of the distribution files received for installation.

210 Administration 209 Once Language Packs are loaded and configured, users can select their desired language setting from the Languages tab in the Admin -> Security -> User Config submenu. Figure 280. Languages Tab in the User Configuration Submenu For more information about how to load a Language Pack into Trueview, see Section Loading a Language Pack with the LangImp Tool. For more information about how to configure default language and supported languages for Trueview, see Section , Configuring Default and Supported Languages. NOTE: At this time, no right-to-left languages are supported. If English is the only required language in Trueview, no Language Packs need to generated or loaded Loading a Language Pack with the LangImp Tool The LangImp tool (short for Language Import ) is used to load Language Packs quickly into Trueview. Language Packs are provided in the form of.xls spreadsheets. They can then be translated by translation service providers. The LangImp tool is used to load either type of Language Pack into Trueview. If multiple.xls Language Packs are loaded at the same time, the second.xls file updates the first.xls file. Due to the caching properties of Trueview s translation engine, Language Packs should be loaded when the Trueview server is offline. If Language Packs are loaded while the system is running, please restart the application after the loading procedure has completed. To support Unicode UTF-8 languages, the Oracle Database Character Set should be set to AL32UTF8 during installation, or the PostgreSql Database Character Set should be set to UTF-8. Trueview s translation engine uses the Language Packs to translate screen elements such as labels, buttons, and error messages only. Data entered into the system is not translated; this data is stored in the Trueview database in whichever language was used to input it. Due to LDAP authentication properties at this time, usernames and passwords must be entered into the system in English. Excel spreadsheets with an.xls extension are currently the only supported file type for loading a Language Pack. Installation LangImp is designed to run on a Windows platform (Windows XP, Vista, and Windows 7). The LangImp application may be installed to any directory by simply unzipping the file LangImp.zip. Once unzipped, a new directory called LangImp will be created. The application with a name Langlmp.exe resides within this directory. To execute the LangImp application,

211 Administration Using a computer with the Windows Vista or Windows 7 operating system, click the Windows button and type cmd in the field labeled Search programs and files. 2. In the command-prompt window, use the cd command to navigate to the directory where the LangImp.exe application is located. For example: assuming that the LangImp.exe application is located in a folder entitled LanguagePackLoader in your C:/ hard drive, type: cd C:/Tools/LanguagePackLoader 3. Then execute the application by typing its name and using the command-line switches described below. For example: LangImp.exe dict ip myoracle.db.com port 1521 oraclesid orcl uid MyID passwd MyPasswd xlsfiles C:\LangPack_Dict.xls 4. Once the Language Pack is loaded configure the default and supported languages for Trueview through the Languages tab in the System Configuration screen. For more information, see Section , Configuring Default and Supported Languages. Command Line Switches The runtime behavior of the LangImp application is controlled by command-line switches. The following supported switches provide the indicated behavior. Table 42. LangImp command-line switches Switches -dict -msg -ip -port -oraclesid -postgresqlsid -uid Behavior Specifies the translation mode which is to be used (i.e. either Dictionary or Message ). Specifying -dict (Dictionary mode) instructs the application that only the Dictionary Translation table(s) should be loaded, whereas specifying -msg (Message mode) instructs the application that only the Message Translation table(s) should be loaded. Specifies the IP Address or host name of the database server. Specifies the port which is listening for incoming connections to the database server. Specifies which database (Oracle or Postgresql) is to be connected to, as well as the SID. Specifies the User ID when making a connection to the database server.

212 -passwd Specifies the password for the User ID when making a connection to the database server. -trunc An optional parameter which specifies that data in the existing Translation table(s) should be purged before loading any new translations. The exact tables which are purged are dependent upon the translation mode which has been selected (i.e. -dict or -msg). -xlsfiles Specifies the path(s) and file name(s) of all.xls files which are to be parsed and loaded into the database server. The.xls files which are specified should match the translation mode which has been selected (i.e. -dict or -msg). -v Displays version information for the application. Administration 211 NOTE: If a command-line switch value contains white space, it will be parsed as multiple switch options. To include whitespace within a single switch option, be sure to enclose the option in double quotation marks. Additional Examples 1. Executes the LangImp application in Dictionary Mode for an Oracle database server. The Dictionary-based.xls file which is loaded is C:\LangPack_Dict.xls. LangImp.exe dict ip myoracle.db.com port 1521 oraclesid orcl uid MyID passwd MyPasswd xlsfiles C:\LangPack_Dict.xls 2. Executes the LangImp application in Message Mode for a Postgresql DB Server. The Message-based.xls file which is loaded is C:\LangPack_Msg.xls. All data in the Message Translation table(s) is truncated before loading any translations from the file C:\LangPack_Msg.xls. LangImp.exe msg ip mypostgresql.db.com port 5432 postgresqlsid postgresql uid MyID passwd MyPasswd trunc xlsfiles C:\LangPack_Msg.xls After a Language Pack is loaded, system performance may slow down slightly as Trueview s translation engine learns the translations provided by the Language Packs. This temporary delay in performance will disappear with increased use of Trueview. If language translations need to be added or updated at a later date (e.g. due to a Trueview upgrade with new labels or messages, etc.), have the translations added to the appropriate Language Pack spreadsheet(s) and load them again with the LangImp tool. The -trunc parameter should be used if significant changes were made to existing translations. If new translations were simply added to the Language Pack spreadsheet(s) without changing any existing terms, the -trunc parameter is not necessary Configuring Default and Supported Languages After loading a Language Pack with the LangImp tool as described in section Loading a Language Pack with the LangImp Tool the next step is to configure Trueview s default and supported languages by using the Languages tab on the System Configuration screen. 1. Select the Languages tab. 2. Based on the order of the translated columns in the Language Pack (.xls) file that was loaded into Trueview, type in the desired Languages in the Language 1, 2 and 3 fields.

213 Administration 212 Figure 281. Entering the Languages in Trueview Figure 282. Language Pack Spreadsheets Figure 283. Language Pack Spreadsheets 3. Click the Save icon in the upper-right corner of the screen. The application saves the Configuration settings. 4. If required, change the Default Language by selecting the appropriate value from the Default Language drop-down list. NOTE: If the user accidentally changes the Language settings in the Admin -> Security -> User Config submenu and can no longer read the screens or reset the Language, instruct the user to navigate back to the Languages tab in System menu and set the Current Language to blank value before logging out. This will change the Language setting to the Default Language when the user logs in again.

214 Administration 213 Figure 284. Settings Default Language to Blank If language translations need to be added or updated at a later date (e.g. due to a Trueview upgrade with new labels or messages, etc.), have the translations added to the appropriate Language Pack spreadsheet(s) and load them again with the LangImp tool as described in section Loading a Language Pack with the LangImp Tool. The -trunc parameter should be used if significant changes were made to existing translations. If new translations were simply added to the Language Pack spreadsheet(s) without changing any existing terms, the -trunc parameter is not necessary. Syslog tab In Trueview devices can send syslog messages to a remote Syslog server or send Syslog messages back to Trueview. If patterns match, Trueview performs the corresponding action, e.g. back up configuration for a device. Figure 285. Syslog Tab To support this action, the following parameters are added: Parameters for Syslog Server

215 Administration 214 Table 43. Parameters for Syslog Server Parameter Protocol Port (Port Number) Maximum Threads (min 10) Log Matched Messages Only Start Syslog Server (Button) Stop Syslog Server (Button) Description Protocol used to receive Syslog message. The probable values are UDP/TCP. Port the Syslog Server will listen to. Maximum number of threads. If selected, only the messages that have matched to one of the specified patterns will be saved to the database. Starts the Syslog server Stops the Syslog server Parameters for Processing Syslog Message 1. Click Add under Defined Patters. The application displays the Create Syslog Pattern screen. 2. Enter the Pattern Matched; the pattern for the task to be triggered. 3. Enter the Time Delay (min); number of minutes after the message received, prior to starting the schedule task. 4. Enter the Schedule Action; action to be performed for the matching pattern. The available actions are - Configuration Backup and OS Backup. 5. Click OK. The pattern is created and added to the list. Figure 286. Create Syslog Pattern Screen Figure 287. Syslog Pattern Created Document Management tab In Trueview Document Management is integrated with Apache Solr Documents (its latest version) are indexed into Apache Solr for fast content search and highlight capabilities.

216 Administration 215 Apache Solr runs as a standalone OS service outside of Trueview. Trueview communicates with Solr to verify whether authentication and SSL are enabled on Solr. Trueview functions even if it is not connected with Solr. When Solr is connected, Trueview uses Solr for searching documents. When a document is added, updated, or deleted, Trueview updates the Solr index accordingly. When Solr is not configured (i.e. no Solr URL is entered) or is disconnected, Trueview still allows you to search, add, update or delete documents, except that the search result will be query result to TNP's database by strictly document name and keywords. In another words, content search and highlight capabilities would be absent. When Solr is connected for the first time or re-connected after it was down, the background document management sync process deletes everything in Solr, and re-index everything in Solr. You can configure the Solr in the System -> Document Management tab, see if the Solr index is currently in sync or not, and verify Solr connection on demand. When the Solr URL is changed, document management is immediately considered out of sync, so that the sync process could be triggered when Solr is connected. The following table explains about the fields available in the Document Management tab for integrating with the Solr. Table 44. Document Management Tab Fields Label Maximum File Size (Bytes) Solr URL Solar User Name and Password Solr Connection Timeout (ms) Highlight Pre and Highlight Post Highlight Snippets Highlight Fragment Size Description The maximum size of the file that could be uploaded into Trueview URL to a Solr core. If no URL is provided, Trueview functions without Solr, but loses the content search and highlight capabilities. Any change to the Solr URL is effected immediately and no system restart is required. Enter the login credentials if Solr requires authentication. The amount of time (in ms) that is accepted for establishing a connection with Solr. Note the value should not be too long. For example, if the connection timeout is set to 10 seconds and if the user searches for documents while Solr is down, the application will take more than 10s for search to return the results. This is because the search operation first tries to connect to Solr, if it fails to connect after 10s, it will then search from Trueview s database. Configures the style of the highlighted text while searching. The default Pre and Post values are <em style= color:blue > and </em> respectively, which makes the highlighted text to appear as italic and blue. The maximum number of highlighted snippets to display. The size, in characters, of the snippets created by the highlighter

217 Administration 216 Figure 288. Document Management Tab - Solr Configuration Click Verify Connection to test whether Solr is configured/is in-sync with Document Management. In-sync allows all the documents in Trueview indexed into Solr. Figure 289. Testing Solr Connectivity Failed Synching with Solr The Solr Index can get out of sync with Trueview under the following circumstances: First time configuring Solr in Trueview (entering the Solr URL). Changing the Solr URL. A document is added/updated/deleted while Trueview is not able to connect to Solr. For information about installing and configuring Solr, please refer to the Apache Solr Installation Guide. Arbor connector This is the location where you setup the details for the Arbor Connector. The information is effectively a URL and Key that are provided to you. 1. Click System -> Arbor Connector tab. 2. Enter the Arbor System URL. 3. Enter the Arbor API Key. 4. Click Save.

218 Administration 217 Figure 290. Arbor Connector 4.8 Workbench The Workbench menu provides utilities for extending the capabilities of Trueview in specific areas. For example, the Digital Bridge area of the Workbench allows you to create, copy, install, test or delete Access adapters. The Reports area allows you to create, modify and delete Trueview Report Definitions from templates provided with the system. The Package area of the Workbench allows users to create, copy and install customized screen Packages with user-defined functionality. Import and Export buttons allows you to transfer of Packages between development, testing, and production environments. Figure 291. Workbench Reports Reports allow you to create, modify and delete Trueview Report Definitions from templates provided in the application. A Report Definition defines the content of a report in terms of information retrieved from and reported in Trueview. The Report Definition uses templates generated with the open-source Jaspersoft ireport tool to lay out report contents based on Trueview objects. For more information about how to install and use Jaspersoft ireport, refer to the Jasper website at One or more reports can be created from a single Report Definition by applying the Report Definition against different Trueview objects (for example: one Availability Report for Facilities and one Availability Report for Circuits). Report output cannot be generated from a Report Definition without a set of objects to report on.

219 Administration 218 When multiple reports refer to the same Report Definition, the design and layout will be similar. For example, a Network Element Report Definition may be used to create different reports based on Location. The reports will share the same format and layout, but will contain data appropriate to the Location selected. For every custom Report Definition created, a default report with the same name as the Report Definition is automatically created in the Reports tab in the Report Definition s Detail/Configuration screen. This feature allows report designers to quickly test and debug the Report Definition. NOTE: Built-in reports cannot be created, modified or deleted. However, their templates can be downloaded and modified to create custom Report Definitions. Built-in reports can also be disabled to prevent users from running unauthorized reports. To access existing Report Definitions in Trueview, 1. Click Admin -> Workbench -> Reports. The application displays the Find Reports screen. 2. Click Search or apply the search criteria. The application displays the available Report Definitions for use in Trueview. Figure 292. Available Report Definitions for use in Trueview Once you install the Trueview application, the following build in report definitions are available in Trueview. Table 45. Report Build-in Definitions Report Name AtRiskAndOOSEvents Availability AvailabilityTrending CircuitImplementationReport CustomerCircuitGapReport DCMAuditReport DCMConfigurationBackupReport DependentCustomerServiceAlarmReport DependentCustomerServiceCardReport DependentCustomerServiceFacilityReport Report Description At Risk and Out of Service Events Availability Report Availability Trending Report Circuit Implementation Report Customer Circuit Gap Report DCM Audit Report DCM Configuration Backup Report Dependent Customer Service Report for Alarm Dependent Customer Service Report for Card Dependent Customer Service Report for Facility

220 Administration 219 DependentCustomerServiceLinkReport DependentCustomerServiceNEReport DependentCustomerServiceNetworkReport DependentCustomerServicePortReport DependentCustomerServiceWithAlarmCardReport DependentCustomerServiceWithAlarmFacilityReport DependentCustomerServiceWithAlarmNEReport DependentCustomerServiceWithAlarmNetworkReport DependentCustomerServiceWithAlarmPortReport DependentServiceAlarmReport DependentServiceCardReport DependentServiceFacilityReport DependentServiceLinkReport DependentServiceNEReport DependentServiceNetworkReport DependentServicePortReport FacilityChannelUtilization LinkCFSImpact LinksCLR MeanTimeToRepair NEReconciliationReport NEReconciliationReport NetworkCapacityReport NetworkElementCFSImpact NetworkElementChannelUtilization NetworkElementDropPortUtilization NetworkUptime ReconciliationReport ReconciliationReport ServiceAffectingEventTrending ServiceAlarmsReport ServiceOOSEvents VideoServiceAlarmsReport VideoServiceAtRiskAndOOSEvents VideoServiceAvailability VideoServiceAvailabilityTrending VideoServiceMeanTimeToRepair VideoServiceNetworkUptime Dependent Customer Service Report for Link Dependent Customer Service Report for NE Dependent Customer Service Report for Network Dependent Customer Service Report for Port Dependent Customer Service Report for Card (With Alarm) Dependent Customer Service Report for Facility (With Alarm) Dependent Customer Service Report for NE (With Alarm) Dependent Customer Service Report for Network (With Alarm) Dependent Customer Service Report for Port (With Alarm) Dependent Service Report for Alarm Dependent Service Report for Card Dependent Service Report for Facility Dependent Service Report for Link Dependent Service Report for NE Dependent Service Report for Network Dependent Service Report for Port Facility Channel Utilization Link CF Service Impact Report Links Circuit Layout Report Mean Time to Repair NE Reconciliation Report NE Reconciliation Report Network Capacity Report Network Element CF Service Impact Report Network Element Channel Utilization Network Element Port Utilization Network Uptime Report Reconciliation Report Reconciliation Report Service Affecting Event Trending Service Alarms Report Out of Service Events Video Service Alarms Report Video Service At Risk and Out of Service Events Video Service Availability Report Video Service Availability Trending Report Video Service Mean Time to Repair Video Service Network Uptime Report Creating a Report Definition Report Definitions are created from one or more templates designed using the Jaspersoft ireport software. Existing templates in Trueview can be downloaded and then modified with Jaspersoft ireport to develop a customized layout. After the templates are successfully previewed in ireport, they must be uploaded and registered in Trueview.

221 Administration 220 The Reports Workbench supports the concept of sub-reports that can be called from master reports. This is necessary in order to report data in sub-grouping hierarchies. As a result, multiple templates can be included for a single Report Definition. NOTE: When creating a new Report Definition, the master Report Template should have the same name as the Report Definition. To create a new Report Definition, 1. Click Admin -> Workbench -> Reports. The application displays the Find Reports screen. 2. Click Create. The application displays the Report Definition s Detail/Configuration screen. Figure 293. Find Reports Screen 3. Enter the details as explained in the following table. Table 46. Report Definition Fields Label Name * Report Type Report Definition Title * Report Data Type * Description Default Format Description The name applied to the Report Definition in Trueview. Built-in or Custom (read-only). This field is automatically populated by Trueview. Only custom reports can be created, modified, or deleted in Trueview. The title to be printed at the head of the report. The data types that can be handled in the report. The value selected for this field determines the criteria available for filtering the Report data. For more information about Report Criteria, see Section Criteria Tab. A brief description of the purpose of the report. The format in which the report is automatically created, if not specified at run-time. The available formats are: PDF HTML EXCEL Report Category This drop-down list is generated from the report.category Enumeration defined in the Admin -> Interface -> Enumerations submenu. The available values are: Access

222 Administration 221 Connectivity Capacity Reconciliation Enabled This flag controls the status of the Report Definition and execution of the related default report. The available values are: No Yes Deployment Mode This field can be set to No to prevent users from running built-in reports that are no longer required. The deployment mode determines whether the report is executed internally within the Trueview server or externally through a report server. The available values are: Internal External The External mode should be used if data is being processed by another system for the report. If an Internal report is using Trueview's ESI Web Service API, refer to the following mentioned points for more information. If an Internal report is using Trueview s ESI Web Service API to make web-service calls, the following conditions should be met: The Jaspersoft ireport designer must be configured to use the following.jar files received with the Trueview installation files: reports/tnpreportbridge.jar lib/tnp.interface.jar The above.jar files must be specified in the Classpath tab under the Tools -> Options menu of the ireport tool. Refer to the relevant ireport documentation for more information. The Jaspersoft ireport designer must be configured to use the following Report parameters in order to make use of Trueview s ESI API: WS_HOLDER Object class: javax.xml.ws.holder TNPNML Object class: com.tieroneoss.tnpnml.tnpnml For more information on how to configure Report parameters in ireport, refer to the relevant ireport documentation.

223 Administration 222 Figure 294. Report Definition s Detail/Configuration Screen 4. Use the Report Template, Criteria, Reports and Data Source tabs to configure the Report Definition in more detail. For more information, see the following Sections. Section Report Template Tab. Section Criteria Tab. Section Reports Tab. Section Data Source Tab. 5. Click the Save icon in the upper-right corner of the screen. 6. Ensure that the Privilege for the new Report is enabled for the relevant User Group(s) that will be running the Report. For more information about User Group Privileges, see Section Privileges tab. NOTE: Trueview automatically creates a Privilege for each new Report in the Admin -> Security -> Privileges submenu. Once the Privilege is assigned to a User Group, users should logoff and logon to the application or the new Privilege to take effect Report Template Tab New Report Definitions can be created using Report Templates that are created using the ireport tool from Jaspersoft, or from modified copies of existing templates you have already downloaded to a directory in your computer. Existing Report Templates can be modified with the help of code generated in the Data Source tab. For more information about Data Source tab, see Section Data Source Tab. NOTE: At this point of time, Jaspersoft ireport is the only supported software tool for creating or modifying Report Templates. To upload a Jaspersoft ireport, 1. Click the Report Template tab in the Report Definition s Detail/Configuration screen. 2. Click Upload. The application displays the Upload Report Template screen. 3. Browse and choose the file, and click Upload. The application uploads the file.

224 Administration 223 Figure 295. Upload Report Template Screen More than one Report Template can be uploaded in the Report Template tab in order to create master-detail reports or subreports. Templates are listed by name in the panel. NOTE: If a master Report Template is modified, it must have the same name as the Report Definition when it is later uploaded to the Report Definition. Sub-reports that are called from the master report do not need to have the same name as the Report Definition. Figure 296. Report Template Tab - Jaspersoft ireport Template Uploaded in the Application After a custom Report Template is uploaded, it can be downloaded later and modified for use in defining other Reports. Select a Report Template, and click Download to download and modify a Report Template in your system. To remove a Repot Template which is no longer in use, select the Report Template and click Delete to remove the report template from the application. Deleting a template is applicable only to custom reports. Built-in Report Definitions cannot be deleted from the application. The following table explains about the buttons and their functions available in the Report Template tab. Table 47. Buttons and their Functions Available in the Report Template Tab Label Upload Download Delete Description Uploads a custom Report Template file from a source directory. Report Templates cannot be uploaded for built-in reports. Downloads one or more Report Template files to a target directory for editing with Jasper ireports. Multiple templates are combined into a ZIP file. Deletes the selected custom Report Template from the current Report Definition. Built-in Report Templates cannot be uploaded or deleted.

225 Administration Criteria Tab When a Report Definition is created, parameters related to the report objects are listed in the Criteria tab. The options listed in the Criteria tab depend on the value selected from the Report Data Type drop-down list in the Report Definition s Detail/Configuration screen. The criteria are used as search fields in the object selection window when the report is run. For example, when a user selects and runs a report from Trueview s Reports module, a selection window opens where the user can specify criteria, select objects, and then execute the report. The criteria that are used in the selection window while running a report can be customized by selecting values in the Criteria tab. To select criteria to be used as Report Parameters, 1. Click the Criteria tab in the Report Definition s Detail/Configuration screen. 2. Select the required report criteria. You can select multiple criteria. 3. Click the Save icon in the upper-right corner of the screen. Figure 297. Criteria Tab The following table explains about the Criteria tab fields. Table 48. Criteria Tab Fields Label Report Criteria Report Criteria Label Description Criteria defined for this type of report. Label displayed in the report for this selection Reports Tab When a Report Definition is created, a default report having the same name as the Report Definition is automatically added in the Reports tab. Its layout is determined by the template(s) defined in the Report Template tab. New reports based on the current Report Definition can be created, or existing reports can be modified or deleted by using the appropriate buttons in this tab. After the changes been done and saved, the new report can be tested by selecting the report in the grid and clicking the Test button.

226 Administration 225 The following table explains about the buttons and their functions available in the Reports tab. Table 49. Buttons and their Functions Available in the Reports Tab Label Create Open Delete Test Description Creates a report based on the current Report Template(s) specified in the Report Template tab. Opens the selected report for editing. Deletes the selected report, provided that it is not the default report for a Report Definition. Executes the selected report based on the defined template(s) and criteria. The following table explains about the Reports tab fields. Table 50. Reports Tab Fields Label Name Description Report Category Description Name assigned to the report. Report description. Category selected when the Report Definition was created. You can create a new report based on the current Report Template(s) specified in the Report Template tab, 1. Click the Reports tab in the Report Definition s Detail/Configuration screen. 2. Click Create. The application displays the Report s Detail/Configuration screen. Figure 298. Reports Tab 3. Enter the report parameters. 4. Click the Save icon in the upper-right corner of the screen. The new report is created and added to the list.

227 Administration 226 Figure 299. Report's Detail/Configuration Screen Figure 300. New Report Created and Added to the List If you intend to use frequent search queries for a report you can create your own queries, To create Queries, 1. Click the Reports tab in the Report Definition s Detail/Configuration screen. 2. Select a report, and click Open or click the report. The application displays the Report s Details screen. 3. Click Test. The application displays the pertaining object selection screen.

228 Administration 227 Figure 301. Reports Tab Opening a Report Figure 302. Report s Details Screen Creating a Query 4. Create the query by entering the required parameters. 5. Click the Save As Query. The application displays the Add/Modify Query screen. Figure 303. Select Links for Report Screen 6. Enter the Query Name, and click Save. The query is created and added to the list.

229 Administration 228 Figure 304. Add/Modify Query Screen 7. To test the report with the saved query, select the query from the list, and click Details. The application displays the Select Links for Report screen displaying the query. Figure 305. Selecting the Query 8. Click Search. The application lists all objects based on the saved query. 9. Select the desired objects, and click Report. The report is generated.

230 Administration 229 Figure 306. Select Links for Report Screen - Testing the Query The report queries can be scheduled to be run in the Admin -> Schedules -> Manage submenu. NOTE: Both the report and the Report Definition must be enabled to test-run a report Data Source Tab Trueview parameters that are referred in the report template are listed in the Data Source tab. This tab represents a helpful tool for generating XML fragments which can be copied into a Jasper ireport file before it is uploaded to the Report Template tab. Trueview s report engine accesses data in Trueview via the Java Bean API or from database tables and queries. The Data Source tab has two subtabs. Bean Fields Subtab These are generated from Java APIs. Bean Fields are Java objects which allow more complex Field Types to be used. Entity Fields Subtab These are generated from XML and Metadata files. Entity Fields allows Field Labels to be captured. The following table explains about the Bean Fields subtab fields. Table 51. Bean Fields Subtab Fields Label Field Name Field Type Description Name of the field Java type

231 Administration 230 The following table explains about the Entity Fields subtab fields. Table 52. Entity Fields Subtab Fields Label Field Name Field Label Field Type Field Length Description Name of the field Label displayed in the report Type of field (integer, string, timestamp) Field length You can generate a formatted list of fields which can be conveniently copied into the Jasper ireport editor for use in a Report Template. To do this, 1. Click the Bean Fields/Entity Fields tab. 2. Click Generate Fields. The application displays the Report Fields screen generating a formatted list of fields. Figure 307. Data Source Tab 3. Copy the field definitions to your report definition.

232 Administration 231 Figure 308. Field Definition For more information about Jasper ireport, refer to the Jasper website at Packages Packages are used to create, modify, copy and install customized screen Packages with user-defined functionality. A Package consists of four main components: Metadata content in XML format A set of custom Privileges A set of custom Workflows A set of Scripts These components are developed using a combination of XML and Java code, and help to define the graphical layout of the screen, as well as the related privileges and functions that make the screen accessible and interactive. Once a Package is developed, it can be installed for use in Trueview, or copied and modified to facilitate the development of other Packages. NOTE: To view the list of custom Packages currently installed in Trueview, navigate to the Admin -> Customization -> Packages submenu. For more information about Customization Packages, see Section under Section Customization. Import and Export options are provided to facilitate the transfer of Packages between development, testing, and production environments Creating a Package To create a new Package, 1. Click Admin -> Workbench -> Packages. The application displays the Package Workbench screen. 2. Click Create. The application displays the Package s Detail/Configuration screen.

233 Administration 232 Figure 309. Package Workbench Screen 3. Enter the details as explained in the following table. Table 53. Customization Package Fields Label Name * Installed Description * Identifier * Version * Description User-defined name for the custom Package. Yes/No. Read-only field automatically populated by Trueview to indicate whether the Package has already been installed for use in Trueview. User-defined description for the Package, briefly explaining its use or purpose. This is a prefix intended to give a Package a unique namespace. It must start with an underscore (_). The prefix is added to all items in the Package Metadata that require uniqueness (such as menu items or actions). Multiple Packages may have the same identifier, but only one of them may be installed at one time. User-managed version number of the Package. Figure 310. Package Definition Detail/Configuration Screen 4. Use the Metadata, Privileges, Workflows, and Scripts tabs to configure the custom screen layout and functionality. For more information, see the following Sections. Section Metadata Tab. Section Privileges Tab. Section Workflows Tab.

234 Administration 233 Section Scripts Tab. 5. Click the Save icon in the upper-right corner of the screen. Once a Package is fully configured, it can be installed for use in Trueview, or copied and modified to facilitate the development of other Packages. For more information about Installing Packages, see Section Installing a Package and Section Copying a Package for more information about Copying Packages Metadata Tab Metadata describes the custom user interface or screen to be used in Trueview. A Customization Package can consist of one or more custom screens. Each screen can have its own Metadata file. Alternatively, the XML content for multiple screens can be included in one Metadata file. To add Metadata, 1. Click the Metadata tab in the Customization Package s Detail/Configuration screen. 2. Click Add. The application displays Custom Metadata screen. Figure 311. Customization Packages Detail/Configuration Screen 3. Enter the Metadata Name and XML Content. 4. Click OK. The metadata is created and added to the list.

235 Administration 234 Figure 312. Custom Metadata Screen 5. Click the Save icon in the upper-right corner of the screen. Figure 313. New Metadata Added to the List NOTE: For more information on how to structure the XML Content, refer to the customizationpackageexportimport.xsd file included in the api\xsd directory of the received installation files or the Trueview Custom Screens Development Guide. Some of the key information that should be included in the XML Content field is listed below. Enumeration Section: contains values and descriptions for Enumerations used in the custom screen. Data Dictionary Section: describes the fields used in the custom screen in terms of their labels, data types, and names. Action Dictionary Section: describes the user-interface scripts that are referenced by buttons, fields and menu items in a custom form or screen. Menu Dictionary Section: adds a menu item to Trueview s main navigation menu on the top of the screen. The new menu item can either be nested under an existing menu item, or it is appended to the right hand side of the horizontal list of menu items. The menu item can have a privileges attribute assigned to it so that access to the custom screen can be restricted. If no privilege is defined, the menu item will always be visible. Record Dictionary: represents a collection of data items that define the view of the custom screen.

236 Administration Privileges Tab The Privileges tab is used to define custom privileges for a Customization Package so that access to the customized screen and its commands can be restricted, if required. The privileges defined in this tab are referenced in the Metadata XML file. Therefore, once the name of a custom Privilege is saved, the Name field cannot be changed; otherwise, all references to the custom Privilege should be changed in the Metadata XML file as well. Once a Customization Package is installed, the Package s privileges are automatically added as options in the Admin -> Security -> Privileges -> Custom tab, as well as in the Admin -> Security -> User Groups -> Privileges -> Custom tab. The privileges are disabled until a Trueview Administrator assigns the custom privileges to the appropriate User Group(s). To add a Custom Privilege, 1. Click the Privileges tab in the Customization Package s Detail/Configuration screen. 2. Click Add. The application displays the Custom Privilege screen. Figure 314. Privileges Tab 3. Enter the Name and Description. 4. Click OK. The new Privilege is created and added to the list. 5. Click the Save icon in the upper-right corner of the screen. Figure 315. Custom Privilege Screen.

237 Administration 236 Figure 316. New Privilege Created and Added to the List Workflows Tab The user-interface scripts in the Metadata XML file of a Customization Package can invoke a custom Workflow that is defined in the Workflows tab. Workflows execute specific business processes as the user interacts with a customized screen. Trueview supports Activiti a lightweight, flexible BPMN 2 process engine. Activiti comes with an Eclipse plugin, the Activiti Eclipse Designer which can be used to graphically model, test and deploy BPMN 2.0 processes. The Workflows could specify service tasks to execute custom BeanShell or Groovy scripts. The custom scripts, in turn, could invoke functions in Trueview s ESI Web Service. The custom scripts to be invoked by a Workflow should be provided in the Scripts tab. For more information about Scripts tab, see Section Scripts Tab. Using the Activiti Eclipse Designer, the BPMN 2 process could be built graphically, and the process definition XML could then be added in the Workflows tab. NOTE: For more information on Activiti, refer to For documentation on the Activity Eclipse Designer, refer to To add a Custom Workflow, 1. Click the Workflows tab in the Customization Package s Detail/Configuration screen. 2. Click Add. The application displays the Custom Workflow screen.

238 Administration 237 Figure 317. Privileges Tab 3. Enter the Name and XML Content. The XML Content can be generated from the Activiti Eclipse Designer. 4. Click OK. The workflow is created and added to the list. 5. Click the Save icon in the upper-right corner of the screen. Figure 318. Custom Workflow Screen.

239 Administration 238 Figure 319. New Workflow Created and Added to the List NOTE: The Workflow XML file contains a <process> tag that specifies the ID of the process. When the workflow is invoked from the Metadata XML file, the process ID is used by Trueview to determine which workflow to execute. Therefore, if the process ID is changed in the Workflow s XML content, the ID must also be modified in the Metadata s XML content to match. NOTE: For more information about how to structure an example Workflow, refer to the Trueview Custom Screens Development Guide Scripts Tab Workflows invoked by a customized screen could specify service tasks to execute custom BeanShell or Groovy scripts in a Customization Package. Each Script should be given a unique name since the process definitions defined in the Workflow XML content call the Scripts that are provided in the Scripts tab. If the name of a Script is modified in the Scripts tab, references to that Script in the Workflow must also be modified to match. To add a Custom Script, 1. Click the Scripts tab in the Customization Package s Detail/Configuration screen. 2. Click Add. The application displays the Custom Script screen.

240 Administration 239 Figure 320. Scripts Tab 3. Enter the Name and XML Content. 4. Click OK. The script is created and added to the list. 5. Click the Save icon in the upper-right corner of the screen. Figure 321. Custom Script Screen Figure 322. New Script Created and Added to the List

241 NOTE: For more information on how to structure an example Script, refer to the Trueview Custom Screens Development Guide Installing a Package Administration 240 Once a Customization Package is fully configured, it needs to be installed in order to have all Package components loaded into the Trueview server(s) and to see the custom screens in action. No server restart is required. Once a Package is installed, it is no longer listed in the Package Workbench screen; instead, it will be listed in Admin -> Customization -> Packages submenu. A Customization Package can be installed in two ways: Select the Package object in the Package Workbench screen, and click Install. Figure 323. Installing a Package from Package Workbench Screen - OR- Open the Package object, and click Install from the the Package from any of the tabs. action menu in the upper-right corner of the screen. You can install Figure 324. Installing a Package through Action Menu Copying a Package For convenience, Packages can be copied and modified to quickly create other Packages.

242 Administration 241 To copy a Package, 1. Click Copy. The application displays the Select Package to Copy screen. Figure 325. Copying a Package 2. Click Search or use the search criteria to list all Packages stored in the Trueview database. 3. Select a Package, and click Select. The application displays a copy of the selected Package. Figure 326. Select Package to Copy Screen Selecting a Package to Copy 4. Modify the required details, and click the Save icon in the upper-right corner of the screen. The copied packaged is added to the list.

243 Administration 242 Figure 327. Package is Copied and Displayed for Modification Figure 328. Newly Copied Package in Added in the List Importing a Package Packages can be conveniently imported from JAR files to assist in migrating custom screens from one environment to another. To import a Package, 1. Click Import in the Package Workbench screen. The application displays the Import Customization JAR File screen. Figure 329. Importing a Package 2. Browse and select the JAR file.

244 Administration Click Import. The application displays the Import Packages screen. Figure 330. Import Customization JAR File Screen 4. Select the required details, and click Import. The package is imported and added to the list. Figure 331. Import Packages Screen You can also rename a Package before importing, 1. Click Rename in the Import Packages screen (after selecting the JAR file). The application displays a Rename Package screen. 2. Enter the New Package name, and click OK. 3. Click Import. The package is renamed, imported and added to the list.

245 Administration 244 Figure 332. Renaming a Package and Importing Exporting a Package Packages can be conveniently exported as JAR files to assist in migrating custom screens from one environment to another, e.g. for testing or production purposes. Packages can be exported in two ways. Select the Package object in the Package Workbench screen, and click Export. Figure 333. Exporting a Package from Package Workbench Screen - OR- Open the Package object, and click Export from the the Package from any of the tabs. action menu in the upper-right corner of the screen. You can install

246 Administration 245 Figure 334. Exporting a Package through Action Menu Updating a Package Displays the Import Customization JAR File screen where you can browse and select a JAR file with which to update the current Package. This feature is convenient in situations where a custom Package is modified in one environment but not in another. The modified Package can be exported as a JAR file which can be used to update the Package in another environment. NOTE: The JAR file used for the update must contain only one Package. The name of the Package inside the JAR file does not need to match the name of the Package being updated. If the Package names are different, the updated Package will be renamed. NOTE: If the Package being updated is currently installed, the previous Package version will be uninstalled and the updated version will be installed. If the update includes changes to Metadata, the user may need to logout and login again to see the changes. If installation fails, the changes from the updated JAR file will be reverted. 4.9 Customization Packages The Customization -> Packages submenu provides access to all custom Packages currently installed in Trueview. Custom Packages are created and configured in the Package Workbench. For more information about Package Workbench, see Section Packages. Once the Custom Packages are installed, they can be managed from the Admin -> Customization -> Packages submenu. Packages submenu allows you to do the following activities. Additional Packages can be installed. Currently installed Packages can be uninstalled, deleted, or exported as JAR files to migrate to other environments.

247 Administration 246 Figure 335. Customization - Packages Viewing Package Details/Configuration To view the installed Package s Detail/Configuration screen, 1. Click Admin -> Customization -> Packages. The application displays Installed Packages screen displaying the packages installed in Trueview. 2. Click a Package. The application displays the Package s Detail/Configuration screen. Figure 336. Installed Packages Screen

248 Administration 247 Figure 337. Package s Detail/Configuration Screen NOTE: To edit the Package, the Package must be uninstalled. It can then be reinstalled after the modifications have been done. For more information on how to uninstall a Package, see Section Uninstalling a Package Installing Additional Packages from the Package Workbench To install custom Package(s) from the Package Workbench, 1. On the Installed Packages screen, click Install. The application displays the Select Packages To Install screen. Figure 4-338: Install Packages Screen 2. Click Search or use the search criteria to list all Packages stored in the Trueview database. 3. Select a Package, and click Select. You can select more than one Package.

249 Administration 248 Figure 339. Select Packages to Install Screen Installing Additional Packages The application loads the packages into the Trueview server and transmitted to other servers as required. No server restart is required Uninstalling a Package If customized screen Packages are no longer required or have been replaced, they can be uninstalled in any one of two ways. Select the Package object in the Package Workbench screen, and click Uninstall. Figure 340. Installing a Package from Package Workbench Screen - OR- Open the Package object, and click Uninstall from the action menu in the upper-right corner of the screen.

250 Administration 249 Figure 341. Uninstalling a Package through Action Menu No server restart is required Exporting an Installed Package Packages can be conveniently exported as JAR files to assist in migrating custom screens from one environment to another, e.g. for testing or production purposes. Packages can be exported in two ways. Select the Package object in the Package Workbench screen, and click Export. Figure 342. Exporting a Package from Package Workbench Screen - OR- Open the Package object, and click Export from the action menu in the upper-right corner of the screen.

251 Figure 343. Exporting a Package through Action Menu Administration 250

252 Exporting files 251 Appendix A Exporting files In some versions of Internet Explorer, exporting a file can result in a new browser window appearing briefly and then disappearing with no option to save the file. This is caused by certain browser settings. To resolve this issue please follow these steps: 1. In the Internet Explorer menu bar, click on the Tools icon and select Internet Options. Figure 344. Internet Explorer menu bar 2. Click the Security tab. 3. Of the four security-related web content zones shown, select the Internet zone. 4. In the panel labeled Security level for this zone, click Custom level. Figure 345. Internet Explorer Security tab

253 Exporting files In the Security Settings window, look for Downloads: File download. Click Enable to verify that this setting is enabled. Figure 346. IE Security settings 6. Click OK on the Security Settings window. 7. Click OK again on the Internet Options window.