commander user reference guide

Copyright 2003 AIRCOM International LtdAll rights reserved

3g, ADVANTAGE, AIRCOM, ARCHITECT, ASSET, CONNECT, DATASAFE, ENTERPRISE,NEPTUNE, HOMEZONE, OPTIMA and TARGET are recognised trademarks of AIRCOMInternational. Other product names are trademarks of their respective companies.

This documentation is protected by copyright and contains proprietary and confidentialinformation. No part of the contents of this documentation may be disclosed, used orreproduced in any form, or by any means, without the prior written consent of AIRCOMInternational.

Although AIRCOM International has collated this documentation to reflect the features andcapabilities supported in the software products, the company makes no warranty orrepresentation, either express or implied, about this documentation, its quality or fitness for aparticular customer purpose. Users are solely responsible for the proper use of ENTERPRISEsoftware and the application of the results obtained.

An electronic version of this document exists on our website.This manual finalized on June 10th 2003.Refer to the Online Help for more information.

This manual prepared by: AIRCOM InternationalGrosvenor House65-71 London RoadRedhill, Surrey RH1 1LQENGLAND

Telephone: +44 (0) 1737 775700Support Hotline:+44 (0) 1737 775777Fax: +44 (0) 1737 775770Web: http://www.aircom.co.uk

Commander User Reference Guide

Version 4.2 MR-2 and 4.2

Can You Improve Our UserAssistance?

Do the Help and User Reference Guides Help You?AIRCOM is always working to improve the online Help and User Reference Guidesfor our products, so that your job is easier to do.

Even if you would not normally do so, please take a look at the Help or UserReference Guide next time you are unsure of how to do something and if you haveany comments or questions that could help us improve them, please email us on:[email protected].

We highly value your comments, suggestions, and criticisms. If you did not find theuser assistance you were looking for, needed more assistance than the online help oruser reference guides provided, or have any suggestions for future improvements toour information, we want to know.

Specifically, consider:

• Is the information accurate and complete?

• Is the information helpful – does it answer your question about the program ?

• Are there any words that you would like to be put into the index ?

♦ ♦ ♦

Commander User Reference Guide Contents iVersion 4.2

Contents

1 IntroductionAbout Commander...............................................................................................1-1Getting Started with Commander.........................................................................1-1

2 Creating Command FilesCreating a Command File ...................................................................................2-1

Creating the Execute Section of your Command File ....................................2-2Creating the Function Section of your Command File....................................2-2

Running your Command File ...............................................................................2-3Running the Command File from the Command Prompt ...............................2-3Running the Command File Using a Batch File..............................................2-4

Viewing the Log File Generated by Commander.................................................2-5Available Command Parameters and Values ......................................................2-6

Using the Export Planet Command in a Command File.................................2-7Using the Export Enterprise Tables Command in a Command File...............2-7Using the Export XML Command in a Command File....................................2-8Using the Import XML Command in a Command File....................................2-9Using the Commit Network Elements Command in a Command File..........2-10

Contents ii Commander User Reference GuideVersion 4.2

Commander User Reference Guide 1 1Version 4.2

1 Introduction

About CommanderThis manual describes how to set up Commander to:

• Export PlaNet/EET data

• Export ENTERPRISE tables

• Export and import XML

• Commit network elements

Using Commander you can, add functions into a command file and run the file eitherfrom Commander or from a batch file. You can also access your project's database,without having to run ENTERPRISE.

Important : Before using Commander, you must have a correctly configured Oracledatabase and ENTERPRISE project.

Getting Started with CommanderBefore you can start to use Commander, you must consider the connection to the datasource that your ENTERPRISE project uses. You must know:

• The name of your Oracle data source

• The number of the project you will be working on

• Your project user name and password

The steps for using commander are:

• Creating a command file

• Running your command file

• Viewing the log file generated by commander

1 2 Commander User Reference GuideVersion 4.2

For More Information

Obtaining HelpENTERPRISE products come with a complete system of online Help which you canaccess in three ways:

• From the Help menu, click Help Contents. Scroll through the table of contentsand choose a relevant topic to display.

• To search for something particular, from the Help menu, click Help Contents andon the Index tab, type in a word.

• Context-sensitive help is available for most of the dialog boxes. Therefore, to getrelevant Help about using a dialog box, in the dialog box, press F1.

We value your comments, suggestions, and criticisms. If you did not find the Help youwere looking for, needed more assistance than the online help provided, or have anysuggestions for future improvements to our online information, we want to know.Please email your comments to [email protected].

Obtaining SupportIf you have any difficulties that you cannot resolve yourself using the online Help, oryou believe that you have found a fault in the software, please contact the AIRCOMProduct Support Group.

