You are on page 1of 76

OPTIMA Installation Tool User Reference Guide

Software Version 6.1 Reference Guide Edition 1

Copyright 2008 AIRCOM International All rights reserved ADVANTAGE, ASSET, CONNECT, DATASAFE, DIRECT ENTERPRISE, NEPTUNE, ARRAYWIZARD, OPTIMA, OSSEXPERT, and WEBWIZARD are recognised trademarks of AIRCOM International. Other product names are trademarks of their respective companies. Microsoft Excel , .NET, Microsoft Office, Outlook , Visual Basic Windows, 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 12 September 2008. 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
Explanation of Symbols 7 9
12
13

About the OPTIMA Installation Tool

About the Created Interface


Handling of Multiple File Formats and Vendor Version

Installing the OPTIMA Installation Tool


Prerequisites for Installing the OPTIMA Installation Tool Installing the OPTIMA Installation Tool and Running Scripts

14
14 15

About a Project Adding a New Project Checking the Database About Updating Project Properties
Updating General and Database Server Machine Properties Updating Mediation Machines, LUNS, and Summary Definitions Properties

16 16 22 23
24 25

Uploading Project Information Defining Global Parameters Opening the Project Working Folder Exporting a Project About Interface Workbooks
Using the Interface Definition button About File Format Information About CFG Table Information About Raw Table Information About Counter Group Information About Parsed Counter Information About Loaded Counter Information About CFG Fields Information About Hierarchy Chain Information About Hierarchy Field Information About Default Element Level Alias Information About Summary Definition Information About BusyHour Definition Information About BusyHour Table Information About BusyHour Summary Information

27 27 28 28 29
30 32 33 34 34 35 36 38 39 39 40 40 41 42 43

Creating an Interface Workbook


Identifying the File Format and Version ID Mapping Parser Out Combining Objects Validating Loading Creating CFG Tables Defining Hierarchies Creating Summaries

44
44 45 46 46 47 48 49 50

OPTIMA Installation Tool Version 6.1

Page 5

Power Tools
Generating a 6.1 Interface Template from Existing Sources Merging Two Interface Templates Reporting on Differences Between Two Interface Templates Removing a File Version/Format from an Existing Interface Template Migrating 1.4.x Interface Templates to the 6.1 Format Displaying an Existing Interface Template

51
51 56 57 58 58 59

Adding an Interface Workbook to a Project Validating an Interface Workbook Template Uploading an Interface to the Database Activating an Interface
Generating a Decommissioning Report

60 61 62 64
66

Reusing PRIDs Viewing INI Files Exporting an Interface File Refreshing the Interface Name Troubleshooting

68 70 71 71 72

Index

75

Page 6

OPTIMA Installation Tool Version 6.1

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.

OPTIMA Installation Tool Version 6.1

Page 7

Page 8

OPTIMA Installation Tool Version 6.1

CHAPTER 1

About the OPTIMA Installation Tool


The OPTIMA Installation Tool (OIT) configures the operation of OPTIMA. The data definitions for incoming vendor data files are maintained in an Excel spreadsheet known as the Interface workbook or the OIT template. The OIT generates the runtime parameter files (INI) for the OPTIMA combiner, validator, and loader. The OIT generates runtime parameter files for summary, busyhour and busyhour summary operations. The OPTIMA also configures the parameters for ORACLE table partitions and table spaces. In addition to this, the OIT also creates the ORACLE vendor schema and the tables for data storage. The entire process contains the following tasks: 1 2 3 4 5 Adding a new project. Creating an interface workbook. Adding the interface workbook to the project. Uploading the interface to the database. Activating the interface.

You can carry out the first three tasks offline but you must carry out the last two tasks online.

OPTIMA Installation Tool Version 6.1

Page 9

This picture shows an overview of the OPTIMA Installation Tool:

The tool can perform the following functions: Automate the creation of new vendor interface schemas Create INI files for Combiner (if used), Validator and Loader Create INI files for Directory Maintenance, Process Monitor, Directory Maintenance Loader and Log loader Populate network configuration for Loader tables Populate OPTIMA Summary tables with network configuration for Summaries, Busy Hour definitions and Busy Hour Summaries Create the vendor tables (Raw/Summary/BH Definition/BH Summary tables) and associated tablespaces Create scripts to install the INI files Create scripts to install the directories on the mediation and database servers Configure the table maintenance, tablespace maintenance Allow an interface to be configured in an Excel workbook, and then reused at different customer sites from a central repository

Page 10

OPTIMA Installation Tool Version 6.1

However, the tool does have the following limitations: Does not configure the FTP or Parser components Limited to single user (only one installer can work on a project/database at one time) Does not configure OPTIMA Client Reports/Modules/KPIs/Alarms Does not create tables in the AIRCOM or GLOBAL schemas Project working directory and database connection details must be modified for each user

In This Section
About the Created Interface Installing the OPTIMA Installation Tool About a Project Adding a New Project Checking the Database About Updating Project Properties Uploading Project Information Defining Global Parameters Opening the Project Working Folder Exporting a Project About Interface Workbooks Creating an Interface Workbook Power Tools Adding an Interface Workbook to a Project Validating an Interface Workbook Template Uploading an Interface to the Database Activating an Interface Reusing PRIDs Viewing INI Files Exporting an Interface File Refreshing the Interface Name Troubleshooting 12 14 16 16 22 23 27 27 28 28 29 44 51 60 61 62 64 68 70 71 71 72

OPTIMA Installation Tool Version 6.1

Page 11

About the Created Interface


The OPTIMA Installation Tool creates the following: Combiner INI Files Validator INI Files Loader INI Files Loader Tables Configuration Creation of Raw Tables Creation of Summary Tables/BH Tables/BH Summary Tables OPTIMA Summary 6.1 Configuration for Summary Tables/BH Tables/BH Summary Tables CFG Tables Procedures that populate CFG Tables Mediation, Installation and Run Scripts

Page 12

OPTIMA Installation Tool Version 6.1

Handling of Multiple File Formats and Vendor Version


The OPTIMA Installation Tool creates a separate stream per file format and vendor version. The FTP separates the raw files per vendor version and file format. Then, these are processed by separate parsers, combiners, validators and loaders. After that, the loaders load all file formats and vendor versions into the same raw table. FTP and Parsers are not configured by the OPTIMA Installation Tool. This picture shows an example:

OPTIMA Installation Tool Version 6.1

Page 13

Installing the OPTIMA Installation Tool


Installing the OPTIMA Installation Tool consists of the following tasks: Prerequisites before installing OPTIMA Installation Tool Installing the OPTIMA Installation Tool and Running Scripts

Prerequisites for Installing the OPTIMA Installation Tool


Before you install the OPTIMA Installation Tool scripts, perform the following tasks in the specified order: 1 2 3 4 Install the OPTIMA Production Database (including AIRCOM schema). Ensure that your database is 9.2.0.6 or later or 10.2.0.3 or later and the catalogue is correctly migrated. Check that the compatible parameter of the database matches the patch level specified in step 2. Check that the following logs tablespaces have been created correctly: 5 6 7 8 9 LOGSD LOGSI

Ensure that the AIRCOM, GLOBAL and LOGS schemas exist. Ensure that the Common Scripts (SCR-GEN-001-GEN-826) is installed. Ensure that the OSS_Logging Package (SCR-GEN-001-GEN-828) is installed. Ensure that the OSS_Maintenance Package (SCR-GEN-001-GEN-827) is installed. Ensure that the OPTIMA_Summary Package is installed.

10 Ensure that the OPTIMA_Loader Package (LOD-GEN-012-ORA-110) is installed.

Page 14

OPTIMA Installation Tool Version 6.1

Installing the OPTIMA Installation Tool and Running Scripts


To install the OPTIMA Installation Tool: 1 2 3 From Add or Remove Programs in "Windows Control Panel", remove any previous version of the OPTIMA Installation Tool. Contact your administrator, who can obtain the software from AIRCOM International. Install the new version of the OPTIMA Installation Tool (via your administrator if appropriate). Click Start on the taskbar, point to Programs, then OPTIMA Installation Tool, then Scripts Folder, then OIT, then DB_Scripts. If you have a pre-6.1 version of the AIRCOM schema, you need to run: 'upgrade_AIRCOM_Schema.sq`l' If tablespaces DD_CONFIG_D and DD_CONFIG_I do not exist, the installer should edit and execute the script create_OSS_tablespaces.sql following the instructions within the file. On the command prompt, type SQLPLUS /NOLOG. It is essential that there are no open sessions connected to "OSS_DICTIONARY", because any open sessions prevent the dropping of this dictionary (even though the install will proceed to completion). 5 Run 'install_OIT_backend.sql' SQL> @install_OIT_backend.sql A log file 'install_OIT_backend.log' is created. Note that a SYS schema needs to be available with SYSDBA privileges with the user and password ready. 6 At the SQL prompts, type your: SYS password ORACLE SID OSS_DICTIONARY password

