HP TeMIP Software

Client GIS Map Viewer Guide

Edition: 6.4

Minor Release

for Microsoft Windows Operating Systems

Feb 2013

Copyright 2013 Hewlett-Packard Development Company, L.P

Legal Notices
Warranty
The information contained herein is subject to change without notice. The only
warranties for HP products and services are set forth in the express warranty statements
accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. HP shall not be liable for technical or editorial
errors or omissions contained herein.
License Requirement and U.S. Government Legend
Confidential computer software. Valid license from HP required for possession, use or
copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software,
Computer Software Documentation, and Technical Data for Commercial Items are
licensed to the U.S. Government under vendor's standard commercial license.
Copyright Notices
Copyright 2013 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe, Acrobat and PostScript are trademarks of Adobe Systems Incorporated.
HP-UX Release 10.20 and later and HP-UX Release 11.00 and later (in both 32 and 64-bit
configurations) on all HP 9000 computers are Open Group UNIX 95 branded products.
Java is trademark of Oracle and/or its affiliates.
Microsoft , Windows and Windows NT are U.S. registered trademarks of Microsoft
Corporation.
Oracle is a registered U.S. trademark of Oracle Corporation, Redwood City, California.
UNIX is a registered trademark of The Open Group.
X/Open is a registered trademark, and the X device is a trademark of X/Open Company
Ltd. in the UK and other countries.
Google Maps mapping service is a trademark of Google Inc.

Contents

Preface ............................................................................................................. 7
Chapter 1 ....................................................................................................... 10
Introduction ................................................................................................... 10
1.1
1.2
1.2.1
1.2.2
1.3
1.4
1.5
1.5.1
1.5.2
1.5.3
1.6
1.7
1.7.1
1.7.2
1.7.3
1.7.4
1.7.5
1.7.6

Overview ..........................................................................................................10
Hardware and Software Requirements ............................................................11
Hardware ....................................................................................................11
Software ......................................................................................................11
Interoperability .................................................................................................11
License .............................................................................................................11
Geography Information Introduction ................................................................11
Geography Position ....................................................................................12
Zoom Level .................................................................................................12
Map Type ....................................................................................................13
GIS Map Viewer Architecture...........................................................................13
Big GIS Map .....................................................................................................14
Introduction .................................................................................................14
Layer ...........................................................................................................14
Child-Parent Link ........................................................................................16
Automatically Clustering/Un-Clustering ......................................................16
Automatically Icon Resize ...........................................................................17
Brief Alarm Report ......................................................................................17

Chapter 2 ....................................................................................................... 19
GIS Map Viewer ............................................................................................. 19
2.1
2.2
2.2.1
2.2.2
2.2.3
2.3
2.3.1
2.3.2
2.3.3
2.3.4
2.4
2.5
2.6
2.7
2.8

Overview ..........................................................................................................19
GIS Map Item ...................................................................................................20
Entity ...........................................................................................................20
Connector ...................................................................................................20
Graphical Object .........................................................................................21
Alarm Decoration .............................................................................................22
Overview .....................................................................................................22
Own Alarm Decoration ................................................................................22
Child Alarm Decoration ...............................................................................23
Alarm Decoration for Connector .................................................................23
Geography Map Navigation and Map Type Selection .....................................23
Search and Selection .......................................................................................24
Map Hierarchy ..................................................................................................24
Show GIS Information ......................................................................................25
Unsupported Functionalities ............................................................................25

Chapter 3 ....................................................................................................... 27
Build GIS Maps.............................................................................................. 27
3.1
3.1.1
3.1.2
3.1.3
3.1.4
3.2
3.3
3.3.1
3.3.2
3.3.3
3.4

Create GIS Maps Using Map Editor ................................................................27

Map Properties ............................................................................................27
Map Item Properties....................................................................................28
Geocoding Tool...........................................................................................29
Create Big GIS Map ....................................................................................29
Create GIS Maps Using TNDL XML Files .......................................................31
GIS Symbols ....................................................................................................33
Symbol Appearance....................................................................................33
Standard GIS Symbols ...............................................................................34
How to Create Your Own GIS Symbols ......................................................35
How to Migrate Legacy Maps to GIS Maps .....................................................36

Chapter 4 ....................................................................................................... 37
Configuration and Customization ............................................................... 37
4.1 Configuration ....................................................................................................37
4.2 Customized Map Viewer ..................................................................................38
4.2.1
Introduction .................................................................................................38
4.2.2
How to Create a Customized Map Viewer ..................................................38
4.2.3
How to Create a Custom Map ....................................................................38

Chapter 5 ....................................................................................................... 39
Performance, Limitation, and Trouble Shooting ........................................ 39
5.1 Performance.....................................................................................................39
5.1.1
Normal GIS Map .........................................................................................39
5.1.2
Big GIS Map ................................................................................................39
5.2 Limitation ..........................................................................................................40
5.3 Trouble Shooting ..............................................................................................40

Appendix A Map Viewer Public Interfaces for GIS Feature ....................... 42

A.1
A.2

GIS Map Data ..................................................................................................42

Services ...........................................................................................................47

Appendix B GIS Information in TeMIP Map Database ............................... 50

B.1
B.2

GIS Information for Map ...................................................................................50

GIS Information for Map Item...........................................................................51

Tables
Table 1 Additional Item Types for GIS Map ........................................................................ 21
Table 2 Unsupported Toolbar and Menu Entry ................................................................... 25
Table 3 Standard GIS Symbols ............................................................................................. 34

Figures

Figure 1 Component View of GIS Map Viewer .................................................................... 13

Figure 2 Invoke TeMIP Client Services ................................................................................ 14
Figure 3 Comparison of Map Hierarchy and Big GIS Map ................................................. 15
Figure 4 An Example for Define Zoom Level Ranges for Layers ........................................ 16
Figure 5: Brief Alarm Report Look&Feel - Summary ........................................................ 17
Figure 6: Brief Alarm Report Look&Feel Detail ............................................................... 18
Figure 7 GIS Map Viewer Overview ..................................................................................... 20
Figure 8 GIS Map Item .......................................................................................................... 20
Figure 9 Connector Example ................................................................................................. 20
Figure 10 Own Alarm Decoration Example ......................................................................... 22
Figure 11 Child Alarm Decoration Example ........................................................................ 23
Figure 12 Alarm Decoration for Connector .......................................................................... 23
Figure 13 Selection Effects .................................................................................................... 24
Figure 14 Search Tool ............................................................................................................ 24
Figure 15 Map and Map Item GIS Properties...................................................................... 25
Figure 16 GIS Group in Map Property Dialog ..................................................................... 28
Figure 17 GIS Data Tab ........................................................................................................ 28
Figure 18: GUI to Set Zoom Range for Layer ....................................................................... 29
Figure 19: Set Parent Entry .................................................................................................. 30
Figure 20: Set Parent Dialog ................................................................................................. 30
Figure 21: Panel for Big GIS Map ......................................................................................... 30
Figure 22 Generation of Own Alarm Decoration ................................................................. 33

Preface
This document provides a guide of the GIS Map Viewer feature available
in TeMIP Client V6.4. This feature is developed to help operators to
monitor networks based on geography maps.

Intended Audience
This document is aimed at any personnel involved with network
management who needs to know about the functions and capabilities of
TeMIP Client.
Specially, this document is very helpful for the developers and
administrators in charge of deployment and monitoring networks.

Software Versions
The supported software referred to in this document is as follows:
TeMIP
6.2

UNIX
RHEL 5.x/6.x
HP-UX Itanium
11.31

Windows
Windows XP (32 & 64 bits)
SP3

TeMIP
Client
6.4

Windows Server 2003 SP2

Windows Server 2008 SP2
Windows Vista SP2
Windows 7 (32 & 64 bits)

6.1

Linux RHEL AP 5
Update 2, 3, 4

Windows XP (32 & 64 bits)

SP3

6.4

Windows Server 2003 SP2

