Commander User Reference Guide
Commander User Reference Guide
Version 10.0.2
Confidentiality, Copyright Notice & Disclaimer
This document is the property of TEOCO, which owns the sole and full rights including copyright.
TEOCO retains the sole property rights to all information contained in this document, and without
the written consent of TEOCO given by contract or otherwise in writing, the document must not be
copied, reprinted or reproduced in any manner or form, nor transmitted in any form or by any
means: electronic, mechanical, magnetic or otherwise, either wholly or in part.
The information herein is designated highly confidential and is subject to all restrictions in any law
regarding such matters and the relevant confidentiality and non-disclosure clauses or agreements
issued with TEOCO prior to or after the disclosure. All the information in this document is to be
safeguarded and all steps must be taken to prevent it from being disclosed to any person or entity
other than the direct entity that received it directly from TEOCO.
All other company, brand or product names are trademarks or service marks of their respective
holders.
This is a legal notice and may not be removed or altered in any way.
Your feedback is important to us: The TEOCO Documentation team takes many measures in
order to ensure that our work is of the highest quality.
If you find errors or feel that information is missing, please send your Documentation-related
feedback to [email protected]
Thank you,
Table of Contents
1 Introduction ..................................................................................................... 7
3 Index............................................................................................................... 25
5
Commander 10.0.2 User Reference Guide
6
Introduction
1 Introduction
Commander enables you to add functions into a command file and run the file either from
Commander or from a batch file. You can also access your project's database, without having to
run ENTERPRISE.
Before using Commander, you must have a correctly configured Oracle database and
ENTERPRISE project. You will need to know:
The name of your Oracle data source
The number of the project you will be working on
Your project user name and password
For further information on configuring your database and setting up a project, see the
ENTERPRISE Installation and Administration Guide.
7
Commander 10.0.2 User Reference Guide
8
About Command Files
To execute functions using Commander you must create and run a command file.
This example shows a command file. The first three lines are the Execute section, the remainder is
the Function section.
[EXECUTE]
1=PLANET_export_example
2=export_example
3=XML_Export
[PLANET_export_example]
COMMAND=EXPORT_PLANET
VERSION=PLANET28
FILTER=ALL
FLAGS=d:\temp\dbcmd\flags.txt
SITES=d:\temp\dbcmd\sites.txt
CARRIERS=d:\temp\dbcmd\carriers.txt
NBRS=d:\temp\dbcmd\nbrs.txt
CARRIER_TYPES=d:\temp\dbcmd\carriers
[export_example]
COMMAND=EXPORT_TABLES
VERSION=PLANET28
FILE=C:\command\table\jersey.aii
[XML_Export]
COMMAND=EXPORT_XML
FILTER=ALL
FOLDER=c:\xml
PROJECT_ITEMS=PROPERTY MSC BSC CELL-SITE
LOCATION_UNIT=GRID
9
Commander 10.0.2 User Reference Guide
2. Type [EXECUTE].
3. Type a sequence number, starting from 1, followed by a function name to execute. For
example:
[EXECUTE]
1=PLANET_export_example
2=export_example
Note: You can list as many function names as you need. The process will terminate once
all the functions have been run.
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]
Note: The complete list of command parameters and associated values is shown under
About Command Parameters and Values on page 11.
4. Type parameters and parameter values associated with the command type entered. For
example, to specify the software version, filter and flags to be used by the
EXPORT_PLANET command, you would type:
Version=PLANET28
FILTER=ALL
FLAGS=d:\temp\dbcmd\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.
10
About Command Files
Tip: When creating command files for different projects choose meaningful names.
Important: Before entering command parameters and values, ensure you have included the
command type COMMAND=EXPORT_PLANET.
The following table shows all available command parameters and values that apply to the Export
Planet command type:
11
Commander 10.0.2 User Reference Guide
CARRIERS The full pathname in which to store the carrier information. If this parameter is omitted or
no filename is specified then this information will not be exported.
NBRS The full pathname in which to store neighbour relations. If this parameter is omitted or no
filename is specified then this information will not be exported
CARRIER_ The full pathname without file-extension in which to store carrier types, groups and names
TYPES information. The file extensions *.types, *.groups and *.names will be appended
automatically.
Due to the support for multiple frequency reuse patterns, the groups filename is modified
to include the name of the carrier layer to which it corresponds. Note that this is different
to exporting in ENTERPRISE, where you are prompted for a specific carrier layer for
which the reuse pattern should be exported.
If this parameter is omitted or no filename is specified then this information will not be
exported.
[EXECUTE]
1=PLANET_export_example
2=export_example
3=XML_Export
[PLANET_export_example]
COMMAND=EXPORT_PLANET
VERSION=PLANET28
FILTER=ALL
FLAGS=d:\temp\dbcmd\flags.txt
SITES=d:\temp\dbcmd\sites.txt
CARRIERS=d:\temp\dbcmd\carriers.txt
NBRS=d:\temp\dbcmd\nbrs.txt
CARRIER_TYPES=d:\temp\dbcmd\carriers
[export_example]
COMMAND=EXPORT_TABLES
VERSION=PLANET28
FILE=C:\command\table\jersey.aii
[XML_Export]
COMMAND=EXPORT_XML
FILTER=ALL
FOLDER=c:\xml
PROJECT_ITEMS=PROPERTY MSC BSC CELL-SITE
LOCATION_UNIT=GRID
12
About Command Files
Important: Before entering command parameters and values, ensure you have included the
command type COMMAND=EXPORT_TABLES.
When writing a command file for Commander, and using the Export ENTERPRISE Tables
command 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 a
different extension, then Commander will replaced it with *.aii.
In the same folder as the index file, a number of other *.aid files are created containing
table data.
If this parameter is omitted or you do not specify a filename then no information is
exported.
Important: Before entering command parameters and values, ensure you have included the
command type COMMAND=EXPORT_XML.
The following table shows all available command parameters and values that apply to the Export
XML command type:
ANTENNA_FILTER The name of a filter based on antenna devices and/or patterns and their attributes.
This parameter only has an effect if CONFIG_ITEMS=ANTENNA is present in the
command file (see the next parameter in this table).
CONFIG_ITEMS This is a space-separated list of the configuration data items that will be exported.
Leave this blank or omit the field if you do not want to export configuration data
items. The following items are accepted:
ANTENNA – Antenna
BAND – Band Channels
BCF-TYPE – BCF Type
BEARERS – Bearers
BK-BK-PRL-NF-CURVE – Back-To-Back Passive Repeater Link Near Field Effect
BSIC-SCHEMAS – GSM BSIC Schemas
BTS – BTS Type
CABIN – Cabin
CAR-LAYER – GSM Carrier Layer
CARRIER-CDMA – CDMA Carrier
CARRIERS – GSM Carriers
CARRIER-UMTS – UMTS Carrier
CELL-EQUIP – Cell Equipment
CELL-LAYER – GSM Cell Layer
CHAN-TRX-SETUP – Channel Transceiver Setup
CI-BER-CONVERSION – CI BER Conversion
CLUTTER-PARAMETERS – Clutter Parameters
COMPOUND-ARRAY-EXPRESSION – Compound Array Expressions
CONTACT – Contact Person
EGPRS-MCS-CURVE – EGPRS Data Throughput
FEEDER – Feeder
FREQ-HOP-DIV-GAIN – Frequency Hopping Diversity Gain
13
Commander 10.0.2 User Reference Guide
14
About Command Files
15
Commander 10.0.2 User Reference Guide
TEMPLATE_ This is a space-separated list of the template data items that will be exported.
ITEMS Leave this blank or omit the field if you do not want to export template data items.
The following items are accepted:
MSC – GSM MSC
BSC – GSM BSC
CARRIERS-PMP – PMP Carrier
CDMA-BSC – CDMA BSC
CDMA-MSC – CDMA MSC
DNODE – GSM Distribution Node
DUAL-POLAR-LINK – Dual Polar Link
HUB-LINKEND-PMP – PMP Hub Linkend
HUB-PMP – PMP Hub
LINKEND-PTP – PTP Linkend
MULTI-RADIO-LINK – Multi Radio Link
MU-NODE – Master Unit Node
CELL - Cell
GENERIC-REPEATER - Repeater
PMP-INTERCON – PMP Interconnection
PROPERTY – Property
PRL-BACKTOBACK – Back to Back PRL
PRL-REFLECTOR – Reflector PRL
PTP-INTERCON – PTP Interconnection
RNC – UMTS RNC
SECTOR-PMP – PMP Sector
SGSN – UMTS SGSN
WMSC – UMTS WMSC
FILTER_(n) (n) must be replaced with a number. You can include this parameter more than
once provided that each instance is on a separate line. For example:
FILTER_1 = NAME
FILTER_2 = NAME
FILTER_3 = NAME
where NAME represents a valid filter name.
FILTER_ITEMS If FILTER_ITEMS=All then ignore any setting of FILTER_(n).
Otherwise execute FILTER_(n) if FILTER_(n) is set.
Important: Before entering command parameters and values, ensure you have included the
command type COMMAND=IMPORT_XML.
In ENTERPRISE version 9.1, the MU-Node (a new object that can contain cells of a single
technology or cells of multiple technologies) subsumes the role of the site/node objects (such as
BTS, Node B or eNodeB) that were present prior to 9.1. In much the same way, the GENERIC
REPEATER subsumes the role of the previous technology-specific repeater objects. For backward
compatibility, the following items will still be supported for XML Import, but not for XML Export:
CDMA-BS
CELL-SITE
LTE-NODE
UMTS-NODEB
WIFI-NODE
WIMAX-NODE
MOBILE-WIMAX-NODE
16
About Command Files
In ENTERPRISE version 10.0.2, the multi-technology CELL (a new object that can be configured
with single or multiple technologies) subsumes the role of the technology-specific cell objects (such
as GSM cell, UMTS cell, LTE cell) that were present prior to 10.0.2. For backward compatibility, the
following items will still be supported for XML Import, but not for XML Export:
GSM-CELL – GSM Cell
UMTS-CELL – UMTS Cell
LTE-CELL – LTE Cell
CDMA-SECTOR – CDMA Sector
WIFI-CELL – WiFi Cell
WIMAX-CELL – Fixed WiMAX Cell
MOBILE-WIMAX-CELL – Mobile WiMAX Cell
REPEATER – GSM Repeater
UMTS-REPEATER – UMTS Repeater
LTE-REPEATER – LTE Repeater
CDMA-REPEATER – CDMA Repeater
WIMAX-REPEATER – Fixed WiMAX Repeater
MOBILE-WIMAX-REPEATER – Mobile WiMAX Repeater
The following table shows all available command parameters 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 will be read.
CONFLICTS This field instructs the program what to do when a conflict is detected during
importing configuration or project items and can be set to one of the following:
STOP
LEAVE
MERGE
REPLACE
If any error occurs such as inadequate permissions, missing object IDs,
missing dependencies (such as a missing MSC when importing BSC),
database errors, propagation model not registered and so on, the import will
be aborted.
IMPORTERROR If any error occurs such as inadequate permissions, missing object IDs,
missing dependencies (such as a missing MSC when importing a BSC),
database errors, propagation model not registered and so on, the import will
be aborted or ignored according to the following values:
IGNORE
STOP
The default action is to ignore the error and continue to the next object to be
imported.
PROJECT_ITEMS This is a space separated list of the project data items that shall be imported.
Leave blank or omit this field if no project data items will be imported. The
same items are accepted as for export, plus the backward compatibility items
listed above this table.
CONFIG_ITEMS This is a space separated list of the configuration data items that shall be
imported. Leave blank or omit this field if no configuration data items are to be
imported. The same items are accepted as for export.
17
Commander 10.0.2 User Reference Guide
TEMPLATE_ITEMS This is a space-separated list of the template data items that will be imported.
Leave this blank or omit the field if you do not want to import project data
items. The same items are accepted as for export, plus the backward
compatibility items listed above this table.
ON_MERGE_ Binary flag controlling the behavior of the Merge functionality:
REPLACE_LISTS
NO=default behavior as per the GUI merge functionality
YES=replaces list data with that in the XML file rather than adding to existing
lists
Individual data types that require Replace-on-Merge have the REPLACE
command appended to the end:
CONFIG_ITEMS=ANTENNA BANDS=REPLACE
PROJECT_ITEMS=PROPERTY CELL=REPLACE
These tell the database commander to replace the sub lists of BANDS and
Cell data types on import.
FILTER_ITEMS The only value for this item is 'all' - an attempt will be made to import all filters
present in the XML file. Unlike the export version of this parameter, the import
version should be present only once.
XML_SCHEMA_ This controls whether or not XML files are validated per object during import for
VALIDATION conformance to the syntax, structure and restrictions stipulated in
ENTERPRISEXML Schema Definition (.xsd) files.
YES or TRUE = validate
NO or FALSE = do not validate. This is the default setting.
[EXECUTE]
1=XML_Import
[XML_Import]
COMMAND=IMPORT_XML
FOLDER=c:\xml
CONFLICTS=REPLACE
Important: Before entering command parameters and values, ensure you have included the
command type COMMAND=COMMIT_NETWORK.
This command enables you to commit all outstanding applies from a central function in the correct
order, in the same way as the Global Commit All function in the ENTERPRISE user interface.
The following table shows all available command parameters and values that apply to the Commit
Network Elements command type:
FILTER The name of the filter from which to derive a subset of elements that will be committed.
The name should be exactly the same as that displayed in ENTERPRISE.
If no specific filter is required use All.
18
About Command Files
[EXECUTE]
1=commit_network_elements
[commit_network_elements]
COMMAND=COMMIT_NETWORK
FILTER=ALL
You can use it to produce both active and provisional plots. The active plot will show all the cells in
a live network for a specified unit region, whereas the provisional plot will show new cells planned
to be activated within three months for a specified unit region.
Important: Before entering command parameters and values, ensure you have included the
command type COMMAND=AUTO_CU_GEN.
The following table shows all available command parameters and values that apply to the Auto Cu
Generation command type:
UNITREGION The co-ordinates of the region to be considered in the order East Min, East Max,
North Min, North Max.
RESOLUTION The required resolution of the coverage plot.
INMETERS
VECTORFILE The vector co-ordinate system to be used for mid/mif files.
COORDINATESYS
ACTIVEFILTER You can specify only one filter here, which will contain all the active cells under
one unit region.
ACTIVEURN Specifies the folder where details for the unitRegion will be stored. Appropriate
VECTORFILEDIR sub folders will be generated. Example.
If ACTIVEURNVECTORFILEDIR = C:\CUOUTPUTS\South East Region then:
for active umts cells with a threshold of -131.5 the subfolder will be
C:\CUOUTPUTS\South East Region\ACTIVE\UMTS\carrier1\131.5DBM
for all active GSM900 and GSM1800 cells the subfolders will be
C:\CUOUTPUTS\South East Region\ACTIVE\GSM\GSM900\131.5DBM and
C:\CUOUTPUTS\South East Region\ACTIVE\GSM\GSM1800\131.5DBM
PROVISIONAL You can specify only one filter here, which will contain all the provisional cells
FILTER under one unit region.
PROVISIONAL Specifies the folder where details for the unitRegion will be stored. Appropriate
URNVECTOR sub folders will be generated in the same way as for active plots described above.
FILEDIR
19
Commander 10.0.2 User Reference Guide
[EXECUTE]
1=North_Region_Cu_Generation
[North_Region_Cu_Generation]
COMMAND=AUTO_CU_GEN
UNITREGION = 550195 572566 5440785 5460166
RESOLUTIONINMETRES = 100
VECTORFILECORDINATESYS = ""UTM Zone 30, Northern Hemisphere (WGS 84)\p32630",
8, 104, 7, -3, 0, 0.9996, 500000, 0"
ACTIVEFILTER = All
ACTIVECuTHRESHOLDSindBM = -70 -160 -135 -113.97
ACTIVEURNVECTORFILEDIR = C:\ENT5Release\inputfiles\Jersey
PROVISIONALFILTER= Profilter
PROVISIONALCuTHRESHOLDSindBM = -160 -70 -113.97
PROVISIONALURNVECTORFILEDR = C:\ENT5Release\inputfiles\Jersey
Note: To avoid memory issues for big regions, the tool splits the whole region into small tiles. By
default, the tool considers 20 tiles, but you can use the registry to specify the number of tiles.
To do this:
1. Open Regedit.
3. Create a new String Value called NumTiles for the AutoOutputGen key.
4. Modify the Numtiles String Value to specify the number of tiles you require.
5. Close Regedit.
2. Type the following information all on one line with a space between each item:
o DBCMD100
o -f followed by the full path to and name of your command file between quotation marks
o -d followed by the name of your Oracle datasource
o -u followed by your database user name
o -p followed by your database password
o - j followed by the name of the project
20
About Command Files
OR
-n followed by your project number (for more information contact your system
administrator)
Optionally you can also include:
o -s followed by a sandbox name
o -c to create a project that does not yet exist, with the name specified by -j. Since project
numbers are automatically allocated, -c can not be used with -n.
o -l followed by the name and path of the log file
o -x followed by the name of the XML file containing your project settings to be imported
only when a new project is created. (You do not have to specify project settings when
creating a project).
o -o after the file name specified with -x to import project settings even when there is an
existing project. Using this parameter will overwrite current project settings with those
in the imported XML file.
This means that:
o To create a project called Jersey and import project settings from a file called
settings.xml you would use:
-c -j Jersey -x settings.xml
o To open a project called Jersey and import project settings from a file called
settings.xml you would use:
-j Jersey -x settings.xml -o
o To open project number 4 and import project settings from a file called settings.xml you
would use:
-n 4 -x settings.xml -o
The following example shows a command prompt line which would be correct for
ENTERPRISE version 10.0:
C:\Windows\system32>DBCMD100 -f "C\temp\cmd.exe" -d ENTDB0001 -u admin
-p system -j Jersey
Notes:
o You can use Commander to back up and restore sandboxes with xml exports and
imports.
o If you do not use the -l parameter to specify the name and path of the log file, a log file
will be generated in the folder where ENTERPRISE has been installed, for each run.
The default log file name will be "DBCMD100_" followed by a date and time stamp and
".log" for example:
DBCMD100_2017-09-28_11-47-00.log
21
Commander 10.0.2 User Reference Guide
To do this:
3. For the third line, type cd followed by the full path to the Common subfolder of the
ENTERPRISE folder where you installed the product to, in quotation marks
4. For the fourth line, type the DBCMD100 followed by the required parameters described
under step 2 of Using the Command Prompt.
5. For the fifth line, type echo End of followed by the name of your batch file.
6. Save your file as a *.bat file, using the name you have specified in the file itself.
The following example shows a batch file that could be used for ENTERPRISE 10.0:
@echo off
echo Running Commander Export
cd "C:\Program Files\TEOCO\ENTERPRISE\Common"
..\DBCMD100 –f "C\temp\Export_co.exe" -d ENTDB0001 -u admin -p system
-j Jersey
echo End of Export Batch
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 and time.
3. View the file. It contains a complete list of what occurred and what failed. An example file is
shown here:
2011-10-08 11:58:29: ENTERPRISECommander Starting...
2011-10-08 11:58:29: Using command file
d:\commander\export_config.txt
2011-10-08 11:58:29: Connecting to ora92 as user1
2011-10-08 11:58:32: Read 4 project(s):
2011-10-08 11:58:32: Starting Project 1: UKProject...
2011-10-08 11:58:42: No 'Building Height Dir' entry. No building height
raster data available
2011-10-08 11:58:44: The Vector added was A Roads
2011-10-08 11:58:44: The Vector added was B Roads
2011-10-08 11:58:44: The Vector added was Motorways
22
About Command Files
23
Commander 10.0.2 User Reference Guide
24
Index
Index
A
Auto CU Generation • 19
C
Command File
creating • 9, 10
format • 11
parameters • 13, 18
Commander, about • 7
F
File formats
command file • 11
L
Log Files
viewing • 22
P
Parameters
command file • 13, 18
25
Commander 10.0.2 User Reference Guide
26