You should now run the appropriate scripts: 1 2 3

OPTIMA Installation Tool Version 6.1

Page 15

About a Project
A project contains information about the local OIT root directory, database server connection, mediation server directories, logical units (LUNS) for database tablespaces. Everytime you open the OPTIMA Installation Tool, you will need to specify a project. There can only be one project for the entire OIT schema. The project information can be updated using the Project Properties dialog box. It is not possible for two people to work on the same project concurrently because the OIT root directory is user specific (set by default to My Documents\OIT). If a new user wishes to use the same project, they must redefine the OIT root directory for their local Windows PC.

Adding a New Project


To add a new project: 1 In the main OPTIMA Installation Tool dialog box, from the File Menu, click New Project. The OSS Management Console Wizard appears.

Page 16

OPTIMA Installation Tool Version 6.1

2 3 4 5 6

In the Project Name box, type a name for the project. In the OIT Root Directory path, browse to the required folder on your local PC. In the Description box, type a description for the project. Click Next. Specify the Database Connection Details: In the Connect Using drop-down list, select the method you want to use for connection In the Database drop-down list, select the project database In the User/Schema box, type the user or schema In the Password box, type your password

OPTIMA Installation Tool Version 6.1

Page 17

7 8

Click Test Connection to test the database connection. If the connection is successful, click Next. You cannot proceed until the test is successful. (At this stage, a check is made to record whether the database is ASM or nonASM.) The project information is added to the database when you log in to the database and upload the project.

Specify the Database Server Machine details: In the Machine ID box, the machine ID is always 0 In the Platform drop-down list, specify the type of platform corresponding to the database operating system In the External (Loader Directory), type the name of the directory for the external mapping path to the mediation machine

Page 18

OPTIMA Installation Tool Version 6.1

10 Click Next. 11 Specify the Mediation Server Machines details: In the Machine ID drop-down list, specify the ID of the machine In the Platform drop-down list, specify the platform corresponding to the mediation machine operating system In the OPTIMA (root) Directory box, type the name of the OPTIMA root directory (absolute path) In the INI File Directory, type the name of the directory for the INI files In the External (Loader) Directory, type the name of the directory for the external data files In the Local PRID Directory, type the name of the PRID directory The last three directory names can be either relative paths to the OPTIMA root path, or absolute paths.

OPTIMA Installation Tool Version 6.1

Page 19

12 Click Add to add all the details for a particular machine ID to the grid. 13 Click Next. 14 Specify the LUNS details. The four defaults of System, Data, Index and Temporary automatically appear in the grid. If required, you can modify the LUN Path box and LUN Capacity by specifying new values and clicking Modify. If you need to add more LUN Types, click Add and then modify the LUN Type, LUN Path and LUN Capacity as appropriate. If the database is ASM, the LUN Path is inactive.

15 In the Datafile edit box, specify a Maximum Size which represents the maximum individual size of an Oracle Datafile. If more than one user is configuring OPTIMA using the OPTIMA Installation Tool, they must ensure that this size is the same for each user.

Page 20

OPTIMA Installation Tool Version 6.1

16 Click Next. 17 Specify the summary definitions details: In the Definition ID box, type the ID of the definition In the Definition Name box, type the name of the definition In the Definition Group Time box, type the group time of the definition In the Definition Based On box, type the time parameter on which the definition is based on In the Definition Where Clause box, type the where clause of the definition

18 Click Add to add all the summary definition details to the grid. 19 Click Finish. You can also modify or delete information. To do this: Select the row in the grid that you want to modify or delete. Click Modify or Delete.

OPTIMA Installation Tool Version 6.1

Page 21

Checking the Database


A basic compatibility check is made to check whether the tool and packages in the relevant schemas have the same major, minor and interim version numbers. The modules involved in the compatibility check are: Application (OPTIMA Installation Tool) All PL/SQL packages relevant from the OSS_DICTIONARY schema To check the database: 1 From the File menu, click Database Check.

Page 22

OPTIMA Installation Tool Version 6.1

It provides information about the following: Release Number OIT GUI Patch Build Info Source Contorl Revision In case of generic errors, a short description of the error is explained. If there is an incompatible module, then that module is also highlighted in red along with the error message. If you encounter an error, please contact AIRCOM International for support.

About Updating Project Properties


After creating a project, you may want to modify the properties of the project. You can update the following properties of the projects: General properties Database Connection properties Database Server Machine properties Mediation Machines properties LUNS properties Summary Definitions properties To update project properties: 1 2 3 Open the project for which you want to update the project properties. Right-Click the project name and select Properties. The Project Properties dialog box appears. Select the required tab.
Tab General Database Server Machine Mediation Machines LUNS Summary Definitions Property General Project Properties Database Server Machine Properties Mediation Machines Properties LUNS Properties Summary Definition Properties

OPTIMA Installation Tool Version 6.1

Page 23

Updating General and Database Server Machine Properties


To update the general, database connection, and database server machine properties: 1 2 3 Open the project for which you want to update the properties. Right-Click the project name and select Properties. The Project Properties dialog box appears. Select the correct tab.

Page 24

OPTIMA Installation Tool Version 6.1

4 5

Make modifications to the properties which you want to update. Click OK to save your modifications. -orClick Apply to apply your modifications. -orClick Cancel to exit.

Updating Mediation Machines, LUNS, and Summary Definitions Properties


To update mediation machines, LUNS, and summary definitions properties: 1 2 3 Open the project for which you want to update the properties. Right-Click the project name and select Properties. The Project Properties dialog box appears. Select the correct tab.

OPTIMA Installation Tool Version 6.1

Page 25

4 5 6

Select the row from the grid that you want to modify and make modifications to the required properties. Click Modify. Click OK to save your modifications. -orClick Apply to apply your modifications. -orClick Cancel to exit.

Page 26

OPTIMA Installation Tool Version 6.1

Uploading Project Information


After you create a project, you have to upload the project information to the database. To upload project information: 1 2 From the File Menu, click Open Project. The project opens. Right-Click the project name and click Upload Project Information. The project information is uploaded.

Defining Global Parameters


Project level settings are defined in the Global Parameters section. To define global parameters: 1 2 From the File Menu, click Open Project. The project opens. Right-click the project name and select Global Parameters.

Specify the following details: Database TNS Name Loader User Loader User Password

The current three settings included are the connection details for the Loader client to connect to the Loader Package in the database. This applies to Loader Clients on all mediation devices.

OPTIMA Installation Tool Version 6.1

Page 27

Opening the Project Working Folder


This enables you to open the working folder of the project that you are working on. This gives you easy access to the folder. To do this: From the File menu, click Open project working folder. The working project folder opens.

Exporting a Project
To export a project: 1 2 Select the project, right-click and click Export Project. In the Export Project dialog box that opens, click Browse to select the location where you want to export the selected project.

3 4

In the Save As window, specify a name for the project and click Save. Click OK. The project is exported in a zip file.

Page 28

OPTIMA Installation Tool Version 6.1

About Interface Workbooks


An interface workbook is an Excel spreadsheet that defines the interface. It contains information about the various fields of the database. It consists of worksheets with the following information:
Worksheet File Formats CFG Tables Raw Tables Counter Groups Parsed Counters Loaded Counter CFG Fields Hierarchy Chain Hierarchy Field Default Element Alias Summary Definition BusyHour Definition BusyHour Table BusyHour Summary Information This worksheet describes the vendor version and file format of the interface. This worksheet describes all the network configuration tables along with stored procedures that populate them from a source raw table. This worksheet contains a full list of raw tables for the interface. This worksheet contains an entire list of all counter groups together with their associated raw tables. This worksheet contains the Loader_File_Mappings table and Validator INI File Configuration information. This worksheet contains the Loader_Table_Mappings table configuration information. This worksheet describes the fields in the network configuration tables. This worksheet describes the fields in a network hierarchy from a network configuration table (CFG). This worksheet describes the CFG fields for each hierarchy level. This section describes the elements of a hierarchy chain. This worksheet defines the summaries of the raw tables. This worksheet describes the busy hours of the raw tables. This worksheet describes the fields on the BusyHour Tables worksheet of the Interface Workbook Excel spreadsheet. This worksheet describes the summaries to be taken from the busy hours.

The following keys are defined in the Excel sheet: PK = Primary Key FK = Foreign Key WFK = Weak Foreign Key, either it is partially matched or is not enforced

OPTIMA Installation Tool Version 6.1

Page 29

Using the Interface Definition button