Windows Server 2008 SP2
Windows Vista SP2
Windows 7 (32 & 64 bits)
6.0

Sun Solaris 2.10

HP-UX Itanium
11.31

Windows XP (32 & 64 bits)

SP3

6.4

Windows Server 2003 SP2

Windows Server 2008 SP2
Windows Vista SP2
Windows 7 (32 & 64 bits)

Note
Please refer to latest release notes for the software and hardware
requirements for TeMIP Client and TeMIP Framework.

Typographical Conventions
Courier Font:
Source code and examples of file contents.
Commands that you enter on the screen.
Pathnames
Keyboard key names
Italic Text:
Filenames, programs and parameters.
The names of other documents referenced in this manual.
Bold Text:
To introduce new terms and to emphasize important words.

Terms and Acronyms

Term

Description

CMV
Custom Map

Customized Map Viewer

A topology map with Custom presentation type.
Process of converting addresses (like "1600 Amphitheatre Parkway,
Mountain View, CA") into geographic coordinates (like latitude 37.423021
and longitude -122.083739)
Geographical Information System
A topology map with GIS/Custom presentation type
GIS Map Viewer
Graphical User Interface
Java Script Object Notation
Latitude
Longitude
Mouse Button 3
Multiple Document Interface
Network Element
Portable Network Graphic; a popular image format used for web pages.
Real Time Alarm Handling
TeMIP Access Library
TeMIP Plug-In
User Interface
Workspace
Third Party Product

Geocoding
GIS
GIS Map
GMV
GUI
JSON
Lat.
Long.
MB3
MDI
NE
PNG
RAH
TAL
TPI
UI
WKS
3PP

Associated Documents
The following documents contain useful reference information:
HP TeMIP Client Installation and Configuration Guide
HP TeMIP Client Overview
HP TeMIP Integrating Applications into the TeMIP Desktop
HP TeMIP Integrating Applications into the TeMIP DesktopInternal Services
HP TeMIP Resource Server Installation and Configuration Guide
For a full list of HP TeMIP Software user documentation, refer to
Appendix A of the HP TeMIP Software Product and Technical Solutions
Overview.

Support
Please visit our HP Software Support Online Web site
at www.hp.com/go/hpsoftwaresupport for contact information, and details
about HP Software products, services, and support.
The Software support area of the Software Web site includes the
following:

Downloadable documentation.

Troubleshooting information.

Patches and updates.

Problem reporting.

Training information.

Support program information.

Chapter 1
Introduction
This chapter introduces the GIS Map Viewer feature briefly. Readers will
learn why this feature is helpful; how to use it and how it works:
Section 1.1 Overview
Section 1.2 Hardware and Software Requirements
Section 1.3 Interoperability
Section 1.4 License
Section 1.5 Geography Information Introduction
Section 1.6 GIS Map Viewer Architecture
Section 1.7 Big GIS Map

1.1 Overview
Since TeMIP Client V6.2 Level 1, customers are allowed to monitor
networks based on geography maps. All map items are distributed
according to their real geography positions. The live status of network can
be viewed by navigating geography maps. It can help customers to locate
the network components that have alarms quickly and analyze root
causes effectively.
It is achieved by introducing geography information to traditional
topology maps and showing them using web GIS services. A standard web
application named GIS Map Viewer (GMV) is developed for this purpose.
GMV is not a stand-alone plug-in instead it is integrated with the
MapViewer. Customers can also develop their own customized map
viewer (CMV) to display maps with GIS information.
To support monitoring a big network (5, 000+ equipments), we introduce a
concept of Big GIS Map in TeMIP Client V6.4. Big GIS Map is a special
GIS map with the following extra features:
Be able to contain a big number of equipments (up to 20k+) without
distinct performance degradation.
Clustering/Un-clustering automatically on zoom out/in
Automatically map icon resize on zoom out/in
Brief alarm report associated with a map item

10

1.2 Hardware and Software Requirements

1.2.1

Hardware
The hardware requirements for the GIS Map Viewer feature are almost
the same as for TeMIP Client V6.4. Please refer to the section 1.1 of the
migration user document.
Please note that this feature requires more memory comparing with
traditional topology map monitoring. Customers are recommended to use
2048MB memory minimal.

1.2.2

Software
The software requirements for the GIS Map Viewer feature are almost the
same as for TeMIP Client V6.4. Please refer to the section 1.1 of the
migration user document.
The only special requirement for this feature is that customers must use
the Internet Explore version 7 or later.

1.3 Interoperability
GIS Map Viewer can interoperate with all supported versions of the
TeMIP Framework. Please refer to the section 1.2 of the migration user
document.

1.4 License
This feature is a part of TeMIP Client and follows the same license policy.
Specially, GIS Map Viewer needs to access at least one kind of web GIS
service. Each web GIS service provider has his own policy to validate for
the customer usage. Customers should follow these policies as well. From
TeMIP client V6.2 Level 1 to V6.4, GOOGLE web GIS service is used only.
Please contact with GOOGLE for detailed license policy.
If customers buy the Google Maps API Premier key, it can be used in the
TeMIP client v6.4. Section 4.1 gives details.

1.5 Geography Information Introduction

The maps shown using GIS Map Viewer (GMV) must have geography
information. To distinguish maps with and without GIS information, a
property named Presentation Type is added. Valid values include:
Null: this map is a topology map without GIS information and it
should be shown by MapViewer. It is the default value.
GIS: this map has additional geography information and should be
shown by GMV.
Custom: this map has geography information and should be shown
by Customized Map Viewer (CMV).

11

Note
The map with GIS/Custom presentation type is termed as a GIS map in
this document.

1.5.1

Geography Position
Latitude
Latitude position shall be defined according the north hemisphere. It is
ranging from 0at the equator to +90for the North Pole, and 90 for the
South Pole.
Longitude
Longitude reference point is the prime meridian, defined to be at the
Royal Observatory, Greenwich, in England. Longitude reference direction
is east. So longitude is ranging from 0 at the Greenwich meridian to
+180in the east direction, and 180 in the west direction.
Degree, minute, second vs. floating point notation
Latitude or longitude can be given using degrees minutes seconds
notation or floating point notation. Conversion rule is the following:
If degrees > 0
FP notation = degrees + (minutes / 60) + (seconds / 3600)
If degrees < 0
FP notation = degrees (minutes / 60) (seconds / 3600)
Samples
Here are the positions of some cities in the world:
Paris, France:
Latitude = 48 51 24" or 48.85667
Longitude = 2 21 7" or 2.341944
New-York, United States
Latitude = 40 71 or 41.18333
Longitude = 74 or 74.0
Shanghai, China:
Latitude = 31 10 or 31.16667
Longitude = 121 28 or 121.4667
Note
The floating point notation is used in GIS Map Viewer feature when
inputting or showing geography position information.

1.5.2

Zoom Level
Each GIS map also contains a zoom level, which defines the resolution of
the current view. The range is different according to web GIS service
provider, e.g. [0-19] for GOOGLE.

12

1.5.3

Map Type
Several types of map views are provided by GIS service providers, e.g.
normal map; satellite; hybird and terrain types are provided by GOOGLE.
Note
Note: Different map types usually have different maximal zoom level.

1.6 GIS Map Viewer Architecture

The GIS Map Viewer is not a stand-alone plug-in, instead, it is a web
application integrated with MapViewer plug-in. The MapViewer plug-in is
also enhanced to forward map data as well as alarm information to GMV
or CMV. It also provides services for them to perform map related
operations.
In this section, the enhancement architecture is introduced briefly and the
GMV is used as an example.
Figure 1 shows the architecture overview. GMV only receives data from
MapViewer. The data exchange mechanism between MapViewer and
TeMIP framework remains the same.

Figure 1 Component View of GIS Map Viewer

This Figure shows how GMV can use services provided by MapViewer or
even other TeMIP client components. It is achieved in two ways: invoking
extern CORBA callbacks through HTTP service and calling MapViewer
special services directly. For the first way, please refer to the integration
user document. For the second one, refer to section 4.2.2 for details.

