Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
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
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
29
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
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
69 70
71
72
72 73
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
89
90
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
102
103 104
106
106
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
171
172 173 175 176 176 177 177
179
179
182 184 185 187 191 191 192 193
194
196
198
198 199 Page 7
Setting Parameter Values Setting Time Aggregation Saving Combination Windows as Templates
206
206 206
207
207 208 209 211
212 213
214 215 220 224 225 225 226 226 226 227 227
229
230 231
231 233 233 234 235 237
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
Page 8
247 248
248 250 252 253 253 254 255
256
256 257 257
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
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
279 280
Page 9
281
281 282 286
Displaying Performance Data on the Map Changing the Display of Performance Data Using the Clock to Display Performance Data
287
288 288
288 290 291 343 348 348 349 350 350 351 352
354
354 357 359 360 360
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
381 382
382 386 386
Viewing, Clearing and Resetting Alarms Viewing and Clearing Alarm Definitions Viewing and Clearing Alarms History
Page 10
392 393
393
393 394
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)
419
Page 11
Page 12
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
Page 13
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.
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
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.
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.
Page 16
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.
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.)
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.
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.
Using the Financial Analysis module to evaluate and plan for the revenue potential of your network. (Optional add-on to ASSET and ADVANTAGE.)
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.
Page 17
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
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
Page 19
Page 20
CHAPTER 2
As a standalone product
Page 21
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.
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.
Page 23
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.
Page 25
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
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.
Page 27
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
Page 29
Page 30
CHAPTER 3
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.
Page 31
Button
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.
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.
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.
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
Page 33
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
Page 35
Page 36
Page 37
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
To open the Global KPI Explorer: From the KPI menu, click Global KPI. The Global KPI Explorer opens. This picture shows an example:
Page 39
Page 40
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
Page 41
Button
Description Display the alarm definitions in a more detailed list format (name, description, next scheduled date and so on).
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:
Page 42
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
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).
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
Page 45
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.
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
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.
Page 47
After you have set these options, this email client is displayed when you export a report to email:
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
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.
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
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
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.
Page 52
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
Page 53
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.
Page 54
Click OK.
Page 55
Click OK.
Page 56
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.
Page 57
When you have finished, click OK to save your default settings and exit the User Preferences dialog box.
Page 58
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.
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.
Click OK.
Page 60
Select the required time zone and then click Update. The time zone details in the Message Log are updated with the new time zone:
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.
Page 62
Page 63
Filter Explorer
Page 64
Page 65
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
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.
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
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.
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
CHAPTER 4
Page 71
Click
Page 72
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.
2 3
From the drop-down list, select the country where you are currently. Click OK to save your changes.
Page 73
You must:
Page 74
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.
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.
Page 76
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
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.
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
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
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.
Page 79
Page 80
Administrator View Add Edit Delete Restrict editing Restrict access Import Export Add to Favourites
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
* 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
Counters
No access
View
View
View
No access
No access
No access
No access
Element Hierarchies
No access
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
Page 81
Object/Role Filters
Administrator View all types (personal, group, system) Add all types Edit all types Delete all types Restrict 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
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
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
Report Folders
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
Page 83
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)
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* * if granted access to the parent folder
Schedule Folders
No access
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
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
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.
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:
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
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.
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.
2 3 4 5
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.
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
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.
Page 89
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. .
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
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.
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.
Page 93
Page 94
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
1 2 3
Page 95
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:
The KPIs of the table will only be displayed on the 2D Map View if you set the table to a CELL level.
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
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.
For more information on how the associated tables are created, see How AIRCOM OPTIMA Generates Associated Tables on page 100.
Page 99
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
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.
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.
Page 102
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:
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.
Page 104
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
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.
To delete a holiday:
Page 106
CHAPTER 5
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.
Page 107
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
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.
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.
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
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.
To remove a table from the Builder tab, select the table and click the in the top-right of the table box.
Page 110
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
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:
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
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.
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.
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
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.
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.
Page 115
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
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
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 . .
Page 119
Page 120
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
DEPT_ID_PK
The value in the POSITION column of the first row shows that the statement has a cost of 2.
Page 121
Page 122
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.
Page 123
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
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.
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.
Page 125
Page 126
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
Page 127
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
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.
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
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.
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.
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.
2 3
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
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
KPI Manager
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
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.
In this example, a personal KPI is being created with the base schema as ERICSSON2G and base table as BSCGPRS.
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:
Page 136
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:
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
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.
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.
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
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
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.
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
Page 144
This picture shows 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.
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
Page 146
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
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
Page 148
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.
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
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
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
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:
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.
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 .
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
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.
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.
Page 156
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
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
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.
Click OK to finish.
Page 159
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
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
Page 161
Page 162
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.
Page 163
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
3 4 5
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
Wisma Rajab
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.
Page 167
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.
Page 168
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 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 .
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.
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
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.
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)
Page 171
To open the Element Hierarchies Explorer: From the Tools menu, click Element Hierarchies. - or Click the Element Hierarchies button .
Page 172
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.
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.
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.
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.
In the message box that appears, click Yes to confirm. The element hierarchy is deleted from the list in the Element Hierarchies Explorer.
Click OK to close the Element Hierarchy Properties dialog box and return to the Element Hierarchies Explorer.
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.
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 .
Page 176
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.
Page 177
Page 178
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.
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
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.
Page 181
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.
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
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.
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.
Page 183
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
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 .
Page 185
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.
Select the folder in which you want to save the module combination.
Page 186
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.
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.
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
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
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.
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
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 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
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
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.
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
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' .
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.
Page 196
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.
Page 197
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
Click the Run All Modules button or the Run Highlighted Module button to refresh the data based on this filtering.
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
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.
Page 199
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
Page 200
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.
The selected time period is indicated by the name of the tab, for example hourly:
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
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.
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.
Page 204
In the message box that appears, click Yes to confirm. The template is loaded.
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.
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.
Page 205
Page 206
Filters pane
You can create custom filters in the Filter Explorer. For more information see Using the Filter Explorer on page 213.
The filter is now available from the list of filters that appear in the Filters pane. This picture shows an example:
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
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:
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
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.
Page 211
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.
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
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 .
Filter Explorer
Page 213
Page 214
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.
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
Click Next.
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.
Page 218
11 Click Finish. The filter is now available from the list of filters that appear in the Filter Explorer:
Page 219
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
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.
Click Next. The query is executed and the filter results are displayed in the Filter Values pane of the Filter Values tab.
Page 221
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.
Page 222
Click Finish. The filter is now available from the list of filters that appear in the Filter Explorer.
Page 223
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
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.
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.
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
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 .
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.
Page 227
Page 228
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:
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.
Page 229
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
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.
Page 231
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
Click OK. The data grid automatically moves to the column that you have selected.
Page 233
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.
In the Column Settings dialog box, double-click one of the Threshold columns.
Page 235
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.
Page 236
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 .
Page 237
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:
Page 238
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.
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.
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.
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
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.
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
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 .
Page 243
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
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.
Page 245
You can copy the SQL in this window by selecting it, and pressing Ctrl+C.
Page 246
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.
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
Page 248
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:
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.
Page 250
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.
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.
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
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.
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.
Page 254
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
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.
Page 255
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.
Page 256
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
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. .
Page 257
2D graph
Page 258
3D graph
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.
Page 259
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
To remove the points from the graph, click the Show Weekend or Show Holiday buttons.
Select either Date Type or Non-Date type from the View drop-down list, depending on which data type you require.
Page 261
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.
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
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.
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:
In the Grid Details window, you can sort your data by clicking on the Field name or Data header box.
Page 264
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.
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.
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.
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
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
Page 267
Page 268
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:
Page 269
If you do this at the module level, you can change the graph type for all items in the series list.
To change the axis back repeat the process and the counter will display on the left axis.
Page 270
Page 271
Page 272
CHAPTER 9
Page 273
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.
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.
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.
Page 275
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
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.
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.
Page 278
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.
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.
Page 279
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
CHAPTER 10
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.
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.
Page 282
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 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
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
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.
Page 285
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.
When you have selected the step and period value, click Play. The performance data displayed on the map will alter accordingly.
Page 286
CHAPTER 11
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.
Page 287
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
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 .
Page 288
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.
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.
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
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.
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:
Page 292
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.
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
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.
Page 295
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
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 .
Page 297
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
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.
Page 299
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
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:
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:
Page 302
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.
Page 303
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
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.
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
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 -
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 .
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
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.
Page 309
Code Toolbox
Page 310
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.
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
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.
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:
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
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:
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.
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.
Page 316
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
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.
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:
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:
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.
Page 319
This picture shows an example of the 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
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:
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:
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.
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
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.
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
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
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.
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:
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
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.
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
To align one or more boxes: 1 Using the mouse pointer, draw a box around all of the boxes that you want to align.
Page 329
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
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:
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
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.
Page 333
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.
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.
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.
AutoSearch
Page 336
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.
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
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:
Page 339
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
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)
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.
Page 342
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.
From the Report Explorer File menu, point to New and click Excel Report.
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
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.
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.
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:
Page 346
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 .
Page 347
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.
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.
Page 348
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.
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:
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 .
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
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. .
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
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.
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
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
To create a new folder: 1 From the Reporter menu, click Schedules. - or Click the Schedules button .
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 .
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.
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.
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.
Page 356
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.
Page 357
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
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.
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 .
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.
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
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.
Page 361
In the Alarms Explorer, the two types of alarm configured in the Explorer Performance and System - are shown on separate tabs:
In the Alarms Handler Explorer, all types of alarm handler are shown on separate tabs:
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
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.
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:
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.
Page 364
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.
2 3
Click Add. Type the name of the element type and click OK.
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:
Page 366
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.
Page 367
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
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
Page 369
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
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.
Page 371
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.
13 Click Next.
Page 372
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
Page 374
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.
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.
Page 376
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.
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.
Page 377
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
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.
Page 379
Page 380
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.
Page 381
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.
The Alarms Handler dialog box appears. 4 On the Information tab, type the handler name and add a description.
Page 382
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.
Page 383
This shows a list of all of the alarms that have been defined on the appropriate tab, either Performance or System.
Page 384
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.
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:
Page 386
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.
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
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.
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.
Page 390
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.
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.
Page 391
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
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.
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
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
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.
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.
Page 395
Page 396
APPENDIX A
Renewing Licences Online on page 404 Generating New Licences Manually on page 407
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.
Page 397
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
2 3 4 5
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.
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.
Page 400
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.
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.
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.
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.
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.
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.
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
Page 405
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
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.
Select the options you require and click Next. None of these options are likely to be required by WEBWIZARD only users.
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
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.
Page 409
Page 410
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.
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.
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
Click Close. The setting selected is stored within the current user configuration and takes effect whenever the user starts ENTERPRISE.
Page 413
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.
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
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
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
Page 415
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
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.
Page 417
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
Page 419
Page 420
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.
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
T
TCP Transmission Control Protocol. The protocol used (along with the IP) to ensure reliable and in-order delivery of data across the Internet.
Page 423
Page 424
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
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
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
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
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
Page 429
Page 430