You can use the Menu button to customise the spreadsheet to show only some of the worksheets. To open the Interface Definition Menu button: 1 In the Interface Workbook Excel spreadsheet opens, click the Interface Definition Menu button. This table describes the fields in the Menu Button screen:
Field Vendor Technology Domain Subdomain Portal Raw/Hourly Data Daily Data Weekly Data Monthly Data Description Name of the vendor. Name of the technology. Name of the domain. Name of the subdomain. Portal Information. Data that is obtained on an hourly basis. Data that is obtained on a daily basis. Data that is obtained on a weekly basis. Data that is obtained on a monthly basis.

Summary and Busy Hours When you click this button, only the following worksheets are displayed in the spreadsheet: Summary Definition BusyHour Definition BusyHour Tables BusyHour Summary Hierarchy and Config When you click this button, only the following worksheets are displayed in the spreadsheet: CFG Tables CFG Fields Hierarchy Chains Hierarchy Fields Default Element Level Alias Interface Dictionary When you click this button, only the following worksheets are displayed in the spreadsheet: FileFormats Raw Tables Counter Groups Parsed Counters Loaded Counters KPIs and STD Reporting When you click this button, only the following worksheets are displayed in the spreadsheet. This feature is not yet implemented.

Page 30

OPTIMA Installation Tool Version 6.1

Field Show All

Description When you click this button, all the worksheets reappear in the spreadsheet.

This picture shows an example of the Interface Definition dialog box:

Notes: Oracle object names are not case sensitive and any object names generated from the Interface Menu screen properties in the template can be considered in UPPERCASE. For example, Vendor=Ericsson, Domain=Utran will generate a Vendor Schema in Oracle = Ericsson_UTRAN. Directory paths and file names in Unix are case sensitive, while directory paths and file names in Windows are not. For example, P001110001.ini and P001001001.ini refer to different files in UNIX but refer to the same file in Windows.

OPTIMA Installation Tool Version 6.1

Page 31

About File Format Information


This table describes the fields on the File Format worksheet of the Interface Workbook Excel spreadsheet.
Field FileFormatID Description PK. ID of the vendor version or the file format. This is unique for each file format. It is a combination of File Format and Vendor Version. For example, if the file format is XML, CSV and the vendor version is G3, P5 , then ID can be CSV-G3 or XML-P5. Maximum length of the FileformatID is 7 characters. File Format Version Enabled Number of Days Data is kept on OMC Filename Match (normal) Filename Date String Remove from Filename (Combiner) File format of the Raw data file. Vendor version of the file. If yes, it turns the entire file format on for the installation. Yes Yes Yes CSV G3 Yes/No 15 Mandatory Yes Example CSV-G3

Number of days that the OMC/NEM stores the files. No It is a numeric value. Regular expression that describes the raw filename. This is used for FTP and Combiner configuration. The format of the date in the filename. Used by Combiner to combine files based on similar filename. However, this filename may have a distinguishing feature that needs to be removed. This is a regular expression that if matched, it is removed from the filename before combining. Default = 1. This sets the number of headers that will be loaded for this file type. No

*.CSV

No No

YYYYMMDD A

Number of Header Lines

No

Page 32

OPTIMA Installation Tool Version 6.1

About CFG Table Information


This table describes the fields on the CFG Tables worksheet of the Interface Workbook Excel spreadsheet. This worksheet is used to produce all configuration tables along with stored procedures that populate them from a source raw table. Each raw table in the Raw Table worksheet has an associated CFG table as specified in the CFG Table column. This worksheet needs to be completed together with the 'Hierarchy Chains', 'Hierarchy Fields', and 'CFG Fields' worksheets.
Field CFG Table Description PK. This is the name of the config table that needs to be created. This is a combination of <network element> and CFG and is written as <network element>CFG. Default = Yes. If the field value is 'Yes', then the CFG table has an associated procedure that will load CFG information from the associated raw tables. This procedure is run every hour. This is the Network Element (Reported Object) name that is level for which the CFG table is defined for at the lowest level. Default = No. If the field value is 'Yes', then the CFG table will store changes to CFG information as a 'new' object in the table. This means that the CFG table will by default be partitioned and have a daily view which shows all elements for each day. Mandatory Yes Example CELLCFG

Populate from Data Update

No

Yes/No

Element Level

Yes

CELL

History

No

Yes/No

Default HierarchyID

WFK. Default ID of the hierarchy.This field No contains a hierarchy of all the hierarchy elements specific to a particular configuration table. For example, In a CELLCFG table, we might have a hierarchy of BSC and Cell. The chain is this case would be B_C where B is BSC and C is Cell. The value defined in the default hierarchy ID should correspond to the 'Hierarchy Unique ID' column in the Hierarchy Chains tab of the Interface Workbook Excel sheet.

B_C

OPTIMA Installation Tool Version 6.1

Page 33

About Raw Table Information


This table describes the fields on the Raw Tables worksheet of the Interface Workbook Excel spreadsheet. This worksheet contains a full list of raw tables for the interface.
Field Tablename Table Alias (shorter) CFG Table Description PK. This is the name of the raw table to be created. This should be a maximum of 20 characters. Determines the shortening of the tablename if a summary or primary key extension exceeds 30 characters. Mandatory Yes No Example CELLHANDOVER CELLHO

FK[CFG Table]. The parent Configuration Table for this Yes raw table. All tables should have a CFG table that will update information automatically for things like maximum timestamp that the Object has data for. The 'Add CFG Tables' button in the CFG Tables worksheet uses the information in this column to autopopulate the list of CFG tables. Indicates whether this table needs to be created. If this table has multiple counter groups loading to it, and you want to configure combiner before loading, then the field value should be 'Yes'. Expected granularity is specified in minutes. Yes No

CELLCFG

Enabled Combiner

Yes/No Yes/No

Expected Granularity (minutes)

Yes

60

About Counter Group Information


This table describes the fields on the Counter Groups worksheet of the Interface Workbook Excel spreadsheet. This worksheet contains an entire list of all counter groups together with their associated raw tables.
Field Tablename Description Mandatory Example CELLSTATS PK, FK [Raw Table/CFG Table]. The counter Yes group must belong to a Raw Table or a CFG Table. Set a counter group for a CFG table only if a separate object for loading is provided by the customer or by an output from the parser. PK. This is the name of the counter group to be Yes defined. A counter group name should always correspond to the name output by the parser. In some cases, the counter group name is too No long, or not meaningful. This gives the ability to alias the name to something shorter or meaningful. This indicates whether the counter group needs Yes to validated or loaded in this install. PK,FK[File Format]. It is a comma separated Yes list of file format IDs that indicate the supported versions for this counter group. New versions may drop or add new counter groups entirely. It is a combination of File Format and Vendor Version. For example, if the file format is XML, CSV and the vendor version is G3, P5 , then ID can be CSV-G3 or XML-P5.

Counter Group

CELLTRAFFIC

CGroup Alias

CELLTRAF

Enabled FileFormatID(s)

Yes/No CSV-G3

Page 34

OPTIMA Installation Tool Version 6.1

About Parsed Counter Information


This table describes the fields on the Parsed Counters worksheet of the Interface Workbook Excel spreadsheet. This worksheet contains the Loader_File_Mappings table and Validator INI Configuration information.
Important :

You must ensure that: The first data row of the worksheet has the value VARCHAR2 for the Type field, and a size is specified in the Dateformat/Size field. The Dateformat/Size field is set to 0 when the Type field has value NUMBER for the first time in the worksheet.
Field
Counter Group

Description PK, FK [Counter Group]. For Parsed Counters,


the Counter Group must match up to a Counter Group Name in the Counter Group worksheet.

Mandatory
Yes

Example
CELLTRAFFIC

Parser File Header

PK. The output from a parser will contain a headerline. This field must match the name in the header for the column in the parser output. This is used to configure the validator INI and Loader_File_Mappings table.

Yes

SDCCH Call Drop

Optima Alias

When loading a file to the EXTERNAL table in No oracle, the field name must be less than 30 characters. This alias us used to standardise naming conventions to use the same loader for certain fields. If 'null', then the header is assumed for the column name in the EXTERNAL table. [VARCHAR2/DATE/NUMBER]. This indicates the type of the field as it is to be loaded into the external table. Yes

SDCCH_Call Drop

Type

VARCHAR2

Dateformat/Size

If type = VARCHAR2, then this sets the length of the Not Mandatory if 50 field in bytes. If type = DATE, then this describes the Type = Number ORACLE dateformat used to change the field from text into a DATE number. If Type=Date, then format of the date would be YYYYMMDDHH24MISS. Determines the order of the columns for Validator. Loader expects the columns to be in this order after validation. It is a numeric field. Indicates whether this column exists in the counter group for this install. Yes 30

Order

Enabled FileFormatID(s)

Yes Yes

Yes/No CSV-G3

PK,FK[File Format]. It is a comma separated list


of file format IDs that indicate the supported versions for this counter group. New versions may drop or add new counter groups entirely. It is a combination of File Format and Vendor Version. For example, if the file format is XML, CSV and the vendor version is G3, P5 , then ID can be CSV-G3 or XML-P5.