13

GMV and CMV

can use a
service channel
to invoke the
services of
MapViewer.

Figure 2 Invoke TeMIP Client Services

1.7 Big GIS Map

1.7.1

Introduction
Big GIS map is a special GIS map which is able to contain a great number
of map items (up to 20k+). Section 1.7.2 gives the precise definition. The
whole Big GIS map is divided into several levels and each level
corresponds to a zoom level range. Each map item belongs to a level and
has a GIS position. So operators can navigate the map easily by using
move and zoom out/in. Two map items belongs to neighborhood levels can
have a parent and child relationship. This relationship is used to
simulate the item and sub-map relationship in topology maps. The
details of levels and parent and child relationship are described in
section 1.7.2 and 1.7.3.
A Big GIS Map has some interesting features such as automatic
clustering/un-clustering, icon resize and brief alarm report. These
features are described in section 1.7.4, 1.7.5 and 1.7.6.
A Big GIS map has all GIS map features described in Chapter 2. There
are also some special behaviors:
a) Operators can not open two Map Viewers to show the same Big GIS
maps.
b) It is not recommended to use a Big GIS map as a sub-map.
c) If a map item of a Big GIS map has a sub-map, when doubleclicking the item, the sub-map is always opened in a new Map
Viewer.

1.7.2

Layer
The layer of a topology map is used to control the display of map items.
But for a Big GIS map, layers are used to represent the level concept
mentioned in 1.7.1. When creating a Big GIS map, operators must create
several item layers first. Each item layer represents a level and is

14

associated with a zoom level range. A map item must belong to an item
layer.
These layers can correspond to the map hierarchy levels of topology maps.
Figure 3 gives an example. This network can be divided into four levels in
terms of geographic region, which are Country, Province, City and
Street. The items belongs to these levels could be Province Domain,
City Domain, BSS and BTS respectively. The traditional map
hierarchy is shown in sub-figure (a), where four hierarchy levels
correspond to Country, Province, City and Street. In each level,
items are organized into several maps according to different provinces or
cities or BSSs. A map in a lower level is attached to a map item in higher
level.
A Big GIS map which represents the network is shown in sub-figure (b),
all items are put into one map, but four layers. Each layer corresponds to
a level, such as Country. Each item belongs to one layer, and it can be a
child of an item on the upper layer. The items with a same parent can be
considered as a sub-map in the traditional map hierarchy. This parentchild relationship helps to do alarm propagation, referring to next section
for details.
Province Domain
City Domain

Country

BSS
BTS

Province

City

Street
(a)

A multi-level hierarchy of maps

(b)

A multi-layer big map

Figure 3 Comparison of Map Hierarchy and Big GIS Map

When monitoring a network based on geography background, different
layers of the network are usually shown using different zoom levels.
Therefore, each layer in a Big GIS map is associated with a zoom level
range, that means, the items on this layer should only be shown when
current zoom level is within this range. By doing so, operators can move to
upper (smaller zoom level) or lower (bigger zoom level) layers
automatically when zooming out or zooming in, which we call autoclustering feature in this document.
All zoom levels should be within the valid value set of the Web GIS
Service in use. For example, Google Web GIS API uses [0, 19] as the value
set.
To define zoom level ranges for layers of a Big GIS map, the following
steps are used, as shown in Figure 4:
1) Define the minimal zoom level for the top layer as zMin.
2) Define the maximal zoom level for the bottom layer as zMax.

15

3) Divide the range [zMin, zMax] into several conjoined sub-ranges

according to the layer number.
4) Assign sub-ranges to layers. The max zoom level of a layer must be
one less than the min zoom level of its lower neighbour.
In conclusion, A Big GIS map is a GIS map which layers have valid zoom
ranges. Valid means that the ranges dont have invalid zoom values, are
not overlapped and are conjoined one by one. For example, the four layers
in Figure 3 could have these four zoom ranges: [6, 8], [9, 12], [13, 15] and
[16, 18], seeing Figure 4.
zMin

Province

Country
6

Street

City
12 13

15 16

zMax

18
19

Google Zoom Level Value Set

Figure 4 An Example for Define Zoom Level Ranges for Layers

Note: The layers used in a Big GIS map must not be backdrop layer. They are Item Layer.

1.7.3

Child-Parent Link
In traditional maps, a map item can be associated with a sub-map and
alarm decorations for sub-map items are propagated to it as sub-map
alarm decoration. In a Big GIS map, an item can have many children
which act like a sub-map. The child items must be on the same layer and
their parent must be on the upper layer, as shown in Figure 3. The alarm
decorations for child items are also propagated to their parent as sub-map
alarm decorations.
When creating a Big GIS Map, operators need to setup child-parent
links directly. The Map Editor provides several ways to do it.
The child-parent link is not only used for alarm decoration propagation,
but also for navigation and simple alarm reports. Double-clicking an item
with child items will cause GMV to drill down to the lower layer and show
the child items.
An item in a Big GIS map can also be associated with a sub-map only if it
does not have any children. For example, this sub-map could be a topology
map shows the equipments inside one building, as they have the same
geography positions.
Note: The child-parent link is only for node items. Non-node items such as
links cant be a parent nor have a parent.

1.7.4

Automatically Clustering/Un-Clustering
Automatically clustering/un-clustering means that when operators zoom
in the geographic map, the current items will be replaced by their children
and vice versa. It is because that when operators zoom out or in, GMV will
check to which layer the current zoom value belongs and then show the
map items on this layer only.
Please note that this switch happens only when the zooming operation
crosses two layers.

16

1.7.5

Automatically Icon Resize

Automatically icon resize means that the icons of map items in a Big GIS
map can be automatically resized when zooming out or in. As mentioned
in previous sections, a layer has a zoom range. When the current zoom
value is the min value of the range, the item icons have the minimal sizes;
when the current zoom value is the max value, the icons have the
maximal sizes.
The auto-resize feature can be enabled or disabled as demand. Please
refer to section 4.1 for details.

1.7.6

Brief Alarm Report

In a Big GIS map, if an item has some children, it is possible to display a
brief alarm report for its children without drilling down to the children
layer. The parent can also define for which types of children the alarm
report is generated, referring to section 3.1.4 for details.
If an item has alarm report, a small icon
is shown on the right top
corner. When clicking the icon, the summary part of the alarm report is
drawn using a popup window. The look&feel of the report is as follows.

Figure 5: Brief Alarm Report Look&Feel - Summary

The children of an item could belong to several model types. In this
window, each tab represents a model type. The tab name is the order of
current model. The first line in each tab shows the model name. If the
total model number is larger than 3, there are two little arrow buttons
which can be used to browser among many tabs. The model icon is shown
on the right. The report table has two columns. The first column is the
highest alarm severity and the second one is the number of children
whose highest alarm severity is equal to the left value. For example, the
third row in Figure 5 means that there are 3 bts type children whose
highest alarm severity is Critical.
If operator requires details by pressing a number hyperlink, GMV should
invoke GetDetailReport service. When Map Viewer sends back the detail
report, GMV should draw it at the bottom of the window, referring Figure
5 for look&feel.

17

Figure 6: Brief Alarm Report Look&Feel Detail

Operators are also allowed to see some details. As shown in Figure 6,
when clicking the third row of the report table, a detail report table is
opened. For each item belongs to the clicked row in the summary table,
there is a row in the detail table which gives the item name, highest
severity of pending and new alarms respectively.

18

Chapter 2
GIS Map Viewer
This chapter describes how to monitor a GIS map using GIS Map Viewer.
The GUI and main functionalities are introduced:
Section 2.1 Overview
Section 2.2 GIS Map Item
Section 2.3 Alarm Decoration
Section 2.4 Geography Map Navigation and Map Type Selection
Section 2.5 Search and Selection
Section 2.6 Map Hierarchy
Section 2.7 Show GIS Information
Section 2.8 Unsupported Functionalities