This table shows the contact details:If you are in Email Phone Fax

North and South America [email protected] +1 214 891 8060 +1 214 891 8061

Singapore and Asia [email protected] +65 372 0548 +65 372 0350

Rest of World [email protected] +44 (0) 1737 775777 +44 (0) 1737 775770

Middle East and Africa [email protected] +971 4 391 2640 +971 4 391 8660

South Africa [email protected] +27 11 324 3601 +27 11 784 8027

When contacting us, it would help us if you:

• Give us as much information as possible about the problem and the context inwhich 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

mailto:[email protected]



Obtaining Further Services

TrainingIf you require details of mobile and fixed network training courses, run by AIRCOMInternational, please contact us at our email address [email protected] or via ourwebsite http://www.aircom.co.uk.

Consultancy ServicesAIRCOM International also provide full radio consultancy services in Network Audits,Business Planning Support, Licence Applications, Radio Network Planning,Telecommunications Research and System Modelling and Propagation Analysis andModelling.

Linking to the AIRCOM WebsiteFor additional information about AIRCOM International products and services, checkthe AIRCOM International website at http://www.aircom.co.uk.

Printing Your Own Copy of ENTERPRISE ManualsIf you prefer to read information in manual form, rather than online help, you can viewthe manuals supplied as PDFs (Adobe portable document format) on the ENTERPRISECD, or print out your own copies of them on a postscript printer.

Tip : You can choose to install the PDFs on your PC when installing.

Note : Adobe and Acrobat are trademarks of Adobe Systems, Incorporated.

This table describes the manuals:

This Manual Contains Information On

What's New The main differences between the latest versions of the ENTERPRISE Suite.

3G user Reference Using the radio planning tool for 3rd Generation mobile communications networks.

Administrator and InstallationGuide

Installing and configuring ENTERPRISE, your network, and Oracle databases.Using Administrator to create users, groups and set permissions.

Also contains information on software licensing.

ENTERPRISE user Reference Functionality that is common to more than one of the products in theENTERPRISE suite, including how to access, view, edit and store data.

Also contains reference information about file formats.

ENTERPRISE DatabaseReference

The relationships between tables in the ENTERPRISE database and the contentsof each table.

ARCHITECT user Reference Using ARCHITECT specific features such as creating, editing and sharingdrawings (configurations).


ASSET user Reference Using ASSET including information on hierarchical network planning, propagationmodelling, coverage analysis, traffic planning, neighbour list definition, automaticfrequency planning and CW data analysis.

Also contains reference information about file formats.

CONNECT user Reference Using CONNECT, the network transmission and microwave link planning softwarefor full network physical link design and logical link design.

Also contains CONNECT-specific reference information.

DIRECT user Reference Using DIRECT to design telecommunications networks of different network layers.Explains how to plan cellular, PSTN and data networks at a both general andstrategic level.

Also contains DIRECT-specific reference information.

HOMEZONE user Reference Using HOMEZONE to automatically generate coverage predictions and bestserver arrays, which gives you instantaneous display of coverage and interferenceinformation for pre-selected filters when loaded into ASSET.

NEPTUNE user Reference Using NEPTUNE to collect, import and analyse testmobile data and using theoptional module, PROBE for additional analysis.

Also contains reference information on NEPTUNE file formats.

OPTIMA user Reference Using OPTIMA to view performance data and statistics both as part ofENTERPRISE, and over the internet.

TARGET user Reference Using TARGET as an administrator to design forms, Gantt charts and reports.Using TARGET to view and edit information about your network and its roll out.Also contains TARGET reference information.

For any further documentation, such as application notes and extra referenceinformation, please email [email protected].

To use the PDFs:

Make sure you have Adobe Acrobat Reader installed on your PC. If you do nothave this, you can install it from the ENTERPRISE CD, or get it from the Adobewebsite at http://www.adobe.com.

Navigate to the Docs folder. If you installed your product in the default location,this is:C:\Program Files\AIRCOM International\Enterprise 4.1\DocsIf this folder does not exist or is empty, modify your ENTERPRISE installationnow and choose to install them. To do this:

− From the Control Panel, double-click Add/Remove Programs.

− In the list of items, choose ENTERPRISE 4.1 and click the Add/Removebutton.

− When prompted, select Modify then click Next twice until you are on theSelect Components page of the installation wizard.

− Ensure that the documentation you require is selected. For example:

When installed, in the Docs folder, double-click the pdf file that you want toopen.



Note : For updated versions of PDF files, see the AIRCOM International website,at http://www.aircom.co.uk.

♦ ♦ ♦


2 Creating Command Files