OPTIMA Installation Tool Version 6.1

Page 35

Field
Combiner Type

Description
[<null> / KEY / REMOVE / UNIQUE]. When combining this counter group, the field can have any of the following values: Key: It must match with other counter groups. Remove: While it exists in the parser output, it must be removed when combined. Unique: The field exists in multiple counter groups and must be kept for each counter group separately.

Mandatory
No

Example
UNIQUE

About Loaded Counter Information


This table describes the fields on the Loaded Counters worksheet of the Interface Workbook Excel spreadsheet. This worksheet contains the Loader_Table_Mappings table configuration information.
Field Description Mandatory Example CELLTRAF NVL (CGroup PK, FK [Counter Group]. For loaded counters, the counter Yes Alias, Counter alias is used to match to the counter group. This is used for Group) easy identification of functional groups and for splitting in Validator. If alias is <null>, then use the Counter Group Name. You can click the 'Add All Counters' button to autopopulate this column with information in the 'CGroup Alias' and the 'Counter Group' columns in the Counter Groups worksheet. Column PK. Name of the column in oracle. As multiple aggregations can extent the name by 4 characters, this should be less than 30 characters and ideally less than 26. You can click the 'Add all Counters' button to autopopulate this column with information in the 'Optima Alias' column in the Parsed Counters worksheet. If this column does not contain any information, then this field is populated with the information in the 'Parser File Header' column in the same worksheet. Yes CELL

Page 36

OPTIMA Installation Tool Version 6.1

Field Type

Description This classifies the column in terms of type of information stored in the column. It can have the following values: CT: Normal Counter PI: Primary Identifier. All fields that form part of the primary key should be set to either GPI or PI. Only one field can be classified as GPI. GPI: Grouping Primary Identifier. This field is used to determine the group element to group the summaries. For example, a table with a primary key of DateTime, BSC, and Cell would have GPI set to BSC and PI set to Cell. DT: Primary Date field DC: Delta Counter. This is used when the counter value is calculated by subtracting sequential counter values. Therefore, the original counter contains cumulative values. AC: Array Counter. This is used when a counter contains multiple subcounters within a single counter value. For example, it will be 3_5_6 if view is created giving access to individual sub counters. OI: Other Identifer. It indicates that it is a string or number that is not a measurement counter that helps identify information about the object but is not used as a part of the primary key. OD: Other Date. It indicates any meaningful date that is loaded into the table that does not identify the measurement part as the primay key.

Mandatory Yes

Example PI

Formula

WFK[Parsed Counter.File Header/Alias]. Any formula or value manipulation required to get from the parsed counter to the loaded value. This is used to populate the mapping values in the Loader_Table_Mappings configuration table. When Type = [OI, PI, GPI]. It determines the size of a VARCHAR2 column. Determines the order of the column in the tables. Indicates whether the column is to be loaded to the raw tables for this install.

No

OBJECTID

Size

Mandatory when 30 Type = [OI, PI, GPI] Yes Yes 3 YES CSV-G3

Order Enabled

FileFormatID( PK,FK[File Format]. It is a comma separated list of file format Yes s) IDs that indicate the supported versions for this counter group. New versions may drop or add new counter groups entirely. It is a combination of File Format and Vendor Version. For example, if the file format is XML, CSV and the vendor version is G3, P5 , then ID can be CSV-G3 or XML-P5. Aggregate TIME Determines the aggregation of the counter over time. Multiple Yes aggregations may be defined and these create multiple columns in Summary Objects using the aggregation as a column name extension. Possible values are MAX, MIN, SUM, AVG. If no aggregation is to be performed, use NULL. Determines the aggregation of the counter over elements. If the field value is 'null', then use AGG TIME. No

MAX

Aggregate Object Aggregate HOUR Comment

CELL MAX

Determines the aggregation of the counter up to the hour. This No is useful if the granularity is less than 60 minutes. If the field value is 'null', then use AGG TIME. Description of the column. This is used when the original counter name has to be shortened. No

CELL IDENTIFIER

OPTIMA Installation Tool Version 6.1

Page 37

About CFG Fields Information


This table describes the fields on the CFG Fields worksheet of the Interface Workbook Excel spreadsheet. You must complete this worksheet together with 'Hierarchy Chains', 'Hierarchy Fields' and 'CFG Tables' worksheets.
Field CFG Table Description PK, FK [CFG Table]. Indicates CFG table to which this field belongs. This is a combination of <network element> and CFG and is written as <network element>CFG. PK. The name of the field to be created in the CFG table. [VARCHAR / NUMBER / DATE]. The Oracle type of the field. Default = 'No'. It indicates whether the field is a primary key for the CFG table. If type = VARCHAR2, then this sets the 'length' of the field in bytes. Determines the order of the column in the Tables. Mandatory Yes Example CELLCFG

Field Name Type PK Size Order

Yes Yes No Not mandatory if Type = Number Yes It is mandatory if CFG table is a foreign key in Counter Group. It is mandatory if the value of the Populate field in the CFG Table is 'Yes'.

BSC VARCHAR2 No 30 1 SubNetwork

from File Config WFK[Parsed Counter.File Header/Alias]. The Data Loader formula utilising Parsed Counters from the Counter Formula Group associated to the CFG table, used to load information into this field. from Loaded Raw-Data Data Table Procedure Formula WFK[Loaded Counter.Column]. The formula utilising loaded counters from the Counter Group associated to Raw Tables(s) associated to the CFG table, used to load information into this field.

BSC

Page 38

OPTIMA Installation Tool Version 6.1

About Hierarchy Chain Information


This table describes the fields on the Hierarchy Chains worksheet of the Interface Workbook Excel spreadsheet. You must complete this worksheet together with the CFG Fields, CFG Tables, and Hierarchy Fields worksheets.
Field CFG Table Description PK,FK [CFG Table]. This is the Config table that the Hierarchy Chain will use as the table in any SELECT statement. This is a combination of <network element> and CFG and is written as <network element>CFG. Mandatory Yes Example CELLCFG

Hierarchy Unique ID

PK. Unique identifier for the hierarchy. This field Yes contains a hierarchy of all the hierarchy elements specific to a particular configuration table. For example, In a CELLCFG table, we might have a hierarchy of BSC and Cell. The chain is this case would be B_C where B is BSC and C is Cell. The value defined in the default hierarchy ID should correspond to the 'Hierarchy Unique ID' column in the Hierarchy Chains tab of the Interface Workbook Excel sheet. Description of the hierarchy. No

N_B_C

Hierarchy Name Where Clause

Default Cell Hierarchy

The WHERE clause in the SELECT statement has No the filtering is to be applied for the hierarchy.

About Hierarchy Field Information


This table describes the fields on the Hierarchy Fields worksheet of the Interface Workbook Excel spreadsheet.
Field Hierarchy Unique ID Description PK, FK [Hierarchy Chain]. This field contains a hierarchy of all the hierarchy elements specific to a particular configuration table. For example, In a CELLCFG table, we might have a hierarchy of BSC and Cell. The chain is this case would be B_C where B is BSC and C is Cell. The value defined in the default hierarchy ID should correspond to the 'Hierarchy Unique ID' column in the Hierarchy Chains tab of the Interface Workbook Excel sheet. Mandatory Yes Example N_B

Element Level Name of the element. This should be consistent across the interface. Formula from CFG Table The LOOKUP formula for element level.

Yes No No

BSC BSC_NAME BSC_ID 1

Element Alias Shortened version of the element level. Override Hierarchy Level

This describes the sequence of the hierarchical structure. Yes It indicates the order of element level in hierarchical structure. It is a numerical value.

OPTIMA Installation Tool Version 6.1

Page 39

About Default Element Level Alias Information


This table describes the fields on the Default Element Level Alias worksheet of the Interface Workbook Excel spreadsheet.
Field Element Level Description PK. Element level for which to describe an alias. This column is populated with a distinct list of available element levels used for the interface. It includes the element level names used in the primary key of raw and summary data. For example, for BSS GSM, it can be {BSC, CELL, NBRCELL}. Mandatory Yes Example BSC

Element Alias

Default shortened version of the element level. The Yes shortened versions are mainly used in the Summary and Busy Hour tables. When summaries and BH Summaries aggregate data to a specific element level, the element alias for that level is included in the summary table name. For example, standard element alias for Network = NW, Cell = CL, Neighbour Cell = NCL, BSC = BSC, Region = R, City = CTY.

NCL

About Summary Definition Information


This table describes the fields on the Summary Definition worksheet of the Interface Workbook Excel spreadsheet. This worksheet defines the generic summary tables. The ADD Hourly, Add Weekly, Add Monthly, and Add Daily buttons will add the appropriate entries to the worksheet automatically by referring to the Raw Tables worksheet.
Field Base Table Description Mandatory Example CELLHANDOVER PK,FK [Raw Table]. The name of the raw table. Yes The columns and data for the Summary report are based on this table. PK, FK [Summary Type]. This is the name or ID of the Summary Type. This is used to determine the Time-based aggregation of the Summary Report. Possible values are HR, DY, WK, and MO It is mandatory if Element Aggregation is NULL.