2.1 Overview
GIS Map Viewer is a web application which can present a GIS map based
on geography background. It is located in the same place as traditional
map view, as shown in Figure 7. However, the look and feel is totally
different.

19

Figure 7 GIS Map Viewer Overview

Alarm decorations can also be viewed in GMV. Most map operations
supported by MapViewer are available. GIS maps and topology maps can
belong to the same map hierarchy. The switch between GMV and
MapViewer is very natural and the navigation history is also supported.

2.2 GIS Map Item

2.2.1

Entity
The look and feel of an entity in GMV is composed of the following parts:
Border: Contain the symbol and point the position.
Symbol image: Show entity type.
Label: Show entity name.
Shortcut icon (optional): The entity associated with a map.
Sticker icon (optional): The entity has a sticker.
Border

Symbol Image

Shortcut
Icon

Sticker
Icon
Label

Figure 8 GIS Map Item

Figure 8 gives an example of GIS map entity. A border with arrow at
bottom is used to point out the geography position precisely. It is also used
to show the child or sub-map alarm decoration. The entity itself is
represented by an image. Section 3.3 gives more details of symbol image.
In current implementation, the entity size will remain the same even
when zooming in or zooming out geography maps.

2.2.2

Connector
In GIS maps, a connector must have To and From nodes. It is shown
as a line connected the arrow parts of both entities, as shown in Figure 9.

Figure 9 Connector Example

20

The connectors original color is always black (r=0, g=0, b=0). Its length
will be changed according to zoom level.
Customers can choose to display only the connectors with alarms, refer to
Section 4.1 for details.

2.2.3

Graphical Object
Graphical objects, such as circle, poly-line, etc. can be used in traditional
topology maps. GMV supports the following graphical objects:
Text
A Text item must have a geography position in which it will be
drawn.
Poly-line
A poly-line consists of several points. It can be closed or not. For a
closed poly-line, it can be filled or not.
Some graphical objects in traditional topology maps can be transformed to
GMV objects. Table 1 lists all the possible graphical objects in topology
maps and their counterparts in GMV.
Table 1 Additional Item Types for GIS Map
Topology Map

GMV

Differences

Line

Poly-line

No line pattern.

Double Line

Poly-line

Only draw single line.

Poly-line

Poly-line

No line pattern.

Spline

N/A

Closed Poly-line

Poly-line

Closed Spline

N/A

Rectangle

Poly-line

No fill pattern. No line pattern.

Double Rectangle

Poly-line

Only draw single line. No fill

pattern. No line pattern.

Circle

N/A

Double Circle

N/A

Filled Closed Polyline

Poly-line

Filled Closed
Spline

N/A

Filled Rectangle

Poly-line

Filled Circle

N/A

Text

Text

Text in Rectangle

N/A

Sector

N/A

3 Point Sector

N/A

Wedge

N/A

No fill pattern. No line pattern.

No fill pattern. No line pattern.

21

2.3 Alarm Decoration

2.3.1

Overview
GMV provides a detailed picture of the alarms received for any entity,
provided that the Alarm Handling module is loaded. The alarm
information is conveyed by means of dynamic properties that can, for
example, change an objects color, or display an information bubble. A
major difference comparing with MapViewer is that GMV does not
provide the blinking effect.
In TeMIP Client, possible alarm decorations for a map entity can belong
to the following groups:
Own Severity
Severity changes are related to the entity itself.
Child Severity
Severity changes are related to its child entities.
Sub Map Severity
Severity changes are related to its child maps.
In GMV, Child Severity and Sub Map Severity are shown in the same
way and are termed as Child Alarm Decoration.
When the severity color setting of TeMIP client is changed, GMV will
refresh itself automatically to draw alarm decorations using new severity
colors.

2.3.2

Own Alarm Decoration

The own alarm decoration is used to reflect the alarm severity changes
related to the entity itself. GMV shows it by changing the entity symbols
color. Figure 10 shows an example of own alarm decoration.

Figure 10 Own Alarm Decoration Example

In this figure, BTS_1 and BTS_2 are two BTSs with and without alarms
(the highest severity is Critical). The color of a part of BTS_1 image is
changed using the Critical severity color (Red).
The own decoration color is decided according to the highest severity level
among all the New/Pending alarms target to the entity.
A bubble is used to give information relative to associated New alarms.
The background color is decided by the highest severity level of associated
New alarms. The information string format is described in the MapVeiwer
online help. This bubble will be shown when mouse moving upon the

22

entity. The same as in MapViewer, this bubble can only be shown in

Advanced Mode.

2.3.3

Child Alarm Decoration

Child alarm decoration contains the child or Sub Map severity changes. It
is shown using entity border. Therefore, the own and child decorations
can be shown for the same entity clearly.

Figure 11 Child Alarm Decoration Example

Figure 11 gives examples of child alarm decoration. BTS_1 is with Critical
own decoration and Major child decoration. BSC_1 is with Warning child
decoration only.

2.3.4

Alarm Decoration for Connector

A connector can have an associated entity. Therefore, it also has alarm
decorations. For connector, only own alarm decoration is shown.
For connector, GMV shows alarm decorations by changing its color to the
severity color simply. Figure 12 shows an example.

Connector with
Decoration

Figure 12 Alarm Decoration for Connector

2.4 Geography Map Navigation and Map Type

Selection
Like many web GIS applications, users can navigate geography maps by
drag-dropping operations simply. Double left clicking is used to zoom in
one step; double right clicking is used to zoom out one step. Two navigate
controls are shown on the left-top part of GMV, referring to Figure 7 as an
example.
Web GIS services often provide several types of geography maps. For
example, GOOGLE web GIS service provides the following types:
Map
Satellite
Hybird
Terrain

23

The map type control is shown on the right-top part of GMV, as shown in
Figure 7. Users can switch among map types using it.
Both the map type control and the navigate controls can be configured to
show or not. Users are also allowed to specify the map type used when
opening the map for the first time. Refer to section 3.1.1 for details please.

2.5 Search and Selection

Users can select map items by clicking, Ctrl + clicking, Ctrl + A and
rectangle selecting (Rubber Band), the same as in MapVeiwer. The only
difference is that right clicking on blank area is used to de-select.
Figure 13 shows the selection effects for entity item as well as connector.
Selected Entities

Selected
Connectors

Figure 13 Selection Effects

A simple search tool is provided to help users locate entity items quickly.
As shown in Figure 14, when users input a string, GMV searches all the
entity labels in the current map and returns results. Automatic string
completion is supported. Users can choose the expected one by using uparrow and down-arrow keys. When an item is chosen, the map will
automatically move to show it in the center position.

Figure 14 Search Tool

2.6 Map Hierarchy

As a GIS map always comes from a topology map, it is transparent for
map hierarchy mechanism in TeMIP client. A GIS map can be a top map.
It can drill down to topology maps, GIS maps, default maps or even
transient maps. It can be a sub map too. Its parent can be a topology map
or another GIS map.

24

As shown in Figure 7, the hierarchy tree view remains unchanged. Users

can browse maps on the hierarchy tree freely and switch between topology
maps and GIS maps seamlessly.

2.7 Show GIS Information

The left panel of MapViewer is used to show GIS information. Figure 15
gives examples about how the map and map item properties related to
GIS are shown.

Figure 15 Map and Map Item GIS Properties.

2.8 Unsupported Functionalities

Most MapViewer functionalities are also supported in GMV, such as map
browse history, filter, display associated alarms, find entity, user launch,
etc. Few functionalities are not supported, e.g. overview, layer and state
monitoring.
When opening a GIS map, the unsupported functionalities will be
disabled automatically. The following tables list all the unsupported
functionalities.
Table 2 Unsupported Toolbar and Menu Entry
Functionalities
Rubber Pan Map View
Zoom in continually
Zoom out continually
Zoom rectangle
Map Overview
Display State Information
Display Associated States
Display Associated States in New Window

25