Creating a Command FileYour command file contains all the functions you can perform on your ENTERPRISEdata and is executed from the command prompt or by using a batch file. The commandfile contains two sections:

• Execute section

• Function section

This picture shows an example command file:


Creating the Execute Section of your Command FileThis section is denoted by the string EXECUTE on the first line and numberedstatements denoting functions to call, on the proceeding lines.

To create the execute section of your Command File:

1. Open a text editor, for example, Microsoft Notepad.

2. Type [EXECUTE]

3. Type a sequence number, starting from 1, followed by a function name toexecute. For example:[EXECUTE]

1=planet_export_example

2=export_example

Note : You can list as many function names as you need. The process willterminate once all the functions have been run.

This picture shows an example of the Execute section of a Command File:

4. Now you can create the Function section of the file.

Creating the Function Section of your Command FileThe Function Section comes directly after the Execute Section in your Command File. Inthis section you can name your function and assign a command type with parametervalues.

To create the Function section of your command file:

1. Open your command file and ensure your cursor is below the Execute Section.

2. Type in brackets a name for your function. For the command file to run correctly,this name must correspond to those present in the Execute section. For example:[planet_export_example]

3. Type command= followed by the command type. For example:COMMAND=EXPORT_PLANET

The complete list of command parameters and associated values are shown atthe end of this document.


4. Type parameters and parameter values associated to the command type entered.For example, using the Export_Planet example, you might type:Version=PLANET27

FILTER=ALL

FLAGS=d:\temp\dbcmd42\flags.txt

Note : You may list any number of parameters associated to a command type.The process will finish when all the parameters have been run.

5. Save the file as cmd.txt in a suitable location.

Tip : When creating command files for different projects choose meaningfulnames.

This picture shows an example of the Function Section of a command file:

Running your Command FileYou can run your command file in two ways:

• From the command prompt

• Using a batch file


Running the Command File from the Command PromptTo run your command file from the command prompt type the following informationon one line:

1. Open the Command Prompt and type the full path to the ENTERPRISEDirectory. If you installed your product in the default location, this is:C:\Program Files\Aircom International\Enterprise 4.2

2. Type dbcmd42.

3. Type the name of your oracle datasource.

4. Type your project number. This is an indexed number corresponding to theorder of the projects listed in the ENTERPRISE start project dialog. For example:

The first project listed in your Start Project Dialog box is 1.

Tip : This number can be found in the Start Project Dialog box.

5. Type your project User name.

6. Type your project password.

7. Type the full path name of your Command File.

This picture shows an example of Command prompt Execution:

Running the Command File Using a Batch FileAs well as running your Command File from the command promptyou can create abatch file to execute your Command File. To do this:

1. Open a text editor, for example Notepad.

2. Type @echo off and then press the Return key.

3. Type echo Running Commander Export and press the Return key.

4. On the same line, type the following:

− In quotation marks, the full path to Commander. If you installed your productin the default location, this is "C:\Program Files\AircomInternational\Enterprise 4.2\dbcmd42"

− The name of your Oracle datasource.

− Your project number. This is an indexed number corresponding to the orderof the projects listed in the ENTERPRISE Start Project dialog box. Forexample, the first project shown at the top of the list in the Start Project dialogbox is project 1.

− Your user name and password.

− In quotation marks, the full path name of your command file.


5. Now press the Return key.

6. Type echo End of BatchFileName.

Note : Use the name of your own batch file instead of the word BatchFileName.

7. Save your file as a *.bat file, using the name you have used in the file.

8. In Windows Explorer, browse for your file then double-click it to run it.

This picture shows an example of a Batch File:

Viewing the Log File Generated by CommanderA log file is generated when you run a command file. To locate and view the log file:

1. In Windows Explorer, browse to the folder where you saved your command file.

2. Double-click on the log file, whose filename will contain its creation date andtime.

3. View the file. It contains a complete list of what occurred and what failed. Anexample file is shown here:


Available Command Parameters and ValuesThis section describes the parameters and values that apply to these command types:

• Export Planet

• Export Enterprise Tables

• Export XML

• Import XML

• Commit Network Elements

Using the Export Planet Command in a Command FileWhen writing a command file for Commander, this table shows all available commandparameters and values that apply to the Export Planet command type:

Parameter Parameter Values

Version The desired Planet export version:

2.5 PLANET25

2.6 PLANET26

2.7 PLANET27

2.8 PLANET28

Filter The name of the filter from which to derive a subset of sites. The name should be exactly the same as thatdisplayed in ENTERPRISE.

If no specific filter is required use All.

Flags The full pathname in which to store the site status flags. If this parameter is omitted or no filename isspecified then this information will not be exported.

Sites The full pathname in which to store site and cell data. If this parameter is omitted or no filename is specifiedthen this information will not be exported.