Aggregation

DY

Element Aggregation Hierarchy ID

PK,FK [Hierarchy Field, Element Level]. If this Yes field is used, the Summary Report aggregates the Raw data up to the level specified in this field. WFK [Hierarchy Chain]. If this field is defined, No then this overrrides the Hierarchy to perform the aggregation to the Element Aggregation. This field contains a hierarchy of all the hierarchy elements specific to a particular configuration table. For example, in a CELLCFG table, we might have a hierarchy of BSC and Cell. The chain in this case would be B_C where B is BSC and C is Cell. The value defined in the default hierarchy ID should correspond to the 'Hierarchy Unique ID' column in the Hierarchy Chains tab of the Interface Workbook Excel sheet.

NBRCELL

N_NB_NC_B_C

Page 40

OPTIMA Installation Tool Version 6.1

About BusyHour Definition Information


This table describes the fields on the BusyHour Definition worksheet of the Interface Workbook Excel spreadsheet.
Field Base Table Description PK,FK [Table]. The formula and data are defined against this raw table in the Summary Report. Mandatory Yes Example CELLSTATS

BH Name

PK. Short name for the BusyHour Definition Yes that is used in the Name for the BusyHour_<BH Name> and all BH Summary tables using this Busy Hour Definition. For example, for a BH based on Erlang, the BH Name would be ERL.

ERL

BH Formula FileFormatId(s)

The formula for the busy hour.

Yes

THCALLS CSV-G3

PK,FK[File Format]. It is a comma separated Yes list of file format ids that indicate the supported versions for this counter group. New versions may drop or add new counter groups entirely. It is a combination of File Format and Vendor Version. For example, if the file format is XML, CSV and the vendor version is G3, P5 , then ID can be CSV-G3 or XML-P5. This is a Boolean value field. If the Base Table No has data that is sub-hourly, then if a rolling busy hour has to be calculated, set to TRUE. A rolling hour means 60 minutes from the DateTime and not a 'calendar' hour which is the 60 minutes between xx:00 and xx+1:00.

Rolling Hour

Yes/No

To Hour Aggregation If the Base Table has data that is sub-hourly, No then this is the aggregation of the formula to 60 minutes whether that is rolling or not. Hierarchy Aggregation If the BH Definition is used at an Element Level No that is NOT the element level of the Base Table, then this is the aggregation of the formula to the defined Element Level A WHERE clause on the Base Table to apply in No the Summary Report. User input to describe the BusyHour Definition. No It is added to the Summary Report as part of the description.

MAX

MAX

Where Clause Description

BH Cell Erlang Busy Hour

OPTIMA Installation Tool Version 6.1

Page 41

About BusyHour Table Information


This table describes the fields on the BusyHour Tables worksheet of the Interface Workbook Excel spreadsheet.
Field BH Name BH Table Name Ext Description PK<FK [BusyHour Definition]. This is the BH name defined in the BH Definition. This is a default formula that uses the first character of the Busy Hour Level instead of its alias. This is constructed as <Busy Hour Level.Alias>_<BH Name>_<BH Type>. PK. Sets the Type of Busy Hour calculation. For Example, [DYBH / WKBH / BDBH / BHBD / AHBH] where: DYBH = Day BH WKBH = Week BH BDBH = Week Rank Busiest Day's BH BHBD = Week Rank BH for the Busy Day AHBH = Busiest Week Average for Hour Hierarchy ID WFK [Hierarchy Chain]. If the default is not required, then this should be set to [Hierarchy Chains.Hierarchy Unique ID]. No N_B Mandatory Yes Yes Example ERL BSC_ERL_DYBH

Busy Hour Type

Yes

DYBH

BusyHour Level

PK. Identifies the element level against the Base Yes Table's Associated CFG table at which level of aggregation the BH calculation is ranked. For example, TCH BH Definition has a base table of CELLSTATS, which has a CFG table of CELLCFG which has three hierarchies - one or more of which has BSC as a level. The BH is calculated to the BSC level according to the hierarchy formula on the CELLCFG table joined with CELLSTATS. [High/Low]. Order of the formula that results for ranking function. Sets the ranking to store: Rank From to Rank To. If these two values are equal, then only one BH period is stored. If Rank From = 1, and Rank To = 3, then three BH periods are stored. Yes No

BSC

Order Rank From

High/Low 1

Rank To

You must populate these columns with two integer values. To find only the Busiest Hour, set both values to 1 (this is the Default).

No

Page 42

OPTIMA Installation Tool Version 6.1

About BusyHour Summary Information


This table describes the fields on the BusyHour Summary worksheet of the Interface Workbook Excel spreadsheet.
Field Base Table Description PK,FK[Table]. The name of the base table from which the columns and data are obtained for the Summary Report. Mandatory Yes Example CELLSTATS

BH_Table Name PK,FK [BusyHour Table]. The Busy Hour Table used to Yes Ext determine which hour was the busiest for the element. Hierarchy ID WFK [Hierarchy Chain]. The Hierarchy ID used to track from the Busy Hour Table Element Level to the Busy Hour Summary Element Level. No

CELL_ERL_DYBH N_B_C_NC

Hierarchy Aggregation Multi-Rank Average

PK. The Element Level for the Base Table to be Yes aggregated to according to the Busy Hour Element Level Busy Hour(s) . Default=NO If the Busy Hour Table has Rank From <> Rank To, then a Multi-rank average can be calculated in the Summary as a single row (no BUSYHOUR timestamp value). If NOT, then all ranked hours will be put into the summary. No

BSC

YES

Include BH Level Default=NO If the BH Element Level <> Hierarchy Aggregation Element Level, then decide whether or not to include the element name from the BH table in the resulting Busy Hour Summary.

No

YES

OPTIMA Installation Tool Version 6.1

Page 43

Creating an Interface Workbook


Creating an interface workbook consists of the following tasks: 1 2 3 4 5 6 7 8 9 Identifying the File Format and Version ID Mapping Parser Out Combining Objects Validating Loading Creating CFG Tables Defining Hierarchies Creating Summaries Busy Hours

Identifying the File Format and Version ID


FileFormatID is a user defined identifier for a particular combination of the file format (ff) and the vendor version (vv). It is commonly written as ff_vv. The file format for different vendors is:
Vendor Siemens Ericsson Nokia File Format Binary and ASCII IOG and APG ASCII and Database R10 IOG_R10 Vendor Version Example

Maximum length of the FileformatID is 7 characters. To fill in information about the file format and version ID: 1 2 3 4 Go to the File Formats worksheet of the Interface spreadsheet. In the File Format column, fill in the file format. In the Version column, fill in the version. In the FileFormatID column, combine the file format and version and specify it. For example, if the file format is IOG and version is R10, then the FileFormatID could be IOG_R10. 5 In the Enabled column, select the 'YES' value from the drop-down list. This will turn the file format ON for the entire installation.

Page 44

OPTIMA Installation Tool Version 6.1

Mapping Parser Out


This section enables you to map the parser output. To do this: 1 2 3 Open the Parsed Counters worksheet. In the Parser File Header, specify the header of the parser file. This is the name of the output of the parser. In the Order column, specify the order of the columns for the validator. The Loader will expect the columns to be in this order after validation. 4 5 In the Type column, specify the type of the field as it should be loaded into the external table. In the Dateformat/Size column, specify the format of the date. If type = VARCHAR2, then it will set the length of the field in bytes. If type = DATE, then this will describe the ORACLE dateformat that will be used to change the field from text into a date number. 6 In the FileFormatID(s) column, specify the fileformatID that you have identified in the previous section. For more information, see Identifying the File Format and Version ID on page 44. In the Optima Alias column, specify the alias for the parser file header, This alias must be ORACLE compliant. Open the Counter Groups worksheet. Click the Add Counter Groups button the worksheet. . This will partially populate

7 8 9

10 In the Enabled column, specify YES. 11 In the FileFormatID(s) column, specify the fileformatID that you have identifaied in the previous section.

OPTIMA Installation Tool Version 6.1

Page 45

Combining Objects
It is possible to combine counter groups having the same Primary Keys before loading. This also helps to remove the fields that might cause conflict when joined. If there are fields of the same name in different counter groups, then we can keep them as UNIQUE after the join. To combine objects: 1 2 3 4 Open the Parsed Counters worksheet. Select two identical parser file headers and in the Combiner Type column, mark them as KEY to create a join between the two counter groups. Open the Counter Groups worksheet. In the Tablename column, set the tablename for all Counter Groups to be combined into the same table in accordance with standards. Click the Filter by Table button 5 6 7 Open the Raw Tables worksheet. Click the Add Raw Tables button to add the raw tables. In the Combiner column, set value as 'YES' for the corresponding table. to filter the list of Parsed Counters.