The layer feature is not supported in GMV. All map items are shown after
loading a map even they are in different layers. When opening a GIS map,
the layer panel is disabled.
The overview feature is another unsupported function. If the overview
window has been shown when opening a GIS map, it is grayed.

26

Chapter 3
Build GIS Maps
This chapter describes how to build a GIS map:
Section 3.1 Create GIS Maps Using Map Editor
Section 3.2 Create GIS Maps Using TNDL XML Files
Section 3.3 GIS Symbols
Section 3.4 How to Migrate Legacy Maps to GIS Maps

3.1 Create GIS Maps Using Map Editor

To create a GIS map using Map Editor, users must create a topology map
first. Then necessary GIS information should be added. In this section,
only the second step is described.

3.1.1

Map Properties
A new group is added in the map property dialog to input GIS information
for the map itself. GIS properties include:
Presentation Type
Its definition can be found in section 1.5. The default value is
Null.
Center Position
Define the geography position of the initial view center. The
default value is (0, 0).
Zoom Level
Define the initial zoom level. The default value is 0.
Initial Map Type
Define the initial map type. Possible values can be found in
section 1.5.3. The default value is Map.
Show Navigate Controls
Define whether the navigate controls are shown or not. It is
checked by default.
Show Map Type Control
Define whether the map type control is shown or not. It is checked
by default.
Figure 16 shows the new map property dialog.

27

Figure 16 GIS Group in Map Property Dialog

3.1.2

Map Item Properties

The only GIS information necessary for a GIS map item are geography
positions. Only one geography position is needed for an entity item or a
text graphic object. For poly-line object, each point must have a geography
position. Connector demands no explicit GIS information, as it links two
entity items already.
A new tab is added in the map item property dialog to input geography
positions. The input field is enabled when the maps presentation type is
set as GIS or Custom. Figure 16 shows some examples of the new GIS
data tab.

a) For an entity

b) For a poly-line with four points

Figure 17 GIS Data Tab

The logical positions are still useful for a GIS map item, as a GIS map will
be shown in MapViewer when GMV is not available. It is highly
recommended to design a good logical layout for a GIS map before adding
any GIS information.

28

3.1.3

Geocoding Tool
A simple geocoding tool is integrated with Map Editor to help users input
GIS information quickly. It is a free online tool Map Channels Simple
Geocoder. Users can point a geography position and copy its longitude
and latitude on the tools homepage.
A pre-defined launch is added into MapEditor. It will open a web browser
and navigates to this tools homepage. The launchs name is Geocoding
Tool.

3.1.4

Create Big GIS Map

A Big GIS map is also a GIS map. When creating a Big GIS map,
operators also need to define the map properties and assign GIS positions
for each map item as mentioned in previous sections.
However, there are some special steps need to be taken for creating a Big
GIS map. The following sections give more details.

3.1.4.1

Create Layers
A Big GIS map must have valid icon layers. So it is important to define
the layers just after setting the map properties. Figure 18 shows the panel
to input zoom range for a Big GIS maps layer.

Figure 18: GUI to Set Zoom Range for Layer

Please make sure that the layers zoom ranges are valid, otherwise the
map is considered as a normal GIS map. Refer section 1.7.2 to learn more
about the valid GIS layers.

3.1.4.2

Set Parent-Child Links

There are several methods to set a parent-child link.
1) A MB3 menu entry Set Parent is added. When it is pressed, a
dialog Set Parent dialog is opened to input the parent item ID, as
shown below.

29

Figure 19: Set Parent Entry

Figure 20: Set Parent Dialog

2) For a node item, the GIS Data tab of map item dialog is updated,
as shown below:

Figure 21: Panel for Big GIS Map

In this tab, the Parent field shows the parent item ID. Operators
can input an item ID directly. A list is also shown to show the IDs
of its children. Operators can add and delete children here also.

3.1.4.3

Alarm Report Definition

If an item of a Big GIS map has some children, operators can ask to
generate alarm reports for certain types of children. In Figure 21, there is
a table named Report for. In this table, all children types are listed. If
the checkbox of a row is checked, the GMV will generate reports for the
children of this type.

30

3.2 Create GIS Maps Using TNDL XML Files

Many maps are injected into TeMIP Map Database using XML files
comply with TNDL format. Users can add GIS information into the XML
file directly then import it into TeMIP to generate a GIS map.
The GIS information for map should be included in the Map_Sticker tag
for the Map_Header block. The format is described in appendix B.1.
The GIS information for map item should be included in the
Validity_String tag for each Map_Item block. The format is described
in appendix B.2.
The following is an example XML file which defines a simple GIS map:
////////////////////////////////////////////////////////////////////////////////////////////////////////
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE Maps SYSTEM "/usr/opt/temip/TNDL/dtd/tndl.dtd">
<Maps>
<Map>
<Map_Header>
<Map_Name>"GIStndl"</Map_Name>
<Positioning_Type>Graphic</Positioning_Type>
<Coordinates_Referential>
<Lower_Left_Corner>
<Point X="0" Y="0" />
</Lower_Left_Corner>
<Upper_Right_Corner>
<Point X="2400"

Y="1800" />

</Upper_Right_Corner>
</Coordinates_Referential>
<Map_Sticker>
{ "InitialMapType" : 0, "Position" : { "X" : 34, "Y" : 114 }, "PresentationType" : 1,
"ShowMapTypeControl" : 1, "ShowNavigateControls" : 1, "ZoomLevel" : 6 }
</Map_Sticker>
</Map_Header>
<Map_Items>
<Map_Item>
<Operation Action="Insert"/>
<Id>systopmap1_1245203275253</Id>
<Associated_Map Associated_MapType="Submap">
syssub1
</Associated_Map>

31

<Severity_Display>
<Severity Type='Own'/>
<Severity Type='Child'/>
<Severity Type='Submap'/>
</Severity_Display>
<Parent_Propagation>True</Parent_Propagation>
<Validity_String>
{ "Position" : { "X" : 34, "Y" : 114 } }
</Validity_String>
<Graphical_Representation>
<Center_Coordinates>
<Graphical_Coordinates
X="1192.4143957170854" Y="1226.5801824328637" />
</Center_Coordinates>
<Name>syssub1</Name>
<Graphical_Type>
<Node>
<Scale X="0.8" Y="0.5" />
<Associated_Symbol>
nas
</Associated_Symbol>
<Zoomable>true</Zoomable>
</Node>
</Graphical_Type>
</Graphical_Representation>
</Map_Item>
</Map_Items>
</Map>
</Maps>

////////////////////////////////////////////////////////////////////////////////////////////////////////
For a Big GIS map, the XML file is the same but there is more
information in the Map_Sticker and Validity_String fields. An example
is shown below, appendix B.1 gives details for the Big GIS map related
fields:
////////////////////////////////////////////////////////////////////////////////////////////////////////
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE Maps SYSTEM "/usr/opt/temip/TNDL/dtd/tndl.dtd">
<Maps>
<Map>
<Map_Header>

32


<Map_Sticker>
{ "InitialMapType" : 0, "Position" : { "X" : 34, "Y" : 114 }, "PresentationType" : 1,
"ShowMapTypeControl" : 1, "ShowNavigateControls" : 1, "ZoomLevel" : 6, "GISLayers" : [ {
"ID" : 2, "MaxZoomLevel" : 12, "MinZoomLevel" : 9, "Name" : "CityLayer" }, { "ID" : 1,
"MaxZoomLevel" : 8, "MinZoomLevel" : 2, "Name" : "CountryLayer" } ] }
</Map_Sticker>
</Map_Header>
<Map_Items>
<Map_Item>

<Validity_String>
{ "Position" : { "X" : 34, "Y" : 114 }, "Parent" : "BSS_001", "Report" : [
"bsc", "bts" ] }
</Validity_String>

</Map_Item>
</Map_Items>
</Map>
</Maps>

////////////////////////////////////////////////////////////////////////////////////////////////////////

3.3 GIS Symbols