Carriers The full pathname in which to store the carrier information. If this parameter is omitted or no filename isspecified then this information will not be exported.

Neighbours The full pathname in which to store neighbour relations. If this parameter is omitted or no filename isspecified then this information will not be exported

Carrier Types The full pathname without file-extension in which to store carrier types, groups and names information. Thefile extensions *.types, *.groups and *.names will be appended automatically.

In Version 2.0 of Commander, because of the support for multiple frequency reuse patterns, the groupsfilename is modified to include the name of the carrier layer to which it corresponds. Note that this isdifferent to exporting in ENTERPRISE where you are prompted for a specific carrier layer for which thereuse pattern should be exported.

If this parameter is omitted or no filename is specified then this information will not be exported.


Using the Export Enterprise Tables Command in a Command FileWhen writing a command file for Commander, and using the Export Enterprise Tablescommand type, the only parameter that applies is:

File

This should reference the full pathname of the export index file.

Note : The filename should have the file extension *.aii. If you specify no extension or adifferent extension, then Commander will replaced it with *.aii.

In the same folder as the index file, a number of other *.aid files are created containingtable data.

If the File parameter is omitted or you do not specify a filename then no information isexported.

Using the Export XML Command in a Command FileWhen writing a command file for Commander, this table shows all available commandparameters and values that apply to the Export XML command type:


Folder The full pathname of the directory into which the XML files will be written.

If this parameter is omitted no information will be exported.

Filter The name of the filter from which to derive a subset of network elements. The name should be exactlythe same as that displayed in ENTERPRISE.


Project Items This is a space separated list of the project data items that will be exported. Leave this blank or omit thefield if you do not want to export project data items.

The following items are accepted:

PROPERTY

MSC

BSC

CELL-SITE

DNODE

GSM-CELL

NEIGHBOUR

REPEATER

PTP-INTERCON

HUB-PMP

PMP-INTERCON

BTS-ROUTE

LINKEND-PTP


HUB-LINKEND-PMP

SECTOR-PMP

CARRIERS-PMP

NETWORK

WMSC

SGSN

RNC

NODEB

LOG-NODE

UMTS-CELL

Config Items This is a space separated list of the configuration data items that will be exported. Leave this blank oromit the field if you do not want to export configuration data items. The following items are accepted:

CONTACT

SUPPLIER

MODEL

BTS

SPLITTER

CABIN

CELL-EQUIP

FEEDER

LINK-TERMINAL

LINK-TYPE

MAST-HEAD-AMPLIFIER

RADIO

MAST

ANTENNA

MW-ANTENNA

CARRIERS

CAR-LAYER

CELL-LAYER

CARRIER-3G


Using the Import XML Command in a Command FileWhen writing a command file for Commander, this table shows all available commandparameters and values that apply to the Import XML command type:


Folder The full pathname of the directory from which the XML files will be read. All files with the .xml extension willbe read.

Conflicts This field instructs the program what to do when a conflict is detected importing configuration or projectitems and can be set to one of the following:

STOP

PROMPT

LEAVE

MERGE

REPLACE

If any error occurs the import will be aborted. Such errors include inadequate permissions, missing objectIDs, missing dependencies (eg missing MSC when importing BSC), database errors, propagation modelnot registered, etc

ProjectItems

This is a space separated list of the project data items that shall be imported. Leave blank or omit this field ifno project data items will be imported. The same items are accepted as for export.

Config Items This is a space separated list of the configuration data items that shall be imported. Leave blank or omit thisfield if no configuration data items are to be imported. The same items are accepted as for export.

On MergeReplaceLists

Binary flag controlling the behaviour of the Merge functionality.

NO = default behaviour as per the GUI merge functionality.

YES = replaces list data by that in the XML file rather than adding to existing lists. Currently only works for 2Gcarriers and neighbours.

Using the Commit Network Elements Command in a Command FileWhen writing a command file for Commander, this table shows all available commandparameters and values that apply to the Commit Network Elements command type:


Filter The name of the filter from which to derive a subset of network elements that will be committed. The nameshould be exactly the same as that displayed in ENTERPRISE.


♦ ♦ ♦

Commander User Reference Guide Index iVersion 4.2

Index

BBatch files

running 2-4

CCommand file

creating 2-1, 2-2format 2-2parameters 2-6, 2-7–2-8, 2-9–2-10running 2-3, 2-4running batch files 2-4

Commander, about 1-1

FFile formats

command file 2-2

LLog files 2-5

PParameters

command file 2-6, 2-7–2-8, 2-9–2-10

Index ii Commander User Reference GuideVersion 4.2

commander user reference guide

Documents