Sei sulla pagina 1di 430

AIRCOM OPTIMA User Reference Guide

Software Version 6.2 Reference Guide Edition 5

Copyright 2010 AIRCOM International All rights reserved ADVANTAGE, ARRAYWIZARD, ASSET, CONNECT, DATASAFE, DIRECT, ENTERPRISE, MYRIAD, AIRCOM OPTIMA, RANOPT and WEBWIZARD are recognised trademarks of AIRCOM International. Other product names are trademarks of their respective companies. Microsoft Excel, .NET, Microsoft Office, Outlook, Visual BasicWindows, Windows XP, Windows Vista and Word are trademarks of the Microsoft Corporation. This documentation is protected by copyright and contains proprietary and confidential information. No part of the contents of this documentation may be disclosed, used or reproduced in any form, or by any means, without the prior written consent of AIRCOM International. Although AIRCOM International has collated this documentation to reflect the features and capabilities supported in the software products, the company makes no warranty or representation, either expressed or implied, about this documentation, its quality or fitness for particular customer purpose. Users are solely responsible for the proper use of ENTERPRISE software and the application of the results obtained. An electronic version of this document exists. This User Reference Guide finalised on 15 April 2010. Refer to the Online Help for more information. This User Reference Guide prepared by: AIRCOM International Ltd Cassini Court Randalls Research Park Randalls Way Leatherhead Surrey KT22 7TW Telephone: Support Hotline: Fax: Web: +44 (0) 1932 442000 +44 (0) 1932 442345 +44 (0) 1932 442005 www.aircominternational.com

Contents
Chapter 1 Introduction 13
14 14 14 15
16 16 18 18 20

About This Manual About the AIRCOM OPTIMA Operations and Maintenance Guide Explanation of Symbols Obtaining User Assistance
Who is This User Reference Guide For? About the ENTERPRISE User Reference Guides Can You Improve Our User Assistance? Obtaining Support Obtaining Further Information and Services

Chapter 2 Installing AIRCOM OPTIMA 21


About the Hardware and Software Requirements for AIRCOM OPTIMA Installing AIRCOM OPTIMA
Installing AIRCOM OPTIMA as Part of ENTERPRISE Installing a Standalone Version of AIRCOM OPTIMA Updating Data About Maintenance and Security Accessing Data from Outside of AIRCOM OPTIMA

21 22
22 22 23 23 23

Starting AIRCOM OPTIMA Using a Web Interface Logging Into AIRCOM OPTIMA
About the Quick Help Screen

24 26
28

Changing your Password

29

Chapter 3 About the AIRCOM OPTIMA User Interface


About the Main AIRCOM OPTIMA Toolbar
About the Favourites Toolbar

31
31
32

About the AIRCOM OPTIMA Menus About the Module Explorer About the Module Combination Explorer About the Report Explorer About the Schedule Explorer About the KPI Manager and Global KPI Explorer About the Favourites Dialog Box About the Alarms Explorer About the Alarms Handler Explorer Setting Administrator Options
Setting General Administrator Options Setting Email Client Options Setting WEBWIZARD Options AIRCOM OPTIMA User Reference Guide Version 6.2

33 34 35 36 37 38 40 41 43 44
45 47 49 Page 5

Setting Which Tables and Schemas to Exclude from the Data Explorer Setting Sandbox Options Setting Partition Maintenance Options

50 51 54

Defining User Preferences


Setting Confirmation Requests Setting Grid Preferences Setting Expression Editor Preferences Setting Security Setting Default Grid Options Setting Default Graph Options Setting Trace File Options Setting the Time Zone

55
55 56 57 57 58 59 60 61

About the Data Explorer About the Filter Explorer About the Element Hierarchies Explorer About the Counter Descriptions Window Switching Between Open Windows Using Clocks
Offsetting the System Clock

63 64 65 66 67 68
69

Using the Find Dialog Box Accessing WEBWIZARD

69 70

Chapter 4 About AIRCOM OPTIMA Administrator Tools


About the Database Config Settings
About Database Links About Regional Settings

71
72
72 73

About AIRCOM OPTIMA Security


Example of Using Groups and Users to Configure Security Creating Groups Editing and Deleting Groups Using Groups to Assign Access Creating Users About AIRCOM OPTIMA User Roles Editing and Deleting Users Changing Passwords

74
74 76 76 77 78 80 85 85

Using Contacts
Adding, Editing and Deleting Contacts in the Address Book Adding a Contact Group to the Address Book Editing and Deleting Contact Groups

86
87 87 88

About the Table Editor


Adding, Editing and Deleting Rows in Tables

89
90

About Table and Field Information Settings


Setting All Table and Field Information Settings Using the Settings Wizard Setting Table Security Setting the Granularity Period for a Single Table Assigning a Category to a Table Defining an Association for a Table Adding a Comment to a Table Applying Changes to Element and Date Columns Setting Table Level Page 6 AIRCOM OPTIMA User Reference Guide Version 6.2

91
92 93 94 94 95 97 97 97

Adding a Comment to a Column Finding a Counter in the Table and Field Info Dialog Box Repopulating Data Generating Associated Tables Automatically

98 98 98 99

About Categories
Creating and Editing Categories

101
101

About Table Periods


Creating and Editing Table Periods Creating and Editing Entities

102
103 104

Excluding Particular Days from Reports


Editing and Deleting Holidays

106
106

Chapter 5 Setting Up and Querying Data


Using the Data Explorer
Finding Tables and Counters Defining a Query About KPIs

107
108
109 110 133

About Modules
Creating Folders for Modules Viewing Modules Creating Modules Element Aggregation in Module Queries Restricting Access to Modules Restricting Editing of Modules Editing and Deleting Modules Opening a Module in a New Combination Copying Modules Importing and Exporting Modules

153
154 156 157 160 167 168 168 169 169 170

Using the Element Hierarchies Explorer


About the Element Hierarchies Explorer Toolbar Creating Element Hierarchies in the Element Hierarchies Explorer Setting Element Hierarchy Security Finding Element Hierarchies Copying Element Hierarchies in the Hierarchies Explorer Viewing Element Hierarchies in the Element Hierarchies Explorer Previewing Element Hierarchies in the Element Hierarchies Explorer

171
172 173 175 176 176 177 177

Chapter 6 Viewing Data

179
179
182 184 185 187 191 191 192 193

About Combination Windows


Creating Folders for Combination Windows Viewing Pre-Defined Combination Windows Creating Combination Windows Displaying Element Data Across Modules Restricting Access to Combination Windows Restricting Editing of Combination Windows Copying Combination Windows Importing and Exporting Combination Windows

Adding and Editing Favourites


Exporting and Importing Favourites

194
196

Filtering Data in the Combination Window


Filtering Data by Selecting Network Elements Setting a Date Range AIRCOM OPTIMA User Reference Guide Version 6.2

198
198 199 Page 7

Setting Parameter Values Setting Time Aggregation Saving Combination Windows as Templates

200 200 203

Finding Elements in the Modules Pane


Finding Elements Within One Module Finding Elements Across Modules

206
206 206

Filtering Elements in the Modules Pane


Creating a Static Filter from a Selection Creating a Static Filter From the Grid Pane Applying Filters Selecting Elements Quickly

207
207 208 209 211

Displaying Data in Graphs Using the Filter Explorer


About the Filter Explorer Toolbar Creating Static Filters in the Filter Explorer Creating Dynamic Filters in the Filter Explorer Converting a Dynamic Filter to a Static Filter Setting Filter Security Editing Filters in the Filter Explorer Renaming Filters Deleting Filters Finding Filters Copying Filters in the Filter Explorer Viewing Filters in the Filter Explorer

212 213
214 215 220 224 225 225 226 226 226 227 227

Chapter 7 Customising Grids

229
230 231
231 233 233 234 235 237

About the Tools for Customising a Grid Customising Columns in a Grid


Sorting Data Within Grid Columns Fixing Grid Columns Scrolling to a Grid Column Changing the Grid Column Settings Setting Thresholds and Conditional Fonts Refreshing Data

Searching for Data in Grids Filtering Data in Grids


Selecting a Single Value to Filter the Grid Filtering One Column of the Grid Filtering More Than One Column In The Grid

238 238
239 239 240

Summarising Data Viewing Details of a Single Network Element in a Grid Printing Grids Exporting Grids Counting Records in Grids Viewing SQL in AIRCOM OPTIMA Grids

241 243 244 245 246 246

Page 8

AIRCOM OPTIMA User Reference Guide Version 6.2

Chapter 8 Using Graphs 247


About the Options for Customising a Graph Changing the Appearance of Graphs
Using the General Tab in the Graph Options Dialog Box Changing the Appearance of Graph Axis Changing Graph Line Thickness or Bar Chart Type Using the Functions Tab in the Graph Options Dialog Box Displaying Thresholds on Graphs Using Advanced Options Using Chart Themes

247 248
248 250 252 253 253 254 255

About the Navigating Tools


Zooming and Scrolling on Graphs Rotating a Graph Viewing Values Using the Cursor Key

256
256 257 257

About the Appearance Tools


Viewing the Graph in 3D Viewing Gaps in the Data Displaying Data per Point on a Graph Viewing Weekends and Holidays

258
258 259 260 261

Changing the X-Axis Field Ordering Graph Data Selecting and Extending Trends on a Graph Viewing Details in a Graph Printing Graphs Exporting Graphs Saving Graphs as Pictures About the Series List
Ordering the List of Data for a Graph About the 3D Options in the Series List Menu Changing the Colours of the Graph Lines Changing the Type of Graph Changing the Axis Where Data Appears Using the Series List Functions in Line Graphs

261 262 263 264 265 266 266 267


268 268 268 269 270 270

Chapter 9 Using Work Areas

273
274 274 275 277 278
279

About the Work Area Toolbar Creating a New Work Area Adding and Removing Combinations Adding and Removing Web Browsers Refreshing Data and Switching Tabs
Enabling Data Refreshing and Switching

Opening Work Areas Importing and Exporting Work Areas

279 280

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 9

Chapter 10 Viewing Data on the Map

281
281 282 286

Displaying Performance Data on the Map Changing the Display of Performance Data Using the Clock to Display Performance Data

Chapter 11 Generating and Scheduling Reports


Download Learning ReportBuilder About Using Reports
Creating Folders for Reports Viewing Reports Creating Reports Using ReportBuilder Creating Excel Reports Restricting Access to Reports Restricting Editing of Reports Editing and Deleting Reports Copying Reports Printing Reports Importing and Exporting Report Definitions Exporting Reports

287
288 288
288 290 291 343 348 348 349 350 350 351 352

Scheduling When Reports Run


Creating Folders for Schedules Creating a Schedule for a Report Editing and Deleting Schedules Copying Schedules Viewing and Deleting the History of a Schedule

354
354 357 359 360 360

Chapter 12 Using Alarms 361


About Alarm Settings
Configuring Vendors Configuring Technologies Configuring Element Types Configuring Problem Texts Configuring Alarm Maintenance Parameters

362
363 364 365 366 368

Defining an Alarm
Defining Performance Alarms Using the Alarms Wizard Defining Alarms Using the Alarms Editor Activating an Alarm Editing and Deleting an Alarm An Example of Creating a System Alarm

369
369 374 379 379 380

About Ripple Counts Assigning Alarms to Contacts


Creating an Alarm Handler Activating an Alarm Handler Enabling Contacts to Receive Alerts

381 382
382 386 386

Viewing, Clearing and Resetting Alarms Viewing and Clearing Alarm Definitions Viewing and Clearing Alarms History

387 389 390

Page 10

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing Alarms Run History Customising Alarm Information


Sorting Alarm Information by Column

392 393
393

About the Alarms Backend Applications Troubleshooting

393 394

Appendix A Licensing Your Software


Generating Lock Codes

397
397 398 399 399 400 402 404 405 407 409 410 410 411
412 417

About Licensing Your Software Installing a Software Licence Server Using the Licence Reader Migrating Existing Licences Online Generating New Licences Online Renewing Licences Online Migrating Existing Licences Manually Generating New Licences Manually Renewing Licences Manually Monitoring Your Software Licence Server Setting Up Redundant Servers About Network Licensing Strategies
Using Licence Administrator (Strategy B) Using Registry Files (Strategy C)

Using a Login Script to Enforce Your Licensing Policy

419

Glossary of Terms 421 Index 425

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 11

Page 12

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 1

Introduction
AIRCOM OPTIMA is a network performance management and monitoring software tool that logs and stores network parameters, enabling you to gain a complete understanding of the current and past performance of your network. You can use AIRCOM OPTIMA with ENTERPRISE or as a standalone product. By accessing and analysing invaluable performance data, you can: Identify and respond quickly to change Accurately pinpoint extra capacity requirements Deploy network enhancements in a timely and cost effective manner Predict future trends in the network or in any specific part of the network

Some typical uses of AIRCOM OPTIMA for network operation and performance management are: Daily reporting of cell, site, BSC, MSC and transmission network performance Daily reporting of any cluster of cell sites or network elements covering particular cities, roads or other geographical regions Identification of performance anomalies across network regions Overall monitoring of alarms and equipment operational status Identification and strategic reporting of traffic hotspots and network locations generating high traffic and revenues

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 13

About This Manual


This manual describes how to use AIRCOM OPTIMA to view performance data and statistics. This table summarises the information within each chapter:
Use This Chapter 2 3 4 5 - 11 12 C For Administrator-only information about configuring AIRCOM OPTIMA and installing the standalone version of AIRCOM OPTIMA. Information on using the AIRCOM OPTIMA interface. Administrator-only information about using Administrator tools. User information about setting up and viewing data and using reports. Administrator-only information about using performance alarms. Reference information about the licensing of the AIRCOM OPTIMA software.

There is also a Quick Reference Guide that provides a brief 'look-up' reference for AIRCOM OPTIMA. You can access the Quick Reference at any time from the Help menu, or, if you prefer a printable version, you can click Start on the taskbar, point to Programs/AIRCOM International/ENTERPRISE/Docs.

About the AIRCOM OPTIMA Operations and Maintenance Guide


The AIRCOM OPTIMA Operations and Maintenance (O&M) Guide is an accompaniment to the AIRCOM OPTIMA User Reference Guide. It contains the operation and maintenance procedures for the data loading processes and describes how to install and configure the AIRCOM OPTIMA backend applications. Please contact AIRCOM International Support to obtain the latest version of the O&M Guide. For contact details, see Obtaining AIRCOM Support on page 18.

Explanation of Symbols
Throughout this guide, where appropriate, some symbols are used to highlight particular pieces of text. Three different symbols are in use, and are explained as follows:
Symbol Brief Description Note Tip Warning or Important Full Description Signifies text that should be noted or carefully considered. Signifies text that may help you do something in an easier or quicker way. Signifies text that is intended as a warning or something important.

Page 14

AIRCOM OPTIMA User Reference Guide Version 6.2

Obtaining User Assistance


Using Online Help ENTERPRISE products come with a complete system of online Help which you can access in three ways: From the Help menu, click Help Contents. Scroll through the table of contents and choose a relevant topic to display. To search for something particular, from the Help menu, click Help Contents and using the Index tab or Search tab, type in a letter or word to start searching for relevant topics. Press F1 in a dialog box to view context-sensitive help (available for most dialog boxes).

If you are using ENTERPRISE within a CITRIX environment, to ensure that the Help graphics are displayed, set your display settings to support more than 256 colours. Using ENTERPRISE User Reference Guides If you prefer to read printed content, we also provide User Reference Guides. To view or print these as PDFs (Adobe Acrobat portable document format): 1 Make sure you have Adobe Acrobat Reader installed on your PC. If you do not have this, you can install it from the ENTERPRISE CD, or get it from the Adobe website. Adobe and Acrobat are trademarks of Adobe Systems, Incorporated. 2 Click Start on the taskbar, point to Programs, then AIRCOM International, then ENTERPRISE, then Docs. - or Navigate to the Docs folder in the location where you installed the product. If neither of these exists, please contact your administrator. 3 Double-click the PDF file that you want to view.

If you have a customer web account, you can also download the latest User Reference Guides from our website.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 15

Checking Release Notes Each release of the ENTERPRISE software is accompanied by Release Notes, giving important information on system requirements, installation, known issues, upgrades and so on. These notes are included in the ENTERPRISE CD, or you can download them from our website. For any further documentation, such as application notes and extra reference information, please email the support team at the address described in Obtaining Support on page 18.

Who is This User Reference Guide For?


The ENTERPRISE User Reference Guides are intended for different audiences, depending on the particular product. Typical prerequisites include a good understanding of the following: The appropriate telecoms technologies and the associated network planning methods (for planning software) Relational database management, and in particular Oracle database creation and administration procedures (for administrative software) The various parameters utilised for monitoring and optimising networks (for OSS software) Microsoft Windows concepts The functions of the Microsoft Office suite of tools, in particular Excel

Irrespective of the particular product, the following basic knowledge is required:

About the ENTERPRISE User Reference Guides


This table describes our range of User Reference Guides:
This Guide What's New ENTERPRISE Installation and Administration Contains Information On The main difference between the latest versions of the ENTERPRISE suite. Installing and configuring ENTERPRISE, your network, and Oracle databases. Using Administrator to create users and groups, and set permissions. Also contains information on software licensing. ENTERPRISE Database Reference ENTERPRISE User Reference ENTERPRISE Technical Reference ADVANTAGE User Reference The relationships between tables in the database and the contents of each table. Functionality that is common to most of the products in the ENTERPRISE suite, including how to access, view, edit and store data. File formats, as well as antenna and diffraction calculations. Using ADVANTAGE to plan and optimise networks automatically, consider measured data in analysis/optimisation, analyse network performance, identify problematic areas/cells, and related tasks. Using ARRAYWIZARD to automatically generate coverage predictions and best server arrays, which gives you instantaneous display of coverage and interference information for pre-selected filters when loaded into ASSET.

ARRAYWIZARD User Reference

Page 16

AIRCOM OPTIMA User Reference Guide Version 6.2

This Guide ASSET User Reference

Contains Information On Using ASSET, the network planning and analysis tool, to design a range of cellular networks. Includes information on hierarchical network planning, propagation modelling, service and bearer definition, coverage analysis, traffic planning, neighbour planning, measurement data analysis, detailed reporting, analysis arrays and simulation of network performance.

ASSET Technical Reference ASSET ACP User Reference Guide

Array descriptions and information on some of the algorithms used in ASSET. Using ASSET ACP to plan and optimise networks automatically, designed as an aid for day-to-day planning. (Optional add-on to ASSET.)

CONNECT User Reference

Using CONNECT, the network transmission and microwave link planning software for full network physical link design and logical link design. Also contains CONNECT-specific reference information.

DATASAFE User Reference DIRECT User Reference

Using DATASAFE, our network configuration tool to implement both small and large scale changes to networks Using DIRECT to design telecommunications networks of different network layers. Explains how to plan cellular, PSTN and data networks at a both general and strategic level. Also contains DIRECT-specific reference information.

Financial Analysis User Reference Guide

Using the Financial Analysis module to evaluate and plan for the revenue potential of your network. (Optional add-on to ASSET and ADVANTAGE.)

ILSA User Reference Guide

Using ILSA, ASSET's automatic 2g frequency planning tool. (Optional add-on to ASSET.)

AIRCOM OPTIMA User Reference RANOPT User Reference WEBWIZARD User Reference

Using AIRCOM OPTIMA to view performance data and statistics both with ENTERPRISE and standalone. Using RANOPT to efficiently find faults in your network, optimise and validate its performance prior to commercial launch. Using WEBWIZARD to display GIS and report information of network data, including creating layers, regions, nodes, layer types, administering and configuring the system and using the GIS view, explorer and report viewers.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 17

Can You Improve Our User Assistance?


We are always trying to improve the online Help and User Reference Guides. If you cannot find the Help you were looking for, need more information, or have any suggestions for improvements, we would be grateful for your feedback. Also, if you are generally satisfied with these resources, we would appreciate any positive feedback. Online Questionnaire You can help us by completing our brief online questionnaire (http://www.surveymonkey.com/s.aspx?sm=RIRKLcrdvaCzRnUBNx5tcQ_3d_3d). Alternatively, you can contact us directly at docs@aircominternational.com.

Obtaining Support
If you have a difficulty you cannot resolve yourself using the online Help or Reference Guides, or you have found a possible fault in the software, you can log a support request. You may also wish to contact us if you want to: Register for a customer web account to access the Support area Obtain further documentation, such as application notes and extra reference information

Logging Support Requests Online To log a support request online: 1 2 3 4 5 6 Go to the AIRCOM website, at www.aircominternational.com. Click the link to Support. Log in, using your customer web account username and password. In the Technical Support pane, click Online Helpdesk System. Click Log New. Type the details of your request, and then click Log.

Page 18

AIRCOM OPTIMA User Reference Guide Version 6.2

Contacting us via Telephone or Email If you wish to contact us directly, here are the contact details of our regional offices:
Location Europe Regional Office United Kingdom Contact Details Tel : +44 1932 442000 Fax :+44 1932 442005 support@aircominternational.com Sweden France Italy Germany Belgium Middle East, Africa and Central Asia United Arab Emirates support@aircominternational.se support@aircominternational.fr support@aircominternational.it support@aircominternational.de support@aircominternational.be Tel : +971 4 391 2642 Fax :+971 4 391 8141 support@aircominternational.ae South Africa Tel : +27 11 745 1475 Fax : +27 11 465 1517 support@aircominternational.com Americas Mexico USA support@aircominternational.com.mx Tel : +1 214 576 2700 Fax : +1 214 576 2794 support@aircominternational.us Brazil Asia and Oceania Australia Singapore support@aircominternational.com.br support@aircominternational.com.au Tel: +65 6372 0548 Fax: +65 6372 0350 support@aircominternational.sg China Taiwan India support@aircominternational.cn support@aircominternational.com.tw Tel: +91 124 4102445-49 Fax: +91 124 41024500 support@aircominternational.in

When contacting us with a support query, it would help us if you: Give us as much information as possible about the problem and the context in which it occurred State the version and build you are using Have all the details of your query to hand Are logged into the ENTERPRISE application Can send extracts of your data sets if we need them to reproduce your problem

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 19

Obtaining Further Information and Services


As well as comprehensive online Help and User Reference Guides and dedicated Product Support, AIRCOM provides: Online Knowledgebase of Articles If you register for a customer web account, you can view our searchable technical database in the Product Support section of the AIRCOM website. This Knowledgebase contains articles created by our support professionals who have resolved issues for our customers, and is constantly updated, expanded, and refined to ensure that you have access to the very latest information. Power Tools If you register for a customer web account, you can download from a selection of useful power tools, such as file conversion utilities. Latest Copies of the User Reference Guides If you register for a customer web account, you can download the latest User Reference Guides (PDFs) from our website. If you do this, please check the back of the reference guides for any additions or corrections. Consultancy Services AIRCOM also provide full radio consultancy services in Network Audits, Business Planning Support, Licence Applications, Radio Network Planning, Telecommunications Research and System Modelling and Propagation Analysis and Modelling. Training There is a wide variety of courses run by AIRCOM. These courses range from tool training to technology training. For details, contact Competence Development Solutions (training@aircominternational.com).

Page 20

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 2

Installing AIRCOM OPTIMA


AIRCOM OPTIMA can be used in the following ways:
If using AIRCOM OPTIMA As part of the ENTERPRISE suite Then To ensure top performance, one of our teams needs to install and integrate AIRCOM OPTIMA to a network, configuring the collection of performance counters, data storage and the database. You should contact your system administrator to find out where on your network AIRCOM OPTIMA is installed, and to get a username and password. When you have this information, you can access AIRCOM OPTIMA without having to install anything. Over the Internet You should contact your system administrator to find out how to use AIRCOM OPTIMA over the Internet.

As a standalone product

About the Hardware and Software Requirements for AIRCOM OPTIMA


You can have one workstation for each client that wishes to use AIRCOM OPTIMA and ENTERPRISE. The hardware and software requirements are the same as the latest ENTERPRISE specification. For more information, see the ENTERPRISE User Reference Guide or confirm with Product Support, who can be contacted on one of the numbers shown in Obtaining AIRCOM Support on page 18.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 21

Installing AIRCOM OPTIMA


You can install AIRCOM OPTIMA in two ways: As part of ENTERPRISE Standalone

Installing AIRCOM OPTIMA as Part of ENTERPRISE


To use AIRCOM OPTIMA as part of the ENTERPRISE suite, one of our teams needs to install and integrate AIRCOM OPTIMA to a network. This ensures maximum performance by configuring the collection of performance counters, data storage and the database.

Installing a Standalone Version of AIRCOM OPTIMA


A standalone version of AIRCOM OPTIMA has been produced so that: You do not have to have any other ENTERPRISE products installed to run AIRCOM OPTIMA You can run AIRCOM OPTIMA over the network with no installation necessary on your own PC

The standalone version does not contain the Map View window or the ENTERPRISE database and filters. Follow these instructions if you want to use the standalone version: 1 If you are installing AIRCOM OPTIMA using the InstallShield program on the ENTERPRISE CD, when selecting components, select the AIRCOM OPTIMA Program option, but ensure that the AIRCOM OPTIMA Integration option is not selected:

or Contact your system administrator to find out where on your network the standalone version is located, and get a username and password.
Page 22 AIRCOM OPTIMA User Reference Guide Version 6.2

Locate the AIRCOM OPTIMA.exe and open it. You can now start using AIRCOM OPTIMA.

Updating Data
When connected to the network switches and the database, AIRCOM OPTIMA updates itself and automatically adds new sites and counter data when necessary. This data collection process is one-way only. AIRCOM OPTIMA cannot modify the network.

About Maintenance and Security


AIRCOM OPTIMA should need no maintenance except for installing any upgrades. However, it is recommended that companies have an on-site Oracle database administrator to attend to any database related problems promptly. The Oracle server handles security and each user is required to log in before any statistics can be obtained.

Accessing Data from Outside of AIRCOM OPTIMA


It is possible to have direct access to AIRCOM OPTIMA's data and configuration tables from outside AIRCOM OPTIMA - for example, using SQLPLUS or TOAD. However, for most users, this is just read-only access - for example, they cannot edit or delete any data or tables. A special 'power user', the DBACCESS user, can access the database to create new objects. In Oracle, when the AIRCOM OPTIMA database is created, all users are assigned the Oracle role 'OPTIMA_DEFAULTS', which does not require a password. A separate, dedicated role exists for each AIRCOM OPTIMA user type, which have certain privileges specific to that user type. This table describes the roles assigned to the different user types in AIRCOM OPTIMA:
User Type OPTIMA_ADMINISTRATOR OPTIMA_ADVANCED_USER OPTIMA_USER OPTIMA_USER_ADMINISTRATOR OPTIMA_ALARM_ADMINISTRATOR Role OPTIMA_ADMINISTRATORS OPTIMA_ADVANCED_USERS OPTIMA_USERS OPTIMA_USER_ADMINISTRATORS OPTIMA_ALARM_ADMINISTRATORS

These roles are assigned to users when they are created in AIRCOM OPTIMA. For more information, see Creating Users on page 78. Because grants are assigned through roles, users cannot grant themselves other rights.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 23

Starting AIRCOM OPTIMA Using a Web Interface


You can start AIRCOM OPTIMA in two different ways, depending on how it has been installed: 1 As a local application - to do this, see Logging Into AIRCOM OPTIMA on page 26. Using a web interface, such as Citrix Ensure that you have installed the required Citrix Presentation Server Client, which can be obtained from the Citrix client download site (http://www.citrix.com/site/SS/downloads/index.asp). Depending on how your web interface is configured, you may be prompted to do this later on before you log in. 2 Open a web browser, and navigate to your web interface log in page. If you do not know the web address for this page, contact your system administrator. This picture shows an example log in page:

To start AIRCOM OPTIMA using Citrix:

While this example shows the typical elements that the log in page can include, it is company-specific, and your own page will be different. 3 In the Log in pane, select your domain, and then type your corresponding user name and password.
AIRCOM OPTIMA User Reference Guide Version 6.2

Page 24

4 5

Click Log In. The Citrix Access Platform page appears. This picture shows an example:

Like the log in page, this shows the typical elements that can be included, but it is company-specific, and your own page will be different. 6 7 In the Applications pane, navigate to the AIRCOM OPTIMA icon, and doubleclick it. You can now log in to AIRCOM OPTIMA. For information on how to do this, see Logging in to AIRCOM OPTIMA on page 26.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 25

Logging Into AIRCOM OPTIMA


To log into AIRCOM OPTIMA as part of ENTERPRISE: 1 2 3 4 Start ENTERPRISE and log in to the relevant database. Select the project you require, and then click the Info>> button. Scroll to the OPTIMA Login tab On this Login tab: Select the appropriate database in the DataSource box. An Oracle connection name is specified here, not ODBC. Type your UserId and Password then click OK.

After you have logged in, you can change your password. For more information, see Changing your Password on page 29. 5 In the Start Project dialog box, click Start. AIRCOM OPTIMA opens, and the Quick Help welcome screen appears. For more information, see About the Quick Help Screen on page 28. 6 If your network is spread across multiple time zones and your OPTIMA_Administrator has defined time zones in the AIRCOM OPTIMA Installation Tool, in the dialog box that appears, select the time zone that you are currently in, and click OK:

The Message Log shows which time zone is being used by the user currently logged in:

You can also change the current time zone at any time, on the Time Zone tab of the User Preferences dialog box. For more information, see Setting the Time Zone on page 61.

Page 26

AIRCOM OPTIMA User Reference Guide Version 6.2

To log into the standalone version of AIRCOM OPTIMA: 1 2 Open the standalone version. To do this, from the Start menu, point to Programs, AIRCOM International, ENTERPRISE Version, AIRCOM OPTIMA. In the AIRCOM OPTIMA Login dialog box, type your User Name and Password, and select the Service to which you want to connect.

Click OK. The standalone version of AIRCOM OPTIMA opens, and the Quick Help welcome screen appears. For more information, see About the Quick Help Screen on page 28. If your network is spread across multiple time zones and your OPTIMA_Administrator has defined time zones, in the dialog box that appears, select the time zone that you are currently in, and click OK. Once you have logged in, you can change your password. For more information, see Changing your Password on page 29.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 27

About the Quick Help Screen


When you first open AIRCOM OPTIMA, the Quick Help welcome screen appears.

Quick Help welcome screen

This provides a reduced version of the main Help, and can be used as a brief 'look-up' reference for AIRCOM OPTIMA. By default, it appears every time you log in. To turn it off: In the Quick Help screen, de-select the 'Always show quick reference on login' option:

To turn it back on: 1 2 In AIRCOM OPTIMA, from the Help Menu, click Quick Reference. The Quick Help welcome screen appears. Select the 'Always show quick reference on login' option:

Page 28

AIRCOM OPTIMA User Reference Guide Version 6.2

Changing your Password


When you use AIRCOM OPTIMA for the first time, you must log in to the database with the username and password created by the OPTIMA_Administrator or OPTIMA_User_Administrator. However, after you have logged in to AIRCOM OPTIMA, you can change your password. To change your password: 1 2 3 From the Tools menu, click Change Password. The Change Password dialog box appears. Type your old password, new password and confirm your new password. Click OK. Next time you log in to the database, you must use your new password.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 29

Page 30

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 3

About the AIRCOM OPTIMA User Interface


The user interface consists of a number of elements, which enable you to: View, compare and analyse counter information for network elements using grids and graphs Customise windows and reports Define how objects, such as modules and grids, function Search for objects such as modules and reports

About the Main AIRCOM OPTIMA Toolbar


To quickly access the frequently used functions, use the AIRCOM OPTIMA toolbar:
Main Toolbar

This picture shows the toolbar for the standalone version of AIRCOM OPTIMA, which contains all of the main options. The toolbar for AIRCOM OPTIMA when used as part of ENTERPRISE contains a small number of additional options, described in the table below. This table describes the toolbar functions:
Button Name Exit AIRCOM OPTIMA Login/Logout Open/Close Project New 2D View Data Explorer Filter Explorer Description Close the current project and exit the tool. Login to and logout of the database but keep ENTERPRISE running. Open and close projects but keep ENTERPRISE running. Open the 2D Map View. For more information, see Displaying Performance Data on the Map on page 281. Open the Data Explorer. For more information, see About the Data Explorer on page 63. Open the Filter Explorer. For more information, see Using the Filter Explorer on page 213.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 31

Button

Name Element Hierarchies Explorer KPI Manager Module Explorer

Description Open the Element Hierarchies Explorer. For more information, see Using the Element Hierarchies Explorer on page 171. Access the KPI Manager. For more information, see About KPIs on page 133. Access the Module Explorer in which you can view and use modules. If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can also create, modify and delete modules. For more information, see About Modules on page 153.

Combination Explorer

Access the Combination Explorer from which you can view and use module combinations. If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can also create, modify and delete combinations. For more information, see About Combination Windows on page 179.

New Combination New Work Area Report Explorer Schedule Explorer

Create a new AIRCOM OPTIMA window for viewing data. For more information, see Creating Combination Windows on page 185. Access a New Work Area. For more information, see Creating a New Work Area on page 274. Access the Report Explorer. For more information, see About Using Reports on page 288. Access the Schedule Explorer. You can only schedule reports if you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User. For more information, see Scheduling When Reports Run on page 354.

Counter Legend OPTIMA Login Main Clock

Access the Counter Legend. For more information, see About the Counter Descriptions Window on page 66. Retry your login. This button is only enabled if you have had an unsuccessful login attempt. Access the main clock. For more information, see Using Clocks on page 68.

About the Favourites Toolbar


The Favourites toolbar is enabled after you have saved one or more favourites and is next to the Main Toolbar. This picture shows an example of the Favourites toolbar:

Favourites toolbar

If you have created a report, module combination or work area that you will reuse frequently, you can save it as a favourite. When you save it as a favourite you also select a button to be added to the Favourites toolbar. For information about saving favourites, see Adding and Editing Favourites on page 194.

Page 32

AIRCOM OPTIMA User Reference Guide Version 6.2

About the AIRCOM OPTIMA Menus


Above the AIRCOM OPTIMA toolbar are a series of menus. This table describes the menu options, some of which are only available if you are running AIRCOM OPTIMA as part of ENTERPRISE:
From the: File menu You can: Exit from the database and close AIRCOM OPTIMA. If you are using AIRCOM OPTIMA with ENTERPRISE, other menu items will be available. For further information about these items, see the ENTERPRISE User Reference Guide. Edit, View, Database and Equipment menus Inspector menu Access features available if you are using AIRCOM OPTIMA with ENTERPRISE. For further information about these menus, see the ENTERPRISE User Reference Guide. Access the Module Explorer. Access the Combination Explorer. Create a New Combination. Create a New Work Area. Reporter menu Access the Report Explorer. Access the Schedule Explorer. KPI menu Access the KPI Manager. Access the Global KPI. Favourites menu Add and edit Favourites. Export and import Favourites. Alarms menu Administrator menu Access the Alarms Explorer and Alarms Handler Explorer. Access Counter information. Access miscellaneous information such as holiday entry and element ID translation. Configure database information such as database links. Manage security by creating users, groups and contacts. The Administrator menu is enabled only if you are an OPTIMA_Administrator or OPTIMA_User_ Administrator. Tools menu Login to AIRCOM OPTIMA only available if your initial attempt to login was unsuccessful. Access the User Preferences dialog box. Change your password. Access the Data Explorer. Access the Element Hierarchies Explorer. Access the Filter Explorer. View the Counter Legend. Access the Windows List, which enables you to locate and switch to an open window. Modify the Main clock. Windows menu Help menu Access the AIRCOM OPTIMA Message Log. Access the Help. Access the Licence Manager. View information about ENTERPRISE, for example the build number.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 33

About the Module Explorer


In the Module Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can set up access to data by defining modules. Modules are used in the same way that you would use a template to customise the data you want to display. To open the Module Explorer: From the Inspector menu, click Modules. - or Click the Module Explorer button .

The Module Explorer opens. This picture shows an example:

The Module Explorer is divided into two areas: The left-hand pane contains a directory structure in which modules are stored The right-hand pane displays the modules in each folder, as either a simple list or a detailed list, containing additional information such as the module description, current state (enabled or not enabled) and so on. To change the view, right-click in the pane, and from the menu that appears, point to View and click either List (for the simple list) or Details (for the detailed list) as required. To view a module, double-click the module name.

Page 34

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Module Combination Explorer


In the Module Combination Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage module combinations, which use modules to display specific data in grid and graph format. To open the Module Combination Explorer: From the Inspector menu, click Module Combinations. - or Click the Combination Explorer button .

The Module Combination Explorer opens. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 35

About the Report Explorer


In the Report Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage reports of performance data. To open the Report Explorer: From the Reporter menu, click Reports. - or Click the Report Explorer button .

The Report Explorer opens. This picture shows an example:

Page 36

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Schedule Explorer


In the Schedule Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage schedules for when reports will run. To open the Schedule Explorer: From the Reporter menu, click Schedules. - or Click the Schedule Explorer button .

The Schedule Explorer opens. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 37

About the KPI Manager and Global KPI Explorer


In the KPI Manager, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage KPIs to show collected key performance data in modules and combination windows, and on the Map View window. To open the KPI Manager: From the KPI menu, click KPI Manager. - or Click the KPI Manager button . The KPI Manager opens. This picture shows an example:

In the Global KPI Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage global KPI views, which consist of a single view showing all existing common public KPIs for various vendor tables.

Page 38

AIRCOM OPTIMA User Reference Guide Version 6.2

To open the Global KPI Explorer: From the KPI menu, click Global KPI. The Global KPI Explorer opens. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 39

About the Favourites Dialog Box


In the Favourites dialog box, you can save module combinations, reports and work areas as favourites. This means you will have fast and easy access to information, via a customised toolbar. The toolbar contains a shortcut button for each favourite you save and is enabled after you have saved one or more favourites. To open the Favourites dialog box: From the Favourites menu, click Open Favourites. The Favourites dialog box opens. This picture shows an example:

Page 40

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Alarms Explorer


In the Alarms Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage alarms. To open the Alarms Explorer: From the Alarms menu, click Alarms. This picture shows an example:

From the Alarms Explorer toolbar you can create alarm definitions and folders and view alarm definition logs. This picture shows an example of the Alarms Explorer toolbar:
Alarms Explorer toolbar

This table describes the buttons on the Alarms Explorer toolbar:


Button Description Exit the Alarms Explorer. Move up one level in the folder hierarchy. Create a new folder. Create a new alarm definition. Edit an alarm definition. Delete an alarm definition. Display the alarm definitions in a simple list format (name only).

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 41

Button

Description Display the alarm definitions in a more detailed list format (name, description, next scheduled date and so on).

In AIRCOM OPTIMA, there are a number of alarm types:


Alarm Type Performance Description Performance alarms enable you to set network counter thresholds or key performance indicators (KPIs) and then receive alerts whenever network conditions are not met. Network data is processed, at user defined intervals, by AIRCOM OPTIMA. This data is stored in database tables in the form of counters. Ripple counts are used to define the threshold conditions for setting or clearing alarms. The information from these alarms can be: Queried in modules and reports Viewed in the Alarms Explorer Passed on to a fault management system Performance alarms are based on SQL queries written in AIRCOM OPTIMA. System System alarms are alarms raised on AIRCOM OPTIMA events, not performance data events. System alarms are based on SQL queries written in AIRCOM OPTIMA. Threshold Crossing Alert (TCA) TCAs are loader-specific alarms, which are raised as data is loaded into the AIRCOM OPTIMA database using the Loader. They indicate a discrepancy between the expected values according to the defined thresholds and the data loaded into the database after any modification during the loading process. TCAs are based on columns loaded into raw tables.

Important : OPTIMA_Administrators can configure and view performance and system alarms, and TCA handlers OPTIMA_Alarm_Administrators can only configure and view performance alarms OPTIMA_Advanced_Users and OPTIMA_Users can only view performance alarms

In the Alarms Explorer, the performance and system types are shown on separate tabs:

Performance and System tabs in the Alarms Explorer

Page 42

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Alarms Handler Explorer


In the Alarms Handler Explorer, OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can create and manage alarms handlers. To open the Alarms Handler Explorer: From the Alarms menu, click Alarms Handlers. This picture shows an example:

From the Alarms Handler Explorer toolbar you can view, create, edit and delete alarm handlers. This picture shows an example of the Alarms Handler Explorer toolbar:
Alarms Handler Explorer toolbar

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 43

This table describes the buttons on the Alarms Handler Explorer toolbar:
Button Description Exit the Alarms Handler Explorer. Move up one level in the folder hierarchy. Create a new folder. Create a new alarm handler definition. Edit an alarm handler definition. Delete an alarm handler definition. Display the alarm handler definitions in a simple list format (name only). Display the alarm handler definitions in a more detailed list format (name, description, next scheduled date and so on).

Setting Administrator Options


If you are an OPTIMA_Administrator, you can set the following global settings (which are not specific to a particular user):
Option Type General Description Enables you to: Sandbox Partition Maintenance Choose to show Cancel dialog boxes Set the maximum tree size for a module hierarchy Choose to prompt users to save combination templates when closing a combination Choose to select all elements for the selected counter in combination graphs Set AIRCOM OPTIMA client settings Define the WEBWIZARD URL from which users will access WEBWIZARD Choose which tables and schemas are not shown in the Data Explorer

Enables you to allocate individual quotas for your users to use space in the 'sandbox' environment, so that they can create sandbox views in the Data Explorer. Enables you to set retention periods (partition maintenance) for the partitioned tables in the database.

Page 44

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting General Administrator Options


The General Administrator Options dialog box contains a number of the settings that an OPTIMA_Administrator can configure globally for users. These include: The connection details for the AIRCOM OPTIMA email client The URL for accessing WEBWIZARD Miscellaneous options, such as choosing to show Cancel dialog boxes when executing queries and setting a maximum number of nodes a module can display From the Administrator menu, click General Options. The General Administrator Options dialog box appears. This picture shows an example:

To set general administrator options: 1

Click the General Options tab.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 45

On this tab, you can set the following options:


Item Cancel Query Description If you want to provide a Cancel dialog box to users when they execute a query, ensure that the Enable checkbox is selected. This picture shows an example Cancel dialog box:

It is recommended that you select this option. Module Tree Size In order to protect memory consumption, set the maximum number of nodes that a module can display. The higher the value, the larger the module size allowed, and therefore the larger the amount of memory that may be needed to run the module. If this number is exceeded, then the module tree will not load within a combination, and an error message is shown:

The recommended value is 100,000. Combination Templates Combination Graphs If you want to prompt users to update the combination template when they close a combination, select this option. If you want to select all of the elements for a selected counter when showing combination graphs, select this option.

Click OK to save these settings.

For more information on how to set the connection details for the AIRCOM OPTIMA email client, see Setting Email Client Options on page 47. For more information on defining the URL that will be used to access WEBWIZARD, see Setting WEBWIZARD Options on page 49. For more information on defining which schemas and tables you want to exclude from the Data Explorer and other modules, see Setting Which Tables and Schemas to Exclude from the Data Explorer on page 50.

Page 46

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting Email Client Options


In the General Administrator Options dialog box, on the Email Client Settings tab, you can define the email client. When you set this option, the client overrides your system's default mail client to use the email client settings when emailing reports. The Email Client Settings check will not run if the virus check on your system is blocking emails. Ensure that you turn off the virus check before you set the email client options. To set the email client options: 1 2 From the Administrator menu, click General Options. In the General Administrator Options dialog box, click the Email Client Settings tab. This picture shows an example:

3 4 5 6 7

Select the Use AIRCOM OPTIMA Client checkbox. In the SMTP Server box, type the name of the SMTP server. In the Port Number box, type the port number. In the Report "From" address field box, type the name of the user from whose email ID the email will be sent. If you want to use authentication, select this option, and then type the SMTP user name and password. If you want to check the connection to the email client, click Test Connection.

Click OK.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 47

After you have set these options, this email client is displayed when you export a report to email:

Example of displayed email client

Tips: You can click To or Cc to open the Address Book to retrieve the email addresses. Once you have set your email address, click Test Connection to check your connection. When this succeeds, click Send to export the report via email.

Page 48

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting WEBWIZARD Options


In the General Administrator Options dialog box, on the Web Wizard tab, you can specify the URL from which users can access WEBWIZARD. This bypasses the WEBWIZARD login, and automatically authenticates the user based on their AIRCOM OPTIMA login details. The URL must contain a number of components:
Item loginuser password Description The user name with which you want to log in. This user must already exist in WEBWIZARD. The password associated with the loginuser. If you choose to encrypt the password, by setting the EncryptPW to 'true', it will be shown as a set of encrypted characters in the URL displayed in WEBWIZARD. Indicates whether the password is encrypted ('true') or not ('false'). The first instance is the name of the favourite that will be loaded. The second instance should be set to 'true'. region minEast maxEast minNorth maxNorth date filter layersOn zoomFeatureId zoomLayerName zoomFactor ShowExplorer GISMode The date that will be applied to the GIS. The name of the filter that will be applied to the GIS. Indicates which layers are initially switched on, specified as a comma-separated list. The identity of a feature (for example, a cell) that will be zoomed into when the region is launched. The name of the layer to which the zoomed-in feature belongs. Indicates by how much the feature will be zoomed into. Indicates whether to show the WEBWIZARD Explorer tree ('true') or not ('false') when the region is launched. Indicates whether to launch the region in standard WEBWIZARD mode ('WW') or Virtual Earth mode ('VE'). The name (and location) of the region that will be launched when WEBWIZARD is opened. Define the initial extent of the region. These parameters are optional. If they are not set, then WEBWIZARD loads the favourite with the extents that were defined when it was created.

EncryptPW favLink

This shows an example URL: http://localhost/webwizard/logon.aspx?loginuser=demouser&password=d`feg&En cryptPW=true&favLink=select region.aspx^region=C:\Inetpub\wwwroot\WW62DEV\WebWizard\Published\UK LatLonVE\LYRX_UK.jpg|favLink=true|date=1/1/112:0:0|filter=All|layersOn=LYR2_UK_UMTSCells,|zoomFeatureId=Cell1a|zoomLa yerName=LYR2_UK_UMTSCells|ShowExplorer=false|zoomFactor=5|GISMode=VE This URL would automatically login to WEBWIZARD as 'demouser', and launch the 'UK' region in Virtual Earth mode, zoomed into the feature 'Cell1a' (which is part of the 'UMTSCells' layer). The feature will also be highlighted.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 49

Setting Which Tables and Schemas to Exclude from the Data Explorer
On the Data Explorer Filters tab of the General Administrator Options dialog box, you can set the AIRCOM OPTIMA database tables and schemas that you want to exclude from the Data Explorer. This ensures that only the relevant tables and schemas are displayed, so that loading and locating information is faster. The selected tables and schemas are not deleted from the database, they are just removed from the Data Explorer display. To do this: 1 2 From the Administrator menu, click General Options. In the General Administrator Options dialog box, click the Data Explorer Filters tab:

This tab displays all of the tables and schemas that are excluded from the Data Explorer and the other associated modules. By default, a number of rarely used tables and schemas are excluded, but you can choose to include these if required. To do this, select the required table or schema and click Delete.

Page 50

AIRCOM OPTIMA User Reference Guide Version 6.2

To add a table or schema: In the appropriate pane, click the Add button. In the dialog box that appears, type the name of the table or schema, or a regular expression to specify a number of tables or schemas. If you are using regular expressions, only certain rules are allowed. For tables, you can only use regular expressions that follow the format 'A...Z a...z 0...9 *._'. For schemas, you can only use regular expressions that follow the format 'A...Z a...z 0...9 _'. Click OK. The tables/schemas are added to the list that are excluded from the Data Explorer and other modules. Selecting the required table/schema and clicking Edit - or Double-clicking the table/schema name.

You can also edit existing table and schema names by:

Click OK. Data from the chosen tables and schemas are removed from the Data Explorer. If you have the Data Explorer open already, click the Refresh button apply the changes. to

Setting Sandbox Options


In the Sandbox Options dialog box, you can allocate individual space quotas for your users to use in the 'sandbox' environment, where they can create sandbox views in the Data Explorer. For more information, see Saving a Query as a Custom View in the Sandbox on page 126. The Sandbox Options dialog box contains information on: Individual users' allocations and what percentage is used The sandbox as a whole, for example the total space available for all users

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 51

To view this information and define quotas for users: 1 From the Administrator menu, click Sandbox Options. The Sandbox Options dialog box appears. This picture shows an example:

You can sort the user data in a number of different ways: To sort the values in a particular column, click the column heading To filter the values in a particular column, click the drop-down arrow in the column heading, and from the list that appears, select the required value:

To group the values by a particular column, drag the column heading into the grey area above the table:

To re-order the columns, drag the column into the required position In the left hand User Data grid, select the user. Click in the corresponding Allocated (MB) column, type the new value, and then press Enter.

To edit the space allocation for a particular user:

Page 52

AIRCOM OPTIMA User Reference Guide Version 6.2

The % Used bar for that user is updated, along with the Sandbox Details pane. The Total Tablespace Usage bar of the Sandbox Details pane shows the total space allocated to users (marked in grey) and the amount of space actually used (marked in green). This picture shows an example:

If you want to set the same space allocation for more than one user: 4 Click each user while holding down the Ctrl key In the Set Global Allocate Space box type the required allocation (up to the specified maximum value) Click the Apply button

If you want to set an expiry period for sandbox views, select the Use Expiry Options checkbox, and in the Expiry Period box, type the required number of days. If you have chosen to set an expiry period, choose which action you want to take at the end of the expiry period: Delete the sandbox view from the database Revert the sandbox view into a normal user view

Click OK to save these settings.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 53

Setting Partition Maintenance Options


In the Partition Maintenance Options dialog box, you can set retention periods (partition maintenance) for the partitioned tables in the database. To do this: 1 From the Administrator menu, click Partition Maintenance. The Partition Maintenance Options dialog box appears. This picture shows an example:

To set a new retention period for a table: 1 2 3 4 5 6 7 8 1 2 3 Click the Add New button. In the dialog box that appears, select the required table from the list, and click OK. (Only tables which do not already have retention periods appear in this list.) Set the Partition Type (Daily, Weekly and so on). Set the Retention Period, that is, the number of partitions (backwards in time) that you want to save. Set the Pre-allocation Period, that is, the number of partitions you want to plan ahead for. Set the Priority number (2 is the highest, 10 is the lowest) which sets the partition maintenance priority. If required, specify the Next Process Date. Click OK. In the Table Name drop-down list of available partitioned tables, select the appropriate table. Edit or view the values as required. Click OK.

To edit or view existing retention periods:

Page 54

AIRCOM OPTIMA User Reference Guide Version 6.2

Defining User Preferences


There are a number of user preferences that you can define using the User Preferences dialog box, including setting your confirmation requests and grid preferences. These options, once defined, are stored in the database and will be available each time you use AIRCOM OPTIMA. User preferences are stored per username. When you exit AIRCOM OPTIMA, your user preferences are saved to the database. If another user with the same username as you then logs in, they will have your user preferences. To open the User Preferences dialog box: From the Tools menu, click User Preferences.

Setting Confirmation Requests


You can choose to have certain actions, for example opening a read-only copy of a module combination that is already open, confirmed before the action is carried out. To set confirmation requests: 1 2 From the Tools menu, click User Preferences. On the Confirmations tab, choose the required actions by selecting the Enable checkbox: Confirming the selection of an element in the module tree Confirming the selection of linked modules Confirming the opening of a read-only combination - that is, one already opened by another user

Click OK.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 55

Setting Grid Preferences


When a grid contains a large number of records, the background processing may slow down the speed with which data is shown in the grid. You can prevent this by disabling the tools after a given number of records are returned from a query. You can also set a limit on the number of values available to select from when you are filtering a column in a grid. To set preferences for the grid: 1 2 From the Tools menu, click User Preferences. On the Grid Settings tab, type the number of: Records after which tools will be disabled. Values available when filtering columns. Columns to load in the Data Explorer. You can override this option when you are using the Data Explorer.

Click OK.

Page 56

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting Expression Editor Preferences


When you define a query in the Expression Editor, you can choose what to insert when creating an expression. To set this: 1 2 From the Tools menu, click User Preferences. On the Expression Editor tab, select how you want the function to appear: As a function name only As a function name with parameters as well

Click OK.

Setting Security
If you are an OPTIMA_Administrator or OPTIMA_Advanced_User, you can assign a particular group to be the default owner of all new objects, such as reports and modules, that are created. If you do not do this, objects that you create will not be assigned to a default group and will be available to all users To set the default group for new objects: 1 2 From the Tools menu, click User Preferences. On the Security tab, select the default group for new objects from the drop-down list:

Click OK.

You can also assign owning groups at the individual object level, for example, for a specific report.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 57

Setting Default Grid Options


You can set grid options to use as your default settings for all of the grids in AIRCOM OPTIMA. For more information about grids, see Customising Grids on page 229. To set default grid options: 1 2 From the Tools menu, click User Preferences. On the User Defaults tab, on the Grid Options sub-tab, complete the following information:
In this field: Highlight Row Do this: Select this checkbox if you want the Row Highlight option to be set by default. For more information, see Viewing Details of a Single Network Element in a Grid on page 243. Select this checkbox if you want to autofit the columns of grids by default. Select this checkbox if you want the grid toolbar to be available by default. For more information, see About the Tools for Customising a Grid on page 230. Click this button to open the Font dialog box. In the Font dialog box, select how you want the text to appear and then click OK to save your changes.

Autofit All Columns Show Toolbar

Change Default Grid Font

This picture shows an example:

When you have finished, click OK to save your default settings and exit the User Preferences dialog box.

Page 58

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting Default Graph Options


You can set graph options to use as your default settings for all graphs. For more information about graphs, see Using Graphs on page 247. To set default graph options: 1 2 From the Tools menu, click User Preferences. On the User Defaults tab, click the Graph Options sub-tab. This picture shows an example:

On the General sub-tab, set the following options:


Use this option: 3D View Show Gaps Show Points Show Toolbar Auto marks Select all elements Show Weekends Show Holidays Weekend colour Holiday colour Background colour To: View graphs in 3D. Show gaps in graph data. Show data value points. Show the graph toolbar. Set the auto marks. Select all the elements automatically after you select the counter when displaying a graph for a particular combination. Show weekend data points. Show holiday data points Change the weekend colour. To do this, click the Change button and then, in the Colour dialog box that appears, click on the colour you want to use and click OK. Change the holiday colour. To do this, click the Change button and then, in the Colour dialog box that appears, click on the colour you want to use and click OK. Change the background colour. To do this, click the Change button and then, in the Colour dialog box that appears, click on the colour you want to use and click OK.

For more information about these options, see About the Tools for Customising a Graph on page 247 and Changing the Appearance of Graphs on page 248.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 59

On the Legend sub-tab: Select the Show Legend checkbox if you want a legend key to be displayed with all graphs. Set the alignment of the legend key, in the Legend Alignment pane, by clicking the required option such as Left, Right, Top or Bottom.

When you have finished, click OK to save your default settings and exit the User Preferences dialog box.

Setting Trace File Options


The trace file maintains a record of the SQL that is executed while you are logged in to AIRCOM OPTIMA. The following shows an example trace file entry: Timestamp: 29/06/2009 09:39:41 Select USER_NAME from SECURITY_USER where USER_NAME = :USER_NAME :USER_NAME = OPTIMA_ADMINISTRATOR Each time you logout and login again, the existing trace file is overwritten. The trace file can become very large if you are logged in for a long period of time. To set trace file options: 1 2 From the Tools menu, click User Preferences. On the Directories tab, complete the following information:
In this field Trace File Directory Do this Browse to the folder in which you want the trace file to be stored. If you want to create a new folder for the trace file, click the New Folder button. Create Trace File Select this checkbox if you want AIRCOM OPTIMA to create a trace file.

This picture shows an example:

Click OK.

Page 60

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting the Time Zone


If your network spans a number of time zones that have been defined by your AIRCOM OPTIMA_Administrator, a user must specify which time zone they are in when they log in for the first time. This is important for data handling purposes, particularly in relation to report scheduling. For more information, see Using AIRCOM OPTIMA Across Different Time Zones on page 62. This has to be specified immediately when you log in, but it can be changed at any time using the Time Zone tab of the User Preferences dialog box. To do this: 1 2 From the Tools menu, click User Preferences. Click the Time Zone tab. This picture shows an example:

Select the required time zone and then click Update. The time zone details in the Message Log are updated with the new time zone:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 61

The User Preferences dialog box also shows two additional times: The OS Time - this is the Operating System Time, and should match the PC clock. The Universal Time - this is based on the Universal Time Zone, which represents the time at the location of the database (recorded as the SYSDATE in the database).

Click OK.

Using AIRCOM OPTIMA Across Different Time Zones


If your network is spread across more than one time zone, the associated time zone difference can cause discrepancies in any AIRCOM OPTIMA application which handles data - particularly, report scheduling and summary. For example, you may be running a daily network summary that covers a network across multiple time zones. If the last hour of data from the farthest part of the network is 5 hours behind the rest of the network, there will be a delay of 5 hours on the summary. This in turn will affect the schedule. If time zone support is not used and the client and database machines are in different time zones, there could be ambiguity in scheduled time. You may also have network elements that have child nodes that span time zones - for example, MSCs with BSCs in regions that have different time zones. If time zone support is not used, this could cause problems because there would be data from two different time zones coming in - for example, 9am ET (Eastern Time) is 8am CT (Central Time). This means that if the BH is summarised at 9am, it would not be truly representative of the elements in both time zones. To manage time zone support, there are a number of different time definitions used in AIRCOM OPTIMA, which are described in this table:
Term Local Time Description Date and time of data, stored as the date and time of the data. Also known as consistent. Natural Time Universal Time Date and time of data, driven by the local time zone. Date and time of data, driven by the universal time zone. Also known as the System Time. Selected Time Date and time of data, driven by the selected time zone. By default, this is the same as the Universal Time. User Time Zone The time zone that the connected user/process is within. This is displayed in the AIRCOM OPTIMA Message Log. If the client is run over Citrix, the User Time Zone is still regarded as where the client is located, not where the Citrix server is located. Universal Time Zone The time zone in which the database is located. Also known as the System, Global or Database Time Zone.

Currently, time zone support for alarm forwarding is not available.

Page 62

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Data Explorer


In the Data Explorer you can view database tables and create modules and reports without being familiar with SQL. The Data Explorer can be launched from the main toolbar or from the Module Maker. For more information about the Module Maker, see Creating Modules on page 157. To open the Data Explorer: From the Tools menu, click Data Explorer. - or Click the Data Explorer button .

The Data Explorer opens. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 63

About the Filter Explorer


In the Filter Explorer, you can create, edit and delete personal, group, administrator and ENTERPRISE filters. For more information about the Filter Explorer, see Using the Filter Explorer on page 213. To open the Filter Explorer, either: From the Tools menu, click Filters. - or Click the Filters button .

The Filter Explorer opens. This picture shows an example:

Filter Explorer

Page 64

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Element Hierarchies Explorer


In the Element Hierarchies Explorer, you can create, edit and delete element hierarchies. Element hierarchies are re-usable SQL queries which enable you to display network elements in the form of a hierarchical tree. To open the Element Hierarchies Explorer: From the Tools menu, click Element Hierarchies. - or Click the Element Hierarchies button .

The Element Hierarchies Explorer opens. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 65

About the Counter Descriptions Window


The Counter Descriptions window displays a list of all the counters used in AIRCOM OPTIMA, grouped by vendor, along with any further information relating to each counter. You can only add, edit and delete counters if you are an OPTIMA_Administrator.

Counter Descriptions window

To view information about a counter: 1 From the Tools menu, click Counter Legend. or Click the Counter Legend button 2 3 4 .

In the Counter Descriptions window, select a vendor from the Vendor menu. In the Counter box, type the name of the Counter for which you want more information. Click Find. The counter is highlighted in the list. Any further information about the counter, if available, will be displayed.

Page 66

AIRCOM OPTIMA User Reference Guide Version 6.2

Switching Between Open Windows


When you are using AIRCOM OPTIMA, you may have many windows open at the same time. To make it easier to find the window you want, you can use the Window List. The Window List will show the names of the following explorer windows, if they are open: Combination Explorer Module Explorer Schedule Explorer Filter Explorer Data Explorer

You will also see listed any open work areas and combination windows. To switch to an open explorer, work area or combination: 1 From the Tools menu, click Show Window List. The Windows List dialog box appears:

In the Windows List: Double-click the window that you want to use. - or Select the window that you want to use and click Switch.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 67

Using Clocks
When running AIRCOM OPTIMA, it is common practice to have it connected to the system clock to show todays data. However, sometimes you will want to view and compare data for a different date and time. You can do this by using the global clock. To set the global clock: 1 From the Tools menu, click Clock. or Click the Clock button 2 3 4 5 .

In the dialog box that appears, ensure that the Set to system clock option is not selected. To change the year, click on the year at the top of the calendar and type the year that you want. Use the arrows to scroll to the correct month then click a date on the calendar. Click the hour and change the time as required, then repeat for minutes and seconds:

Providing there is data for that date, you can display the data in different ways: If you are using AIRCOM OPTIMA with ENTERPRISE, click Update Map to apply the time you have chosen to any open Map View window. For more information, see Viewing Data on the Map on page 281. To review data collected over the same period, ensure that in each combination window, in the Date Range pane, the Synchronise to global clock option is selected.

When you have finished reviewing data, you can reset the date and time to the system clock again by opening the global clock and selecting the Set to system clock option.

Page 68

AIRCOM OPTIMA User Reference Guide Version 6.2

Offsetting the System Clock


When data is collected by AIRCOM OPTIMA, there is usually a one hour processing delay before that data is available for use. You can take account of this delay by offsetting the system clock. To do this: 1 From the Tools menu, click Clock. or Click the Clock button 2 3 4 .

In the global clock's Offset pane, select the Enable checkbox. Select an offset period using the arrow keys and drop-down menu. Close the global clock.

Using the Find Dialog Box


You can use the Find dialog box to search for items, such as modules or reports, in the following explorers: 1 Module Explorer Combination Explorer Report Explorer Schedule Explorer Alarms Explorer From the View menu, click Find. - or Right-click a folder in the tree, and from the menu that appears, click Find. The Find dialog box appears. 2 Type the name (or part of the name) of the item you wish to find in the Name field. If you want to search for whole words or a full name only, select the Find Whole Words Only or Find Full Name Only checkbox as appropriate. If you are searching for a name, you cannot use the Find Whole Words Only option. 3 If you have chosen the Find option from the context menu, AIRCOM OPTIMA will search the currently selected folder. However, you can modify this search if required: To include the subfolders of the currently selected folder, select the Include Subfolders checkbox - or To search all folders, ensure that the Search Folder checkbox is not selected
Page 69

To search for an item in an explorer:

AIRCOM OPTIMA User Reference Guide Version 6.2

If you have chosen the Find option from the View menu, AIRCOM OPTIMA will automatically search all folders. 4 Click Search. All items that match the search criteria are displayed in the lower pane. If you type * in the Find dialog box, then all the items are displayed in the lower pane. This picture shows an example:

You can view an item in the list by double-clicking the item's name, and/or navigate the Explorer to a folder in the list by double-clicking the folder.

Accessing WEBWIZARD
WEBWIZARD is AIRCOM's web-based GIS and report distribution tool. It is powerful and easy to use. You can access WEBWIZARD from within AIRCOM OPTIMA. To do this: From the Tools menu, click WEBWIZARD. The URL address is set by an OPTIMA_Administrator. For more information, see Setting WEBWIZARD Options on page 49.

Page 70

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 4

About AIRCOM OPTIMA Administrator Tools


This section describes the tools that are available to OPTIMA_Administrators and OPTIMA_User_Administrators. Important : If you are an OPTIMA_Administrator, you can access the full Administrator menu If you are an OPTIMA_User_Administrator, you can access the Security Users and Groups options If you are any other role, you cannot access the Administrator menu

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 71

About the Database Config Settings


The Database Config Settings include the following: Database Links Regional Settings

About Database Links


In AIRCOM OPTIMA, you can create a Database Link. A Database Link is the way in which Oracle allows you to connect from one database to another. To create a Database Link: 1 From the Administrator menu, point to Database Config and click Database Links. This dialog box appears:

Click

. The Create Database Link dialog box appears:

Page 72

AIRCOM OPTIMA User Reference Guide Version 6.2

In this dialog box, specify the following details: In the Link Name text box, type the name of the link. In the Database to connect to text box, type the name of the database with which you want to create a link. You can get the name of the database that you want to link to from the tnsnames.ora file on your computer. In the User name and Password for connection text boxes, provide the user name and password that you have set for that database.

Click OK. The new link will appear in the Database Links dialog box.

Once you have created a Database Link, you can use it in the SQL tab in the Data Explorer to get data from another database in the following way: Suppose you have created a database link OPT_620_LINK as shown above. Now in the SQL tab of the Data Explorer, type the following SQL statement: Select * from CellStats@OPT_620_LINK where: CELLSTATS is the name of the table in the OPT_DEV_620 database OPT_620_LINK is the name of the database link It is important to write the SQL query in the following syntax: Select * from TableName@DatabaseLinkName Now, when you click , the information will be retrieved from the OPT_DEV_620 database and displayed.

About Regional Settings


The Regional Settings dialog box enables you to change the country settings for AIRCOM OPTIMA. To do so: 1 From the Administrator menu, point to Database Config and click Regional Settings. The Regional Settings dialog box appears:

2 3

From the drop-down list, select the country where you are currently. Click OK to save your changes.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 73

About AIRCOM OPTIMA Security


In AIRCOM OPTIMA, there are two ways to configure security. These are: At user level by assigning roles, for example, you can choose to give a user readonly access by making them an OPTIMA_User At object level using groups, for example, you can choose to allow a group of users access to certain reports in the Schedule Explorer Create groups before you can restrict access to specific objects Assign users to each group, they will inherit the permissions of the group OPTIMA_Administrators have write-access to all features and objects. Important : Only OPTIMA_Administrators and OPTIMA_User_Administrators can create, edit and delete groups and users User Administrators can only create, edit and delete OPTIMA_Advanced_Users and OPTIMA_Users

You must:

Example of Using Groups and Users to Configure Security


First, you create these groups: North_Team South_Team

AIRCOM OPTIMA Groups dialog box

Page 74

AIRCOM OPTIMA User Reference Guide Version 6.2

Then you create these users:


User John Pierre Emma Member Of North_Team Everyone North_Team Everyone South_Team Everyone Role OPTIMA_Advanced_User OPTIMA_User OPTIMA_Advanced_User

You can then use these groups to limit access to the folders in the Schedule Explorer, as shown here:

The results are: John can view and run schedules in the NorthCity_A folder and, as he is an OPTIMA_Advanced_User, he can also create schedules in this folder. John cannot view or create schedules in the SouthCity_A folder. Pierre can view and run schedules in the NorthCity_A folder, but as he is a OPTIMA_User, he cannot create schedules. Pierre cannot view schedules in the SouthCity_A folder. Emma can view and run schedules in the SouthCity_A folder and, as she is an OPTIMA_Advanced_User, she can also create schedules in this folder. Emma cannot view or create schedules in the NorthCity_A folder.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 75

Creating Groups
In AIRCOM OPTIMA, you can create groups and then use these groups to give access to objects. The group Everyone is automatically created and includes all users. You cannot edit the Everyone group. To create a group: 1 2 3 From the Administrator menu, point to Security and click Groups. In the dialog box that appears, click New Group. In the New AIRCOM OPTIMA Group dialog box, type a name and description for the group. You can only use letters, numbers and the symbols $ _ and # in the group name. You cannot use spaces and you must use a letter or number for the first and last characters. 4 If you have already created the users that you want to become members of this group, click Add User. If you have not created any users, see Creating Users on page 78. Select the users you want to add to this group and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to highlight more than one user at a time and use the >> button to add all the users to the Destination List. 6 When you have finished adding users to the Destination List, click OK. The users who are members of this group are listed in the Members pane of the New AIRCOM OPTIMA Group dialog box. 7 Click Close to save the new group. You can now assign this group to the different objects, enabling the members of this group to use those objects. For more information, see Using Groups to Assign Access on page 77.

Editing and Deleting Groups


To add users to and remove users from a group: 1 2 From the Administrator menu, point to Security and click Groups. The AIRCOM OPTIMA Groups dialog box appears. Double-click the required group. - or Select the group and click the Edit Group button. 3 To add a user: Click Add Users. In the Select Users dialog box, select the users you want to add to this group and use the > button to move them to the Destination List.

Page 76

AIRCOM OPTIMA User Reference Guide Version 6.2

Use the Shift and Ctrl keys to select more than one user at a time and use the >> button to add all the users to the Destination List. 4 5 1 2 3 4 When you have finished adding users to the Destination List, click OK. Select the user and click the Remove User button.

To remove a user: Click Close to save the changes. From the Administrator menu, point to Security and click Groups. The AIRCOM OPTIMA Groups dialog box displays. Select the group and click the Delete Group button. Click Yes to confirm. If no objects are owned by the group, the group is deleted. However, if there are objects still owned by the group, then the Change AIRCOM OPTIMA Group dialog box appears. To select a new owning group for the objects: Select a group from the Group list and click the right arrow button. -or Double-click a group in the Group list. If you click Cancel, the group will not be deleted.

To delete a group:

6 7

Click OK. Click Close.

Using Groups to Assign Access


You can use groups to restrict access to objects and information held in AIRCOM OPTIMA. Groups can be assigned to objects in the following windows: Module Explorer Combination Explorer Report Explorer Schedule Explorer

For example, in the Schedule Explorer, you may have a folder that contains schedules that only one group of users will work with. This may be a regional group, for example, such as the South Team. You can make sure that only the South Team can access those schedules by assigning the South Team group to the folder. You must create groups before you can assign them. For more information, see Creating Groups on page 76.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 77

To assign a group to an object: 1 2 3 4 Open the appropriate explorer window from the menu or toolbar. Browse to the folder to which you wish to assign access and right-click the folder name. From the menu that appears, click Properties. In the dialog box that appears, click the Security tab and then click Add. A list of available groups appears. Select the group(s) you want to have access to this folder and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List. 5 6 Click OK. Select how you want the group permission to be applied:
Select Do not cascade permissions To Assign Access To The selected folder level and its objects only. Users of the group will not be able to access any subfolders unless they are a member of a group with access to those folders. The selected folder and its subfolders. This option will not overwrite any existing groups that have already been assigned to the folder or subfolders. The selected folder and its subfolders. This option overwrites existing groups that have already been assigned to the folder or subfolders.

Cascade permission changes to child folders Cascade all permission to child folders

Click OK to apply the group permissions to the folder.

Creating Users
To create a user: 1 2 3 From the Administrator menu, point to Security and click Users. In the dialog box that appears, click New User. On the General tab of the New AIRCOM OPTIMA User dialog box, add the following details:
In This Box Username Do This Type a name for the user, this is the name they will use to log in. You can only use letters, numbers and the symbols $ _ and # in the username. You cannot use spaces and you must use a letter or number for the first and last characters. Full Name Description Department Region Password, Verify Password Type the full name of the user. Type a description of the user's account if necessary. This field is not mandatory. Type the name of the user's department if necessary. This field is not mandatory. Type the name of the user's region - this could be actual location or the part of the country they work deals with, for example, a cell planner covering the North. This field is not mandatory. Type the password for the user, this is the password they will use to log in.

Page 78

AIRCOM OPTIMA User Reference Guide Version 6.2

In This Box User Access

Do This Select a role for the user. For more information about roles, see About AIRCOM OPTIMA User Roles on page 80. User Administrators can only create OPTIMA_Advanced_Users and OPTIMA_Users.

To assign groups to this user, click the Group Membership tab. The user is automatically a member of the group Everyone and this group is listed in the Group(s) pane.

5 6

On the Group Membership tab, click Add. In the dialog box that appears, select the groups you want this user to be a member of and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List.

When you have finished adding groups to the Destination List, click OK. The group(s) that this user is a member of are listed in the Group(s) pane of the New AIRCOM OPTIMA User dialog box.

If you want to assign contact information to the user: Click Assign Contact Info. Select the contact name and click Assign Contact. In the dialog box that appears, click OK Click Close to return to the AIRCOM OPTIMA Users dialog box. For more information about contacts, see Using Contacts on page 86.

Click Close to add the new user.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 79

About AIRCOM OPTIMA User Roles


There are a number of default roles for users in AIRCOM OPTIMA. They are created during installation and determine the level of system access for a user. You can further define a user's access by assigning groups. For more information about groups, see About AIRCOM OPTIMA Security on page 74. The default roles are:
Object/Role Administrator Menu Administrator Full access User Administrator Security > Users : View Add Edit Delete (Advanced Users and Users only) Security > Groups : View Add Edit Delete Alarms Performance No access Alarms and System Alarms : View Add Edit Delete Alarm Handlers Performance Alarms, System Alarms and TCAs : View Add Edit Delete No access Performance Alarms : View Add Edit Delete No access No access Performance Alarms : View Add Edit Delete Performance Alarms : View Performance Alarms : View Alarm Administrator No access Advanced User No access User No access

Page 80

AIRCOM OPTIMA User Reference Guide Version 6.2

Object/Role Combination Windows

Administrator View Add Edit Delete Restrict editing Restrict access Import Export Add to Favourites

User Administrator No access

Alarm Administrator View Add Edit* Delete* Restrict editing** Import Export

Advanced User View Add Edit* Delete* Restrict editing** Import Export

User View* Add Edit* Delete* Restrict editing** Import Export Add to Favourites

Add to Favourites Add to Favourites

* If granted object * If granted object access * If granted object access access ** If granted group object ** If granted group object ** If granted group ownership ownership object ownership No access View Add Edit* Delete* Import* Export View Add Edit* Delete* Import* Export View* Add Edit* Delete* Import* Export

Combination Folders

View Add Edit Delete Restrict editing and access Import Export

* If granted object * If granted object access * If granted object access access No access View (for scheduling purposes) View (for scheduling purposes) No access

Contacts

View Add Edit Delete

Counters

View Add Edit Delete

No access

View

View

View

Categories (Table Properties dialog box)

View Add Edit Delete

No access

No access

No access

No access

Element Hierarchies

View all types (personal, group, system) Add Edit Delete

No access

View personal, system and group*

View personal, system and group*

Add personal and group* Add personal and Edit personal and group* group* Edit personal and Delete personal group* Delete personal * If granted group object ownership * If granted group object ownership

View system and group (if granted group object ownership)

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 81

Object/Role Filters

Administrator View all types (personal, group, system) Add all types Edit all types Delete all types Restrict access

User Administrator No access

Alarm Administrator View personal, system and group* Add static and dynamic filters Add personal, system and group*

Advanced User View personal, system and group* Add static and dynamic filters Add personal, system and group*

User View personal, system and group (if granted group object ownership) Add static personal filters Edit static personal filters

Delete static personal Edit personal and group* filters

Edit personal and Delete personal group* * If granted group object ownership Delete personal * If granted group object ownership KPIs View all types (personal, group, admin) Add all types Edit all types Delete all types Import Export Restrict access Create KPI views No access View personal, View personal, admin admin and group* and group* Add personal and Add personal and group group Edit personal and group* Edit personal and Delete personal group* Import as public Delete personal (EVERYONE group) and Import as public personal (EVERYONE Export group) and personal * If granted group object ownership Export * If granted group object ownership Global KPIs View Add Edit Delete Modules View Add Edit Delete Restrict editing Import Export Restrict access No access View Add Edit Delete View Add Edit Delete View No access No access No access No access View personal, admin and group (if granted group object ownership) Add personal Edit personal Delete personal Import as personal Export

Restrict editing (if Restrict editing (if granted group granted group object object ownership) ownership) Import Export Import Export

Page 82

AIRCOM OPTIMA User Reference Guide Version 6.2

Object/Role Module Folders

Administrator View Add Edit Delete Restrict access Import Export

User Administrator No access

Alarm Administrator View Add* Edit* Delete* Rename Import ** Export * If granted access to the parent folder ** If granted access to the destination folder

Advanced User View Add* Edit* Delete* Rename Import ** Export * If granted access to the parent folder ** If granted access to the destination folder

User View

Reports

View Add Edit Delete Restrict access and editing Import Export report definition and reports in any format Add to Favourites Restrict access Schedule

No access

View Add Edit Delete Restrict editing Import Export report definition and reports in any format Schedule

View Add Edit Delete Restrict editing Import Export report definition and reports in any format Add to Favourites

View Add to Favourites Export reports in current format

Add to Favourites Schedule

Report Folders

View Add Edit Delete Import Export Restrict access

No access

View* Add* Edit* Delete* Import* Export * If granted access to the parent folder

View* Add* Edit* Delete* Import* Export * If granted access to the parent folder

View

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 83

Object/Role Sandbox Views

Administrator View all types Add all types Edit all types Delete all types Create index Delete index (that the user has created) Create sandbox views (if the user has a quota)

User Administrator No access

Alarm Administrator View (if granted object access)

Advanced User View (if granted object access)

User View (if granted object access)

Add personal and Add personal and group group Edit personal and group* Edit personal and Delete personal and group* group* Delete personal Create index and group* Delete index* Create index Delete index* Create sandbox views (if the user has a quota) * That the user has created Create sandbox views (if the user has a quota) * That the user has created

Schedules

View Add Edit Delete Delete history Restrict access and editing

No access

View Add Edit Delete Delete history Restrict editing

View Add Edit Delete Delete history Restrict editing View* Add* Edit* Delete* * if granted access to the parent folder

View View history

Schedule Folders

View Add Edit Delete Import Export Restrict access

No access

View* Add* Edit* Delete* * if granted access to the parent folder

View

User Views

View all types (personal, group, system) Add all types Edit all types Delete all types Add to the Data Model

No access

View (if granted object access)

View (if granted object access)

View (if granted object access)

Add personal and Add personal and group Add personal group Edit personal and own Edit personal Edit personal and group Delete personal own group Delete personal and own Delete personal group and own group

Editing includes: Renaming objects Adding objects to folders, if the folders exist Copying and pasting objects, assuming the user has access to the destination folder

Page 84

AIRCOM OPTIMA User Reference Guide Version 6.2

Editing and Deleting Users


To edit user details and permissions: 1 2 From the Administrator menu, point to Security and click Users. The AIRCOM OPTIMA Users dialog box appears. Double-click the user that you want to edit. - or Select the user and click Edit User. You can change the password or the user group details. If you want to change the user name, you will have to recreate the user. To delete a user: If you delete a user, all of the information and objects owned by the user will be deleted (for example, any materialized views that they have created). 1 2 3 From the Administrator menu, point to Security and click Users. The AIRCOM OPTIMA Users dialog box appears. Select the user and click Delete User. Click Yes to confirm the deletion. The user is deleted. User Administrators can only edit and delete OPTIMA_Advanced_Users and OPTIMA_Users.

Changing Passwords
When a user logs into AIRCOM OPTIMA, they can choose to change their password. For more information, see Changing your Password on page 29. If a user forgets their password, and therefore cannot access AIRCOM OPTIMA, you can assign a new password to that user. To do this: 1 2 3 4 From the Administrator menu, point to Security and click Users. The AIRCOM OPTIMA Users dialog box appears. Select the user and click Edit User. Type and then verify the password. Click OK to save the changes.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 85

Using Contacts
In AIRCOM OPTIMA, you can save contact details for individual users and groups of users. These contact details are stored in the Address Book and, once saved, can be: Assigned when you create users. Selected in the Schedule Editor to determine who reports are emailed to. For more information about scheduling reports, see Scheduling When Reports Run on page 354. Selected in an alarm handler to determine who receives alerts when an alarm is raised. For more information about alarms, see Using Alarms on page 361. From the Administrator menu point to Security and then click Contacts. Contacts that contain a group of users are underlined and shown in green text. This picture shows an example:

To open the Address Book:

Address Book

In the Address Book, you can: Search the list of contacts by selecting a column from the Search column dropdown list and then typing the text you are looking for into the Search Text field. As you type text into the Search Text field, non-matching contacts are removed. To clear the search text and restore the list of contacts, click the Show all contacts button. You can use wildcards to represent characters in your search text. There are two wildcards you can use: Asterisk (*) - to represent zero or more characters. For example, if you type 'BSC*', you will find all the elements that begin BSC. Question mark (?) to represent a single character. For example, if you type 'BSC?', you will find all the four-character elements that begin BSC, such as BSC1 or BSC2.

Page 86

AIRCOM OPTIMA User Reference Guide Version 6.2

Filter the list of contacts by selecting All Groups or All Users from the Contacts type drop-down list. Sort the list of contacts by clicking on any of the column headings.

Adding, Editing and Deleting Contacts in the Address Book


To add a contact to the Address Book: 1 2 3 4 From the Administrator menu point to Security and then click Contacts. In the Address Book, click the Add User button Click OK. .

Type the details for the user in the appropriate boxes.

To edit a contact in the Address Book: 1 Highlight the user and click the Edit button - or Double-click the user name. 2 3 Edit the user's details as necessary. Click OK to save the changes. .

To delete a contact in the Address Book: 1 2 Highlight the user and click the Delete button .

In the Confirm dialog box that appears, click Yes to delete the user.

Adding a Contact Group to the Address Book


You can add a group of users as a contact group to the Address Book. This allows many individuals to receive the same: Report when a scheduled report is emailed. For more information about scheduling reports, see Scheduling When Reports Run on page 354. Alert when an alarm is set or cleared. For more information about alarms, see Using Alarms on page 361. Ensure you have created the users that you want to include in the group. For more information, see Adding, Editing and Deleting Contacts in the Address Book on page 87. From the Administrator menu point to Security and then click Contacts. In the Address Book, click the Add Group button Type a name for the group. If you want to send alarms to a group email address or phone number, type the email address and phone number.
Page 87

To add a contact group to the Address Book: 1

2 3 4 5

AIRCOM OPTIMA User Reference Guide Version 6.2

6 7 8 9

Add a note if necessary. Select the Active checkbox if you want this contact group to be able to receive alerts when an alarm is set or cleared. Click Modify Members. In the dialog box that appears, click Add. - or Type the name of the user and click Add. To change the properties of a user, click Properties and in the dialog box that appears make the changes required. These users are in addition to any users that are a member of the group email address that you may have typed earlier. You do not have to add those users here.

10 Select a user from the Name pane and click Add >.

11 When you have finished adding users, click OK and, in the dialog box that appears, click Yes. The users appear in the Group Members dialog box. To remove a user, highlight their name and click Remove. 12 Click OK to close the Group Members dialog box. 13 In the Group Properties dialog box, click OK and, in the Information dialog box click Yes to save the group. The contact group is shown, in green text, in the Address Book and can now be used with alarms.

Editing and Deleting Contact Groups


To edit a contact group: 1 Highlight the contact group and click the Edit button - or Double-click the contact group name. 2 3 4 Edit the details as necessary. Click Modify Members to add and remove users. Click OK to save the changes. .

To delete a contact group: 1 2 Highlight the group and click the Delete button .

In the Confirm dialog box that appears, click Yes to delete the contact group. Users in the contact groups are not deleted.

Page 88

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Table Editor


AIRCOM OPTIMA Administrators can use the Table Editor to edit the data in any table which has been added to AIRCOM.EDITABLE_TABLES. You add tables to AIRCOM.EDITABLE_TABLES using the database. If AIRCOM.EDITABLE_TABLES is empty, a message box is displayed when the Table Editor is opened. To open the Table Editor dialog box: From the Administrator menu, point to Editors and click Table Editor. The Table Editor dialog box appears. This picture shows an example:

You can use the options in the Search / Filter pane of the Table Editor dialog box to search for specific table rows and to filter table data. The permissions (insert, update, and/or delete) that you have for any selected table are displayed in red text at the bottom of the Table Editor dialog box. If you do not have a certain permission, then the relevant button above the table data is disabled.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 89

Adding, Editing and Deleting Rows in Tables


Adding a Row To add a row to a table: 1 2 From the Administrator menu, point to Editors and click Table Editor. The Table Editor dialog box appears. In the Table Editor dialog box, select the table you want to edit from the Table drop-down list. Table data is returned a few rows at a time. You can return all of the rows by scrolling to the end of data but this can take a few seconds for large tables. 3 4 5 6 Click the Insert Record button Click Apply to save your changes. Click OK to close the Table Editor dialog box. .

Type the required information on the new row marked with an asterisk.

Editing a Row To edit a row in a table: 1 2 3 4 5 In the Table Editor dialog box, select the table you want to edit from the Table drop-down list. Click the Edit Record button Click Apply to save your changes. Click OK to close the Table Editor dialog box. .

Highlight the row and type the required changes.

Deleting a Row To delete a row from a table: 1 2 3 4 5 In the Table Editor dialog box, select the table you want to edit from the Table drop-down list. Click the Delete Record button Click OK to confirm the deletion. Click Apply to save your changes. Click OK to close the Table Editor dialog box. .

Page 90

AIRCOM OPTIMA User Reference Guide Version 6.2

About Table and Field Information Settings


The AIRCOM OPTIMA Administrator can use table and field information settings to: Allow groups of users access to certain tables Set the granularity period for tables Set the table period for tables Assign tables to specific categories Assign summary tables to tables Add comments to tables and table columns

You configure table and field information settings in the Table and Field Info dialog box. Tables can be configured individually or all at the same time using the Settings Wizard. To open the Table and Field Info dialog box: From the Administrator menu, point to Data Dictionary and click Table and Field Info. This picture shows an example of the Table and Field Info dialog box.

Table and Field Info dialog box.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 91

Setting All Table and Field Information Settings Using the Settings Wizard
The Settings Wizard enables you to change permission, category and granularity period settings for one or more tables at the same time, rather than changing them individually. To set table and field information settings: 1 2 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select a table, category or schema:

This selection determines which tables will be available to configure in the Settings Wizard. For example, if you select a category or schema, then all of the underlying tables will be available. 3 From the Edit menu, click Change Settings. - or Right-click the schema, category or table you selected and then, from the menu that appears, click Change Settings. 4 On the first page of the Settings Wizard, select the tables you want to use and then click Next. If you want to select more than one table, hold down the Shift key and click the tables you want to select. You cannot apply permissions to tables marked in red as these are internal tables. If your selection includes internal tables, you must unselect them otherwise you will not be able to apply permissions. You can still apply category and granularity period settings to internal tables. 5 On the Table Permission page, select: The group you want to apply permissions to Whether the permissions are to be reset, updated or removed

For more information about table permissions, see Setting Table Security on page 93.
Page 92 AIRCOM OPTIMA User Reference Guide Version 6.2

6 7

Click Next. On the Table Info Settings page, select: The granularity period to be applied to all selected tables. For more information about granularity periods, see Setting the Granularity Period for a Single Table on page 94. The category to be applied to all selected tables. For more information about categories, see Assigning a Category to a Table on page 94.

8 9

Click Next. Click Finish to apply your settings and close the Settings Wizard.

Setting Table Security


In AIRCOM OPTIMA, you can configure security at the table level by using groups. For example, you can choose to allow a group of users access to certain tables. You must create groups before you can assign them. For more information, see Creating Groups on page 76. To set security for a table: 1 2 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the table and click the Modify Groups button. A list of available groups appears. You cannot apply permissions to internal tables (marked in red). If your select an internal table, the Modify Groups button will be disabled. 3 Select the group(s) you want to have access to this table and use the > button to move them all to the Destination List at the same time. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List. 4 5 6 Click OK. Click Apply to apply the group permissions to the table. Click Yes to confirm.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 93

Setting the Granularity Period for a Single Table


The granularity period is used by the Map View window to determine which is the nearest time stamp and therefore what data is returned. This means that you do not have to select the exact time stamp. For example, if you set the granularity period to 15 minutes, data for 13.00 will be displayed if you select 13.15. You can set the granularity period for a single table or use the Settings Wizard to set the granularity period for all the tables in a category or schema. This is usually done once during the initial set-up. To set the granularity period for a single table: 1 2 3 4 5 6 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the table you want to set the granularity period for. Click the Table Info tab. Click the Apply Table Granularity checkbox and in the Period column, use the up and down arrows to select the number of periods. Select a period type from the drop-down list. If you want to assign a table period, select the table period you require from the drop-down list. If you want to create a new table period, you can open the Table Properties dialog box by clicking the button Editing Table Periods on page 103. 7 8 Click Apply. Click Yes to confirm. . For more information, see Creating and

Assigning a Category to a Table


All database tables must be assigned a category to appear in the Data Explorer list of tables. When you create a new database table, a category is automatically assigned when you repopulate the Table and Field Info dialog box. For more information about repopulating tables, see Repopulating Data on page 98. However, you can also manually assign a category to a table. To do this: 1 2 3 4 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the table you want to set the category for. Click the Table Info tab. Click the Apply Table Category checkbox and select a category from the dropdown list.

Page 94

AIRCOM OPTIMA User Reference Guide Version 6.2

If you want to create a new category, you can open the Table Properties dialog box by clicking the button Categories on page 101. 5 6 Click Apply. Click Yes to confirm. . For more information, see Creating and Editing

For more information on categories, see About Categories on page 101.

Defining an Association for a Table


Associated tables associate a summary table/view with its source raw table and vice versa, and are used for: Synchronising table KPIs. For more information, see Synchronising Associated Tables on page 144. Time aggregation. For more information, see Enabling Time Aggregation for a Query on page 125. Generate associated tables when repopulating AIRCOM OPTIMA's data dictionary. For more information, see Generating Associated Tables Automatically on page 99. Manually define your own associations for a single table From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the table to which you want to assign an associated table. Click the Table Info tab.

In AIRCOM OPTIMA, you can define associated tables in a number of ways:

1 2 3

To define associations manually:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 95

This picture shows an example of the Table Info tab:

4 5 6

In the Associated Tables pane, click the Modify list button. In the Table Selection dialog box that appears, select a schema from the Schema drop-down list. Select the associated table(s) you want to assign to the selected table and use the > button to move them all to the Destination List at the same time. Use the Shift and Ctrl keys to highlight more than one associated table at a time or use the >> button to add all the associated tables to the Destination List. To add associated tables from more than one schema, repeat steps 5 and 6.

7 8

Click OK. If you want to assign a table period for an associated table, click in the table's row and select the table period you require from the drop-down list. This picture shows an example:

Click Apply to save your changes.

10 Click Yes to confirm.


Page 96 AIRCOM OPTIMA User Reference Guide Version 6.2

Adding a Comment to a Table


To add a comment to a table: 1 2 3 4 5 6 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the table you want to add a comment to. Click the Table Info tab. Click the Apply Table Comment checkbox and type a comment in the Comment box. Click Apply. Click Yes to confirm.

Applying Changes to Element and Date Columns


To set the element and date columns at the table level: 1 2 3 4 5 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the required table. Click the Table Info tab. Select the Apply Changes to Element and Date columns option. From the Element Column drop-down list, select the element level for the selected table. This will be used as the element level for that table throughout AIRCOM OPTIMA. 6 7 8 From the Date Column drop-down list, select the date level for the selected table. This will be used as the date level for that table throughout AIRCOM OPTIMA. Click Apply. Click Yes to confirm.

Setting Table Level


To set the table level: 1 2 3 4 5 6 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the required table. Click the Table Info tab. Select the Apply Table Level checkbox. From the Table Level drop-down list, select the level of the selected table. Click Apply.
Page 97

AIRCOM OPTIMA User Reference Guide Version 6.2

Click Yes to confirm.

The KPIs of the table will only be displayed on the 2D Map View if you set the table to a CELL level.

Adding a Comment to a Column


To add a comment to a column in a table: 1 2 3 4 5 6 From the Administrator menu, point to Data Dictionary and click Table and Field Info. In the tree view of the Table and Field Info dialog box, select the table which contains the column you want to add a comment to. Click the Column tab. Find the relevant column in the list and click its Comments cell. Type the comment you want to add and click Apply. Click Yes to confirm.

Finding a Counter in the Table and Field Info Dialog Box


You can search the database tables for counters in the Table and Field Info dialog box in the same way you can in the Data Explorer. For information about how to do this, see Finding a Counter on page 109.

Repopulating Data
In the Table and Field Info dialog box, you should repopulate data when tables or columns have been created or removed in the database, and you want to view these changes in the Table and Field Info dialog box and the Data Explorer. To do this: 1 From the Administrator menu, point to Data Dictionary and click Table and Field Info. The Table and Field Info dialog box appears. 2 3 From the View menu, click Regenerate Table Info. From the dialog box that appears, choose to regenerate all table information or only the table information that has changed in the database by clicking the appropriate radio button. If you choose to regenerate all table information, then the category and granularity period settings for all tables will be reset to the default values. 4 5 Click the Regenerate button. Click Yes to confirm.

Page 98

AIRCOM OPTIMA User Reference Guide Version 6.2

When you repopulate the Table and Field Info dialog box with new tables, category names are automatically assigned according to the naming convention for the table. The following table describes the naming conventions:
Category KPI Summary Configuration Counters Convention Tables beginning with V. Tables beginning with XX. Hard-coded configuration tables. All other tables.

For more information about categories, see About Categories on page 101.

Generating Associated Tables Automatically


In AIRCOM OPTIMA, you can automatically create table associations based on the summary configuration tables in the database. To do this, the summary configuration tables must be configured correctly To generate associated tables automatically: 1 From the Administrator menu, point to Data Dictionary and click Table and Field Info. The Table and Field Info dialog box appears. 2 3 From the View menu, click Regenerate Table Info. From the dialog box that appears, choose to regenerate all table information or only the table information that has changed in the database by clicking the appropriate radio button. If you choose to regenerate all table information, then the category and granularity period settings for all tables will be reset to the default values. 4 5 Click the Regenerate button. Click Yes to confirm.

For more information on how the associated tables are created, see How AIRCOM OPTIMA Generates Associated Tables on page 100.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 99

How AIRCOM OPTIMA Generates Associated Tables


If you create associated tables using the Regenerate Table Info option in the Table and Field Info dialog box, the associated tables are generated as follows: An associated table is created for each pair of source and destination tables defined within the summary report. For example, the (subhourly) raw table ERICSSON_GERAN.CELLSTATS will have the following associated tables generated: ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_DY (this could be derived from the ERICSSON_GERAN.CELLSTATS_HR) ERICSSON_GERAN.CELLSTATS.BHDY

Associated tables are also created for all of the other relationships within the hierarchy. This means that for the ERICSSON_GERAN.CELLSTATS example, the entire list of associations would be as follows (totalling 12 in all):
TABLE_NAME ERICSSON_GERAN.CELLSTATS ERICSSON_GERAN.CELLSTATS ERICSSON_GERAN.CELLSTATS ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_DY ERICSSON_GERAN.CELLSTATS_DY ERICSSON_GERAN.CELLSTATS_DY ERICSSON_GERAN.CELLSTATS_BHDY ERICSSON_GERAN.CELLSTATS_BHDY ERICSSON_GERAN.CELLSTATS_BHDY ASSOCIATED_TABLE_NAME ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_DY ERICSSON_GERAN.CELLSTATS_BHDY ERICSSON_GERAN.CELLSTATS ERICSSON_GERAN.CELLSTATS_DY ERICSSON_GERAN.CELLSTATS_BHDY ERICSSON_GERAN.CELLSTATS ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_BHDY ERICSSON_GERAN.CELLSTATS ERICSSON_GERAN.CELLSTATS_HR ERICSSON_GERAN.CELLSTATS_DY

Page 100

AIRCOM OPTIMA User Reference Guide Version 6.2

About Categories
All the tables in the database are assigned a category. Categories are used to group tables in the Data Explorer. If a table does not have a category assigned to it, then it will not appear in the Data Explorer list of tables. The categories can be manually assigned or automatically assigned when you repopulate the Table and Field Info dialog box. For more information about repopulating tables, see Repopulating Data on page 98. AIRCOM OPTIMA has four default categories, which cannot be changed or deleted: Configuration Counters KPI Summary

However, if you are an OPTIMA_Administrator, you can create additional userdefined categories and then associate them with database tables.

Creating and Editing Categories


If you are an OPTIMA_Administrator, you can create additional user-defined categories and then associate them with database tables. To create a category: 1 From the Administrator menu, point to Data Dictionary and then click Table Properties. The Table Properties dialog box appears. 2 3 4 5 1 On the Table Categories tab, click Add. In the Add Category dialog box, type a name and description for the category. Click OK. In the Table Properties dialog box, click Close. In the Table Properties dialog box, on the Table Categories tab: Double-click the category that you want to edit. - or Highlight the category that you want to edit, and then click Edit. You cannot edit the default categories. 2 3 4 Edit the name and description as required. Click OK. In the Table Properties dialog box, click Close.

To edit a user-defined category:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 101

When you delete a category, you must reassign other categories to all the tables that were in the category you have deleted. If you do not assign other categories, the tables will not appear in the Data Explorer. To delete a user-defined category: 1 In the Table Properties dialog box, on the Table Categories tab, highlight the category you want to delete. You cannot delete the default categories. 2 3 4 Click Remove. Click OK to confirm the deletion. In the Table Properties dialog box, click Close.

About Table Periods


All the tables in the database must be assigned a table period. For information about assigning time periods, see Setting the Granularity Period for a Single Table on page 94. Table periods are used when running data queries with time aggregation. If a table does not have a period assigned to it, then it cannot be used for time aggregation. For more information about time aggregation, see Enabling Time Aggregation for a Query on page 125. AIRCOM OPTIMA comes pre-configured with several default table periods, for example, Hourly and Daily, and also a Not Applicable period for tables such as configuration tables that do not contain time-related data. The Not Applicable period cannot be changed or deleted. OPTIMA_Administrators can use the Table Properties dialog box to add, edit and remove table periods. For more information, see Creating and Editing Table Periods on page 103. OPTIMA_Administrators can use the Table Properties dialog box to add, edit and remove entities. For more information, see Creating and Editing Entities on page 104.

Page 102

AIRCOM OPTIMA User Reference Guide Version 6.2

To open the Table Properties dialog box: 1 From the Administrator menu, point to Data Dictionary and click Table Properties. The Table Properties dialog box appears. 2 Click the Table Periods tab. This picture shows an example:

Creating and Editing Table Periods


If you are an OPTIMA_Administrator, you can create user-defined table periods and then assign those periods to database tables. For more information, see Setting the Granularity Period for a Single Table on page 94. Creating a Table Period To create a table period: 1 From the Administrator menu, point to Data Dictionary and then click Table Properties. The Table Properties dialog box appears. 2 3 4 5 On the Table Periods tab, click Add. In the Add Table Period dialog box, type a name and description for the table period. Click OK. In the Table Properties dialog box, click Close.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 103

Editing a Table Period To edit a user-defined table period: 1 In the Table Properties dialog box, on the Table Periods tab: 2 3 4 Double-click the table period. - or Highlight the table period you want to edit, and then click Edit.

Modify the name and description as required. Click OK. In the Table Properties dialog box, click Close.

Deleting a Table Period To delete a user-defined table period: 1 2 3 4 In the Table Properties dialog box, on the Table Periods tab, highlight the table period you want to delete. Click Remove. Click OK to confirm the deletion. In the Table Properties dialog box, click Close.

Creating and Editing Entities


The Entity Map tab of the Table Properties dialog box lists all the element types and their properties. The following table describes the entity properties:
Property Entity Name Display Name Comment Physical Description Name of the entity Display Name of the entity Information about the entity Indicates whether it is a physical or logical entity. 1: Logical 0: Physical Priority Custom_K Priority of the entity in the network Indicates if it is an AIRCOM created entity which cannot be edited or deleted 1: AIRCOM 0: User

Page 104

AIRCOM OPTIMA User Reference Guide Version 6.2

To create an entity: 1 From the Administrator menu, point to Data Dictionary and then click Table Properties. The Table Properties dialog box appears. 2 3 4 5 6 7 Click the Entity Map tab. Click Add. The Add entity dialog box appears. In the Entity Name text box, type the name of the entity. In the Display Name text box, type the display name for the entity. Select the Entity Type as logical or physical. In the Comment text box, type a comment for the entity. When you add details of this new entity, it automatically appears in the Current Network Priority pane. 8 9 In the Current Network Priority pane, drag and drop the new entity at the level at which you want it to be used in the network. Click Save. This new entity is now visible in the list of entities and it is located at the same level at which you placed it in the Current Network Priority pane. To edit an entity: 1 From the Administrator menu, point to Data Dictionary and then click Table Properties. The Table Properties dialog box appears. 2 3 Click the Entity Map tab. Double-click the entity that you want to edit. - or Select the entity that you want to edit and click Edit. 4 5 In the dialog box that appears, make changes to the entity. Click Save.

You cannot edit or delete the entities which are shown in Red, as these have been created by AIRCOM. To delete an entity: 1 From the Administrator menu, point to Data Dictionary and then click Table Properties. The Table Properties dialog box appears. 2 3 4 Click the Entity Map tab. Select the entity that you want to delete and click Remove. Click Yes to delete the entity.
Page 105

AIRCOM OPTIMA User Reference Guide Version 6.2

Excluding Particular Days from Reports


AIRCOM OPTIMA enables you to exclude particular days, for example holidays, from reports. These days are specified in the Holiday Entry dialog box.

Holiday Entry dialog box

To add a day that you want to exclude from reports: 1 2 3 4 5 6 From the Administrator menu, point to Editors and click Holiday Entry. In the dialog box that appears, select the date you wish to make a holiday. Select the Holiday checkbox. Type a description in the Holiday Description window then click Apply. Click Yes if you want this holiday date to reoccur every year. Click OK to close the dialog box.

Editing and Deleting Holidays


To edit a holiday: 1 2 3 4 5 1 2 3 4 From the Administrator menu, point to Editors and click Holiday Entry. In the Holiday Entry dialog box, select the date. Amend the information. Click Apply. Click OK to close the Holiday Entry dialog box and save the changes. In the Holiday Entry dialog box, select the date. Clear the Holiday checkbox. Click Apply and then click Yes to confirm. Click OK to close the Holiday Entry dialog box and save the changes.

To delete a holiday:

Page 106

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 5

Setting Up and Querying Data


AIRCOM OPTIMA uses counters to continually record the performance of each operational network element. The data from these counters is stored in an Oracle database that can be queried using the Data Explorer. From the Data Explorer you can: Search for a counter View query results in grid format

OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can set up access to data by defining modules, which are then used in module combinations, to display specific data in grid and graph format. Modules are used in the same way that you would use a template to customise the data you want to display.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 107

Using the Data Explorer


You can use the Data Explorer to find counters, view data from the database tables and to define modules to be used in combination windows. To open the Data Explorer: From the Tools menu, click Data Explorer. - or Click the Data Explorer button on the main toolbar.

The Data Explorer appears. This picture shows an example:

If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or an OPTIMA_Advanced_User and you are creating a module, the Data Explorer can be accessed by clicking Edit Query in the Module Maker. For more information, see Creating Modules on page 157.

Page 108

AIRCOM OPTIMA User Reference Guide Version 6.2

The Data Explorer is made up of a number of panes. The following table describes these panes.
From The Schema List pane You Can Browse the list of schemas and the database tables associated with them. The tables are grouped into categories, for example Configuration, Counters, KPI and Summary. Categories can only be created by OPTIMA_Administrators. For more information, see About Categories on page 101. View the column headings, data or KPIs contained within a chosen table. Hide or show this pane by clicking the View menu and then clicking Show Data. Builder / SQL / Filters / Parameters / Preview tabs Build a query using SQL or by dragging and dropping tables to create the query if you are not familiar with SQL. Hide or show this pane by clicking the View menu and then clicking Show SQL.

Columns / Data / KPI tabs

From the Data Explorer Misc menu, OPTIMA_Administrators can access table categories. For more information about using this feature, see About Categories on page 101. If you are an OPTIMA_Administrator, you can choose to exclude certain database tables and schemas from the Data Explorer display, which makes loading and locating information faster. For more information, see Setting Which Tables and Schemas to Exclude from the Data Explorer on page 50.

Finding Tables and Counters


You can search the database tables for any counter that appears as a column heading in the database tables. For example, you can search for Cell but not the cell name 10A. To find a counter in the Data Explorer: 1 Click the Find Counter button - orFrom the Edit menu, click Find Counter. 2 In the dialog box that appears, type the name of the counter you wish to find. If you want to search for whole words only, select the Find Whole Words Only checkbox. You can use wildcards to represent characters in counter names. There are two wildcards you can use: Asterisk (*) - to represent zero or more characters. For example, if you type 'BSC*', you will filter all the elements that begin BSC. Question mark (?) to represent a single character. For example, if you type 'BSC?', you will filter all the four-character elements that begin BSC, such as BSC1 or BSC2. .

3 4

Click the Find First button. The first occurrence of the counter is highlighted on the Column tab. Click the Find Next button and the next occurrence of the counter is highlighted.
Page 109

AIRCOM OPTIMA User Reference Guide Version 6.2

Click Cancel to close the dialog box and return to the Data Explorer.

You can choose to exclude certain database tables and schemas from the Data Explorer display, which makes loading and locating information faster. For more information, see Setting Which Tables and Schemas to Exclude from the Data Explorer on page 50.

Defining a Query
You can define a query which returns data from the database tables. You can use this query to view data in the Data Explorer or you can create a query as part of a module or report. Only OPTIMA_Administrators, OPTIMA_Alarm_Administrators or OPTIMA_Advanced_Users can create modules. Follow these steps to define a query: 1 Create the query using either the Builder tab or the SQL tab. If you are not familiar with SQL, you can use the Builder tab to create the query. However, the Builder tab is disabled if: 2 3 4 5 6 7 Your database is not using Oracle 10g or above You have manually edited the SQL on the SQL tab - or Add unions to the query. Add filters to the query. Define parameters for the query. Enable time aggregation for the query. Preview the results of the query. Save the query to file or as a custom view.

Using the Builder Tab to Define a Query


To define a query using the Builder tab: 1 2 In the Data Explorer, click the Builder tab. Add tables to the Builder tab by: Double-clicking the table names in the Schema List - or Selecting a table name and then, while holding down the left mouse button, dragging it onto Builder tab. button

To remove a table from the Builder tab, select the table and click the in the top-right of the table box.

Page 110

AIRCOM OPTIMA User Reference Guide Version 6.2

Select which columns you want to include in the query by clicking the boxes next to the column headings.

Select and clear all the columns in a table by clicking the table heading. 4

button next to the

Add links between the tables by selecting a column heading in one table and then, while holding down the left mouse button, dragging the heading to a column heading in another table. If the two columns cannot be linked, the following icon appears .

To remove a link, select the link, right-click and from the menu that appears, click Delete Link. 5 Set the link type by double-clicking the link and selecting a type. By default, all links are inner links. This means that only rows with matching values in the linked columns will be displayed when the query is run. Select the KPIs that you want to include in your SQL query. You can do this by selecting a KPI in the KPI pane and dragging it to the Selected KPI pane. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 111

When you have selected the tables and columns for your query, you need to define the query using the tabs below the Builder tab. The following table describes these tabs:
Use This Tab Criteria To Create the Where clause by adding conditions, each of which may contain one or more criteria. The default compose condition is All. To change this, click on the word highlighted in blue and, from the menu that appears, select the appropriate compose condition. Click the circle, and from the menu that appears, click Add Condition. In the line that appears, click to select the first part of the criterion and type a value or press Shift + Enter. From the menu that appears, double-click to select the table or column. The default rule is =. To change this, click on the rule and, from the menu that appears, select the appropriate rule. Select the second part of the criterion and type a value or press Shift + Enter. From the menu that appears, double-click to select the table or column. To delete a condition, click on the circled number for that condition and from the menu that appears, click Delete Condition. To create a compose condition, add a condition and click on its circled number. From the menu that appears, click Make Compose Condition. Selection View the selected table columns. Here you can choose to return an aggregate value for a column instead of a single row value. To do this: Double-click in the Aggregate column for the appropriate table column and, from the menu that appears, select the aggregate function. Grouping criteria Create the Having clause. You can only do this if you have included an aggregate function in the query. The Having clause is created in the same way as the Where clause, which is described for the Criteria tab. Sorting Define the order for the returned data. The left pane contains all the columns included in the query. Use the arrows to move the columns to the right pane to include them in the returned data. You can move all the columns by clicking the button.

Use the Up and Down buttons to set the order of the columns in the right pane. You can change the sort order for each column alphabetically by selecting the column heading it in the right pane and then clicking the A-Z or Z-A button.

When you have finished, you can add filters and/or parameters to the query. For more information, see Adding Filters to a Query on page 115 and Defining Parameters for a Query on page 116.

You can preview the results of the query at any time. For more information, see Previewing the Results of a Query on page 124.

Page 112

AIRCOM OPTIMA User Reference Guide Version 6.2

Using the SQL Tab to Define a Query


You can use the SQL tab to define a new query or a query that has been created on the Builder tab. If you do this, the Builder tab will be disabled and any further changes to the query must be made on the SQL tab. To define a query using the SQL tab: 1 2 In the Data Explorer, click the SQL tab. Type the SQL for your query. You can automatically add text to the SQL tab by double-clicking, or dragging and dropping, items in the Oracle Commands pane, the Schema List and the Columns tab. 3 You can automatically add a KPI to the SQL query by clicking the KPI tab. To do so: Click the KPI tab. Search for the required KPI in the Search option and drag the KPI in the SQL statement. -or Drag and drop the required KPI from the tree structure. The KPI is added in the form of a KPI parameter. For example, a KPI with the name Total_Calls is shown as %KPI(Total_Calls). You can hover your mouse over the KPI to see a tool tip showing the KPI formula. Using the KPI within a SQL statement will update the KPI_Param table. Hence, you can update the KPI dynamically as the changes will be reflected. You can right-click on a KPI category and sort the KPIs into different categories as shown in this picture:

4 5

To add a complex expression using the Expression Editor, click the Insert Expression button . Create the expression by double-clicking column headings and selecting items from the drop-down menus. Click OK to add the expression to the SQL tab.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 113

When you have finished, if you have not already added filters and/or parameters to the query, you can add them using the corresponding tabs. For more information, see Adding Filters to a Query on page 115 and Specifying Default Parameter Values on page 118.

You can preview the results of the query at any time. For more information, see Previewing the Results of a Query on page 124.

Adding Unions to Queries


You can use unions to combine the results of two or more queries. There are two types of union: Union and Union All. Use Union if you want to select only distinct values when the queries are run and Union All if you want to select all values. To add a union to a query: 1 2 3 In the Data Explorer, ensure that you have defined a query. Click the Builder tab. Right-click in the Query List and, from the menu that appears, click Add union.

A new query with a Union All is added to the Builder tab. This picture shows an example:

If you want to use Union rather than Union All, right-click the query in the Query List and then, from the menu that appears, click Union All to deselect it.

Create the second query. For information about how to do this, see Using the Builder Tab to Define a Query on page 110. All corresponding columns need to be of the same data type.

Page 114

AIRCOM OPTIMA User Reference Guide Version 6.2

When you have finished, if you have not already added filters and/or parameters to the query, you can add them using the corresponding tabs. For more information, see Adding Filters to a Query on page 115 and Defining Parameters for a Query on page 116.

You can preview the results of the union at any time. For more information, see Previewing the Results of a Query on page 124.

Adding Filters to a Query


You can add a date filter and an element filter to a query to further define the query. When the query is run, you will be asked to choose a date range or select a filter. The Filters tab is disabled if you use the Data Explorer to create a report query. For more information, see Defining Queries on page 292. If the query is created as part of a module, the element filter option will be replaced by elements selected from the module element tree in the Module Maker. To add a filter to a query: 1 2 3 In the Data Explorer, ensure that you have defined your query. Click the Filters tab. Select the Date Filter checkbox if you want to add a date filter. A list of available date fields appears in the Date Fields box. 4 5 Select the date field you wish to use and click the button to select it.

Select the Element Filter checkbox if you want to add an element filter. A list of available filters appear in the Data Fields box. Select the Show All Fields checkbox if you want to see all of the data fields.

6 7

Select the filter you wish to use and click the You can now preview the results of the query.

button to select it.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 115

Defining Parameters for a Query


You can define parameters, using items such as formulae or counters, to filter data when a query is run. For example, you could define a parameter to filter all dropped calls greater than 10%. You can use parameters in: Modules Reports Report Schedules

To quickly define a parameter (or parameters) based on the available field (or fields) in the current query: 1 2 3 In the Data Explorer, ensure that you have defined your query. Click the Parameters tab. Click the Add All Fields button .

All of the available fields in the current query are added as parameters, and appear in the parameters list:

If a parameter has already been created for a particular field, you will be given the option to create a new one with a different name or just keep the existing one.

Page 116

AIRCOM OPTIMA User Reference Guide Version 6.2

To define a parameter manually: 1 2 3 In the Data Explorer, ensure that you have defined your query. Click the Parameters tab. Click the New Parameter button This picture shows an example: . The Parameter Editor dialog box appears.

In the Parameter Editor dialog box, complete the following information on the Counters or KPIs tab:
In this field: Name Do this: Type a name for the parameter. - or Leave blank if you want this field to be automatically updated with a counter name when you create the parameter. Data Type Select a data type from the drop-down list. - or Leave blank if you want this field to be automatically updated with a counter data type when you create the parameter. Prefix table / alias name Select this checkbox if you want to prefix columns with the table or alias name.

5 6

Create a parameter by double-clicking column headings and selecting items from the drop-down menus. When you have finished, click OK to save the parameter and return to the Data Explorer.

Now when you run the query, you will be asked to specify parameter values based on the criteria you have set. For more information, see Previewing the Results of a Query on page 124. If you do not want to specify parameter values each time you run the query, you can set default parameter values. For detailed information about how to do this, see Specifying Default Parameter Values on page 118.
AIRCOM OPTIMA User Reference Guide Version 6.2 Page 117

Specifying Default Parameter Values If you have created a parameter for a query, you can set a default value for that parameter. The default value will be pre-selected when the parameter is run. To specify a default parameter value: 1 2 3 In the Data Explorer, ensure that you have defined a parameter for your query on page 116. Click the Parameters tab. On the Parameters tab, complete the following information:
In this field Operator Values Do this Select an operator from the drop-down list. For example, if you want to create a filter that only returns data for an exact value, then select the = operator. Type the default value(s) for the parameter. Multiple values must be separated by commas. - or Click the Values button you require and click OK. and, in the dialog box that appears, set the default values

This button is only available when using certain data types (DATE and NUMBER) and/or operators (Between, Not Between, In List and Not In List). Show All Select this checkbox if you want the parameter to display all of the values of the field.

The name, formula and data type are all defined when you create the parameter. This picture shows an example:

You can now preview the query with the default parameter value(s) pre-selected. For more information, see Previewing the Results of a Query on page 124.

Page 118

AIRCOM OPTIMA User Reference Guide Version 6.2

Editing and Deleting Parameters To edit a parameter: 1 2 In the Data Explorer, click the Parameters tab. Select the parameter you want to edit and click the Edit Parameter button - or Double-click the parameter name. 3 4 In the Parameter Editor dialog box that appears, make the required changes. When you have finished, click OK to save your changes and return to the Data Explorer. In the Data Explorer, click the Parameters tab. Select the parameter that you want to delete and click the Delete Parameter button . 3 Click Yes to confirm. The parameter is deleted. To delete all parameters: 1 2 In the Data Explorer, click the Parameters tab. Click the Clear All Parameters button . .

To delete a single parameter: 1 2

All parameters in the parameters list are deleted.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 119

About Explain Plan


The Explain Plan option enables you to determine the execution plan that the Oracle database follows to execute a specified SQL statement. The Explain Plan statement inserts a row describing each step of the execution plan into a specified table. If you are using cost-based optimization, then this statement also determines the cost of executing the statement. If any domain indexes are defined on the table, then it also inserts user-defined CPU and I/O costs. To issue an Explain Plan statement, you must have the necessary privileges to: 1 2 Insert rows into an existing output table that you specify to hold the execution plan Execute the SQL statement for which you are determining the execution plan Access a view if the SQL statement is based on a particular view In the Data Explorer, ensure that you have defined a query. Click to view the explain plan. The dialog box that appears gives the execution plan that the Oracle database will follow to execute the defined query. This picture shows an example of the Explain Plan dialog box:

To view the explain plan for a SQL query:

Page 120

AIRCOM OPTIMA User Reference Guide Version 6.2

Example of an Explain Plan The following statement determines the execution plan and cost for an UPDATE statement and inserts rows describing the execution plan into plan_table with the STATEMENT_ID value of 'Raise in Tokyo': EXPLAIN PLAN SET STATEMENT_ID = 'Raise in Tokyo' INTO plan_table FOR UPDATE employees SET salary = salary * 1.10 WHERE department_id = (SELECT department_id FROM departments WHERE location_id = 1200); The following SELECT statement queries plan_table and returns the execution plan and the cost: SELECT LPAD(' ',2*(LEVEL-1))||operation operation, options, object_name, position FROM plan_table START WITH id = 0 AND statement_id = 'Raise in Tokyo' CONNECT BY PRIOR id = parent_id AND statement_id = 'Raise in Tokyo'; The query returns this execution plan:
Operation UPDATE STATEMENT UPDATE TABLE ACCESS VIEW HASH JOIN INDEX RANGE SCAN DEPT_LOCATION_IX FULL EMPLOYEES EMPLOYEES index$_join$_002 Option Object_Name Position 2 1 1 1 1 1

INDEX

FAST FULL SCAN

DEPT_ID_PK

The value in the POSITION column of the first row shows that the statement has a cost of 2.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 121

Selecting Filter Values and Parameters


The Selection dialog box enables you to select filter values and parameters. The following table describes when the Selection dialog box appears:
This Component/Event Data Explorer Reports Alarms Ambiguous KPI Selection (Ambiguous KPIs are KPIs with the same name but different formula.) Opens the Selection Dialog Box When You define filters, parameters, element aggregation for the query or when time aggregation is available for the tables used. You preview a report that has filters, parameters, element and time aggregation. You set values to alarms in the Alarm Wizard. You are trying to use ambiguous KPIs, the Selection dialog box will appear so that you can select the KPI that you want to use.

This picture shows an example of the Selection dialog box:

Page 122

AIRCOM OPTIMA User Reference Guide Version 6.2

The following table describes the various panes in the Selection dialog box:
In This Pane Queries Do This From the Queries pane, select a particular query. Once you select a particular query, the right-hand pane has all the information pertaining to the selected query. Under the Element Agg column, select the element level at which you want to run the query the default level, for example: CELL, or at parent level, for example: BSC, to return the aggregated data. You can right-click in the Queries pane to see the aggregated data query. Date Range Select the date range to be applied to the query. You can click the date text box or you can click to change the date.

Select the Apply to all queries checkbox if you want to apply the date range to all the queries. Element Selection/Parameters Select the elements and the parameters for the query. To do so: 1. Select the Element Hierarchy tab and click to select an element hierarchy.

2. Click the Filter tab and select the filter. For more information, see Adding Filters to a Query on page 115. 3. Click the Manual Input tab and type in your manual elements. Select the Apply to all queries checkbox if you want to apply your selection to all the queries. Select the Include all elements checkbox if you want to include all the elements. KPI Settings This tab will list all the ambiguous KPIs. 1. From the list of ambiguous KPIs, select the KPI that you want to use. 2. If the KPI that you have selected is an aggregated KPI, then from the Global Aggregation drop-down list, select the type of aggregation. The aggregation type is displayed in the Global Agg column of the Queries pane. If you want to apply the selected aggregation type to all of the queries within the report, select the Apply Global Aggregation to All Queries checkbox. Save settings as default This option is available only if you have accessed the Selection dialog box while previewing a report. Select this option to save the report settings as default.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 123

Previewing the Results of a Query


At any time during the creation of a query, you can preview its results in a grid on the Preview tab. To do this: 1 2 In the Data Explorer, click the Execute SQL button .

If you have included filters and/or parameters in the query, the Selection dialog box appears. This table describes how you can filter the query:
On this tab Network Elements Do this: Select a filter from the list that appears and then select elements you wish to include using the arrow keys to move the elements to the Selection pane. You can add elements from any number of filters. For more information about creating filters, see Adding Filters to a Query on page 115. Date Range - Range sub-tab Select the period over which you require data. To link to the global clock: 1. Select the Start or End checkbox and then select Synchronise to Global Clock. The current date and time display. 2. Type the desired period in the Period box. You cannot synchronise to the global clock if you set start and end dates. To specify a duration whose start or end date you know, click either the Start or End checkbox and choose the correct date, then specify the desired period in the period box. To specify a period whose start and end dates you know, select the Start and End checkboxes and choose the required dates. Date Range - Exclude / Include sub- Select which days you want to include in the date range. Right-click the Dates of tab Week area and, from the menu that appears, you can Select All or Deselect All the days or choose just Weekdays or Weekends. Select the Start and End hours for the days you have included. Select the checkbox if you want to Exclude Holidays. For more information about holidays, see Excluding Particular Days from Reports on page 106. Parameters Select an operator from the drop-down list and then type a value for the parameter. The parameter value must match the specified data type, otherwise an error message will be displayed when the query is run. For more information about parameters, see Defining Parameters for a Query on page 116. Time Aggregation Select the time period on which you want to run the query. A time period is only available if an associated table with that table period has been set for every data table in the query. If the associated tables have not been configured for any one of the tables in the query, the list will be empty and disabled. For more information, see Defining an Association for a Table on page 95. For more information about time aggregation, see Enabling Time Aggregation for a Query on page 125.

3 4

Click OK to close the Selection dialog box and run the query. You can now customise how the data is shown in the grid. For more information about customising grids, see Customising Grids on page 229.
AIRCOM OPTIMA User Reference Guide Version 6.2

Page 124

Enabling Time Aggregation for a Query


Time aggregation enables you to display data for different time periods (hourly, daily, weekly, and so on) in the same query. Time Aggregation is applied by replacing tables in a data query with the corresponding associated tables for the selected time period. This means you do not have to create separate queries for each time period you want to display. Before you can use time aggregation, you must first configure: A table period for each table in the query. For more information, see Setting the Granularity Period for a Single Table on page 94. An associated table for each time period, for example, which table contains hourly, daily, and weekly busy hour data. For more information, see Defining an Association for a Table on page 95.

Time aggregation can only be applied in a query if the associated tables and table periods have been configured for every table defined in the query (excluding configuration tables). To enable time aggregation: 1 2 In the Data Explorer, ensure that you have defined your query. Select the Enable Time-Aggregation checkbox.

You will now be asked to select a time period each time the query is run. For more information, see Previewing the Results of a Query on page 124.

Saving and Opening Queries


When you have created a query, you can save it so you can use it again. Queries are saved as SQL files. To save a query: 1 2 In the Data Explorer, click the Save To File button .

In the Save SQL File dialog box, open the folder in which you wish to save the file and type a name for the file. If the required folder does not exist, click the Create New Folder button .

Click Save.

To open an existing query: 1 2 In the Data Explorer, click the Open File button .

In the Load SQL File dialog box, find the query file you wish to load and click Open. The query is loaded in to the Data Explorer.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 125

Saving a Query as a Custom View in the Sandbox


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can save a query as a custom view, as well as edit and delete existing custom views. AIRCOM OPTIMA provides a 'sandbox' environment in which you can create custom views without affecting other users. Before you can do this, your OPTIMA_Administrator must allocate a space quota for you in the sandbox. This space quota cannot be exceeded when creating or refreshing custom views. For more information, see Setting Sandbox Options on page 51. Custom views are reusable data queries that can be used in reports, modules, alarms, KPIs and other queries. They can be considered as equivalent to predefined SQL statements. There are two types of custom view, described in the following table:
Item User Views Sandbox Views Description Do not contain stored data, and can be used at any time to obtain the current data. Contain stored data, by taking a 'snapshot' of the data at a given time. A sandbox view can be updated at any time, by right-clicking it and selecting 'Refresh Sandbox View'. The table on which you want to base the sandbox view must have a Primary Key. If it does not, AIRCOM OPTIMA provides the error message: 'ORA-12014: Table "<name>" does not contain primary key constraint' and cannot create the sandbox view.

Page 126

AIRCOM OPTIMA User Reference Guide Version 6.2

To save a query as a custom view: 1 In the Data Explorer, click the Save As User View button View Wizard appears. This picture shows an example: . The Create User

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 127

On the Details tab of the wizard, complete the following information:


In this field: Name Description Add to Data Model Do this: Type a name for the custom view. Type a description for the custom view. Select this checkbox if you want to add the custom view to the AIRCOM OPTIMA, Global or Vendor schemas. To do this: Select a schema from the drop-down list. This option is only available if: Category You are an OPTIMA_Administrator You are creating a user view, not a sandbox view

Select a category for the custom view from the drop-down list. For more information, see About Categories on page 101.

Create as Sandbox View Select this if you want to create a sandbox view. If you select this option, you cannot add this view to the data model. Security Choose the security type, by selecting the appropriate radio button: Personal views can only be seen by you Group views can be seen by particular user groups System views can be seen by everyone using the project

3 4

Click Next. If you set the security type as Group or System, the Security tab appears. On the Security tab, complete the following information:
In this field: Group list Do this: Select the user group(s) that can use the custom view. To add a new group: 1. Click Add. 2. In the Select Groups dialog box that appears, select the group(s) you want to have access to this custom view and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List.

5 6 7

Click Next. On the Completing View tab, check that the details are correct. If not, click Back and correct them, otherwise click Save. Click Yes to confirm.

The custom view is displayed in the Schema List pane of the Data Explorer.

Page 128

AIRCOM OPTIMA User Reference Guide Version 6.2

Editing and Deleting Custom Views To edit a custom view: 1 2 In the Data Explorer, in the Schema List pane, select the custom view you want to edit. Double-click the custom view. - or Right-click and, from the menu that appears, click Edit User View. The SQL tab appears, displaying the SQL for the custom view:

3 4

Make any required changes to the SQL, then click the Save as Custom View button . In the User Views Wizard that appears, edit the details as required on each page. For more information, see Saving a Query as a Custom View in the Sandbox on page 126.

Click Save at the end of the wizard to save your changes and return to the Data Explorer. In the Data Explorer, in the Schema List pane, select the required sandbox view. Right-click, and from the menu that appears, click Refresh Sandbox View.

To refresh the data displayed for a sandbox view: 1 2

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 129

To delete a custom view: 1 2 3 In the Data Explorer, in the Schema List pane, select the custom view you want to delete. Right-click and, from the menu that appears, click Delete. Click Yes to confirm. The custom view is removed from the Schema List in the Data Explorer. Viewing Details of Custom Views In the Data Explorer, you can view details of all of the custom views that have been created for a particular user - for example, the size of each custom view and how much of the user's quota they take up. To do this: 1 2 Right-click one of the views assigned to the user. From the menu that appears, click Sandbox TableSpace Detail. The Sandbox TableSpace Details dialog box appears. This picture shows an example:

Page 130

AIRCOM OPTIMA User Reference Guide Version 6.2

In this dialog box, you can view: The name of the view The size of the view in MB The expiry time/date of the view (based on the Sandbox View Expiry Period defined by the OPTIMA_Administrator in the Sandbox Options) The time/date when the view was last refreshed The amount of the user's space quota remaining (free space), based on the size of the existing views

Defining Indexes for Sandbox Views In the Data Explorer, you can create an index for a sandbox view. Creating indexes can increase performance, as queries run on the underlying tables can run faster when they use a good index. To define a sandbox view index: 1 2 Select the required sandbox view. Right-click, and from the menu that appears, click Edit Sandbox View Index. The Sandbox View Index Management dialog box appears. This picture shows an example:

3 4 5 6 7

Click Add. In the dialog box that appears, in the New Index Name pane, type a name for the new index. In the left-hand pane, select the first parameter that you want to include in the index, and then click the right arrow button . Repeat for each parameter that you want to include. Ensure that the parameters are in the correct order, using the Up and Down buttons to re-arrange them. You may want to prioritise particular parameters (by moving them higher up the list) based on the expected results - parameters that return fewer entities will be processed quicker than those that return a large number.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 131

8 9 1 2 3

When you have included all of the parameters in the correct order, click Save. The new index for the sandbox view is created. Click Close. From the Current Index(es) drop-down list, select the index that you want to edit. Click Edit. In the dialog box that appears, make the required changes. You cannot edit the name of an existing index.

To edit an existing sandbox view index:

4 1

Click Save to save your changes, and then click Close. From the Current Index(es) drop-down list, select the index that you want to delete. You cannot delete the primary key index.

To delete a sandbox view index:

2 3

Click Delete. The required index is deleted. Click Close.

Viewing KPIs in the Data Explorer


You can view information about existing KPIs on the KPI tab, in the Data Explorer. To do this: In the Data Explorer, select the base table for which you want to see the KPIs. This picture shows an example:

The KPI tab indicates the name, equation and description of the KPI. It also indicates whether the KPI is valid (true) or not (false).

Page 132

AIRCOM OPTIMA User Reference Guide Version 6.2

About KPIs
Using the KPI Manager, you can create KPIs to show collected key performance data both in AIRCOM OPTIMA Inspector, using modules and combination windows, and on the Map View window. From the drop-down list on the right-hand side of the KPI Manager, you can select the criteria to group the KPIs. When you open the KPI Manager, you can view information about existing KPIs which you have access to in a tree structure grouped by the following:
Option Security Security, Schema, Table Security, Table Security, Element Level Grouped on the basis of Security levels Security levels, schema levels, and table level Security levels, and table level Security levels, and element levels

This picture shows an example of KPIs grouped at the security level:

KPI Manager

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 133

Creating KPIs
To create a KPI: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 3 . In the KPI Manager, from the File menu, click New KPI. In the KPI dialog box that appears, complete the following information:
In This Box: Name Description Security Do This: Type a name for the KPI Type a description for the KPI To create a personal KPI, select the Personal option. All users and OPTIMA_Administrators can view and create personal KPIs but only OPTIMA_Administrators and the creator of a personal KPI can make changes. To create a group KPI, select the Group option. Group KPIs are shared with all the user groups. All users can create group KPIs but only OPTIMA_Administrators and the creator of a group KPI can make changes. The exception to this are KPIs assigned to the 'Everyone' group, also known as public KPIs. OPTIMA_Administrators, Alarm_Administrators and OPTIMA_Advanced_Users and the creator can all make changes. If you are creating a group KPI, click Select Group to select all the groups that share the selected KPI. Select the Admin option to have the administrative rights over the created KPI. Data 1. Select the Multi table KPI option if you want to share the KPI with more than one table. 2. Click the Select/show tables button. 3. In the Select Valid KPI Tables dialog box that appears, select the required KPI usage tables and click Save. -or1. From the Base schema drop-down list, select a base schema for the KPI. 2. From the Base table drop-down list, select a base table for the KPI. Equation Type an equation to define the KPI, using the available columns. The equation must be in correct Oracle syntax. You can build complex equations using the Expression Editor. Click to open the Expression Editor. Double-click a KPI in the Counters for Equation list to have it added to the equation. To activate the aggregation function, you need to write the following equation: % aggr(tch) where tch is the KPI equation. Element Aggregation From the drop-down list, select the element aggregation function. This function will replace the '%aggr' keyword when the KPI aggregation function is used in the Query Builder.

Page 134

AIRCOM OPTIMA User Reference Guide Version 6.2

In This Box: Time Aggregation

Do This: From the drop-down list, select the time aggregation function. This function will replace the '%aggr' keyword when the KPI aggregation function is used in the Query Builder.

This picture shows an example of the New KPI dialog box:

In this example, a personal KPI is being created with the base schema as ERICSSON2G and base table as BSCGPRS.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 135

Click Save. When prompted, click Yes to create and view the list of tables. These usage tables are the ones on which this new KPI is valid. To make dynamic changes to this list, select the checkboxes corresponding to the tables in which you want to use the KPI. This picture shows an example of KPI Usage Tables:

Click Save to create the KPI.

Page 136

AIRCOM OPTIMA User Reference Guide Version 6.2

Editing KPIs
Different types of user can edit KPIs, depending on the type of KPI:
This KPI Type Personal Group Public ('Everyone' Group) Can Be Edited By OPTIMA_Administrators and the creator. OPTIMA_Administrators and the creator. OPTIMA_Administrators, Alarm_Administrators, OPTIMA_Advanced_Users and the creator.

To edit a KPI: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 In the KPI Manager: Double-click the KPI that you want to edit. - or Select the KPI that you want to edit, and from the Edit menu, click Edit. .

The KPI dialog box appears, in which you can edit the details for the selected KPI. This picture shows an example KPI dialog box:

Modify the KPI information.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 137

Click Save to save your changes. When you click Save, the following message appears:

If you click Yes, the system displays the list of KPI usage tables that were selected while creating the KPI. You can change your selection. If you click No, the system will validate the edited KPI against the list of usage tables that were selected previously. If the KPI is no longer valid, then that table is removed from the usage list; otherwise that table remains in the usage list. You can also edit multiple KPIs at the same time. For more information, see Editing Multiple KPIs on page 138. Editing Multiple KPIs To edit multiple KPIs: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 3 Right-click and select Edit. . In the KPI Manager, select the KPIs that you want to edit.

Page 138

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

The left-hand pane shows all the KPIs that you have selected in the KPI Manager screen. All the changes made in this dialog box will be applied to this list of KPIs. 4 Select the Security checkbox to change the security levels for the selected KPIs. If you select the Group option, then you will be able to add and remove groups. To add or remove groups, click the Add Groups or Remove Groups buttons. In the dialog box that appears, select the KPIs that you want to add or remove in the left-hand pane and click Click OK. to move the selected KPIs to the right-hand pane.

The Destination List pane will not show any existing groups. 5 Click the Administrative rights checkbox to give admin rights to the selected KPIs. The Admin checkbox is active only if you have administrative rights, and you have selected Group as the Security option. 6 Select the Base table and schema checkbox if you want to change the base schema and table of the selected KPIs. From the Schema and Table drop-down lists, select the appropriate schema and table. When you change the base table and schema for the KPIs, AIRCOM OPTIMA will perform an update. Only those KPIs for which the new table and schema are valid (according to the equation of the selected KPIs) are updated.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 139

Select the Time aggregation and Element aggregation checkbox to edit the aggregation details for the KPIs. The new selected time and element aggregation values will be applied only to those KPIs that have %aggr defined in their equations. Click Save to Apply the changes to the selected KPIs.

Deleting KPIs
Different types of user can delete KPIs, depending on the type of KPI:
This KPI Type Personal Group Public ('Everyone' Group) Can Be Deleted By OPTIMA_Administrators and the creator. OPTIMA_Administrators and the creator. OPTIMA_Administrators, Alarm_Administrators, OPTIMA_Advanced_Users and the creator.

To delete a single KPI or multiple KPIs: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 . In the KPI Manager, select the KPI(s) that you want to delete. To select multiple KPIs, click each one while holding down the Ctrl key. 3 4 From the Edit menu, click Delete. In the dialog box that appears, click Yes to confirm the deletion. The selected KPIs are deleted.

Exporting and Importing KPIs


You can export and import KPIs to move them between databases. To export a KPI: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 3 4 5 6 . Select the KPI that you want to export. Right-click and from the menu that appears, click Export. In the dialog box that appears, click Yes to confirm. Browse to the folder where you want to export the KPI. Click OK. The KPI is exported. Notes :
Page 140

The file format for exporting a KPI is .KPI. When you export a multi table KPI, the base tables of the KPI are not exported.
AIRCOM OPTIMA User Reference Guide Version 6.2

You can import KPIs in several ways: Individually. In bulk from a CSV file. For more information on how to do this, see Importing KPIs in Bulk from a CSV file on page 142.

You cannot use the bulk import for KPIs that contain %AGGR or %KPI in their equation. You must import these individually. To import individual KPIs: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 3 4 5 . In the KPI Manager, right-click and from the menu that appears, click Import. In the Confirm dialog box that appears, click OK. The Import Objects window appears. Click to browse to the location from where you want to import the KPI.

Click OK. The contents of the folder are displayed in the Import Objects window. This picture shows an example:

Select the KPI that you want to import and click OK. If you import a multi table KPI, there will be an option to set the base tables for it. Click Yes to set the base tables for the multi table KPI that you are importing. In the dialog box that appears, click to set the base table.
Page 141

AIRCOM OPTIMA User Reference Guide Version 6.2

Click Save. The KPI is imported. If you do not select the base table, then the KPI is imported and saved as an invalid KPI.

Importing KPIs in Bulk from a CSV File You can import KPIs (including those that contain aggregation) in bulk from a CSV file. The values in the CSV file should be in the following format: {KPI Name, DESC, EQUATION, SCHEMANAME, TABLE, TIME_AGG. ELEMENT_AGG} Where: KPI Name is a valid field name in ORACLE DESC, EQUATION, TIME_AGG and ELEMENT_AGG are in double quotes if they contain a space or a comma, for example {KPI Name, Desc, "NVL (Field,0)", Schema, Table, Time_Agg, Element_Agg} TIME_AGG and ELEMENT_AGG contain the equations used for time aggregation and element aggregation respectively Only DESC, TIME_AGG and ELEMENT_AGG can be NULL

The first line of the CSV file should be a header line which contains all the column names. To perform a bulk KPI import: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 3 4 5 . In the KPI Manager, right-click and from the menu that appears, click Import. In the Confirm dialog box that appears, click OK. The Import Objects dialog box appears. Click to browse to the location from where you want to import the KPI. Click OK. The selected file is displayed in the Import Objects dialog box:

Select the KPI that you want to import and click OK.

Page 142

AIRCOM OPTIMA User Reference Guide Version 6.2

If you want to import the KPIs as public/group KPIs that can be accessed by everyone, click Yes. - or If you want to import the KPIs as personal KPIs just for the current user, click No. If you try to import a public KPI that already exists in the database, then the import will work differently, depending on whether you are an OPTIMA_Administrator or not: If you are an OPTIMA_Administrator, you will be prompted to either overwrite the existing one or not import the KPI at all. You can choose to do this for all KPIs at once or decide for each one individually. If you are not an OPTIMA_Administrator, and the KPI already exists as a public KPI, then it will be imported as a private KPI. If the KPI already exists as a private KPI, then it will be imported as another private KPI with the same name and a different identifier.

Viewing KPI Use


In AIRCOM OPTIMA, you can view where a particular KPI is used throughout the network. To view KPI use: 1 From the KPI menu, click KPI Manager. -orClick the KPI Manager button 2 . In the KPI Manager, select a KPI, right-click and, from the menu that appears, click View KPI Use. This picture shows an example of the KPI Use dialog box:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 143

The KPI Use dialog box shows: In which objects (reports, tables, modules and so on) the selected KPI is used in this example, it is used in one alarm (Channel Allocation Request Failures (Voice)), one module (Channel Allocation Requests (Voice)) and one report (Channel Allocation Requests (Voice)) The location of those objects - in this example, the alarm, module and report are all stored in the GERAN subfolder (within the All Folders folder) The tables in which the KPI is used - in this example, DEMO_GERAN.CELLSTATS, DEMO_GERAN.CELLSTATS_DY, DEMO_GERAN.CELLSTATS_MO and DEMO_GERAN.CELLSTATS_WK

Synchronising Associated Tables


The Synchronise functionality enables you to synchronise a base table and its associated tables to ensure that both have the same KPIs. While synchronising associated tables, the system checks whether the KPI is valid on the tables. If it is valid, then that table is added to the list of usage tables for that KPI. If it is not valid, then that table is removed from the usage list for that KPI. To synchronise associated tables: 1 2 3 4 5 6 From the KPI menu, click KPI Manager. In the dialog box that appears, select the required KPI. Right-click and from the menu that appears, click Synchronise. Click Yes to confirm that you want to synchronise the base table with the associated tables. In the dialog box that appears, select the tables that you want to synchronise. Click Synchronise.

Page 144

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example of the Synchronise Associated Tables dialog box:

An example of the Synchronise Associated Tables dialog box

Depending on whether a KPI is valid on the tables, the tables will be added or removed from the list of usage tables for the selected KPI.

Recreating Views
This section enables you to create KPI views using the following options:
Option Selected Table Selected Schema All Creates Views For The base table of the selected KPI All the tables in the base schema of the selected KPI All the tables in all the schemas

The security level for these KPIs must be Group and access should be set to everyone.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 145

Creating Views for a Table To create a view for a base table of the selected KPI: 1 2 3 4 From the KPI menu, click KPI Manager. In the KPI Manager, select the KPI associated with the base table for which you want to create a view. Right-click and from the menu that appears, point to Recreate View and click Selected table. Select the checkbox corresponding to the base table of the selected KPI. In this case, there is only one base table displayed as you are creating the view for a table. 5 Click Process. The view is created. This picture shows an example of the Create KPI Views dialog box:

The Status column indicates: 6 Whether the view has been created successfully Number of the Valid KPIs for the base table/Total KPIs, for example, Success(86/87) indicates 86 valid KPIs/87 total KPIs Whether the KPI is valid or not Errors for the invalid KPIs

The Message column indicates: Click Close.

Page 146

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating Views for a Schema To create a view for a schema for the selected KPI: 1 2 3 From the KPI menu, click KPI Manager. In the KPI Manager, select the KPI associated with the base schema that includes the base tables for which you want to create views. Right-click and from the menu that appears, point to Recreate View and click Selected schema. The Create KPI Views dialog box opens and lists the selected schema with all the usage tables under that schema. These are the usage tables in the base schema that were selected while creating the selected KPI. 4 5 Select the tables for which you want to create the view. Click Process. The view is created. This picture shows an example of the Create KPI Views dialog box:

The Status column indicates: 6 Whether the view has been created successfully Number of the Valid KPIs for the base table/Total KPIs, for example, Success(2/2) indicates 2 valid KPIs/2 total KPIs Whether the KPI is valid or not Errors for the invalid KPIs

The Message column indicates: Click Close.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 147

Creating Views for All Schemas and All Tables To create views for all schemas and all tables: 1 2 From the KPI menu, click KPI Manager. In the KPI Manager, right-click and from the menu that appears, point to Recreate View and select All. The Create KPI Views dialog box opens and lists all the schemas with all its usage tables. These are the usage tables in the base schemas that were selected while creating the selected KPI. 3 4 Select the schemas and their respective base tables for which you want to create the view. Click Process. The view is created. This picture shows an example of the Create KPI Views dialog box:

The Status column indicates: 5 Whether the view has been created successfully Number of the Valid KPIs for the base table/Total KPIs, for example, Success(108/108) indicates 108 valid KPIs/108 total KPIs Whether the KPI is valid or not Errors for the invalid KPIs

The Message column indicates: Click Close.

Page 148

AIRCOM OPTIMA User Reference Guide Version 6.2

About Global KPI Views


A Global KPI View consists of a single view showing all existing common public KPIs for various vendor tables. The KPIs listed in the view will be the ones that exist when you create the view. If you add another KPI after you have created the view, you will have to create the view again for this new KPI to be shown. This picture shows an example of the Global KPI Explorer:

To access a global view that has been created: 1 2 From the KPI menu, click Global KPI. In the Global KPI Explorer, from the left-hand pane, expand the tree and select the global view that you want to see. The global view shows the data of the current view that you have selected. It also specifies the KPI name, equation, and the description. However, if there is a KPI that can be aggregated, then the aggregation formula will be deleted from the global view. That means, the %aggr formula for a particular KPI will not be displayed in the Global KPI dialog box. Notes: The security level for these KPIs must be Group and access should be set to everyone. The KPI names must match across all the tables selected in the Global KPI dialog box.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 149

Creating a Global KPI View Only users with administrative privileges can create a global view. To create a global view: 1 2 From the KPI menu, click Global KPI. In the Global KPI Explorer, from the Edit menu, click Add Global View. -orIn the dialog box that appears, right-click in the left-hand pane and click Add Global View. 3 The dialog box that appears lists all the tables for different schemas in the lefthand pane. Select the tables that you want to include in the global view. This picture shows an example:

In the right-hand pane, click the Configure Selections button. The first grid is populated with your selection. The table in the grid lists the following: The Primary Key for each table that you have selected The common public KPIs for each table that you have selected

Page 150

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

You can change the primary key values. To do this, click the column to edit the primary key. When editing the primary key values, you must ensure that: All the values must be of the same data type Each column name must be unique

If, for example, there are two column names that are same, then you will not be able to save the global view and an error message will appear in the Message Log. However, it will be possible for you to preview the global view and see the results. 5 Click the Preview Global View button to see the configurations for the global view. The second grid is populated with the global view values. The information is based on each vendor and its primary keys and KPIs. This picture shows an example of the second grid at the bottom:

6 7 8

In the View Name text box, type the name of the view. In the View Description text box, type a description for the view. Click Create Global View to save the global view.
Page 151

AIRCOM OPTIMA User Reference Guide Version 6.2

Editing a Global KPI View To edit a global KPI view: 1 2 3 From the KPI menu, click Global KPI. In the Global KPI Explorer, in the left-hand pane, select the global view that you want to edit. From the Edit menu, click Edit Global View. - or Right-click the global view and click Edit Global View. 4 5 Make the required changes. Click Create Global View to save the changes.

Deleting a Global KPI View To delete a global KPI view: 1 2 3 From the KPI menu, click Global KPI. In the Global KPI Explorer, in the left-hand pane, select the global view that you want to delete. From the Edit menu, click Drop Global View. -orRight-click in the left-hand pane and click Drop Global View. 4 Click Yes to confirm the deletion.

Page 152

AIRCOM OPTIMA User Reference Guide Version 6.2

About Modules
AIRCOM OPTIMA modules consist of: Module details name, description, name of creator, creation date, name of the last person to edit the module and the date last edited. A database query that enables you to create a network element tree for displaying and selecting specific network elements. Base queries to return data when elements are selected from the tree-view. A separate query can be defined for each tree level. For example, you may have BSCs on one level and cells on the next level. Therefore you could have a query for each of these. The module details:

The main parts of a module are:

The network element tree:

The tree-level queries:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 153

If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can: Create and delete module folders Create modules Edit and delete modules Restrict editing of modules Import and export modules

OPTIMA_Administrators can also restrict access to folders and modules. Other users can still view restricted folders and modules, but only an OPTIMA_Administrator can edit them. All OPTIMA_Users can view modules.

Creating Folders for Modules


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create and delete folders in the Module Explorer. To create a new folder: 1 From the Inspector menu, click Modules. - or Click the Modules button 2 .

In the Module Explorer, browse to where you want to create the new folder and right-click. From the menu that appears, click New Folder. - or Click the New Folder button .

Type a name for your new folder and press Enter.

OPTIMA_Administrators can restrict access to folders to prevent other users from accessing them. For more information about this, see Restricting Access to Folders on page 155.

Deleting Folders
To delete a folder: 1 2 In the Module Explorer window, highlight the folder you want to delete. Right-click and, from the menu that appears, click Delete. - or Click the Delete button 3 .

In the Confirm dialog box, click Yes to delete the folder and return to the Module Explorer.

Page 154

AIRCOM OPTIMA User Reference Guide Version 6.2

Restricting Access to Folders


If you are an OPTIMA_Administrator, you can restrict access to prevent users who do not have Administrator permissions from editing, moving or deleting folders. To restrict access to a folder: 1 From the Inspector menu, select Modules. -or Click the Modules button 2 3 4 .

In the Module Explorer, select the folder you want to restrict. Right-click and then, from the menu that appears, click Properties. On the Security tab in the Module Folder Properties dialog box, select the Admin Folder checkbox.

5 6

Click OK. If the selected folder has child folders, you will be asked if you want to apply changes to all child folders. This enables you to restrict all of the child folders of an Admin Folder. Click Yes to apply changes, otherwise click No. Follow the previous steps and clear the Admin Folder checkbox.

To remove the restriction from a folder:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 155

Viewing Modules
To view a module in AIRCOM OPTIMA: 1 From the Inspector menu, select Modules. - or Click the Modules button .

The Module Explorer appears, displaying a directory of all of the folders containing modules on the left-hand side. This picture shows an example:

2 3

In the Module Explorer, select the file containing the modules you want to view. A list of the modules will appear in the right-hand pane. You can choose to view the modules as a list or as a list with details. To change between the two, right-click and then, from the menu that appears, point to View and click List or Details.

Double-click the module name to view that module.

Page 156

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating Modules
If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create modules. To do this: 1 From the Inspector menu, select Modules. -or Click the Modules button 2 .

In the Module Explorer, right-click and then, from the menu that appears, click New Module. - or Click the Add New Module button The Module Maker dialog box appears: .

In the Details pane: Type a name and a description for the new module Select the Enabled checkbox to enable OPTIMA_Users to use the module

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 157

In the Element Hierarchy pane you define the selection tree information to be displayed by the module. To do this either: Click Select to open the Element Hierarchy Selection dialog box. Select the element hierarchy you want to use and click OK. For more information about element hierarchies, see Using the Element Hierarchies Explorer on page 171. If you want to manually edit the element hierarchy SQL, click Edit Query . In the Data Explorer that appears, edit the query as required. When you have finished, click OK, and then click Yes to save your changes. For more information, see Using the Data Explorer on page 108. Editing an element hierarchy in this way breaks the link between the module and the original element hierarchy. Any changes that you make will not be updated in the original element hierarchy. Similarly, changes to the original element hierarchy will not be captured by the module. - or Click Edit Query and, in the Data Explorer that appears, define the query for the network element tree. When you have finished, click OK, and then click Yes to save your changes. For more information, see Using the Data Explorer on page 108. When creating a network element tree, you should choose your elements from database tables which allow smaller querying, making the return of data faster. Your statement should also return data with no duplicates thereby making the operation of the statement simpler. In order to meet both of the above criteria it is strongly recommended that you query the Configuration tables. The addition of a DISTINCT or WHERE command will also prevent duplicates being returned if you choose to query other database tables. If the Element Hierarchy pane is hidden, click the Preview Query/Tree button to display it.

When you have defined the selection tree, click Preview Tree to view the selection tree you have created. A network element tree of the information you have just entered appears on the Preview tab. This picture shows an example:

Page 158

AIRCOM OPTIMA User Reference Guide Version 6.2

If you have included a date filter in the SQL, you must also define a date and time in the Date Time Entry dialog box. Select a date range and click OK to continue. 6 In the Element Queries pane you can define a separate query for each tree level. This customises the data displayed in a grid or graph when an item is selected from the network element tree. The following table describes how to do this:
In this column Description Query Do this Click in the row and, in the dialog box that appears, type a description and click OK. Click in the row and, in the dialog box that appears, click Edit. In the Data Explorer that appears, define the tree level query. When you have finished, click OK, and then click Yes to save your changes. For more information about the Data Explorer, see Using the Data Explorer on page 108. Graph Type Click in the row and select the type of graph you require from the drop-down list. The graph is shown when you run a module in a combination window. For more information, see Using Graphs on page 247. X-Axis Field Plot Data Click in the row and select the x-axis field you require from the drop-down list. Click in the row and, in the dialog box that appears, choose how you want to plot data by selecting the appropriate radio button and clicking OK.

This picture shows an example:

Click OK to finish.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 159

Element Aggregation in Module Queries


Element Aggregation enables a module data query defined at one element level (e.g. the cell level) to be run at parent element levels (e.g. the BSC and MSC level) to return aggregated data. For example, if a query defined at the cell level returns traffic data for individual cells, the same query when run at the BSC level can be configured to return average or total traffic data by BSC. For example, consider the element hierarchy shown here: Network MSC BSC Cell

In this hierarchy, a data query defined at the Cell level can be run at the BSC, MSC, and Network level. A data query defined at the BSC level can be run at the MSC and Network level, and so on. When the query is run at a parent element level, AIRCOM OPTIMA generates an aggregation query by enclosing the original query in an outer Group by query. The outer query has: A SELECT clause that contains the parent elements, all date-time fields, and the aggregated counters A GROUP BY clause that groups the data by the parent elements and the datetime fields

For example, supposing that your CELL element level query is: SELECT ERICSSON2G.CELLSTATS.BSC, ERICSSON2G.CELLSTATS.CELL, ERICSSON2G.CELLSTATS.SDATE, ERICSSON2G.CELLSTATS.ERLANG FROM ERICSSON2G.CELLSTATS When the query is run at the BSC level, the query is modified to produce the aggregation query shown here. The aggregation functions applied to each counter are specified when the query is defined. SELECT BSC, SDATE, AVG(ERLANG) FROM ( SELECT ERICSSON2G.CELLSTATS.BSC, ERICSSON2G.CELLSTATS.CELL, ERICSSON2G.CELLSTATS.SDATE, ERICSSON2G.CELLSTATS.ERLANG

Page 160

AIRCOM OPTIMA User Reference Guide Version 6.2

FROM ERICSSON2G.CELLSTATS ) GROUP BY BSC, SDATE For queries that include element aggregation, AIRCOM OPTIMA supports noncommutative equations, that is, equations where the order of elements has an effect on the final result. As a result, you should define your queries carefully. As a very simple example, consider the following cell data for BSC1:
Cell Cell1 Cell2 Cell3 Cell4 Counter 1 3 4 8 6 Counter 2 2 2 2 2

If you have two KPIs: KPI1 = %aggr (Counter 1) KPI2 = %aggr (Counter 2) And you define an element aggregation equation of: select %KPI(KPI1)/%KPI(KPI2) from table With an element aggregation function of 'SUM', you would get the following result: select SUM (Counter 1) / SUM (Counter 2) from table Which would divide the added results of Counter 1 from the added results of Counter 2, in other words (3 + 4 + 8 + 6) / (2 + 2 + 2 + 2) = 21/8 = 2.6 However, if you have not defined aggregation within the KPI equations, then you would get a quite different result: select SUM (COUNTER1/COUNTER2) from table Which would add all of the results of Counter 1/Counter 2 together, in other words, (3/2) + (4/2) + (8/2) + (6/2) = 1.5 + 2 + 4 + 3 = 10.5

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 161

Configuring Element Aggregation


To configure a module to use element aggregation: 1 2 3 4 5 From the Inspector menu, click Modules. In the Module Explorer, select the folder containing the modules you want to view. A list of the modules appears in the right-hand pane. Double-click a module name to view that module. From the Element Queries pane in the dialog box that appears, double-click the element level for which the query is defined. The Data Explorer opens. In the elements list box in the Filters tab, set the data field for each element level at which you want to run the query. (When the data field is set, the element agg checkbox is automatically selected to indicate that the query can run at that element level.) In the Column Settings tab, set the aggregation functions for each counter that you want to include in the aggregated queries. You can select a standard aggregation function, such as AVG, SUM, or write your own aggregation formula using the Expression Editor. The following table describes the different column types for each column and data field: Only the query 'Counter' columns can be aggregated.
Column Type Identifier DateTime Counter Description Indicates the text fields in the SQL query. Indicates the date and time fields in the SQL query. Indicates the numerical fields in the SQL query.

This picture shows the Column Settings tab:

Page 162

AIRCOM OPTIMA User Reference Guide Version 6.2

7 8

Set the aggregation type. For more information on how to do this, see Setting the Aggregation Type for Element Aggregation on page 163. In the Data Explorer, click OK and then click Yes to save the changes.

You can click View/Test element aggregation SQL button to view the aggregation query and check that the query is valid. Setting the Aggregation Type for Element Aggregation When you are configuring element aggregation, to set the aggregation type: Click the Aggregate Type column corresponding to the Counter column type and select a function from the drop-down list to set the aggregate type and formula. If there is a KPI defined in the SQL query, then you will not be able to set the aggregate type for it. This is because the aggregation type for a KPI is set while defining a KPI. For more information, see Creating KPIs on page 134. If required, you can define your own aggregation function. To do this for each counter type: 1 2 Select the User Defined option from the drop-down list. In the Aggregate Formula column, click and type the formula directly in the cell or click to launch the Expression Editor.

- or To do this for multiple counters at the same time: 1 2 3 Click the Set Multiple Aggregates button . From the Global Aggregate drop-down list in the Quick Aggregation dialog box that appears, select the counter type you require. Click the Apply Aggregate to All Fields button if you want to apply the counter type to all columns. - or If you want to apply the counter type to one or more columns, select the column(s) in the Field Name list and click the Apply Aggregate to Selected Fields button. You can only set the aggregate type and formula for the COUNTER column type. If you select User Defined aggregate type, click the Aggregate Formula column to define a new aggregate type in the Expression Editor dialog box. Tips : 4 Use the Shift and Ctrl keys to highlight more than one column at a time To clear all counters, click the Clear All Aggregates button

Click OK to save your changes and close the Quick Aggregation dialog box.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 163

This picture shows an example of the Quick Aggregation dialog box:

Setting the Aggregate Description for Element Aggregation When you are configuring element aggregation, to set the aggregate description: 1 In the Description column, type the description for the column. - or Click the Get Default Column Descriptions button to populate the description column with the data. This data is present in the table and field information dialog box. For more information, see About Table and Field Information Settings on page 91. You can edit this description information and it is saved only for this data query. It does not get reflected in the Table and Field Information Settings. 2 Click Preview SQL . The Selection dialog box opens. Select the elements and parameters for element aggregation. For more information, see Selecting Filter Values and Parameters on page 122. Click OK to run the query. The Preview tab is populated with the output data of the aggregated query.

Page 164

AIRCOM OPTIMA User Reference Guide Version 6.2

Displaying Element Aggregated Data in Inspector


Element Aggregation allows you to change a module element level query by aggregating to a parent level. For more information on element aggregation, see Element Aggregation in Module Queries on page 160. When a module query is run at a parent element level, aggregated data is displayed in both the data grid and in the graph. The aggregated data is displayed in the graph only if a graph is defined. To set the level at which you want to run a module data query: 1 2 From the Inspector menu, click Module Combinations. In the Module Combination Explorer, select a folder containing the module combinations you want to view. A list of module combinations appears in the right-hand pane. Double-click a module combination. In the Modules pane, expand a module to view its element tree. Select the elements whose data query you want to run. For example, in the picture shown here, the selected module has an element tree containing BSCs, site names, and cells. As shown, two cells are selected, hence the cell level data query is run.

3 4 5

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 165

Select the element level at which you want the data query. You can do this in two ways: Right-click a Cell and from the menu that appears, point to Run Level (Element Aggregation) and click the element level (Cell, Sitename, BSC) at which you want to run the query as shown in the picture here:

In the Module pane, click the Module Settings button . In the Module Settings dialog box that appears, select the Aggregation tab and set the Element Aggregation level.

When you select a parent level for element aggregation, all the elements at that level are marked in green. For example, if you select the run level for element aggregation as SiteName, the sites in the tree are shown in green. This picture shows an example, where the following sites are green: Green Hall Institute Victoria Island City Hotel Peco Industrial Rentokil Victoria Street

Page 166

AIRCOM OPTIMA User Reference Guide Version 6.2

Wisma Rajab

From the toolbar, click

to run the selected module.

Restricting Access to Modules


If you are an OPTIMA_Administrator, you can restrict access to modules to prevent users who do not have Administrator permissions from making changes. You may want to restrict access if a module is particularly complex to create or if a module is used by lots of users, to prevent the module being changed in error. To restrict access to a module: 1 From the Inspector menu, select Modules. -or Click the Modules button 2 3 4 5 .

In the Module Explorer, select the module you want to restrict. Right-click and then, from the menu that appears, click Properties. In the Module Properties dialog box, select the Admin Module checkbox. Click OK.

To remove the restriction from a module, follow the previous steps and clear the Admin Module checkbox.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 167

Restricting Editing of Modules


You can use an owning group to restrict who has editing access to a module. If a module is assigned an owning group, then it can only be edited by members of that group. A module can only have one owning group. To assign an owning group for a module, you must be: An OPTIMA_Administrator - or An OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, and a member of the group that owns the module From the Inspector menu, click Modules. -or Click the Modules button 2 .

To make a group the owner of a module: 1

In the Module Explorer window, select the module you want to set the owning group for. You cannot assign the owning group for an Admin Module, unless you are an OPTIMA_Administrator.

3 4 5

Right-click the selected module and from the menu that appears, click Properties. In the Module Properties dialog box, select a group from the drop-down list. Click OK.

Editing and Deleting Modules


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can edit and delete modules. To edit a module: 1 From the Inspector menu, select Modules. or Click the Modules button 2 3 Click OK to save the changes. .

Double-click the module and make the necessary changes.

Page 168

AIRCOM OPTIMA User Reference Guide Version 6.2

To delete a module: 1 From the Inspector menu, click Modules. or Click the Modules button 2 .

Select the module you want to delete, right-click and, from the menu that appears, click Delete. or Select the module you want to delete and click the Delete button .

In the Confirm dialog box, click Yes to delete the module.

Opening a Module in a New Combination


To open a module in a new combination: 1 From the Inspector menu, select Modules. -or Click the Modules button 2 3 .

In the Module Explorer, select the module you want to open in a new combination. Right-click and then, from the menu that appears, click Execute. The New Module Combination dialog box appears with the selected module added.

For more information about combinations, see About Combination Windows on page 179.

Copying Modules
If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can copy existing modules and then modify them. To do this: 1 From the Inspector menu, click Modules. -or Click the Modules button 2 .

In the Module Explorer, select the module(s) you want to copy.

Use the Shift and Ctrl keys to select more than one module at a time.
AIRCOM OPTIMA User Reference Guide Version 6.2 Page 169

3 4 5

Right-click, and from the menu that appears, click Copy. Select the folder that you want to copy the module(s) to. Right-click, and from the menu that appears, click Paste. The modules are copied to the specified folder.

Importing and Exporting Modules


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can export modules to a datafile and then import and use them in another AIRCOM OPTIMA installation. You can import and export: Modules Module folders A combination of modules and module folders

You must be an OPTIMA_Administrator to be able to import and export Admin modules and Admin folders. To import a module: 1 2 In the Module Explorer, select the folder into which you want to import the file(s). Click the Import Module From File button - or Right-click, and from the menu that appears, click Import. 3 4 5 6 Click OK to confirm. In the Import Modules dialog box, click the Browse button. In the Browse for Folder dialog box, select the folder which contains the module(s) you want to import and click OK. In the File Name list, select the file(s) and/or folder(s) you want to import and click OK. Use the Shift and Ctrl keys to select more than one file and/or folder at a time. 7 If your selection includes modules in subfolders, you will be asked if you want to recreate the directory structure in the Module Explorer. Click Yes to recreate the directory structure, otherwise click No. In the message box that appears, click OK to import the module(s). The modules are imported to the specified folder. .

Page 170

AIRCOM OPTIMA User Reference Guide Version 6.2

To export a module: 1 In the Module Explorer, select the module(s) and/or folder(s) you want to export. Use the Shift and Ctrl keys to select more than one module and/or folder at a time. 2 Click the Export Module to File button - or Right-click, and from the menu that appears, click Export. 3 If your selection includes modules in subfolders, then in the Export Modules dialog box, set the following options by selecting or clearing the appropriate checkboxes:
Item Export modules from subfolders Create folders in destination directory Description Select this option if you want to export the modules contained in the subfolders as well as the selected folder. If you have chosen to export modules from subfolders, select this option if you want to recreate the directory structure in your destination directory.

4 5 6

Click OK. In the Browse for Folder dialog box, select the folder into which you want to export the module(s) and click OK. In the message box that appears, click OK to export the module(s). The modules are exported to the specified folder.

Using the Element Hierarchies Explorer


In the Element Hierarchies Explorer, you can create, edit and delete element hierarchies. Element hierarchies are re-usable SQL queries which enable you to display network elements in the form of a hierarchical tree. You can use element hierarchies in modules instead of defining a new element tree SQL query each time you create a module. For more information, see About Modules on page 153. You can use three types of element hierarchy. These are described in this table:
This Type Personal Group System Can be Used By The user who creates them and OPTIMA_Administrators. The user who creates them, group members, and OPTIMA_Administrators. OPTIMA_Administrators only.

Important : If you are an OPTIMA_Administrator, you can add, edit and delete all types of element hierarchy, as well as restrict access to them If you are any other type of user, you can add, edit and delete personal element hierarchies and group element hierarchies (if you are a member of the group)

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 171

To open the Element Hierarchies Explorer: From the Tools menu, click Element Hierarchies. - or Click the Element Hierarchies button .

The Element Hierarchies Explorer opens, this picture shows an example:

Element Hierarchies Explorer

About the Element Hierarchies Explorer Toolbar


This picture shows the Element Hierarchies Explorer toolbar:
Element Hierarchies Explorer toolbar

This table describes the available buttons:


Button Description Exit the Element Hierarchy Explorer. Create new element hierarchy. Edit element hierarchy. Delete element hierarchy. Copy element hierarchy.

Page 172

AIRCOM OPTIMA User Reference Guide Version 6.2

Button

Description Paste element hierarchy. Display the element hierarchy Preview and SQL tabs. Display the element hierarchies in a more detailed list format (name, description, next scheduled date and so on). Display the element hierarchies in a simple list format (name only). Search for an element hierarchy.

Creating Element Hierarchies in the Element Hierarchies Explorer


To create an element hierarchy: 1 In the Element Hierarchies Explorer, either: From the File menu, point to New Element Hierarchy. - or Click the Create New Element Hierarchy button .

The Element Hierarchy Creation Wizard appears. This picture shows an example:

In the Element Hierarchy (Add) dialog box, on the Details tab, complete the following information:
In this field: Name Description Type Do this: Type a name for the element hierarchy. Type a description for the element hierarchy. Choose the type you require by selecting the appropriate radio button.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 173

3 4

Click Next. On the SQL tab, you define the data query for the element hierarchy. To do this: Click Edit. The Data Explorer appears. In the Data Explorer, define the SQL for the element hierarchy. For more information, see Defining a Query on page 110. When you have finished, click OK and then click Yes to save your changes. The SQL is added to the SQL pane.

5 6 7

Click Next. The query is executed and the results are displayed on the Preview tab. Click Next. If you chose to save your element hierarchy as a Group or Administrator hierarchy, on the Security tab, complete the following information:
In this field: Admin Only Do this: Select this checkbox if you only want OPTIMA_Administrators to access the element hierarchy. This option is only enabled for Administration element hierarchies. Group list Select the user group(s) that can use the element hierarchy. To add a new group: 1. Click Add. 2. In the Select Groups dialog box that appears, select the group(s) you want to have access to this element hierarchy and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List.

On the Complete tab, check your element hierarchy details and then click Finish. The element hierarchy is now available from the list in the Element Hierarchies Explorer.

Editing Element Hierarchies


In the Element Hierarchies Explorer, you can edit existing element hierarchies. To edit an element hierarchy: 1 2 In the Element Hierarchies Explorer, select the element hierarchy you want to edit. Double-click the element hierarchy. - or Right-click, and from the menu that appears, click Edit Element Hierarchy. - or Click the Edit Element Hierarchy button 3 .

If the element hierarchy is used by any modules, a message box is displayed listing these modules. Click Yes to continue editing the element hierarchy.
AIRCOM OPTIMA User Reference Guide Version 6.2

Page 174

In the Element Hierarchy (Edit) dialog box that appears, edit the element hierarchy details as required on each page. When you are satisfied, click the Finish button on the final page.

Renaming Element Hierarchies


In the Element Hierarchies Explorer, you can rename existing element hierarchies. To rename an element hierarchy: 1 2 3 In the Element Hierarchies Explorer, select the element hierarchy you want to rename. Right-click, and from the menu that appears, click Rename. Type in the new name for the element hierarchy and press Enter.

Deleting Element Hierarchies


You can only delete an element hierarchy if it is not used in any modules. To delete an element hierarchy: 1 2 In the Element Hierarchies Explorer, select the element hierarchy you want to delete. Right-click, and from the menu that appears, click Delete. - or Click the Delete Element Hierarchy button 3 .

In the message box that appears, click Yes to confirm. The element hierarchy is deleted from the list in the Element Hierarchies Explorer.

Setting Element Hierarchy Security


If you are the creator of a group element hierarchy or an OPTIMA_Administrator, you can select which groups are allowed to use that group element hierarchy. To do this: 1 2 3 In the Element Hierarchies Explorer, select the group element hierarchy. Right-click and, from the menu that appears, click Properties. The Element Hierarchy Properties dialog box appears. In the Element Hierarchy Properties dialog box, on the Security tab, select the user group(s) that can use the element hierarchy. To add a new group: Click Add. In the Select Groups dialog box that appears, select the group(s) you want to have access to this element hierarchy and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List. 4 Click Apply to save your changes.
Page 175

AIRCOM OPTIMA User Reference Guide Version 6.2

Click OK to close the Element Hierarchy Properties dialog box and return to the Element Hierarchies Explorer.

Finding Element Hierarchies


If you want to view a particular element hierarchy, you can search for it in the database. To find an element hierarchy: 1 From the Edit menu, click Search. - or Click the Search button 2 .

In the Find Element Hierarchy dialog box that appears, type the name of the element hierarchy you wish to find. Element hierarchy names are case-insensitive.

3 4 5

Click Find First and the first occurrence of the element hierarchy is highlighted. Click Find Next and the next occurrence of the element hierarchy is highlighted. To close the dialog box and return to the Element Hierarchies Explorer, click Cancel.

Copying Element Hierarchies in the Hierarchies Explorer


To copy an element hierarchy: 1 2 In the Element Hierarchies Explorer, select the element hierarchy that you want to copy. Right-click, and from the menu that appears, click Copy Element Hierarchy. - or Click the Copy Element Hierarchy button 3 4 .

Select the folder into which you want to copy the element hierarchy. Right-click, and from the menu that appears, click Paste Element Hierarchy. or Click the Paste Element Hierarchy button .

The element hierarchy is copied to the specified folder.

Page 176

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing Element Hierarchies in the Element Hierarchies Explorer


To view the different types of element hierarchy available in the Element Hierarchies Explorer: In the Element Hierarchies Explorer, in the left-hand pane, click the element hierarchy type you want to view. All existing element hierarchies of that type are then displayed in the right-hand pane. For example, click Group to view the Group element hierarchies.

If you only want to view your own personal element hierarchies, right-click in the left-hand pane and, from the menu that appears, click Show only current user's hierarchies.

Previewing Element Hierarchies in the Element Hierarchies Explorer


To preview an element hierarchy in the Element Hierarchies Explorer: 1 2 In the Element Hierarchies Explorer, select the element hierarchy you want to preview. Click the Preview tab and click OK to confirm in the message box that appears. - or Click Run. The element hierarchy is displayed on the Preview tab:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 177

Page 178

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 6

Viewing Data
AIRCOM OPTIMA enables you to view specific data from your network using combination windows, which you can define yourself. For example, you can display cell statistics within a certain date range in both a graph and a grid layout.

About Combination Windows


In AIRCOM OPTIMA, you can view data in either a pre-defined combination window or a window you have created. A combination window is made up of a number of panes. This picture shows an example:

Combination Window Example

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 179

The following table describes how you can customise the window using these panes.
This Pane Modules Enables you to Add and remove modules that customise the data that is to be displayed in the window. For more information, see Creating Combination Windows on page 185. You can run one module, or a combination of modules.

Filters

Select, create and edit custom filters. You can hide or display this pane by clicking on the title bar. For more information, see Filtering Elements in the Modules Pane on page 207.

Date Range

Set the date range for the data to be displayed. You can hide or display this pane by clicking on the title bar. For more information, see Setting a Date Range on page 199.

Grid

Display the data. You can modify the order of the data as well as search for specific information. For more information, see Customising Grids on page 229.

Page 180

AIRCOM OPTIMA User Reference Guide Version 6.2

This Pane Series List

Enables you to Select what data appears in the graph pane. For more information, see About the Series List on page 267.

Graphs

Display the data in a graph format. For more information, see Displaying Data in Graphs on page 212.

Before you can use combination windows, OPTIMA_Administrators, OPTIMA_Alarm_Administrators or OPTIMA_Advanced_Users must first define the modules. For more information, see Creating Modules on page 157.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 181

Creating Folders for Combination Windows


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create and delete folders in the Combination Explorer. To create a new folder: 1 From the Inspector menu, click Module Combinations. - or Click the Module Combinations button 2 .

In the Combination Explorer window, browse to where you want to create the new folder and right-click. From the menu that appears, click New Folder.

- or Click the New Folder button 3 .

Type a name for your new folder and press Enter. You can also create a new folder when creating a new combination window or saving a copy of an existing combination, using the Create New folder button .

OPTIMA_Administrators can restrict access to folders to prevent other users from accessing them. For more information about this, see Restricting Access to Folders on page 183.

Page 182

AIRCOM OPTIMA User Reference Guide Version 6.2

Restricting Access to Folders


If you are an OPTIMA_Administrator, you can restrict access to folders to prevent users and other Administrators from editing, moving or deleting them. To restrict access to a folder: 1 From the Inspector menu, select Module Combinations. -or Click the Module Combinations button 2 3 4 .

In the Combination Explorer, select the folder you want to restrict. Right-click and then, from the menu that appears, click Properties. On the Security tab in the Combination Folder Properties dialog box, select the Admin Folder checkbox.

5 6

Click OK. If the selected folder has child folders, you will be asked if you want to apply changes to all child folders. This enables you to restrict all of the child folders of an Admin Folder. Click Yes to apply changes, otherwise click No. Follow the previous steps and clear the Admin Folder checkbox.

To remove the restriction from a folder:

Deleting Folders
To delete a folder: 1 In the Combination Explorer window, highlight the folder you want to delete If you delete a parent folder, all of its subfolders will be deleted as well. 2 Right-click and, from the menu that appears, click Delete. - or Click the Delete button 3 .

In the Confirm dialog box, click Yes to delete the folder and return to the Combination Explorer.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 183

Viewing Pre-Defined Combination Windows


To view a pre-defined combination window: 1 From the Inspector menu, click Module Combinations. or Click the Module Combinations button 2 .

In the Combination Explorer, select the file containing the combination window you want to view. A list of the combinations will appear in the right-hand pane. You can choose to view the combinations as a list or as a list with details. To change between the two, right-click and then, from the menu that appears, point to View and select List or Details.

3 4

Double-click on a combination name to open that combination window. Select the data you want to view, for example, the network elements and date. For more information, see Filtering Data in the Combination Window on page 198. Click the Run All Modules button combination. to view data for all the modules in the

If you want to view a single module, select it in the Module pane and click the Run Highlighted Module button .

Page 184

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating Combination Windows


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create combination windows. To create a new combination window: 1 From the Inspector menu, click New Combination. or Click the New Combination button 2 .

In the New Module Combination window that appears, either: Right-click the Modules pane and, from the menu that appears, click Add Module. - or Click the Add Module to Combination button .

From the Select Module dialog box, select the module you wish to use and click Open. The module appears in the Module pane. or In the Module Explorer, select the module you wish to use and drag and drop it onto the Modules pane. The module appears in the Module pane. If you want to select more than one module, hold down the Shift key and click the modules you want to select before dragging.

3 4

You can now create links between the modules to view associated element data. For more information, see Displaying Element Data Across Modules on page 187. To save the combination, right-click the Modules pane and, from the menu that appears, click Save. or Click the Save button .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 185

The Save Module Combination dialog box appears:

In this dialog box: Select the folder in which you want to save the module combination. If the required folder does not exist, then click the Create New Folder button . Type a name and (if required) a description and click Save.

Removing Modules from the Combination Window


To remove a module from the combination window: 1 2 3 In the Module Combination window, select the module you want to remove and click the Remove Module button . In the Confirm dialog box that appears, click Yes to delete the module. To save the window, click the Save button - or To save a copy of the window: Click the Save As button . .

Select the folder in which you want to save the module combination.

Page 186

AIRCOM OPTIMA User Reference Guide Version 6.2

If the required folder does not exist, then click the Create New Folder button . Type a name and (if required) a description and click Save.

Removing a module from a combination window does not delete that module from the Module Explorer.

Refreshing Modules in the Combination Window


You use the Refresh Module option to update a module in the combination window, and ensure that it is the most up-to-date version. To refresh a module: 1 2 3 In the Modules pane, highlight the module you want to refresh. Right-click the Modules pane and, from the menu that appears, select Refresh Module. In the message box that appears, click Yes to confirm. The selected module is refreshed.

Deleting Combination Windows


To delete a saved combination window: 1 2 In the Module Combination Explorer window, select the module combination you want to delete. Click the Delete button - or Right-click and, from the menu that appears, click Delete. 3 The Confirm dialog box appears, click Yes to delete the combination window. .

Displaying Element Data Across Modules


When you combine modules you can also add links between them so that the modules display data for the same elements selected from any of the module network element trees. There are two different types of link:
Item Tree Links Description Between modules and link elements in the module trees. When an element in one module tree is selected, all other elements with the same name are automatically selected in the other module trees. Links can be edited to include other matching attributes. Drill Down Links Between levels in the same or other modules. Drill down links do not have default settings. When you create a drill down link, you also have to select a field to be used in the link. This link will enable you to view data from linked modules.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 187

To enable or disable linking within a combination: In the Module pane, right-click and from the menu that appears, click Enable Linking:

Adding Links
To add links in a Module Combination window: 1 Click the Edit Module Links button - or Right-click the Modules pane and, from the menu that appears, click Edit Links. The Module Links dialog box appears. The Modules pane lists each module and each level under that module for which data is available. 2 3 Highlight a level in the Module pane and click Add. The Link Editor appears. Select the type of link you want to create, either a Tree link or a Drill down link. If the link is between data levels in the same module, you must select Drill down link. From the Additional Levels/Data Fields listed in the Source Module pane, select the level/field you want to link. From the TARGET Module and Tree Level menus, select the module and level you want to link to. The Additional Levels pane shows the list of available levels. 6 Highlight the level you want to link to and click the > and < buttons to add or remove links from the Additional Links pane. If you have selected a drill down link, the first link is automatically set to the TARGET module tree level.
Page 188 AIRCOM OPTIMA User Reference Guide Version 6.2

4 5

7 8

When you have finished adding links to the Additional Links pane, click OK. In the Module Links dialog box, click OK to save the changes and return to the combination window. You can now run the linked modules from the grid.

Editing and Removing Links


To edit a link: 1 In the Links pane of the Module Links dialog box: 2 3 Double-click the link that you want to edit. - or Select the link that you want to edit, and then click Edit.

Make the required changes and click OK. In the Module Links dialog box, click OK to save the changes and return to the combination window. In the Links pane of the Module Links dialog box, select the link. Click Remove. The link is removed. Click OK to save the changes and return to the combination window.

To remove a link: 1 2 3

Running Linked Modules


When you have added drill-down links between modules, you can run the linked modules from either the grid or the graph. Elements in a grid column that have available drill-down links are underlined and shown in blue text. To run linked modules from the grid: 1 If you want to run the linked modules for a single element, double-click the element name for which you wish to run linked modules. For example cell 306A. - or If you want to run the linked modules for more than one element: Click the first element in the column and then hold down the left mouse button to highlight all of the elements for which you want to run linked modules You cannot select multiple columns. Right-click, and from the menu that appears, click Multi Element Drill Down

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 189

In the dialog box that appears, select the linked modules that you want to run:

Click OK to run the linked modules. The data for the linked modules will appear in the grid.

To run linked modules from the graph: 1 2 3 Double-click the series point for which you wish to run linked modules. In the dialog box that appears, select the linked modules that you want to run. Click OK to run the linked modules. The data for the linked modules will appear in the grid.

Page 190

AIRCOM OPTIMA User Reference Guide Version 6.2

Restricting Access to Combination Windows


If you are an OPTIMA_Administrator, you can restrict access to folders to prevent users and other Administrators from editing, moving or deleting these folders. To restrict access to a combination: 1 From the Inspector menu, select Module Combinations. -or Click the Module Combinations button 2 3 4 5 .

In the Combination Explorer, select the combination you want to restrict. Right-click and then, from the menu that appears, click Properties. In the Combination Module Properties dialog box, select the Admin Combination checkbox. Click OK.

To remove the restriction from a combination, follow the previous steps and clear the Admin Combination checkbox.

Restricting Editing of Combination Windows


You can use an owning group to restrict who has editing access to a combination. If a combination is assigned an owning group, then it can only be edited by members of that group. A combination can only have one owning group. To assign an owning group for a combination, you must be: An OPTIMA_Administrator An OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, and be a member the group that owns the combination From the Inspector menu, click Module Combinations. -or Click the Module Combinations button 2 .

To make a group the owner of a combination: 1

In the Combination Explorer window, select the combination you want to set the owning group for. You cannot assign the owning group for an Admin Combination, unless you have OPTIMA_Administrator permissions.

3 4 5

Right-click the selected combination and from the menu that appears, click Properties. In the Combination Module Properties dialog box, select a group from the dropdown list. Click OK.
Page 191

AIRCOM OPTIMA User Reference Guide Version 6.2

Copying Combination Windows


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can copy existing combination windows in a number of ways (and then modify them): 1 Using the Copy option in the Combination Explorer Using the Save As option in the Module Combination window From the Inspector menu, click Module Combinations. -or Click the Module Combinations button 2 .

To use the Copy option:

In the Combination Explorer, select the combination window(s) you want to copy.

Use the Shift and Ctrl keys to select more than one combination at a time. 3 4 5 Right-click, and from the menu that appears, click Copy. Select the folder into which you want to copy the combination window(s). Right-click, and from the menu that appears, click Paste. The combinations are copied to the specified folder. In the Combination Explorer, double-click the module combination window that you want to copy. In the module combination window, click the Save As button In the Save Module Combination dialog box: Select the folder in which you want to save the copy of the module combination. If the required folder does not exist, then click the Create New Folder button . Type a name and (if required) a description and click Save. .

To use the Save As option: 1 2 3

To save a copy of the module combination window, and not just overwrite the version that you have opened, ensure that either the name or folder are different to the original.

Page 192

AIRCOM OPTIMA User Reference Guide Version 6.2

Importing and Exporting Combination Windows


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can export module combinations to a datafile and then import and use them in another AIRCOM OPTIMA installation. You can import and export: Combinations Combination folders A combination of combinations and combination folders

You must be an OPTIMA_Administrator to be able to import and export Admin combinations and Admin folders. To import a combination: 1 2 In the Combination Explorer, select the folder into which you want to import the file(s). Click the Import Module Combination From File button - or Right-click, and from the menu that appears, click Import. 3 4 5 6 Click OK to confirm. In the Import Module Combinations dialog box, click the Browse button. In the Browse for Folder dialog box, select the folder which contains the combination(s) you want to import and click OK. In the File Name list, select the file(s) and/or folder(s) you want to import and click OK. Use the Shift and Ctrl keys to select more than one file and/or folder at a time. 7 If your selection includes combinations in sub-folders, you will be asked if you want to recreate the directory structure in the Combination Explorer. Click Yes to recreate the directory structure, otherwise click No. In the message box that appears, click OK to import the combination(s). The combinations are imported to the specified folder. In the Combination Explorer, select the combination(s) and/or folder(s) you want to export. Use the Shift and Ctrl keys to select more than one combination and/or folder at a time. 2 Click the Export Module Combination to File button - or Right-click, and from the menu that appears, click Export. . .

To export a combination: 1

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 193

If your selection includes combinations in sub-folders, then in the Export Module Combinations dialog box, set the following options by selecting or clearing the appropriate checkboxes: Export module combinations from sub-folders Create folders in destination directory

4 5 6

Click OK. In the Browse for Folder dialog box, select the folder into which you want to export the combination(s) and click OK. In the message box that appears, click OK to export the combinations(s). The combinations are exported to the specified folder.

Adding and Editing Favourites


AIRCOM OPTIMA enables you to save module combinations, reports and work areas as favourites. This means you will have fast and easy access to information, via a customised toolbar. The toolbar contains a shortcut button for each favourite you save and is enabled after you have saved one or more favourites. This is an example of the Favourites toolbar, which appears next to the Main Clock button:

Favourites toolbar

To add or edit favourites: 1 From the Favourites menu, click Open Favourites:

You can right-click the module combination, report or work area you want to save and click Add to Favourites. 2 In the Favourites dialog box that appears, edit an existing favourite by selecting it and modifying the information or delete a favourite from the list by selecting it and clicking Delete.

Page 194

AIRCOM OPTIMA User Reference Guide Version 6.2

To add a favourite, click Add and then, from the Favourite Type dialog box, select the type of favourite that you want to add:

4 5

Click OK. To continue creating the favourite: If you chose to add a module combination, in the Module Combination Explorer that appears, select the combination you want to add and click OK If you chose to add a report, in the Report Explorer that appears, select the report you want to add and click OK If you chose to add a work area, browse to the work area .INI file and click Open

The combination, report or work area appears in the Favourites dialog box, with a default icon:

To add a new icon, click the Upload Icon button and then in the dialog box that appears, select the required icon file (which must be sized 16x16 pixels) and click Open. AIRCOM provides a set of sample icon files that you can use. They are stored in the 'Favourite Icons' folder of your installation - for example, 'C:\Program Files\AIRCOM International\ENTERPRISE Version\Favourite Icons' .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 195

Click Save to save the favourite to memory. The favourite will not be saved to the database until you close AIRCOM OPTIMA. A new button is added to the Favourites toolbar with the selected icon.

You can now access the favourite view by clicking the appropriate button on the Favourites toolbar.

To share your favourites, import and export them using .INI files. For more information, see Exporting and Importing Favourites on page 196.

Exporting and Importing Favourites


If you have added favourites in AIRCOM OPTIMA, you can share them by exporting and importing favourites using INI files. To export all of your favourites: 1 2 From the Favourites menu, click Export Favourites. In the dialog box that appears: Select the required location for the favourites file. Type the required file name. Click Save.

Page 196

AIRCOM OPTIMA User Reference Guide Version 6.2

The favourites are saved in an INI file. This picture shows an example:

To import an INI file containing favourites: 1 2 3 From the Favourites menu, click Import Favourites. In the dialog box that appears, select the required INI file and then click Open. The favourites are imported. To view them, from the Favourites menu, click Open Favourites.

Click Save to save the imported favourites to memory. Imported favourites will not be saved to the database until you close AIRCOM OPTIMA.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 197

Filtering Data in the Combination Window


In the combination window, you can filter the data you view in the grid and graph panes by: Selecting network elements from the modules in the combination. Data is only displayed for the selected items. Setting a date range. This option is available if a date filter has been included in the module. Setting parameter values. This option is available if a parameter has been included in the module. Setting time aggregation. This option is available if you have configured time aggregation.

Filtering Data by Selecting Network Elements


You can select network elements from modules to restrict the data shown in the combination window. You can select elements in the following ways: If you know where the network element appears in the module tree, click the + sign to expand the tree under the module containing the element you want and select the checkbox.

If you do not know where the element appears in the module tree, you can search for it within one module or across all modules. For more information, see Finding Elements in the Modules Pane on page 206. You can apply a filter to select a defined group of elements within the modules. For information, see Filtering Elements in the Modules Pane on page 207.

You can select or clear all the elements under each network element by rightclicking the element name and, from the menu that appears, clicking All or Clear All. When you have selected the network element(s):

Page 198

AIRCOM OPTIMA User Reference Guide Version 6.2

Click the Run All Modules button or the Run Highlighted Module button to refresh the data based on this filtering.

Setting a Date Range


You can restrict data by filtering on the current date or over a specified date range. To select a date or date range: 1 2 3 In the New Module Combination window, click the double down arrow expand the Date Range pane. In the Date Range pane, click the Date Range button Parameter dialog box appears. to

. The Changing Date

On the Range tab, select the period over which you require data in one of these ways:
To Link to the global clock Do this Select the Start or End checkbox and then select Synchronise to Global Clock. The current date and time appears. Type the required period in the Period box. For example, 2 days. You can set a global data and time in the Main Clock. For more information, see Using Clocks on page 68. Specify a duration whose start or end date you know Click either the Start or End checkbox and choose the correct date. Enter the desired period in the period box. For example, 1 week. Select the Include Time checkbox, if you wish to set the start or end time in hours and minutes. Specify a period whose start and end dates you know Select the Start and End checkboxes and choose the required dates. Select the Include Time checkbox, if you wish to set the start or end time in hours and minutes. You cannot synchronise to the global clock if you set a start and end date.

To modify your time period further, on the Exclude/Include tab: Select which days you want to include in the date range. Right-click the Dates of Week area and, from the menu that appears, you can Select All or Deselect All the days or choose just Weekdays or Weekends. Select the Start and End hours for the days you have included. Select the checkbox if you want to Exclude Holidays. For more information about holidays, see Excluding Particular Days from Reports on page 106. or the Run Highlighted Module button

Click the Run All Modules button to refresh the data.

Data for the period that you specified is displayed. The dates you set are saved for this window and you can save different dates for each window separately unless you have linked to the global clock.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 199

Setting Parameter Values


If you have pre-defined parameters, you can set parameter values to filter module data. For more information about defining parameters, see Defining Parameters for a Query on page 116. To set parameter values: 1 2 In the Module Combination window, click the Module Settings button Module Settings dialog box appears. . The

In the Module Settings dialog box, on the Parameter Settings tab, complete the following information:
In this field Operator Values Do this Select an operator from the drop-down list. For example, if you want to create a filter that only returns data for an exact value, then select the = operator. Type the default value(s) for the parameter. Multiple values must be separated by commas. - or Click the Values button and, in the dialog box that appears, set the default values you require and click OK. This button is only available when using certain data types (DATE and NUMBER) and/or operators (Between, Not Between, In List and Not In List). Show All Select this checkbox if you want the parameter to display all of the values of the field.

If you want to set parameter values globally for all modules with the same parameter, select the parameter you require and click Apply Selected Values Globally. Click OK. Click the Run All Modules button to refresh the data. or the Run Highlighted Module button

4 5

Setting Time Aggregation


If you have configured time aggregation for a module, you can set the time period at which to run the module. For more information about time aggregation, see Enabling Time Aggregation for a Query on page 125. To set time aggregation: 1 2 In the Module Combination window, click the Module Settings button The Module Settings dialog box appears. In the Module Settings dialog box, on the Time Aggregation tab, select the time period for the module, at the element hierarchy level you want the query to run. .

Page 200

AIRCOM OPTIMA User Reference Guide Version 6.2

If you want to set time aggregation globally for all modules, select the time period you require and click Apply Selected Values Globally. This setting will only be applied to queries that can run at the specified time period.

Click OK. or the Run Highlighted Module button to

Click the Run All Modules button refresh the data.

The selected time period is indicated by the name of the tab, for example hourly:

Drilling Down into Modules Based on Time


If a module has time aggregation enabled, you can drill down within it based on date (and time). The time aggregation for a particular module is indicated by the subtab below the module name - for example, hourly:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 201

To drill down into a module based on time: 1 Double-click the date column for the particular element into which you want to drill down. The Date Time Picker appears:

The Summary pane contains a brief view of the drill down options selected. 2 If required, select an aggregation type: If you select a different time aggregation type to the one already displayed, a new tab for this type is added, and when the module is run across this time aggregation type the new data is also added to the Series List so that it can be plotted on the graph. - or If you select element aggregation, you can choose to run the module at a different element level.

Page 202

AIRCOM OPTIMA User Reference Guide Version 6.2

If you do not want to use an aggregation type, but want to run the module over a specified time period instead, on the Range tab, select the period over which you require data in one of these ways:
To Link to the global clock Do this Select the Start or End checkbox and then select Synchronise to global clock. The current date and time appears. Type the required period in the Period box. For example, 2 days. You can set a global data and time in the Main Clock. For more information, see Using Clocks on page 68. Specify a duration whose start or end date you know Specify a period whose start and end dates you know Click either the Start or End checkbox and choose the correct date. Enter the desired period in the period box. For example, 1 week. Select the Include time checkbox, if you wish to set the start or end time in hours and minutes. Select the Start and End checkboxes and choose the required dates. Select the Include Time checkbox, if you wish to set the start or end time in hours and minutes. You cannot synchronise to the global clock if you set a start and end date.

To modify your time period further, on the Exclude/Include tab: Select which days you want to include in the date range. Right-click the Dates of Week area and, from the menu that appears, you can Select All or Deselect All the days or choose just Weekdays or Weekends. Select the Start and End hours for the days you have included. Select the checkbox if you want to Exclude Holidays. For more information about holidays, see Excluding Particular Days from Reports on page 106.

Click OK.

Saving Combination Windows as Templates


If you want to save the settings of a module combination and reuse them, you can save them as a template. You can also set a template to be your personal default for a module combination. When you save a combination window as a template, the following are saved: Layout Font Colours Threshold Module Selection Date Range Tiling information of the graphs Graph Scroll Information

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 203

If you are the creator of a module combination and you set a template to be the default, it becomes the default template for every user viewing the module combination unless they have personal settings particular to that module combination. To save a combination window as a template: 1 2 In the Module Combination window, click the double down arrow the Template pane. In the Template pane, click Save As New Template. This picture shows an example: to expand

In the dialog box that appears, type a name and click OK to save your template.

Loading Combination Window Templates


If you have created your own combination window template, you can load it when you open a module combination. To load a combination window template: 1 In the Module Combination window which contains the module combination you want to apply the template to, click the double down arrow Template pane. 2 In the Template pane: Select the template you want to load from the Change to Load Template dropdown list. Select the Run All Modules Immediately checkbox, if you want to run the template straight away. If you just want to load the template without running the modules, leave this checkbox unselected. to expand the

Page 204

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

In the message box that appears, click Yes to confirm. The template is loaded.

Editing Combination Window Templates


If you are the creator of a template, you can edit that template and/or set it as the default template for a combination window. To edit a combination window template: 1 2 3 4 In the Module Combination window, click the double down arrow the Template pane. to expand

Make the required changes to the combination window and then click Update Settings. In the message box that appears, click OK. The template is updated with the new settings. If you want to set the template as the default template, click Set As Default Template and, in the message box that appears, click OK. The template is set as the default for the combination window.

Deleting Combination Window Templates


To delete a combination window template: 1 2 3 In the Module Combination window, click the double down arrow the Template pane. to expand

In the Template pane, select the template you want to delete from the Change to Load Template drop-down list. In the message box that appears, click Yes to confirm. The template is deleted.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 205

Finding Elements in the Modules Pane


If you want to view data for a particular network element or group of elements, you can search for it in the Modules pane of the Combination window using the following options: Find in module use this to find elements within a single module. Find across modules use this to find elements across a number of modules.

Finding Elements Within One Module


If you want to search in one module for a single network element: 1 2 3 4 In the Modules pane of the Combination window, highlight the module you want to search. Right-click the Modules pane and, from the menu that appears, click Find in Module. In the Find dialog box, type the element you want to find. Click Find Next. If the element is found, it is highlighted in the Modules pane. You can now select that element and run the module to view the data.

Finding Elements Across Modules


If you want to search across several modules for a network element: 1 2 3 4 In the Modules pane of the Combination window, highlight a module. Right-click and from the menu that appears, click Find Across Modules. In the Find Across Modules dialog box, type the element you want to find. Click Find Next. If the item is found, it is highlighted in the Modules pane. You can now select that element and run the module to view the data.

Page 206

AIRCOM OPTIMA User Reference Guide Version 6.2

Filtering Elements in the Modules Pane


In the Modules pane, you can use filters to select a sub-set of performance data based on particular network elements. For example, you might want to select data for cells 10A, 10B and 10C only if these are known to be a group of problem cells. Filters are found in the Filters pane. If the pane is hidden, click the Filters title bar to display it.

Filters pane

You can create custom filters in the Filter Explorer. For more information see Using the Filter Explorer on page 213.

Creating a Static Filter from a Selection


You can create a static filter by selecting network elements in the Modules Pane. For more information about static filters, see Creating Static Filters in the Filter Explorer on page 215. To create a static filter from a selection: 1 2 3 In the Modules pane, select the checkbox for each element that you want to add to the filter. Right-click the Modules pane and, from the menu that appears, click Create Filter From Selection. To include the parent elements for each element you have selected, click With Path. - or To include just the selected element names, click Without Path. 4 In the Custom Filter dialog box that appears, complete the filter details as required on each page. For more information, see Creating Static Filters in the Filter Explorer on page 215. When you are satisfied, click the Finish button on the final page.
Page 207

AIRCOM OPTIMA User Reference Guide Version 6.2

The filter is now available from the list of filters that appear in the Filters pane. This picture shows an example:

Creating a Static Filter From the Grid Pane


If you have run a module and data is displayed in the grid, you can create a static filter from the Grid pane . The filter will only contain the elements shown in the grid. For more information about static filters, see Creating Static Filters in the Filter Explorer on page 215. To create a static filter from the Grid pane: 1 Right-click and, from the menu that appears, click Create Filter. - or Click the Create Filter button 2 .

The Custom Filter dialog box appears. In the Custom Filter dialog box that appears, complete the filter details as required on each page. For more information, see Creating Static Filters in the Filter Explorer on page 215. When you are satisfied, click the Finish button on the final page.

Page 208

AIRCOM OPTIMA User Reference Guide Version 6.2

The filter is now available from the list of filters that appears in the Filters pane. This picture shows an example:

Applying Filters
In the Filters pane, you can apply filters in different ways using the Filters pane toolbar. This picture shows the Filters pane toolbar:

Filters Pane toolbar

This table describes the buttons on the Filters pane toolbar:


Button Description Open Filter Explorer. Apply to the Module Tree. Select in Module Tree. Apply Filter to Grid and Graph. Clear Filter Selection. Refresh Filter Explorer. Run Filter directly.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 209

To apply a filter: 1 In the Filters pane, select the filter you want to apply by selecting its checkbox. You can apply more than one filter at a time. To select another filter simply select its checkbox. When you select a filter, the word Include is displayed next to it. This means that the filter's values will be included when the filter is applied. You can exclude a filter's values by clicking Include and changing it to Exclude.

2 3 4

If you want the filter(s) to apply to all modules, ensure the Apply: all modules checkbox is selected. If you only want the filter(s) to apply to a selected module, clear the Apply: all Modules checkbox and, in the Modules pane, select the module you want to filter. Apply the selected filter(s) by using one of the three methods described in the following table:
If you want to: Apply the selected filter(s) to the module tree. Do this: Click the Select in Module Tree button .

The elements within the filter(s) are selected in the Modules pane. Only show the selected filter(s) in the module tree. Click the Apply Filter to Module Tree button Apply the selected filter(s) to the grid and graph. .

Only the elements within the filter(s) are shown in the Modules pane. Click the Apply to Grid and Graph button .

Only the elements within the filter(s) are shown in the grid.

When you apply a filter, any elements you have previously selected will be cleared.

Page 210

AIRCOM OPTIMA User Reference Guide Version 6.2

Selecting Elements Quickly


You can use the Quick Selection list to select a list of elements in the Modules pane. You can also re-use previous lists. When you apply a filter, any elements you have previously selected will be cleared. To quickly select elements: 1 In the Filters pane, in the Quick Selection drop-down, type the list of elements you want to select. The elements must be separated by commas, for example, 10A,11B,11C. You can use wildcards to represent characters in filter values. There are two wildcards you can use: Asterisk (*) - to represent zero or more characters. For example, if you type 'BSC*', you will filter all the elements that begin BSC. Question mark (?) to represent a single character. For example, if you type 'BSC?', you will filter all the four-character elements that begin BSC, such as BSC1 or BSC2.

Click one of the buttons on the Filters Pane toolbar to apply your selection. For more information, see Applying Filters on page 209.

The Quick Selection drop-down list holds the previous ten quick selection filters. To re-use one of these filters: 1 2 From the Quick Selection drop-down list, select the one you want to use. Click one of the buttons on the Filters Pane toolbar to apply your selection. For more information, see Applying Filters on page 209.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 211

Displaying Data in Graphs


In the Graphs pane, you can add and arrange graphs. If the pane is hidden, click the Graphs title bar to display it.

Graphs pane

The following table describes the options that are available in the Graphs pane:
Click this: Add Graph Align Horizontally Align Vertically Tab / Tile Graphs Undock All Graphs To: Add a new graph to the combination window. You can add as many graphs as required. Align graphs horizontally in the combination window. Align graphs vertically in the combination window. Display each graph on a separate tab. Detach graphs from the combination window and display them in their own dialog box. To dock the graphs again, click the Re-dock button Link Graphs .

Link graphs that have the same x-axis field. In the message box that appears, you can choose to link graphs by either x-axis only or by x-axis and y-axis. Once you have linked your graphs, they will zoom and scroll in unison. To unlink graphs, click Link Graphs again.

Save Graphs to HTML Bring Graphs to Front Graph Scrolling

Export graphs to an HTML file. Display detached graphs in front of other open windows. Set all the graphs to equal size. It initially aligns all the graphs horizontally and then sets the size of each graph to 1/3 of the screen size.

For detailed information about customising graphs, see Using Graphs on page 247.

Page 212

AIRCOM OPTIMA User Reference Guide Version 6.2

Using the Filter Explorer


In the Filter Explorer, you can create, edit and delete filters. You can use four types of filter in AIRCOM OPTIMA. These are described in this table:
This Type Personal Group System ENTERPRISE Can be Used By The user who creates them and OPTIMA_Administrators The user who creates them, group members, and OPTIMA_Administrators Administrators only Any user with the correct ENTERPRISE permissions And is Stored In the database In the database In the database In the ENTERPRISE database

You cannot create ENTERPRISE filters when using the standalone version of AIRCOM OPTIMA. To open the Filter Explorer, either: From the Tools menu, click Filters. - or Click the Filters button .

The Filter Explorer opens, this picture shows an example:

Filter Explorer

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 213

About the Filter Explorer Toolbar


This picture shows the Filter Explorer toolbar:
Filter Explorer toolbar

This table describes the available buttons:


Button Description Exit the Filter Explorer. Create new static filter. Create new dynamic filter. Edit filter. Delete filter. Copy filter. Paste filter. Display the element hierarchy Preview and SQL tabs. Display the filters in a more detailed list format (name, description, next scheduled date and so on). Display the filters in a simple list format (name only). Search for a filter.

Page 214

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating Static Filters in the Filter Explorer


Static filters are based on fixed filter values that you specify as part of the filter definition. To create a static filter: 1 In the Filter Explorer, either: From the File menu, point to New and click New Static Filter. - or Click the Create New Static Filter button .

The Static filter (Add) dialog box appears. This picture shows an example:

If you are creating a static filter from the grid pane of a combination window, you will also see a Field Names tab.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 215

In the Static filter (Add) dialog box, on the Filter Details tab, complete the following information:
In this field: Name Description Filter Type Do this: Type a name for the filter. Type a description for the filter. Choose the filter type you require by selecting the appropriate radio button. If you are using AIRCOM OPTIMA as part of ENTERPRISE, you can create User or System filters, whereas if you are using AIRCOM OPTIMA as a standalone product, you can create Personal, Group or Administrator filters.

3 4

Click Next. If you are creating a static filter from the grid pane of a combination window, on the Field Names tab, in the Available Fields pane, select the network level on which you want to filter. You can specify certain criteria that the elements at that network level must satisfy in order to be included in the list of available filter values. To do this: Select the Configure Filter Threshold option. Click the Filter Threshold button. In the dialog box that appears, specify the field, operator and value for the threshold. For example, you could set a threshold for the Cell level, which specifies that cells should only be included in the filter if their SDCCH_DROP_RATE value is greater than 0.4:

- or If you want to use an existing threshold, select the Use Existing Threshold option and from the drop-down list, select the required threshold. 5 Click OK.

Click Next.

Page 216

AIRCOM OPTIMA User Reference Guide Version 6.2

On the Filter Values tab, complete the following information:


In this pane: Filter Values Do this: Type the values on which you want to filter. For example, if you want to filter on cell 10A, type 'Cell10A'. You can use wildcards to represent characters in filter values. There are two wildcards you can use: Asterisk (*) - to represent zero or more characters. For example, if you type 'BSC*', you will filter all the values that begin BSC. Question mark (?) to represent a single character. For example, if you type 'BSC?', you will filter all the four-character values that begin BSC, such as BSC1 or BSC2. You cannot use wildcards with ENTERPRISE filters. Load Filter If you want to load filter values from a file, click the Browse button, browse to the filter file and click Open.

This picture shows an example:

Click Next.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 217

If you chose to save your filter as a Group or Administration filter, the Security tab appears. On the Security tab, complete the following information:
In this field: Admin Only Do this: Select this checkbox if you only want Administrators to access the filter. This option is only enabled for Administration filters. Group list Select the user group(s) that can use the filter. To add a new group: 1. Click Add. 2. In the Select Groups dialog box that appears, select the group(s) you want to have access to this filter and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List.

Click Next. This picture shows an example:

10 On the Complete Filter tab, check your filter details.

Page 218

AIRCOM OPTIMA User Reference Guide Version 6.2

11 Click Finish. The filter is now available from the list of filters that appear in the Filter Explorer:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 219

Creating Dynamic Filters in the Filter Explorer


Dynamic filters produce a list of filter values by running a data query. This type of filter is dynamic because the values returned by the data query can change. For example, you could define a dynamic query to return all cells with percentage dropped calls less than 5% in the past 24 hours which could return different filter values each time it was run. To create a dynamic filter: 1 In the Filter Explorer, either: From the File menu, point to New and click New Dynamic Filter. - or Click the Create New Dynamic Filter button .

The Dynamic filter (Add) dialog box appears. This picture shows an example:

In the Dynamic filter (Add) dialog box, on the Filter Details tab, complete the following information:
In this field: Name Description Filter Type Do this: Type a name for the filter. Type a description for the filter. Choose the filter type you require by selecting the appropriate radio button.

Page 220

AIRCOM OPTIMA User Reference Guide Version 6.2

On the SQL tab, you define the data query for the dynamic filter. To do this: Click Edit. The Data Explorer appears. In the Data Explorer, define the SQL for the data query. For more information, see Defining a Query on page 110. When you have finished, click OK, and then click Yes to save your SQL. The SQL is added to the SQL pane.

This picture shows an example:

Click Next. The query is executed and the filter results are displayed in the Filter Values pane of the Filter Values tab.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 221

This picture shows an example:

5 6

Click Next. If you chose to save your filter as a Group or Administration filter, the Security tab appears. On the Security tab, complete the following information:
In this field: Admin Only Do this: Select this checkbox if you only want Administrators to access the filter. This option is only enabled for Administration filters. Group list Select the user group(s) that can use the filter. To add a new group: 1. Click Add. 2. In the Select Groups dialog box that appears, select the group(s) you want to have access to this filter and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List.

On the Complete Filter tab, check your filter details.

Page 222

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

Click Finish. The filter is now available from the list of filters that appear in the Filter Explorer.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 223

Converting a Dynamic Filter to a Static Filter


There are two options you can use to convert dynamic filters into static filters. This table describes the two options:
Use this option: Create New Filter Replace Dynamic Filter To: Convert a dynamic filter into a static filter which you can change the name, description and/or type of. Convert a dynamic filter into a static filter with exactly the same name, description and type.

To create a new static filter from a dynamic filter: 1 2 In the Filter Explorer, select the dynamic filter you want to convert. Right-click, point to Convert to Static Filter and click Create New Filter. The dynamic filter's data query is executed and then the Custom Filter (Convert Dynamic Filter to Static Filter) dialog box appears. In the Custom Filter (Convert Dynamic Filter to Static Filter) dialog box, on the Filter Details tab, you can: 4 5 6 Type a new name and/or a description for the filter Change the filter type by selecting the appropriate radio button

Click Next. The results of the data query are displayed as fixed filter values in the Filter Values pane on the Filter Values tab. Click Next. If you chose to save your filter as a Group or Administration filter, the Security tab appears. On the Security tab, complete the following information:
In this field: Admin Only Do this: Select this checkbox if you only want Administrators to access the filter. This option is only enabled for Administration filters. Group list Select the user group(s) that can use the filter. To add a new group: 1. Click Add. 2. In the Select Groups dialog box that appears, select the group(s) you want to have access to this filter and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List.

7 8

Click Next. On the Complete Filter tab, check your filter details and then click Finish. A new static filter is created.

Page 224

AIRCOM OPTIMA User Reference Guide Version 6.2

To replace a dynamic filter with a static filter: 1 2 3 In the Filter Explorer, select the dynamic filter you want to convert. Right-click, point to Convert to Static Filter and click Replace Dynamic Filter. In the message box that appears, click Yes to confirm. The data query is executed and a new static filter is created. The results of the data query provide the fixed filter values for the new static filter.

Setting Filter Security


If you are the creator of a group filter or an OPTIMA_Administrator, you can select which groups are allowed to use the selected group filter. To do this: 1 2 3 In the Filter Explorer, select the group filter. Right-click and, from the menu that appears, click Properties. The Filter Properties dialog box appears. In the Filter Properties dialog box, on the Security tab, select the user group(s) that can use the filter. To add a new group: Click Add. In the Select Groups dialog box that appears, select the group(s) you want to have access to this filter and use the > button to move them to the Destination List. Use the Shift and Ctrl keys to select more than one group at a time and use the >> button to add all the groups to the Destination List. 4 5 Click Apply to save your changes. Click OK to close the Filter Properties dialog box and return to the Filter Explorer.

Editing Filters in the Filter Explorer


In the Filter Explorer, you can edit existing filters. To do this: 1 Double-click the filter that you want to edit. - or Right-click the filter that you want to edit, and from the menu that appears, click Edit Filter. - or Select the filter that you want to edit and click the Edit Filter button 2 .

In the Custom filter (Edit) dialog box that appears, edit the filter details as required on each page. When you are satisfied, click the Finish button on the final page.

You cannot edit ENTERPRISE filters when using the standalone version of AIRCOM OPTIMA.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 225

Renaming Filters
In the Filter Explorer, you can rename existing filters. To do this: 1 2 3 In the Filter Explorer, select the filter you want to rename. Right-click, and from the menu that appears, click Rename. Type in the new name for the filter and press Enter.

Deleting Filters
To delete a filter: 1 2 In the Filter Explorer, select the filter you want to delete. Right-click, and from the menu that appears, click Delete. - or Click the Delete Filter button 3 .

In the message box that appears, click Yes to confirm. The filter is deleted from the list of filters in the Filter Explorer.

You cannot delete ENTERPRISE filters when using the standalone version of AIRCOM OPTIMA.

Finding Filters
If you want to view a particular filter, you can search for it in the database. To find a filter: 1 From the Edit menu, click Search. - or Click the Search button 2 3 4 5 .

In the Find Filter dialog box that appears, type the name of the filter you wish to find. Click Find First and the first occurrence of the filter is highlighted. Click Find Next and the next occurrence of the filter is highlighted. To close the dialog box and return to the Filter Explorer, click Cancel.

Page 226

AIRCOM OPTIMA User Reference Guide Version 6.2

Copying Filters in the Filter Explorer


To copy a filter: 1 2 In the Filter Explorer, select the filter that you want to copy. Right-click, and from the menu that appears, click Copy Filter. - or Click the Copy Filter button 3 4 .

Select the folder into which you want to copy the filter. Right-click, and from the menu that appears, click Paste Filter. or Click the Paste Filter button .

The filter is copied to the specified folder.

Viewing Filters in the Filter Explorer


To view the different types of filter available in the Filter Explorer: In the Filter Explorer, in the left-hand pane, click the filter type you want to view. All existing filters of that type are then displayed in the right-hand pane. For example, click Group to view the Group filters.

If you only want to view your own personal filters, right-click in the left-hand pane and, from the menu that appears, click Show only current user's filters.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 227

Page 228

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 7

Customising Grids
You can show data in grid format when you run either: A performance alarm in the Alarm Explorer A module in the Module Combination window A query in the Data Explorer

For modules, a separate grid is displayed for each module in the combination window. You can switch between grids by clicking the appropriate tab above the grid. This picture shows an example:

Example Combination Window

Many of the tools used are accessed by right-clicking the grid. You can also set options to use as the default settings for all grids. For information about how to do this, see Setting Default Grid Options on page 58. When a grid contains a large number of records some of the tools, such as filtering and grouping, may slow down the speed with which data is shown in the grid. This is due to the background processing of these tools. You can prevent this slow down by disabling these tools after a given number of records are returned from a query. For more information, see Setting Grid Preferences on page 56.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 229

About the Tools for Customising a Grid


To view the tools menu, hover the mouse cursor over a grid and right-click. This table describes the menu that appears:
Menu Option Description Expands to fix a number of columns.

Prints the grid. Exports a grid. Expands for you to format the grid. Run linked modules. Counts how many entries there are in a record. Shows the details for a selected row in a grid. Enables you to scroll horizontally to a specific column. Enables server-side sorting. Displays the SQL used to generate the grid. Opens the Add Filter window. Enables you to customise summaries of data in the grid. Enables/disables advanced grid options. Expands for you to show/hide the Toolbar and Search bar.

You can show the toolbar above the grid by pointing to Toolbars and from the menu that appears select Toolbar. The toolbar duplicates the options in the popup menu:
Grid toolbar Description Fix N columns Print grid Export grid to Excel Record count View grid details Grid column settings Apply best column fit Refresh grid data Create filter Enable advanced grid options

Page 230

AIRCOM OPTIMA User Reference Guide Version 6.2

Load all columns Apply order to graphs

Customising Columns in a Grid


You can customise the way each grid displays data using the tools described in the following sections. If you have defined a maximum number of columns to display when you run a query (for more information, see Setting Grid Preferences on page 56), then all the columns may not appear in the grid. If you want to display all the columns before you begin to customise them, click the Load All Columns button .

Sorting Data Within Grid Columns


To see by which column data in the grid is sorted, look for the arrow in the column heading. An up arrow indicates data is in ascending order and a down arrow indicates data is in descending order:

Grid columns

To sort the data using the column headings: Click the heading for the column by which you wish to sort the data. If you want to sort by more than one column, hold down the Shift key and click the heading for each column by which you want to sort the data. The table refreshes to show information sorted in ascending or descending order by the column you clicked. To clear a sort on a column: Hold down the Ctrl key and click the heading for the column from which you want to remove the sort.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 231

Sorting Data Before Running a Module


Before you run a module, you can sort data on the server. This is particularly useful if you know the query will return a large amount of data. The sorting function is much quicker when run on the server. To sort data on the server: 1 2 3 Highlight the module in the Modules pane. Right-click the grid and, from the menu that appears, click Server-side Sorting. In the Sort Order dialog box that appears, highlight the column by which you want to sort the data and click the right arrow button. Repeat this step for all the columns you want to sort by:

You can move all the selected columns back to the list on the left by clicking the double left arrow button. 4 5 6 7 Sort the columns in the right-hand pane by using the Up and Down buttons. Use the ASC or DESC button to switch between ascending and descending sort orders for each column. Click OK to return to the grid. You can now run the module. To do this, in the Modules pane: Click the Run Highlighted Module button .

Page 232

AIRCOM OPTIMA User Reference Guide Version 6.2

Fixing Grid Columns


In AIRCOM OPTIMA, for windows that contain a grid showing data, you can choose to fix any number of columns in that grid. This means that they remain displayed while the other columns of data will still scroll. For example, in a window showing Cell Statistics, you might want to have the Cell Identification and Site name columns fixed so that they are always shown when you are scrolling through the data. This makes it easy to see which information belongs to which cell. To fix columns: Right-click the grid, point to Fix columns and choose the number of columns you wish to fix. - or Click the Fix N Columns button and in the Fix Columns dialog box that appears, type the number of columns and click OK.

Scrolling to a Grid Column


A data grid can contain an infinite number of columns, depending on the information defined in the database query. To assist you in locating a column more easily, you can quickly scroll to a grid column. To do this: 1 2 3 Ensure the Row Highlight option is not selected. For more information, see Viewing Details of a Single Network Element in a Grid on page 243. Right-click the grid and, from the menu that appears, select Scroll to Column. In the Scroll to column dialog box, from the drop-down list that appears, select the column to which you want to scroll:

Click OK. The data grid automatically moves to the column that you have selected.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 233

Changing the Grid Column Settings


AIRCOM OPTIMA enables you to change the column settings. You can set the position, size and width of columns and also hide columns. You can also change how text appears in the columns. To change the column settings: 1 Right-click the grid, and from the menu that appears, point to Format Options and then click Column Settings. - or Click the Column Settings button .

The Column Settings dialog box appears:

In this dialog box, set up your columns as required:


To: Move a column up or down Move a column to the beginning or end Change the width of the column Do this: Select the column from the list and click the Move Up and Move Down buttons as appropriate. Select the column from the list and click the Move to First and Move to Last buttons as appropriate Double-click on the column you want to modify and, in the Column dialog box, type the width you want the column to be. or Select the column to which you want to make changes and click the Edit button. In the Column dialog box, type the width you want the column to be. or Click in the Width column next to the column to which you want to make changes and type in the width you want the column to be. Hide or show a hidden column Select the checkbox in the Show column for each column to want to display. You can Show All, or Hide All, by clicking the Show All or Hide All buttons.

You can also use shortcuts to quickly edit columns. For more information, see Shortcuts for Changing Column Settings on page 235.
Page 234 AIRCOM OPTIMA User Reference Guide Version 6.2

You can change how the text appears in all the columns in your grid by changing the column fonts. If you have also set threshold and conditional fonts, these will overwrite the column font. To change the column font: 1 2 3 Right-click the grid and, from the menu that appears, point to Format Options and then click select Font. In the Font dialog box that appears, select how you want the text to appear. You can set the font, font style, font size and so on. Click OK to close the Font dialog box and save the changes.

Shortcuts for Changing Column Settings


You can also change the column settings in the grid using the following shortcuts:
To: Change the position of a column Change the width of the column Automatically size the column so you can read all the column text Do this: Select the column and drag it to the desired location in the table. Place the cursor between the column titles (above the column divider) then click and drag the cursor to the required width. Place the cursor between the column titles (above the column divider) then double-click between the columns. The column to the left will automatically resize.

Setting Thresholds and Conditional Fonts


You can use conditional fonts to highlight certain data values, for example, if you want to show congestion greater than 1% in blue, and greater than 2 % in red. You can do this as part of the process of setting thresholds. Conditional fonts will override counter thresholds that have been set via the Thresholds window. For example, if the conditional font has been set on a column containing Erlang data, the data will be displayed using the conditional fonts rather than the global Erlang threshold colours. To set thresholds: 1 Right-click the grid and, from the menu that appears, point to Format Options and then click Column Settings. - or Click the Column Settings button 2 .

In the Column Settings dialog box, double-click one of the Threshold columns.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 235

The Column dialog box appears:

3 4 5 6

Select one of the numbered checkboxes to enable that threshold. Type a value for the threshold and select a logical operator (=, <>, >, >=, <, <=) from the drop-down menu. Click the font type. button to set the conditional fonts. You can set the colour, size and

Click OK to close the Font dialog box and then click OK to close the Column dialog box. You can set up to three thresholds for each column.

Click OK to close the Column Settings dialog box.

Page 236

AIRCOM OPTIMA User Reference Guide Version 6.2

Data that falls between the thresholds defined for the column can then be viewed in the grid:

Refreshing Data
The Refresh data option is used to update data in the grid to show the most recent query run. To refresh data: Right-click the grid and, from the menu that appears, select Refresh Data. - or Click the Refresh Data button .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 237

Searching for Data in Grids


You can search for data in a grid using the Search toolbar. To do this: 1 Make sure the toolbar is displayed by selecting Search bar from the Toolbars menu:

2 3

In the Search On box, from the menu select the item that you want to find. In the For box, type a value or element name as required.

Select the checkboxes if you want to find a Partial Match and/or you want your search to be Case Insensitive. If you search for a partial match of CELL and 301, the search would return all cells containing the number 301. That is 30100, 30101, 40301 and so on.

Click Find to start the search. The grid scrolls and the line that contains the nearest match to your search is indicated with an arrow:

Filtering Data in Grids


You can filter the data in one or more columns of the grid. This makes it easier to view specific information. For example, the grid could display data for a number of days, but you may want to quickly view the data for just one of those days. If a column has a filter applied to it, the filter arrow is shown in blue. Using filters, you can define the data in the grid in the following ways: Display data for a single value from one or more columns, for example BSC1 Display data which is filtered by rules applied to one column, for example where the Erlang is less than 5 or greater than 10 Display data which is filtered by rules applied to more than one column, for example where the Erlang is less than 5 or greater than 10 and the BSC is equal to BSC1

Page 238

AIRCOM OPTIMA User Reference Guide Version 6.2

Selecting a Single Value to Filter the Grid


You can select a single value from any column in the grid and only view the data which applies to that value. To select a value: Click the arrow on the heading of the column you want to filter and, from the menu that appears, click the value. Repeat this for each column that you wish to filter.

To remove a filter: Click the blue arrow on the heading of the column from which you want to remove the filter and then click All. You can limit the number of values that are listed by editing your user preferences. For more information, see Setting Grid Preferences on page 56.

Filtering One Column of the Grid


You can create a filter which applies to only one column of the grid but uses rules to return more than one value in that column. To create a filter: 1 Click the arrow on the heading of the column you want to filter and, from the menu that appears, click Custom.

The Custom Filter dialog box appears. 2 3 4 Select a rule and type a value for your filter. If the value is a date, click the arrow in the value box and a calendar appears from which you can select a date. If you want to define a second rule, you must select a logical operator for your filter. Click OK. The grid refreshes to show only the filtered data, the filtered column's arrow changes to blue and a summary of the filter appears below the grid. 5 Repeat steps 1-4 for each column that you wish to filter.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 239

To remove a filter: Click the blue arrow on the heading of the column from which you want to remove the filter and then click All. - or Click X in the filter summary.

Filtering More Than One Column In The Grid


You can create a filter which applies to more than one column of the grid and uses rules to return more than one value for each column. This is done in the Filter Builder. To open the Filter Builder: Click Customize, to the right of the filter summary, below the grid.

To create a filter in the Filter Builder: 1 2 Click Filter and select Add Condition. In the condition row that appears, the first column from the grid is automatically displayed. To change this, click the column name and from the list of columns that appear select the appropriate one.

3 4 5 6

To select an operator, click on the default operator and from the list that appears select the appropriate operator. To select a value, click Empty and type a value. If the value is a date, click the arrow in the value box and a calendar appears from which you can select a date. Repeat steps 1-4 until you have defined your filter. Click Apply to view the grid with the filter applied.

Page 240

AIRCOM OPTIMA User Reference Guide Version 6.2

Click OK to save the filter and close the Filter Builder. Click the blue arrow on the heading of the column from which you want to remove the filter and then click All. - or Click X in the filter summary.

To remove a filter:

Summarising Data
AIRCOM OPTIMA enables you to summarise the data contained in the grid. You choose at least one column by which you wish to group the data, for example, you could choose to group by CELL. The data in the column you choose to group by cannot be summarised. You can then summarise each column by one summary type, that is either count, average, minimum, maximum or total. For example:

Summaries Example

To create a summary of data in one or more columns: 1 Right-click and, from the menu that appears, click Customise Summaries. - or Click the Customise Summaries button 2 .

In the Quick Aggregation dialog box that appears, select the summary type you require from the Global Aggregate drop-down list.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 241

If you want to apply the summary type to all columns, click the Apply Aggregate to All Fields button - or If you want to apply the summary type to one or more columns, select the column(s) in the Field Name list and click the Apply Aggregate to Selected Fields button . .

Use the Shift and Ctrl keys to highlight more than one column at a time. This picture shows an example:

To clear all summaries, click the Clear All Aggregates button 4 1 To view summarised data:

Click OK to save your changes and close the Quick Aggregation dialog box. Ensure you have created a summary for each column you want to summarise then decide by which column you want to group the data, this column must not have a summary created for it. Click the heading of the column by which you want to group the data and drag the heading into the grey area above the grid.

The grid displays the summaries. 3 Repeat steps 1-2 for each column by which you want to group the data. Click the heading in the grey area above the grid and drag it back onto the grid. To remove the summaries:

Page 242

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing Details of a Single Network Element in a Grid


If your grid has many columns, you might want to highlight a row or view all the details for a single network element. In AIRCOM OPTIMA, you can do this is two ways: Highlighting a Row in a Grid You can analyse the data contained within a row more easily by using the Row Highlight option. This marks any selected row with a blue background, and colours the text accordingly. This picture shows an example:

Row Highlighting

To turn this option on (and off): 1 2 Right-click in the grid. From the menu that appears, point to Format Options and then click Row Highlight.

Viewing Details in a Grid To view details for a single network element: 1 2 Select a cell in the row for the element you wish to view. Right-click and, from the menu that appears, select View Details. - or Click the View Details button 3 .

A Grid Details window appears, detailing information on your chosen element.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 243

This picture shows an example:

In the Grid Details window, you can manipulate your data in the following ways:
To Move the position of data Sort the details by Field name or Data Delete a piece of data Do This Click the data you wish to move and drag it to the required position. Click on the Field name or Data header box to sort the details. Click again to view the details in descending order. Right-click the data and from the menu that appears, click Delete. Deleting data in this way removes it from the Grid Dialog Box only; it still remains in the Cell Statistics window. Print the data In the Grid Details window, right-click and, from the menu that appears, select Print or Print Preview. This will only print data for this network element. Freeze the data in the Grid Details window Right-click the data, and from the menu that appears, click Detach. If you then choose to view the details for another element in the grid, AIRCOM OPTIMA opens a new Grid Details window appears, rather than refreshing the existing one.

Printing Grids
From the combination window, you can print: A single network element. To do this, you first need to view the details for that single element, for more information on this, see Viewing Details of a Single Network Element in a Grid on page 243. The entire grid. Right-click the grid, and from the menu that appears, click Print. - or Click the Print button 2
Page 244

To print an entire grid:

In the Print dialog box, choose your options then click OK.
AIRCOM OPTIMA User Reference Guide Version 6.2

Exporting Grids
You can export grids to: 1 A CSV or HTML file The Clipboard, from where you can paste the grid into other applications A Microsoft Excelspreadsheet Right-click the grid, point to Export and choose one of the following: Clipboard File as CSV File as HTML Excel

To export a grid:

- or If you just want to export to Excel, click the Export to Excel button 2 If you export to the clipboard, open an application and paste the grid. or If you export to Excel, an Excel spreadsheet displaying the data opens. or If you select .CSV or .HTML, select the required location, type a filename then click Save. If the required folder does not exist, click the Create New Folder button . .

When you export a grid to a version of Excel earlier than 2007, there is a limitation that each worksheet of the Excel spreadsheet can contain only 65,000 rows. Hence, if there are more than 65,000 rows to be exported, the following message will appear:

Click Yes to continue. The data will be divided across various worksheets within a single Excel spreadsheet.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 245

Counting Records in Grids


You can count the total number of cells shown in the grid, even for a particular filter displayed. To count the records shown: Right-click the grid and, from the menu that appears, click Record Count. - or Click the Record Count button .

A dialog box appears, displaying the number of records:

Viewing SQL in AIRCOM OPTIMA Grids


You can view the SQL query used in the module that calls the data shown in the grid. You might want to do this to check you are querying the correct tables, or you may wish to copy the SQL to use it elsewhere. To view the SQL: Right-click the grid and, from the menu that appears, select Show SQL. A window appears, showing the SQL. This picture shows an example:

You can copy the SQL in this window by selecting it, and pressing Ctrl+C.

Page 246

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 8

Using Graphs
When you run a module in the Module Combination window, the data is shown in grid and graph format. This chapter describes the tools you can use to customise the graph. Many of the tools used are accessed by right-clicking the graph.

About the Options for Customising a Graph


To view the Tools menu, hover the cursor over a graph and right-click. This picture shows the menu that appears:

Graph tools menu

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 247

By selecting Tool Bar, you can display the navigating, appearance, function, printing, and exporting options from the menu as a toolbar. This picture shows the sections of the toolbar:

Graph toolbar

Changing the Appearance of Graphs


You can set up the properties of graphs using the Graph Options dialog box. Once this is set up for one graph, it is used as the default for all other graphs. To open the Graph Options dialog box: Right-click the graph and from the menu that appears, click Properties. You can edit the graph options on a number of tabs: General Axis Series Functions Threshold Lines Advanced Options Chart Themes

Using the General Tab in the Graph Options Dialog Box


On the General tab of the Graph Options dialog box you can: Choose to show or hide the legend key and amend the alignment Select auto marks Edit the background, weekend and holiday colours

This picture shows the General tab:

General tab of the Graph Options dialog box

Page 248

AIRCOM OPTIMA User Reference Guide Version 6.2

Showing and Hiding the Legend Key You can select to show or hide the legend key in the Graph Options dialog box. To do this: 1 2 3 4 Right-click the graph and from the menu that appears, click Properties. On the General tab, select the Show Legend checkbox. To amend the alignment of the legend key, in the Legend Alignment pane, click the required option such as Left, Right, Top or Bottom. Click Apply to view the changes and then click OK to save the changes.

Setting the Auto Marks You can set the mouse so that when it is hovered over a series, the information about that point in the series is automatically: 1 2 3 Displayed in the graph Highlighted in the grid Right-click a graph and from the menu that appears, click Properties. On the General tab, select the Auto marks checkbox. Click Apply to view the changes and then click OK to save the changes. Now when you hover over a point on a graph, the information is automatically displayed, as shown here:

This is known as auto marks. To set the auto marks:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 249

Setting the Colours You can set different colours for the weekends and holidays shown on the graph as well as setting the background colour for the entire graph area. To set a colour: 1 2 3 4 Right-click a graph and from the menu that appears, click Properties. On the General tab, click the Change button next to the holiday, weekend or background colour. In the Colour dialog box that appears, click on the colour you want to use and click OK. In the Graph Options dialog box, click Apply to view the changes and then click OK to save the changes.

Changing the Appearance of Graph Axis


On the Axis tab of the Graph Options dialog box, you can: Add grid lines to your graph Change the values of each axis Hide the x-axis border Amend the date format Change the angle of the labels on each axis Change the position of the x-axis border

This picture shows the Axis tab:

Axis tab of the Graph Options dialog box

Page 250

AIRCOM OPTIMA User Reference Guide Version 6.2

Adding Grid Lines To add grid lines to the graph: 1 2 3 Right-click the graph then, from the menu that appears, click Properties. Select the Axis tab and click the Grid Lines checkbox for the relevant axis, either left, bottom or right. Click Apply to view the changes and then click OK to save the changes.

To remove grid lines, repeat the process. Changing the Values of an Axis You may want to change the values of an axis because you wish to view the values as a percentage, or because values for one or two selected counters shown on different axes may be too small to display. To change the values of an axis in a graph: 1 2 3 Right-click the graph then, from the menu that appears, click Properties. On the Axis tab, under the axis you want to change, clear the Automatic checkbox and insert the required minimum and maximum values. Click Apply to view the changes and then click OK to save the changes.

Hiding the Border If you want to hide the x-axis border of a graph: 1 2 3 Right-click the graph and from the menu that appears, click Properties. On the Axis tab, in the Bottom pane, select the Hide Border checkbox. Click Apply to view the changes and then click OK to save the changes.

Changing the Date Format If you want to change the format of any dates that are shown on the graph axis: 1 2 3 Right-click the graph and from the menu that appears, click Properties. On the Axis tab, in the Bottom pane, select the required Date Format from the list. Click Apply to view the changes and then click OK to save the changes.

Changing the Angle of the Labels You can change the angle of the labels on the bottom axis to enable more labels to be viewed. To do this: 1 2 3 Right-click the graph and from the menu that appears, click Properties. On the Axis tab, in the Bottom pane, use the up and down arrows on the Angle box to select the angle in degrees. Click Apply to view the changes and then click OK to save the changes.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 251

Changing the Position of the Border If you want to change the position of the x-axis border: 1 2 3 Right-click the graph and from the menu that appears, click Properties. On the Axis tab, in the Bottom pane, use the up and down arrows on the Position box to select a percentage between -100% and 100%. Click Apply to view the changes and then click OK to save the changes.

Changing Graph Line Thickness or Bar Chart Type


On the Series tab of the Graph Options dialog box, you can alter the appearance of the series data when displayed as a line on a line graph or as a bar on a bar chart. This picture shows the Series tab:

Series tab of the Graph Options dialog box

If your graph is a line graph, you can adjust the thickness of the lines displayed. To do this: 1 2 3 Right-click the graph and from the menu that appears, click Properties. On the Series tab, in the Line Series Thickness pane, select the required line thickness Thin, Medium or Thick. Click Apply to view the changes and then click OK to save the changes.

If your graph is a bar graph, you can adjust the thickness of the bars displayed. To do this: 1 2 3 4 Right-click the graph and from the menu that appears, click Properties. On the Series tab, in the Bar Series Options pane, choose how you want the bars to appear None, Side, Stacked, Stacked 100%. If your bar graph has DATETIME on the X-axis, you can specify the thickness of the bars by typing a number between 0 and 100 in the Bar Width field. Click Apply to view the changes and then click OK to save the changes.

Page 252

AIRCOM OPTIMA User Reference Guide Version 6.2

Using the Functions Tab in the Graph Options Dialog Box


On the Functions tab of the Graph Options dialog box, you can set a gap period. The gap period is normally set at twice the data capture period, for example, if the data is captured at hourly intervals, then the gap period would be set at two hours. This picture shows the Functions tab:

Functions tab in the Graph Options dialog box

To set the gap period: 1 2 3 4 Right-click the graph and from the menu that appears, click Properties. On the Functions tab, in the Gap period pane, use the up and down arrows to set the number and from the drop-down list select the time period. In the Moving Average Function pane, set the number of value used in the moving average function. Click Apply to view the changes and then click OK to save the changes.

Displaying Thresholds on Graphs


On the Threshold Lines tab of the Graph Options dialog box, you can set thresholds and then display a threshold line in the graph. This does not affect the threshold display options in the Grid. This picture shows the Threshold Lines tab:

Threshold Lines tab of the Graph Options dialog box

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 253

To set the threshold: 1 2 3 4 5 6 7 Right-click the graph and from the menu that appears, click Properties. On the Threshold Lines tab, click Add. Type a name for the threshold, for example GSM_Standard. Insert a value. Select the Axis and choose a colour. Click OK. In the Graph Display Options dialog box, click OK to save the changes.

To edit or delete a threshold, highlight the threshold and click Edit and make your changes or click Delete. To display threshold lines: Right-click the graph and from the menu that appears, click Show Threshold Lines. The threshold lines for this graph are displayed.

Using Advanced Options


On the Advanced Options tab of the Graph Options dialog box you can set a wide range of graph options. This picture shows the Advanced Options tab:

Advanced Options tab of the Graph Options dialog box

Page 254

AIRCOM OPTIMA User Reference Guide Version 6.2

The Advanced Options tab has two sub-tabs which are described in the following table:
On this sub-tab: Chart You can: Perform or set many of the options for graphs, for example: Export Print Preview Zoom Scroll Axis Titles Legend

Set the options for exporting graphs.

Using Chart Themes


On the Chart Themes tab of the Graph Options dialog box, you can apply pre-defined themes, such as Windows XP, to your graphs. This picture shows the Chart Themes tab:

Chart Themes tab of the Graph Options dialog box

To apply a theme to a graph: 1 2 3 4 Right-click the graph and, from the menu that appears, click Properties. On the Chart Themes tab, select a theme from the list in the left-hand pane. Click Apply to apply the theme to your graph. Click OK to save your changes and return to the combination window.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 255

About the Navigating Tools


You can use the following tools to navigate around the graphs: Zoom Rotate Cursor

Zooming and Scrolling on Graphs


You can point to an area on the graph and manually zoom in or zoom out. To do this: 1 2 Click the Arrow & Manual Zoom button on the toolbar.

Click and hold the left mouse button on the graph and drag the cursor to select an area: dragging to the right zooms in the graph, dragging to the left zooms out, and so on. Release the left mouse button to achieve the desired effect.

You also have options to zoom in or zoom out by only 10%. To do this: To zoom in on a graph: On the graph, right-click and from the menu that appears, click Zoom In. - or Click the Zoom In button To zoom out on a graph: On the graph, right-click and from the menu that appears, click Zoom Out. - or Click the Zoom Out button 1 . .

You can also scroll to a particular point on the graph. To do this: On the graph, right-click and from the menu that appears, point to Mouse Options and click Drag Mode. - or Click the Drag Mode button 2 on the toolbar.

Click and hold the left mouse button on the graph and drag the cursor in the required direction: dragging to the right scrolls the graph right, dragging to the left scrolls the graph left, and so on.

To turn scrolling off, click the Drag Mode button again.

Page 256

AIRCOM OPTIMA User Reference Guide Version 6.2

Rotating a Graph
You can rotate graphs using the rotating tool. To do this: 1 On the graph, right-click and then from the menu that appears, point to Mouse Options and click Rotate. - or Click the Rotate button 2 on the toolbar.

Click and hold the left mouse button on the graph and drag the cursor in the required direction.

To turn the rotating tool off, click any one of the following buttons on the toolbar: Arrow & Manual Zoom button Cursor button Drag button

Viewing Values Using the Cursor Key


Use the cursor key to view values between points. To select the cursor: 1 On the graph, right-click and from the menu that appears, point to Mouse Options and click Cursor. - or Click the Cursor button 2 on the toolbar.

Hover with the mouse over the graph and drag the cursor in the required direction, the values are highlighted on the graph.

To turn the cursor tool off, click any one of the following buttons on the toolbar: Arrow & Manual Zoom button Rotate button The Rotate button Drag button is active only if the graph is in the 3D view. .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 257

About the Appearance Tools


You can use the following tools to change the appearance of the graphs: View 3D Show Gaps Show Points Show Weekends and Holidays

Viewing the Graph in 3D


You can view graphs in 2D or in 3D. To view a graph in 3D: On the graph, right-click and from the menu that appears, click View 3D. - or Click the View 3D button This picture shows a graph in 2D: on the toolbar.

To revert to a 2D graph, click the View 3D button.

2D graph

Page 258

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows the same graph in 3D:

3D graph

Viewing Gaps in the Data


You can view gaps, or missing data values, in the data shown in a graph. The gap period is set on the Functions tab in the Graph Options dialog box. For more information, see Using the Functions Tab in the Graph Options Dialog Box on page 253. To view the gaps in the data: 1 2 Ensure you have set the required gap period. On the graph, right-click and from the menu that appears, point to Extra Info and click Show Gaps. - or Click the Show Gaps button on the toolbar.

The gaps will display on the graph. To view the gaps in more detail, use the zooming tool. To remove gaps from the graph, click the Show Gaps button.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 259

Displaying Data per Point on a Graph


You may wish to study data related to a specific point on a graph. To do this: 1 Right-click a graph and from the menu that appears, point to Extra Info and click Show Points. - or Click the Show Points button on the toolbar.

The data points are marked on the graph:

Click the specific point on the graph. The Counter value and the date appear. The grid also scrolls to this value, enabling you to see the relevant data in tabular form. You can also view the information on the graph automatically with the mouse hovered over the points. This is called auto marks. For more information, see Using the General Tab in the Graph Options Dialog Box on page 248.

To remove the points from the graph, click the Show Points button.

Page 260

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing Weekends and Holidays


You may wish to view or analyse points that occur at the weekend or on holidays. You can change the colour of these points so that they stand out from other points. This is done in the Graph Options dialog box. For more information, see Using the General Tab in the Graph Options Dialog Box on page 248. To view weekend or holiday points: On the graph, right-click and from the menu that appears, point to Extra Info and click either Show Weekends or Show Holidays. - or Click the Show Weekend button or Show Holiday button on the toolbar.

To remove the points from the graph, click the Show Weekend or Show Holiday buttons.

Changing the X-Axis Field


To change the x-axis field of a graph: 1 2 3 Right-click the graph and, from the menu that appears, click Change X-Axis Field. In the message box that appears, click Yes to confirm. In the Select Field dialog box that appears, in the left-hand pane, select the module with the field that you want to be the x-axis. This picture shows an example:

Select either Date Type or Non-Date type from the View drop-down list, depending on which data type you require.
Page 261

AIRCOM OPTIMA User Reference Guide Version 6.2

In the right-hand pane, double-click the field you want to be the x-axis field. All x-axis fields must have matching data types.

When you have finished, click OK to save your changes and return to the combination window.

Ordering Graph Data


You may wish to order values in a graph in ascending or descending order. You can only do this if the current x-axis field is non-date type. Each new series you add to the graph will have the same order applied. To order graph data: 1 2 Click the Apply Order to Graph button .

In the grid, click the column heading that you want to use to sort the data in the graph. The graph refreshes to show the data sorted in ascending or descending order. This picture shows an example of a graph with its y-axis data sorted in ascending order:

Repeat step 2, if you want to order graph data by a different column heading. again.

To stop ordering graph data, click the Apply Order to Graph button

Page 262

AIRCOM OPTIMA User Reference Guide Version 6.2

Selecting and Extending Trends on a Graph


To select a trend: 1 2 3 From the Series list, select the Counters or the Elements tab. On the selected tab, select a node. Right-click and from the menu that appears, point to Series Properties and click All Series Options. This picture shows an example:

4 5

In the dialog box that appears, click the Functions column corresponding to the selected node. Select the Trend Function Type. Click the Colour column to select the colour of the trend in the graph. This picture shows an example of selecting a trend for a node:

Click OK.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 263

To extend a trend: 1 2 Select a trend. On the graph, right-click and from the menu that appears, click Show Extents. - or Select the Show Extents button 3 from the toolbar.

In the Time Period dialog box that appears, use the up and down arrows and the drop-down list to select how far you would like to extend the trends. This picture shows an example:

Click OK to view the extended trend.

Viewing Details in a Graph


To view details for a series point on a graph: 1 2 Select the point on the graph you wish to view details about. Right-click and, from the menu that appears, click View Details. - or Click the View Details button This picture shows an example: .

A Grid Details window appears, detailing information on your chosen point.

In the Grid Details window, you can sort your data by clicking on the Field name or Data header box.

Page 264

AIRCOM OPTIMA User Reference Guide Version 6.2

Printing Graphs
From the combination window, you can print a graph. To do this: 1 Right-click the graph and from the menu that appears, click Print Preview. - or Click the Print Preview button from the toolbar.

The Print Preview dialog box appears:

In the Print Preview window, configure the following items so your graph prints as required:
Set the: Printer Paper Orientation Margins By Doing This: Selecting a printer from the list. You can set the printer properties by clicking the Setup button. Selecting either Portrait or Landscape. Using the up and down arrows next to each margin value. - or Selecting the View Margins checkbox and dragging the margins to the desired position on the preview of the graph. Detail Level Dragging the Detail arrow to either More or Normal.

Click the Print button.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 265

Exporting Graphs
From the combination window, you can export a graph: 1 To the Clipboard To a File Via email Right-click the graph and from the menu that appears, click Export. - or Click the Export button 2 .

To export a graph:

In the Export dialog box that appears, select the format type for exporting the graph.

3 4

If you want to save the graph to the Clipboard, click Clipboard. The graph is saved to the clipboard. If you want to export the graph to a File, click File and in the Save as window that appears, browse to the appropriate folder and save your graph. If the required folder does not exist, click the Create New Folder button .

If you want to export the graph via email, click Email and in the Choose profile dialog box, ensure the profile is correct and click OK. The graph is added to a blank email as an attachment. When you have completed your export, in the Export dialog box, click Close.

Saving Graphs as Pictures


From the combination window, you can save a graph as a picture. To do this: 1 2 Click the Save Graph as Picture button on the toolbar.

In the Save As dialog box that appears, browse to the appropriate folder, type a name, and click Save. If the required folder does not exist, click the Create New Folder button The graph is saved as a JPEG file. .

Page 266

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Series List


The series list is shown to the left of the graph pane, and displays the counters and elements available for selection within the graph. Select counters and elements to display their corresponding series values on the graph. The following picture shows the series list.

You can show and hide the series list. To show or hide the list: Right-click the graph, from the menu that appears click Visible Tree. To view the series list tool menu: Right-click the series list. Use the Selections Options to select all the data in the series list and the Unselect all option to deselect the data. From the series list you can: Order data in the series list Move series along the z axis when viewing a graph in 3D Change the colours used on the graph Change the axis where data appears Change the graph type between bar, line and point graphs Access extra functions if the graph is a line graph

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 267

Ordering the List of Data for a Graph


You may wish to order performance data in the list to the left of the graph. AIRCOM OPTIMA enables you to sort this data alphabetically. This is useful for displaying related data together when multiple elements have been selected for viewing. To order the list of data that you can display on a graph: 1 2 Right-click the series list. From the menu that appears, click Sort.

About the 3D Options in the Series List Menu


The 3D options are only available when a graph is in 3D mode. You can use the 3D options to move series in a graph on the z axis forward one, back one or right to the beginning of the axis or to the end of the axis. To do this: 1 2 Right-click the series list. From the menu that appears select 3D Options and then select the option you require.

Changing the Colours of the Graph Lines


To change the colour of a graph line: 1 2 3 4 5 In the series list pane, select the node for which you want to change the colour and right-click. From the menu that appears, point to Series Properties and click All Series Options. In the dialog box that appears, click the Colour column corresponding to the selected node. Choose a colour from the colour palette. Click OK to close the dialog box. This applies the colour to the graph.

Page 268

AIRCOM OPTIMA User Reference Guide Version 6.2

You can also change the colour of a series in the following way: 1 2 3 4 Select a series on the graph. Right-click and click Change Series Colour. In the dialog box that appears, select a colour for the series. Click OK. The series has the selected colour in the graph. This picture shows an example:

Changing the Type of Graph


You may wish to display data on different types of graph. You can use this function to switch between area, bar, line and point graphs. To do this: Right-click the series list and, from the menu that appears, point to Change Graph Type and click either Area, Bar, Line or Point.

The graph data is then displayed in the new graph type.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 269

If you do this at the module level, you can change the graph type for all items in the series list.

Changing the Axis Where Data Appears


If you are comparing two graphs, it is sometimes easier to gain an accurate picture or comparison when the graphs you are viewing have the same axis. An example of this might be if you have a view set up that combines a cell history and cell statistics module. However, you may not want all the data displayed using the same axis. For example, values for one of two selected counters may be too small to display. In this case, you can select one of the counters and change the axis. To do this: In the series list pane, click the Graph Axis button The counters are displayed on the right axis. next to the required counter.

To change the axis back repeat the process and the counter will display on the left axis.

Using the Series List Functions in Line Graphs


If the graph is a line graph, you can access extra functions such as low, high, trend, and average, for the graph. To use a function: 1 2 3 4 In the series list pane, select a node and right-click. From the menu that appears, point to Series Properties and click All Series Options. In the dialog box that appears, click the Functions column corresponding to the selected node. From the list of functions that appears, select the one you want to use:

Page 270

AIRCOM OPTIMA User Reference Guide Version 6.2

This table describes the functions:


Function Trend Low High Average Moving Average Exponential Average Description Constructs a line based on the trend of the series values; it draws the best straight line trend through the data. Shows the lowest point of all the series values. Shows the highest point of all the series values. Gives you the average for a series across the whole chart. Performs a simple or weighted average of last period series values enabling you to track the current average as your data charts. Creates an exponential average based on the series values. The exponential average is similar to a moving average. It has a weight factor to add importance to more recent data. Standard Deviation Curve Fitting Cumulative Count RSI Shows the standard deviation from the mean of data from the input series. Performs a polynomical Gaussian calculation on the underlying series data to draw a smooth curve over the original points. Constructs a line based on the cumulative values of the input. It sums the series values starting from the first point. Draws a horizontal line at Y position that is defined by the number of values in underlying series. Calculates a percent value based on financial data.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 271

Page 272

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 9

Using Work Areas


An AIRCOM OPTIMA work area can contain two types of page: Web browser pages, which enable you to display web pages Combination pages, which enable you to display module combinations Save all the items you regularly use then open this one work area rather than opening each item every time you want to view it. All the settings for the work area are saved on a per user basis to a local .INI file. You can save a work area as a favourite. This gives you quick, easy access to that work area from the Favourites toolbar. For more information, see Adding and Editing Favourites on page 194. Set up refresh times so, after a specified interval, queries will be executed again. Set switching intervals so that you can automatically switch between combinations and web browsers. From the Inspector menu, select New Work Area. - or Click the New Work Area button .

By using a work area, you can:

To open the Work Area dialog box:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 273

About the Work Area Toolbar


This picture shows the work area toolbar:
Work Area toolbar

You can use the options available from the toolbar to customise your work area.
Button Description Enable refresh. Enable switching. Import work area. Export work area. Open work area. Save work area. Set tab options. Add web page. Remove web page. Edit web page. Add combination. Remove combination. Delete work area.

For more options when you have a work area open, right-click the work area and, from the menu that appears, select the appropriate action.

Creating a New Work Area


A work area consists of two types of page: Web browser pages, which enable you to display web pages Combination pages, which enable you to display module combinations

You can have as many pages in a single work area as you require. To create a new work area: 1 2 3 Open the Work Area dialog box. Add any combinations you want to save with this work area. For more information, see Adding and Removing Combinations on page 275. Add any web browser pages you want to save with this work area. For more information, see Adding and Removing Web Browsers on page 277.
AIRCOM OPTIMA User Reference Guide Version 6.2

Page 274

4 5 6

Add the switching and refreshing data intervals. For more information, see Refreshing Data and Switching Tabs on page 278. On the work area toolbar, click the Save button to save your changes.

Select a folder and type a filename for the work area then click OK. If the required folder does not exist, click the Create New Folder button .

When you save the work area it is saved to a local .INI file. If you want to remove a work area you will need to delete the .INI file from your machine. This will remove the file completely. You should only do this if you are certain you no longer need this work area.

Adding and Removing Combinations


Adding a Combination To add a combination to a work area: 1 2 3 4 Click the Add Combination button .

In the Module Combination Explorer, select the combination you want to add and click OK. You can now specify the switching interval and the refreshing interval for the page. For more information see Refreshing Data and Switching Tabs on page 278. Click the Save button on the work area toolbar to save your changes. You can also drag and drop an open combination onto a work area.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 275

This example shows a work area containing three module combinations:

Example Work Area with Three Modules

Removing a Combination To remove a combination from the work area: 1 Right-click the combination tab you want to remove and, from the menu that appears, select Remove Combination. - or Click on the combination tab you want to remove and click the Remove Combination button 2 3 . In the Confirm dialog box, that appears, click Yes. The combination is removed from the work area. Click the Save button on the work area toolbar to save your changes.

Page 276

AIRCOM OPTIMA User Reference Guide Version 6.2

Adding and Removing Web Browsers


You can add web browsers to the work area so that you can view any queries that may be running via the Intranet or Internet. Adding a Web Browser To add a web browser to a work area: 1 2 Click the Add Web Page button .

In the dialog box that appears, type the URL for the web page you want to display then click OK. To change the page you want to display, on the work area toolbar, click the Edit Web Page button and type the new web page address. A new page displaying the web page is added to your work area. This picture shows an example:

You can navigate to other areas from the web page, although the Back web browser button is not available when navigating from the web page. 3 4 You can now specify the switching interval and the refreshing interval for the page. For more information, see Refreshing Data and Switching Tabs on page 278. Click the Save button on the work area toolbar to save your changes.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 277

Removing a Web Browser To remove a web browser from the work area: 1 Right-click the web page tab you want to remove and, from the menu that appears, select Remove Web Page. - or Click on the web page tab you want to remove and click the Remove Web Page button 2 3 . In the Confirm dialog box, that appears, click Yes. The web page is removed from the work area. Click the Save button on the work area toolbar to save your changes.

Refreshing Data and Switching Tabs


You can set up refresh times for the data, so that after a specified interval the query will be executed again and the data updated. Refreshing data in a work area is particularly useful if you are analysing Key Performance Indicators (KPIs) which are updated within a specified interval (for example, every hour). The refresh timing interval is set for all module combinations contained within one work area (or workgroup). You can also set a switching interval, which specifies how long each page is shown. Refresh and switching intervals can be set per page. To specify the interval for data refresh or switching for a page: 1 2 In the New Work Area dialog box, select the page for which you want to set the refresh and switching intervals. Click the Tab Options button on the toolbar.

The Tab options dialog box appears:

Page 278

AIRCOM OPTIMA User Reference Guide Version 6.2

In the Tab options dialog box: In the Refresh interval field, specify the interval time in seconds. This is the number of seconds that should pass before the query runs to refresh the data. If you want the interval to apply to all pages, select the Apply to All checkbox. In the Switch interval field, type the interval time in seconds. This is the number of seconds that should pass before the work area switches to the next page. If you want the interval to apply to all pages, select the Apply to All checkbox.

Click OK. If you have selected to apply the refresh and/or switching intervals to all pages, click Yes to confirm.

Enabling Data Refreshing and Switching


Refresh Option To turn the Refreshing data option on or off: On the Work area toolbar, click the Enable Refresh button Switching Option To turn the Switching option on or off: On the Work area toolbar, click the Enable Switching button . .

Opening Work Areas


If you have saved a work area previously, you can open it for viewing and editing. To open a work area: 1 2 3 Open the Work Area dialog box. On the work area toolbar, click the Open work area button .

In the Open Workarea dialog box, select the relevant work area file and click OK. The work area is loaded along with any switching and refreshing procedures previously set up for that work area.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 279

Importing and Exporting Work Areas


You can transfer work areas between projects by importing and exporting them as INI files. To export a work area that you have created: 1 2 3 4 5 Open the Work Area dialog box. Open the work area. On the work area toolbar, click the Export Work Area button .

In the dialog box that appears, select the location to where you want to save the work area. Type an appropriate name for the work area INI file and then click Save. The work area is saved as an INI file.

To import a work area from an INI file: 1 2 3 Open the Work Area dialog box. On the work area toolbar, click the Import Work Area button .

In the dialog box that appears, select the work area that you want to import, and then click Open. The selected work area INI file is loaded, and the work area is opened.

Page 280

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 10

Viewing Data on the Map


When using AIRCOM OPTIMA with ENTERPRISE, you can view operational performance against geographical location using the Map View window. To enable you to do this, AIRCOM OPTIMA has the category Performance Data in the standard list of data types available for display in the Map View window. KPIs, created by the OPTIMA_Administrator, are shown under this category. All these counters can be displayed on the map. Only KPIs of tables for which the table level is set to CELL will be visible on the 2D map. To set the table level for a table, please see Setting Table Level on page 97. For more information about the ENTERPRISE Map View window, see the ENTERPRISE User Reference Guide.

Displaying Performance Data on the Map


When you have collected performance data, you can display it on the map. To display data on the map: 1 From the View menu, click 2D View to open a Map View window. - or Click the New 2D View button 2 3 Click the Show Data Types button . .

In the list of data types, click the + sign next to Performance Data to expand the category.

Expand the appropriate schema and table and then select the counters that you want to display on the map.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 281

Right-click the map and click Refresh to redraw the map and show the performance data that you selected. This picture shows an example.

Changing the Display of Performance Data


When using AIRCOM OPTIMA to display data on the Map View window, you can customise the display for the selected performance counter using the Display Properties window. You can change properties such as font, colour, symbol, and size of symbol. Also, on the Data tab you can: Choose which data is shown on the map by setting the date and time required Choose the filter required, to specify whether all or a sub-set of cell groups is shown on the map In the Display Options pane, choose whether to display service area, sector and text for the cells

Page 282

AIRCOM OPTIMA User Reference Guide Version 6.2

To change how performance data is displayed on the map: 1 2 3 In the Map View window, click the Show Data Types button Expand the Performance Data category. Double-click the counter whose display you wish to change. The Display Properties dialog box appears: .

On the Data tab:


Select The Link to Global Clock To display Data for the current date. If you do not select this checkbox, select a date using the calendar in the Date pane. Filter Sector checkbox Text checkbox Service Area checkbox Only data that is included in the selected ENTERPRISE filter. Select the All filter to include all data. The cell as a three-sector icon. The textual data that applies to this cell. The area of service provided by this cell. Click Select to choose a 2G or 3g service area. If you choose 3G, you can also select array settings from the Array Setting menus.

On the Size tab, select: A Symbol Size, using either Auto or typing in a set size in metres The minimum and maximum size limits to stop the symbol from dominating the view when you zoom in or disappearing when you zoom out

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 283

These settings are particularly useful when showing the performance data of more than one counter in the Map View. By manually allocating a different size for each counter, the different counter values will appear as 'bands' on the site symbol. This picture shows an example, where three different counters (ERLANG, PCONG and TCH) are displayed:

Page 284

AIRCOM OPTIMA User Reference Guide Version 6.2

On the Colour tab, select: The first colour used to show the data type The interval. For every increase in the value you type in the Interval box, the colour will change to the next colour in the palette The minimum and maximum values displayed by any colour

7 8

On the Font tab, change the font settings as required. On the Background tab, select whether a background colour is switched On or Off. If you choose On, select a colour from the palette.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 285

Click OK to save the changes.

10 Right-click the map and click Refresh to redraw the map.

Using the Clock to Display Performance Data


You can display performance data by using the Clock. By using the Play function, you can look at the data from different time periods as quickly or as slowly as you want. To use the Clock's Play function: 1 2 From the Tools menu, click Clock. In the Main Calendar dialog box that appears, click Advanced. This pane appears.

This table shows what you can do in this pane:


In this pane/box Choose

Playing data in 2D map Increment The size of the interval you want between each data display. For example, to by: see the data at 0000, 0200 and 0400, you would select a step of 2 hours. Playing data in 2D map Every: How quickly you want the map to refresh with the data you have specified. For example, if you refresh the map view every minute, it gives you a minute to analyse the data before it changes. How often you want to switch between maps.

2D map Switching Every:

When you have selected the step and period value, click Play. The performance data displayed on the map will alter accordingly.

Page 286

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 11

Generating and Scheduling Reports


You can use AIRCOM OPTIMA to generate and schedule reports of performance data. You can create reports, and then, at times you have defined, have AIRCOM OPTIMA automatically produce reports and email them to you, print them to a printer or save them to a file. The reports can be printed or exported in the following formats:
RAF CSV PDF XHTML RTF HTML XLS BMP JPEG TIFF RTM

You can save a report as a favourite and then have quick, easy access to that report from the Favourites toolbar. For more information, see Adding and Editing Favourites on page 194. The report system uses the following report applications: ReportBuilder, which is a third party report application that is fully integrated with AIRCOM OPTIMA. For more information, see Creating Reports Using ReportBuilder on page 291. Detailed information on ReportBuilder and how to use it can be found on the Digital Metaphors website at www.digital-metaphors.com. Digital Metaphors supply a document called Learning ReportBuilder, which is available for download from their website. Excel Report Editor, which enables you to create and edit Microsoft Excel reports in AIRCOM OPTIMA. For more information, see Creating Excel Reports on page 343.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 287

Download Learning ReportBuilder


To access the Learning ReportBuilder document: 1 2 On the www.digital-metaphors.com Welcome page click the Documentation link. From the list of options in the left hand pane, select Documentation - Learning ReportBuilder. You can now download the Learning ReportBuilder document, in PDF format.

About Using Reports


Using the Report Explorer, all OPTIMA_Users can: Select existing reports to view View the history of a report

OPTIMA_Administrators, OPTIMA_Alarm_Administrators and OPTIMA_Advanced_Users can additionally: Create and delete folders Create reports Filter report data Restrict editing of reports Edit and rename reports Copy and paste reports Import and export reports Print and print preview reports

Creating Folders for Reports


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create and delete folders in the Report Explorer. To create a new folder: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 .

In the Report Explorer window, browse to where you want to create the new folder and right-click. From the menu that appears, click New Folder. - or Click the Create New Folder button .

Type a name for your new folder and press Enter.

Page 288

AIRCOM OPTIMA User Reference Guide Version 6.2

OPTIMA_Administrators can restrict access to folders to prevent other users from accessing them. For more information about this, see Restricting Access to Folders on page 289.

Deleting Folders
To delete a folder: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 3 .

In the Report Explorer window, highlight the folder you want to delete. Right-click and, from the menu that appears, click Delete. - or Click the Delete button .

In the Confirm dialog box, click Yes to delete the folder and return to the Report Explorer.

Restricting Access to Folders


If you are an OPTIMA_Administrator, you can restrict access to folders to prevent users who do not have Administrator permissions from editing, moving or deleting them. To restrict access to a folder: 1 From the Reporter menu, select Reports. -or Click the Reports button 2 3 4 .

In the Report Explorer, select the folder you want to restrict. Right-click and then, from the menu that appears, click Properties. On the Security tab in the Report Folder Properties dialog box, select the Admin Folder checkbox.

5 6

Click OK. If the selected folder has child folders, you will be asked if you want to apply changes to all child folders. This enables you to restrict all of the child folders of an Admin Folder. Click Yes to apply changes, otherwise click No. Follow the previous steps and clear the Admin Folder checkbox.

To remove the restriction from a folder:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 289

Viewing Reports
To view a report: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 .

In the Report Explorer window, browse for the report you want to view and either: Double-click the report name. - or Right-click the report, and from the menu that appears, click Open.

If the numbering format does not match your locale (for example, if the reports display decimals in the UK format of a full stop - 12.3 - rather than the required European format of a comma - 12,3), contact your administrator to change your regional settings, or see About Regional Settings on page 73.

Page 290

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating Reports Using ReportBuilder


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create and edit reports with ReportBuilder. The ReportBuilder application is incorporated within the Report Designer window. You use the Report Designer window to create and edit your reports. This picture shows an example of the Report Designer window:

To create a new report: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 .

In the Report Explorer window, browse to where you want to create the new report and right-click. From the menu that appears, click New Report. - or Click the New Report button .

The Report Designer window appears. You can now choose the content of your report and design its layout. For more information, see Defining Queries on page 292 and Designing Reports on page 321.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 291

The Report Designer window has a number of tabs, which are described in the following table:
Use This Tab: Data Calc Design Preview To: Select and manipulate the data required for a report. For more information, see Defining Queries on page 292 and Editing Queries on page 308. Perform calculations and dynamically control visual aspects of the report layout. For more information, see Controlling Visual Aspects of a Report on page 310. Design the layout of a report. For more information, see Designing Reports on page 321. See how a report will look when it is printed.

ReportBuilder also contains a Report Wizard, which enables you to quickly create a new report. For more information, see Creating a Report Using the Report Wizard on page 340.

Defining Queries
On the Data tab of the Report Designer window, you can define queries to retrieve information from the database to use in your reports. When you build a query, you can choose to use the Data Explorer, Query Designer or Query Wizard:

Options for building queries

Page 292

AIRCOM OPTIMA User Reference Guide Version 6.2

The following table describes the options:


Option: Data Explorer Description: An explorer that enables you to build a query using SQL or by dragging and dropping tables to create the query if you are not familiar with SQL. For more information, see Using the Data Explorer to Define a Query on page 293 and Editing Queries on page 308. If you create a report query with the Data Explorer, you cannot subsequently use the Query Designer tabs to edit that query. Query Designer A dialog box with a series of tabs that can be used to define and edit queries. The Query Designer is more flexible than the Query Wizard and allows you to edit the SQL manually. It can also be used for multi-vendor queries. For more information, see Using the Query Designer to Define a Query on page 302 and Editing Queries on page 308. A step-by-step wizard that guides you through the process of defining a query. You do not need to be familiar with SQL to use the Query Wizard, but it does limit the possible content of the query. For more information, see Using the Query Wizard to Define a Query on page 294.

Query Wizard

Using the Data Explorer to Define a Query To define a query using the Data Explorer: 1 In the Report Designer window, on the Data tab, from the File menu, click New.

In the New Items dialog box that appears, select Data Explorer and then click OK.

The Data Explorer appears. 3 4 In the Data Explorer, define the SQL for the query. For detailed information about how to do this, see Defining a Query on page 110. When you have finished, click OK and then click Yes to save your SQL. The query is added to the Report Designer window.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 293

Using the Query Wizard to Define a Query To define a query using the Query Wizard: 1 In the Report Designer window, on the Data tab, from the File menu, click New.

In the New Items dialog box that appears, select Query Wizard and then click OK.

Page 294

AIRCOM OPTIMA User Reference Guide Version 6.2

On the first page of the Query Wizard, in the left-hand pane, select the table(s) that you want to query and click the right arrow button :

If you select more than one table, you can choose to create a join between them. 4 5 Click Next. On the second page of the Query Wizard, select the fields that you want to query by selecting one of the options described in the following table:
Select this Option: All Fields Choose Fields If You Want To: Select all of the fields in the table. Select specific fields in the table. To select a field, select it in the left-hand pane and click the right arrow button.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 295

This picture shows an example:

6 7

Click Next. On the third page of the Query Wizard, you can add calculations to the fields selected in Step 5. To add a calculation to a field: Select the Add Calculations option. In the left-hand pane, select the field you want to add a calculation to and click the right arrow button . In the dialog box that appears, select a function from the Function drop-down list and a field from the Numeric Field drop-down list. Click OK. The calculation is added to the right-hand pane. You can add more than one calculation in this way. If you do not want to add any calculations, select the No Calculations option.

Page 296

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

8 9

Click Next. On the fourth page of the Query Wizard, you can group rows together based on common field values. The following table describes the two grouping options:
Select This Option: No Grouping Select Group Fields If You Want To: Have no grouping. Select the fields to group by. To select a field, select it in the left-hand pane and click the right arrow button .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 297

This picture shows an example:

If your query contains calculations, then it will automatically be grouped by all selected fields. 10 Click Next. 11 On the fifth page of the Query Wizard, you can limit the rows returned by the query. You might want to do this to restrict the amount of data returned during the design process. The following table describes the two limiting options:
Select Option: All Rows Define Search Criteria If You Want To: Have all rows returned by the query. Define search criteria to limit the rows returned. To define search criteria: 1. In the Criteria pane, right-click and, from the menu that appears, click Insert Criteria. 2. In the Search Criteria dialog box, select a Field and an Operator from the appropriate drop-down lists and type a value in the Value field. 3. Click OK. The search criterion is added to the Criteria pane. 4. To define more search criteria, repeat steps 1 to 3.

Page 298

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

12 Click Next. 13 On the sixth page of the Query Wizard, you can set the row order based on the field values. The following table describes the two row order options:
Select This Option: Natural Order Set Order If You Want To: Use the natural row order. Set your own row order. To set the row order: 1. In the left-hand pane, select the row that you want to be first in the order and click the right arrow button .

2. In the left-hand pane, select the row that you want to be next in the order and click the right arrow button .

3. Repeat step 2 until there are no more rows in the left-hand pane.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 299

This picture shows an example:

14 Click Next. 15 On the final page of the Query Wizard, type a name for your query and select one of the options described in the following table:
Select This Option: Return to Data Workspace Preview this Query Modify the Query's Design If You Want To: To be returned to the data workspace when you have finished. Preview the data returned by your query when you have finished. Modify your query using the Query Designer when you have finished.

Page 300

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

16 Click Finish to save your query and close the Query Wizard. This picture shows an example query which returns data from the ERICSSON2G_CELLSTATS table:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 301

Using the Query Designer to Define a Query To define a query using the Query Designer: 1 In the Report Designer window, on the Data tab, from the File menu, click New.

2 3

In the New Items dialog box that appears, select Query Designer and then click OK. The Query Designer window appears. On the Tables tab, in the Available Tables list, double-click the table you want to query. The table is added to the Selected Tables list. This picture shows an example:

To remove a table, double-click the table in the Selected Tables list.

Page 302

AIRCOM OPTIMA User Reference Guide Version 6.2

On the Fields tab, in the Available Fields list, double-click the fields you want to query. The fields are added to the Selected Fields list. This picture shows an example:

You can add all of the fields to the Selected Fields list by selecting the All Fields checkbox. 5 On the Calcs tab, you can add calculations to the fields selected in Step 4. To add a calculation to a field: In the Available Fields list, double-click the field you want to add a calculation to. The field is added to the Calculations list. In the Calculations list, select the field. Select a function from the Function drop-down list. If you want to use a userdefined expression, select Expression from the Function drop-down list and then type the expression in the Expression field.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 303

This picture shows an example of the Sum function:

On the Group tab, you can select fields to group the results of your query by. To select a field to group by, double-click the field in the Available Fields list. This picture shows an example:

Page 304

AIRCOM OPTIMA User Reference Guide Version 6.2

On the Search tab, you can filter the data returned by your query. For detailed information about how to do this, see Creating Filters for Reports on page 335.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 305

On the Sort tab, you can select fields to order the rows returned by your query. To select a field to order by: In the Available Fields list, double-click the field you want to order by. If you want the returned rows to be in descending order, select the field in the Sort Fields list and then select the Desc (z>a) checkbox. This picture shows an example:

To use the order of the rows stored in the database, select the Natural Order checkbox. 9 On the SQL tab, you can view and manually edit the SQL of your query. Once you have manually edited a query, you can no longer use the Query Designer tabs to edit your query.

Page 306

AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example:

To manually edit a query: Right-click the SQL and, from the menu that appears, click Edit SQL. Click Yes to confirm. The SQL becomes editable. If you want to use the Data Explorer, right-click the SQL and, from the menu that appears, click Data Explorer. Click Yes to confirm. The Data Explorer appears. In the Data Explorer, make the required changes to your query. For more information, see Defining a Query on page 110. When you have finished, click OK and then click Yes to save your changes and return to the Query Designer.

- or -

10 Click OK to save your query and close the Query Designer.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 307

Editing Queries
You can edit report queries using either the Query Designer or the Data Explorer, depending upon the following conditions: If you have created the report query with the Query Designer, you can edit it using either the Data Explorer or the Query Designer. If you have created the report query with the Data Explorer, you can only edit it using the Data Explorer. If you have already edited the report query with the Data Explorer, then you can only edit it using the Data Explorer. In the Report Explorer, double-click the report with the query you want to edit. The Report Designer window appears. In the Report Designer window, click the Data tab. Right-click the query you want to edit and, from the menu that appears, click Data Explorer. - or Click the Data Explorer button 4 .

To edit an existing query using the Data Explorer: 1 2 3

If the query was defined using either the Query Wizard or the Query Designer, a message box appears asking you to confirm you want to manually edit the query. Click Yes to confirm. The Data Explorer appears. In the Data Explorer, make the required changes to your query. For more information about using the Data Explorer, see Using the Data Explorer on page 108. When you have finished, click OK and then click Yes to save your changes.

Page 308

AIRCOM OPTIMA User Reference Guide Version 6.2

To edit an existing query using the Query Designer: 1 2 3 In the Report Explorer, double-click the report with the query you want to edit. The Report Designer window appears. In the Report Designer window, click the Data tab. Right-click the query you want to edit and, from the menu that appears, select the required option.

The Query Designer appears, with the corresponding tab selected. 4 5 Make the required changes to your query. For more information about using the Query Designer, see Using the Query Designer to Define a Query on page 302. When you have finished, click OK to save your changes and close the Query Designer.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 309

Controlling Visual Aspects of the Report Layout


On the Calc tab of the Report Designer window, you can use an event-based environment to perform calculations and dynamically control visual aspects of the report layout while the report is generating. The Calc tab is divided into the following areas: Code Explorer

Code Toolbox

Page 310

AIRCOM OPTIMA User Reference Guide Version 6.2

Code Editor

Message Window

About the Code Explorer The upper area of the Calc tab is called the Code Explorer. The Code Explorer area contains a tree view to enable you to navigate your report's code. In the Code Explorer, you can manage the report code using different views:
View Variables Events Module Description Displays the variables within a report. Variables are used to perform calculations. Displays all components contained within a report, and any events associated with the currently selected component. Displays a global view of the declarations, events, programs, and event handlers. This view is useful when you want to examine all of the reports code.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 311

Viewing the Report Variables In the Variables view, you can display the variables within a report. Variables enable you perform calculations. This picture shows an example of the Variables view:

Variables View

To view the variables in a report: Right-click in the Code Explorer area and from the menu that appears, click Variables.

Page 312

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing the Report Events In the Events view, you can view all components contained within a report. You can also view any events associated with the currently selected component. This picture shows an example of the Events view:

Events View

To view the events contained within a report: Right-click in the Code Explorer area and from the menu that appears, click Events.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 313

Example of Using the Calc Tab - Highlighting Values in Reports This example explains how to use the Calc tab to control the visual aspects of the report layout, and configure a threshold to appear in different colours depending on the value. Take a sample report: Top 20 - Cell Handover Stats. If you want to ensure that the handover success rate is maintained at a threshold of 98%, you may find it useful to highlight any measurements less than 98% in a warning colour (for example red), and highlight any values above the threshold in a different colour (for example, blue). This picture shows an example:

Example report with colour-coded threshold values

To define this on the Calc tab, we first need to know the associated field on the report layout, and the database field that this relates to.

Page 314

AIRCOM OPTIMA User Reference Guide Version 6.2

This information can be seen on the Design tab; the % Handover Success is associated with the DBText3 on the report layout, and this relates to the HOSSR database field:

Checking the details on the Design tab

Now if we go back to the Calc tab, we can start to define our SQL procedure: On the Calc tab, in the Report Objects pane, select DBText3. In the Events for DBText3 pane, select the 'ONPrint' event. To view the events, right-click in the Report Objects pane, and from the menu that appears, click Events. Right-click, and from the menu that appears, click New.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 315

In the Code Editor pane at the bottom of the screen, write the procedure in SQL. For this example it will be: procedure DBText3OnPrint; begin if HOSR['HOSSR'] else DBText3.Font.color:=clblue; end; <98 then DBText3.Font.color:=clred

Right-click the 'ONPrint' event, and from the menu that appears, and click Compile.

From the File menu, click Save.

Page 316

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing the Report Modules In the Module view, you can view a global view of the declarations, events, programs, and event handlers. This view is useful when you want to examine all of the reports code. It displays the following:
Module Declarations Events Programs Event Handlers Description Variables and constants that are globally visible throughout the report Report events Procedures and functions that are globally visible throughout the report and can therefore be called from any event handler Event handlers that have been implemented in the report

This picture shows an example of the Module view:

Module View

To view the report modules: Right-click in the Code Explorer area and from the menu that appears, click Module. About the Code Toolbox The lower right-hand side area of the Calc tab is called the Code Toolbox. It is a visual code repository that contains identifiers and code elements. It consists of the following three tabs:
Tab Data Objects Language Description View data pipelines and fields and drag and drop field references into the Code Editor. View report objects and their properties, and drag and drop properties into the Code Editor. View the RAP language elements and drag and drop elements into the Code Editor.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 317

Viewing Data Fields In the Data tab of the Code Toolbox, you can view data pipelines and fields and drag and drop field references into the Code Editor. To use the data fields in the code: 1 2 In the Code Explorer, ensure that you are displaying the Events view and select the Data tab. Select a field and drag it in the Code Editor. The code necessary to retrieve the field value is generated.

For example, if you drag the City field from the Code Toolbox, you get the following code in the Code Editor: Value := Clients[City] This picture shows an example of the Data tab of the Code Toolbox:

Data Tab of the Code Toolbox

Viewing the Report Objects In the Objects tab of the Code Toolbox, you can view report objects and their properties, and drag and drop properties into the Code Editor. To use the report objects in the code: 1 2 3 In the Code Explorer, ensure that you are displaying the Events view and select the Objects tab. In the Code Toolbox: Report Objects pane, select an object in the tree. The properties of the object are displayed in the Properties for Detail pane. In the Properties for Detail pane, select and drag a property to the Code Editor. The code necessary to retrieve the value of the property or call the method is generated.

For example, if you drag the AutoSize property from the Code Toolbox, the following code generates in the Code Editor: Label1.AutoSize
Page 318 AIRCOM OPTIMA User Reference Guide Version 6.2

This picture shows an example of the Objects tab of the Code Toolbox:

Objects Tab of the Code Toolbox

Viewing the Report Application Pascal (RAP) Language Elements In the Language tab of the Code Toolbox, you can view the RAP language elements and drag and drop elements into the Code Editor. To use the RAP language elements in the code: 1 2 3 In the Code Explorer, ensure that you are displaying the Events view and select the Language tab. In the Code Toolbox: Language pane, select a category in the tree to view elements for that category. In the Code Toolbox: Language pane, select and drag an element to the Code Editor. The code necessary to reference or use the element is generated.

For example, if you drag Copy to the Code Editor, the following code is generated: Copy(S, Index, Count); When you drop an item such as a function call, the function's parameter list is provided.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 319

This picture shows an example of the Language tab of the Code Toolbox:

Language Tab of the Code Toolbox

About the Code Editor The lower left-hand side area of the Calc tab is called the Code Editor and it contains the code. This picture shows an example of the Code Editor:

Code Editor

To create the code in the Code Editor: Right-click an event in the Code Explorer and from the menu that appears, click New. An outline of the code for the selected element is displayed in the Code Editor. You can then edit the code. -orSelect an element in the Code Toolbox and drag it to the Code Editor. The code for the selected element is displayed in the Code Editor. You can then edit the code. -or-

Page 320

AIRCOM OPTIMA User Reference Guide Version 6.2

Right-click in the Code Editor and select New. The outline of the code is displayed in the Code Editor. You can then edit the code. The New option is only enabled if there is no existing code for the item currently selected in the Code Explorer. To compile, save, delete, or revert the code, right-click and from the menu that appears, click the appropriate option. Following is an example of code: procedure DBText3OnPrint; begin if ERICSSON2G_CELLSTATS['MHT'] > 20 then label7.Font.color:= 13382297 else DBText3.Font.color:=clblack; end; For more information on RAP, you can visit http://www.digital-metaphors.com. About the Message Window In the Message Window (in the lower left-hand corner), you can see the error messages from the compiler when you compile the code in the Code Editor.

Designing Reports
After you have selected the content of your report, you can design its layout. You design reports using the toolbars available on the Design tab in the Report Designer window. The design workspace consists of two areas:
Item Workbench Canvas Description Contains the toolbars, component palettes, rules and other tools used to manipulate the canvas. Contains the report layout.

The Standard Component toolbar contains 'static' components which you use to enhance the appearance of your report, for example, to add labels or images. This picture shows an example of the Standard toolbar:

Standard Component toolbar

The Data Component toolbar contains 'data aware' components. You use these components to display actual data from the database. This picture shows an example of the Data toolbar:

Data Component toolbar

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 321

This picture shows an example report design. In the example, static components have been used in the Header band of the design area to create the visual appearance of the report and data aware components have been used in the Detail and Footer bands to display data from the database.

Example Report Design

The rest of this section guides you through designing a basic report, but for more information about using ReportBuilder, see the Digital Metaphors website at www.digital-metaphors.com. The recommended workflow for designing a report is as follows: 1 2 3 4 Add the title and/or logo. Add the report details (in other words, the data from the query that you want to display). Add headers and footers. Align all of the components correctly.

Page 322

AIRCOM OPTIMA User Reference Guide Version 6.2

About the Report Designer Canvas The Report Designer canvas contains the report layout, and consists of three panes:
Pane Header Detail Footer Description This pane appears at the top of every page of the report. It is suitable for column headers. This pane is used to place the data retrieved from the database. You can place 'DB text' boxes in here, which are essentially pointers into records on your Database query. This pane appears at the bottom of every page of the report. It is suitable for footers such as date, file name, page count and so on.

This picture shows an example:

You can also add a 'Title' and 'Summary' pane using the Report menu:
Pane Title Summary Description This pane appears at the top of the first page of the report. It is suitable for a Title and/or a Logo. This pane appears at the bottom of the last page of the report. It is suitable for graphs and other 'one-off' summary items

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 323

Adding a Title and Logo to a Report To add a title to a report: 1 Ensure that you are displaying the Title pane. If you are not, from the Report menu, click Title. 2 3 Click the Label button Click in the Title pane. A 'Label' box appears: .

At this point, it does not have to be in the correct alignment, because you can adjust this later using the alignment toolbar. 4 Click in the Label pane, and type the required title for the report:

To edit the title appearance, use the formatting options to the right of the Label pane. To add a logo to a report: 1 Ensure that you are displaying the Title pane. If you are not, from the Report menu, click Title. 2 3 Click the Image button .

In the Title pane, click in the area where you want to the logo to appear.

Page 324

AIRCOM OPTIMA User Reference Guide Version 6.2

An empty box appears:

4 5

Right-click in the empty box, and from the menu that appears, click Picture. In the dialog box that appears, locate the required logo and then click Open. Your logo appears in the selected location:

If your logo does not display at the correct size, right-click it and from the menu that appears, click Stretch. You can then resize the logo as required.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 325

Adding Details to a Report (Date from the Query) Although the Header pane comes before the Detail pane, it is recommended that you add the details first, so that you will have a better idea of which headers are needed for those details. To add details to your report: 1 2 Click the DB Text button Click in the Details pane. A 'DB Text' box appears: .

At this point, it does not have to be in the correct alignment, because you can adjust this later using the alignment toolbar. 3 To define what is displayed in the box: From the first drop-down list, select the required query:

From the second drop-down list, select the required field from that query:

The field appears in the DB Text box:

Repeat steps 1-3 to add all of the details that you require. Rather than adding all of the details at once, you can add one field, then add its header, then go back and add another field, then add its header and so on.

Page 326

AIRCOM OPTIMA User Reference Guide Version 6.2

Adding Headers to a Report To add a header to a report: 1 2 Click the Label button .

Click in the Header pane, so that the header will be above the corresponding data field ('DB Text' box). A 'Label' box appears:

Click in the Label pane, and type the required header name:

To edit the title appearance, use the formatting options to the right of the Label pane.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 327

Adding Footers to a Report To add a footer to a report: 1 2 Click the System Variable button Click in the Footer pane. A 'System Variable' box appears, which by default shows the date: .

If you want to display a different variable type in the footer, select it from the System Variable drop-down list:

Aligning Items in Reports To correctly align all of the different boxes in your report layout, you can use the Align or Space Toolbar. It is strongly recommended that you save a version of your report before using the Align or Space options. To display this toolbar, from the View menu, point to Toolbars and then click Align or Space. This picture shows the toolbar:
Align or Space toolbar

Page 328

AIRCOM OPTIMA User Reference Guide Version 6.2

To align one or more boxes: 1 Using the mouse pointer, draw a box around all of the boxes that you want to align.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 329

All of the boxes are selected:

Click the appropriate button on the Align or Space Toolbar. This table describes the options:
Description Align left. Align middle (vertically). Align right. Align top. Align centre (horizontally). Align bottom. Space horizontally. Space vertically. Centre horizontally in band. Centre vertically in band.

Item

Page 330

AIRCOM OPTIMA User Reference Guide Version 6.2

Adding Graphs to a Report


With ReportBuilder, you can add graphs to your reports to display the data from queries. You create graphs using TeeChart Pro. TeeChart Pro is a third party charting application. For more information about TeeChart Pro, see the Steema Software website at http://www.steema.com. You must have a query defined before creating a graph. For information about defining queries, see Defining Queries on page 292. To display query data in a graph: 1 2 3 4 In the Report Explorer, double-click the report you want to add the graph to. The Report Designer window appears. In the Report Designer window, click the DB Chart button .

In the Summary pan, click where you want the graph to be located. Right-click the graph, and from the menu that appears, click Edit Chart. The Editing dialog box appears. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 331

In the Editing ppDPTeeChartControl1 dialog box, click Add. The TeeChart Gallery dialog box appears. This picture shows an example:

In the TeeChart Gallery dialog box, click the type of graph that you want to add. If you want your graph to be a 2D graph, clear the 3D checkbox.

Page 332

AIRCOM OPTIMA User Reference Guide Version 6.2

Click OK. A new series is added to the Editing ppDPTeeChartControl1 dialog box. This picture shows an example of a series for a bar graph:

To rename the series, click Title and, in the dialog box that appears, type a new name and then click OK. 8 Click the Series tab and then click the Data Source sub-tab.

On the Data Source sub-tab, select Data Pipeline from the drop-down list. This will enable you to link a query to the series.

10 From the Data Pipeline drop-down list, select the query that you want to link to the series.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 333

11 On the Data Source sub-tab, complete the following information:


In This Field: Labels X Bar DateTime DateTime Do This: Select a label from the drop-down list, if you want a label to be displayed on the x axis for each series point. Select a field from the drop-down list to display on the x axis of the graph. Select a field from the drop-down list to display on the y axis of the graph. Select this checkbox if you want to display the date and time on the x axis. Select this checkbox if you want to display the date and time on the y axis.

If you try to display both a label and the date/time on the x axis, they will overlap. In this case, it is recommended to leave the label blank, because the required information can be displayed by other means, for example by using a legend. This picture shows an example of a bar series which is linked to the MIRNC01_Query query and has DAY, Date and Time on the X axis and RAB SU ACC COMP VOICE % on the Y axis:

12 Click Apply. 13 If you want to add another series to your graph, repeat steps 5 to 12. 14 Click the Chart tab and then click the Titles sub-tab.

15 In the Text pane, type a title for your graph.


Page 334 AIRCOM OPTIMA User Reference Guide Version 6.2

16 Click Close to save your graph and exit TeeChart Pro. To preview your graph, in the Report Designer window, click the Preview tab.

Saving Reports
To save a report to the database: 1 2 In the Report Designer window, on the Design tab, from the File menu, click Save As. In the Save New Report As dialog box, browse to the Report Explorer folder where you want to save your report, type a name and click Save. If the required folder does not exist, click the Create New Folder button The report is saved to the database. To save a report to file: 1 2 In the Report Designer window, on the Design tab, from the File menu, click Save to File. In the Save As dialog box, browse to the folder where you want to save your report, type a name and click Save. If the required folder does not exist, click the Create New Folder button . .

Reports are saved in RTM format. This means that you can send reports, by email for example, and load them into other databases by using the Load from File option.

Filtering the Data Displayed in Reports


In AIRCOM OPTIMA, you can use filters and parameters to limit the data returned when reports are run. When you run a report with a filter or a parameter, the Selection dialog box is displayed. In the Selection dialog box, you select the values for the filters and parameters. Creating Filters for Reports In ReportBuilder, you can use filters to limit the data returned when reports are run. When you run a report with a filter, you are asked to specify the criteria that you want AIRCOM OPTIMA to report on. To create a filter for a report: 1 2 3 In the Report Explorer window, open the report that you want to add a filter to. The Report Designer window appears. In the Report Designer window, click the Data tab. Select the query that you want to filter and either: Click the Search button - or AIRCOM OPTIMA User Reference Guide Version 6.2 Page 335

Right-click the query and, from the menu that appears, click Search. The Query Designer appears, with the Search tab selected. This picture shows an example:

In the Available Fields pane, either: Double-click the field that you want to be a filter. - or Right-click the field that you want to be a filter and, from the menu that appears, click Insert Criteria. The selected field appears in the Criteria pane.

In the Criteria pane, complete the following information:


In This Field: Operator Do This: Select an operator from the drop-down list. For example, if you want to create a filter that only returns data for an exact value, then select the = operator. You must select In List if you want to use filters when the report is run. Value Either leave this field blank or add default values. If you add default values, they will be preselected in the filter when you run the report. For more information about filter values, see Adding Filter Values for Reports on page 337. Select this checkbox if you want to display the Search dialog box when the report is run. For more information, see Adding Filter Values for Reports on page 337. Do not select the AutoSearch checkbox if the report is to be scheduled. Mandatory Select this checkbox if you want to ensure that a filter value is entered when the report is run.

AutoSearch

Page 336

AIRCOM OPTIMA User Reference Guide Version 6.2

In This Field: Show All

Do This: Select this checkbox if you want the filter to display all of the values of the field. This option overrides all other filter options.

This picture shows a filter for the XXTRAFFMEASBH24_ERI.UTRANCELL field which when run will display the Search dialog box and allow filters to be used:

6 7

Click OK. Close the Report Designer and click Yes to save your changes. Now when you run the report, you will be asked to specify filter value(s) based on the criteria you have set. For more information about filter values, see Adding Filter Values for Reports on page 337.

Adding Filter Values for Reports When you run a report with a filter, the Selection dialog box is displayed. In the Selection dialog box, you can choose to add a filter value and/or a filter. The report will display only the information that relates to the filter value(s) you have added. To add a filter value: 1 2 In the Report Explorer window, preview the report you want to filter. In the Selection dialog box that appears, select the filter values that you want to add. For more information, see Selecting Filter Values and Parameters on page 122. Click OK to close the Selection dialog box and run the report with the specified filter value.

Creating Parameters for Reports With AIRCOM OPTIMA reports, you can use parameters to limit the data returned when reports are run. When you run a report with a parameter, you are asked to specify the criteria that you want AIRCOM OPTIMA to report on. Creating a parameter for a report requires you to manually edit the report query. Once you have manually edited a query, you can no longer use the Query Designer tabs to edit that query.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 337

To create a parameter for a report: 1 2 3 In the Report Explorer window, open the report that you want to add a parameter to. The Report Designer window appears. In the Report Designer window, click the Data tab. Select the query that you want to filter and either: Right-click the query and, from the menu that appears, click Data Explorer. - or Click the Data Explorer button 4 .

If the report query was defined using the either the Query Wizard or the Query Designer, a message box appears asking you to confirm you want to manually edit the query. Click Yes to confirm. The Data Explorer appears. In the Data Explorer, create the parameter. For detailed information about how to do this, see Defining Parameters for a Query on page 116. When you have finished, click OK and then click Yes to save your changes. Close the Report Designer and click Yes to save your changes. Now when you run the report, you will be asked to specify parameter values based on the criteria you have set. For more information about parameter values, see Setting Parameter Values for Reports on page 338.

5 6 7

Setting Parameter Values for Reports When you run a report with a parameter, the Search dialog box is displayed. In the Search dialog box, you set the parameter value(s) you want to use. If you do not want to specify parameter values each time you run a report, you can set default parameter values. For detailed information about how to do this, see Specifying Default Parameter Values on page 118.

Page 338

AIRCOM OPTIMA User Reference Guide Version 6.2

To set a parameter value: 1 2 In the Report Explorer window, preview the report you want to filter. In the Selection dialog box that appears, on the Parameters tab, set the parameter values for the reports. For more information, see Selecting Filter Values and Parameters on page 122. This picture shows an example:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 339

Creating a Report Using the Report Wizard


When generating a new report, you can use the Report Wizard to create a new report. The wizard will overwrite any existing design for a report, so it is recommended that you only use it for new reports. To use the Report Wizard: 1 2 3 From the File menu, click New. In the dialog box that appears, select Report Wizard, and then click OK. On the first page of the wizard, choose the required fields for the report, by selecting them from the Available Fields list and clicking the right arrow button:

To select all of the available report fields, click the double right arrow button. 4 5 Put the fields in the required order, using the up and down arrow buttons. Click Next.

Page 340

AIRCOM OPTIMA User Reference Guide Version 6.2

On the next page of the wizard, choose which fields you want to show in separate panes, by selecting them from the Available Fields list and clicking the down arrow button:

Each selected field will appear in its own pane, whereas the unselected fields will be displayed together in a single group. This grouping is also used in queries. For more information, see Defining Queries on page 292. Use the Priority up and down arrow buttons to change the order of the fields as they appear on the report. 7 8 Click Next. Select the required orientation for your report: The report layout - for example, stepped or block (tabular) The page orientation - either portrait (vertical) or landscape (horizontal)

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 341

If you want all of the fields to fit on a page, select the 'Adjust field widths so all fields fit on page' option.

Click Next.

10 Select a report style from the pre-defined list.

Page 342

AIRCOM OPTIMA User Reference Guide Version 6.2

11 Click Next. The basic report design is now completed. 12 Choose to either: Preview the report based on the design you have created - or Modify the report layout

Click Finish. 13 If you chose the preview option, the wizard closes and you can preview the report on the Preview tab. - or If you chose the modify option, the wizard closes and you can edit the report design on the Report tab in the normal way. For more information, see Designing Reports on page 321.

Creating Excel Reports


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create and edit Microsoft Excel reports in AIRCOM OPTIMA. To create an Excel report: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 - or Click the New Excel Report button . .

From the Report Explorer File menu, point to New and click Excel Report.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 343

The Excel Report Editor window appears. This picture shows an example:

On the Report Information tab, type a name and description and select the Enabled checkbox. Ensure the Enabled checkbox is selected otherwise the report will not run. You can enable this later, if required.

On the Report Definition tab, you define the contents of your report by writing one or more data queries. Data queries determine what data will be displayed in your report. This table describes the Report Definition buttons:
Click: Add To: Create and add a new data query to a report. To do this: 1. Click Add. The Data Explorer appears. 2. In the Data Explorer, define your data query. For more information, see Defining a Query on page 110. 3. Click OK, and then click Yes to save your data query to the Excel Report. 4. Close the Data Explorer. 5. In the dialog box that appears, type a name and description for your data query and click OK. The new data query is added to your report and appears in the Report Data Queries List. Remove Remove a data query from a report. To do this: 1. Select the data query you want to remove in the Report Data Queries List. 2. Click Remove. 3. Click OK to remove the data query.

Page 344

AIRCOM OPTIMA User Reference Guide Version 6.2

Click: Edit

To: Edit a pre-defined data query. To do this: 1. Select the data query you want to edit in the Report Data Queries List. 2. Click Edit. The Data Explorer appears. 3. In the Data Explorer, edit your data query. For more information, see Defining a Query on page 110. 4. Click OK, and then click Yes to save your data query to the Excel Report. 5. Close the Data Explorer. 6. In the dialog box that appears, click OK. The edited data query is added to your report.

Preview Data

Preview the data returned from a data query. To do this: 1. Select the data queries you want to preview in the Report Data Queries List. Use the Shift and Ctrl keys to highlight more than one data query at a time. 2. Click Preview Data. An Excel workbook appears, containing a separate worksheet for each selected data query. 3. Close Excel to return to the Excel Report Editor window.

This picture shows an example of the Report Definition tab:

If you want to assign a pre-existing Excel template to this report: Click Assign Template. In the dialog box that appears, locate the required template. Click Open. The template is loaded, and the name appears in the Template file name box.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 345

To view the contents of the Excel template that you have assigned, click the Open Template button - or If you want to create a new Excel template to use with this report (and future reports): 6 7 Click Create Blank Template. For detailed information on what to do next, see Creating an Excel Template on page 347. .

Click the Preview Report button. The data is exported to Excel and displayed in the named ranges defined in the Excel template. In Excel, add any further formatting you require to your report, for example, headings or graphs. You can also include Microsoft Excel macros in your report templates, which will be run automatically when you open the report. For more information, see the Microsoft Excel help.

8 9

When you have finished, remove the data and re-save the workbook as an Excel template file (for example, *.xlt or *xltx). Close Excel to return to the Excel Report Editor window.

10 Click OK to save your report to the database and close the Excel Report Editor window. This picture shows an example of an Excel report:

Example Excel Report

Page 346

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating an Excel Template


When you create an Excel report in AIRCOM OPTIMA, you also need an Excel template so you can add formatting to your report. For more information about Excel reports, see Creating Excel Reports on page 343. You can also include Microsoft Excel macros in your report templates, which will be run automatically when you open the report. For more information, see the Microsoft Excel help. To create an Excel template: 1 In the Excel Report Editor window, on the Report Definition tab, select the data queries in the Report Data Queries List that you want to use in the template. Use the Shift and Ctrl keys to highlight more than one data query at a time. 2 3 Click Preview Data. An Excel workbook appears, containing a separate worksheet for each selected data query. In Excel, create a cell range for each data query that you want to be displayed. You can define the cell ranges in the same worksheet or in separate worksheets. To create a cell range: Select the range of cells that you want to use. When selecting a range, you can simply select the top left cell rather than the full range. If you select a range which is smaller than the data size, only the data that fits the range will be displayed. Select the Name Box at the left-hand end of the formula bar. Type a name for the cell range. The name of each cell range must match the corresponding data query name, otherwise the data will not be displayed in the range when it is exported to Excel. Data query names are case sensitive. 4 5 6 Press Enter.

For more information about cell ranges, see the Microsoft Excel Help. Delete the data from the Excel worksheet(s). Save the workbook as an Excel template file (for example, *.xlt or *.xltx). Close Excel to return to the Excel Report Editor window. The new template appears in the Template File Name box:

To view the contents of the Excel template that you have created, click the Open Template button .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 347

Viewing Excel Reports


To view an Excel report: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 .

In the Report Explorer window, browse for the Excel report you want to view and either: Double-click the report name. - or Right-click the report, and from the menu that appears, click Open.

Restricting Access to Reports


If you have OPTIMA_Administrator permissions, you can restrict access to reports to prevent users who do not have Administrator permissions from editing them. To restrict access to a report: 1 From the Reporter menu, select Reports. -or Click the Reports button 2 3 4 5 .

In the Report Explorer, select the report you want to restrict. Right-click and then, from the menu that appears, click Properties. In the Report Properties dialog box, select the Admin Report checkbox. Click OK.

To remove the restriction from a report follow the previous steps and clear the Admin Report checkbox.

Restricting Editing of Reports


You can use an owning group to restrict who has editing access to a report. If a report is assigned an owning group, then it can only be edited by members of that group. A report can only have one owning group. To assign an owning group for a report, you must be: An OPTIMA_Administrator An OPTIMA_Advanced_User or OPTIMA_Alarm_Administrator, and be a member the group that owns the report

Page 348

AIRCOM OPTIMA User Reference Guide Version 6.2

To make a group the owner of a report: 1 From the Reporter menu, click Reports. -or Click the Reports button 2 .

In the Report Explorer window, select the report you want to set the owning group for. You must be an OPTIMA_Administrator to assign the owning group for an Admin Report.

3 4 5

Right-click the selected report and from the menu that appears, click Properties. In the Report Properties dialog box, select a group from the drop-down list. Click OK.

Editing and Deleting Reports


To edit a report: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 .

Right-click the report that you want to edit, and from the menu that appears, click Edit. The Report Designer window appears.

To rename a report: 1 2 1 2 In the Report Explorer, right-click a selected report, and from the menu that appears, click Rename. Type in the new name for the report and press Enter. In the Report Explorer, select the report you want to delete. Right-click, and from the menu that appears, click Delete. or Click the Delete button .

To delete a report:

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 349

Copying Reports
If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can copy existing reports and then modify them. To do this: 1 From the Reporter menu, click Reports. -or Click the Reports button 2 .

In the Report Explorer, select the report(s) you want to copy.

Use the Shift and Ctrl keys to select more than one report at a time. 3 4 5 Right-click, and from the menu that appears, click Copy. Select the folder that you want to copy the report(s) to. Right-click, and from the menu that appears, click Paste. The reports are copied to the specified folder.

Printing Reports
To print a report: 1 From the Reporter menu, click Reports. - or Click the Reports button 2 .

In the Report Explorer window, highlight the report you want to print and either: Right-click and from the menu that appears, click Print or Print Preview. - or Click the Print or Print Preview buttons . to open the Print dialog

In the Print Preview dialog box, you can scroll through the report pages and zoom in and zoom out on the report. Click the Print button box.

You can preview more than one report at a time. To do this repeat step 2. 4 In the Print dialog box, select the printer and the print properties and click OK to print the report and return to the Report Explorer.

Page 350

AIRCOM OPTIMA User Reference Guide Version 6.2

Importing and Exporting Report Definitions


If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can export reports and then import and use them in another AIRCOM OPTIMA installation. You can import and export: Reports Report folders A combination of reports and report folders

You must be an OPTIMA_Administrator to import and export Admin reports and Admin folders. Importing Reports To import a report: 1 2 In the Report Explorer, select the folder into which you want to import the report(s). Click the Import Report From File button - or Right-click, and from the menu that appears, click Import Report(s) Definition. 3 4 5 6 Click OK to confirm. In the Import Reports dialog box, click the Browse button. In the Browse for Folder dialog box, select the folder which contains the report(s) you want to import and click OK. In the File Name list, select the file(s) and/or folder(s) you want to import and click OK. Use the Shift and Ctrl keys to select more than one file and/or folder at a time. 7 If your selection includes reports in sub-folders, you will be asked if you want to recreate the directory structure in the Report Explorer. Click Yes to recreate the directory structure, otherwise click No. In the message box that appears, click OK to import the report(s). The reports are imported to the specified folder. .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 351

Exporting Reports To export a report: 1 In the Report Explorer, select the report(s) and/or folder(s) you want to export. Use the Shift and Ctrl keys to select more than one report and/or folder at a time. 2 Click the Export Report to File button - or Right-click, and from the menu that appears, click Export Report(s) Definition. 3 If your selection includes reports in sub-folders, then in the Export Reports dialog box, set the following options by selecting or clearing the appropriate checkboxes: 4 5 6 Export reports from sub-folders Create folders in destination directory .

Click OK. In the Browse for Folder dialog box, select the folder into which you want to export the report(s) and click OK. In the message box that appears, click OK to export the report(s). The reports are exported to the specified folder.

Exporting Reports
In the Report Explorer, you can export reports. To do this: 1 2 3 In the Report Explorer, select the report you want to export. Right-click, and from the menu that appears, click Export. In the Export dialog box that appears, select the format you want to export the report in by clicking the appropriate radio button. This picture shows an example:

Page 352

AIRCOM OPTIMA User Reference Guide Version 6.2

If you are exporting an Excel report, the Excel File radio button is pre-selected for you. 4 5 If you want to zip the report, select the 'Zip file before exporting' checkbox. If you want to export the report to file, click File and in the Save As dialog box that appears, browse to the appropriate folder, type a name, and click Save. If the required folder does not exist, click the Create New Folder button 6 .

If you want to export the report via email, click Email and in the blank email that appears, type the email address(es), appropriate subject title and click Send. If the Email Client Settings have been enabled in the User Preferences, then the AIRCOM OPTIMA client will appear and you can use the email address book to select the appropriate email addresses. For more information, see Setting Email Client Options on page 47.

When you have finished, click Close to return to the Report Explorer.

Using the Fast CSV (*.CSV) Option To save time, you also have the option of exporting the file in a fast way using the Fast CSV (*.CSV) option. When you use this option, the details on the Design tab are ignored and only the columns in the Select statement of the SQL query are exported to the CSV file. The Fast CSV option is available only to ReportBuilder reports. It is not available for Excel reports. To use the Fast CSV option: 1 2 3 4 In the Report Explorer, select the report you want to export. Right-click, and from the menu that appears, click Export. In the Export dialog box that appears, select the Fast CSV (*.CSV) option. If you want to export the report to file, click File. In the dialog box that appears, click Yes to confirm. The dialog box informs that the report layout will be ignored and the report will be exported without the details on the Design tab. Browse to the appropriate folder, and click OK. The report is exported. -orIf you want to export the report via email, click Email. In the dialog box that appears, click Yes to confirm. The dialog box informs that the report layout will be ignored and the report will be exported without the details of the Design tab. In the blank email that appears, type the email address(es), appropriate subject title and click Send. 5 When you have finished, click Close to return to the Report Explorer.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 353

When you use the Fast CSV (*.CSV) option, the number of reports exported is equivalent to the number of SQL queries in the Data tab of the Report Designer. The filename of the report that is saved is a combination of the report name and a unique number. For example, if you export a report called Test with three SQL queries, then the filenames of the reports will be: Test.csv Test_1.csv Test_2.csv

Scheduling When Reports Run


You can manage report schedules in the Scheduler Explorer window. If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can: Create schedules Edit schedules Delete schedules Rename schedules View the history of schedules

Creating Folders for Schedules


Before creating a schedule, it is strongly recommended that a file structure is created to aid efficiency. Some examples would be: Match the file structure in Report Explorer Organise by department or by frequency (for example, weekly reports, monthly and so on)

If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can create and delete folders in the Schedule Explorer.

Page 354

AIRCOM OPTIMA User Reference Guide Version 6.2

To create a new folder: 1 From the Reporter menu, click Schedules. - or Click the Schedules button .

The Schedule Explorer appears:

In the Schedule Explorer window, browse to where you want to create the new folder and right-click. From the menu that appears, click New Folder. - or Click the New Folder button .

Type a name for your new folder and press Enter.

OPTIMA_Administrators can restrict access to folders to prevent other users from accessing them. For more information about this, see Restricting Access to Folders on page 356.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 355

Deleting Folders
To delete a folder: 1 2 In the Schedule Explorer window, highlight the folder you want to delete. Right-click and, from the menu that appears, click Delete. - or Click the Delete button 3 .

In the Confirm dialog box, click Yes to delete the folder and return to the Schedule Explorer.

Restricting Access to Folders


If you are an OPTIMA_Administrator, you can restrict access to prevent users who do not have Administrator permissions from editing, moving or deleting folders. To restrict access to a folder: 1 From the Reporter menu, select Schedules. -or Click the Schedules button 2 3 4 .

In the Schedule Explorer, select the folder you want to restrict. Right-click and then, from the menu that appears, click Properties. On the Security tab in the Schedule Folder Properties dialog box, select the Admin Folder checkbox.

5 6

Click OK. If the selected folder has child folders, you will be asked if you want to apply changes to all child folders. This enables you to restrict all of the child folders of an Admin Folder. Click Yes to apply changes, otherwise click No. Follow the previous steps and clear the Admin Folder checkbox.

To remove the restriction from a folder:

Page 356

AIRCOM OPTIMA User Reference Guide Version 6.2

Creating a Schedule for a Report


OPTIMA_Administrators, OPTIMA_Alarm_Administrators or OPTIMA_Advanced_Users can either create a schedule for a report from the Report Explorer or from the Schedule Explorer. To create a report schedule: 1 In the Report Explorer window, right-click the report you want to schedule and, from the menu that appears, click Schedule. or In the Schedule Explorer, right-click the report you want to schedule and, from the menu that appears, click New Schedule. or In the Schedule Explorer, click the New Schedule toolbar button 2 3 .

In the Select Report dialog box, select the report you want to create a schedule for and click Open. In the Schedule Editor dialog box, set the following options:
On this tab/sub-tab General Do this Type a name for the schedule, and a description if required. Ensure the Enable Schedule checkbox is selected otherwise the report will not run. Recurrence In the Pattern pane, select how often you want the report to run. Using the options that appear, select when you want the report to run. In the Range pane, select the start and end date and time. You can also select whether you want the schedule for running the report to: End on a particular date End after the report has run a specific number of times Have no end date If your network spans multiple time zones, select the Use Time Zone option, and from the drop-down list, ensure that you select the time zone against which the schedule will be run. If you do not select this option, the schedule will run according to the database's local time. For more information on time zones in AIRCOM OPTIMA, see Using AIRCOM OPTIMA Across Different Time Zones on page 62. For more information on scheduling reports using time zones, see the AIRCOM OPTIMA Operations and Maintenance Guide. Export Export/Printer Choose where you want the report to be exported by selecting the appropriate Export To checkbox(es). Select the Windows default or a specified printer for the report. You can choose a format for the report from the Export Format drop-down list. The default format is PDF.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 357

On this tab/sub-tab Export/File

Do this Click the Browse button and, in the dialog box that appears, find the client server shared folder, type a name and click Save. Click Add to add the file to the File Names list. You can add as many files as you want. It is important to specify a network path. If you have specified the name of the file as .csv, the Fast CSV checkbox is enabled. You can use this option to export the file in a fast way. When you use this option, the details on the Design tab are ignored and only the columns in the Select statement of the SQL query are exported to the CSV file. When you use the Fast CSV (*.CSV) option, the number of reports exported is equivalent to the number of SQL queries on the Data tab of the Report Designer. The filename of the report that is saved is a combination of the report name and a unique number. The Fast CSV option is available only to ReportBuilder reports. It is not available for Excel reports. If you want to overwrite the same report each time you run the schedule, select the <filename without date stamp> radio button. If you do not want to overwrite the report, select the <filename with date stamp> radio button. Select a date format from the drop-down list and, if you want to specify a date offset, select the Apply Date Offset checkbox and change the offset as required. You can zip the file by selecting the Zip File Before Exporting checkbox.

Export/Email

Click the Select Contacts button, and in the Address Book that appears, select the user(s) and/or group(s) you require and click OK. If you select a group, you are asked to confirm whether you want to export to the individual users in the group or to the group email address. Type a subject line for the email. You can choose a format for the email from the Format drop-down list. If you select the *.CSV option, then the Fast CSV checkbox is enabled. When you use this option, the details of the Design tab are ignored and only the columns in the Select statement of the SQL query are exported to the CSV file. Notes: The Fast CSV option is available only to ReportBuilder reports. It is not available for Excel reports. You can zip the file by selecting the 'Zip file before exporting' checkbox.

Conditions

Set any further conditions for the report schedule. Use SQL, which may contain multiple conditions ('where' clauses). If the SQL returns any results, the schedule is processed. If no results are returned, the schedule is ignored. For example, to schedule a report only if the percentage drops rate for any cell goes above 2%, you would need to add the following code: SELECT COUNT(*) FROM LASTREADING WHERE PDROP > 2 To test the SQL, click Test SQL. Ensure you select the Enable condition on this report if you want the condition to be active.

Parameters

Set any parameter values for the report schedule. To do this either: Select an operator from the drop-down list and type the required values in the Value field. - or If you want to display all of the values, select the Select All checkbox. For more information, see Setting Parameter Values for Reports on page 338.

Page 358

AIRCOM OPTIMA User Reference Guide Version 6.2

Click OK to schedule the report. Notes: If you created the New Schedule from the Report Explorer then you will be prompted to save the schedule to a folder. To do this, select the appropriate folder and click OK. If you have selected the Fast CSV option, click Yes in the confirmation message that appears to save the schedule.

Editing and Deleting Schedules


Editing Schedules To edit a report schedule: 1 2 In the Schedule Explorer, double-click the schedule that you want to edit. The Schedule Editor is displayed. Amend the details and click OK to save the changes.

Renaming Schedules To rename a schedule: 1 2 3 In the Schedule Explorer, double-click the schedule you want to rename. In the Schedule Editor, select the General tab and change the schedule name. Click OK to save the changes.

Deleting Schedules To delete a schedule: 1 2 In the Schedule Explorer, highlight the schedule you want to delete Right-click and from the menu that appears, click Delete. or Click the Delete button .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 359

Copying Schedules
If you are an OPTIMA_Administrator, OPTIMA_Alarm_Administrator or OPTIMA_Advanced_User, you can copy existing report schedules and then modify them. To do this: 1 From the Reporter menu, click Schedules. -or Click the Schedules button 2 .

In the Schedule Explorer, select the schedule(s) you want to copy. Use the Shift and Ctrl keys to select more than one report.

3 4 5

Right-click, and from the menu that appears, click Copy. Select the folder that you want to copy the schedule(s) to. Right-click, and from the menu that appears, click Paste. The schedules are copied to the specified folder.

Viewing and Deleting the History of a Schedule


In the Schedule Explorer you can view the history of a schedule. To do this: Select the schedule for which you want to view the history. The history appears in the Schedule History pane of the Schedule Explorer. This picture shows an example:

To check the current run status of a report, press F5. If the report is currently running, this will be indicated in the Last Run Status. Deleting the History of a Schedule In the Schedule Explorer you can delete the history of a schedule. To do this: 1 2 3 Select the schedule for which you want to clear the history. The history appears in the Schedule History pane of the Schedule Explorer. In the Schedule History pane, right-click and click Clear History. In the Confirm dialog box, click Yes to delete the history.

Page 360

AIRCOM OPTIMA User Reference Guide Version 6.2

CHAPTER 12

Using Alarms
In AIRCOM OPTIMA, there are a number of types of alarm:
Alarm Type Performance Description Performance alarms enable you to set network counter thresholds or key performance indicators (KPIs) and then receive alerts whenever network conditions are not met. Network data is processed, at user defined intervals, by AIRCOM OPTIMA. This data is stored in database tables in the form of counters. Ripple counts are used to define the threshold conditions for setting or clearing alarms. The information from these alarms can be: System Queries in modules and reports Viewed in the Alarms Explorer Passed on to a fault management system

System alarms are alarms raised on AIRCOM OPTIMA events, not performance data events. For an example of a system alarm, see An Example of Defining a System Alarm on page 380.

Threshold Crossing TCAs are loader-specific alarms, which are raised as data is loaded into the AIRCOM OPTIMA database Alert (TCA) using the Loader. They indicate a discrepancy between the expected values according to the defined thresholds and the data loaded into the database after any modification during the loading process. A potential standard use may be to report on NULL values being inserted at load for faster reporting. This needs evaluation against Data Quality Nullness reports.

As well as alarms, AIRCOM OPTIMA also enables you to create alarm handlers, which define how an alarm is 'handled'. Alarm handlers specify: Which contacts are notified when an alarm is raised How the alarm is sent, either by email, SMS (text message) or both Important : OPTIMA_Administrators can configure and view performance and system alarms, and TCA handlers OPTIMA_Alarm_Administrators can only configure and view performance alarms OPTIMA_Advanced_Users and OPTIMA_Users can only view performance alarms

This chapter will describe the configuration of performance and system alarms; for more information about configuring TCAs, see the AIRCOM OPTIMA Operations and Maintenance Guide.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 361

In the Alarms Explorer, the two types of alarm configured in the Explorer Performance and System - are shown on separate tabs:

Performance and System tabs in the Alarms Explorer

In the Alarms Handler Explorer, all types of alarm handler are shown on separate tabs:

Performance, System and TCA tabs in the Alarm Handler Explorer

About Alarm Settings


Before you can define and use an alarm, you must configure a number of components that will make up the alarm definition: Vendors Technologies Element types (performance alarms only) Problem text (not mandatory - you can define your own problem text when defining the alarm, but configuring it here beforehand can save time) Maintenance parameters

You define these settings from menus in the Alarms Explorer. To open the Alarms Explorer: From the Alarms menu, click Alarms. Once defined, these settings can be added to an alarm on the Settings tab of the Alarm Definition dialog box. The settings provide an easy way to sort information in the Alarm Log Viewer.

Page 362

AIRCOM OPTIMA User Reference Guide Version 6.2

Configuring Vendors
In the Vendor Settings dialog box you can create a list of vendors that you can then choose from when you are creating an alarm. To add a vendor: 1 In the Alarms Explorer, from the Config menu, click Vendor. The Vendor Settings dialog box appears:

2 3 4 1 2

From the Alarm Type drop-down list, select the alarm type for which you want to define vendors. Click Add. In the Add Vendor dialog box, type the name of the vendor and click OK. In the Alarms Explorer, from the Config menu, click Vendor. Select the vendor that you want to edit and click Rename. - or Double-click the vendor name.

To edit a vendor name:

3 1 2

Type in the new name for the vendor. In the Alarms Explorer, from the Config menu, click Vendor. Select the required vendor and click Delete.
Page 363

To delete a vendor:

AIRCOM OPTIMA User Reference Guide Version 6.2

Click Yes to confirm.

Configuring Technologies
In the Technology Settings dialog box you can create a list of technologies that you can then choose from when you are creating an alarm. To add a technology: 1 In the Alarms Explorer, from the Config menu, click Technology. The Technology Settings dialog box appears:

2 3 4 1 2

From the Alarm Type drop-down list, select the alarm type for which you want to define the technology. Click Add. In the Add Technology dialog box, type the name of the technology and click OK. In the Alarms Explorer, from the Config menu, click Technology. Select the technology that you want to edit and click Rename - or Double-click the technology name.

To edit a technology name:

Type in the new name for the technology.

Page 364

AIRCOM OPTIMA User Reference Guide Version 6.2

To delete a technology: 1 2 3 In the Alarms Explorer, from the Config menu, click Technology. Select the required technology and click Delete. Click Yes to confirm.

Configuring Element Types


In the Element Type Settings dialog box you can create a list of element types that you can then choose from when you are creating an alarm. Because system alarms are raised on AIRCOM OPTIMA events, rather than performance events, you do not need to define element types for them. To add an element type: 1 In the Alarms Explorer, from the Config menu, click Element Type. The Element Type Settings dialog box appears:

2 3

Click Add. Type the name of the element type and click OK.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 365

To edit an element type: 1 2 In the Alarms Explorer, from the Config menu, click Element Type. Select the element type that you want to edit and click Rename. - or Double-click the element type name. 3 1 2 3 Type in the new name for the element type. In the Alarms Explorer, from the Config menu, click Element Type. Select the element type and click Delete. Click Yes to confirm. To delete an element type:

Configuring Problem Texts


In the Problem Text dialog box, you can create a list of problem text definitions that you can then choose from when you are creating an alarm. You can also choose to create the problem text when creating the rest of the alarm, rather than choosing a pre-defined option. To add a problem text: 1 2 3 4 5 6 In the Alarms Explorer, from the Config menu, click Problem Text. In the dialog box that appears, click Add. In the Name column, type the name of the problem text. In the Definition column, click the empty row. In the text box that appears, click Edit. In the dialog box that appears, type in your definition, either as an SQL query or simple text. If you are using SQL query, check the Override SQL checkbox so that the system knows that the written text is SQL. You can double-click any of the items in the list of tables and columns, Oracle keywords and functions in the Database pane on the right-hand side to help you write the problem text. 7 8 To test that the code works correctly, click Test SQL. If your code is correct, results appear in the bottom pane of the dialog box. Click Save.

Page 366

AIRCOM OPTIMA User Reference Guide Version 6.2

Here is a problem text example for Route congestion alarm: Set Problem Text: FDN:%ELEMENTID DATETIME:%DATE CONGESTION:%LAST(%CONGESTION) OG CALLS:%LAST(%NCALLSO) OG TRAF:%LAST(%OG_TRAF) RIPPLE:%COUNT(%CONGESTION) Result of Set Problem Text: FDN:MSC:MRG05;ROUTE:BRSI-BRSO DATETIME:26-03-2007 12:00:00 CONGESTION:1,09 OG CALLS:2475 OG TRAF:74 RIPPLE:1 Clear Problem Text: %ELEMENTID CLEARED To delete a problem text: 1 2 3 In the Alarms Explorer, from the Config menu, click Problem Text. Select the problem text that you want to delete and click Delete. Click Yes to confirm.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 367

Configuring Alarm Maintenance Parameters


In the Alarm maintenance dialog box, you can configure the parameters that will make up the alarm maintenance routine. This routine can then be scheduled to run periodically. To configure alarm maintenance parameters: 1 In the Alarms Explorer, from the Config menu, click Maintenance. The Alarm maintenance dialog box appears:

2 3

Select the number of days that you want to keep the alarms in the database. The default is 30 days. Select the 'User acknowledgement required for alarms' option if you want the user to acknowledge an alarm before it is removed from the system. The user will only be able to acknowledge an alarm on the AIRCOM OPTIMA web interface. Therefore, you should only select this option only if the web interface is installed on the user's system.

Click OK.

Page 368

AIRCOM OPTIMA User Reference Guide Version 6.2

Defining an Alarm
Before defining an alarm, ensure you have configured the alarm settings. For more information, see About Alarm Settings on page 362. You can define an alarm in one of the following two ways: Define an alarm using a wizard (performance alarms only) Define an alarm using an editor

Defining Performance Alarms Using the Alarms Wizard


To define a performance alarm using the Alarms Wizard: You can only define performance alarms using the Alarms Wizard. If you want to define a system alarm, you must use the Alarms Editor. For more information, see Defining Alarms Using the Alarms Editor on page 374. 1 2 From the Alarms menu, click Alarms. In the Alarms Explorer, click the Create New Alarm Definition button - or In the Alarm Definitions pane, right-click and from the menu that appears, click Add Definition. 3 4 5 In the dialog box that appears, select the Create Performance Alarm with Wizard option, and then click OK. In the dialog box that appears, type the name and description of the alarm. Click Next. .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 369

In the dialog box that appears:


Item Schema, Table, Element Column, Date Column Date Period to be scanned back Description Select the schema, table, element column, and date column that the alarm will monitor.

This determines how far back the data is monitored and is required if any of the following conditions arise: There has been a delay in loading the data into the database The alarm service has not been running.

Element Selection

By default, the alarm will monitor all the network elements of the type selected in the element column. However, you can change the selection to apply the alarm only to a subset of elements. To do so: 1. Select the Filter Elements checkbox. 2. Click Select. The Selection dialog box appears. 3. You can select the elements monitored by the alarm in any one of the following three ways: Element Hierarchy: You can select elements from only one element hierarchy level. Click the Select Hierarchy button to select the element hierarchy. For more information on element hierarchy, see Using the Element Hierarchies Explorer on page 171. Filters: You can apply filters on element hierarchy and select the elements. Click the 'Use filter on element hierarchy' button to select the elements using the filters. For more information on filters, see Applying Filters on page 209. Manual Input: You can manually type element values. Click the Add to Manual Input button to specify the elements manually.

Click Next.

Page 370

AIRCOM OPTIMA User Reference Guide Version 6.2

On the next page of the wizard, define the threshold that the alarm will use:
Option Severity Description This defines the severity of the alarm, if it is raised. Click <Select> to get the Severity drop-down list. You have the following options: Parameter Name and Expression Minor Major Critical Information_Only Intermediate Warning

To add the parameters and expression: Click the AddParameter button to add the parameters and expression for the alarm threshold. The Parameter Editor dialog box opens. You can also click in the Parameter Name column to add a parameter.

In the Parameter Editor dialog box: 1. In the Name text box, type the name of the parameter. 2. From the Data Type drop-down list, select the data type of the parameter. 3. From the Functions pane, select the number, string, date, and custom values for the parameter. 4. From the Operators pane, select the operator. 5. Click OK. You can also right-click in the Threshold dialog box to add or delete a parameter. Operator and Value Set the operator and value for this threshold: 1. Click the Set value button to set the operator and value for the parameters. The Selection dialog box appears. You can also click in the Operator and Value columns to set operator values.

2. From the Operator drop-down list, select the operator for each parameter. 3. In the Values column, type the value for the parameter. 4. Select the Apply to all queries checkbox to apply all the parameters to the queries in the Queries pane on the left-hand side. 5. Click OK. You can also right-click in the Threshold dialog box to set the value. Override the If this option is not checked, the system automatically adds an identical clear parameter parameters for Clear for every set parameter that you create. Select this checkbox if you want to create a separate clear parameter for the set parameters that you create. If this option is selected, then you have the option to click to edit the operator value for the clear parameter. After setting a different value for the clear parameter, if you uncheck this option, a warning message is displayed that the clear parameter will be synchronized with the set parameter. Click Yes to continue. It is mandatory to have at least one set and clear parameter.

Click Next.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 371

10 In the dialog box that appears:


In This Pane Do This Normal: If you select this option, the system raises an alarm for the first time when the SET condition is met. Then it checks for the CLEAR condition. If the CLEAR condition is not met, it keeps checking for the CLEAR condition until it is met. After the CLEAR condition is met, it again checks the SET condition. That means that there is always a pattern SET-CLEAR, SET-CLEAR. Monitor active alarms: If you select this option, the system raises an alarm when the SET condition is met and then checks for the CLEAR condition. If the CLEAR condition is not met, it checks for the SET condition again. If the SET condition is met, it raises a SET alarm. This means that the pattern need not be SET-CLEAR,SETCLEAR as in the normal mode and several SET alarms can be raised before a CLEAR alarm is raised. Alarm Process Mode Select the alarm process mode from any one of the following options:

The option Monitor set on granularity is selected automatically when you select the Monitor active alarms process mode. Select Problem Text You can select an existing problem text from the drop-down list or you can add a new problem text. To add a new problem text: 1. Click Add. The Problem Text dialog box appears. 2. Click Add. 3. In the Name column, type the name of the problem text. 4. In the Definition column, click the empty row. 5. In the text box that appears, click Edit. 6. In the dialog box that appears, type in the SQL code or simple text. If you type simple text, double-click any of the items in the list of tables and columns, Oracle keywords and functions in the Database pane on the right-hand side. If you type the actual code, check the Override SQL checkbox so that the system knows that the written text is SQL. 7. To test that the code works correctly, click Test SQL. If your code is correct, results appear in the bottom pane of the dialog box. 8. Click Save. Vendor, Technology, Select a vendor, technology, and element type. Element Type To add a new vendor, technology, and element type, click the Add button corresponding to the correct row. For more information, see About Alarm Settings on page 362.

11 Click Next. 12 In the dialog box that appears:


In This Pane Alarm Polling Do This Set the rate at which information from the network is tested against the alarm thresholds. To do this: 1. From the Next Polling Date Time menus, select a date and a time from which to run the alarm. 2. From the Alarm Polling Interval menu, select the polling interval frequency and time duration.

13 Click Next.

Page 372

AIRCOM OPTIMA User Reference Guide Version 6.2

14 In the dialog box that appears:


In This Pane Handler Type Do This Select the method via which you want to send the alarm notifications. It can be any of the following methods: Handler Location Select Contacts Email: Alarm notification is sent by email. SMS: Alarm notification is sent by sms. SNMP: Alarm notification is sent by SNMP.

Click the Select button to specify a location to save the alarm handler. To select contacts: 1. Click the Add button to select a contact from the address book. You can search users, groups, and contacts to select your contact. 2. Click OK. 3. Select the Send multiple notifications per email and/or SMS checkbox if you want to send multiple alarm notifications. 4. Select the Apply handler on 'Clear' alarms checkbox if you want to send the notifications for cleared alarms also.

SNMP

This pane is active only if you have select SNMP as your handler type. Select the type of event and probable cause for your alarm from the available lists.

15 Click Next. The Alarm Wizard - Summary dialog box lists all the details of the alarm. You can click any right-hand side menu items to edit your alarm information. As a minimum, you have to specify the Information, Data and Threshold details. This picture shows an example of the Alarm Wizard - Summary dialog box:

16 Click Finish. A new alarm definition is created. 17 When you have defined an alarm, you can activate it. For more information, see Activating an Alarm on page 379.
AIRCOM OPTIMA User Reference Guide Version 6.2 Page 373

Defining Alarms Using the Alarms Editor


You can use the Alarms Editor to define two types of alarm - performance and system. To define either of these: 1 2 From the Alarms menu, click Alarms. In the Alarms Explorer, click the Create New Alarm Definition button - or In the Alarm Definitions pane, right-click and from the menu that appears, click Add Definition. 3 In the dialog box that appears, select the required option, depending on the type of alarm you are creating: Create Performance Alarm with Editor Create System Alarm with Editor To view an example system alarm, see An Example of Defining a System Alarm on page 380. 4 Click OK. .

Page 374

AIRCOM OPTIMA User Reference Guide Version 6.2

The Alarm Definition dialog box appears:

5 6

On the Information tab, type the alarm name and add a description. On the Settings tab:
In This Pane Alarm Process Mode Do This Select the alarm process mode: Normal: If you select the Process Mode for the defined Alarm as Normal, the system raises an alarm for the first time when the SET condition is met. Then it checks for the CLEAR condition. If the CLEAR condition is not met, it keeps checking for the CLEAR condition until it is met. After the CLEAR condition is met, it again checks the SET condition. That means that there is always a pattern SET-CLEAR, SET-CLEAR. Monitor active alarms: If you select the Process Mode for the defined Alarm as Monitor active alarms, the system raises an alarm when the SET condition is met and then checks for the CLEAR condition. If the CLEAR condition is not met, it checks for the SET condition again. If the SET condition is met, it raises a SET alarm. This means that the pattern need not be SET-CLEAR,SET-CLEAR as in the normal mode and several SET alarms can be raised before a CLEAR alarm is raised.

The Monitor set on granularity option is selected automatically when you select the Monitor active alarms process mode, as it is part of this option.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 375

In This Pane Ripple Counts Alarm Severity Vendor, Technology, Element type

Do This Select the ripple counts that will define the thresholds. For more information, see About Ripple Counts on page 381. Select the severity level for your alarm from the list available. If the alarm is triggered, then this is the severity level value that will be stored in the database for the event. Select a vendor, technology and element type. The available options are based on the items defined in the Alarms Settings dialog boxes, and may be different depending on the type of alarm you are defining. For more information, see About Alarm Settings on page 362. For system alarms, you can also select the required AIRCOM OPTIMA module, for example, the ETL Loader. You cannot define an Element type for a system alarm, as this option is not applicable for AIRCOM OPTIMA events.

SNMP

Select the Forward SNMP traps option to send alarm notifications by SNMP to a third-party fault management system. Select the event type and probable cause that will describe the alarm when it is triggered.

On the SQL tab:


In This Pane SQL SET Alarm SQL/ CLEAR Alarm SQL To define the Set Alarm SQL: 1. In the Set Alarm pane, click Set SQL. The Data Explorer launches. 2. Define the SQL query to set an alarm. For more information, see Using the Data Explorer on page 108. Based on the SQL query, the Element ID and Date Time drop-down lists are populated with values. 3. From the Element ID drop-down list, select a value. 4. From the Date Time drop-down list, select a value. 5. Select the counters that you want to include in the problem text. 6. If you are defining a system alarm, select the Process ID that will be used in the SQL query to define the PRID. If you have defined the technology as Oracle or RAC, for example, which have no Process ID, select the Use Technology as Process ID option. To define the Clear Alarm SQL: 1. In the Clear Alarm pane, click Clear SQL. The Data Explorer launches. 2. Define the SQL query to clear an alarm. For more information, see Using the Data Explorer on page 108. Based on the SQL query, the Element ID and Date Time drop-down lists are populated with values. 3. From the Element ID drop-down list, select a value. 4. From the Date Time drop-down list, select a value. Do This

Page 376

AIRCOM OPTIMA User Reference Guide Version 6.2

In This Pane Element Selection

Do This The alarm monitors these elements. By default, this selection includes all the network elements of the type selected in the element column. You can change the selection to apply the alarm only to a subset of elements. To do so: 1. Select the Filter elements checkbox. 2. Click Select. The Selection dialog box appears. 3. You can select the elements monitored by the alarm in any one of the following three ways: Element Hierarchy: You can select elements from only one element hierarchy level. Click the Select Hierarchy button to select the element hierarchy. For more information on element hierarchy, see Using the Element Hierarchies Explorer on page 171. Filters: You can apply filters on element hierarchy and select the elements. Click the 'Use filter on element hierarchy' button to select the elements using the filters. For more information on filters, see Applying Filters on page 209. Manual Selection: You can manually enter element values. Click the Add to Manual Input button to specify the elements manually.

Threshold Severity

This defines the severity of the alarm threshold. From the Severity drop-down list, select a severity for the threshold. You can click <Select> to get the Severity drop-down list.

Operator and Value

To set the operator and value: 1. Click the Set value button to set the operator and value for the parameters. The Selection dialog box appears. 2. From the Operator drop-down list, select the operator for each parameter. 3. In the Values column, type the value for the parameter. 4. Select the Apply to all queries checkbox to apply all the parameters to the queries in the Queries pane on the left-hand side. 5. Click OK. You can also right-click in the Threshold dialog box to add or delete a parameter.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 377

On the Problem Text tab:


In This Pane Do This Problem Text for Define the problem text that will be received when an alarm is raised. SET/CLEARED Alarm You can define the problem text from a predefined list or by creating your own. To define own problem text: 1. Select the Define own problem text checkbox. 2. Click Define. The Problem Text dialog box appears. 3. Type in the text that you want to be sent when an alarm is raised. -orSelect the Override SQL checkbox if you want to include an SQL statement and in the SQL pane, type the code for the problem text. If you type SQL code, double-click any of the items in the list of tables and columns, Oracle keywords and functions in the Database pane on the right-hand side. If you type the actual code, check the Override SQL checkbox so that the system knows that the written text is SQL. 4. To test the code works correctly, click Test SQL. If your code is correct, results appear in the bottom pane of the dialog box. 5. When you have defined the problem text, click Save and then click Yes to confirm. To select problem text from a predefined list: From the drop-down list, select a predefined problem text. -orTo add a new problem text: 1. Click Add. The Problem Text dialog box appears. 2. Click Add. 3. In the new row, type the name of the problem text. 4. In the Definition column, click the empty row. 5. In the text box that appears, click Edit. 6. In the dialog box that appears, type in the SQL code or simple text. 7. Close the window to exit.

On the Schedule tab:


In This Pane Alarm Polling Do This Set the rate at which information from the network is tested against the alarm thresholds. To do this: 1. From the Next Polling Date Time menus, select a date and a time from which to run the alarm. 2. From the Alarm Polling Interval menu, select the polling interval frequency and time duration.

10 When you have finished defining your alarm, click Apply. A new alarm definition is created in the system. As a minimum, you must specify the Information, Data and Threshold details. 11 When you have defined both SET and CLEARED alarms, you can activate the alarm. For more information, see Activating an Alarm on page 379.

Page 378

AIRCOM OPTIMA User Reference Guide Version 6.2

Activating an Alarm
After you have created an alarm, you must activate it to start monitoring the network. You can have as many active alarms as needed at any one time. To do this: 1 2 From the Alarms menu, click Alarms. In the Alarm Definition pane, select the Active checkbox for each alarm you wish to activate. You cannot activate an alarm whose definition is incomplete. It is coloured grey indicating that the alarm definition is incomplete.

Editing and Deleting an Alarm


To edit an alarm: 1 2 In the Alarms Explorer, select the alarm you want to edit. Double-click the alarm. - or Click the Edit Alarm Definition button - or Right-click the alarm name and from the menu that appears, click Edit Alarm Definition. 3 1 2 3 Edit the alarm as necessary and click OK to save the changes. In the Alarms Explorer, select the alarm you want to delete. If the alarm is active, clear the Active checkbox. Click the Delete Alarm Definition button - or Right-click your alarm definition and from the menu that appears, click Delete. 4 In the Confirm dialog box, click Yes to delete the alarm. . To delete an alarm: .

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 379

An Example of Creating a System Alarm


This topic describes a system alarm definition, which is based on the COMMON LOGS table found in the LOGS schema. The logs from all of the mediation devices are loaded into the COMMON LOGS table. The alarm is raised using the following SQL query: SELECT A.PRID, HOST, MAX(A.DATETIME) DATETIME, MAX(SEVERITY) as SEVERITY, COUNT(A.PRID) as TOTAL FROM LOGS.COMMON_LOGS A, (SELECT PRID, MAX(DATETIME) LASTDATE FROM LOGS.COMMON_LOGS WHERE DATETIME BETWEEN SYSDATE-7 AND SYSDATE GROUP BY PRID) B WHERE A.PRID=B.PRID AND A.DATETIME BETWEEN B.LASTDATE-1/24 AND B.LASTDATE AND %PARAM_SEVERITY GROUP BY A.PRID This will query the data in the COMMON LOGS table from the last seven days and return data for each PRID for the hour leading up to the last entry made by that PRID. The outer query will group all the records to the PRID, providing the maximum severity and the number raised. The parameter enables you to select the severity level that you are interested in, filtering out log entries that do not meet the criteria. You could schedule this alarm hourly to return errors for each hour, or set it to a different granularity. Alternatively, you could use a sliding window to only raise an alarm if a new entry meeting the criteria has been entered since the alarm was last processed, this will then return a summary for the last hour, including entries that have previously raised alarms. No new alarm would be raised if no new entry has appeared. The alarm may be configured with 'clear' SQL, which should provide the conditions that would clear any alarms raised by the above 'set' SQL. You can also set the alarm as 'monitor active alarms', which will allow an alarm to be raised each time the 'set' SQL is met, without the need for a 'clear'. The final part of the configuration is the problem text. This can contain the element, date and any counters returned by the SQL query. It can also be based on the output of a separate SQL statement, possibly drilling down into the cause of the alarm. The following is a simple example of a text based entry: %TOTAL(%TOTAL) ERROR(S) FOR PRID:%ELEMENTID AT %DATE. MAXIMUM SEVERITY: %MAXIMUM(%SEVERITY) This would output the following: 3 ERROR(S) FOR PRID:003817001 AT 17-09-2009 22:30:02. Maximum Severity: 6

Page 380

AIRCOM OPTIMA User Reference Guide Version 6.2

About Ripple Counts


Ripple counts are used to define the threshold conditions for setting or clearing alarms. These conditions need to be met continually until the threshold is reached and an alarm is raised. If, at any point the condition is not met, the ripple count is reset and the conditions will have to be met again to raise an alarm. On the Settings tab in the Alarm Definition dialog box, you can define the ripple counts using the up and down arrows. This picture shows an example.

Ripple Count pane

The following is an example of using ripple counts: For a SET alarm query returning 5 or greater Erlangs and a CLEARED alarm query returning 4 or less Erlangs, you specify a SET ripple count of 3 and a CLEARED ripple count of 4. This means that: For a SET alarm to be raised for a particular element in a filter, the element should have an Erlang factor of 5 or more for the next three polling intervals For a CLEARED alarm to be raised for a particular element in a filter, the element should have an Erlang factor of 4 or less for the next four subsequent data granularity periods For information about granularity periods, see Setting the Granularity Period for a Single Table on page 94. This applies to all cells in the filter and with any order of values. So: 1 If the three values 6, 9 and 8 are received, then the SET alarm will be activated on receiving the third value (8). The ripple process will now wait for a CLEARED alarm. If the four values 2, 4, 1 and 3 are received, then the CLEARED alarm will be activated on receiving the fourth value (3). The ripple process will now wait for a SET alarm.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 381

Assigning Alarms to Contacts


After you have created an alarm, you should define an alarm handler for it, which specifies: Which contacts are notified when an alarm is raised How the alarm is sent, either by email, SMS (text message) or both

You can assign multiple alarms to a contact or a group of contacts, and you can also use the same alarm in multiple alarm handlers. Before you can assign an alarm to a contact, the contact must be defined. Only OPTIMA_Administrators can define contacts using the Address Book. For more information, see Using Contacts on page 86.

Creating an Alarm Handler


To create an alarm handler: 1 2 From the Alarms menu, click Alarm Handlers. In the Alarms Handler Explorer, click the Create New Alarm Handler button - or In the Alarm Handler pane (for any tab), right-click and from the menu that appears, click New Alarm Handler. 3 In the dialog box that appears, select the alarm handler type that you want to create, and then click OK: .

The Alarms Handler dialog box appears. 4 On the Information tab, type the handler name and add a description.

Page 382

AIRCOM OPTIMA User Reference Guide Version 6.2

On the Settings tab:


In This Pane Alarm Handler Do This Choose which alarm(s) you want a contact to be notified about. For more information on how to do this, see Selecting the Alarms for an Alarm Handler on page 384. Notification Type Select how you want the contact to be notified when the alarm is raised. If you want the contact to receive an alert for each element within the alarm, select the Send Multiple Notifications Per Email and/or SMS checkbox. You should only use this option if the alarm is monitoring a small number of elements. Amend Alarm Type Select the Apply Handler on CLEAR Alarms checkbox if you want the contact to be notified when an alarm is cleared. The contact will also be notified if the alarm is cleared by the OPTIMA_Administrator.

6 7

On the Contacts tab, click Assign. In the dialog box that appears, select a contact and click Add. The contacts who will receive notification when this alarm is raised are shown in the right-hand pane of this dialog box. To remove a contact from the list, select the name and click Remove. You view detail for a contact or activate a contact so they can receive alarm notifications by selecting their name in the Assign Users dialog box and clicking Properties.

You can now activate the alarm handler so the contact receives the notifications.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 383

Selecting the Alarms for an Alarm Handler


When you are creating an alarm handler, you must select which alarm(s) will use it. The method for this can differ slightly, depending on the type of alarm handler that you are creating. To select the alarms for the handler: 1 2 In the Alarm Handler pane, click the Select button. If you are creating a performance or system alarm handler, the Alarm Definition Selection dialog box appears:

This shows a list of all of the alarms that have been defined on the appropriate tab, either Performance or System.

Page 384

AIRCOM OPTIMA User Reference Guide Version 6.2

If you are creating a TCA handler, the TCA Definition Selection dialog box appears:

This shows a list of all of the TCAs defined in the backend Loader GUI. 3 For all three alarm types, you can select the specific alarms that you want to include in the handler. To do this, in the top pane, select the alarms that you want to add to this handler and then either click the Add button or drag and drop them into the lower pane. You can browse the folder structure on the left-hand side to find the required alarm. - or For TCAs, you can define a mask, and any TCAs that match that mask (for example, all of the TCAs for a particular interface) will be assigned to this handler. This is particularly useful when you know that new TCAs will be added in the future, as any new ones that match the mask will be included automatically without modifying the handler definition. To define a mask: Select the 'Use mask' option Type the required mask based on the PRIDs (in the alarm definition) that you want to include The only regular expressions that you can use are * or %. Any other character will be treated as part of the PRID and therefore be invalid.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 385

Click Display. A list of alarms that currently match the mask and will be included in the handler are shown in the lower pane.

Click OK. The chosen alarms are listed in the Alarm Handler pane:

Activating an Alarm Handler


Before a contact can receive alarm notifications, you must activate the alarm handler. To do this: 1 2 3 Ensure the alarm in each alarm handler is active. For information about activating alarms, see Activating an Alarm on page 379. From the Alarms menu, click Alarm Handlers. In the Alarm Handler pane, select the Active checkbox for each alarm handler you wish to activate.

Enabling Contacts to Receive Alerts


If a contact is not active, they will not receive alerts. OPTIMA_Administrators can activate contacts using the Address Book. For more information, see Using Contacts on page 86. If you are not an OPTIMA_Administrator, you can activate a contact from the Alarm Handler Explorer. To do this: 1 2 3 4 5 From the Alarms menu, click Alarm Handlers. In the dialog box that appears, from the Tools menu, click Contacts. In the Address Book that appears, select the contact you want to activate and click the Edit button . In the Properties dialog box that appears, select the Active checkbox. Click OK and then click Yes to confirm. To activate or deactivate all contacts, right-click the Address Book and from the menu that appears select Activate All or Deactivate All.

Page 386

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing, Clearing and Resetting Alarms


In the Alarms Explorer Viewer pane, on the Alarms tab, you can view the alarms which are not acknowledged by a third party Fault Management System (FMS). This picture shows an example of the Alarms tab:

Alarms Tab

Viewing Alarms The information shown on the Alarms tab includes the following details: Description of the alarm. Element ID. Element type, for example Cell. Alarm Date Time, this is when the data was queried by the alarms program. SQL Date Time, this is the date and time of the data that generated the alarm. Vendor, Technology and Severity as selected when the alarm was defined. Problem Text. Forwarded value. The following table describes the two possible Forwarded values:
Forwarded Value: 0 1 Description: Alarm has not been forwarded to the FMS by the SNMP program. Alarm has been forwarded to the FMS by the SNMP program.

You can customise the way alarm information is displayed by using the tools menu. For more information, see Customising Alarm Information on page 393.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 387

Clearing SNMP Forwarded Alarms If an alarm has been raised and it has been forwarded to the FMS, you can choose to clear that alarm. You can only clear the alarms whose Forwarded value has been set to 1. To do this: 1 In the Alarms tab, select the alarm(s) you want to clear. Use the Shift and Ctrl keys to highlight more than one alarm at a time. 2 Right-click and then, from the menu that appears, click Delete Forwarded Alarms. You can choose to delete all or delete by alarm ID or definition ID. Cleared alarms can be viewed in the Alarms Historical Log tab. Resetting SNMP Forwarded Alarms If an alarm has been raised and it has been forwarded to the FMS, you can choose to reset that alarm. Resetting an alarm sets its Forwarded value back to 0. You might want to do this if there was a problem sending SNMP notifications, for example, during SNMP synchronisation. To do this: 1 In the Alarms tab, select the alarm(s) you want to reset. Use the Shift and Ctrl keys to highlight more than one alarm at a time. 2 Right-click and then, from the menu that appears, click Reset Forwarded Alarms. You can choose to reset all or reset by alarm ID or definition ID.

Page 388

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing and Clearing Alarm Definitions


In the Alarms Explorer Viewer pane, on the Definition Log tab, you can view information about the changes made to alarm definitions. The Definition log tab has two subtabs which are described in the following table:
Sub-Tab Definition log Redundant Definition log Description Shows the log for alarm definitions. Shows the log for deleted and/or non-existing alarm definitions. You can choose to view either all results or results by definition, by selecting the appropriate option from the View Data drop-down list.

This picture shows an example of the Definition log tab:

Definition log tab

Viewing Alarm Definitions The following information is shown in both subtabs on the Definition log tab: A description of the definition The user who made the change to the definition The date and time when the change was made to the definition The action that was performed on the definition

You can customise the way alarm definition information is displayed by using the tools menu. For more information, see Customising Alarm Information on page 393.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 389

Clearing Alarm Definitions To clear alarm definitions in the Definition log subtab: 1 In the Definition Log subtab, select the alarm definition(s) you want to clear. Use the Shift and Ctrl keys to highlight more than one alarm at a time. 2 Right-click and, from the menu that appears, click Clear Items. You can choose to clear one item or all of the items. In the Redundant definition log subtab, select the alarm definition(s) you want to clear. Use the Shift and Ctrl keys to highlight more than one alarm at a time. 2 Right-click and then, from the menu that appears, click Clear Items. You can choose to clear one item or all of the items.

To clear alarm definitions in the Redundant definition log subtab: 1

Viewing and Clearing Alarms History


In the Alarms Explorer Viewer pane, on the Alarms historical log tab, you can view all historical alarms. The Alarms historical log tab has the following two subtabs: Historical alarms which shows the historical log for all generated alarms Redundant alarms log which shows the alarms for deleted and/or non-existing definitions

This picture shows an example of the Alarms historical log tab:

Alarms historical log tab

Page 390

AIRCOM OPTIMA User Reference Guide Version 6.2

Viewing Alarms History The following information is shown in both tabs of the Alarms historical log tab: Description of the alarm Element ID Element type, for example Cell Alarm Date Time, this is when the data was queried by the alarms program SQL Date Time, this is the date and time of the data that generated the alarm Vendor, Technology and Severity as selected when the alarm was defined Problem Text

You can customise the way alarm history information is displayed by using the tools menu. For more information, see Customising Alarm Information on page 393. Clearing Alarms History To clear alarms history in the Historical alarms subtab: 1 In the Historical alarms subtab, select the alarm(s) you want to clear. Use the Shift and Ctrl keys to highlight more than one alarm at a time. 2 Right-click and then, from the menu that appears, point to one of the options described in the following table:
To: Clear one or all items. Manually clear alarms which have been raised and not cleared, for example, if an alarm is in a setting state and its clear conditions have not been met after a long period of time, and the user has acknowledged this and is prepared to close the alarm.

Point to: Clear Items Send ADMIN_CLEAR

To clear alarms history in the Redundant alarms log subtab: 1 In the Redundant alarms log subtab, select the alarm(s) you want to clear. Use the Shift and Ctrl keys to highlight more than one alarm at a time. 2 Right-click and then, from the menu that appears, point to Clear Items. You can choose to clear one item or all of the items.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 391

Viewing Alarms Run History


In the Alarms Explorer Viewer pane, on the Run History tab, you can view alarm processing messages for the alarms that you have selected in the Alarm Definitions pane. This picture shows an example of the Run History tab for the alarms:

Run history tab

The following table shows the various parameters and their description:
Parameter Message Date and Time Definition ID Element Ripple Status Number Ripple Count Number Data Modified Date Last Date Message Severity Number Description Message for the alarm Date and Time at which the alarm was created Definition ID of the alarm Element for which the alarm is raised Indicates whether the alarm is set or clear: 0 = clear, 1 = set Indicates the ripple counts for the alarm Date at which the alarm was created Last date when the input table was updated in the database Indicates the level of severity of the message. The available options are: 1 - Debug 2 - Information 3 - Warning 4 - Minor 5 - Major 6 - Critical

Page 392

AIRCOM OPTIMA User Reference Guide Version 6.2

Customising Alarm Information


In the Alarms Explorer Viewer pane, information is displayed in grid format. You can customise the way this information is displayed by using the tools menu. For more information, see About the Tools for Customising a Grid on page 230.

Sorting Alarm Information by Column


To sort alarm information using the column headings: Click the heading for the column by which you wish to sort the data. If you want to sort by more than one column, hold down the Shift key and click the heading for each column by which you want to sort the data. To see by which column data in the grid is sorted, look for the arrow in the column heading. An up arrow indicates data is in ascending order and a down arrow indicates data is in descending order. To change the position of a column: Select the column and drag it to the desired location.

About the Alarms Backend Applications


The alarms you define in AIRCOM OPTIMA are processed by two backend applications: The Alarms Service checks the next schedule date of each alarm and then processes and updates any alarm whose schedule date is due The Alarm Notifier polls the database for recently raised alarms and sends alarm notifications via email or SMS

You can find detailed information about installing and configuring the alarms backend applications in the AIRCOM OPTIMA Operations and Maintenance (O&M) Guide. Please contact AIRCOM International Support to obtain the latest version of the O&M Guide. For contact details, see Obtaining AIRCOM Support on page 18.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 393

Troubleshooting
The following table shows troubleshooting tips for AIRCOM OPTIMA alarms:
Symptom When trying to edit an alarm definition, the severity, vendor and technology combo boxes are empty. Possible Causes Synonym, Grant missing for the tables : 'ALARM_VENDORS', 'ALARM_TECHNOLOGY', 'ALARM_ELEMENT_TYPE', 'PROBABLE_CAUSE' Rows deleted from these tables. Does not receive Alarms SMS Wrong option selected in Alarm Handler but receive Alarms email GUI Make sure that the right option is selected in Alarm Handler definition Solution Make sure that these tables have proper synonyms, grants and also they have all the rows from the original installation.

Insufficient privileges error message in the log when opening Alarm Handler Explorer

Insufficient privileges/ Not enough access rights on the tables

Check the table access privileges. Run the necessary scripts. If the database is installed from a production template this should not happen. Check the file and see which query has failed. This might give a clue as to which table has the grants missing

The ALARM definition is shown as active but in the Alarm definition window, the Alarm status is inactive The ALARM definition. is shown as active but no alarm is triggered and the Next Schedule Date is not updated

Expected behaviour.

Expected behaviour. A definition is made inactive when it is opened for editing and cannot be edited when the alarm is being processed. Remove the double quoted alias from the SET SQL. Will be providing a better solution soon. CREATE PUBLIC SYNONYM SNMP_PKG FOR AIRCOM.SNMP_PKG;

This can be a problem with the SET SQL query. The SQL with double quoted ALIAS works fine through the TEST SQL button but gives Oracle error Missing Expression in the trace file.

Right-click Alarm Explorer Synonym missing for SNMP package window and select either delete or reset forwarded alarms. It generates the following error message: PLS-00201: identifier 'SNMP_PKG.DEL_FWD_ ALARMS_ALL' must be declared. Keeps on repeating same alarm and inbox is filled with same SMS alarm issue The wrong option for Process Mode might be selected. If the Process Mode for the defined Alarm is set to be Continuous the alarm will be raised whenever the SET condition is met , even if the clear condition is not met after a set.

Select the Normal mode if that serves the purpose. If the Process Mode for the defined Alarm is set to be Normal, the program raises an alarm (once) when the Set condition is met and the alarm will not be raised again until the Clear condition is met for that alarm. Check if the Process Mode is set to Normal.( This is in the Alarm definition Settings tab

Page 394

AIRCOM OPTIMA User Reference Guide Version 6.2

Symptom Alarms not being generated and receiving Oracle error911 in the alarmservice trace file when using % sign in the alias in Set SQL definition.

Possible Causes The problem was not using the % in double quoted alias in the SET SQL. After defining the SET SQL, when you map the counters bought back by the SQL, if the values list contains the alias with %, this was not handled properly by the Alarms package.

Solution Install the latest version of AIRCOM OPTIMA Alarms package

Problem text not working when using the Override SQL option. Blank results in the problem text column.

User was using the %Date placeholder in the where clause of the SQL statement. Need to have a to_date conversion in front of it as the user was comparing it with a date column.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 395

Page 396

AIRCOM OPTIMA User Reference Guide Version 6.2

APPENDIX A

Licensing Your Software


The licensing of ENTERPRISE installations will normally be carried out by you, the administrator, on behalf of numerous users via a software-based licensing system called SafeNet Sentinel. Your order for ENTERPRISE will entitle you to a number of licences which you can activate using the Licence Fulfilment Wizard provided.

About Licensing Your Software


Before you can use the Licence Fulfilment Wizard, lock codes must be created. For more information see Generating Lock Codes on page 398. If you intend to use network licences you must create a software licence server. You can do this before installing ENTERPRISE if you wish. For more information see Installing a Software Licence Server on page 399. You can then use the Licence Fulfilment Wizard to generate, migrate or renew your licences either online or manually. This table shows which section to read under what circumstances:
See Generating New Licences Online on page 402 If You have installed ENTERPRISE for the first time and/or you do not have a currently licensed installation. You want to carry out the process online. You have a version of ENTERPRISE name which is currently licensed with a hardware dongle or via node locking. You want to carry out the process online. You wish to extend the validity of your software based licences. You want to carry out the process online. You have installed ENTERPRISE for the first time and/or you do not have a currently licensed installation. You do not want to carry out the process online. You have a version of ENTERPRISE which is currently licensed with a hardware dongle or via node locking. You do not want to carry out the process online. You wish to extend the validity of your software based licences. You do not want to carry out the process online.

Migrating Existing Licences Online on page 400

Renewing Licences Online on page 404 Generating New Licences Manually on page 407

Migrating Existing Licences Manually on page 405

Renewing Licences Manually on page 409

When you have completed the licensing process you will no longer need your dongle. Please make sure that you return your dongle to Product Support.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 397

Generating Lock Codes


When you use the Licence Fulfilment Wizard you will need to type a lock code for each machine on which there is a stand-alone installation of ENTERPRISE and for each machine that is to be used as a network server. The lock code must be created by running the Lock Code Generator on each user machine and/or each network server. To do this: 1 Click on Start/All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Locking Code Generator. The Lock Code Generator dialog box appears and a lock code is generated automatically. Make a note of the code displayed in the Lock Code field:

Click Close.

You can get your users to run the Lock Code Generator on their machines and tell you the resultant codes. You will also need to know the hostname of each machine. These names and codes can be entered into the Licence Fulfilment Wizard either individually or, if you create one from them, as a .csv file. The lock code produced by the Lock Code Generator uses your Hard Disk Identity by default as one of its lock criteria. If for any reason different criteria are required, Product Support will inform you of this by email after you have run the Licence Fulfilment Wizard. If different criteria are required, you will need to: 1 2 3 4 5 Re-open the Lock Code Generator. Select the Override checkbox. Type the code supplied by Product Support into the Lock Criteria field. Click Update. A new code will appear in the Lock Code field. Either re-run the Licence Fulfilment Wizard and on the Locking Codes page, use the new lock code or codes, select the overridden locking criteria option and type the Lock Criteria code supplied by Product Support into the adjacent field. - or Email a file of comma-separated values with details of your server names and corresponding revised lock codes to Product Support. For contact details see Obtaining Support.

Page 398

AIRCOM OPTIMA User Reference Guide Version 6.2

Installing a Software Licence Server


If your ENTERPRISE users are going to be licensed with Network licences rather than stand-alone client-based licences, you must set up a software licence server. To do this: 1 Install the licence server software. This is available on your ENTERPRISE installation disk or from the AIRCOM website. Run the setup executable and complete the installation wizard. Click Start/Control Panel. Double-click Administrative Tools. Double-click Services. Ensure that there is a service called AIRCOM Software Licensing Server listed, that it has a Status of Started and a Startup Type of Automatic. The service will not run successfully if you attempt to run it on a Virtual Machine System.

2 3 4 5

Using the Licence Reader


If you have a version of ENTERPRISE which is currently licensed with a hardware dongle or via node locking and you wish to migrate your licences to the softwarebased licensing system, you can use of the Licence Reader application. The purpose of the Licence Reader is to transfer details of existing licences to the Licence Fulfilment Wizard. As an administrator you will normally use the Licence Reader while using the Licence Fulfilment Wizard. In this case licence details are transferred directly to the Wizard page. However you may also need to get users who have ENTERPRISE installed on stand-alone machines to use the Licence Reader as a separate application. These users can then send you the report files produced so that you can load them into the Licence Fulfilment Wizard. To use the Licence Reader while using the Licence Fulfilment Wizard: 1 2 On the "Migration from previous licence system" page, click Launch Reader. In the Licence Type Pane of the Licence Migration Version 1.0.0 dialog box: If you wish to transfer details of licences based on a local dongle, click Local. - or If you wish to transfer details of licences based on a network dongle, click Network. - or If you wish to transfer details of licences based on your node locking setup, click Node Lock. Whichever button you click, the associated details appear in the dialog box.
AIRCOM OPTIMA User Reference Guide Version 6.2 Page 399

Click Report. The licence details are transferred to the "Migration from previous licence system" page and the Licence Reader is closed. Double-click HASPMigration.exe in the Program Files/AIRCOM International/ENTERPRISE/Licensing Utilities folder on your local drive. In the Licence Type Pane of the Licence Migration Version 1.0.0 dialog box: If you wish to transfer details of licences based on a local dongle, click Local. - or If you wish to transfer details of licences based on a network dongle, click Network. - or If you wish to transfer details of licences based on your node locking setup, click Node Lock. Whichever button you click, the associated details appear in the dialog box.

To use the Licence Reader as a separate application: 1 2

3 4

Click Report. You are prompted to save the returned details to a report file (.lmr) by the appearance of a Save As dialog box. Save the file: Select the folder where the file is to be saved Type a name for the file in the File name field Click Save

5 6

Close the Licence Migration Version 1.0.0 dialog box. Send the report file to the system administrator who can use the Load Report File button on the "Migration from previous licence system" page to transfer the details of your licence into the Licence Fulfilment Wizard.

Migrating Existing Licences Online


If you have a version of ENTERPRISE name that is currently licensed with a hardware dongle or via node locking you will need to migrate the existing licences to the new software licensing system. To migrate existing licences online: 1 2 3 4 5 6 Click Start. Click All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Software Licence Fulfilment Wizard. The Licence Fulfilment Wizard begins. Select Yes to indicate that you wish to migrate your licences online. Click Next. On the Licence Request Type page, select Migration (from Dongle or Node Lock). Click Next.

Page 400

AIRCOM OPTIMA User Reference Guide Version 6.2

On the "Migration from previous licence system" page, type your Customer ID. This is provided by Product Support. If you need to contact Product Support, see the contact details under Obtaining Support. You must now transfer the details of your existing licences to the "Migration from previous licence system" page as described under Using the Licence Reader on page 399. You can use the Launch Reader and Load Report File buttons to transfer details of multiple licences, but you cannot include details of more than one licence type, for example network and local, in a single run of the Licence Fulfilment Wizard.

On the Migration from previous licence system page, click Next.

10 If you opted to transfer details of a Local or Node Lock licence with the Licence Reader, you can skip this step. If you opted to transfer details of a Network licence with the Licence Reader, the "Server based licence options" page appears. This table explains the options available:
Select This Checkbox Enable Commuter Licensing So That A user can check out a licence from the network server for a number of days from 1 to 30, or with no limit. This token is then reserved and transferred to the local machine, it remains out of use on the network server until either the licence is checked back in or the commuter licence reaches the expiry date. If the commuter licence reaches its expiry date it will not work on the machine it was transferred to and is automatically released back into the network server's available token list. The licence server does not automatically relinquish a held token back into the available pool when the application exits. It will stay allocated for a configurable period of time until the time runs out or the application reconnects. If the application reconnects from the same user and machine they will get that token back even if no licences are shown as free. If the application does not reconnect before the end of the held period then the user must request a new token. If all available licences have since been used up, a new token will not be available. The created licence can be locked against multiple servers which when properly configured will form a server pool. The server pool will service licence token distribution and provide redundancy should one or more of the servers go down. When this is enabled you will need lock codes for all of the server machines to be used and the configuration must be done on the servers themselves.

Enable Hold Licensing

Enable Redundant Server Usage

Select the options you require and click Next. None of these options are likely to be required by WEBWIZARD only users. 11 On the Locking Codes page, click Add. 12 In the Add Machine Details dialog box, type the name of a stand-alone client or server and the lock code that you created for it as described under Generating Lock Codes on page 398, then click Add.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 401

If you are generating licences for a number of clients or servers on which the Lock Code Generator has been run, you can: Repeat the previous step and this one for each server. - or Use the Load button to import a file of comma separated values with details of the server names and corresponding lock codes. You will need to have created such a file from the results of running the Lock Code Generator.

13 On the Locking Codes page, click Next. 14 The Web Licensing Fulfilment page appears. If a cross appears by any of the status lines and error message appears in the Result field, the Back button is enabled so that you can make changes to your previous Wizard entries and then try for licence fulfilment again. If all the status lines are ticked and Successful appears in the Result field, click Next. 15 On the Completing the Licence Fulfilment Wizard page, click Save Licences. If you have chosen a network licence, select a backup location. If you have chosen a Local or Node Lock licence you are required to save a file called lservrc at this point. Save this file in the folder where your licence.ini file is located (normally C:\Program Files\AIRCOM International\ENTERPRISE\Common). 16 Click Finish.

Generating New Licences Online


If you have installed ENTERPRISE for the first time and/or you do not have a currently licensed installation, you will need to license your software. To generate new licences online: 1 2 3 4 5 6 7 Click Start. Click All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Software Licence Fulfilment Wizard. The Licence Fulfilment Wizard begins. Select Yes to indicate that you wish to generate your licences online. Click Next. On the Licence Request Type page, select New. Click Next. On the Order Information page, type your Customer ID and Order ID. These are provided by Product Support. If you need to contact Product Support, see the contact details under Obtaining Support. Select the type of licence required. This can be network server based or a standalone client based as befits your order. On the Order Information page, click Next.
AIRCOM OPTIMA User Reference Guide Version 6.2

8 9
Page 402

10 If you opted to generate a stand-alone client-based licence on the Order Information page, you can skip this step. If you opted to generate a Network licence on the Order Information page, the "Server based licence options" page appears. This table explains the options available:
Select This Checkbox Enable Commuter Licensing So That A user can check out a licence from the network server for a number of days from 1 to 30, or with no limit. This token is then reserved and transferred to the local machine, it remains out of use on the network server until either the licence is checked back in or the commuter licence reaches the expiry date. If the commuter licence reaches its expiry date it will not work on the machine it was transferred to and is automatically released back into the network server's available token list. The licence server does not automatically relinquish a held token back into the available pool when the application exits. It will stay allocated for a configurable period of time until the time runs out or the application reconnects. If the application reconnects from the same user and machine they will get that token back even if no licences are shown as free. If the application does not reconnect before the end of the held period then the user must request a new token. If all available licences have since been used up, a new token will not be available. The created licence can be locked against multiple servers which when properly configured will form a server pool. The server pool will service licence token distribution and provide redundancy should one or more of the servers go down. When this is enabled you will need lock codes for all of the server machines to be used and the configuration must be done on the servers themselves.

Enable Hold Licensing

Enable Redundant Server Usage

Select the options you require and click Next. None of these options are likely to be required by WEBWIZARD only users. 11 On the Locking Codes page, click Add. 12 In the Add Machine Details dialog box, type the name of a stand-alone client or server and the lock code that you created for it as described under Generating Lock Codes on page 398, then click Add. If you are generating licences for a number of clients or servers on which the Lock Code Generator has been run, you can: Repeat the previous step and this one for each server. - or Use the Load button to import a file of comma separated values with details of the server names and corresponding lock codes. You will need to have created such a file from the results of running the Lock Code Generator.

13 On the Locking Codes page, click Next. 14 The Web Licensing Fulfilment page appears. If a cross appears by any of the status lines and error message appears in the Result field, the Back button is enabled so that you can make changes to your previous Wizard entries and then try for licence fulfilment again.
AIRCOM OPTIMA User Reference Guide Version 6.2 Page 403

If all the status lines are ticked and Successful appears in the Result field, click Next. 15 On the Completing the Licence Fulfilment Wizard page, click Save Licences. If you have chosen a network licence, select a backup location. If you have chosen a stand-alone licence you are required to save a file called lservrc at this point. Save this file in the folder where your licence.ini file is located (normally C:\Program Files\AIRCOM International\ENTERPRISE\Common). 16 Click Finish.

Renewing Licences Online


You can extend the validity of your software based licences. To renew your existing licences online: 1 2 3 4 5 6 7 Click Start. Click All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Software Licence Fulfilment Wizard. The Licence Fulfilment Wizard begins. Select Yes to indicate that you wish to renew your licence online. Click Next. On the Licence Request Type page, select Renewal. Click Next. On the Order Information page, type your Customer ID and Order ID. These are provided by Product Support. If you need to contact Product Support, see the contact details under Obtaining Support. Click Next. The Web Licensing Fulfilment page appears. If a cross appears by any of the status lines and error message appears in the Result field, the Back button is enabled so that you can make changes to your previous Wizard entries and then try for licence fulfilment again. If all the status lines are ticked and Successful appears in the Result field, click Next.

8 9

10 On the Completing the Licence Fulfilment Wizard page, click Save Licences. If you have chosen a network licence, select a backup location. If you have chosen a stand-alone licence you are required to save a file called lservrc at this point. Save this file in the folder where your licence.ini file is located (normally C:\Program Files\AIRCOM International\ENTERPRISE\Common). 11 Click Finish.

Page 404

AIRCOM OPTIMA User Reference Guide Version 6.2

Migrating Existing Licences Manually


If you have a version of ENTERPRISE name that is currently licensed with a hardware dongle or via node locking you will need to migrate the existing licences to the new software licensing system. To migrate existing licences manually: 1 2 3 4 5 6 7 Click Start. Click All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Software Licence Fulfilment Wizard. The Licence Fulfilment Wizard begins. Select No to indicate that you wish to migrate your licences manually. Click Next. On the Licence Request Type page, select Migration (from Dongle or Node Lock) . Click Next. On the "Migration from previous licence system" page, type your Customer ID. This is provided by Product Support. If you need to contact Product Support, see the contact details under Obtaining Support. You must now transfer the details of your existing licences to the "Migration from previous licence system" page as described under Using the Licence Reader on page 399. You can use the Launch Reader and Load Report File buttons to transfer details of multiple licences, but you cannot include details of more than one licence type, for example network and local, in a single run of the Licence Fulfilment Wizard. 9 On the "Migration from previous licence system" page, click Next. 10 If you opted to transfer details of a Local or Node Lock licence with the Licence Reader, you can skip this step. If you opted to transfer details of a Network licence with the Licence Reader, the "Server based licence options" page appears. This table explains the options available:
Select This Checkbox Enable Commuter Licensing So That A user can check out a licence from the network server for a number of days from 1 to 30, or with no limit. This token is then reserved and transferred to the local machine, it remains out of use on the network server until either the licence is checked back in or the commuter licence reaches the expiry date. If the commuter licence reaches its expiry date it will not work on the machine it was transferred to and is automatically released back into the network server's available token list. The licence server does not automatically relinquish a held token back into the available pool when the application exits. It will stay allocated for a configurable period of time until the time runs out or the application reconnects. If the application reconnects from the same user and machine they will get that token back even if no licences are shown as free. If the application does not reconnect before the end of the held period then the user must request a new token. If all available licences have since been used up, a new token will not be available.

Enable Hold Licensing

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 405

Select This Checkbox Enable Redundant Server Usage

So That The created licence can be locked against multiple servers which when properly configured will form a server pool. The server pool will service licence token distribution and provide redundancy should one or more of the servers go down. When this is enabled you will need lock codes for all of the server machines to be used and the configuration must be done on the servers themselves.

Select the options you require and click Next. None of these options are likely to be required by WEBWIZARD only users. 11 In the Add Machine Details dialog box, type the name of a stand-alone client or server and the lock code that you created for it as described under Generating Lock Codes on page 398, then click Add. If you are generating licences for a number of clients or servers on which the Lock Code Generator has been run, you can: Repeat the previous step and this one for each server. - or Use the Load button to import a file of comma separated values with details of the server names and corresponding lock codes. You will need to have created such a file from the results of running the Lock Code Generator.

12 On the Locking Codes page, click Next. 13 The "Completing the Licence Fulfilment Wizard" page appears. Click Generate Request File. 14 Save the request file (.lrq) and email it to Product Support. For the email address, see Obtaining Support. 15 Click Finish. 16 You will receive a licence response (.lrp) file from Product Support containing your licence. Save this file to a folder. 17 To install the licence, re-start the Licence Fulfilment Wizard and on the Welcome page, select Install from file. 18 Click Browse and select the licence response file from the folder where you saved it. 19 Click Next. 20 The "Completing the Licence Fulfilment Wizard" page appears. If any error messages are shown on this page, inform Product Support. For contact details, see Obtaining Support. Click Save Licences. If you have chosen a network licence, select a backup location. If you have chosen a Local or Node Lock licence you are required to save a file called lservrc at this point. Save this file in the folder where your licence.ini file is located (normally C:\Program Files\AIRCOM International\ENTERPRISE\Common). 21 Click Finish.

Page 406

AIRCOM OPTIMA User Reference Guide Version 6.2

Generating New Licences Manually


If you have installed ENTERPRISE for the first time and/or you do not have a currently licensed installation, you will need to license your software. To generate new licences manually: 1 2 3 4 5 6 7 Click Start. Click All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Software Licence Fulfilment Wizard. The Licence Fulfilment Wizard begins. Select No to indicate that you wish to generate your licences manually. Click Next. On the Licence Request Type page, select New. Click Next. On the Order Information page, type your Customer ID and Order ID. These are provided by Product Support. If you need to contact Product Support, see the contact details under Obtaining Support. Select the type of licence required. This can be network server based or a standalone client based as befits your order. On the Order Information page, click Next.

8 9

10 If you opted to generate a stand-alone client-based licence on the Order Information page, you can skip this step. If you opted to generate a Network licence on the Order Information page, the "Server based licence options" page appears. This table explains the options available:
Select This Checkbox Enable Commuter Licensing So That A user can check out a licence from the network server for a number of days from 1 to 30, or with no limit. This token is then reserved and transferred to the local machine, it remains out of use on the network server until either the licence is checked back in or the commuter licence reaches the expiry date. If the commuter licence reaches its expiry date it will not work on the machine it was transferred to and is automatically released back into the network server's available token list. The licence server does not automatically relinquish a held token back into the available pool when the application exits. It will stay allocated for a configurable period of time until the time runs out or the application reconnects. If the application reconnects from the same user and machine they will get that token back even if no licences are shown as free. If the application does not reconnect before the end of the held period then the user must request a new token. If all available licences have since been used up, a new token will not be available. The created licence can be locked against multiple servers which when properly configured will form a server pool. The server pool will service licence token distribution and provide redundancy should one or more of the servers go down. When this is enabled you will need lock codes for all of the server machines to be used and the configuration must be done on the servers themselves.

Enable Hold Licensing

Enable Redundant Server Usage

Select the options you require and click Next. None of these options are likely to be required by WEBWIZARD only users.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 407

11 On the Locking Codes page, click Add. 12 In the Add Machine Details dialog box, type the name of a stand-alone client or server and the lock code that you created for it as described under Generating Lock Codes on page 398, then click Add. If you are generating licences for a number of clients or servers on which the Lock Code Generator has been run, you can: Repeat the previous step and this one for each server. - or Use the Load button to import a file of comma separated values with details of the server names and corresponding lock codes. You will need to have created such a file from the results of running the Lock Code Generator.

13 On the Locking Codes page, click Next. 14 The "Completing the Licence Fulfilment Wizard" page appears. Click Generate Request File. 15 Save the request file (.lrq) and email it to Product Support. For the email address, see Obtaining Support. 16 Click Finish. 17 You will receive a licence response (.lrp) file from Product Support containing your licence. Save this file to a folder. 18 To install the licence, re-start the Licence Fulfilment Wizard and on the Welcome page, select Install from file. 19 Click Browse and select the licence response file from the folder where you saved it. 20 Click Next. 21 The "Completing the Licence Fulfilment Wizard" page appears. If any error messages are shown on this page, inform Product Support. For contact details, see Obtaining Support. Click Save Licences. If you have chosen a network licence, select a backup location. If you have chosen a stand-alone licence you are required to save a file called lservrc at this point. Save this file in the folder where your licence.ini file is located (normally C:\Program Files\AIRCOM International\ENTERPRISE\Common). 22 Click Finish.

Page 408

AIRCOM OPTIMA User Reference Guide Version 6.2

Renewing Licences Manually


You can extend the validity of your software based licences. To renew your existing licences manually: 1 2 3 4 5 6 7 Click Start. Click All Programs/AIRCOM International/ENTERPRISE/Licensing Tools/Software Licence Fulfilment Wizard. The Licence Fulfilment Wizard begins. Select No to indicate that you wish to renew your licences manually. Click Next. On the Licence Request Type page, select Renewal. Click Next. On the Order Information page, type your Customer ID and Order ID. These are provided by Product Support. If you need to contact Product Support, see the contact details under Obtaining Support. Click Next. The "Completing the Licence Fulfilment Wizard" page appears. Click Generate Request File.

8 9

10 Save the request file (.lrq) and email it to Product Support. For the email address, see Obtaining Support. 11 Click Finish. 12 You will receive a licence response (.lrp) file from Product Support containing your licence. Save this file to a folder. 13 To install the licence, re-start the Licence Fulfilment Wizard and on the Welcome page, select Install from file. 14 Click Browse and select the licence response file from the folder where you saved it. 15 Click Next. 16 The "Completing the Licence Fulfilment Wizard" page appears. If any error messages are shown on this page, inform Product Support. For contact details, see Obtaining Support. Click Save Licences. If you have chosen a network licence, select a backup location. If you have chosen a stand-alone licence you are required to save a file called lservrc at this point. Save this file in the folder where your licence.ini file is located (normally C:\Program Files\AIRCOM International\ENTERPRISE\Common). 17 Click Finish.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 409

Monitoring Your Software Licence Server


If you are using network licences and you have installed your licence server and generated your licences, you can view and edit your licence server details. To monitor your software licence server: 1 2 3 4 5 6 7 Click Start/All Programs/AIRCOM International/Licence Server/Software Licensing Administrator. In the WlmAdmin window that appears, on the Edit menu, click Defined Server List. In the Server field of the Defined Server List dialog box that appears, type the name of your licence server. Click Add. Click OK. In the left hand pane of the WlmAdmin window, click the plus sign adjacent to Defined Servers. Click your licence server in the left pane and the details associated with it appear in the right pane. To store your server name so that it is visible in the WlmAdmin window in future: 1 2 3 In the WlmAdmin window, on the Edit menu, click Preferences. Select the "Discover defined servers on startup" option. Click OK.

Setting Up Redundant Servers


If your users are provided with network licences you may wish to set up backup servers to supply licences in the event that your normal licence server fails. To do this: 1 2 3 4 5 6 7 Install the licence server software on each backup server. For more information on how to do this, see Installing a Software Licence Server on page 399. On your normal licence server, click Start/All Programs/AIRCOM International/Licence Server/Redundant Server setup Tool. In the WrlfTool window that appears, from the File menu, select New. Click Add Server. In the Add Server to Pool dialog box type the name and IP address of an alternative server. Click OK. Your server is listed in the WrlfTool window. Repeat steps 3 to 5 until you have a minimum of 3 servers listed. The maximum number you can add is 11.

Page 410

AIRCOM OPTIMA User Reference Guide Version 6.2

The order in which the servers appear on the list is the order in which they will be called upon if the normal licence server fails. You can change this order using the Move Up and Move Down buttons. If more than half the listed servers go down, the licence server software stops working. 8 9 In the WrlfTool window, from the File menu, select Save As. In the Save As dialog box that appears, from the "Save in" drop down field, select the folder where your normal licence server is installed. By default this is C:/Program Files/AIRCOM International/Licence Server.

10 Click Save. The lservrlf licence file is stored in the specified location. 11 Copy the lservrlf licence file to the same location on each of your listed backup servers. 12 Restart the AIRCOM Software Licensing Server service on all licence server machines. For more information on accessing services, see Installing a Software Licence Server on page 399.

About Network Licensing Strategies


By default, ENTERPRISE obtains licences for all installed products regardless of an individual user's need. If for example you have forty users half of whom use only ASSET while the other half use only CONNECT, you will need twenty licences for each product. However if you install both products on all forty machines and all the ASSET users log on first, those users will also get the CONNECT licences and the CONNECT users will be unable to log on. To prevent this from happening, there are three approaches that you can take to ensure efficient licence distribution. These are: Strategy A - to install only the products that a single user needs on each machine. Strategy B - to install all the products on all the machines and instruct the users to use the Licence Administrator dialog box within ENTERPRISE to limit the licences they receive. Strategy C - to install all the products on all the machines and use registry settings to control which licences are obtained by which users. This approach is appropriate for single user desktop and laptop use and also for a Citrix environment.

Which of these strategies you adopt will be determined by the type of installation and whether or not you want the user to be involved in licence allocation. This table shows which strategies are possible under which circumstances.
This Strategy A B C Can be used for a single user desktop Yes Yes Yes Can be used for a shared desktop No Yes Yes Can be used for an application server No No Yes

Strategy A, involving the installation of only those products that a user needs, requires no further explanation.
AIRCOM OPTIMA User Reference Guide Version 6.2 Page 411

For further information on Strategy B see Using Licence Administrator (Strategy B) on page 412. For further information on Strategy C see Using Registry Files (Strategy C) on page 417.

Using Licence Administrator (Strategy B)


You can access the Licence Administrator from the ENTERPRISE Help menu. This picture shows an example of the Licence Administrator:

Licence Administrator

Once you have used Licence Administrator to obtain licences for your ENTERPRISE software after installation, you can subsequently use it to: Set the default licensing behaviour on ENTERPRISE startup. View the licence details currently associated with a particular product. Get licences for individual products. Drop licences for individual products. Check out commuter licences for individual products. Check in commuter licences for individual products.

Page 412

AIRCOM OPTIMA User Reference Guide Version 6.2

Setting the Startup Licensing Behaviour


To use Licence Administrator to set the licensing behaviour that will be applied when ENTERPRISE starts up: 1 2 Click on the down arrow in the Startup Option field to display the available options. Select:
This option Prompt at startup Auto get last licences Auto get all To do this Display the Licence Administrator dialog box when ENTERPRISE starts up so that the user can specify the licences they require using the Get Licence and Drop Licence buttons. Obtain the licences that the user had in the previous session. Attempt to obtain licences for all modules installed on the machine.

Click Close. The setting selected is stored within the current user configuration and takes effect whenever the user starts ENTERPRISE.

Viewing Licence Details for Individual Products


To access the details of your licence: Double-click the product name. The Licence Details dialog box appears:

Licence Details dialog box

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 413

This table provides further information on the licence details:


This Field Issuing Server Licence Type Indicates The IP address or hostname of the server that issued the licence token (appears only for a network licence). The type of licence. This can be: Licence Valid From Date Licence Expiration Date Licence obtained at Licence will release at Normal a standard licence Perpetual a never expiring stand-alone licence Grace a grace licence which will expire once the Grace Period Elapsed Time Usage has been used up. Trial a trial licence which expires once the Trial Days Count has been used up.

The beginning of the validity period of this licence. The end of the validity period of this licence. The time and date when the licence request was granted. The time and date when the serving system will release the licence back into the system unless a renewal takes place. (ENTERPRISE performs this automatically and so this value is updated after every renewal). The type of node lock the licence is using. This can be: Unlocked can be installed on an appropriate serving system and used by any clients with access to that serving system. Client can be installed on an appropriate serving system but can only be used by a client which matches the client lock code given the specific client lock criteria. Server can only be installed on a serving system which matches the server lock code given the specific server lock criteria but can be used by any client with access to the serving system. Client and Server can only be installed on a serving system which matches the server lock code given the specific server lock criteria and also can only be used by a client which matches the client lock code given the specific client lock criteria.

Node Locking Type

Key Lifetime Total number of licences Is Exclusive

In seconds and minutes, the time for which an issued key is valid before a renewal must be completed to prevent the token from being released. The number of licences purchased for this feature, NOT how many are still available or in use. Whether the licence is exclusive or additive. True = Exclusive False = Additive

Trial Days Count Supports Commuter Licensing

How many days usage is available on your trial licence. This appears only if the Licence Type is set to Trial. Whether or not the licence supports checking-out for remote usage from the network server. True = Yes False = No

Commuter Maximum Days Checkout

The maximum number of days the checked-out licence is valid for from the time of the initial check-out. This will only appear if Supports Commuter Licensing is set to True. After the period expires the client will no longer be able to use the licence and it should be checked back in to the server. The licence is due to expire within 2 weeks. This item will only appear within the 2 weeks expiry period and is not displayed at all for commuter licences as they have a limited fixed period of validity).

Expires Soon

Page 414

AIRCOM OPTIMA User Reference Guide Version 6.2

Getting Licences for Individual Products


To use Licence Administrator to get a licence for a particular product or products: 1 2 Select the product or products you require licences for (you can hold the Ctrl key down to multi-select). Click the Get Licence button. - or Right-click and, from the menu that appears, click Get. 3 Click Close.

Dropping Licences for Individual Products


To use Licence Administrator to drop a licence for a particular product or products: 1 2 Select the product or products you wish to drop licences for (you can hold the Ctrl key down to multi-select). Click the Drop Licence button. - or Right-click and, from the menu that appears, click Drop. 3 Click Close.

Checking Out Commuter Licences


A commuter licence is one which can be checked out for remote usage from the network server. To use Licence Administrator to check out a commuter licence for a particular product or products: 1 2 3 Select the product or products that you want to check out commuter licences for (you can hold the Ctrl key down to multi-select). Right-click and, from the menu that appears, click Check Out. Click Close.

Checking In Commuter Licences


To use Licence Administrator to check in a commuter licence for a particular product or products: 1 2 3 Select the product or products that you want to check in commuter licences for (you can hold the Ctrl key down to multi-select). Right-click, and from the menu that appears, click Check In. Click Close.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 415

Exporting Licence Selections


The licence settings that you choose using the Licence Administrator are stored in the HKEY_CURRENT_USER registry key. To export these settings for use with other users: 1 2 Open the Registry Editor (select Start/Run, type regedit in the Open field and click OK). Select the HKEY_CURRENT_USER\Software\AIRCOM International\ENTERPRISE\Settings\All Servers\All Instances\All Projects\All Users\Licenses folder. This picture shows an example:

The StartOption parameter in the right-hand frame shows the selection you made from the Startup Option field in the Licence Administrator dialog box. 0 = Prompt at startup 1 = Auto get last licenses 2 = Auto get all 3 4 5 6 Right-click the Licenses folder and select Export. The Export Registry File dialog box appears. In the Save in field, select the folder in which you want your exported registry settings file to be stored. In the File name field, type in a name for your .reg file. Click the Save button. The file is saved in the specified location.

Page 416

AIRCOM OPTIMA User Reference Guide Version 6.2

Using Registry Files (Strategy C)


You can use registry settings to control which licences are obtained when ENTERPRISE is started up. This is not done using ENTERPRISE Administrator but by using Registry Editor to manipulate registry settings that are used by ENTERPRISE itself. The registry keys under which these settings reside are: 1 HKEY_CURRENT_USER (HKCU) and HKEY_LOCAL_MACHINE (HKLM) A check is made to see if the subkey [HKEY_CURRENT_USER\Software\AIRCOM International\ENTERPRISE\Settings\All Servers\All Instances\All Projects\All Users\Licences] exists. If it does, the licence settings are read from it and start up continues. If the subkey does not exist a further check is made to see if the subkey [HKEY_LOCAL_MACHINE\Software\AIRCOM International\ENTERPRISE\6.2\Licences] exists. If it does, the licence settings are read from it and start up continues. If this subkey does not exist then all licences are obtained. On starting up, the following sequence of checks is performed by ENTERPRISE:

As these registry checks are performed when ENTERPRISE is started and prior to logging in to the database, the licence settings cannot be stored on the database, even if the database settings management service (for more information see Database Settings Management) is in use. If you use Registry Editor incorrectly, you may cause serious problems that may require you to reinstall your operating system. Use Registry Editor at your own risk. The following sections describe how to add, modify and delete registry settings using a Registration Entries (.reg) file. Regedit.exe uses .reg files to import and export registry settings. You can use these .reg files to remotely distribute registry changes to several Windows-based computers. When you run a .reg file, the file contents merge into the local registry. Therefore, you must distribute .reg files with caution.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 417

Controlling Default Licences for all Users on a Machine


To control licences using registry files: 1 Use the Licence Administrator as described under Using Licence Administrator to select the licences that you want all users to obtain by default when they start ENTERPRISE. Export your settings to a .reg file as described under Exporting Licence Selections on page 416. Edit the .reg file to insert a minus sign after the opening square bracket in the line [HKEY_CURRENT_USER\Software\AIRCOM International\ENTERPRISE\Settings\All Servers\All Instances\All Projects\All Users\Licenses]. This will cause the user settings to be purged when ENTERPRISE is started. Edit the .reg file to insert the line [HKEY_LOCAL_MACHINE\Software\AIRCOM International\ENTERPRISE\6.2\Licenses]. This will cause the licences that you want all users to have by default to be obtained when they start ENTERPRISE. This picture shows an example of a correctly edited .reg file:

2 3

5 6 7

Save the edited .reg file. In the Registry Editor, select Import from the File menu. In the Import Registry File dialog box, select the edited .reg file and click Open. A message appears to inform you that the .reg file has been successfully entered into the registry.

Page 418

AIRCOM OPTIMA User Reference Guide Version 6.2

Using a Login Script to Enforce Your Licensing Policy


To ensure that the default licences obtained by users are reset to those specified by the method described under Controlling Default Licences for all Users on a Machine on page 418, include the following command in the users' login script: reg.exe import filename.reg Where filename.reg is a .reg file containing only the following line: [-HKEY_CURRENT_USER\Software\AIRCOM International\ENTERPRISE\Settings\All Servers\All Instances\All Projects\All Users\Licenses]

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 419

Page 420

AIRCOM OPTIMA User Reference Guide Version 6.2

Glossary of Terms
B
BSC Base Station Controller. A piece of equipment that controls one or more BTS (Base Transceiver Stations). BTS Base Transceiver Station.

C
CSV Comma-Separated Values. A type of data format in which each piece of data is separated by a comma.

F
FTP File Transfer Protocol. The standard protocol for exchanging files across the Internet.

I
INI Initialization file. INI files are used to initialize, or set parameters for, the operating system and certain programs. IP Internet Protocol. This defines the format for all data travelling through a TCP/IP network, performs the routing functions and provides a mechanism for processing unreliable data.

K
KPI Key Performance Indicator. A quantifiable measurement, agreed beforehand, representing a critical success factor of an organization.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 421

M
MIB Management Information Base. A type of database used to manage the devices in a network. MIBs are especially used with SNMP. MSC Mobile Switching Centre. In a cellular network, this is a switch or exchange that interworks with location databases.

P
PDU Protocol Data Unit. The PDU format is used to send and receive SMS messages.

S
SMPP Short Message Peer-to-peer Protocol. The protocol used for exchanging SMS messages between SMS peer entities such as SMSCs. SMS Short Message Service. The text messaging system, enabling messages to be sent to/from GSM phones and to external systems (for example, email or voicemail). Messages that cannot be delivered straight away (due to the receiver's mobile being switched off or out of range) are stored, and delivered as soon as possible. SMSC Short Message Service Centre. A network element in the mobile telephone network which delivers SMS messages. SMTP Simple Mail Transfer Protocol. A protocol used to send and receive email messages. SNMP Simple Network Management Protocol. SNMP is the protocol used for network management and the monitoring of network devices and their functions. SQL Structured Query Language. SQL is an ANSI and ISO standard computer language for getting information from and updating a database.

Page 422

AIRCOM OPTIMA User Reference Guide Version 6.2

T
TCP Transmission Control Protocol. The protocol used (along with the IP) to ensure reliable and in-order delivery of data across the Internet.

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 423

Page 424

AIRCOM OPTIMA User Reference Guide Version 6.2

Index
A
Adding alarm handlers 382 alarms 369, 382 combination windows to a work area 275 contact groups 87 contacts 87 favourites 194 holidays 106 modules to a combination window 185 web pages to a work area 277 Administrator Options Email Client 47 General 45 Partition Maintenance 54 Sandbox 51 WEBWIZARD 49 Aggregation element 160, 165 time 200 Alarm definitions clearing 389 viewing 389 Alarms about 41, 361 about the Explorer 41 about the Handler Explorer 43 activating 379, 386 assigning to contacts 382 clearing 387 creating handlers 382 defining 369 defining using the Editor 374 defining using the Wizard 369 deleting 379 editing 379 resetting 387 viewing 387 Alarms history clearing 390 viewing 390

C
Cancel dialog boxes, disabling and enabling 45 Categories about 101 assigning 94 creating 101 editing 101 Clearing

alarm definitions 389 alarms 387 alarms history 390 Clock offsetting 69 play data 286 setting global date 68 viewing data on the map 286 Combination Window adding to work area 275 copying 192 creating 185 data grids 229 deleting 187 exporting 193 filtering data 198 importing 193 new 185 removing modules 186 restricting access 191 restricting editing 191 viewing 184 Combination window templates deleting 205 editing 205 loading 204 saving 203 Contact groups adding 87 deleting 88 editing 88 Contacts adding 87 deleting 87 editing 87 Converting, filters 224 Copying combination windows 192 Copying filters 226 modules 169 reports 350 schedules 360 Counters finding 109 Viewing 66 viewing on the map 281 Creating alarms 369 combination windows 185 custom filters 207 element hierarchies 173 entities 104 Excel report templates 347 filters 215, 220 folders 154, 182, 288, 354 KPIs 134 links between modules 187 new work area 274 queries 110 report schedules 357 reports 291, 343 table periods 103 users 78 Custom Filters 207 Custom Views

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 425

deleting 129 editing 129 saving queries as 126 viewing details 130

D
Data gathering 107 grids 229 monitoring with alarms 361 setting-up 107 sorting 232 summarising 241 viewing on the map 281 Data Explorer about 63 adding filters 115 defining queries 110, 113 searching 109 using 108 Date Range 199 Defaults parameter values 118 Defining associations for a table 95, 99, 100 parameters 116 Deleting alarms 379 combination window templates 205 contact groups 88 contacts 87 custom views 129 element hierarchies 175 filters 226 groups 76 KPIs 140 modules 168 parameters 119 report schedules 359 reports 349 table periods 103 users 85 Drill down links about 187 editing and removing 189

Element aggregation configuring 162 displaying 165 Element hierarchies creating 173 deleting 175 editing 174 finding 176 previewing 177 renaming 175 setting security 175 viewing 177 Email client, settings 47 Enabling, time aggregation 125 Entities creating and editing 104 Excel reports creating 343 templates 347 viewing 348 Explain Plan, about 120 Exporting combination windows 193 graphs 266 grids 245 KPIs 140 modules 170 reports 351, 352

F
Favourites adding and editing 194 Filtering data in combination windows 198 elements 207 network elements 198 report data 335, 337, 338 using date ranges 199 Filters about 213 converting 224 copying 227 creating 215, 220 deleting 226 editing 225 finding 226 renaming 226 viewing 227 Finding counters 109 element hierarchies 176 elements in the modules pane 206 filters 226 items in explorers 69 Folders creating 154, 182, 288, 354 locking 155, 183, 289, 356 restricting access 155, 183, 289, 356

E
Editing alarms 379 combination window templates 205 contact groups 88 contacts 87 custom views 129 element hierarchies 174 filters 225 groups 76 KPIs 137 parameters 119 queries 308 report schedules 359 reports 349 table periods 103 tables 90 users 85

G
Global date and time 68 Global KPI Views creating 150

Page 426

AIRCOM OPTIMA User Reference Guide Version 6.2

deleting 152 editing 152 Granularity period repopulating tables 98 setting 94 Graphs advanced options 254 automarks 248 changing appearance 258 changing x-axis field 261 chart themes 255 colours 248 exporting 266 grid lines 250 legend 248 linking 212 ordering 262 printing 265 properties 248 saving as pictures 266 Grids exporting 245 toolbar 230 Using 229 using thresholds 235 Groups deleting 76 editing 76 permissions 74

Using the Fulfillment Wizard 397 Linking graphs 212 modules 187 Links drill down 189 Loading combination window templates 204 Locking, folders 155, 183, 289, 356 Login to AIRCOM OPTIMA 26

M
Map View viewing data 281 Materialized views defining indexes for 131 saving queries as 126 Module tree size, specifying 45 Modules about 153 copying 169 creating 157 deleting 168 drilling down 201 editing 168 exporting 170 filtering in the combination window 198 finding 206 importing 170 linking 187 opening in a new combination 169 refreshing in the combination window 187 removing from the combination window 186 restricting access 167 restricting editing 168 running linked 189 setting up 107 viewing 156

H
Help, Quick screen 28 Holidays about 106 entering 106

I
Importing combination windows 193 KPIs 140 KPIs in bulk 142 modules 170 reports 351 work areas 279 Indexes, defining for materialized views 131 Installing AIRCOM OPTIMA 22

N
Network elements selecting 198

O
Opening AIRCOM OPTIMA 26 AIRCOM OPTIMA as a standalone product 26 combination windows 184 Data Explorer 63 module in a new combination 169 queries 125 work areas 279 Oracle roles, in AIRCOM OPTIMA 23

K
KPIs about 133 creating 134 deleting 140 editing 137 exporting 140 importing 140 importing in bulk 140 viewing use 143

P
Parameters creating 337 defining 116 deleting 119 editing 119 reports 337

L
Licensing

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 427

specifying default values 118 Partition maintenance configuring 54 Password,changing 29 Performance alarms about 41 defining 369, 374 editing and deleting 379 Permissions about 74 creating 78 Previewing, element hierarchies 177 Printing graphs 265 grids 244 reports 350

Q
Queries editing 308 opening 125 saving 125 saving as a custom view in the sandbox 126 Quick Help screen, about 28

graphs 266 queries 125, 126 reports 335 Scheduling reports 354 viewing history 360 Searching explorers 69 Selecting network elements 198 Setting time aggregation 200 trace file options 60 Settings Wizard 92 Sorting data 232 Starting AIRCOM OPTIMA 26 AIRCOM OPTIMA as a standalone product 26 Symbols used in Help/Guide 14 System alarms about 41 defining 374 editing and deleting 379

R
Recreating, views 145 ReportBuilder, using 287, 291 Report schedules copying 360 creating 357 deleting 359 editing 359 renaming 359 viewing history 360 Reports about 287, 321 copying 350 creating 291, 343 exporting 351, 352 filtering 335, 337, 338 importing 351 parameters 337 restricting access 348 restricting editing 348 saving 335 scheduling 354 viewing 290, 348 Resetting, alarms 387 Restricting access combination windows 191 folders 155, 183, 289, 356 modules 167 reports 348 Roles, AIRCOM OPTIMA 23, 80

T
Table and Field Information about 91 adding comments to columns 98 adding comments to tables 97 assigning categories 94 defining associations for a table 95, 99 setting granularity period 94 setting table security 93 using the Settings Wizard 92 Table associations, defining 95, 99, 100 Table Editor about 89 editing tables 90 Table periods about 102 creating 103 deleting 103 editing 103 Table Security, setting 93 TCAs about 41 Templates Excel reports 347 Thresholds setting 235 Time aggregation drilling down into modules based on 201 enabling 125 setting 200 Time zones setting 61 using AIRCOM OPTIMA across different 62 using in report schedules 357 Toolbar AIRCOM OPTIMA 31 favourites 32 grids 230 Trace file options, setting 60

S
Sandbox administrator options 51 saving queries in 126 viewing tablespace details 130 Saving combination window templates 203

Page 428

AIRCOM OPTIMA User Reference Guide Version 6.2

Tree links, using 187

U
User Permissions about 74 creating 78 User preferences, defining 55 User quotas, allocating 51 Users creating 78 deleting 85 editing 85 permissions 80 roles 80 Using AIRCOM OPTIMA 26 AIRCOM OPTIMA as a standalone product 26 custom filters 207 Data Explorer 108 Grids 229 quick selection filters 211 reports 288 windows in the work area 273 work areas 273

V
Viewing alarm definitions 389 alarms 387 alarms history 390 automarks 248 combination windows 184 counters 66 data 179 data in the Data Explorer 124 data on the map view 281 element hierarchies 177 filters 227 KPI use 143 modules 156 report schedules 360 reports 290, 348 thresholds 235 web pages 273, 277 Views recreating 145 saving queries as 126

W
WEBWIZARD defining the URL for 49 launching 70 Work areas, creating 274

AIRCOM OPTIMA User Reference Guide Version 6.2

Page 429

Page 430

AIRCOM OPTIMA User Reference Guide Version 6.2

Potrebbero piacerti anche