3.3.1

Symbol Appearance
As described in section 2.2.1, a GIS symbol includes a 4040 image,
termed as original image. To show own alarm decoration clearly a mask
image is used to specify the decoration part of original image. The mask
image is with the same size and all red (r=255, g=0, b=0) pixels represent
the decoration part.
Figure 22 shows how to generation own alarm decoration using the
original and mask images.

Figure 22 Generation of Own Alarm Decoration

For one GIS symbol, when GMV is launched for the first time, six
temporary decoration images are created automatically according to
different severity colors. These files are used to populate the final own
decoration effects. A specific path can be used to save these temporary
files, referring to section 4.1 for details.

33

3.3.2

Standard GIS Symbols

TeMIP client provides many standard symbols for creating a topology
map. Nearly half of them are supported in GMV, Table 3 gives details. All
GIS symbols should be saved in %TEMIP_MAP_RESOURCE
%\GISMODEL\ path.
If GMV cant find a symbol for a GIS map item, the default_model
symbol will be used. Please make sure that all your GIS map items have
valid GIS symbols.
Table 3 Standard GIS Symbols

Symbol Name

Look&feel in
MapViewer

Own
Decoration
in
MapViewer

Remarks for GIS Symbols

border_gateway
bsc
bss
bss2
bts
bts1_z
bts2_z

no transparent decoration

charging_gatewa
y
charging_gatewa
y2
default_model

no transparent decoration

charging_gatewa
y3
dns

no shadow

dns2
dns3
domain
ip_server
ip_server2
host
gns
firewall
gateway
ipsec_device
ipservice
mcc
msc

34

new own decoration

multi_network_h
ost
nas
omc
omc2
omc3

no shadow

other
other_gateway
pe
printer
router
router2
router4
ss7_gateway
switch
switch2
switch3
switch_router
video_server
webserver
workstation
workstation2
workstation3

3.3.3

How to Create Your Own GIS Symbols

Users are allowed to add their own GIS symbols. For example, if you want
to create a GIS symbol named MySymbol, the following steps should be
finished:
1) Add a topology symbol named MySymbol.
2) Create the original and mask images for GIS.
3) Copy these images into the %TEMIP_MAP_RESOURCE%\
\GISMODEL\ path. Please refer section 3.8.3 in installation doc for
details of TEMIP_MAP_RESOURCE.
Step 1 will help you to create a GIS map item using this symbol in Map
Editor. Please refer to the online help to find how to create a topology
symbol. In the following part, the step 2 is discussed.
The original and mask images for a GIS symbol can be drawn using any
image process tool, e.g. Photoshop or ArtIcons. Any picture can be used for
your symbol, just resize it into 4040 range. It is highly recommended to
use white background for original image, as it makes your symbol looks
clear against all map types. The red pixels in mask file should be chosen
precisely to reflect the decoration part. Mask files background is not

35

important. The standard GIS symbols use white but you can use any
other colors.
The image file format must be PNG. The original and mask files must be
named as <symbol_name>_original.png and <symbol_name>_mask.png.
In this example, the names should be MySymbol_original.png and
MySymbol_maks.png.

3.4 How to Migrate Legacy Maps to GIS Maps

The migration from legacy topology map to GIS map is very simple. Users
need only to open a legacy map using Map Editor then input GIS
information as described in section 3.1. The migration can also be done in
bulk by using TNDL files, as shown in Section 3.2.
Map hierarchies will not be changed during the migration.
When a map cant be shown properly by GMV, users need to check first
that whether the map and its items have proper GIS information. Then
the following points need to be checked:
Are there some connectors represented by logical positions instead
of linked items?
Are there some symbols not supported in GMV? Refer to section
3.3.2.
Are there some graphic objects not supported in GMV? Refer to
section 2.2.3.

36

Chapter 4
Configuration and Customization
This chapter describes how to configure GMV and how to develop a
customized map viewer (CMV).
Section 4.1 Configuration
Section 4.2 Customized Map Viewer

4.1 Configuration
All the configuration resources should be added in Map Viewer plug-in
configuration file:
%TEMIP_CLIENT_HOME%\MapViewerSystem.conf
A new section named GIS Map Viewer is added in this configuration file.
An example is shown as follows:
[ GIS Map Viewer ]
Enable GIS Map Viewer = True
Show Normal Connector = False
GIS Map Viewer Path = C:\GMV
GIS Temporary Path = C:\gis_temp
Web GIS Provider = Google
Customized Map Viewer Path = C:\CMV
Customized Map Viewer Entry = My_CMV_Home.html
Auto Icon Resize = True
Google Client ID = ABCXYZ
[ End GIS Map Viewer ]
Where:
Enable GIS Map Viewer:
It is used to enable/disable the GIS feature. The default value is true.
When it is false, a GIS map will be shown in MapViewer always.
Show Normal Connector:
It indicates whether GMV will display normal connectors which do not
have alarms. The default value is false. This configuration resource will
not affect the connectors with alarms, they will always be displayed.
GIS Map Viewer Path:
Indicates where the GMV application files lie in. By default, the
%TEMIP_CLIENTHOME%\GISMapViewer path is used. The entry file
of GMV must be TeMIP_GIS_Map_Viewer.html. Therefore, please make
ensure that this file exists in the GIS Map Viewer Path.
GIS Temporary Path:

37

Indicates the GIS temporary path, referring to section 3.3.1. By default,

the system temporary path is used.
Customized Map Viewer Path:
Indicates where the CMV application files lie in. It is a mandatory
configuration resource for CMV usage. If it does not exist or is not valid, a
Custom map will be shown by MapViewer always.
Customized Map Viewer Entry:
A file acts as the entry of CMV application. This file should exist in the
Customized Map Viewer Path. It is a mandatory configuration resource
for CMV usage. If it does not exist or is not valid, a Custom map will be
shown by the MapViewer always.
Auto Icon Resize
This configuration resource is only used for a Big GIS map. It is a flag to
enable/disable the automatically icon resize functionality. It is True by
default.
Google Client ID
If the customer buys the Google Maps API key, the key should be set
using this configuration resource. Then the TeMIP Client will use this
key to access Google Web GIS Service. Please note that this configuration
resource is introduced since V6.3.

4.2 Customized Map Viewer

4.2.1

Introduction
Users are allowed to use their own applications to show a Custom map.
The application, termed as CMV, should be a web application developed
using JAVA Script.
Before using CMV, make sure that the CMV entry exists and is valid. The
Enable GIS Map Viewer configuration resource must be set as True
too.

4.2.2

How to Create a Customized Map Viewer

A
valid
CMV
must
have
a
function
named
as
TeMIP_MAP_JSCRIPT_ENTRY_POINT. The only parameter of this function is a
JSON string. This interface is used to pass data from MapViewer to GMV
or CMV. The data includes:
Map definition
Alarm decoration information
MapViewer configuration updates
Additional values, such as sticker.
The JSON formats for different kinds of data are introduced in appendix
A.1.
MapViewer provides some services which allow CMV to perform special
operations. The interface definitions and usages are described in appendix
A.2.

4.2.3

How to Create a Custom Map

To create a Custom map, user can follow the same descriptions in Chapter
3 and only change the Presentation Type to Custom.

38

Chapter 5
Performance, Limitation, and
Trouble Shooting
This chapter describes the performance, limitation and trouble shooting
for the GIS Map Viewer feature:
Section 5.1 Performance
Section 5.2 Limitation
Section 5.3 Trouble Shooting

5.1 Performance
5.1.1

Normal GIS Map

Loading a map in GMV will be slower than in MapViewer. The navigation
and zoom in/out are slower too. This is partly because that the web
application cant run as fast as a binary application. In addition, GIS
information processing and communications between MapViewer and
GMV demands more time.
In general, the performance of GMV is related to the following conditions:
Map Size: How many items are included in a map.
Internet Connection Speed: The geography map background
refresh speed highly depends on it.
GOOGLE Web Service Availability: GMV must load GOOGLE
Services before opening a map.
Particularly, drawing connectors are much slower than drawing entities.
Therefore, it is recommended to not display normal connectors.
GMV also demands more memory. For example, a map with 1, 000 items
will use additional 150M memory. Therefore, it is highly recommended to
use 4G memory for your hardware platform.
Higher versions of Internet Explorer are expected to provide better
performance. The minimal version can be used for GMV is IE 7.0.