Validating
Validation performs the following two functions: It guarantees the order of the columns in the file It splits one file into two output files The Splitting functionality is useful when the number of columns in the input file exceeds the number of columns in the database. The OPTIMA Installation Tool does not currently support the splitting functionality. To validate: 1 2 Open the Parsed Counters worksheet. In the Counter Group column, specify the counter group. This should match up to a Counter Group Name in the Counter Group worksheet. 3 In the Parser File Header column, specify the header of the parser file. This should match the name in the header for the column in the parser output. This is used to configure the validator INI. 4 In the Order column, set the Parsed Counters order. This determines the order of the columns for the Validator. The loader expects the columns to be in this order after validation.
OPTIMA Installation Tool Version 6.1

Page 46

When combined, the validation order is set by the parsed order.


Counter Group MG1 MG1 MG1 MG2 MG2 MG2 Parser File Header C1 MG1_C2 MG1_C3 C1 MG2_C2 MG2_C3 Order 1 2 3 1 2 3

This picture shows an example:

In the Enabled column, specify whether the column exists in the counter group for this installation. If it does, select YES.

Loading
WIth the loading process, you can load: Combined or single objects into a table Multiple objects into a table For the loading process, you need to: Identify the column Enter the type - specify OI: Other Identifier, OD: Other Date Provide a formula Specify the Order: the order that you want to see in the raw table Assign the CounterGroupName or the CounterGroupAlias if it has been set previously The PI, GPI, and DT are combined to make the primary key and they must be consistent for all objects that have the same raw tables in the CG. They also need to have the same order. Ensure that the Enabled column is set to YES.

OPTIMA Installation Tool Version 6.1

Page 47

To load counters: 1 2 Open the Loaded Counters worksheet. Click the Add All Counters button . This populates the worksheet with all the counters from the Parsed Counters worksheet where the column Enabled has been set to 'YES'. If an alias has been defined for the counter group, then the alias will be automatically used. 3 In the Type column, specify the Type. This indicates the type of the field as it is to be loaded into the external table. For more information on Type, see About Loaded Counter Information on page 36.

Creating CFG Tables


There are two ways of loading config into Config Tables: Using a procedure to populate Config Tables from Raw Data Tables: 1. Set all the raw tables that report on the same network element and share the same config table. The information in the raw table is needed to update the CFG table. 2. Name the network element level. 3. In the CFG Fields Information worksheet, set the columns that the config table has. The field from Loaded Raw-Data Data Table Procedure formula is the formula used to perform a SELECT on the raw table to return the value for the field. Rules: Primary Key must have the formula for all raw tables Everything else must at least work for one raw table If it is not a Primary Key and works for multiple raw tables, then maximum return value for the formula is used

Loading an external file into the config table on a periodic basis This is not currently supported by the OPTIMA Installation Tool.

Page 48

OPTIMA Installation Tool Version 6.1

Defining Hierarchies
This always relates to the Config Tables. 1 Define the config table it is based on, and a unique identifier. The identifier is usually an under_score concatenation of the network elements in the hierarchy. For example, if the hierarchy of network elements is Network_BSC_CELL, then the unique identifier would be N_B_C. Go to the config table and define the default ID as N_B_C. Hierarchy fields relate to CFG fields. All information in the Hierarchy Fields worksheet is taken from the CFG Fields worksheet by name or formula. Hierarchies are in a 1:N tree structure. When networks are not 1:N, we must define the multiple hierarchies to support them. This picture shows an ideal hierarchy:

2 3

In reality, the hierarchy that results is:

In such a situation, we define the following:

+ 4 5 Element Aliasing We define a short name for the network element. For example, CELL = CL For a specific hierarchy element level, we can override the alias value in the Element Alias Override column in the Hierarchy Fields worksheet. The purpose of creating an alias is for naming the tables. For example, CELLSTATS_CELL = CELLSTATS_CL

OPTIMA Installation Tool Version 6.1

Page 49

Creating Summaries
Creating Summaries affects Loaded Counters and Summary Definitions worksheets. In Loaded Counters, the field is Aggregate_Time and Aggregate_Hour and object is not used. For each column in loaded counters, we define how each column is aggregated. Use comma separation if multiple aggregation is required. To create summaries: 1 2 Open the Loaded Counters worksheet. Set values for the following columns: Aggregate Time: This is recommended for the OI and OD type. It is the aggregate formula used by Summary to sum, min, max, and average the counters in the summary. If NULL is used, this excludes the counter from aggregation. Aggregate Object: Is the aggregate formula used for the counter over objects rather than time. When it is left empty, aggregation over time is assumed. Aggregate Hour: In sub performance data, this may be used to aggregate the counter to the hour in a different way than you normally aggregate over time.

Page 50

OPTIMA Installation Tool Version 6.1

Power Tools
The Power Tools have been designed to help you create, amend or review interface templates. The Power Tools enable you to: Create an interface template from an existing installation Merge two existing 6.1 interface templates for the same interface Report on differences between two templates for the same interface Migrate 1.4x interface templates to 6.1 interface templates Remove a file format/version from the 6.1 interface template Create a blank 6.1 interface template Display a 6.1 interface template

Generating a 6.1 Interface Template from Existing Sources


This option enables you to create and populate interface templates from the information in an existing installation's configuration. The primary benefit of this option is that it can significantly speed up the deployment and installation process. You can select the configuration data from three sources: Database INI files Parser Out

OPTIMA Installation Tool Version 6.1

Page 51

To use this feature: 1 2 3 4 5 From the Tools menu, click Power Tools. In the dialog box that appears, click Next. Select the Generate a 6.1 Interface Template option. Click Next. Select the required source(s). You can select: Both Database and Parser Out - or Database only - or Parser Out only

Whichever permutation you select, you can choose to include or exclude the INI files. 6 Click Next. The following steps vary according to which source selections you have made. Steps when Database has been Selected as a Source 1 Specify the database connection details in the available drop-down and edit boxes.

When you have specified these details, a message prompt appears. Click this to test the connection and the existence/accessibility of the tables.

If the test is successful, the Database Source Options are enabled.

Page 52

OPTIMA Installation Tool Version 6.1

Select the schema to use from the drop-down list, as in this example:

When all database details have been specified and tested (using the message prompt), the grid will show a list of the available tables. 4 Click Next.

Steps when INI Files have been Selected as a Source 1 Specify the folder locations containing the INI file information of the existing installation. It is possible for you to leave the folder with Combiner INI files empty and still continue.

2 3

When you have specified three valid folders, a message prompt appears. You can click this to preview the INI files. Click Next.

OPTIMA Installation Tool Version 6.1

Page 53

Steps when Parser Out has been Selected as a Source 1 Specify an 'Out Folder' that contains the sample Parser Out information.

If all the sample files are in one single folder (as opposed to subfolders) then you can select the 'Output in Single Folder' checkbox. For this option, you must provide a valid regular expression to extract the counter name from each sample file. If you want all files for each measurement object to be read (rather than just one file), select Scan All Files. You can preview the counter group names, by clicking the appropriate prompt message. Click Next.

3 4 5

Specifying the File Format 1 2 Specify the File Format and File Format Version. Click Next.

Running the Tasks The Creating Interface Data screen now appears, listing all the tasks to be performed. 1 2 Click Start. Wait until all the tasks change their state from Not Started to Finished. Click Finish. The Interface dialog box opens, showing the interface template that has been created. You now have the opportunity to save the template. For information on this, see Saving an Interface Template on page 55.

Page 54

OPTIMA Installation Tool Version 6.1

Saving an Interface Template


For all of the options within the Power Tools (except the reporting option), you have the opportunity to save the Interface Template. This section explains how to do this, at the stage where you are viewing a template in the Interface dialog box: 1 In the Interface dialog box, from the File menu, click Save. The Save Interface dialog box appears. You can now specify the interface and retention period details. 2 3 4 5 6 In the Vendor text box, specify the name of the vendor. From the Technology, Domain, Subdomain and Portal drop-down lists, select the appropriate choices. From the Raw/Hourly Data, Daily Data, Weekly Data, and Monthly Data dropdown lists, select the appropriate choices. Click Browse. The 'Save As' dialog box appears. Choose a location where you want to save the template on your local machine, and then click Save. The tasks to save the interface template are then listed in the grid of the Save Interface dialog box. This picture shows an example:

OPTIMA Installation Tool Version 6.1

Page 55

7 8

In the Save Interface dialog box, click Save. Each task is performed, and when the state for each task changes from Not Started to Finished, the template is saved. Click Close to exit.

Merging Two Interface Templates


