Manual
Installation guidelines/Software description
Software Manual
ASM [PRO]
Antenna System Manager
Version 2.00
Antenna System Manager
Professional Edition
Version 2.00
Contents
Contents ........................................................................................................................................................................ 2
1 Licence Agreement ..................................................................................................................................................... 5
2 ASM – General Requirements ................................................................................................................................... 6
3 Architecture of the ASM .............................................................................................................................................. 7
3.1 Integrating the ASM into the Network Infrastructure............................................................................................ 7
3.2 Communication Overview ................................................................................................................................... 8
3.3 Data Export and Import ....................................................................................................................................... 9
4 Feature Overview ....................................................................................................................................................... 10
5 ASM Installation .......................................................................................................................................................... 12
5.1. Installation on a Windows OS ............................................................................................................................ 12
5.1.1 Server Installation......................................................................................................................................... 12
5.1.2 Dongle Installation ........................................................................................................................................ 16
5.1.3 ASM Client Installation ................................................................................................................................. 17
5.1.4 ASM Installation Directories ......................................................................................................................... 18
5.2 Installation on a Linux OS ................................................................................................................................... 18
5.2.1 ASM-Server and -Client Installation ............................................................................................................. 18
5.2.2 Dongle Installation ........................................................................................................................................ 19
5.3 Starting the ASM ................................................................................................................................................. 19
5.4 About ASM........................................................................................................................................................... 21
5.4.1 About ASM-Client ......................................................................................................................................... 21
5.4.2 About ASM-Server ........................................................................................................................................ 22
6 ASM Launch-in-Context Feature ................................................................................................................................ 23
6.1 Client Commands ................................................................................................................................................ 23
6.2 Server Commands .............................................................................................................................................. 24
7 ASM-GUI .................................................................................................................................................................... 26
8 Application Properties ................................................................................................................................................. 27
8.1 General ................................................................................................................................................................ 28
8.2 Language ........................................................................................................................................................... 29
8.3 Device Appearance ............................................................................................................................................. 29
8.4 Customised Control Interface (CCI) .................................................................................................................... 31
8.5 SNMP .................................................................................................................................................................. 32
8.6 Default Directories ............................................................................................................................................... 33
9 Server Administration ................................................................................................................................................. 34
9.1 The Periodic RET Polling Engine ........................................................................................................................ 34
9.2 RET System Errors.............................................................................................................................................. 35
9.3 SNMP .................................................................................................................................................................. 36
9.4 Shutdown ............................................................................................................................................................ 37
9.5 Server Sessions .................................................................................................................................................. 38
10 Commissioning of RET Systems .............................................................................................................................. 40
10.1 General .............................................................................................................................................................. 40
10.2 Registration - Step 1.......................................................................................................................................... 40
10.2.1 Type of Registration ................................................................................................................................... 40
10.2.2 Connection During Commissioning ............................................................................................................ 41
10.2.3 System Time............................................................................................................................................... 41
10.3 Registration - Step 2.......................................................................................................................................... 42
10.3.1 CCU Identification ...................................................................................................................................... 42
10.3.2 Public Connection Properties ..................................................................................................................... 42
10.3.3 Configuration of the Ethernet Interface ...................................................................................................... 42
10.4 Registration - Step 3.......................................................................................................................................... 43
10.4.1 AISG Device Configuration......................................................................................................................... 43
10.4.2 Sector Definitions ....................................................................................................................................... 45
10.4.3 Configuration of Antennas and TMAs......................................................................................................... 46
10.4.4 Changing the Device Values ...................................................................................................................... 48
10.5 Registration - Step 4.......................................................................................................................................... 49
2
Contents
11 ASM Views ................................................................................................................................................................ 51
11.1 What is a View .................................................................................................................................................. 51
11.2 Using Views ....................................................................................................................................................... 51
11.2.1 Creating Views ........................................................................................................................................... 51
11.2.2 The Current View Tab ................................................................................................................................. 57
11.2.3 The Views Tab ............................................................................................................................................ 59
11.2.4 The CCUs Tab ............................................................................................................................................ 60
12 Configuring a CCU ................................................................................................................................................... 62
12.1 General .............................................................................................................................................................. 63
12.2 Connection ........................................................................................................................................................ 64
12.3 Status ................................................................................................................................................................ 66
12.4 Antennas ........................................................................................................................................................... 66
12.5 Update ............................................................................................................................................................... 67
12.6 Alarm Interface .................................................................................................................................................. 68
13 Utilities for Unregistered CCUs................................................................................................................................. 70
13.1 Firmware Update Utility ..................................................................................................................................... 70
13.2 Reboot Utility ..................................................................................................................................................... 71
14 Configuration of an RCU .......................................................................................................................................... 72
14.1 Tilt & Antenna .................................................................................................................................................... 73
14.1.1 Selecting the Antenna Type........................................................................................................................ 74
14.1.2 Setting the Tilt............................................................................................................................................. 75
14.1.3 Setting the Sector ID .................................................................................................................................. 76
14.1.4 Additional Descriptions ............................................................................................................................... 77
14.1.5 Calibrating .................................................................................................................................................. 78
14.2 General .............................................................................................................................................................. 79
14.3 Device Status .................................................................................................................................................... 80
14.4 Update ............................................................................................................................................................... 81
15 Configuration of a TMA............................................................................................................................................. 84
15.1 Gain & Mode and Sector ID .............................................................................................................................. 85
15.1.1 Setting the TMA Mode: ............................................................................................................................... 85
15.1.2 Setting Gain (dB): ....................................................................................................................................... 85
15.1.3 Setting Sector ID: ....................................................................................................................................... 85
15.1.4 TMA Name: ................................................................................................................................................ 85
15.2 General .............................................................................................................................................................. 87
15.3 Device Status .................................................................................................................................................... 88
15.4 Update ............................................................................................................................................................... 89
16 ASM User Management ........................................................................................................................................... 92
16.1 The ASM Login Dialog ....................................................................................................................................... 92
16.2 The User Management Dialog........................................................................................................................... 93
16.2.1 Creating a New User Account .................................................................................................................... 95
16.2.2 Edit an Account .......................................................................................................................................... 95
16.2.3 Deleting an Account ................................................................................................................................... 95
17 Periodic RET Polling Engine ( PPE ) ........................................................................................................................ 96
18 Error Logging ............................................................................................................................................................ 97
19 Database Operations................................................................................................................................................ 102
19.1 Export Database................................................................................................................................................ 102
19.2 Import Database ................................................................................................................................................ 104
19.3 Delete Database................................................................................................................................................ 107
3
Contents
20 CCI (Customised Control Interface) ......................................................................................................................... 108
20.1 Introduction........................................................................................................................................................ 108
20.2 Script Layout ..................................................................................................................................................... 110
20.3 Typical CCI Actions............................................................................................................................................ 110
20.3.1 RCU Tilt ...................................................................................................................................................... 110
20.3.2 RCU Calibration ......................................................................................................................................... 110
20.3.3 Set TMA Gain ............................................................................................................................................. 110
20.3.4 Set TMA Mode............................................................................................................................................ 111
20.3.5 CCU Firmware Update / Device Data Update ............................................................................................ 111
20.4 The CCI Flow..................................................................................................................................................... 111
20.5 Create Scenario Snapshot ................................................................................................................................ 111
20.6 Importing CCI Scripts ........................................................................................................................................ 112
20.6.1 Configuration Selection (Step1) ................................................................................................................. 112
20.6.2 Initialization (Step2) .................................................................................................................................... 113
20.6.3 Performing (Step3) ..................................................................................................................................... 114
20.6.4 Update Report (Step4) ............................................................................................................................... 115
21 Annex........................................................................................................................................................................ 116
21.1 Glossary of Terms.............................................................................................................................................. 116
21.2 Abbreviations ..................................................................................................................................................... 118
21.3 Shortcuts ........................................................................................................................................................... 119
22 Troubleshooting & FAQs........................................................................................................................................... 121
23 Contact addresses.................................................................................................................................................... 122
4
1 Licence Agreement
Please Note that prior to installation you will be required to confirm acceptance of
licensing terms and conditions.
The Licensing terms and conditions can also be found in the directory:
<ASM Installation Directory>\extlibs\licences\Kathrein_Disclaimer.txt
or on the ASM Installation CD.
5
2 ASM – General Requirements
In order to run and maintain the Kathrein ASM application properly, certain
minimum system requirements must be met.
For detailed information about requirements concerning the network or hardware
platform, please refer to the following document:
• ASM_System_Requirements.pdf.
It is located on the shipped ASM CD in the documentation directory.
6
3 Architecture of the ASM
3.1 Integrating the ASM into the Network Infrastructure
The ASM Server application runs on a machine within your network. It connects
to the controller devices (CCUs) at the Node B and manages the installed CCUs,
TMAs and RCUs.
You can start the ASM client application on any machine and connect to the ASM
server in order to manage the ASM. The ASM clients communicate mainly with
the ASM server, but they also access the CCUs directly.
The following figure shows the scenario:
7
3 Architecture of the ASM
3.2 Communication Overview
The following figure illustrates the communication channels and the protocols
used by the individual components involved:
*) Will be implemented in Version 3.0
8
3 Architecture of the ASM
3.3 Data Export and Import
The following figure provides an overview of the options the ASM provides to
export and import information.
All information between the ASM and the CCU is exchanged using the UDP
protocol SNMP. The ASM gathers the information in its internal SQL database.
The ASM Client provides the user interface to export data into files or import data
from files.
The following export/import options are provided:
• Export Devices:
This export generates an XML file that contains the device information from
the database.
You can use this file to inspect your current configuration.
However, this export cannot be re-imported into the ASM. It is a read-only
access to the database.
• Error Report Export:
You can create an XML file or PDF document that contains all RET system
errors.
• DB Export / Import:
There is an option to create a binary database export.
This export file can be used as a backup to be re-imported again, later.
• Export a Scenario Snapshot / Import a CCI Script:
The ASM provides the possibility to create a scenario snapshot. This is an
XML document that contains the current settings of your TMAs and RCUs.
The snapshot can be re-imported to automatically set the values of your RET
system devices to the specified values.
However, the scenario snapshot uses only a subset of the options offered by
a CCI (Customised Control Interface) script. In a CCI script, you can also
specify operations like a CCU reboot or an RCU calibration.
Thus, a CCI script provides a way to automatically perform a complete set of
operations.
• Please refer to chapter 20 (CCI) for principal information about the usage of
CCI.
9
4 Feature Overview
Module
CCU
Configuration
RCU
Configuration
TMA
Configuration
Fault
Management
Module
User Management
CCI
10
Feature
Description
Update CCU Software
Update CCU firmware, kernel or device data
CCU Parameters
Name, Site_ID, NodeB
Alarm-Interface
Setup of the Alarm-Interface connector of the CCU
Network Properties
Change IP-Address, Gateway, Netmask of the CCU-Ethernet connector
Device Data
Tables containing information about tilt values for different antenna types
General RCU Parameters
Name, Sector
Configure Tilt and Antenna
Setup and edit the antenna type and the electrical downtilt
Calibrate RCU
Explicitly calibrate the RCU for the chosen antenna
View Status and Error
Messages
Monitoring device state
Update RCU Software
Update RCU software
General TMA-Parameter
Name, Sector
Configure Gain and Mode
Configure the gain and/or mode of the TMA
View Status and Error
Messages
Monitoring device state
Software Update
Update TMA firmware, etc.
Show Errors Log Dialog
Shows all current and passed errors with history
Export all current and
passed errors with history
Errors Report in PDF and XML format and deletes the errors from the database
Browseable Error Log
GUI dialog to browse through the error log
Feature
Description
Role-Admin
... can create new user and change sensitive properties
Role-General-User
... can view and edit a RET System
Role Read-Only (Browser)
... can only view the system, but can do no configuration
Role-Manager
... has the ability to define new Views and assign users to those Views
User/RET Access
Management
Control Rights for RET Systems are definable via User to View Association
Secure Password
There is a possibility to generate automatically a secure password in the user
management dialog
CCU SW Update
Automatic 'mass'-update of CCU firmwares, device data and kernel
Scenario-Snapshot
Stores the current system-parameter set to an XML file that can later be
imported via the CCI-Import functionality
Configure RCU Tilt
To change the electrical downtilt of an RCU
Configure TMA
To setup the gain and mode of TMAs
Create CCI Report
Report is created in XML and PDF format
V2.0
V2.5
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
V2.0
V2.5
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Update RCU and TMA SW
Automatic 'mass'-update of RCU and TMA firmwares, bootloader
Variable Device Addressing
AISG Devices can be addressed via their Serial or via the Sector the device is
assigned to
Calibrate RCU
e.g. after RET installation
Verification Task
Performs a variance comparison on the actual system (tilt, gain, mode)
--
CCU Registration
Import of a CCU list to register, SerialNo check, Update of IP parameter
--
4 Feature Overview
Module
General
Feature
Integrated help system
Max. Number of Devices
Max. number of devices, that can be managed by the various ASM
Periodic polling of all CCUs registered in the ASM provides a maximum actuality
of the information stored in the ASM database
Module
Launch
in Context
Database
Automatic
Task Scheduling
View
Management
Client
Server
Architecture
V2.0
V2.5
•
•
20K
20K
•
•
•
•
•
•
Dongle
USB-Dongle Protection (ASM Server-Component only)
Configure Device
Appearance
Manage the composition of the text, to be shown for device identification. e.g.
SiteID-Serial for a CCU
Platform Independence
Supported operating systems: Win 2000, Win XP, MS Server Win 2003, Linux
Change-History Report
Change History Log: WHO did WHAT change at WHICH time
--
Registration
Register commissioned CCUs in the ASM database
Network Properties
Configure IP-Address, Gateway, Netmask
PPP-Connection
Commissioning via a PPP-Connection
Commissioning
Complete Commissioning and Registration at ASM for RET systems
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
V2.0
V2.5
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Periodic Polling Engine
Commissioning
Description
Integrated Help System
IP Connection
Prepare ASM for network infrastructure: LAN, Router, NAT, CCU PPP
Sort CCUs
Sorts the CCUs according to the device appearance
Feature
Description
Automated Login
Provide user name and password at the command line and skip the login
dialog
Open CCU Dialog
Launches the ASM and opens CCU configuration dialog automatically
Launch-In-Context Help
Help-Dialog in case of parameter error
Export Database
Exports the current ASM database. For backup and/or a import later.
Import Database
Import of previously exported ASM databases.
Export Device Information
XML based output format
Export Database
Exports the current ASM database automatically.
--
Export Device Information
XML based output format
--
Configure View-Structure
Each view can contain a tree structure modeling the network structure more
detailed
View-Management
Create views to model the super network structure
Unlimited Number of Views
Each view can have up to 2000 CCU's
Load Views Dynamically
Loads only one view at a time for saving memory
Central Data Storage
Parallel Client Connections
Multi-User and MultiLocation
One central database hosted at ASMServer for all ASM Clients.
Max. number of Client connection accepted by ASM Server + additional
ADMIN session
Divides up the ASM into a Server and a Client component, distributed RET
management
•
•
•
•
•
10+1 10+1
•
•
11
5 ASM Installation
Since the ASM 2.00 is designed for a client/server architecture, the CD-ROM
provided contains two different installation files for every operating system (client
and server installation file). Depending on your operating system (OS), select the
corresponding executable file to start the installation procedure.
NOTE:
• uninstall other ASM versions
• check installation path during installation
e.g. for windows
D:\ASM_2.00_Pro2K\ASM_Server\Windows\KATHREIN_ASM-Server_PRO_
_2_00_2000.exe
5.1. Installation on a Windows OS
5.1.1 Server Installation
The installer window appears with a short introduction to the installation.
12
5 ASM Installation
• By clicking ‘Next’ the License Agreement appears. Read it through and
continue.
• Now you can select an installation folder.
13
5 ASM Installation
• Click ‘Next’
• In this window, the user can enter or select a start menu folder in which a
shortcut is created. You can also decide whether the shortcuts should be
created for all users or not.
14
5 ASM Installation
• By pressing ‘Next’, the installation will be performed.
• The server installation has now been completed, and further information
regarding the dongle installation is displayed.
• Hit ‘Next’ and then ‘Finish’ to complete the ASM-Server Setup Wizard.
15
5 ASM Installation
5.1.2 Dongle Installation
• Install the USB dongle driver as mentioned above.
• Select ‘Install’ and click ‘Ok’.
16
5 ASM Installation
• Click ‘Yes’ and confirm the completion of the dongle driver installation.
NOTE:
• Only users with administrator rights are allowed to install the dongle driver
(Crypto-Box).
• Before starting the ASM-Server, attach the USB dongle to an available USB
port.
5.1.3 ASM Client Installation
The procedure for the ASM Client installation compared to the server is pretty
much the same. Only the dongle installation is omitted, since the clients do not
need such a device.
NOTE:
It is also possible to install one ASM-Client on the same hardware the ASM-Server
has been installed on. This configuration is called ‘localhost configuration’.
The ASM-Client’s IP-address is identical to that of the ASM-Server.
17
5 ASM Installation
5.1.4 ASM Installation Directories
Have a look at the ASM Client installation directory. Several folders are listed.
The most important ones are the ‘cci’, ‘dbbackup’ and ‘reports’ folders.
These are the default folders for snapshot-scenario files (‘cci’ → ‘*.xml’), databasebackup files (‘dbbackup’→ ‘*.db’) and all report files (‘reports’ → ‘*.pdf’, ‘*.xml’)
that can be processed and / or generated by the ASM. During training, you will
get familiar with the file types mentioned.
5.2 Installation on a Linux OS
5.2.1 ASM-Server and -Client Installation
When using Linux, the setup file of the ASM has to be executable.
Copy the setup file from the ASM CD to any location on your hard disk drive and
change its mode to ‘executable’.
<ASM_[version]_[licence]/ASM_[type]/linux/KATHREIN_ASM-[type]_PRO_
_2_00_2000.sh>
where:
version
licence
type
=
=
=
2.00
Demo,Pro2k,Pro5k
Client, Server
Step-by-step instructions:
• Copy the setup file to your hard disk, for example ‘KATHREIN_ASM-Server_
PRO__2_00_2000.sh’.
• Open a console/shell.
• Enter the folder on your hard disk to which you copied the file.
• Type ‘chmod a+x KATHREIN_ASM-Server_PRO__2_00_2000.sh’ to make
the file executable.
• Type ‘./KATHREIN_ASM-Server_PRO__2_00_2000.sh’ to start the installer.
• Follow the installer’s instructions (refer to the installation procedure on a
Windows OS).
18
5 ASM Installation
5.2.2 Dongle Installation
To install the USB-Dongle driver refer to the troubleshooting document
<ASM_server_inst_dir>\misc\drivers\marx\linux_usb_troubleshoot.info.
This file will be stored in the corresponding folder during the ASM-Server.
5.3 Starting the ASM
• Start the ASM Server by clicking the corresponding icon or link.
The window of the ASM Server does not provide any user interface. The only
action you can perform is to click the ‘Shutdown’ button to terminate the server
program.
NOTE:
On other platforms (LINUX) the executable file or a link to it is located in the folder
the user specified during installation.
The ASM Server window provides the following information:
• Memory Usage:
The percentage of the memory that the ASM server currently uses.
• Ticket Traffic:
The communication between the server and the ASM Clients uses a
proprietary communication system on top of TCI/IP. Every client request and
server response is packet into a so-called ticket. The number of tickets sent
and received is displayed here.
• Sessions:
This value shows the number ASM Clients that are currently logged in.
19
5 ASM Installation
• Start the ASM Client by clicking the corresponding icon or link.
• No password is required for the initial login.
• Click on the ‘ASM Server’ tab. By default, the server’ IP address is set to
‘localhost’. If the client is not installed on the same PC as the server, replace
‘localhost’ with the corresponding IP address. The server port ‘50001’ is
the default communication port for the client-server communication protocol
(TCP/IP).
• To test the communication between client and server click the ‘Test
Connection’ button.
20
5 ASM Installation
• Continue with ‘Yes’ or ‘No’.
NOTE:
Depending whether the server is already running or not, the ASM behaves
differently.
• Click on the ‘ASM User’ tab and click ‘Login’ to enter the ASM.
5.4 About ASM
5.4.1 About ASM-Client
Via ‘Help\About’ the user can view general information related to the ASM-Client
and used open surce products.
21
5 ASM Installation
5.4.2 About ASM-Server
• Click ‘Server\About ASM Server’ to open the corresponding window
containing further ASM-Server related information.
22
6 ASM Launch-in-Context Feature
The Launch-in-Context feature provides command-line parameters that enable
seamless launching of ASM features while starting the ASM. Several command
line arguments that pre-configure the ASM are possible.
6.1 Client Commands
To get detailed information regarding the functionality of the individual commands,
open the ‘Launch-In-Context Help’ window.
Syntax: <ASM executable> [--ccu_serial_nr <ccu_serial_nr>]
[--ccu_ip_address <ccu_ip_address>] [--cci_script <cci_script>]
[--login_server_ip <login_server_ip>] [--login_server_port
<login_server_port>]
[--login_user <login_user>] [--login_password <login_password>]
[--netlog_duration <netlog_duration>] [--netlog_threshold
<netlog_threshold>]
23
6 ASM Launch-in-Context Feature
Example:
• Open an OS console (e.g. DOS-window) and change the directory to the
ASM’s installation folder
• (see example below).
• Enter the following command in the command line, assuming that the client
has been installed on the same PC as the server, that the user account is
‘admin_1’ and the password is ‘Ad/MiN’.
The ASM-client starts, and the user is automatically logged in.
NOTE:
If the parsing engine of the ASM detects any problems with the parameters
provided, it will display a help dialogue right after startup containing the error that
has occurred and the syntax explanation of the Launch-in-Context feature.
6.2 Server Commands
To get detailed information regarding the functionality of the individual commands,
proceed as described below:
24
Linux:
1.) Change to the ASM-Server’s installation folder.
2.) Set the environmental variable ‘LD_LIBRARY_PATH’ to
‘misc/drivers/marx’.
e.g. in bash: export LD_LIBRARY_PATH=./misc/drivers/marx
3.) Execute the following command: jre/bin/java -jar ASMServer.
jar -h
Windows:
1.) Change to the ASM-Server’s installation folder.
2.) Extend the environmental variable ‘PATH’ by ‘misc\drivers\
marx’,
e.g.: set path=%PATH%;misc\drivers\marx
3.) Execute the following command: jre\bin\java -jarASMServer.
jar -h
6 ASM Launch-in-Context Feature
The ASM-Server will be started and the following information will be shown
among other things in the OS console:
NOTE:
The option [-h | --help] will only be performed by using the java execution call
as shown above (e.g. java -jar ASMServer.jar -h). The other options can be
performed as described in the example in the client section (see above).
Example:
• This command-line example starts the ASM-Server without any GUI.
25
7 ASM-GUI
NOTE:
• A table including all commands and the corresponding shortcuts and icons is
listed in the Annex chapter.
• The ASM’s GUI is provided with so called ‘tool tips’. A tool tip contains
additional information related to a command or function the mouse pointer is
currently pointing to.
26
8 Application Properties
Properties and configurations of the ASM can be accessed and edited via the
‘Application Properties’ dialogue.
The dialogue can be opened via the ASM ‘Tool Bar’,
the ASM ‘Menu’ (‘Project/Properties’), or via the Shortcut <Alt-P>.
NOTE:
For security reasons some properties can only be changed by users with the
‘ADMIN’ role (Administrators). Users without ‘ADMIN’ rights will be informed by
an appropriate message dialogue. Some changes require a restart of the ASM to
take effect. In this case a message window is displayed.
27
8 Application Properties
8.1 General
Confirmations:
This properties tab contains general properties of the ASM application.
Select the first checkbox if you want a confirmation dialogue to appear when
terminating the ASM.
Select the second checkbox if you want a confirmation dialogue to appear when
logging out the current user.
Select the ‘Confirm Opening View’ checkbox if you want a confirmation dialogue
to appear when opening a view.
PPP IP Configuration:
Local access to a CCU is possible using the PPP connection via RS 232.
The default PPP IP address is ‘192.168.249.250’.
Once changed, you can restore this default PPP IP address by pressing the
‘Reset’ button.
Database Import Policy:
While importing a database you can choose if you want to overwrite or preserve
the current users, passwords, and roles.
28
8 Application Properties
8.2 Language
The ASM supports two languages:
• German
• English
The changes will take effect after restarting the ASM.
8.3 Device Appearance
The device appearance of the CCU and the RET devices in the ASM’s GUI can
be configured in this tab.
29
8 Application Properties
CCU:
Two indicators can be set for the CCU.
The first one can be set to the following values:
• Public IP
• Serial No.
• Site ID
• Name
The second indicator can be set to one of the following identifiers:
• Public IP
• Serial No.
• Site ID
• Name
• <none>
AISG Devices:
Up to three indicators can be set for the connected AISG devices.
You can select one of the following identifiers for the three indicators:
First Indicator:
• Serial No.
• Name
Second Indicator:
• Value (e.g. tilt value for RET, mode for TMA)
• Specific
Third Indicator:
• Value (e.g. tilt value for RET, gain value for TMA)
• Specific (e.g. selected antenna type for RET, mode for TMA)
• <none>
NOTE:
If the TMA is in bypass mode, [---] will be displayed if the value option is selected
for an indicator field.
NOTE:
After modifying the device appearance, it is recommended to trigger a
re-sort-procedure for all device lists (e.g. CCUs, RCUs, ...). This command can
be performed by selecting ‘Window\Re-Sort the views’.
30
8 Application Properties
8.4 Customised Control Interface (CCI)
The CCI properties tab can be used to edit CCI parameters:
• Maximum number of parallel CCI actions:
The CCI engine launches multiple parallel configuration tasks to improve
the performance of the configuration process. This feature can be used
depending on network quality and workload. Generally speaking, slow
networks (or networks with a heavy workload) may require a small number of
parallel CCI tasks, whereas fast networks can handle a higher parallel task
rate.
The range of this parameter is from 1 to 50 (the default value is 2).
It is possible to perform between 1 and 50 actions in parallel. Pressing the
‘Reset’ button restores the default value
NOTE:
Handle this property with care! If the value is too high, it may cause heavy network
load or transmission errors during SNMP queries.
• XML/PDF report:
A report will be generated in XML / PDF format, showing the details of the CCI
actions performed. Here, you can decide whether all the performed actions
will be stored to the report files or only those where errors occurred.
31
8 Application Properties
8.5 SNMP
The ‘Connection Tolerances’ in this tab allow the user to edit SNMP connection
tolerances for the ASM Client, such as the number of retries of SNMP queries
and the timeout period in milliseconds.
These parameters should not be changed, unless the ASM is operating in a
very slow Ethernet environment that causes SNMP timeouts. Very high Ethernet
traffic volume may also cause SNMP timeouts, causing a prompt to change the
tolerances.
The SNMP tolerances can always be reset to default values by clicking the
‘Reset Values’ button.
WARNING
To ensure stable ASM functionality, do not enter timeout values which are too
small, because the connected devices may not be able to respond immediately.
32
8 Application Properties
8.6 Default Directories
It is possible to set a default directory for Database Backup, CCI Script, CCI
Report and General Reports (e.g. error reports). Selected default directions are
displayed.
33
9 Server Administration
9.1 The Periodic RET Polling Engine
The Periodic RET Polling Engine (PPE) updates the embedded database, loads
necessary data from registered RET systems, and polls them periodically to
detect parameter changes (e. g. the current tilt of a certain RCU). The acquired
(updated) data is written to the database.
NOTE:
The PPE does not only poll CCUs linked to a view in the ASM. All CCUs registered
in the ASM database are updated by the PPE. The PPE is an ASM background
process.
The PPE is blocked during CCI processing and commissioning.
The PPE properties can be configured in the ‘Server Administration’ dialogue
under ‘Polling Engine’.
In this tab the PPE can be activated or switched off. The PPE speed can be
adjusted via the slider.
NOTE:
The speed adjustment is only qualitative. The real PPE speed also depends on
the network type and the current network traffic.
34
9 Server Administration
9.2 RET System Errors
The dwell time and the warning threshold can be adjusted in this tab.
• Dwell time:
In the pull down menu, the user can adjust the time the resolved RET system
errors will remain in the database. After this period, the resolved error entries
will be deleted automatically.
• Warning threshold:
This value indicates the maximum number of RET errors in the ASM server
database. Exceeding this value will cause periodic ASM warning messages.
This value can not be modified.
35
9 Server Administration
9.3 SNMP
The ‘Connection Tolerances’ in this tab allow the user to edit SNMP connection
tolerances for the ASM Server, such as the number of retries for SNMP queries
and the timeout period in milliseconds.
These parameters should not be changed, unless the ASM is operating in a
very slow Ethernet environment that causes SNMP timeouts. Very high Ethernet
traffic volume may also cause SNMP timeouts, causing a prompt to change the
tolerances.
The SNMP tolerances can always be reset to default values by clicking the
‘Reset Values’ button.
WARNING
To ensure stable ASM functionality, do not enter timeout values which are too
small, because the connected devices may not be able to respond immediately.
36
9 Server Administration
9.4 Shutdown
In this tab the ASM-Server can be shut down manually by clicking the corresponding
button.
Setting the check ‘Restart Server after Shutdown’ forces a server restart after
the shutdown.
37
9 Server Administration
9.5 Server Sessions
By clicking ‘Server\Server Sessions’ the ‘Server Sessions’ dialogue can be
opened. Here the users currently logged in, their roles, IP-addresses, and login
time are listed.
Two features are available:
• ‘Send Message’ button:
In this dialogue the logged-in users can communicate via the ASM’s short
message feature by selecting the user and clicking the ‘Send Message’
button.
38
9 Server Administration
The recipient of the message may respond via the following dialogue box that
pops up on his or her screen:
• ‘Kill Session’ button:
An user with administrator rights is allowed to kill other users’ sessions.
For instance, this could be necessary if one user forgot to log-out and the
maximum number of ASM-Clients has already been reached. To free that
unused license for another possible user, this session can be killed by
selecting the user and clicking the corresponding button.
The following window pops up on the selected user’s screen.
Now he can decide whether to shutdown immediately or not. The countdown
starts at 15 seconds.
If a critical activity (e.g. a software upgrade) is currently in progress when the
‘Kill Session’ button is clicked, the following window comes up, stating that the
session cannot be closed normally and asking if the ‘Kill Session’ command
should be executed anyway.
NOTE:
As the ‘Kill Session’ function itself starts a system critical action, use this
command only if there is no other way to communicate to the other users that
they are required to be logged out (e.g. via the ASM’s short message feature, by
e-mail, by telephone).
39
10 Commissioning of RET Systems
10.1 General
A newly deployed RET system has to be commissioned and registered to the
ASM. For the RET system, this means that all AISG devices have to be configured
(for example setting the tilt and the sector ID). Also the CCU has to be configured,
at least with the TCP/IP parameters.
NOTE:
For the ASM, it is necessary to register an RET system in the database to be able
to manage it.
Both commissioning and registration can be performed via the so-called ASM
‘Registration Wizard’.
A RET system only can be addressed and managed via the ASM after being
registered with the registration wizard (the ASM queries information from the
CCU and stores the data in the embedded database).
The wizard handles commissioned, partly commissioned and fully commissioned
RET systems (for registration only).
To start the registration procedure, launch the registration wizard via the
‘Project \ Registration Wizard’ menu or the ‘Wizard’ icon.
10.2 Registration - Step 1
10.2.1 Type of Registration
The registration can be done with or without commissioning:
• To add a fully commissioned RET system (e.g. commissioned via the CCU
browser) to the ASM, clear the ‘Include AISG Commissioning’ checkbox.
• To commission the RET system partly or fully, the check ‘Include AISG
Commissioning’ must be set.
40
10 Commissioning of RET Systems
10.2.2 Connection During Commissioning
The URL of the CCU:
Enter the IP address of the CCU to be registered in the ASM. The ASM will
remember the last IP address entered and suggest it to ease the registration of
CCUs with successive IPs.
NOTE:
During commissioning, it is also possible to connect a CCU via a PPP connection.
The URL 192.168.249.250 is the default IP address for this connection. This IP
can be changed in the application properties dialogue on the ‘General’ tab.
10.2.3 System Time
In this section, the CCUs system date and time can be set (only if AISG
commissioning is included). The system time will be used on the CCU for creating
time stamps of notifications and alarms. Click ‘Adjust’ to open the ‘System Time’
dialogue. To set the CCU time, click in the time display to choose either hours,
minutes or seconds. The selected value can be changed using the up and down
cursor keys or by clicking the up and down arrows in the time display. Confirm the
changes by clicking the ‘OK’ button.
By default, the CCU is set to the time of the computer the ASM-Client is running on.
Click ‘Next’ or hit enter to continue the registration (‘Step 2’).
41
10 Commissioning of RET Systems
10.3 Registration - Step 2
10.3.1 CCU Identification
These parameters can be used for additional labelling and identification of a CCU.
It is not required to configure them (only if AISG commissioning is included).
10.3.2 Public Connection Properties
Enter the CCU’s public IP address.
10.3.3 Configuration of the Ethernet Interface
Set the TCP/IP parameters for the Ethernet connection in this section.
NOTE:
Changes to the CCU TCP/IP properties take effect after a reboot of the CCU.
This will be performed automatically after the registration is finished.
Click ‘Next’ to continue with ‘Step 3’ if AISG commissioning is activated.
Otherwise, the registration finishes after this step.
42
10 Commissioning of RET Systems
10.4 Registration - Step 3
10.4.1 AISG Device Configuration
This step shows the configuration window for the connected AISG devices such
as RCUs and TMAs.
• Refresh: Clicking the ‘Refresh’ button updates the current AISG scan result
in the table displayed.
• Restart AISG-Scan: The ‘Restart AISG-Scan’ button triggers the CCU to
launch a new AISG device scan.
• Click the ‘Install Devices’ button to proceed.
NOTE:
A restarted AISG-Scan may take a few minutes until the CCU detects new
secondary devices. Do not press the ‘Restart AISG-Scan’ button repeatedly
within a short time. Each time the button is pressed the device scan is started
over again.
43
10 Commissioning of RET Systems
The duration of the initializing step depends on the number of devices.
After a successful ‘Install Devices’ procedure, the ASM should appear as
follows:
The ‘Sector ID’, ‘Specific’, and ‘Value’ data fields must be assigned for each
AISG device.
Description of the columns in the ‘AISG Device Configuration’ tab:
• ‘Sector ID’:
Customisable. Assigns a sector ID to an AISG device
connected to the CCU. Can be configured on the ‘Sector
Definitions’ tab (see below).
• ‘Serial Number’: The serial number of this AISG device.
• ‘Type’:
44
The type identifier of this AISG device, e.g. ‘RCU’, ‘TMA’,
etc..
10 Commissioning of RET Systems
• ‘Vendor’: The abbreviation for the vendor of the AISG device, e.g. ‘KA’ for
Kathrein devices.
• ‘Specific’: Customisable. Sets the specific attributes of the AISG device. The
content of the ‘Specific’ attributes depends on the type and the vendor of the
AISG device. For Kathrein RCUs this will be the type of antenna connected to
the RCU. For TMAs the mode is selected on the ‘Specific’ tab. Possible TMA
modes depend on the features of the TMA. (e.g. NORMAL sets the TMA to
the specified gain value, BYPASS sets the TMA to RX bypass mode).
• ‘Value’: Customisable. According to the type of AISG device, the values will
represent the tilt for RCUs or the gain for TMAs.
• ‘Device Status’: Current status of the device.
• Checkbox ‘Calibrate RCUs only if necessary’: Set the check if only
non-calibrated RCUs should be calibrated or remove the check to force the
calibration procedure for each RCU.
10.4.2 Sector Definitions
The name of a sector can be edited on this tab.
• Click on the ‘Sector Definitions’ tab to assign sector-ID definitions in line
with the number of scanned AISG devices connected to a CCU. The ASM
suggests sector IDs (‘Sector 1’, ‘Sector 2’, etc). Additionally, the registration
wizard queries the already assigned sector-IDs of the scanned devices and
adds them to the ‘Sector Definitions’ tab. The identifier of a sector can be
modified in this tab. Click on the sector label and edit its name.
45
10 Commissioning of RET Systems
The new ‘Sector Definition’ can now be assigned to the ‘Sector ID’.
• Click on the ‘AISG Device Configuration’ tab again to allocate the sector ID
to the connected secondary devices.
10.4.3 Configuration of Antennas and TMAs
When configuring RCUs, the antennas used must be specified or selected by
clicking a cell in the ‘Specific’ column.
• Configuration of a Kathrein antenna:
When using Kathrein RCUs, the mounted antenna type must be selected.
The type can be selected from the combo box listing all available antennas.
NOTE:
The procedure for configuring non-Kathrein antennas is basically the same as
described above.
46
10 Commissioning of RET Systems
• Changing TMA mode:
For Kathrein TMAs a click on the corresponding cell in the ‘Specific’ column
changes the mode between normal and bypass. By performing this action,
the TMA’s gain value (listed in the ‘Value’ column) changes from the adjusted
one (normal mode) to ‘---’.
47
10 Commissioning of RET Systems
10.4.4 Changing the Device Values
• Changing antenna tilt values:
To change a tilt value of a certain antenna click on the corresponding cell in
the ‘Value’ column and select the proper value from the list.
• Changing TMA gain:
In case of a variable gain TMA, the gain can be changed by clicking on
the certain corresponding cell in the ‘Value’ column. This value can not be
modified for a fixed gain TMA.
Click the ‘Next’ button to continue.
48
10 Commissioning of RET Systems
10.5 Registration - Step 4
This step enables transmission and setup of the parameters specified in step 3.
Hit the ‘Finish’ button to start the commissioning procedure. It is not possible to
cancel this process once it has been started.
NOTE:
Depending on the total number and type of connected AISG devices, this
procedure may take several minutes.
49
10 Commissioning of RET Systems
The status, progress and actions can be monitored in the ‘Progress’ column.
The commissioning of the RET system is complete and the ASM is now ready
to handle the new RET system. Now you can assign the RET system to the
appropriate ‘View’. Refer to the ‘ASM Views’ section for details.
50
11 ASM Views
11.1 What is a View
A view is a freely customisable set of RETs that can be defined by the user. There
may be one or more views defined in the ASM. Refer to the screenshot below as
an example.
Views are located in the so called ‘Explorer’ (navigation area) of the ASM. A
view contains a freely definable tree structure to which the CCUs can be linked.
Each view is divided into two areas, the navigation tree with the linked CCUs and
the detail area below. The detail area contains the AISG devices of the currently
selected RET system, listed and grouped by their ‘Sector ID’. To switch between
different views, click the ‘Views’ tab at the bottom of the ASM explorer and select
another view by double-clicking on its name.
11.2 Using Views
11.2.1 Creating Views
To be able to handle registered RET systems in the ASM, it is necessary to
create at least one view. A new view can be created in the ‘Views’ tab of the ASM
Explorer by clicking on ‘View\New View’.
51
11 ASM Views
The following commands can be selected in the view menu, depending if there is
already a view available or not:
•
•
•
•
Open View:
Close View:
New View:
Edit View:
opens the selected view
closes the currently open view
creates a new view
opens a dialogue to edit and customise the currently selected
view
• Delete View: deletes the currently selected view
A view cannot be deleted whilst its ‘Edit View’ dialogue is open (see below). Only
the view and the data defining the view will be deleted - neither the CCU nor its
data and the connected devices are affected. Deleting a view has no influence
on the content of the database.
To create a new view, click on ‘New View’ in the ASM Explorer’s ‘View’ menu
(see screenshot below).
A new view has been created. The Explorer now contains an empty view and the
‘Edit View’ dialogue to customise the newly created view appears (right-hand
pane of the ASM main window)
• The name of the root node is identical to the view name (here ‘New View 1 of
admin’).
52
11 ASM Views
Have a look on the screenshot below. Enter any name in the ‘View Name’
and / or ‘View Description’ field.
The root node can be subdivided into further nodes and these nodes can be
divided again. Click once with the left mouse button on the view name in the
‘Node Definition’ field and then once with the right mouse button to open the
sub-menu. Select ‘Add New Node’ to add and edit the new user-defined node.
The nodes are a convenient method to represent, for example, streets, areas,
etc. as possible subdivisions of the root node. As can be seen in the menu below,
a node may also be renamed or deleted.
Enter an appropriate ‘Node Title’ and ‘Node Description’.
Additional nodes below the sub-nodes can be created in the same way.
53
11 ASM Views
This following example shows a view with three sub-nodes and unlinked CCUs:
• Linking an unlinked CCU:
After defining the nodes, the CCUs can be assigned from the ‘Unlinked
CCUs Tree’ to the previously defined nodes and sub-nodes in the ‘Node
Definition Tree’. Link the registered CCUs via drag and drop to the ‘Node
Definition’ field (or to the view or to the node). Multiple selection of unlinked
CCUs is also possible.
Example of multiple selection (via the pressed ‘shift key’):
• Unlinking a linked CCU:
A linked CCU can be unlinked again. Select the CCU with a left mouse click.
Right-click to open a pop-up window where the CCU can be unlinked or
completely removed from the ASM.
54
11 ASM Views
NOTE:
To be listed in the ‘Unlinked CCUs’ tree, the CCUs must have been registered
previously.
• The screenshot below shows an example of a fully defined view
including three nodes, each one with a linked CCU:
55
11 ASM Views
• Click the ‘Next’ button to proceed to the ‘Rights’ tab. Here you can
determine whether a user can edit this view or may only browse it. Hit ‘Close’
and the edited view becomes the current active one. Only one view can be
active.
NOTE:
The four different user roles can be assigned to an unlimited number of users.
The user accounts can be created in the ‘User\Manage’ dialogue. Refer to the
respective chapter.
56
11 ASM Views
11.2.2 The Current View Tab
After closing the ‘Edit View’ dialogue the created view is shown on the current
view tab in the ASM explorer window.
In the ‘Navigation’ area all the nodes and sub nodes including the assigned
CCUs are listed.
The ‘Detail’ area shows all the devices that are connected to the CCU that has
been selected in the ‘Navigation’ area (see above), grouped by their sector ID.
57
11 ASM Views
Clicking with the the right mouse button on a CCU (or in the ‘Navigation’ or in the
‘Detail’ area) displays a pop-up menu (see above) showing two possible actions
that can be performed on the selected CCU.
• Ping CCU:
The ping result will appear on screen as shown below. You can repeat this
command periodically by setting the corresponding check.
• Remove CCU from ASM:
Select this command to delete the CCU from the ASM’s database. To confirm
this action click the ‘Yes’ button.
• To edit or close the current view, select the corresponding command in the
‘View’ menu at the top of the explorer window.
The same commands can be reached by right-clicking on the root node or a sub
node in the ‘Navigation’ area:
58
11 ASM Views
• Edit View:
The ‘Edit View’ dialogue (see chapter View Creation) is
displayed. The current view can be modified here.
• Close View: Closes the current view. Now the current view tab is empty.
NOTE:
The ‘Edit View’ and ‘Close View’ commands can also be reached by right
clicking on a CCU in the ‘Navigation’ area (see above). Double clicking on a
node (root or sub node) also opens the ‘Edit View’ dialogue.
Double clicking on CCUs, RCUs or TMAs opens the selected device’s
configuration dialogue. For more detailed information on the individual devices
and their configuration, refer to the corresponding chapters.
11.2.3 The Views Tab
The ‘Views’ tab contains a list of all the available views. Double-clicking on a
listed view name opens it in the current view tab.
59
11 ASM Views
NOTE:
Depending on the setting for the parameter ‘Confirm Opening View’ in the
confirmation area in the ‘Project\Properties\General’ dialogue, a confirmation
window (as shown above) is or is not displayed. In the latter case, double-clicking
the view name opens the selected view directly in the current-view tab.
Right-clicking on the view’s name or clicking (left mouse button) on ‘View’ at the
top of the explorer window opens the following menu:
The listed commands are described in the chapter ‘View Creation’ (see above).
11.2.4 The CCUs Tab
Have a look at the ‘CCUs’ tab in the explorer window.
60
11 ASM Views
At the top of that tab you can select the filter criteria for the CCUs that should be
listed below.
The following selection criteria are possible:
• All:
All the registered CCUs will be listed.
• Current View:
Only the CCUs that are linked to the currently
selected view will be displayed.
• Unlinked to Current View:
All the CCUs that have been registered to the
ASM’s database and that are not linked to the
current view are listed by using this filter
criterion.
• Totally Unlinked:
CCUs that are not linked to any view will be
shown.
In the ‘Go to page’ pull down menu, the user can directly select the page number
to view (in the example above, there is only one page available). By clicking on
the left or right indicating arrows you can leaf through the pages step by step.
The ‘Details’ area lists all the relevant identification parameters of the selected
CCU (click once on a CCU to select it) as shown in the screenshot below.
Double-clicking on a listed CCU opens its configuration dialogue.
61
12 Configuring a CCU
All relevant parameters of a CCU can be configured in the ‘CCU Configuration’
dialogue. The current status of the CCU can also be checked. To open the ‘CCU
Configuration’ dialogue, double-click on a specific CCU in the ‘Navigation
Tree’.
The ‘CCU Configuration’ dialogue is divided into six tabs:
•
•
•
•
•
•
General:
Connection:
Status:
Antennas:
Update:
Alarm Interface:
Common CCU properties
Network connection properties
CCU status and error display
Shows the table of antenna types
To perform software updates on the CCU
Freely definable open collector alarm interface
The two buttons located at the bottom of the ‘CCU Configuration’ dialogue are
available on all six tabs.
The buttons are:
• ‘Close’:
• ‘Refresh’:
Click this button to close the ‘CCU Configuration’ dialogue.
Hit Click this button to update the fields by querying the current
information of the selected CCU from the embedded database.
NOTE:
The dialogue appears with data copied from the embedded database! To get
current data from the RET system hit the ‘Refresh’ button!
To change the value of a CCU parameter, or to perform a special action on the
CCU, enter the new value in the appropriate field and click the corresponding
button. The ASM transfers the new value to the CCU and stores it in the
database.
62
12 Configuring a CCU
12.1 General
This tab allows you to edit general properties of the CCU, such as labelling,
identification parameters, and time settings. The ‘Versions’ section shows the
current software versions. The ‘Time’ section shows the total hours this device
has been in use and permits setting the system time.
The identification labels are for user customisation. They can be set to any value
(numbers or text).
• Serial Nr.:
Serial number of the CCU.
• MAC Address: The hardware identification number of the CCU’s Ethernet
adapter.
• Name:
The name of the CCU is for information only (optional).
It can additionally be displayed in the navigation tree (see
device appearance).
• Site ID:
The site ID can be used to associate the CCU with a certain
site (optional).
• NodeB:
The NodeB label can be used to assign a CCU to a NodeB
(optional).
The ‘Versions’ labels show the currently installed software and hardware
versions of the CCU.
For further information on the software versions and on updating software, refer
to the ‘Update’ section.
To adjust the system time of the CCU click the ‘Adjust’ button and the ‘Adjust
System Time’ dialogue will appear.
63
12 Configuring a CCU
Select the current date in the displayed calendar. To change the time setting,
adjust it by selecting (via mouse click) the hours, minutes or seconds of the
displayed time and using the up or down arrows (also possible via the keyboard
up and down keys). Then click the ‘OK’ button to set the system time of the CCU.
Click ‘Cancel’ to quit the dialogue without adjusting the date and time.
12.2 Connection
All necessary properties to access a CCU via a TCP/IP network are shown in
this tab.
64
12 Configuring a CCU
This tab is divided into four fields:
• CCU Connection Properties:
The CCU’s Ethernet settings;
IP-address, gateway, and netmask
• Public Connection Properties:
The CCU’s public IP-address, which can
differ from the other one, for example
when using NAT (Network Address
Translation)
• Configure Connection Properties: Click on this button to reconfigure the
CCU’s connection properties, or to run
through the registration procedure again
(required in case of an RET system
configuration change).
• SNMP MIB Version:
The ASM’s and CCU’s MIB
(Management Information Base)
versions are listed here. Compatibility of
the MIB version IDs of the ASM and the
CCU is required for a successful ASM
operation. For details, refer to the
release notes of the current ASM
version.
NOTE:
The MIB Version ID of the CCU depends on the current CCU firmware version.
This version ID has to be greater than or equal to the ASM’s MIB version ID. To
update the MIB version ID of the CCU, download the latest firmware version via
‘Utilities \ Unregistered CCU \Update’ by entering the IP-address of the CCU
and choosing the firmware image file. Open the download dialogue by clicking
‘Start Update’.
65
12 Configuring a CCU
12.3 Status
The ‘Status’ tab shows the current ‘CCU Status’ and the CCU‘s ‘Error
Status’.
• Click ‘Reboot CCU’ to reboot the CCU immediately.
• Click the ‘Clear Errorlist’ button to remove all error entries from the CCU’s
internal error buffer.
12.4 Antennas
This tab displays the current ‘Table Version’ of the Kathrein ‘Device Data’
file, where the Kathrein antennas are listed. To update or to load the Antenna
Types table from the CCU, click the ‘Reload’ button at the top right corner of this
tab. The ASM will refresh the antenna type data from the CCU and update the
embedded database. The ‘Antenna Types’ table provides information on the
types of antennas that can be selected in the RCU configuration dialogue. The
Antenna Types table cannot be changed. To update this table on the CCU, refer
to the ‘Update’ section.
66
12 Configuring a CCU
12.5 Update
This tab allows software updates of the following CCU software for registered
CCUs:
• CCU Firmware:
Includes the application program running on the CCU.
• CCU Device data: Antenna Types Table - This table holds information on all
KATHREIN antennas which can be connected to the CCU
via the AISG interfaces.
• CCU Kernel:
The operating system of the CCU.
To update software, proceed as follows:
1. Select the update type.
2. Choose the update file to be transferred, either by typing the correct
path into the field or by choosing the correct update file by clicking the
‘File’ button.
3. Click the ‘Start Update’ button, and confirm the dialogue with ‘Yes’ if
the settings are correct.
While the update is running a progress bar and the current update status are
shown. During this process the CCU’s configuration dialogue is disabled.
NOTE:
The selected file is downloaded to the CCU via FTP. The update procedure may
take a while depending on the type of software to be updated and the quality of
the TCP/IP connection. The downloaded file will be flashed to the CCU memory.
67
12 Configuring a CCU
12.6 Alarm Interface
The CCU’s alarm interface is provided by 8 open-collector outputs, and has been
physically implemented via a 9-pin female sub-D connector on the CCU’s front
panel. Pins 1 to 8 are user-programmable, and represent the 8 mentioned opencollector outputs. Pin 9 is connected to the device’s ground. Refer to the CCU
manual for more detailed information.
Pin states:
• The following states can be selected and assigned individually for each
pin:
Pin State
68
Description
Example (LED attached)
‘Active GND’
The pin is switched to the
status ‘ground’ if an alarm
occurs.
If an alarm appears, the LED
is switched on.
‘Active Open’
The pin is switched to the
status ‘open’ if an alarm
occurs.
If an alarm appears, the LED
is switched off.
‘Fixed GND’
The pin remains at the status
The LED is always switched
‘ground’ even if an alarm
on.
occurs.
‘Fixed Open’
The pin remains at the status
The LED is always switched
‘open’ even if an alarm
off.
occurs.
12 Configuring a CCU
The adjusted configurations can be saved by way of the ‘Save Template’
area. The configurations saved in this way can then be loaded from the ‘Load
Template’ area (see below).
NOTE:
Adjustments for individual devices will not be stored to the template.
Alarm Type:
One of the following alarm types can be assigned by selecting it in the ‘Alarm
Type’ area on the right-hand side of the window:
•
•
•
•
•
•
All errors
All CCU errors
All AISG errors
All RCU errors
All TMA errors
All errors related to a specific registered secondary device (RCU or TMA)
NOTE:
If the ASM detects that the tab contents have currently been edited, the PPE
is prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after entering all
necessary changes.
69
13 Utilities for Unregistered CCUs
13.1 Firmware Update Utility
With the firmware update utility, the users can update the firmware of an
unregistered CCU. For instance this may be necessary if the MIB version of the
CCU is not compatible to the ASM’s version.
To update the firmware image select ‘Utilities\Unregistered CCU\Update’ and
enter the IP-address of the CCU. Enter the firmware image’s path or choose it via
the file browser dialogue and click ‘Start Update’.
A pop-up window informs the user about the update result.
70
13 Utilities for Unregistered CCUs
13.2 Reboot Utility
In certain situations a reboot of the CCU may be necessary (refer to the external
troubleshooting document). This action can be performed by selecting the
‘Utilities\Unregistered CCU\Reboot’ command.
Enter the corresponding IP-address and click ‘Reboot’ in the reboot utility window
to start the reboot process.
After confirming the reboot command the progress bar illustrates the progression.
The successful reboot will be displayed via the following message box.
71
14 Configuration of an RCU
To configure an RCU, click on the CCU to which the RCU is connected.
The ‘Detail’ tree of the ASM Explorer will display the individual AISG devices
which are connected to the selected CCU.
To open the configuration dialogue of an RCU, double-click (left mouse button) it
in the ‘Detail’ tree of the Explorer.
NOTE:
Any changes have to be confirmed by clicking the corresponding ‘Apply’ button.
The ASM will then transmit the new values to the RCU. After this, the new values
will be stored in the embedded database of the ASM. The data displayed in this
dialogue was initially retrieved from the ASM embedded database, and may be
out of date. To update the information, hit the ‘Refresh’ button in this dialogue.
72
14 Configuration of an RCU
The ‘RCU Configuration’ dialogue is divided into four tabs:
14.1 Tilt & Antenna
On this tab the antenna type, tilt value, sector ID and additional descriptions
relating to the device can be changed. An RCU calibration can also be initiated.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected RCU from the embedded database.
73
14 Configuration of an RCU
14.1.1 Selecting the Antenna Type
To choose a certain ‘Antenna Type’, click on the ‘Select’ button to open the
‘Antenna Selection’ dialogue. A dialogue including all available antennas from
the ‘Antenna Types’ table will appear and the antenna type to which the RCU is
connected can be selected. The diagram on the right-hand side of the dialogue
box illustrates the minimum and maximum tilt values which are supported by the
selected antenna.
74
14 Configuration of an RCU
14.1.2 Setting the Tilt
The tilt of the antenna can be changed after a successful calibration (if it was not
calibrated before). The ‘Current Down Tilt’ combo box will be initialised with
the tilt range of the selected antenna. A tilt value can be easily chosen, and is
confirmed by the ‘Apply’ button.
75
14 Configuration of an RCU
14.1.3 Setting the Sector ID
To assign the RCU to a sector, edit the ‘Sector ID’ field and click the ‘Apply’
button. In the ‘Detail’ tree of the ASM Explorer, AISG devices are grouped by
their sector configuration.
76
14 Configuration of an RCU
14.1.4 Additional Descriptions
Check the ‘Activate Additional Descriptions (optional)’ checkbox to make the
two fields editable. Here the current RCU can be described in more detail. These
fields can be left blank if not needed.
77
14 Configuration of an RCU
14.1.5 Calibrating
To calibrate the antenna, click the ‘Calibrate’ button on this tab. The action will
be performed immediately.
78
14 Configuration of an RCU
14.2 General
General device information is shown on this tab. A freely definable name for the
RCU can also be edited.
‘Reset RCU’: It is possible to perform a reset of the RCU according to the
corresponding AISG command.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected RCU from the embedded database.
79
14 Configuration of an RCU
14.3 Device Status
This tab shows the device status and current error messages of the RCU. The
error list can be cleared by clicking ‘Clear RCU Error List’; this action does not
resolve the underlying problems. The ‘Device configured’ checkbox will be set
if the RCU has been commissioned and configured successfully. The ‘Device
active’ checkbox illustrates that the RCU has been scanned successfully by the
CCU via the AISG bus.
NOTE:
For detailed RCU status descriptions refer to the CCU manual.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected RCU from the embedded database.
80
14 Configuration of an RCU
14.4 Update
In this dialogue the RCU firmware and RCU bootloader can be updated.
Select either RCU Firmware or RCU Bootloader in the ‘Update Type’- field and
choose the respective file via the ‘Update File’ -field browser.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected RCU from the embedded database.
81
14 Configuration of an RCU
When you click the ‘Start Update’ button the update starts and the current status
will be displayed.
The update procedure starts after clicking the ‘Yes’ button.
While updating the current software the ‘Update Status’ field shows the action.
When the software upgrade procedure is accomplished, the following window is
displayed:
82
14 Configuration of an RCU
After clicking the ‘OK’ button the update status field shows the actual status.
NOTE:
Some AISG devices do not support software updates!
The ‘General’ tab shows whether the AISG device supports a software update.
83
15 Configuration of a TMA
To configure a TMA, click on the CCU to which the TMA is connected.
The ‘Detail’ tree of the ASM Explorer will display the individual AISG devices
which are connected to the selected CCU.
To open the configuration dialogue of a TMA double-click (left mouse button) it in
the ‘Detail’ tree of the Explorer.
NOTE:
Any changes have to be confirmed by clicking the corresponding ‘Apply’ button.
The ASM will then transmit the new values to the TMA. After this, the new values
will be stored in the embedded database of the ASM. The data displayed in this
dialogue were initially retrieved from the ASM embedded database, and may
be out of date. To update the information, click the ‘Refresh’ button in this
dialogue.
84
15 Configuration of a TMA
The ‘TMA Configuration’ dialogue is divided into four tabs:
15.1 Gain & Mode and Sector ID
On this tab the current mode, configured gain, and sector ID can be changed.
15.1.1 Setting the TMA Mode:
The current mode can be set by either selecting NORMAL or BYPASS and
clicking the ‘Apply’ button.
In NORMAL mode, the gain of the RX-path is set to the configured gain value.
In BYPASS mode the RX-path LNA is bypassed.
15.1.2 Setting Gain (dB):
In the ‘Configured Gain (dB)’ combo box the gain of the TMA can be set.
If the TMA is a fixed gain TMA, the gain value is displayed in the window. This
value can not be changed.
If the TMA is a variable gain TMA, the gain value can be changed. The Min-Gain
and Max-Gain values of the TMA are displayed in the window, the resolution is
set according to the AISG standard. A gain value can easily be choosen, and is
confirmed by the ‘Apply’ button.
15.1.3 Setting Sector ID:
To assign the TMA to a sector, edit the ‘Sector ID’ field and click the ‘Apply’
button. In the ‘Detail’ tree of the ASM explorer, AISG devices are grouped by
their sector configuration.
15.1.4 TMA Name:
A freely definable name for the TMA can also be edited in the ‘TMA Name’ field.
Changes will be activated when you click the ‘Apply’ button.
85
15 Configuration of a TMA
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected TMA from the embedded database.
86
15 Configuration of a TMA
15.2 General
General TMA information, as shown below, can be seen in this tab.
‘Reset TMA’:
It is possible to perform a reset of the TMA according to the corresponding AISG
command.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected TMA from the embedded database.
87
15 Configuration of a TMA
15.3 Device Status
This tab shows the device status and current error messages of the TMA.
The error list can be cleared by clicking ‘Clear TMA Errorlist’; this action does
not resolve the underlying problems. The ‘Device Configured’ checkbox will be
set if the TMA has been commissioned and configured successfully. A checked
‘Device Active’ checkbox indicates that the TMA has been scanned successfully
by the CCU via the AISG bus.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected TMA from the embedded database.
88
15 Configuration of a TMA
15.4 Update
In this dialogue the TMA Firmware and TMA Bootloader can be updated.
Select either TMA Firmware or TMA Bootloader in the ‘Update Type’ -field and
choose the corresponding file via the ‘Update File’ -field browser.
NOTE:
• ‘Abort editing mode’:
If the ASM detects that you are currently editing the tab contents, the PPE is
prevented from updating this frame. Otherwise the PPE would overwrite the
changes you made. Click the ‘Abort editing mode’ button after you have
made all necessary changes!
• ‘Refresh’:
Hit this button to update the fields by querying the current information of the
selected TMA from the embedded database.
89
15 Configuration of a TMA
When you click the ‘Start Update’ button the following window appears:
The update procedure starts after clicking the ‘Yes’ button.
While updating the current software the ‘Update Status’ field shows the action.
90
15 Configuration of a TMA
When the software upgrade procedure is complete, the following window is
displayed:
After clicking the ‘OK’ button the update status field shows the actual status.
NOTE:
Some AISG devices do not support software updates!
The ‘General’ tab shows whether the AISG device supports a software update.
91
16 ASM User Management
The ASM provides a user management interface for easy and effective access
control.
There are four kinds of ASM users:
• The ‘Administrator’ with all rights
• The ‘Manager’ with all rights except the specific functions for the technical
administration of the ASM server
• The ‘Default User’ with restricted rights
• The ‘Browser’ with very restricted read-only rights
For security-related actions, such as
•
•
•
•
Changing SNMP parameters in the ‘Application Properties’ dialogue
Changing FTP parameters in the ‘Application Properties’ dialogue
Changing CCI parameters in the ‘Application Properties’ dialogue
Editing, creating or deleting other user accounts
logging in as a user with administrative rights is required. A ‘Default User’ or a
‘Browser’ user may not perform these critical changes.
By managing the different users in the ‘User Management’ dialogue, each
account is protected by a user-specific password with a length of at least six
characters.
16.1 The ASM Login Dialog
When starting the ASM the following login dialogue is shown. All registered
accounts of the ASM are listed in the ‘Login’ dropdown box. Enter the userspecific password to log in. The ASM remembers the last user and displays his/
her account in the dropdown box by default.
92
16 ASM User Management
After logging in and starting the ASM, the current account in use is displayed
on the status bar of the ASM (at the bottom left corner of the application’s main
window).
The user login can also be performed via the command line using the ‘Launchin-Context’ feature arguments --user<user_name> and --password<user_
password>. If there is no password set for the user, use the --user<user_name>
argument only. For more detailed information and examples refer to the ‘Launchin-Context Feature’ section.
NOTE:
The very first time the ASM starts up, a default account is defined. The login
name is ‘admin’ and the password is empty. For security reasons, the password
for the ‘admin’ account should be changed immediately! To change the current
ASM user, log out and back in again.
16.2 The User Management Dialog
The user management dialog enables you to create, edit or delete ASM
accounts.
NOTE:
As mentioned above, it is necessary to log in as a user with ‘Administrator’ or
‘Manager’ rights in order to create, edit or delete accounts.
Open the ‘User Management’ dialog by choosing ‘User\Manage’ from the ASM
menu.
93
16 ASM User Management
The table below lists the assignments between user roles and the actions that
can be performed by these users.
The user management dialogue has a facility to generate a secure password
using the ‘Generate’ button.
94
16 ASM User Management
The generated password is copied to the ‘Password’ and ‘Confirm Password’
text boxes. A dialogue opens up showing the newly generated password in
readable text.
The generated secure password has the following properties:
•
•
•
•
It consists of upper and lower case letters, numbers and special characters.
It is eight characters long.
The first character of the password is never a special character.
Two consecutive characters are never the same.
16.2.1 Creating a New User Account
• Click the ‘Add’ button and enter the data requested on the right-hand side
• Click the ‘Apply’ button to save your changes
The new account is now ready to be used.
NOTE:
Each account is protected by a user-specific password with a length of at least
six characters.
16.2.2 Edit an Account
• Select an account from the list on the left and click ‘Edit’
• Edit the parameters you want to change (to reset the prior values just click
‘Reset’)
• Click the ‘Apply’ button
16.2.3 Deleting an Account
• Select an account from the list on the left
• Click the ‘Delete’ button and confirm your action
NOTE:
There must be at least one administrator. Therefore, you are not allowed to delete
your own user account. This ensures that there will always be a user account left
to manage the users.
WARNING
Do not forget your password!!
It cannot be recovered, nor is there a backdoor to the ASM!
95
17 Periodic RET Polling Engine ( PPE )
The Periodic Polling Engine (PPE) is the responsible mechanism of the ASM that
keeps the central server database up to date by getting a list of all registered RET
systems and looping through this list, continuously checking for any changes of
those RET parameters.
If the PPE detects a change or an alarm in one or more RET systems, the
registered RET system in the database will be updated automatically.
As a consequence, currently logged in ASM clients will be notified about the
detected changes and will update their models and GUIs.
Since the PPE is based on a polling pattern, the detection of the changes cannot
be done in real time - there is a certain delay, depending on
• the configured PPE speed,
• the number of registered RET systems, and
• the network speed and its quality of service.
In order to configure or deactivate the ASM PPE, open its configuration dialog
‘Server’ -> ‘Server Administration’ -> ‘Polling Engine’:
By default the PPE is set to activated and medium polling speed.
It is not recommended to permanently deactivate the PPE as it is a very important
mechanism to keep track of the registered systems.
Please note, that any change of RET parameters in the field cannot be detected by
the ASM application if the PPE has been deactivated!! The ASM server database
and all ASM clients will get out of date; alarms and errors (e.g. timeouts) will not
be scanned by the ASM.
There are five levels of PPE speed configuration: slowest, slow, medium, fast
and fastest.
The faster the polling speed, the greater the load on the underlying network. The
slower the polling speed, the longer it will take to detect alarms or changes on the
systems. A compromise between these opposite goals is the default ‘Medium
PPE speed’.
96
18 Error Logging
The ASM uses the so called ‘Error Logging’ module in order to manage occurring
RET system alarms. All RET alarms detected by the ASM PPE (see chapter 16).
Commissioning, CCI and so on are collected in a central way in the ASM server
component.
The current status of all registered RET systems is distributed by the ASM server
to all logged in ASM clients, so that the user is immediately informed when
detecting an alarm.
The collected alarms and errors have one of two possible statuses: new or
resolved.
New alarms are alarms that occur for the first time on a device or system.
Resolved alarms are alarms that appeared and have disappeared. They stay in
the database for a certain time until being removed (configurable).
The ASM supports two scopes (perspectives) for alarm logging:
• the View Scope that indicates all errors concerning the currently opened view;
and
• the Server Scope that indicates the errors and alarms of all registered RET
systems.
To get a quick overview of the overall system status, the ASM offers an
information panel about the RET alarms at the bottom (status bar) of the ASM
client window:
The left icon represents the health of the view scope, the right icon represents the
overall health of the complete system.
A gear wheel with a green tick indicates that all registered RET systems are OK
and that there are no errors in the system.
If the status changes to a gear with a red cross, the PPE has found an error in
one of the RET systems. The detailed error information is reported in the RET
error log.
A yellow symbol means that there are only resolved errors left in the error log.
Examples:
To browse the current error log, double-click on one of the scope icons in the ASM
client status bar; clicking the left icon will open the view scope of the RET errors
log, clicking the right icon will open the server scope of the RET errors log.
Alternatives are the shortcut <Alt> + <F8> or via the ASM menu bar.
By using the tabs of this dialog, the user is always able to change the initial
scopes (view or server).
97
18 Error Logging
NOTE:
Due to performance reasons, the server scope is not dynamic, so that the user
should press the refresh button (or re-enter the tab) in order to browse an up-todate list of the overall RET alarms.
If the user is browsing the view scope, a double-click on an alarm entry will open
the corresponding device configuration dialog. The same result can be achieved
by clicking the ‘Open-Device’ button.
Example showing the error log of the view scope:
Example showing the error log of the server scope:
98
18 Error Logging
The ‘Delete-Resolved-Errors’ button will manually remove all resolved RET
system errors from the ASM database and all client logs. This may be useful if
the error log is not configured to delete resolved errors automatically.
Configuration of the Error Log:
In order to configure and set up the error log, please open the error log dialog via
‘Server’ -> ‘Server Administration’ -> ‘RET System Errors’.
This interface provides access to the available parameters of the module. It
enables the user to configure the time that must go by until a resolved RET
system error is automatically deleted from the ASM database; in other words, it
sets up the life time of resolved errors.
It is also possible to leave resolved errors in the database by choosing the ‘Never’
option.
In this case the users themselves are responsible for deleting the resolved RET
errors from the database (see text above).
If there are more than 2000 RET errors registered (new or resolved), a periodic
warning message will be displayed at each logged in client.
The GUI of the RET Error Set-Up:
99
18 Error Logging
• Export RET System Error Report:
All current and resolved errors of the registered RET systems may be
exported as PDF- or as pure XML reports (or as both).
Open the export GUI via the shortcut <Ctrl>+<Shift>+<S> or via the ASM menu
bar:
‘Utilities’ -> ‘Database’ -> ‘Export RET System Error Report’
After successful export of the report the following window will appear on the
screen.
100
18 Error Logging
NOTE:
If a device is still defective, the error for that device will appear in the log again as
soon as the PPE polls the RET system for its current status. So deleting an error
without resolving the problem has only one effect: the ‘known since:’ entry will
change to the current time.
Example:
Exported RET System Errors Log file.
The exported RET system error report in PDF format looks as follows:
101
19 Database Operations
19.1 Export Database
The ASM database can be exported.
You can open the dialog using the menu entry ‘Utilities\Database\Export
Database’.
There are two possibilities for the export file:
• The database can be exported completely.
This is a kind of database backup. This export can be re-imported later.
It contains all information stored in the ASM database, including device
information, view assignments, users, antenna types, etc.
• The second possibility is a device export.
This cannot be reimported, but it can be very useful to have an overview of
the devices in the database.
Choose one of the options in the upper part of the dialogue box. In the ‘Destination
File’ area the ‘Filename’ and the destination ‘Folder’ of the export file can be
selected.
Click the ‘OK’ button to start the export.
The progress of the export operation is shown in a window:
102
19 Database Operations
When the export has finished, the following message is displayed.
If the export operation cannot be performed for some reason, a dialog will inform
you about it:
103
19 Database Operations
19.2 Import Database
Exported databases can be reimported into the ASM using the DB import
dialogue.
Only the ‘Administrator’ is allowed to import the database.
It can be accessed via ‘Utilities\Database\Import Database’.
If the checkbox in the top section of the dialogue box is cleared, the existing
database is not saved before the export. So if the database import fails there is
no fallback system available.
You have to select a file that contains the exported database. Press ‘OK’ to start
the import process.
104
19 Database Operations
The import procedure consists of three steps:
• The first one is the export of the existing database, if the checkbox described
above is not cleared.
• The second step is deletion of the existing database.
• The third step is import of the chosen database.
The progress of the export in the first step will be shown in a dialog:
For the second step, you have to confirm that your current database content will
be deleted:
105
19 Database Operations
The progress of the deletion is shown on the progress bar:
The third step with the import of the database is also shown in a progress bar:
At the end of the third step, the client database is synchronized with the newly
imported server database:
106
19 Database Operations
When the import has finished this dialogue is displayed:
19.3 Delete Database
Deletion of the database during database import can also be triggered
separately.
It can be accessed via ‘Utilities\Database\Delete Database’.
If this dialogue prompt is confirmed, the database will be completely deleted.
The progress bar provides information on the status of the deletion process.
107
20 CCI (Customised Control Interface)
20.1 Introduction
The following chapter describes the principal usage of CCI. Further information
regarding layout, syntax, and elements of this scripting language can be found in
the document ‘ASM_2.0_CCI_documentation.pdf’ in the ASM documentation
directory.
The ‘Customised Control Interface’ (CCI) is an ASM feature to automatically
perform (mass) actions on RET systems. It works using simple XML files
containing the relevant information in a hierarchical structure.
The CCI enables the ASM to carry out RET system mass management, so a
huge amount of actions on RET systems are possible, without user interaction,
by importing a valid XML file (snapshot).
The CCI scripts can be generated manually or via the Kathrein ASM application
as a so called ‘Scenario Snapshot’.
If you want to use the ASM application to generate a script, then use the ‘Scenario
Snapshot’ feature, which will create a CCI script containing all relevant RET
parameters:
•
•
•
•
RET system identification (CCU and AISG devices)
RCU tilt
TMA mode
TMA gain
In order to carry out other actions, such as firmware updates, explicit reboots or
calibrations, etc. the script has to be extended or created manually.
108
20 CCI (Customised Control Interface)
The CCI engine can be configured via the CCI tab in the application properties
dialogue (refer to the chapter 8):
109
20 CCI (Customised Control Interface)
20.2 Script Layout
The CCI script itself is completely based on the XML specification language.
The CCI scripting language is precisely defined in the document
‘ASM_2.0_CCI_documentation.pdf’, which contains the syntax, the elements
and other rules needed to create ASM CCI scripts.
Please see the figure below for an example of a scenario snapshot of the ASM
application:
20.3 Typical CCI Actions
20.3.1 RCU Tilt
The RCUs down-tilt can be configured. The name for the action key word in the
CCI script is ‘tilt’. The value for the action describes the tilt to be set, with no unit
(e.g. 2.6 for 2.6 degrees).
20.3.2 RCU Calibration
Use this action in order to explicitly calibrate an RCU; e.g. for mechanical tests.
20.3.3 Set TMA Gain
The gain of a TMA can be modified if supported by the TMA. The name for the
action key word in the CCI script is ‘gain’. The value of the action describes the
gain to be set, with no unit (e.g. 12.0 for 12.0 dB).
110
20 CCI (Customised Control Interface)
20.3.4 Set TMA Mode
The TMA mode can be set as ‘NORMAL’ or ‘BYPASS’. The name for the action
key word in the CCI script is ‘mode’. The value of the action can either be
‘NORMAL’ or ‘BYPASS’.
20.3.5 CCU Firmware Update / Device Data Update
In some cases it will be likely that a large number of CCUs need to be provided
with the latest firmware version or device data information. The CCI offers the
possibility to do this in bulk.
The names for these actions in the CCI script are:
‘firmware’ and ‘dev_data’ respectively. The value describes the path to the
image file to upload to the CCU (e.g. ‘C:\firmware_122.bin’).
For a complete list of possible CCI RET actions please see document
‘ASM_2.0_CCI_documentation.pdf’ in the ASM documentation directory.
20.4 The CCI Flow
The CCI runs through several states to perform the specified actions:
•
•
•
•
•
Retrieving the actions to perform from the XML file.
Updating the internal database.
Setting additional actions which are necessary.
Executing the extracted and additionally set actions.
Generating a report containing status information on the actions.
All these steps are performed automatically without additional input from the
user.
20.5 Create Scenario Snapshot
With the snapshot feature you can create a CCI script for a specific RET system
configuration. This exported XML script can later be used to re-import the stored
configuration of the RET system as it was exported before.
Please consider that the snapshot feature is view-oriented. Complete views can
be exported with the ‘Scenario Snapshot’ feature.
111
20 CCI (Customised Control Interface)
20.6 Importing CCI Scripts
The CCI can be started either by way of the
‘CCI\ImportWizard’ button, or
by specifying an XML file with the Launch-in-Context feature.
To start the CCI at ASM start-up the following command has to be used:
<ASM executable> [--cci_script <cci_script>]
For details see Launch-in-Context
The CCI involves 4 steps:
Step 1: Selecting an XML configuration file.
Step 2: Initializing of the RET components.
Step 3: The CCI performs the actions from the XML file.
Step 4: The CCI has finished and displays a short report.
For further report information click the ‘Save/Show report’ button. A PDF and xml
report is created. The PDF report is automatically displayed in Adobe Reader.
20.6.1 Configuration Selection (Step1)
An XML file has to be specified either by typing the file name into the box or by
selecting a file in the file selection dialogue. A default path for the file selection
dialogue can be set in the application properties dialogue. To start the CCI actions
click the ‘Next’ button.
112
20 CCI (Customised Control Interface)
20.6.2 Initialization (Step2)
The RET components, involved in the ‘CCI’ xml file will be initialized. The status
of each secondary device can be seen by pressing the
sign in the ‘Type’
field. If the status is not OK, then the corresponding failure message will be
displayed in the ‘Error/Message’ field.
• Press the ‘Next’ button to continue.
113
20 CCI (Customised Control Interface)
20.6.3 Performing (Step3)
After the CCI has passed and processed the XML file provided and updated the
database, and has extracted the additional actions that have to be performed, the
CCI displays a list of all actions that will be performed. The CCI status shows the
ongoing progress of the CCI flow. The table shows all RET systems that will be
affected by the actions.
By expanding an RET system in the tree all actions of a particular RET system
are shown in the order they will be performed. The second column displays the
unique ID number of a device or system. The ID number may be different for
different device types or system types. For RET systems it is the IP address;
for RCUs it is the serial number; and TMAs are displayed by serial number and
channel number (1) or (2). The third and fourth columns show the status and
errors for the device actions or the system. The RET system status displays the
current process status of this system.
If any error in one of the action items or in the system itself occurs, it is indicated
in the error column and an error message is displayed informing you that you
cannot continue the process unless the problems are resolved.
The CCI now starts processing the action list. The CCI works in parallel on several
RET systems, but within an RET system performs the actions in the specified
sequence. The number of parallel running RET systems can be configured in
the application properties dialogue. The progress bar below the table shows the
progress of the CCI based on the completed RET systems.
114
20 CCI (Customised Control Interface)
20.6.4 Update Report (Step4)
In addition to the table, the details of a selected tree item are shown separately
in the field below the table. Click the ‘Save/Show Report’ button to generate a
report in xml and PDF format.
After confirming the dialogue, Adobe Reader opens showing the PDF report. This
report is helpful to identify and track errors.
115
21 Annex
21.1 Glossary of Terms
• AISG:
Antenna Interface Standards Group. This association of antenna-related
companies has created an open specification for remote control antenna line
products, called AISG.
• ASM:
Antenna System Manager. A Java-based management application for remote
RET system control.
• CCI:
Customised Control Interface. A feature of ASM Professional Edition that
allows automated ‘mass configuration’ of RET systems via XML
configuration files.
• CCU:
Central Control Unit. The control unit to manage and configure AISG devices.
Also named ‘RET system’ (see ‘RET’).
• Client-Server architecture:
Client-Server architecture means a certain service and control pattern of an
application like the ASM. This enables the customer to use the application in
a multi-location and multi-user manner. The server is responsible for providing
certain services to the connected clients and for managing the central
databases.
• Commissioning:
The initial setup and configuration of a new RET system. This is a mandatory
procedure to be able to use a new RET system. During commissioning
several important parameters are configured, AISG devices are set up,
and the RET system is registered in the ASM database. See ‘Registration
Wizard’.
• Dongle:
A dongle is a piece of hardware connected to a system in order to manage
access and usage rights for applications or for the complete system. Normally
dongles are used to grant ‘one licence – one installation’ relations.
• Explorer:
The navigation and browsing area for RET systems in the ASM.
• Launch-in-Context:
A feature in ASM Professional Edition that allows the user to launch the ASM
using different command line parameters.
For example: ‘asm --ccu_ip_address 192.168.12.240’ launches the
ASM and opens the configuration dialogue of the RET system with the IP
192.168.12.240. Automated launch of the CCI feature is also possible.
• Linked CCU:
A registered CCU (see ‘Registration’) must be linked to a user-defined
view (see ‘View’) shown in the ASM Explorer. Until linked to a view, the RET
system is listed in the ‘Unlinked CCUs’ tree of the ASM. One CCU / RET
system may be linked to one or more views.
• Professional Edition:
ASM Professional Edition provides some enhanced features relative to
the 1.07.1 Standard Edition: CCI feature, Launch-In-Context feature, up to
2000 RET systems, automated (periodic) alarm monitoring and RET data
refreshes.
116
21 Annex
• Registration:
For RET systems to be handled via the ASM, they must be registered in the
embedded database of the ASM. Registration can be performed either via the
CCI feature in Professional Edition, or manually via the Registration Wizard
(see ‘Registration Wizard’).
• Registration Wizard:
An ASM embedded tool to easily commission and/or register RET systems, in
order to integrate them in ASM Management.
• RCU:
Remote Control Unit. An AISG device for remotely changing the tilt of
antennas.
• RET:
Remote Electrical Tilt. Single RCUs or CCUs with connected AISG devices,
especially RCUs, are termed remote electrical tilt systems - RETs for short.
• Roles:
Roles are predefined subsets of certain rights for an application user. Roles
may be used by administrators in order to quickly associate users with
approved access rights. The ASM uses roles as a security concept to manage
the different types of users.
• Session:
A session describes the time between the login of a client with a dedicated
and authenticated application user and the logout of this client. Normally the
term session is used in conjunction with client-server architecture.
• SNMP:
Simple Network Management Protocol. This TCP/IP based protocol is used
for communication between ASM and CCUs.
• TMA:
Tower Mounted Amplifier (Masthead Amplifier). A TMA is a low noise amplifier
for communication between Antennas and Base Transceiver Stations (BTS).
• View:
A visualisation concept of the ASM to group and manage a large number of
RET systems. Every RET system to be controlled by the ASM must be linked
to a view (see ‘Linked CCU’).
117
21 Annex
21.2 Abbreviations
118
AISG
Antenna Interface Standard Group
ASM
Antenna System Manager
CCI
Customised Control Interface
CCU
Central Control Unit
FTP
File Transport Protocol
GSM
Global Standard for Mobile Communication
LAN
Local Area Network
MIB
Management Information Base
PDF
Portable Document Format
PPE
Periodic RET Polling Engine
PPP
Point to Point Protocol
RCU
Remote Control Unit
RET
Remote Electrical Tilt (CCU + RCUs + TMAs + TMBs)
SNMP
Simple Network Management Protocol
STMA
Single Tower Mounted Amplifier
TCP/IP
Transmission Control Protocol / Internet Protocol
TMA
Tower Mounted Amplifier
TMB
Tower Mounted Booster
URL
Uniform Resource Locator
WAN
Wide Area Network
WLAN
Wireless Local Area Network
XML
Extensible Markup Language
21 Annex
21.3 Shortcuts
Command
Shortcut
Language
Icon
(the shortcuts’ identifiers
depend on the language
version of the OS)
Project \ Properties
<ALT> - <P>
Project \ Registration Wizard
<ALT> - <R>
Project \ Exit ASManager
<ALT> - <F4>
CCI \ Create Scenario Shortcut
Ctrl + Shift - C
Strg +Umschalt - C
CCI \ Import Wizard
<ALT> - <C>
User \ Logout
Crtl - Q
Strg - Q
User \ Manage
<ALT> - <F6>
Utilities \ Monitors \ Current
RET Errors
<ALT> - <F8>
Utilities \ Unregistered CCU
\ Update
Ctrl + Shift - U
Strg + Umschalt - U
English
German
Utilities \ Unregistered CCU
\ Reboot
Ctrl + Shift - B
Strg + Umschalt - B
English
German
Utilities \ Database \ Export
RET System Error Report
Ctrl + Shift - S
Strg + Umschalt - S
English
German
Utilities \ Database \ Export
Database
Ctrl + Shift - E
Strg + Umschalt - E
English
German
Utilities \ Database \ Import
Database
Ctrl + Shift - I
Strg + Umschalt - I
English
German
Utilities \ Database \ Delete
Database
Ctrl + Shift - D
Strg + Umschalt - D
English
German
Window \ Minimize all
Ctrl + Shift - M
Strg + Umschalt - M
English
German
Window \ Restore all
Ctrl + Shift - R
Strg + Umschalt - R
English
German
Window \ Close all
Ctrl + Shift – W
Strg + Umschalt - W
English
German
Window \ Re-Sort the Views
Ctrl + Shift – V
Strg + Umschalt - V
English
German
Server \ Server Sessions
Ctrl + Shift - K
Strg + Umschalt - K
English
German
Server \ Server Administration
Ctrl + Shift - P
Strg + Umschalt - P
English
German
Server \ About ASM Server
Shift + <F11>
Umschalt + <F11>
English
German
English
German
English
German
119
21 Annex
Command
Shortcut
Language
(the shortcuts’ identifiers
depend on the language
version of the OS)
120
Help \ ASM Help System
<F1>
Help \ Command Line
<F12>
Help \ About
<F11>
Edit View
<ALT> - <E>
Close View (only Explorer)
<ALT> - <W>
Icon
22 Troubleshooting & FAQs
If there are any potential errors or bugs in the ASM application, please refer to
the document ‘ASM_FAQs.pdf’ first which is located on your ASM CD in the
documentation directory!
This document contains known issues, work-arounds and troubleshooting
solutions.
If your issue is not listed or the document does not serve your needs,
please report the issue or bug to the address(es) listed in the chapter below
(chapter 22).
In that case please provide the information listed below, as this will help to speed
up the bug tracking significantly:
• Screenshots:
Showing the issue or other relevant information; e.g ASM GUI
If possible in the popular ‘jpg’-format.
• ASM Client log file:
<asm_client_inst_directory>\asm_runtime.log
Please ‘zip’ this log file to client_log.zip
• ASM Server log file:
<asm_server_inst_directory>\asm_runtime.log
Please ‘zip’ this log file to server_log.zip
• Database backup:
Use the ASM ‘Utilities\Database\Export Database’ feature
• In case of a CCI error please attach the CCI script.
121
23 Contact addresses
• For all sales inquiries:
Fax (++49)(+8031)184-820
E-Mail: central.sales@kathrein.de
• For technical information:
Fax (++49)(+8031)184-973
E-Mail: antennas.mobilcom@kathrein.de
122
NOTICE
123
936.2808/A/0706/ZWT - Technical data subject to change.
NOTICE
Internet: http://www.kathrein.de
KATHREIN-Werke KG . Phone +49 8031 184-0 . Fax +49 8031 184-494
Anton-Kathrein-Straße 1 – 3 . P.O. Box 10 04 44 . 83004 Rosenheim . Germany