5.1.2

Big GIS Map

A Big GIS map will achieve better performance than a normal GIS map,
especially when the map item number increases heavily. It is because that
even thousands of items are in the map, only the items in current
viewport is drawn. A set of well designed layers can help to reduce the
map items in a certain viewport.

A.2

39

Therefore, the point of creating a Big GIS map is to avoid putting so many
map items in the same viewport. If there are many items in current
viewport, you can put them into lower layer and add some parent items in
current layers.

5.2

Limitation
The current version of GMV has the following limitations:
Map Size:
The maximal item number (include connectors) for a normal GIS map is
limited to 1, 000. Big item number can cause dramatic performance
degradation. It is highly recommended to use no more than 200 items for
a normal GIS map.
A big GIS map can contain up to 20, 000 items. However, if there are too
many items in a viewport, e.g. more than 200, the performance will be
degraded also. So it is highly recommended to design the layers of a big
GIS map properly to avoid showing too many map items in a viewport.
If the GIS Map Viewer is degraded heavily, there might be an error popup
window:

Users can set the configuration of Internet Explore to forbid this popup
window by using the following steps:
1.

Using a Registry Editor such as Regedt32.exe, open this key:

HKEY_CURRENT_USER\Software\Microsoft\InternetExplorer\Styles
Note If the Styles key is not present, create it.
2.

Create a new DWORD value called MaxScriptStatements under

this key and set the value to the desired number of script statements.
If this is no such a value, the default number is 5,000,000. You can set
a much bigger value to avoid this popup window.
Symbol Size:

For a normal GIS map, the entity symbol size is fixed. When zooming out
geography maps, symbols will be closer to each other and overlap effects
can appear.
Open Map Speed:
If the GIS map contains a huge number of items, e.g. a Big GIS map
might have 10, 000+ items, it will need much more time to open the map.
Opening a 20, 000 items map will need about 4 minutes.

5.3 Trouble Shooting

When GMV does not work properly, please check the following points:
Is the Enable GIS Map Viewer configuration resource set as
True?

40

 Is the GMV/CMV entry file configured well?

The internet connection status.
The GOOGLE Web Service availability.
Is it a valid GIS map or is it a value Big GIS map?
If all answers are ok but the problem still exist, TeMIP support engineers
will help you to investigate.

A.2

41

Appendix A
Map Viewer Public Interfaces for
GIS Feature
This Appendix
GMV/CMV.

describes

the

interface

between

MapViewer

and

A.1 GIS Map Data

For the TeMIP_MAP_JSCRIPT_ENTRY_POINT interface, the following JSON
format is used:
{
"Action" : <action>,
"MapHeader" : {
"MapName" : <map_id>,
"MapFormat" : <map_format>,
"Position" : <initial_position>,
"ZoomLevel" : <zoom>
"Filters" : [ {
"FilterID" : <Unique_filter_ID>,
"Name" : <name>
} ],
"AssociatedEntity" : <TeMIP_entity_name>,
"InitialMapType" : <GISMap_Type_name>,
"ShowNavigateControls" : <boolean>,
"ShowMapTypeControl" : <boolean>,
"GISLayers" : [{
"ID" : <layer_id>,
"Name" : <string>,
"MaxZoomLevel" : <zoom_level>,
"MinZoomLevel" : <zoom_level>
}]
},
"MapItems" : [ {
"ID" : <Unique_Item_ID>,
"Entity" : <temip_full_entity_name>,
"Type" : <map_item_type>,
"URL" : <url>,
"Sticker" : <sticker>,
"Layer" : <Unique_layer_ID>,
"Filters" : [ <Unique_filter_ID> ],
"Representation" : {
"Name" : <item_name>,
"Symbol" : <associated_model>,
"MapType" : <associated_maptype>,
"MapName" : <associated_mapID>,
"Position" : {
"X" : <position_or_north_latitude>,

42

"Y" : <position_or_east_longitude>
},
"Points" : [ {
"X" : <position_or_north_latitude>,
"Y" : <position_or_east_longitude>
} ],
"ConnectedEntities" : {
"From" : <Unique_Item_ID>,
"To" : <Unique_Item_ID>
},
"LineStyle" : <line_style>,
"LineWidth" : < line_width>,
"LineNumber" : <integer>,
"LineStyleStart" : <end_point_style>,
"LineStyleEnd" : <end_point_style>,
"Color" : <color>,
"Text" : <text_value>,
"TextPosition" : {
"X" : <position_or_north_latitude>,
"Y" : <position_or_east_longitude>
},
"Font" : {
"Name" : <font_name>,
"Size" : <font_size>,
"Italic" : <boolean>,
"Bold" : < boolean>,
"Underline" : <boolean>
},
"Closed" : <boolean>,
"FillStyle" : <boolean>,
"FillPatten" : <fill_patten>,
"FillColor" : <color>,
"Parent" : <item_id>,
"Report" : [<unique_symbol_name>]
}
} ],
"Events" : [ {
"ItemID" : <Unique_Item_ID>,
"Events" : [ {
"Variable" : <variable name>,
"Value" : <value>
} ]
} ],
"Global" : {
"Severities" : [ <list_of_severities> ],
"DesktopID" : <temipclient_desktop_ID>,
"HttpPort" : <temipclient_http_service_port>,
"GISProvider" : <GIS_provider>,
"GISModelsPath" : <directory>,
"GISModelsTempPath" : <directory>,
"AdvancedMode" : <boolean>,
"NewPendingAlarmVisibility" : <boolean>
},
"RefreshTimestamp" : <date_time>
}

Where:
Action specifies context of the JSON message. Possible values are:

A.2

43

openmap: indicates that a new map is opened. MapHeader section

contains all map information.

additems: indicates that new items shall be add to the current map.
MapItems section contains the description of items.

notify: indicates a decoration event (alarms or states changes). The

Events section is used to describe event.

closemap: indicates that the current map is about to be closed.

setting: indicates a global setting change. The Global section is used

to describe event.

MapHeader section describes the map to open. Following information are

provide:

MapName: the map name

MapFormat: the map format, oracle or file

Associated Entity: domain associated to the map

Filters: list of {FilterID:, Name:} item

For PresentationType:GIS/Custom:

Position: point of form {X:, Y:} that indicates the initial

position (latitude / longitude) of the map (center point).

ZoomLevel: initial zoom level

InitialMapType: Define the initial Map Type. The possible values

are:
o

Map(0)

Satellite(1)

Hybrid(2)

Terrain(3)

Note: The first four values are for Google. For other providers,
more might be needed.

ShowNavigateControls: Indicate whether the geography navigate

controls are shown or not.

ShowMapTypeControl: Indicate whether the GIS Map Type control

is shown or not.

GISLayers
Where:

44

ID: The layer ID. This ID must been associated to at least one
map item.

Name: The layer name used for GIS solution. As the layer names
for traditional logical map are stored in local tile file other than
Map DB, it is difficult to share layer names among clients from
different machines. We keep a name here for possible GIS usages
and it will be stored in Map DB. It should be a string and can be
NULL.

MaxZoomLevel: The max zoom level of this layer.

MinZoomLevel: The min zoom level of this layer.

Global section gives additional information mandatory to handle map

events:

Severities: tab of {color:XXX, label:YYY} structure, used to

describe alarms severities. Order shall follow MSL definition Colors
shall follow HTML format #RRGGBB.

DesktopID: TeMIP Client desktop ID

HttpPort: port number used by TeMIP Client HTTP Service.

GISModelsPath: full path to directory where bitmaps associated to

symbol are stored