This section enables you to merge two interface templates that have the same interface. The purpose of this is to collate information from two different interface templates into one. The two templates must have the same interface (in terms of vendor and technology). To merge two interface templates: 1 2 3 4 5 6 7 From the Tools menu, click Power Tools. In the dialog box that appears, click Next. Select the Merge Two Interface Templates option. Click Next. In the Master Interface field, click Select to browse and select the interface template that you want to set as the master. In the Source Interface field, click Select to browse and select the interface template that you want to set as the source. Click Next. The tasks to perform this operation are listed. This picture shows an example:

8 9
Page 56

Click Start. Wait until all the tasks change their state from Not Started to Finished. Click Finish.
OPTIMA Installation Tool Version 6.1

The Interface dialog box opens, showing the interface template (with merged values) that has been created. You now have the opportunity to save the Interface Template. For information on this, see Saving an Interface Template on page 55.

Reporting on Differences Between Two Interface Templates


This option enables you to report on differences between two templates. The two templates must have the same interface (in terms of vendor and technology). To do this: 1 2 3 4 5 6 7 8 From the Tools menu, click Power Tools. In the dialog box that appears, click Next. Select the Report on Differences option. Click Next. Select the appropriate source files. Click Next. The tasks to perform this operation are listed. Click Start. Wait until all the tasks change their state from Not Started to Finished. Click Finish. Black: records exist in both source files Blue: records exist in source file 1 only Green: records exist in source file 2 only The report opens with the differences listed in three colours:

OPTIMA Installation Tool Version 6.1

Page 57

Removing a File Version/Format from an Existing Interface Template


This option enables you to remove a specific File Version/Format from an existing interface template. In other words, it enables you to remove all records relating to a specific FileFormatID. To do this: 1 2 3 4 5 6 7 8 9 From the Tools menu, click Power Tools. In the dialog box that appears, click Next. Select the Remove File Version/Format option. Click Next. Select the appropriate interface template. Select the FileFormatID you want to remove. Click Next. The tasks to perform this operation are listed. Click Start. Wait until all the tasks change their state from Not Started to Finished. Click Finish. The Interface dialog box opens, showing the edited interface template that has been created. You now have the opportunity to save the template. For information on this, see Saving an Interface Template on page 55.

Migrating 1.4.x Interface Templates to the 6.1 Format


This option enables you to update 1.4.x templates to the format of 6.1 templates. To do this: 1 2 3 4 5 6 7 8 From the Tools menu, click Power Tools. In the dialog box that appears, click Next. Select the Migrate 1.4.x Interface Templates option. Click Next. Select the appropriate 1.4x interface template. Click Next. The tasks to perform this operation are listed. Click Start. Wait until all the tasks change their state from Not Started to Finished. Click Finish.

Page 58

OPTIMA Installation Tool Version 6.1

The Interface dialog box opens, showing the updated interface template that has been created. You now have the opportunity to save the template. For information on this, see Saving an Interface Template on page 55.

Displaying an Existing Interface Template


This enables you to display the interface template once it has been populated with values. To display an installed interface: 1 2 3 4 5 6 7 From the Tools menu, click Power Tools. In the dialog box that appears, click Next. Select the Display Interface Template option. Click Next. Click Select to browse to the location where the interface template that you want to open is saved. Select that interface template. Click Next. The tasks to display an interface are listed. This picture shows an example:

8 9

Click Start. Wait until all the tasks change their state from Not Started to Finished. Click Finish.

The Interface dialog box opens, showing the interface template populated with values. You now have the opportunity to save the template. For information on this, see Saving an Interface Template on page 55.

OPTIMA Installation Tool Version 6.1

Page 59

Adding an Interface Workbook to a Project


To add an interface workbook to a project: 1 2 Open the project to which you want to add the interface workbook. Right-click Interfaces and select Add Interface.

The Add Interface:Workbook dialog box appears 3 Click Browse to select the interface workbook that you want to add to the project.

Click Next. The Interface Properties dialog box appears. The Interface Properties dialog box appears only when you add a new interface. If you add another version of an existing interface, this dialog box does not appear.

Page 60

OPTIMA Installation Tool Version 6.1

Select the Machine ID from the drop-down list.

Click Finish.

Validating an Interface Workbook Template


You need to validate the interface workbook template that you have created. It normally happens during interface workbook creation. To validate interface workbook template: 1 2 3 From the Tools Menu, click Validate Template. The Excel Interface Validation dialog box appears. Click Browse to select the interface workbook Excel sheet that you want to validate. Click Validate. A list of error messages that occurred during validation appears.

OPTIMA Installation Tool Version 6.1

Page 61

Click Export Validation XML to export the errors to an XML file. -orClick Export Errors to export the errors to a CSV file. You need to fix these errors in the Excel files.

Uploading an Interface to the Database


To upload an interface to the database: 1 2 3 4 From the File Menu, click Open Project. Browse to the project location and select the project. From the File menu, click Database Login. Right-Click the appropriate Version and select Upload Interface.

The dialog box that appears lists the tasks to be uploaded. 5 Click Start.

Page 62

OPTIMA Installation Tool Version 6.1

This picture shows an example of the Upload Progress dialog box.

It provides the following information: Source of the task State of the task Time Start Time of the upload Running Time of the upload End Time of the upload Click Cancel to stop the upload during the upload process. 6 Click Exit to close the dialog box. You can click View Log to see the log messages once the upload is finished. The interface is uploaded to the database.

OPTIMA Installation Tool Version 6.1

Page 63

Activating an Interface
To activate an interface: 1 2 Ensure that there is at least one interface template uploaded to generate a revision. Select the Vendor Interface <Revision_Number>, right-click and select Activate Interface. The Activate Interface screen opens.

The Activate Interface screen displays all the activation objects such as loaders, combiners, and validators for a particular revision. It displays all the existing objects in the Activation Tree in a green colour. The combiner, validator, loader operations which have an entry in the AIRCOM.INSTANCES table are displayed in a yellow colour. It contains the following panes: Activation Tree: Lists the activation objects, type of activation objects, version and format. Database Operations: Lists the various database operations. The check boxes enable you to selectively activate a particular operation. It is not possible to deactivate the Busy Hour Summary database operation without deactivating the corresponding Busy Hour database operation. Additionally, it is not possible to deactivate raw table database operation. Detail: Lists the details of the various activation objects selected in the activation tree pane. For a particular schema, the Details pane shows all the ORACLE objects within that schema.

Select the Database Operations to be activated. You can select the Create Partitions checkbox to run the OSS Maintenance Package to create table partitions.

Page 64

OPTIMA Installation Tool Version 6.1

Click Activate. A dialog box is displayed indicating that a backup of the AIRCOM schema is created in the AIRCOM_BACKUP schema. Click OK. The activation process creates the objects that have been defined in the interface revision. For example, if you activate the CFG tables, then the activation process will compare the columns that have been uploaded with the columns that already exist in the database and then will add any columns that do not already exist. The objects that now exist in the database are marked in Green after the activation process. INI files and batch files are always recreated during the activation process and existing files are overwritten.

5 6

Click Working Folder on the Activate screen to open the working folder. After activation is complete, the deployment scripts are copied to the working folder. Copy all the files in the <Mediation_ID> folder in the working directory to the mediation device. You need to manually set the home directory for the OPTIMA backend referenced by the environment variable $OPTDIR (UNIX OS) or %OPTDIR% (WIN OS) before running the deployment scripts.

Click Close to exit. Click Activation Log to see the activation log. It lists the following details: Log Message Severity Date Time Client Machine

In the Log Display window, click Export to export the activation log messages to a file in the CSV format. You can also select the Show Preview Row checkbox to expand the log message details. In case, you click Activate again without closing the original activation screen, a dialog box will appear asking you to keep or override the current backup.

OPTIMA Installation Tool Version 6.1

Page 65

Generating a Decommissioning Report


Whenever an interface activation takes place for upgrade or modification, there might be a difference in the two revisions. This difference may be due to manual database changes, or different vendor software versions. In such a scenario, some of the database objects become deprecated. In other terms, it means that some of the objects might not be needed by the new revision. For example, a raw table in an activated interface could have 20 columns. When you upload the new revision, of the same interface, if the same table now needs only 15 columns, then the 5 odd columns will be reported as deprecated. The Decommissioning Report presents these deprecated objects from the database. It reports on the following objects as deprecated: Tables: All tables which were created during earlier activation but which are not included in the selected revision for comparison Columns: All database table columns which are not needed any more, even if their tables are part of the current revision Old Summary Configuration: This information is extracted from the information held in the GENERIC_SUMMARY_REPORTS table New Summary Configuration: This information is extracted from the information held in the OPTIMA_SUMMARY_REPORTS table Instance: All configuration information for the different executable instances which are not relevant for the selected interface revision Loader Configuration: All configuration information for all loader instances which are not relevant to the selected version Notes: Once the Decommissioning Report presents this information, you can delete or archive these specified objects. It may help space utilisation and improve performance. Objects that are still valid in terms of stored data may still be reported as deprecated. It may be necessary to wait until the data has been purged from the database before removing the object.

To generate a Decommissioning Report: 1 2 Ensure that you have activated an interface. For more information on this, see Activating an Interface on page 64. Right-click on the revision number for which you want to generate the report, and from the menu that appears, click Decommissioning Report. The Decommissioning Report for the selected version opens. It lists the tables, columns, old and new summary configuration, instance, and loader configuration information that is no longer needed for this version.

Page 66

OPTIMA Installation Tool Version 6.1

This picture shows an example:

Click Collapse all/Expand all to collapse/expand all the details. You have the option to export the decommission report in HTML or XML format. To do so, click the button and save the report to the appropriate location and in the required format.

OPTIMA Installation Tool Version 6.1

Page 67

Reusing PRIDs
For an older version of an OPTIMA installation (pre V6.1), the AIRCOM INSTANCES table does not contain the following columns: Vendor Version File Format Tablename Each row in the AIRCOM INSTANCES table defines an OPTIMA process. Each process is identified by its PRID (AIRCOM Process Identifier). The PRID is formed by concatenating values in the following columns: MACHINEID PROGID INSTID There are multiple instances of combiners, validators and loaders for each vendor version, file format, and object. Hence, during activation, it becomes necessary to identify each instance with a unique Process IDs (PRID). To avoid duplicates, when you are upgrading an OPTIMA installation using version 6.1 of the OIT, this functionality enables you to associate existing PRIDs with their respective vendor version, file format, and object, and to update the AIRCOM INSTANCES table with that information. The OPTIMA Installation Tool will attempt to reuse any AIRCOM INSTANCES records which match the current vendor version, file format and object. This is the basis of the PRID Re-use function. Reusing PRIDs is only necessary for combiners, validators and loaders and only when an upgrade is taking place. New vendor versions, file formats, and objects which cannot be matched to an AIRCOM INSTANCES record will generate a new PRID and a new INSTANCES record. Summary Process is vendor-neutral and therefore there is no need to reuse PRIDs.

Page 68

OPTIMA Installation Tool Version 6.1

To reuse PRIDs: 1 Select the <Revision_Number>, right-click and from the menu that appears, click Reuse PRIDs. The Reuse PRIDs window that opens displays the data from the AIRCOM Instance Table. For every instance of a combiner, validator, and loader for which you want to reuse a PRID, select the particular row.

From the Vendor version, File format and Operation object name drop-down lists, select the correct values. You can get the correct values for any instance from the respective INI files.

Click Apply.

OPTIMA Installation Tool Version 6.1

Page 69

Viewing INI Files


After you activate an interface, you can view the generated INI files. To do this: 1 2 Ensure that you have activated an interface. For more information, see Activating an Interface on page 64. Select the <Interface Name>, right-click and select View INI Files. The INI Files dialog box that appears lists the INI files that have been generated for the combiner, data validation and loader. This picture shows an example:

Click any INI File in the left hand pane to see the respective key and value in the right hand pane. You can also edit the combiner, validation and loader path.

Page 70

OPTIMA Installation Tool Version 6.1

Exporting an Interface File


You can export an interface template from the database to an Excel sheet. To do this: 1 2 3 4 Select the <Revision_Number>, right-click and from the menu that appears, click Export Interface File. Select the location where you want to export this interface file. In the File name, specify a name for the interface file. Click Save. The interface file is now stored at your specified location.

Refreshing the Interface Name


It is possible for you to change the interface name. To do this: Select the <Revision_Number>, right-click and from the menu that appears, click Refresh Interface Name. The OIT will read the custom properties Vendor, Technology, Domain, subdomain and portal from the interface template. This sets the interface name on the tree to format Vendor_Technology_Domain_subdomain_portal.

OPTIMA Installation Tool Version 6.1

Page 71

Troubleshooting
I cannot log in to the database with the tool after I run Setup.exe Ensure you have installed the API and data dictionary in the OSS_DICTIONARY schema. This is available in distribution under Management Tools, program code 431. Follow the installation instructions to install the API, then log on to the tool as oss_dictionary/password. I have applied patch 1.0.x and now I want to go to patch 1.0.y Simply download and run the latest patch installer, as long as you are on a 1.0.x version you can re-install the previous updates without any issues. The tool is not responding, what should I do next? The tool can sometimes take several hours to complete an upload or an activation. However occasionally, the tool finishes processing but freezes. To find out what the tool is doing, run the following query: SELECT * FROM OSS_DICTIONARY.LOG_EVENT ORDER BY EVENT_DATETIME DESC The log messages refer to IDs, how do I know what tables this is referring to? The DD_OBJECT table enables you to see which object the ID refers to. The DD_OBJECT table should never be altered, however, it can be queried to retrieve the object. For example, for the log messageFunction ACT_ON_RAWTABLE processing objectid 309925 with activation value 1, the following query can be run: SELECT OBJECT_NAME FROM DD_OBJECT WHERE OBJECT_ID=309925 I get an error when I validate my template. How should I resolve this? The validation results will show which spreadsheet in the workbook the error applies to and the error that is encountered. The template can be re-validated by selecting Validate Template from the Tools menu. The SQL that is used in the validation can be found by clicking on 'Export Validation XML', any rows brought back by the queries signify an error in the template workbook. I am trying to add a new project to my database, but I get an error There is a limit of one project per database. So 1 project -> 1 database -> 1 customer -> 1 project file. New interfaces can be added to the same project, but two projects cannot exist in the same database. I have defined some summaries, but they have not been included when I upload/activate the interface This is normally caused by a lack of hierarchy information. In the current version of the installation tool, all summaries must have hierarchies defined. Either a hierarchy must be defined per summary in Summary Defn.Hierarchy ID, or more simply CFG Tables.Default HieraerchyID must be populated for the CFG table associated with the raw base table in the Raw Tables spreadsheet. I get an error about VARCHAR2a when compiling an Optima Backend package

Page 72

OPTIMA Installation Tool Version 6.1

You need Oracle 9.2.0.3 or above and you need to ensure that the catalogue (Oracles catpatch) has been migrated successfully for varchar2a to be usable. To run the catpatch for the database do the following: sqlplus sys/<password>@<optimadb> as sysdba SQL> Shutdown immediate SQL> Startup migrate SQL> @?/rdbms/admin/catpatch.sql How should I update a pre 6.1 interface template file to the official 6.1 interface template file? You should use the migrate operation in the Power Tool wizard and save the interface. How should I update a beta 6.1 interface template file to the official 6.1 interface template file? You should use the display interface operation in the Power Tool wizard and save the interface.

OPTIMA Installation Tool Version 6.1

Page 73

Page 74

OPTIMA Installation Tool Version 6.1

Hierarchy Chain Information, about 39 Hierarchy Field Information, about 39

Index
A
Alias Information, default element level 40

B
BusyHour definition information 41 summary information 43 table information 42

C
CFG fields information 38 table information 33 Counter Group Information, about 34 Creating interface workbooks 44 projects 16

D
Database connection properties 24 server machine properties 24 Defaull Element Level Alias Information, about 40 Defining blank interface workbook 44 global parameters 27 project 16 Definition Information busyhour 41 summary 40

Information (root) busyhour definition 41 busyhour summary 43 busyhour table 42 cfg fields 38 CFG Table 33 default element level alias 40 hierarchy chain 39 hierarchy field 39 Information counter group 34 file format 32 raw table 34 loaded counter 36 parsed counter 35 summary definition 40 Interface activating 64 uploading to database 62 Interface Workbook about 29 adding to a project 60 busyhour definition information 41 busyhour summary information 43 busyhour table information 43 cfg fields information 38 cfg table information 33 counter group information 35 default level alias information 40 file format information 32 hierarchy chain information 39 hierarchy field information 39 loaded counter information 36 raw table information 34 summary definition information 40 validating 61

L
Loaded Counter Information, about 36 LUNS Defintion, updating 25

M
Menu Button, using 30

F
Fields CFG information 38 hierarchy information 39 File Format Information, about 32

O
OSS Installation Tool, about 9

G
Global Parameters,defining 27

P
Parameters Global 27 Project adding an interface workbook 60 creating 16 updating properties 23, 24, 44 uploading information 27 Properties, updating 23, 24, 25

H
Hierarchy chain information 39 field information 39

OPTIMA Installation Tool Version 6.1

Page 75

R
Raw Table |nformation, about 34

S
Summary Definition Information, about 40

T
Table Information busyhour 42 CFG 33

U
Updating database connection properties 24 database server machine properties 24 general properties 24 LUNS properties 25 mediation machines properties 25 project properties 23, 24, 25 summary definitions properties 25

W
Workbooks blank 44

Page 76

OPTIMA Installation Tool Version 6.1

You might also like