GISModelsTempPath: full path to directory where the temporary

images associated to symbol are stored

AdvancedMode: The advanced mode enable/disable configuration

value in the client. If it is disabled, no bubble is shown for alarm
counter.

NewPendingAlarmVisibility: The New/Pending alarm visibility

configuration value in the client.

MapItems section describes map items. This section is a list of JSON

structures. Each element of the list contains following information:

Type: describes the map item type. Possible values are:

o

Entity

Text

Connector

PolyLine

ID: unique identifier of the item

Entity: TeMIP entity associated to the item

URL: optional, URL associated to the item

Sticker: optional, sticker associated to the item

Filters: optional, list of filter ID. Item shall be displayed only if one of
the filters is active

Layer: ID of the layer used to display the item

Parent: Optional. The ID of its parent item. Only used for items in a
Big GIS map.

Report: Optional. A list of symbol names. For each symbol in the list,
Map Viewer will generate reports from the items children belong to
the symbol. Only used for items in a Big GIS map.

Representation: graphical data of the item

For Type=Entity:
o

Position: point of form {X:, Y: } that indicates the

position of the item

Name: name of the item, mainly used for display

Symbol: name of symbol associated to the item

MapType: The type of the associated map

A.2

45

MapName: The name of the associated map

For Type=Text:
o

Text: text to display

TextPosition: point of form {X:, Y: } that indicates

the position of the text

Color: color of the text. Color shall follow HTML format

#RRGGBB

Font: description of the font to use

Name: font name

Size: font size

Italic: set to 1 if italic mode shall be activated, else 0.

Bold: set to 1 if bold mode shall be activated, else 0.

Underline: set to 1 if underline mode shall be

activated, else 0.

For Type=Connector:
o

Points: set of two points of form {X:, Y:} that

describe the beginend of the connector.

ConnectedEntities: entities associated to connector ends

From: string, name of the first entity

To: string, name of the second entity

For Type=PolyLine:
o

Points set of points that describe the beginend of the

connector. More than 2 points can be present in case of polyline.

Closed: set to 1 if poly-line shall be closed (last point

connected to the first one), else 0. Always 0 in case of simple
line (two points).

Color: color of the line(s). Color shall follow HTML format

#RRGGBB

FillColor: color of the line. Color shall follow HTML format

#RRGGBB

Events section describes decoration/properties changes for map items.

This section is a list of JSON structures. Each element of the list contains
following information:

ItemID: unique identifier of the map item concerned by decoration

changes. If these events are for the whole map, the ItemID should
not exist.

Event: a list of Variable and Value couple, where variable can be any
HDS predefined variables or the variables generated by TeMIP Client.

Event Variables
Variables used to manage alarm decoration include:

46

iOSev:

highest severity on the object for new and pending alarms

iCSev:

idem own but for child entities of the object

iSSev:

idem own but for submap associated to the object

sOSev:

Own Severity String

Other variables for operation include:

Sticker:

Zoom:
Ask the GMV or CMV to zoom in or zoom out. It is
an integer represents zoom steps, positive means zoom in and
negative means zoom out. E.g. -1: zoom out 1 step; +2: zoom in 2 steps.
ItemID should not exist for this event.

Reset:
Ask the GMV or CMV to reset the map with initial
center position and zoom level. ItemID should not exist for this
event. Possible values:

The new sticker set for the item. It is a string.

0: reset to initial center position and zoom level (for the

Reset tool button)

1: move to initial center position, keep the current zoom level.

2: reset to the initial zoom level, keep the current center

position.

Action: Notify the GMV to perform certain actions. ItemID should

not exist for this event. Possible values:
o

0 (Rect_Selection): Set the GMV in the rectangle selection

mode.

1 (Select_All): Ask the GMV to perform select all. This event

should be sent when pressing Ctrl+A.

FilterEnable: Notify the GMV to enable a filter. ItemID should not

exist for this event. Possible value: the filter ID.

FilterDisable: Notify the GMV to disable a filter. ItemID should

not exist for this event. Possible value: the filter ID.

A.2 Services
MapViewer provides services to allow performing operations from GMV or
CMV. These services are accessed using a single interface:
int TeMIP_ExecuteWebInterface(const CString& strJSONParam);
All the parameters should be assembled to a JSON string and passed to
MapViewer. For some services, MapViewer might return information
using a JSON string as well.
The general syntax is as follows:
{
"Service" : <service>,
"Params" : <service_paramter_list>
}
Where the <service_paramter_list> is:
[
{
"Name" : <param_name>,

A.2

47

"Value" : <param_specific_value>
}
]
The available services include:

OpenMap

Select

ShowProperties

DrawMB3Menu

Notify

These services are described in the following parts.

1) OpenMap
The OpenMap service is used to open a map associated to a map item.
Params formats:
{
"Name" : "ItemID",
"Value" : <item_id>
}
Only one map item should be passed.
2) Select
The Select service is used to synchronize the selection between
GMV/CMV and the MapViewer. When selection is changed in GMV/CMV,
GMV/CMV can invoke this service to notify the MapViewer.
Selection synchronization is very important. The MapViewer should
update the operation menu when selection changed.
To notify GMV/CMV about the operation availabilities according to
current selection, this service will return a JSON string represents a MB3
menu.
Params formats:
{
"Name" : "ItemList",
"Value" : [<item_id>]
}
3) ShowProperties
The ShowProperties service is used to show the item properties in the
MapViewer.
Params formats:
{
"Name" : "ItemID",
"Value" : <item_id>
}
4) DrawMB3Menu
The DrawMB3Menu service is used to ask the MapViewer to draw a
MB3 menu at certain position. The MB3 menu should be populated
according to current selection.
No parameters are needed for this service.

48

5) Notify
The Notify service is used to notify the MapViewer plug-in about current
GMV status.
Params formats:
{
"Name" : "Status",
"Value" : <status_value>
}
where the <status_value> includes:
o

0 (Web_GIS_Service_Ready): Web GIS Service is ready.

1 (Web_GIS_Service_Inaccessible):
inaccessible.

Web

GIS

Service

A.2

is

49

Appendix B
GIS Information in TeMIP Map
Database
This Appendix describes the format of GIS information string stored in
TeMIP Database.

B.1 GIS Information for Map

The GIS information for a map is populated as a JSON string and stored
in the Map Sticker field. Appendix gives the details of HDS Map Header
Fields
The syntax of this JSON string is as follows:
{
"PresentationType" : <presentation_type_values>,
"Position" : <initial_position>,
"ZoomLevel" : <zoom>,
"InitialMapType" : <GISMap_Type_name>,
"ShowNavigateControls" : <boolean>,
"ShowMapTypeControl" : <boolean>,
"GISLayers" : [{
"ID" : <layer_id>,
"Name" : <string>,
"MaxZoomLevel" : <zoom_level>,
"MinZoomLevel" : <zoom_level>
}]
}
Where:

PresentationType: This property indicates whether the map is

shown by GMV or CMV. If it does not exist, the map should be shown
by the MapViewer and all the information in Map Sticker field
should be ignored. The possible values include:
o

Null(0)

GIS(1)

Custom(2)

For other properties, please refer to appendix A.1.

The GISLayers field is only used by a Big GIS map.

50

B.2 GIS Information for Map Item

The syntax of this JSON string is as follows:
{
"Position" : {
"X" : <position_or_north_latitude>,
"Y" : <position_or_east_longitude>
},
"Points" : [ {
"X" : <position_or_north_latitude>,
"Y" : <position_or_east_longitude>
} ],
"TextPosition" : {
"X" : <position_or_north_latitude>,
"Y" : <position_or_east_longitude>
},
"Parent" : <item_id>,
"Report" : [<unique_symbol_name>],
}
Different kinds of item have different properties. Please refer to appendix
A.1 for details.
If the Presentation Type property of map header does not exist, all the
information in Validity String should be ignored.
The Parent and Report fields are only used by a Big GIS map.

A.2

51