Ndl Userguide

hp OpenView TeMIP

Network Data Loader

User’s Guide

Edition: 5.0-5

for the UNIX Operating System

June 2005

© Copyright 2003 Hewlett-Packard Company

Legal Notices

Warranty

Hewlett-Packard makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be held liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance, or use of this material.

A copy of the specific warranty terms applicable to your Hewlett-Packard product can be obtained from your local Sales and Service Office.

Restricted Rights Legend

Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause in DFARS 252.227-7013.

Hewlett-Packard Company

United States of America

Rights for non-DOD U.S. Government Departments and Agencies are as set forth in FAR 52.227-19(c)(1,2).

Copyright Notices

©Copyright 2000-2003 Hewlett-Packard Company, all rights reserved.

No part of this document may be copied, reproduced, or translated to another language without the prior written consent of Hewlett-Packard Company. The information contained in this material is subject to change without notice.

Trademark Notices

Adobe® and Acrobat® 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 a U.S. trademark of Sun Microsystems, Inc.

Microsoft® is a U.S. registered trademark of Microsoft Corporation.

Netscape is a U.S. trademark of Netscape Communications Corporation.

NMOS™ is a trademark of RiverSoft Technologies Limited.

Oracle® is a registered U.S. trademark of Oracle Corporation, Redwood City, California.

Oracle7™ and Oracle7 Server™ are trademarks of Oracle Corporation, Redwood City, California.

PostScript® is a trademark of Adobe Systems Incorporated.

Riversoft™ is a trademark of RiverSoft Technologies Limited.

UNIX® is a registered trademark of The Open Group.

Windows® and Windows NT® are U.S. registered trademarks of Microsoft Corporation.

X/Open® is a registered trademark, and the X device is a trademark of X/Open Company Ltd. in the UK and other countries.

All other product names are the property of their respective trademark or service mark holders and are hereby acknowledged.

2

Contents

Preface .........................................................................................................................7

Chapter 1 .........................................................................................................9

Introducing the TNDL .....................................................................................9 1.1 TNDL Overview................................................................................................10 1.1.1 Input Files ...................................................................................................10 1.1.2 Reference Files...........................................................................................12 1.1.3 Data Conversion .........................................................................................12 1.1.4 Automatic Topology Delta Computing ........................................................12 1.1.5 Topology Updates.......................................................................................12 1.1.6 Management Domain Updates ...................................................................13 1.1.7 Map Updates...............................................................................................13 1.1.8 Data Loader Options...................................................................................13 1.1.9 Migrating from TNDL V4.x for HP Tru64 UNIX...........................................13

Chapter 2 .......................................................................................................15

TNDL Input Files ...........................................................................................15 2.1 Global Configuration File .................................................................................15 2.1.1 TeMIP Name Space ...................................................................................16 2.1.2 Name Server...............................................................................................16 2.1.3 Default Map Format ....................................................................................17 2.1.4 Line Width ...................................................................................................17 2.1.5 Line Color....................................................................................................17 2.1.6 Fill Color......................................................................................................18 2.1.7 Text Color ...................................................................................................19 2.1.8 Grid Positioning...........................................................................................20 2.1.9 Network Element Alphasort ........................................................................22 2.1.10 Publish Resource Command ......................................................................22 2.1.11 Configuration File Example.........................................................................23 2.2 Topology File....................................................................................................23 2.2.1 Topology Elements .....................................................................................24 2.2.2 Domain........................................................................................................25 2.2.3 Tndl Element...............................................................................................26 2.2.4 Scoped and Wildcarded Element ...............................................................26 2.2.5 Entity ...........................................................................................................27 2.2.6 Map Membership (Map Item)......................................................................37 2.2.7 Topology File Examples .............................................................................40 2.3 Map File ...........................................................................................................42 2.3.1 Map Header ................................................................................................43 2.3.2 Layers .........................................................................................................55 2.3.3 Map Header Example .................................................................................59 2.3.4 Map Item.....................................................................................................61

3

2.3.5 Graphical Representation ...........................................................................67 2.3.6 Graphical Type............................................................................................76 2.3.7 Full Text Item Example ...............................................................................99 2.4 Profile File ......................................................................................................100 2.4.1 Profile Overview........................................................................................101 2.4.2 Profile Name .............................................................................................101 2.4.3 Coordinates Attribute ................................................................................104 2.4.4 Graphical Representation .........................................................................105 2.4.5 Example Profile Definition Records ..........................................................105 2.5 Delta Topology File and Delta Map File.........................................................107 2.5.1 Entity .........................................................................................................107 2.5.2 Scoped/Wildcarded Element ....................................................................109 2.5.3 Map Header ..............................................................................................111 2.5.4 Map Item...................................................................................................113

Chapter 3 .....................................................................................................115

Activating the TNDL....................................................................................115 3.1 Providing Input Files ......................................................................................115 3.2 Activating the TNDL .......................................................................................115 3.2.1 Authorized User ........................................................................................115 3.2.2 Environment Variables..............................................................................115 3.2.3 Command Line..........................................................................................116 3.2.4 Command Line Options Detailed Description...........................................116 3.3 Checking TNDL Completion Status ...............................................................117 3.3.1 Log Files ...................................................................................................117 3.3.2 Exit Status.................................................................................................118 3.4 Stopping the TNDL ........................................................................................118

Chapter 4 .....................................................................................................119

TNDL Processing ........................................................................................119 4.1 Initialization ....................................................................................................120 4.2 Expand...........................................................................................................120 4.3 Delta...............................................................................................................120 4.3.1 Standard Input Files..................................................................................120 4.3.2 Delta Input Files ........................................................................................121 4.4 MIR Updates ..................................................................................................121 4.5 Domain Updates ............................................................................................121 4.6 Map Updates..................................................................................................122 4.7 How Graphical Representation is Computed.................................................122 4.8 How Graphical Coordinates are Computed ...................................................122 4.8.1 Standard Mode .........................................................................................123 4.8.2 Graphic Mode ...........................................................................................123 4.8.3 Grid Positioning.........................................................................................130

Chapter 5 .....................................................................................................131

Data Conversion .........................................................................................131 5.1 Data Converter Examples..............................................................................131 5.1.1 Data Converter Example 1 .......................................................................132 5.1.2 Data Converter Example 2 .......................................................................132

4

5.2 Data Converter Guidelines.............................................................................133 5.2.1 Naming Entities.........................................................................................133 5.2.2 Ordering Entities for Creation ...................................................................134 5.2.3 Activating Data Conversion ......................................................................134 5.3 Data Conversion Facilities .............................................................................134 5.4 Compiling a Data Converter...........................................................................135

Chapter 6 .....................................................................................................137

Troubleshooting the TNDL.........................................................................137 6.1 The Parsing and Loading Phases..................................................................137 6.1.1 Parsing Phase...........................................................................................137 6.1.2 Loading Phase..........................................................................................138 6.2 Error Conditions .............................................................................................138 6.2.1 TNDL Stop ................................................................................................138 6.2.2 TNDL Abort ...............................................................................................138 6.2.3 Non-Recoverable Entity Creation Failure .................................................139 6.3 The Recovery File..........................................................................................139 6.3.1 Recovery File Content ..............................................................................139 6.3.2 Editing the Recovery File..........................................................................140 6.4 TNDL Messages ............................................................................................140 6.4.1 Information Messages: [0001-0005] .........................................................141 6.4.2 Warning Messages [1001-1329]...............................................................143 6.4.3 Minor Messages [2003] ............................................................................156 6.4.4 Major Messages [3001-3401] ...................................................................156 6.4.5 Critical Messages [4001] ..........................................................................164

Chapter 7 .....................................................................................................165

Migration Tool on HP Tru64 UNIX..............................................................165 7.1 TNDL Migration Tool......................................................................................165 7.1.1 Functionality..............................................................................................165 7.1.2 Migration Tool Launch and Options..........................................................166 7.2 Migration Tool Messages...............................................................................169 7.2.1 Messages..................................................................................................170 7.2.2 Information Messages : [001-005] ............................................................171 7.2.3 Warning Messages [104-121]...................................................................171 7.2.4 TeMIP Warnings [119-121].......................................................................175 7.2.5 Minor Message [202] ................................................................................176 7.2.6 Major Messages [301-322] .......................................................................176 7.2.7 Critical Messages [401-402] .....................................................................179

Chapter 8 .....................................................................................................181

Usage Recommendations ..........................................................................181 8.1 TNDL and TNS Confidence Level .................................................................181 8.2 Special Characters for Attribute Value...........................................................181 8.3 Special Characters for Entity Name...............................................................182 8.4 Special Characters for XML...........................................................................183

Appendix A..................................................................................................185

5

Samples of the Log File..............................................................................185 A.1 Success Log...................................................................................................185 A.2 One Warning..................................................................................................185 A.3 TNDL Stop and Resumption ..........................................................................186 A.4 Parsing Error..................................................................................................186 A.5 Fatal Error and Recovery...............................................................................186

Appendix B..................................................................................................189

DTD Syntax..................................................................................................189 B.1 ELEMENT Declaration...................................................................................189 B.2 ENTITY Declaration .......................................................................................189 B.3 Attribute Declaration ......................................................................................189

Appendix C..................................................................................................191

Configuration File DTD...............................................................................191

Appendix D..................................................................................................193

Topology/Map/Profile File DTD..................................................................193

Appendix E ..................................................................................................199

Data Conversion Classes...........................................................................199 E.1 TCVEntity Class.............................................................................................200 E.2 TCVMember Class.........................................................................................202 E.3 TCVEntitySpec Class.....................................................................................204 E.4 Graphical Classes..........................................................................................205 E.4.1 TCVAbstractMap Class ............................................................................205 E.5 CVBackdrop Class.........................................................................................206 E.5.1 TCVMap Class..........................................................................................207 E.5.2 TCVMapItem Class...................................................................................207 E.5.3 TCVGraphics Class ..................................................................................209 E.5.4 TCVAbstractContainer Class....................................................................211 E.5.5 TCVAbstractContainerItem Class.............................................................212

Glossary ......................................................................................................215

6

Preface

The purpose of this guide is to help network operators in the use of the TNDL system.

Intended Audience This guide is intended for people responsible for the delivery of appropriate input data to the TNDL, and for the network personnel responsible for managing the TNDL system in their TeMIP environment.

Readers are assumed to be familiar with the following:

• UNIX.

• Telecommunications Management Network (TMN) concepts.

• OpenView TeMIP.

A general overview of TeMIP is available in the OpenView TeMIP Product Family Introduction.

Supported Software The supported software referred to in this document is as follows:

Product Version Operating Systems

OpenView TeMIP Network Data Loader 5.0

HP Tru64 Unix

Sun Solaris

HP-UX

The term UNIX is used as a generic reference to the operating system, unless otherwise specified.

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.

7

Associated Documents The following documents contain useful reference information:

• OpenView TeMIP Network Data Loader Installation and Configuration Guide

• OpenView TeMIP Product Family Introduction

• OpenView TeMIP System Reference Manual Volume 1

• OpenView TeMIP Iconic Map and FCL User’s Guide

• OpenView TeMIP Client Overview

For a full list of TeMIP user documentation, refer to Appendix A of the OpenView TeMIP Product Family Introduction.

Support Please visit our HP OpenView web site at: HP OpenView

There you will find contact information as well as details about OpenView products, services and support.

The OpenView support area of the OpenView web site includes:

• Downloadable documentation

• Troubleshooting information

• Patches and updates

• Problem reporting

• Training information

• Support program information

8

http://openview.hp.com/

Chapter 1

Introducing the TNDL The TeMIP Network Data Loader (TNDL) provides a solution to a need common to the majority of TeMIP-based network management solutions:

• How to automate and control the process of “feeding” TeMIP with the current network inventory: managed object registration and naming, collection domain members, state domain elements and geographical maps.

• How to keep the data up-to-date in TeMIP when a change happens in the network configuration (addition, modification, deletion).

TNDL product use is strongly recommended when the configuration of the network elements (including their location and characteristics) are described and maintained in a TeMIP independent configuration database. TNDL is used to “feed” or “populate” TeMIP with this data in an automated and controlled way. Note that TNDL will insure that TeMIP is synchronized with the external inventory updates.

The TNDL product is a tool and needs to be customized. User-defined converters must be developed to convert the source information (inventory data) to the XML input files expected by the TNDL Run-time applications.

Note that the TNDL can also be used if no network configuration database exists: instead of direct/manual TeMIP update by TeMIP operators, a user-defined application or process controls the declaration via a user-defined inventory. The resulting inventory is used by the TNDL to populate TeMIP (directly or via a converter depending on the inventory format).

The TNDL is generic: it does not contain any “hard-coded” descriptions of the network elements that are managed by TeMIP, nor does it have any “hard-coded” limitations in:

• The object model of the managed network elements.

• The number of network elements and their attributes.

• The number and hierarchy of the domains.

• The number and hierarchy of the maps.

The TNDL is able to:

• Register managed objects (name and managing director assignment).

• Create managed object instances (responsible management module MIR will be updated).

• Define and un-define synonyms.

• Set characteristic and reference attributes.

9

• Create domains and add managed objects to collection domains or state domains.

• Create maps and map items (if the graphical characteristics of network elements are supplied, the TNDL creates the associated map item in the map. If the geographical positions of network elements are provided, the TNDL places the map item at the corresponding position in the map).

The TNDL takes the total configuration or a delta configuration as input. It is able to determine any differences since its last execution and executes the appropriate commands to reflect these differences in the TeMIP configuration.

TNDL

Log Files

XML Input filesOR

XML Delta Input files

TeMIP Registration TeMIP Synonyms

TeMIP Access Modules responsible for the Network Elements TeMIP Domains

TeMIP Maps (HDS)

User-defined Converters

Reference files

Profile file

Configuration file

Network Inventory

Topology file

Map file

1.1 TNDL Overview The figure below shows the significant components of a TeMIP solution including TNDL.

Figure 1 Main Components and Interfaces of the TNDL

The TNDL communicates with TeMIP using the Local TeMIP Access Library (TAL).

1.1.1 Input Files The TNDL uses a set of XML input files to populate the TeMIP system. These input files are described below.

10

1.1.1.1 Network Element Topology File The TNDL manages its own representation of network element data. It expects the data to be located in a single place, with a specified format. Network element data might be located in different databases. It is not the purpose of the TNDL to gather and convert raw data. The network element topology file must hold the full list of entities (both global and child entities) to be handled by the TNDL. The network element topology file is optional if a map file is provided; see Section 1.1.1.2 for the description of the map file.

The following information is associated with each entity instance definition:

• The entity name.

• The list of attribute/argument names and their values (including the managing director).

The following is a list of optional items:

• The domains that the entity is a member of.

• The synonyms of the entity.

• The map items (with their graphical representations) to be used to display the entity in maps.

The file may also contain a list of pure graphical objects to display in maps.

It is recommended to define the map items directly in the map file (with their corresponding map definition).

1.1.1.2 Map File This file contains all the information that is needed to automatically create the maps handled by the TeMIP Client Map Viewer application. For each map, it defines the global map characteristics and its map items.

This file is optional: it is possible to define the map items directly in the network element topology file (with their corresponding entities definition).

The following information is associated with each map item definition:

• The map item characteristics (id, name, associated entity).

• The graphical representation to be used to display the map item on a map. The list of possible graphic type is: line, connector, node, polyline, box, circle, spline and text.

1.1.1.3 Profile File This file allows you to define common graphical properties that may be used to represent the map items listed in the map file or the network element topology file. The profile file is optional.

Each profile defines:

• The attribute that contains the geographical coordinates of the entity associated to the map item.

• The graphical representation (line, connector, node, poly-line, box, circle, spline and text) to be used by default, to display any map item attached to this profile.

11

A profile can be either linked to:

• A specific entity: each time this entity is represented on a map, it is displayed using this profile.

• A class: each time an entity of this class is represented on a map, it is displayed using this profile.

• Any map item that references this profile.

1.1.1.4 Configuration File This file defines some general parameters of the TNDL and a list of default values. It is optional.

1.1.2 Reference Files The TNDL also maintains and uses some reference files that contain the description of the network configuration currently loaded in TeMIP. Before the very first run of the TNDL, none of the reference files exist. They are created at the end of the first successful run of the TNDL. Any subsequent run uses these files to compute the difference between the new network configuration and the current one. The TNDL generates the appropriate TeMIP command to load only the differences between the current network configuration and the new one. Each network element topology file, map file and profile file has a corresponding reference file. A reference file has the same format as its corresponding input file.

1.1.3 Data Conversion A pre-processing phase, known as data conversion, is necessary to convert the network inventory raw data to the TNDL XML input format. The data converter(s) are user-defined. They depend on the technology used to store the customer’s network inventory and need to be developed in the context of the System Integration project.

Three examples of data converter programs are supplied, with the toolkit of data conversion facilities used to build them and associated documentation.

1.1.4 Automatic Topology Delta Computing The TNDL can handle the delta inventories in two different ways:

• When the data converter re-generates the full topology and map files, it automatically computes the “delta” of changes, using the reference files it stored in the previous run.

• When the data converter generates delta topology and map files, it directly computes the delta information and merges it with its reference files.

In both cases, the changes include the addition, modification and deletion of network elements, domains and map items.

1.1.5 Topology Updates Depending on the operation to perform on a managed object – addition, modification, or deletion – the TNDL updates TeMIP (the registration data, MIR data, synonyms, maps).

12

1.1.6 Management Domain Updates The TNDL updates alarm collection and state domain membership for the addition/deletion of domains and global network element entities.

1.1.7 Map Updates The TNDL can generate and update maps compatible with the TeMIP Client V5.0 set of products running on Windows and Tru64 UNIX. The TNDL updates the graphic characteristics of entities (coordinates, graphical representation) according to the addition, modification, and deletion of network elements.

Map coordinates are automatically computed, either from a geographical position or from a grid layout.

1.1.8 Data Loader Options The tool provides several options that can be chosen at execution time and provides the flexibility to:

• Load a full configuration in TeMIP.

• Load a delta configuration in TeMIP.

• Refresh the reference files without re-configuring TeMIP.

• Populate the maps and the management domains without creating or deleting the Network Entities.

1.1.9 Migrating from TNDL V4.x for HP Tru64 UNIX The format of the TNDL V5.0 input files (XML) is different from the format of the TNDL V4.x input files (BNF format) Therefore, the TNDL V4.x inputs files are not directly supported by the TNDL V5.0.

A migration tool is provided to convert TNDL V4.0 input files into TNDL V5.0 input files. This way the user can still use his user-defined TNDL V4.0 Data Converter programs and populate TeMIP V5.0 systems. Note however that the TNDL V5.0 input files (XML format) provide more functionality that is not available when using the V4.0 BNF file format. To benefit from all TNDL V5.0 features, the user-defined converters must create the XML files.

13

Chapter 2

TNDL Input Files This chapter describes the use and content of each TNDL input file: global configuration, topology, map and profile files.

2.1 Global Configuration File The TNDL configuration file contains the general parameters that govern the TNDL processing. This file is optional. If used, it must be located in the config directory under the TNDL_WORKSPACE directory (for example /var/opt/temip/TNDL/config), and named config.xml.

The following information can be specified in this file:

• TeMIP namespace

• Default name server instance name

• Default map Format

• Default line width for lined item

• Default line color for lined item

• Default fill color for lined item

• Default color for text item

• Grid Positioning parameters:

• Start Position on a Map

• Horizontal and vertical map item spacing on a map

• Number of map items per display line

• Map item ordering policy on a map

• Sorting policy for the Network Element

• Publish Resource command.

15

Diagram

Note

Child elements in the configuration file must be strictly ordered.

Refer to Appendix C for a full description of the configuration file syntax.

2.1.1 TeMIP Name Space The <Temip_Name_Space> parameter defines the namespace prefix to be used for the naming of all the global entities managed by the TNDL. You should not specify the trailing colon “:”, TNDL will generate it for you.

If this parameter is not specified, or specified with no value, or badly specified, the TeMIP default local name space applies (“local_NS”).

Diagram

Type String

Default “local_NS”

Source <Temip_Name_Space>local_NS</Temip_Name_Space>

2.1.2 Name erver SThe <Name_Server> parameter defines the name of the default Name Server (synonym) instance.

16

If this parameter is not specified, or specified with no value, or badly sp TNDL uses the default value “syno”.

am

ecified, the

Diagr

Type String

Default “syno”

Source <Name_Server>syno</Name_Server>

2.1.3 Defe

this parameter is not specified, or specified with no value, or badly sp TN uses the default value “Oracle”.

ault Map Format The <Default_Map_Format> parameter defines the default format of thmap to be generated if it is not specified.

Ifecified, the DL

Diagram

Type Enum (Oracle, Map_File)

Default Oracle

Source <Default_Map_Format>Oracle</Default_Map_Format>

Note

Map format “Map_File” is supported on HP Tru64 UNIX platforms only.

2.1.4 Linemeter defines the default line width to be used for

ne pology file nor the map

le nor the profile file.

If eter is not specified, or specified with no value, or badly sp TNDL uses the default value “1.0”.

Width The <Line_Width> paraany lined item and any connector in a map. This value is used if the liwidth has not been defined neither through the tofi

this paramecified, the

Diagram

Type Float

Default 1.0

Source <Line_Width>1.0</Line_Width>

2.1.5 Line parameter defines the default color to be used for any

lor

le.

Color The <Line_Color>lined item and any connector in a map. This value is used if the line cohas not been defined through the topology file, the map file or the profile fi

17

If eter is not specified, or specified with no value, or badly sp TN uses the default value: Red=”0”, Green=”0”, Blue=”0”.

this paramecified, the DL

Diagram

Type Color

Attributes

0..255)

en

e

0

Name

Type

Use

Default

Red

Integer (

Required

0

Gre

Integer (0..255)

Required

0

Blu

Integer (0..255)

Required

Source <Line_Color> <Color Red=”0” Green=”0” Blue=”0”> </Line_Color>

2.1.6 Fill or ll

ed through the topology file, the map file or the rofile file.

If eter is not specified, or specified with no value, or badly sp TNDL uses the default value: Red=”255”, Green=”250”, Blue=”250”.

Color The <Fill_Color> parameter defines the color to be used as a fill colforeground for any lined map item in a map. This value is used if the ficolor has not been definp

this paramecified, the

Diagram

Type Color

Attributes

Name

Type

Use

Default

18

Red

Integer (0..255)

(0..255)

250

Required

255

Green

Integer

Required

250

Blue

Integer (0..255)

Required

Source <Color Red=”255” Green=”250” Blue=”250”/> </Fill_Color>

<Fill_Color>

2.1.7 Tex

em in a map. This value is used if the text color has not been defined rough the topology file, the map file or the profile file.

If eter is not specified, or specified with no value, or badly sp the TN the default value: Red=”0”, Green=”0”, Blue=”0”.

Diagram

t Color The <Text_Color> parameter defines the color to be used for any text itth

this paramecified, DL uses

Type Color

Attributes

ault

Required

Name

Type

Use

Def

Red

Integer (0..255)

Required

0

Green

Integer (0..255)

Required

0

Blue

Integer (0..255)

19

0

Source <Text_Color> <Color Red=”0” Green=”0” Blue=”0”/> </Text_Color>

2.1.8 Grid Positioning oses the automatic placement of the map items

2.1.8.1 Grhe <Grid_Start_Position> parameter defines the coordinates of the tarting position for the automatic placement of the map items, when

TN sitioning applies.

If this parameter is not specified, or specified with no value, or y specified, the TNDL uses the default value: X=”0”, Y=”0”.

Diagram

The grid positioning propin a grid layout; see Section 4.8.

The following attributes are used by the TNDL to control the grid positioning.

id Start Position Ts

DL grid po

badl

Type Point

Attributes e

ault

Required

Nam

Type

Use

Def

X

Float

Required

0

Y

Float

0

Source <Grid_Start_Position> <Point X=”0” Y=”0”/> </Grid_Start_Position>

2.1.8.2 Gr

onsecutive map items on a grid line (horizontally and vertically), when NDL grid positioning applies. The distance is computed between map

ite

If this parameter is not specified, or specified with no value, or badly specified, the TNDL uses the default value: X=”100” and Y=”150”.

id Spacing The <Grid_Spacing> parameter defines the distance between two cT

m centers.

20

Diagram

Type Value

Attributes

e

t

Name

Typ

Use

Default

X

Floa

Required

100

Y

Float

Required

150

So <Value X=”100” Y=”150”/> </Grid_Spacing>

urce <Grid_Spacing>

2.1.8.3 Gr

same horizontal grid line, when starts , and

e map. TNDL places the ap item centered on the line axis.

If eter is not specified, specified with no value, or badly specified, the TNDL uses the default v e 10.

id Icons Per Line The <Grid_Icons_Per_Line> parameter defines the maximum number ofmap items that can be placed on the TNDL grid positioning applies. Automatic positioning of map itemsat the position specified by the <Grid_Start_Position> parameterproceeds down the y-axis (right the x-axis) of thm

this paramalu

Diagram

Type Integer

Default 10

Source <Grid_Icons_Per_Line>10</Grid_Icons_Per_Line>

2.1.8.4 Ma

in

_Hierarchy, the map items are ordered

p Ordering Policy When grid positioning applies, the parameter <Map_Ordering_Policy> indicates how map items are ordered in the grid.

When this parameter is set to None, the TNDL displays the map items the order in which they are specified in the topology or in the map file.

When this parameter is set to Classalphabetically by class and instance. A global entity is immediately followed by its child entities (on the next line), if any. When the global class of the entity map item is different from the previous one, the map item is positioned on the next line.

21

Pure graphical map items – line, circle, box, text, polyline, connector, and spline – are supported by this algorithm. They are ordered at the end of lass hierarchy because the TNDL considers them as instances of a virtual ast” class.

W rameter is not specified, or specified with no value, or badly sp the TN ierarchy.

c“l

hen this paecified, DL uses the default value Class_H

Diagram

Type Enum (Class_Hierarchy, None)

Default Class_Hierarchy

Source <Map_Ordering_Policy>Class_Hierarchy</Map_Orderg_Policy>

in

2.1.9 Net

ent entities in the order in

ful

child

n he TNDL), then

orting alphabetically might not be sufficient. In this case, you should set e sorting parameter to Off, and check that the order respects all

de including parent/child ones.

If the sorting parameter is not specified, or specified with no value, or ba cified, e default value On.

work Element Alphasort The <Network_Element_Alphasort> parameter indicates whether the TNDL sorts the elements in the network element topology file alphabetically before processing the file or not. When the parameter is set to Off , the TNDL processes the network elemwhich they are specified in the network element topology file.

Most of the time, the only ordering that must be respected for successentity creation within TeMIP is the parent/child relationship. When records are sorted alphabetically on the entity name, parent entities automatically precede their child entities.

If you set the sorting parameter to On, you can put the network element records in any order, because TNDL automatically reorders them to ensure that parent entities are created before their child entities. With the sorting parameter set to Off, you should check that parent and entities are specified in the correct order.

If the successful creation of an entity is dependent on the existence of aentity other than the parent one (also maintained by tsth

pendencies

dly spe the TNDL uses th

Diagram

Type Enum (On, Off)

Default On

Source <Network_Element_Alphasort>On</Network_Element_Alphasort>

2.1.10 Publish Resource Command Th urce command is used to publish the map resource files ge by th see Section 2.3.2. It is used when the TNDL is launch ith the – ion; see Section 3.2.4.6.

e Publish Resonerated

ed we TNDL;

R opt

22

Diagram

Type String

Default “temip_publish_resource”

Source <Publish_Resource_Command>temip_publish_resource</Publish_Resource_Command>

2 .1.11 Configuration File Example

<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE Configuration_Elements SYSTEM "/usr/opt/temip/TNDL/dtd/config.dtd"> <Configuration_Elements> <Temip_Name_Space>local_NS</Temip_Name_Space> <Name_Server>Syno</Name_Server> <Default_Map_Format>Oracle</Default_Map_Format> <Line_Width>30</Line_Width> <Line_Color> <Color Red="100" Green="110" Blue="10"/> </Line_Color> <Fill_Color> <Color Red="10" Green="110" Blue="100"/> </Fill_Color> <Text_Color> <Color Red="100" Green="110" Blue="10"/> </Text_Color> <Grid_Start_Position> <Point X="0" Y="0"/> </Grid_Start_Position> <Grid_Spacing> <Value X="100" Y="150"/> </Grid_Spacing> <Grid_Icons_Per_Line>6</Grid_Icons_Per_Line> <Map_Ordering_Policy>Class_Hierarchy</Map_Ordering_Policy> <Network_Element_Alphasort>On</Network_Element_Alphasort> <Publish_Resource_Command>temip_publish_resource</Publish_Resource_Command> </Configuration_Elements>

2.2 Topology

be named: topology_<timestamp>.xml, and created

File The topology file contains the description of all the entities (domains, network elements) to be managed by the TNDL. It may contain a list of pure graphical map items to be displayed in map(s).

Naming Convention

The topology file mustin the input directory under the TNDL_WORKSPACE directory (for example /var/opt/temip//TNDL/input). The time stamp should follow the format: yyyymmddhhmmss (for example topology_20020320123410.xml), and is optional.

23

Synchronization File

An empty file, whose name is the same as the topology file, except for the ata file is available for

exists, but not its synchronization file, the also th (for

3410.xmlok).

2.2.1 Top

managed by the TNDL).

extension (.xmlok), notifies the TNDL that the dprocessing. If the data fileTNDL does not process the data file. This synchronization file must be located in the input directory under the TNDL_WORKSPACE paexample topology_2002032012

ology Elements The topology file contains a list of <Topology_Elements> (elements

Note

Child elements in the topology file must be strictly ordered.

Refer to Appendix D for a full description of the topology file syntax.

It e <Domains> list (TeMIP domains) and the <Tndl_Elements> list (TeMIP global and child entities that do not represent a TeMIP domain).

Diagram

contains th

Source <Topology_Elements> <Domains>…</Domains> <Tndl_Elements>…</Tndl_Elements> </Topology_Elements>

Note

TeMIP entities can be specified as members of domains. This implies thdomains m

at ust be specified first.

The ordering of domains in the file is important when for example a domain is specified as member of other domains managed through the

others

a typical TNDL installation you might choose not to declare domains in e topology file, but instead to use the TeMIP Iconic Map/Client or FCL

PM g on the complexity of the domain.

The TeMIP dom ared in the topology file as a list of <Domain> in the s on <D

TNDL. In this case, this domain must be specified before all the domains.

Inth

dependin

ains are declecti omains>.

Diagram

Source <Domains> <Domain>…</Domain> <Domain>…</Domain> </Domains>

24

Th tities are declared as a list of <Tndl_Element> in the section <Tndl_Elements> (<Wildcarded_Element> and <Scoped_Element> are described in Section 2.2.4).

Diagram

e TeMIP en

Source /Tndl_Element>

<Wildcarded_Element>…</Wildcarded_Element> <Wildcarded_Element>…</Wildcarded_Element> <Scoped_Element>…</Scoped_Element>

<Tndl_Elements> <Tndl_Element>…</Tndl_Element> <Tndl_Element>…<

<Scoped_Element>…</Scoped_Element> </Tndl_Elements>

2.2.2 Domain A ins the description of an <Entity> (a TeMIP domain th ed in the TeMIP environment) and an optional <Map_Items> se

Diagram

<Domain> contaat must be creat

ction.

Source <Domain> <Entity>…</Entity> <Map_Items>…</Map_Items> </Domain>

The <Entity> section contains the name, MSL attribute values and synonyms.

T ins a list of <Map_Item> that represents the g stics used to display the domain in map(s). If maps a he TNDL, their map header characteristics must be d 3), and not in the topology file.

he <Map_Items> section contaraphical characterire to be managed by tefined in the map file (see Section 2.

<Topology_Elements> <Domains> <Domain> <Entity> … // TeMIP Domain </Entity> <Map_Items> <Map_Item> … // Representation of the domain in a map </Map_Item> </Map_Items> </Domain>

25

</Domains> </Topology_Elements>

2.2.3 Tndfollows the same logic as a <Domain>

xcept that it does not represent a TeMIP domain.

A ent> contains an optional <Entity> section and an optional <Map_Items> section.

l Element The description of a <Tndl_Element> e

<Tndl_Elem

Diagram

Source <Tndl_Element> <Entity>…</Entity> <Map_Items>…</Map_Items> </Tndl_Element>

A <Entity> is a pure graphical element (an e ap that is not associated to an entity).

<Tndl_Element> without lement displayed in a m

<Topology_Elements> <Tndl_Elements> // Standard TeMIP entity <Tndl_Element> <Entity> … // TeMIP Entity </Entity> <Map_Items> <Map_Item> … // Representation of the entity in a Map </Map_Item> </Map_Items> </Tndl_Element> // Pure Graphical Element <Tndl_Element> // No TeMIP Entity <Map_Items> <Map_Item> … // Pure Graphic Map Item </Map_Item> </Map_Items> </Tndl_Element> </Tndl_Elements> </Topology_Elements>

2.2.4 Sco

list of <Scoped Element> and a list of <Wildcarded Element> may be dded at the end of the <Tndl_Elements> section to specify that those

ped and Wildcarded Element In TeMIP V5.0, a domain may contain wildcarded or scoped entities (as elements of the domain).

Aa

26

gr ties must be specified as elements of domains. See Section 2. re details.

Diagram

oups of enti2.5.4 for mo

Source <Tndl_Ele<Tndl_Elements>

ment>…</Tndl_Element> <Tndl_Element>…</Tndl_Element>

ed_Element>…</Wildcarded_Element> <Wildcarded_Element>…</Wildcarded_Element>

d_Element> t>…</Scoped_Element>

</Tndl_Elements>

<Wildcard

<Scoped_Element>…</Scope <Scoped_Elemen

<Topology_Elements> <Tndl_Elements> < --! Standard Tndl_Element -- > <Tndl_Element> … </Tndl_Element> < --! Wildcarded Element: BOX * -- > <Wildcarded_Element> … </Wildcarded_Element> < --! Scoped Element: BOX box1 with a scoped type -- > <Scoped_Element> … </Scoped_Element> </Tndl_Elements> </Topology_Elements>

2.2.5 Entity The characteristics of a TeMIP entity are specified in the <Entity> section of a <Domain> or <Tndl_Element>.

It contains the entity name, the MSL Attributes, the synonyms and the domain memberships.

27

Diagram

Source <Entity> <Name>…</ <Attributes>…</Attributes>

Name>

<Synonyms>…</Synonyms> t>…</Element> <Elemen

<Member>…</Member> </Entity>

The MSL attributes are specified in the <Attributes> section.

The domain memberships are specified in the <Member> and <Element> sections. These sections contain the list of all domains in which the entity is either a member or an element.

The list of synonym is specified in the <Synonyms> section.

Note

The TNDL cannot deals with several occurrences of the same entity several times in a topology file. Fo ce TNDL is not able to create the object for the first occurrence a forms the different SET

st definition will be taken into account.

r instannd per

directives for others. In such case only the first occurrence is processed, the others generate a warning message telling that only fir

2.2.5.1 Entity Name Attribute T is is the TNDL representation of the TeMIP full entity name. When the c ts several identifier attributes (for example, SNMP) this value m me (the primary identifier attribute).

T names can be expressed as simple names or hexadecimal names (see Full Name and Simple Name in the chapter on Data Types and Structures in the OpenView TeMIP System Reference Manual Volume 1 must follow the TeMIP s t for the namespace name, which must not be specified for the global instance name. Blanks within a name are not allowed (TAL

mitation).

hlass supporust be the TeMIP registered na

eMIP instance

). Each instance name of a TNDL entity nameyntax, excep

li

Note

As

lthough you can define synonyms using TNDL, you cannot ever use a onym in place of the entity name in other statements.

yn

E

ntity Name for Global and Child Entity

<Entity> <Name>BSC bsc1</Name> </Entity>

28

<Entity> <Name>BSC bsc1 BTS first_bts</Name> </Entity>

Hexadecimal Entity Name for Global and Child Entity

<Entity> <Name>BSC .equipment.%xfa41</Name> </Entity> <Entity> <Name>BSC .equipment.bsc1 BTS %XCD98</Name> </Entity>

L Attributes The MSL attributes list describes the MIR data for entity registration, creation, update and deletion. I

2.2.5.2 MS

t can contain any of the settable entity

e.

attributes, and arguments to the entity Register, Create and Delete directives. If those arguments keep the same name as their attribute equivalent (frequently applied rule for Access Module specification), just specify one MSL attribute. It will be used for both entity creation and entity update. An MSL attribute is described by its name and valu

Note

The Register, Create, Delete, and Deregister directives used by the TNDLmay require mandatory arguments defined with a default value in the TeMIP dictionary. You must specify these arguments in th

e MSL attributes list, even if the defaul ppropriate. Otherwise, the t value is adirective will not complete successfully.

When your TeMIP configuration requires you to register an entity on a dedicated director, specify the Routing attribute “Managing Director” in

n

nly a subset of the TeMIP base datatypes is supported by the TNDL. Any class that defines a mandatory argument for the Register, Create or

iv nnot be handled by the TNDL. However, a class that defines a settable attribute with an

rted datatyp DL, because the ed attribute is simply discarded. You need to manage such directly th ugh TeMIP PMs.

TNDL defines its ow teger, float), list and cord, which group

the MSL attributes list. The TNDL uses this value to create the entity iTeMIP. If the “Managing Director” is modified later on, the new value is made effective within TeMIP.

O

Delete direct e with an unsupported datatype ca

unsuppo e can be handled by the TNunsupportattributes ro

n datatypes: scalar (string, inre the supported TeMIP base datatypes.

29

Warning

Carriage return (ASC cter 10) and the following 3-character sub-string: es, comma, double quotes) are not supported in the MS values.

II decimal chara (double quot","L string attribute

Table 1 lists MSL at

the TeMIP d t are supported by the TNDL for tribute specif esponding TNDL datatypes.

Supported TeMIP Datatypes

ata types thaications, with their corr

Table 1

TeMIP Data Type TNDL Representation

Numeric Datatypes

Boolean scalar : string (True,False)

Enumeration scalar : string (name)

TeMIP dictionary presentation

FloatF scalar : float (example: -12.45)

Integer 8 scalar : integer




Unsigned integer 8 scalar : integer




Phase 4 Address scalar : string

Real scalar : float (example: 12e-3)

String Datatypes

Area Address scalar : string

Attribute Identifier scalar : string

Address Prefix scalar : string

Binary Absolute Time scalar : string

Binary Relative Time scalar : string

Directory Specification scalar : string

DTE Address scalar : string

Global Entity Name scalar : string

Local Entity Name scalar : string

Entity Class scalar : string

ID802 scalar : string

ID802_SAP scalar : string

ID802_SNAP scalar : string

30

TeMIP Data Type TNDL Representation

IDENETV2_Type scalar : string

File Specification scalar : string

Full Name scalar : string

Hex String scalar : string

Internet Name scalar : string

Internet Protocol Address scalar : string

Latin1String scalar : string

Network Entity Title (NET) tring scalar : s

NSAP Address r : string scala

Octet scalar : string

Octet string scalar : string

Phase 4 Name scalar : string

Qualified SNA Name scalar : string

Expression scalar : string

Simple Name scalar : string

SNA Resource Name scalar : string

Time24 scalar : string

Transport Se L) scalar : string lector (TSE

Version Number scalar : string

Constructor Datatyp es

Record Record

Sequence Of List

Set Of List

Constructed Datatypes

Attribute scalar : string

String Set scalar : string

STeMIP da

calar attribute values must follow the TeMIP syntax of their respective tatype. Refer to the chapter on Data Types and Structures in

stem Reference Manual, Volume 1 for a yntax of data types.

e MSL attributes are specified in the <Attributes> section of the <

the OpenView TeMIP Syof the input sdescription

ThEntity>.

Diagram

The tribute>. An < e> of the attribute and its <Value>.

<Attributes> section contains a list of <AtAttribute> contains the <Nam

31

Diagram

Scalar MSL Attributes

<Attribute> <Name>quoted string attribute</Name> <Value>"Company name Nice,FRANCE"</Value> </Attribute> <Attribute> <Name>simple string attribute</Name> <Value>value</Value> </Attribute> <Attribute> <Name>enumeration attribute</Name> <Value>CommunicationAlarm</Value> </Attribute> <Attribute> <Name>float attribute</Name> <Value>4.56</Value> </Attribute>

List and Record MSL Attr

ibutes

<Attribute> <Name>list attribute</Name> <Value>("FirstElement","LastElement")</Value> </Attribute> <Attribute> <Name>record attribute</Name> <Value>["float field",”3.4”,”string field”,”string”,"list field",(“34”,”56”)]</Value> </Attribute>

Interaction of MSL Attributes with PMs

file. It will also be eded by the topology file value as soon as the TNDL detects a

hange from its reference value.

TeMIP

As long as an MSL attribute is present in the topology file for an entity, you should not try to modify it through TeMIP PMs. If you do so, the new value will not be reflected in the TNDL topologysupersc

32

2.2.5.3 SynFrom TeMIP V4.0, the TeMIP management model includes synonyms, which are represented by the ASCIISynonym or OSIDNSynonym child classes of the global class NameServer.

In the TNDL V4.0, Synonym instances were maintained using in the same way as other TeMIP entities.

Th i s a new approach to specify the list of synonym related to an enti

The <Entity> se <Synonyms> section.

The <Synonyms> s n optional “Name_Server” attribute, an optional list of <ASCIISynonym> lowed by an optional list of <OSIDNSynonym>.

Note

onyms

e TNDL V5.0 ntroducety.

ction contains a

ection contains a fol

R of this full entity name in the topology fil

egardless synonym definition, you must use thee to declare the entity name.

Diagram

A ame ttributes N

Type

efault

Name_Server

String

ult

D

No defa

Source <Synonyms Name_Server=”alternate_syno_server”> <ASCIISynonym>…</ASCIISynonym>

Synonym>…</ASCIISynonym> Synonym>…</OSIDNSynonym>

</OSIDNSynonym>

<ASCII <OSIDN <OSIDNSynonym>…</Synonyms>

The <Name_Serve es the Name Server instance that will be used to set the following list of <ASCIISynonym> and <OSIDNSynonym>.

er> attribute is not present, the default name server e).

n <ASCIISynonym> is specified by its <Name> and its associated <Tag>.

Diagram

r> attribute specifi

If the <Name_Servwill be used (the default name server is defined in the configuration fil

ASCII Synonym

A

33

Diagram

Type String

Diagram

Type String

Source <ASCIISynonym> <Name>name</Name> <Tag>tag</Tag> </ASCIISynonym>

O

AR d Name (each RDN are separated by the following s .

SI DN Synonym

n <OSIDNSynonym> is a formatted string that describes a sequence of elative Distinguisheeparator: “,”)

Diagram

Type String

Default No Default

Format Sequence of String

Source <OSIDNSynonym>(“rdn1”, “rdn2”, “rdn3”)</OSIDNSynonym>

Full Synonym Example

<Entity> <Name>BSC equipment.bsc1</Name> <Synonyms Name_Server=”alternate_syno_server”> <ASCIISynonym> <Name>name</Name> <Tag>tag</Tag> </ASCIISynonym> <OSIDNSynonym>(“rdn1“,“rdn2“,“rdn3“)</OSIDNSynonym> </Synonyms> </Entity>

2.2.5.4 Domain Membership The s define the domain memberships of t f the entity as a member (or an element) o Element). It allows the p ollection or state domains.

T and <Element> sections contain a list of domain (<Of> secti ember (or an e

<Member> and <Element> sectione specification ohe entity. It is th

f a domain (TeMIP class Domain Member or opulation of the c

he <Member> on). It specifies all the domains that the entity is a m

lement) of.

Diagram

34

<Member> <Of>…</Of> Source <Of>…</Of> </Member>

The domain is specified as an entity name. The <Member> section must be pr obal entities (a child entity can not be a member of a domain).

Domain Member

esent only in gl

Specification

//A Global Entity as member of a domain: <Entity> <Name>Box box1</Name> <Member> <Of>Domain collection.ATM</Of> </Member> </Entity> //A global entity as member of two domains: <Entity> <Name>Box box1</Name> <Member> <Of>Domain CircuitColl</Of> <Of>Domain Customer_Coll </Of> </Member> </Entity>

The <Element> section can be used for child entities.

Diagram

Source <Element> <Of>…</Of> <Of>…</Of> </Element>

Domain Element Specification

//A child entity as element of a domain: <Entity> Box b<Name> ox1 card card1</Name> <Element> <Of>Domain collection.ATM</Of> </Element> </Entity>

Interaction of Domain Membership with TeMIP PMs

When a domain is specified in the topology file for an entity, you should not try to delete the membership using TeMIP PMs. The TNDL would still believe that the entity is a member of the domain.

35

Yo se to handle some domain membership outside the TNDL. In cify in the <Member> or <Element> section the subset of domains for which you want the TNDL to handle entity membership. You can add existing domain membership to the topology file later. When it creates these extra memberships, TNDL will signal that they already ex

Scoped and Wildcard

Scoped and wildcar es can be specified as <Element> of a domain.

Wildcarded Eleme

Diagram

u may choo this case, spe

ist.

ed Elements

ded entiti

nt

Source <Wildcarded_Element> <Name>BOX box1 card *</Name> <Element>…</Element> </Wildcarded_Element>

Scoped Element

The scope type and th of a scoped entity can be specified in the TNDL.

Diagram

dep

Attributes Name

Default

evel_Down,

,

btree”

String

0

Type

Type

Enum:

Base_Object, One_L

Nth_Sub_Level,

To_Nth_Sub_Level

Whole_Subtree

“Whole_Su

Depth

Source <Scoped Element Type="Nth l" DeSub Leve pth="1" <Name>BOX box1</Name>

>

<Element>…</Element> coped_Element> </S

<Topology_Elements>

36

<Tndl_Elements> <Tndl_Element> … </Tndl_Element> <Wildcarded_Element> <Name>BOX box1 card *</Name> <Element> <Of>domain domain1</Of> </Element> </Wildcarded_Element> <Scoped_Element Type="Nth_Sub_Level" Depth="1"> <Name>BOX box1</Name> <Element> <Of>domain domain2</Of> </Element> </Scoped_Element> </Tndl_Elements> </Topology_Elements>

Note

G l Wildcarded entities are not supported as <Element> of a domain. loba

2.2.5.5 Full Entity Example <Entity> <Name>BSS bss1</Name> <Attributes> <Attribute> <Name>Responsible Person</Name> <Value>person1</Value> </Attribute> </Attributes> <Synonyms> <ASCIISynonym> <Name>Equipment1</Name> <Tag>tag1</Tag> </ASCIISynonym> </Synonyms> <Element> <Of>domain domain1</Of> </Element> <Member> <Of>domain domain2</Of> </Member> </Entity>

2.2.6 Map Membership (Map Item) You may define in the <Domain> section that an entity can be displayed in map(s). You have to define a list of <Map_Item> in the <Map_Items> section.

A <Map_Item> defines the <Graphical_Representation> that will be used to display the entity in a map. All the maps where this entity is displayed must have a corresponding <Map_Item>.

It is recommended to specify the list of <Map_Item> in the map file. See Section 2.3.4 for a complete description of the <Map_Item> syntax.

37

38

M

ap Membership Specification

<Topology_Elements> <Domains> <Domain> <Entity> <Name>domain east</Name> … </Entity> <Map_Items> <Map_Item> <Id>item1</Id> <Map_Name>map east</Map_Name> <Graphical_Representation> … </Graphical_Representation> </Map_Item> </Map_Items> </Domain> </Domains> </Topology_Elements>

T contains a <Default_Graphical_Representation> that defines the default values for t entation> of all the <Map_Item> present in the l

T a box entity that is displayed in two maps: t ion applies to the first one; a merge of t pplied to the s

M aphical Representation

he <Map_Items> section

he <Graphical_Represist.

he following example defines he default graphical representathe default and the local graphical representation will be aecond one.

ap Membership with Default Gr

<Map_Items> <Default_Graphical_Representation> <Matched_Filters> <Identifier>1</Identifier> </Matched_Filters> <Associated_URL>http://www.compaq.com"</Associated_URL> <Graphical_Type> <Node> <Associated_Symbol>box</Associated_Symbol> </Node> </Graphical_Type> </Default_Graphical_Representation> <Map_Item> <Id>item1</Id> <Map_Name>map1</Map_Name> </Map_Item> <Map_Item> <Id>item2</Id> <Map_Name>map2</Map_Name> <Graphical_Representation> <Name>Control_Box</Name> <Matched_Filters> <Identifier>2</Identifier>

39

</Matched_Filters> <Associated_URL>http://www.compaq.com/temip" </Associated_URL> <Graphical_Type> <Node> <Position> <Point X="65" Y="305"/> </Position> <Associated_Symbol>box2</Associated_Symbol> </Node> </Graphical_Type> </Graphical_Representation> </Map_Item> </Map_Items>

2.2.7 Topo

D

T th map membership in a d

logy File Examples

omain Hierarchy

his example illustrates a list of domain wiistributed TeMIP configuration.

<Topology_Elements> <Domains> <Domain> <Entity> <Name>Domain .domain.National</Name> <Attributes> <Attribute> <Name>Managing Director</Name> <Value>temip.xny_director</Value> </Attribute> </Attributes> </Entity> </Domain> <Domain> <Entity> <Name>Domain .domain.SouthEast</Name> <Attributes> <Attribute> <Name>Managing Director</Name> <Value>temip.xny_director</Value> </Attribute> </Attributes> </Entity> <Map_Items> <Map_Item> <Id>item1</Id> <Map_Name>Map .domain.National</Map_Name> <Graphical_Representation> <Graphical_Type> <Node> <Position> <Point X="12" Y="24"/> </Position> <Associated_Symbol>domain_large_icon </Associated_Symbol> </Node> </Graphical_Type>

40

</Graphical_Representation> </Map_Item> </Map_Items> </Domain> <Domain> <Entity> <Name>Domain .domain.Site2</Name> <Attributes> <Attribute> <Name>Managing Director</Name> <Value>temip.xny_director</Value> </Attribute> </Attributes> </Entity> <Map_Items> <Map_Item> <Id>item2</Id> <Map_Name>Map .domain.SouthEast</Map_Name> <Graphical_Representation> <Graphical_Type> <Node/> </Graphical_Type> </Graphical_Representation> </Map_Item> </Map_Items> </Domain> </Domains> </Topology_Elements>

N h Domain and Map M

T e definition of a network element with attributes, domain memberships, and map memberships.

etwork Element Entity witembership

his example illustrates th

<Topology_Elements> <Tndl_Elements> <Tndl_Element> <Entity> <Name>MCC .temip.xyz_director HEAP_FILTER hf1</Name> <Attributes> <Attribute> <Name>Forward First</Name> <Value>True</Value> </Attribute> <Attribute> <Name>Similarity</Name> <Value>Any</Value> </Attribute> <Attribute> <Name>Managing Director</Name> <Value>temip.xyz_director</Value> </Attribute> <Attribute> <Name>HEAP_FILTER</Name> <Value>hf1()</Value> </Attribute> <Attribute>

41

<Name>Time Interval Length</Name> <Value>+2-01:20:04</Value> </Attribute> <Attribute> <Name>Target</Name> <Value>*</Value> </Attribute> </A ributes> tt <Me mber> < ilter_coll</Of> Of>Domain .dm.f </Member> </Entity> <Map_Items> <Map_Item> <Id>item3</Id> <Map_Name>Map dm.filter_admin</Map_Name> <Graphical_Representation> <Name>Admin_Filter</Name> <Layer>1</Layer> <Associated_URL> http://temip.vbx.dec.com/NMS/filters.html </Associated_URL> <Graphical_Type> <Node> <Position> <Point X="1.5" Y="2.0"/> </Position> </Node> </Graphical_Type> </Graphical_Representation> </Map_Item> </Map_Items> </Tndl_Element> </Tndl_Elements> </Topology_Elements>

File 2.3 Map generated by the TNDL can be specified in the map file. The list of map

Note

Child elements in the map file must be strictly ordered.

Refer to Appendix D for a full description of the map file syntax.

Na

ated in the

20320123410.xml), and is o

the ext for

ozation file must also

ming Convention

The map file must be named: map_<timestamp>.xml, and creinput directory under the TNDL_WORKSPACE directory (for example /var/opt/temip//TNDL/input). The time stamp should follow the format: yyyymmddhhmmss (for example map_200

ptional.


An empty file, whose name is the same as the map file, except forvailable ension (.xmlok), notifies the TNDL that the map file is a

pr cessing. If the map file exists, but not its synchronization file, the TNDL does not process the map file. This synchroni

42

be located in the input directory under the TNDL_WORKSPACE path (for

Th tional. It contains a list of <Map> element inside the

example map_20020320123410.xmlok).

e map file is op<Maps> section.

Diagram

Source <Maps> <Map>…</Map> <Map>…</Map> </Maps>

A <Map> element represents a map managed by the TNDL. It is not mandatory to create a <Map> element for each map referenced in the topology file. Each <Map> element must be unique. If this rule is not

erved, the TNDL only considers the first occurrence of that <Map> lement, other occurrences are ignored.

escription of the <Map_Header> and an

Diagram

obse

A <Map> element contains the doptional list of insid<Map_Item> e the <Map_Items> section.

Source <Map> <Map_Header>…</Map_Header> <Map_Items>…</Map_Items> </Map>

The <Map_Header> contains general characteristics of the map that are p correctly.

the map file does not contain the definition of a map referenced in the pology file, the grid positioning will be applied for the corresponding

map; see Sec

2.3.1 Mapr contains the following list of TNDL specific attributes:

Positioning Type : The positioning policy that must be apply by the TNDL for this map.

• oordinates Referential: The geographical

A Map Header contains the following list of HDS attributes:

ferential : The coordinates referential of the map.

Backdrop Name : The name of the backdrop.

• Format : The format of the map.

• rts : The predefined viewports of the map.

useful to position map items on the ma

Ifto

tion 4.8.

Header A Map Heade

• Map Name : The name of the map.

•

Geographical Ccoordinates referential for this map.

• Coordinates Re

• Backdrop Type : The type of the backdrop.

•

Defined viewpo

43

• : The filters defined in this map.

• : The active layer of the map.

ated to the map if it exists.

ems.

s.

Map Sticker : The sticker of the map.

• te Units : The units used for the coordinates.

Th Heade e Icon and Backdrop L orresp ce file” managed by the TeMIP Cl

Defined Filters

Current Layer

• Associated Entity : The entity associ

• Is Top Map : The status that ind icates if the map is a top map for its hierarchy.

• Default Text Properties : The default properties of the text it

• Default Url Properties : The default properties of the URL

•

Coordina s

e Mapayers c

r contains the description of thonding to the “map resour

ient.

Diagram

44

2.3.1.1 Map ) Th the name of the map.

Diagram

Name (TNDL Specifice <Map_Name> attribute represents

Type String

Default No Default

The TNDL accepts three different formats for the map name.

Standard Format

It contains the final name of the map:

<Map_Header> <Map_Name>map1</Map_Name> </Map_Header>

Map Format

It contains the name of the map prefixed by the “map” keyword.

<Map_Header> <Map_Name>map map1</Map_Name> </Map_Header>

Full Name Format

It contains the full specification of the map name.

<Map_Header> <Map_Name> P .temip.metis_temip Hierarchy_Services Map map1 TeMI </Map_Name> </Map_Header>

2.3.1.2 Positioning TTh sets the type of positioning that must be g the map item coordinates ca n.

Se .8 for graphical coordinates computation.

ype (TNDL Specific) e <Positioning_Type> attribute applied on the current map durinlculatio

e Section 4

Diagram

Type Enum (Grid, Graphic)

Default Graphic

Source <Positioning_Type>Grid</Positioning_Type>

45

2.3.1.3 CooThe <Coor e coordinates of the lower left

Diagram

rdinates Referential dinates_Referential> attribute map indicates th

corner and the upper right corner of the map.

Type Point

Attributes

Y

0

Name

Type

Use

Default

X

Float

Required

0

Float

Required

Default (0,0) ,1000) (1000

Source es_Referential> <Lower_Left_Corner>

oint X

Rig er> nt X_Right_Corner>

<Coordinat

<P </Lower_Left_Corner>

="10" Y="10"/>

<Upper_ ht_Corn <Poi </Upper

="100" Y="100"/>

</Coordinates_Referential>

2.3.1.4 Ge order to perform geographical placement in a map, geographical

dinates of both the entity and the map must be available. The latter ar as the geographical position of the lower left and upper right gr ordi ote that the geographic system used to define th rdinate e the same as the one used to define the ge oor ities to place in the map.

Th tes(longitude, latit e) or as Lambert coordinates.

ographical Coordinates Referential Incoor

e specified aphical coese coo

nates. Ns must b

ographic c dinates of ent

e coordina can be specified as standard geographical coordinates ud

46

Diagram

Diagram

Attributes Name

Type

Use

Default

Format

Latitude

String

Required

None

([0-90] - [0-59] - [0-59] [N | S])

Longitude

String

Required

None

([0-180] - [0-59] - [0-59] [E | W])

Source <Geographical_Coordinates_Referential> <Geographical_Lower_Left> <Geographical_Coordinates Latitude=”42-30-12N” Longitude=”2-10-50W” /> </Geographical_Lower_Left> <Geographical_Upper_Right> <Geographical_Coordinates Latitude=”45-30-12N” Longitude=”20-10-50W” /> </Geographical_Upper_Right> </Geographical_Coordinates_Referential>

Diagram

47

Attributes Name

Default

Float

ed

Y

Required

Type

Use

X

Requir

None

Float

None

Source <Geographical_Coordinates_Referential>

ates X=”5678” Y=”546” />

inates X=”5800” Y=”600” />

<Geographical_Lower_Left> <Lambert_Coordin </Geographical_Lower_Left> <Geographical_Upper_Right> <Lambert_Coord </Geographical_Upper_Right> </Geographical_Coordinates_Referential>

2.3.1.5 Bate indicates the TeMIP Client supports ckdrops.

Diagram

ckdrop Type1 The <Backdrop_Type> attribupixmap, bitmap and vector ba

Type Enum (None, Bitmap, Pixmap, Vector)

Default None

Source <Backdrop_Type>Bitmap</Backdrop_Type>

2.3.1.6 Backdrop Name2 The <Backdrop_Name> attribute indicates the backdrop name.

Diagram

Type String

Default N Default o

Source <Backdrop_Name>vector_backdrop.dat</Backdrop_Name>

eMIP Client 1 Not used by T

2 Not used by TeMIP Client

48

2.3.1.7 Format Th at> attribute indicates the format of the Map.

Diagram

e <Form

Type Enum(Oracle, Map_File, …)

Default Oracle (<Default_Map_Format /> in the configuration file)

Source <Format>Oracle</Format>

Note

Map format “Map ed on HP Tru64 UNIX platforms only.

_File” is support

2.3.1.8 Defined Viewports The <Defined_Viewports> ttribute represents the list of predefined viewports of the m

A ewpo following list of attributes:

Refere

A Referential Point Type.

•

a

ap.

defined vi rt has got the

• A Name.

• A ntial Point.

•

A Zoom.

Diagram

N ute

he <Name> attribute defines the name of the defined viewport.

Diagram

ame Attrib

T

Type String

Default No Default

49

Ref Point Attribute

The <RefPoint> attribute defines the referential point of the defined viewport.

Diagram

Type Point

Attributes Name

Type

Use

Default

X

Float

quired

Y

Re

0

Float

Required

0

Default No Default

Zo te

The <Zoom> attribute defines the zoom applied to the defined viewport.

Diagram

om Attribu

Type Float

Default t No defaul

Ref Point Type Attribute

The <RefPointType> attribute defines the type of the referential point.

Diagram

Type Enum (Center, UpperRight, UpperLeft, LowerRight, LowerLeft)

Default No default

50

Full Defined Viewports Example

<Map_Header> <Defined_Viewports> <Defined_Viewport> <Name>viewport1</Name> <RefP oint> <Point X="10" Y= "20" /> /Ref < Point> <Zoom>1.0</Zoom> <RefPointType>Center</RefPointType> </Defined_Viewport> </Defined_Viewports> </Map_Header>

2.3.1.9 DefT ers that are applied on the c

T rs to define filters. Filters can be a ap items that match a given f s are applied across layers.

A fi tifier.

ined Filters he Defined Filters attribute defines the filturrent map.

he Map Filter feature enables usepplied to maps in order to display only the milter. Note that filter

lter is identified by its name and its iden

Diagram

Source < Filter> <Name>filter1</Name>

fier>1</Identifier> >

<Identi</Filter

N ute

Th attribute indicates the name of the filter.

ame Attrib

e <Filter>

Diagram

Type String

Default No Default

51

Identifier Attribute

The <Identifier> attribute indicates the identifier of the filter.

Diagram

Type Integer32

Default No Default

Full Defined Filters Example

<Map_Header> <Defined_Filters> <Filter> <Name>switches</Name> <Identifier>1</Identifier> </Filter> <Filter> <Name>admin</Name> entifier>2</Identifier> <Id ter> </Fil <Filter> <Name>customer path</Name> <Identifier>3</Identifier> </Filter> </Defined_Filters> </Map_Header>

2.3.1.10 Current Layer The <Current_Layer> attribute indicates the active Layer of the Map.

Diagram

Type Integer

Default No default

Source <Current_Layer>1</Current_Layer>

2.3.1.11 AssT e A ociated to the m

ociated Entity h < ssocited_Entity> attribute indicates the entity assap.

Diagram

Type String

Default No Default

Source <Associated_Entity>Domain domain1</Associated_Entity>

52

2.3.1.12 Is Top Map This status indicates if the Map is a Top Map for its hierarchy.

A Top Map is displayed in the hierarchy tree and can be regarded as a ap having particular significance. This could be a Map that is at the

he er chy (or at the head of a part of it), a Map containing a sp f equipment, or a Map that needs to be located and loaded

t

t are displayed.

Diagram

Mad of the hiecific type o

ar

regularly. The notion of Top Map is useful, for example, to reduce the lisof Maps displayed in the Open Map window. Only those Maps with the attribute se

Type Boolean

Def u t False a l

Source <Is_Top_Map>True</Is_Top_Map>

2.3.1.13 Def T ts the default text properties f

Diagram

ault Text Properties3

he <Default_Text_Properties> attribute seor the current map.

Se 2.3. t_Properties> at

Full Default Text Properties Example

e Sectiontributes.

6.5 for the description of the <Default_Tex

<Map_Header> <Default_Text_Properties> <Font_Color> <Color Red="0" Green="0" Blue="255"/> </Font_Color> <Font_Size>12</Font_Size> <Font_Modifier Italic="True" Bold="False" Underlined="False"/ <Font_Name>Arial</Font_Name> <Text_Is_Visible>Default_Visibility</Text_Is_Visible> </Default_Text_Properties> </Map_Header>


53

2.3.1.14 Default Url Properties4 The <Default_Url_Properties> attribute specifies the default URL

ent map.

Diagram

properties for the curr

See Section 2.3.5.7 for the description of the <Default_Url_Properties> attributes.

Full Default UrlProperties Example

<Map_Header> <Default_Url_Properties> <Font_Color> <Color Red="0" Green="0" Blue="255"/> </Font_Color> _Size>12</Font_Size> <Font _Modifier Italic="True" Bold="False" <FontUnderlined="False"/> <Font_Name>Arial</Font_Name> <Text_Is_Visible>Not_Visible</Text_Is_Visible> </Default_Url_Properties> </Map_Header>

2.3.1.15 Map Sticker5 The <Map_Sticker> attribute indicates the Map Sticker.

Diagram

Type String

Default No Default

Source <Map_Sticker>sticker1</Map_Sticker>

4 Not used by TeMIP Client 5 Not used by TeMIP Client

54

2.3.1.16 Coordinates Units6

Diagram

The <Coordinates_Units> attribute indicates the coordinates units.

Type String

Default No t Defaul

Source <Coordinates_Units>centimeter</Coordinates_Units>

2.3.2 Layerer> contains a <Layers> section that describes the layers

iated yers must be stored in the source file” is generated by

ap.

Pl e Section 3.2.4.6 to understand the generation and the publicat file”.

2.3.2.1 Map escripThe <Layers> section contains the list of <Layer_Description>.

s The <Map_Headassoc to the map. The description of the laTeMIP Client “map resource file”. One “map rem

ease refer to thion of the “map resource

Layer D tion

Diagram


55

Id Attribute

The <Id> attribute is the identifier of the layer. It must be unique in themap co

ntext (two layers of the same map must not have the same <Id>).

e of a map item.

Diagram

This attribute is used to match with the <Layer> attribut

Type String

Mandatory Yes

Default No Default

Name Attribute

The <Name> ute is the name of the layer.

attrib

Diagram

Type String

Default No Default

Minimum/Maximum Zoom Attributes

Th attributes are related to the zo of the m e layer is visible when the zoom factor of the map is between the <Minimum_Zoom> and <Maximum_Zoom> values.

be inferior to the .

e <Minimum_Zoom>om factor

and <Maximum_Zoom>ap. Th

The <Minimum_Zoom> must <Maximum_Zoom>

Diagram

Type Float in [0.0, 1.0]

Mandatory Yes

Default (0.0, 1.0)

56

Detectability Attribute

The <Detectability> attribute indicates the detectability status of the la

• ctability must be set to True for Icon Layers.

• ility sh be set to False for Backdrop Layers.

Diagram

yer:

The dete

The detectab ould

Type Boolean

Default True

Visibility Attribute

The <Visibility> ute indicates the visibility status of the layer when a map is ope in the TeMIP Client.

• Not visible.

• Visible (only if t factor is between the <Minimum_Zoom> and <Maximum_Zoom>

attribned

he zoom values).

Diagram

Type Boolean

Default True

Backdrop Tiles att

The <Backdrop_Tiles> tribute contains the description of the tiles of the backdrop layer tectability> is false). A <Tile> contains a file name and the e of the backdrop.

Diagram

ribute

at (when <Dextent

File Attribute

The <File> attribute contains the name of the backdrop (the TeMIP C e). This file must be available in the % OURCES%\MAPS directory of the TeMIP Client).

lient model file namTEMIP_MAP_RES

57

Diagram

Type String

Mandatory Yes

Default No Default

L

T ent> es represent t

ow Left Extent/Upper Right Extent Attributes

he <Low_Left_Extent> and <Upper_Right_Extile extent.

attributhe coordinates of the backdrop t

Diagram

Type Point

Attributes Name

Type

Default

X

Float

Required

Use

Float

Required

0

Y

0

Diagram

Type Point

Attributes Name

Type

Use

Default

X

Float

Float

Required

0

Required

0

Y

58

2 Example .3.2.2 Full Layers <Map_Header> <Layers> <Layer_Description> <Id>1</Id> <Name>layer1</Name> <Minimum_Zoom>0.1</Minimum_Zoom> <Maximum_Zoom>0.5</Maximum_Zoom> <Detectability>True</Detectability > <Visibility>True</Visibility> </Layer_Description> <Layer_Description> <Id>2</Id> <Name>layer2</Name> <Minimum_Zoom>0.5</Minimum_Zoom> <Maximum_Zoom>0.8</Maximum_Zoom> <Detectability>False</Detectability > <Visibility>True</Visibility> <Backdrop_Tiles> <Tile> <File>fileName</File> <Low_Left_Extent> <Point X=”12” Y=”20”/> </Low_Left_Extent> <Upper_Right_Extent> <Point X=”24” Y=”40”/> </Upper_Right_Extent> </Tile> </Backdrop_Tiles> </Layer_Description> </Layers> </Map_Header>

2.3.3 Map

2.3.3.1 Ma aphic Placement T nt of entities.

Header Example

p Header Definition for Default Grhis example describes a map that allows graphic placeme

<Maps> <Map> <Map_Header> <Map_Name>map1</Map_Name> <Coordinates_Referential> <Lower_Left_Corner> <Point X=”0” Y=”0”/> </Lower_Left_Corner> <Upper_Right_Corner> <Point X=”1000” Y=”1000”/> </Upper_Right_Corner> </Coordinates_Referential> </Map_Header> </Map> </Maps>

59

2.3.3.2 MaCo

p Header Definition with Standard Geographical ordinates This example describes a map whose geographic coordinates are available to perform standard geographical placement of the map.

<Maps> <Map> <Map_Header> <Map_Name>map2</Map_Name> <Coordinates_Referential> <Lower_Left_Corner> <Point X=”0” Y=”0”/> </Lower_Left_Corner> <Upper_Right_Corner> <Point X=”1000” Y=”1000”/> </Upper_Right_Corner> </Coordinates_Referential> <Geo agr phical_Coordinates_Referential> <Geographical_Lower_Left> -<Geographical_Coordinates Latitude=”40-30-10N” Longitude=”3012-05W”/> </Geographical_Lower_Left> <Geo agr phical_Upper_Right> <G -eographical_Coordinates Latitude=”43-45-58S” Longitude=”13429-16E”/> </Ge rog aphical_Upper_Right> </Geographical_Coordinates_Referential> </Map_Header> </Map> </Maps>

2.3.3.3 Ma Th ble to bert geographical placement of the map.

p Header Definition with Lambert Geographical Coordinates is example describes a map whose geographic coordinates are availaperform Lam

<Maps> <Map> <Map_Header> <Map_Name>map3</Map_Name> <Coordinates_Referential> <Lower_Left_Corner> <Point X="0" Y="0"/> </Lower_Left_Corner> <Upper_Right_Corner> <Point X="1000" Y="1000"/> </Upper_Right_Corner> </Coordinates_Referential> <Geographical_Coordinates_Referential> <Geographical_Lower_Left> <Lambert_Coordinates X="100" Y="150"/> </Geographical_Lower_Left> <Geographical_Upper_Right> <Lambert_Coordinates X="345" Y="238"/> </Geographical_Upper_Right> </Geographical_Coordinates_Referential> </Map_Header> </Map> </Maps>

60

2.3.4 Map Item The <Map_Item> attribute describes a graphical object displayed in a

ap.

A map item can be represented by a node (icon), a connector, a text or a graphical shape (line, circle, box, polyline, spline).

Map Items are normally graphical objects associated with TeMIP data, although not necessarily representing TeMIP entities. Map Items that do not represent TeMIP entities can be Shortcuts, URLs or simple graphical objects. In addition, map items that are not TeMIP entities can be added to a map to describe planned changes to the network as it expands. An entity association can be made later when the new equipment is added to the network. Map Items reflect changes in the network based on incoming alarm information, by changes of color, display of an information box… If, for example, the network topology is geographically based, a map can help the operator to find the geographical location of a problem and then descend the hierarchy to find the faulty equipment itself. In this way an operator can monitor changes in the network as they happen and take action to remedy faults as soon as they occur.

A map item is defined using the following list of TNDL attributes:

• Map Name : The name of the Map that contain the map item.

• Graphical Profile : The graphical Profile associated to the map item.

A map item is defined using the following list of HDS attributes:

• ID : The unique identifier of the map item.

• Associated Entity : The TeMIP entity associated to the map item.

• Associated Map :

d Map Name: The unique identifier of the map that is

map item. The map type can be Shortcut, Submap, Transient or

Hierarchy: The Top Map Hierarchy if the ed ype is Shortcut.

• ity Disp e severity status that the map item reflects: its rities d objects severities and/or its sub map

• Parent Propagation : The parent propagation status.

m

• Associateassociated to the map item.

• Associated Map Type : The kind of map that is associated to the

Default.

• Associated Map associat map t

Sever lay : Thown seve and/or its chilseverities?

• Date Range : The date range.

• Validity String : The validity string.

• Synonym Tag : The current synonym tag.

61

Diagram

2.3.4.1 ID AThe <Id> attribute represents the unique identifier of the map item.

ttribute

Diagram

Required yes

Type String

Default No Default

Source <Id>item1</Id>

2.3.4.2 Mae

his attribute is used when the map item is defined in the topology file (along with its associated TeMIP entity). It is not used in the map file context.

p Name Attribute (TNDL Specific Attribute) The <Map_Name> attribute represents the name of the map in which thmap item is displayed.

T

62

Diagram

Type String

Default No Default

Source <Map_Name>map1</Map_Name>

<Map_Item> <Map_Name>map1</Map_Name> </Map_Item> <Map_Item> <Map_Name>map map1</Map_Name> </Map_Item> <Map_Item> <Map_Name> TeMIP .temip.local_temip Hierarchy_Services Map map1 </Map_Name> </Map_Item>

2.3.4.3 Graphical

that must be applied to th

Profile Attribute (TNDL Specific Attribute) The <Graphical_Profile/> attribute represents the graphical profile

e map item by the TNDL during the expansion process; see Section 2.4.

Diagram

Type String

Default No Default

<Map_Item> <Graphical_Profile>profile1</Graphical_Profile> </Map_Item> <Map_Item> <Graphical_Profile>box box1</Graphical_Profile> </Map_Item> <Map_Item> <Graphical_Profile>BOX CARD</Graphical_Profile> </Map_Item>

63

2.3.4.4 Associated Entity Attribute The <Associated_Entity> attribute represents the TeMIP entity

xists (it must be used in the map file

Diagram

associated to the map item if it econtext, not in the topology file context).

Type String

Default No Default

Source <Associated_Entity>BOX box1</Associated_Entity>

2.3.4.5 Associated Map Attribute The <Associated_Map> attribute represents the identifier of the map associated to the xists.

Associated Map

The <Associated_ ute represents the type of the associated map. T e a Shortcut, a Submap, Transient or Default.

A map is a repres the network topology, defined using the entity model. A m s a particular portion of a managed network and occupies a sp in the overall hierarchy. A map normally consists of map it present your network elements and a backdrop that cou example, the map of a given country or the map of a building.

A map can be a T , Sub Map, Transient Map or Default Map. A map can contain other maps or Shortcuts to other maps and the behavior of map items in a linked to alarm notification in the Real-Time Alarm Han f an operator double clicks on a map item in a map, the map h evealed as follows:

• p it ted with a sub map, the sub map is loaded. The map item

• If the map item is associated with a transient map, the transient map n reflect only its own and child severity

ed in a new map window. Map items corresponding with a Shortcut cannot reflect severity changes of map

e associated map.

• If the map item has no associated map and no Shortcut and the map item represents a TeMIP entity, the default map is loaded, erwise a

ge is dis its own and child ty chang

map item if it e

Type Attribute

Map_Type> attribhe type can b

entation ofap representecific place ems that reld be for

op Map

map can bedling View. Iierarchy is r

If the ma em is associa can reflect its own, child and sub map severity changes.

is loaded. The map item cachanges.

• If the map item is a Shortcut to a map in the current hierarchy, the map is loaded. If the map item is a Shortcut to a map in another hierarchy, the map is load

items in th

othmessaseveri

played. The map item can reflect es.

64

Associated Hierarchy Attribute

In , the ssociated Hierarchy attribute (the Top Map H uld be stated additionally to the Associated Map.

a Shortcutierarchy) co

A

Diagram

Type String

Default No Default

Attributes Name

Type

Use

t

MapType

Transient,

t,

Required

Default

ated_Hierarchy

Defaul

Associated_

Enum (Submap,

Defaul

Shortcut)

Associ

String

Required

No Default

Source pe=”Shortcut”

Associated_Hierarchy=”map1”>map2</Associated_Ma

<Associated_Map Associated_MapTy

p>

2.3.4.6 Sehe <Severity_Display> attribute represents the severity status that the

m lects: its own severities and/or child objects severities and/or sub map severities?

verity Display Attribute T

ap item ref

Diagram

Type Enum (Own, Child, Submap)

Default Own

Source <Severity_Display> <Severity Type=”Own”/> <Severity Type=”Child”/> <Severity Type=”Submap”/> </Severity_Display>

65

2.3.4.7 Parent Propagation Attribute agation mechanism.

Diagram

The <Parent_Propagation> attribute sets the prop

Type Boolean

Default True

Source <Parent_Propagation>True</Parent_Propagation>

2.3.4.8 SynT ym tag of the map item.

onym Tag Attribute7 he sets the <Synonym_Tag> current synon

Diagram

Type String

Default No Default

Source ym_Tag>tag1</Synonym_Tag> <Synon

2.3.4.9 Dat ttribute8 T e> attribute sets the date range validity of the map item.

e Range Ahe <Date_Rang

Diagram

Type Date

Default No Default

Format YYYY-MM-DD-HH:MM:SS

Source <Date_Range> <Begin_Date>10:00:00</Begin_Date> <End_Date>12:00:00</End_Date> </Date_Range>

2.3.4.10 Va attribute sets the validity string of the map item.

lidity String Attribute9 The <Validity_String>

Diagram

Type String

Default No Default

Source <Validity_String>sample1</Validity_String>

7 Not used by T8 Not used by T9 Not used by TeMIP Client

eMIP Client eMIP Client

66

2.3.4.11 Fue

tion will be illustrated in the next

ll Map Item Example The following example represents a map item, th<Graphical_Representation> secsections.

<Map_Item> <Id>item1</Id> <Graphical_Profile>profile1</Graphical_Profile> <Associated_Entity>BOX box1</Associated_Entity> <Associated_Map Associated_MapType="Shortcut">control_box</Associated_Map> <Severity_Display> y Type=”Own”/> <Severit Type=”Child”/> <Severity </Severity_Display> <Parent_Propagation>True</Parent_Propagation> <Synonym_Tag>tag1</Synonym_Tag> <Date_Range> <Begin_Date>10:00:00</Begin_Date> <End_Date>12:00:00</End_Date> </Date_Range> <Validity_String>sample1</Validity_String> <Graphical_Representation> … </Graphical_Representation> </Map_Item>

Interaction of Map Membership with TeMIP PMs

You should not try to remove or modify a map item placed by the TNDL using the Iconic Map/Client PM. As the TNDL applies only differences

ts own reference, the input files characteristics will not be restored hen the TNDL next updates the map. In order to restore these

characteristics, you must change them in the TNDL input files.

In order to redisplay a removed map item, you must change one of its characteristics in the input files (or you can remove it in a TNDL run and recreate it in the next run).

When you modify the position of a map item placed by the TNDL using the Iconic Map/Client PM. The new position will take precedence over the old position computed by the TNDL. In order to make the position computed by the TNDL effective, you must change the position of the map item in the input files.

NDL may contain map items that are not handled

map has a graphic positioning efinition, the TNDL will keep the current map items and their positions. the map has a grid positioning definition, the TNDL will keep the

cu ge their positions according to the map or .

2.3.5 Graphical Representation The Graphical Re tation of the Map Item is defined using the following list of T es:

with iw

Maps managed by the Tby the TNDL. Using the Iconic Map/Client PM, you can add, remove, or change map items in the map. If thedIf

rrent map items, but will chandering policy

presenNDL attribut

67

• Center Coordinates: Coordinates of the item center.

It contains the following list of HDS attributes:

• Name : Nam m.

• Layer : The n which the item is present.

• Matched Filt : The filters that this item matches.

• Associated U e URL Associated with this item.

• Url Properti perties of the Url associated to this item.

• Url Position he position of the URL on the Map.

• : Th the item.

• Graphical TyConnector).

Diagram

e of the ite

Layer o

ers

RL : Th

es : The pro

: T

Sticker e sticker associated with

pe : The type of the item (Node or Extended or

2.3.5.1 Center Coordina ute (TNDL Specific) The <Center_Coordinates> attribute defines the coordinates of the map item on a map.

The coordinates c graphical mode, in (standard) geographical mode or in Lamb aphical) mode. The <Positioning_Type> of the <Map_Header> must be set to “Graphic”; see Section 2.3.1.2.

The <Center_Coordinates> may be omitted. This is the case when you want to apply gri ning on the map, or you want to use the geographical coor in that map; see Section 4.8.

tes Attrib

an be set inert (geogr

d positiodinates of the entity to place it

68

Diagram

Graphical Coord

The <Graphical_C dinates> attribute defines the graphical coordinates of the map item cent the map.

Diagram

inates

oorer on

Attributes e

Float

Required

0

Nam

Type

Use

Default

X

Float

Required

0

Y

Source oordinates> al_Coordinates X=”367” Y=”1030” />

rdinates>

<Center_C <Graphic</Center_Coo

G al Co t Coordinates

The <Geographic defines the universal tes of the entity within the chosen system. TNDL

s: Lambert and geographic system

he attribute value is used when computing the graphical coordinates of a map whose backdrop is defined geographically. The

associated backdrop must be defined with the same geographic system.

If aphica e already present in an MSL attribute fo y clas efer to reference that attribute as the co “hold e attribute set

eographic ordinates/Lamber

al_Coordinates> attributegeographical coordinasupports two system(Latitude/Longitude).

Tthe entity in

the geogr l coordinates arr the entitordinates

s, you may prer” through th <Coordinates_Attribute>

in the profile file; see Section 2.4.3.

69

Diagram

Attributes Name

Type

Use

Latitude

ing

None

([0-90] - [0-59] - [0-59] [N | S])

Longitude

- [0-59] [E | W])

Default

Format

Str

Required

String

Required

None

([0-180] - [0-59]

Source <Geographical_Coordinates Latitude=”42-30-12NLongitude=”2-10-50W” />

<Center_Coordinates> ”

</Center_Coordinates>

Diagram

Attributes Name

one

Y

Float

Required

Type

Use

Default

Format

X

Float

Required

N

None

Source <Center_Coordinates> 5678” Y=”546” /> <Lambert_Coordinates X=”


70

Automatic Coordinates

he <Automatic> coordinates section indicates that the TNDL must determine the center of the map item using the grid algorithm; see Section 4

T

.8.2.6.

Diagram

Type Element

Default No Default

Source <Automatic/><Center_Coordinates>


2.3.5.2 Name Attribute > attribute indicates the display name of the map item. The <Name/

Diagram

Type String

Default No Default

The name specified in this section supersedes the default name displayed ient PM and synonyms. by the Iconic Map/Cl

Note

Whes

n the director as a whole or the Iconic Map/Client in particular is in ynonym mode, then the Iconic Map/Client PM ignores names and uses

synonyms for display purposes instead.

< l_RepGraphica resentation> <Name>Test BTS</Name> </Graphical_Representation>

2.3.5.3 La<Layer> s the layer that contains the map item.

yer Attribute attribute indicateThe

Diagram

Type Integer

Default No Default

Source <Layer>1</Layer>

2.3.5.4 Matched Filters Attribute The <Matched_Filters> attribute indicates the filters matched by the map item.

71

Filters can be defined for a map, and objects can be assomore of these fi

ciated with one or lters.

Diagram

Type Integer32

Default No Default

Source <Matched_Filters> <Identifier>1</Identifier> <Identifier>2</Identifier> <Identifier>3</Identifier> </Matched_Filters>

2.3.5.5 Associated Url AThe <Associated_URL> attribute indicates the URL that is associated with the map item.

Diagram

ttribute

Type String

Default N ult o Defa

The TNDL does n RL syntax.

Full Specification

ot validate the U

<Graphical_Representation> <Associated_URL>http://www.compaq.fr</Associated_URL> </Graphical_Representation>

Pa when the URL Prefix has been D ur TeMIP Reso rce File

rtial Specification efined in yo u

<Graphical_Representation> <Associated_URL>/temip/info.html</Associated_URL> </Graphical_Representation>

Null Value

<Graphical_Representation> <Associated_URL></Associated_URL> </Graphical_Representation>

72

2.3.5.6 Sticker Attribute10

The <Sticker> a indicates the sticker that is associated with the map item.

Diagram

ttribute

Type String

Default lt No Defau

Source ticker1</Sticker> <Sticker>s

2.3.5.7 URL Properties Attribute11 The <Url_Proper e defines the properties of the URL associated with th .

Diagram

ties> attribute map item

Font Color Attribute (Currently not used by the TeMIP Client V5.0)

The <Font_Color> attribute sets the font color of the URL.

Diagram

Attributes Name

Type

Use

Default

Red

Integer (0..255)

Required

0

Green

Integer (0..255)

Required


73

0

Required

0

Blue

Integer (0..255)

Default No Default

Font Size Attribu

Th ize> the font size of the URL.

te

e <Font_S attribute sets

Diagram

Type Float

Default 12

Font Modifier Att

e sets the list of modifier to apply to the

ribute12

The <Font_Modifier> attributURL.

Diagram

Att ib tes Name r u

quired

False

Boolean

Type

Use

Default

Italic

Boolean

Required

False

Bold

Boolean

Re

Required

False


74

Font Name Attrib

The <Font_Name> ts the font name of the URL.

Diagram

ute13

attribute se

Type String

Default No Default

Te ble At

Th Is_Vi URL is visible.

xt Is Vis

e <Text_

i tribute

sible> attribute indicates if the

Diagram

Type Enum (Default_Visibility, Visible, Not_Visible)

Default Default_Visibility

Full Url_Properties Example

<Graphical_Representation> <Url_Properties> <Font_Color> <Color Red="120" Green="100" Blue="110"/> </Font_Color> _Siz >10</Font_Size> <Font e <Font_Modifier Italic="True" Bold="False" Underlined="True"/> <Font_Name>Courier New</Font_Name> <Text_Is_Visible>Default_Visibility</Text_Is_Visible> </Url_Properties> <Graphical_Type> … </Graphical_Type> </Graphical_Representation>

2.3.5.8 URTh sition> attribute defines the position of the URL associated

L Position Attribute14 e <Url_Po

with the map item.

Diagram

Attributes Name

Type

Use


75

Default

X

Float

Required

0

Y

Float

Required

0

Default No Default

Source <Url_Position> <Point X="100" Y="110"/> </Url_Position>

2.3.6 GraphTh hical ty a Map Item is the type of graphic that is used to repr t the map item on the screen.

Th lab ic types is grouped into three categories:

• Node (represe an icon).

• Connector (gra links between Map Items).

• Extended (box e, polyline, spline, text).

If the graphical t s not specified, the map item is represented as a </Node>.

Diagram

ical Type e grap

esenpe of

e list of avai le graph

nted by

phical

, circle, lin

ype i

2.3.6.1 NodA Node is a map resented by an icon.

tes are:

e graphical representation of the node.

• he scale percentage X and Y to apply on the associated

• ng le of rotation applied on the associated symbol.

• Connection P points of the symbol that should be preferred for c n.

• Zoomable : Indicates if the associated symbol is zoomable.

All attributes are

e item that is rep

The Node attribu

• Position : The position of the node in the map.

• Associated Symbol : The “File” that will contain th

Scale : Tsymbol.

Rotation A le : Ang

oints : Theonnectio

optional.

76

See the following esponding grammar.

Diagram

corr

Position Attribute

ons

Diagram

The <Position> attribute represents the center of the Node; see Secti4.8 and 4.8.2.1 for more information.

Type Point

Attributes Name

Type

Use

Default

X

Float

Required

0

Y

quired

Float

Re

0

Source <Position> <Point X=”10” Y=”10” /> </Position>

Scale Attribute

The <Scale> attribute represents the scale percentage to be applied on the symbol associated to the Node (for axis X and Y).

Diagram

Attributes Name

77

Type

Default

X

Float

ed

Use

Requir

1.0

Y

Float

Required

1.0

Source <Scale X="2.0" Y="3.2"/>

Rotation Angle Attribute15

The <Rotation_Angle> attribute represents the rotation angle to be applied on the symbol associated to the Node. It will be defined as a trigonometric angle (so counterclockwise). The rotation center will be the

center of the Node.

90

0 / 36180 0

270

Diagram

Type Integer (0..360)

Default 0

Source <Rotation_Angle>180</Rotation_Angle>

15 Not used by Te Client MIP

78

Associated Symbol Attribute

Diagram

Type String

Default N ult o Defa

The “Associated S ” name we export to the Hierarchy Server is a logical name. The do not include any information about the format used.

For example, the d name can be “snmp_1”.

The TeMIP Clien any prefix and suffix. For example, “UNIX_like_” for nd “.m1” for the suffix and then, the Map NT should use the co ponding file:

“Unix_like_snmp_1.m1” without storing this name in the Hierarchy Server.

The Map Viewer NT will use M1 files that are specific to the graphical toolkit se M1 files described the symbols and their behavior.

Fo displ , specify the icon file name as a relative path nam . The f the TeMIP default directory for ic MIP_M :\TeMIP Res\MapViews b

If all entities of a g h the same icon, you may mmon graphical representation through the

n 2.4.4. You no longer need to specify the <Node> on

.

Node mbol

ymbolse names

exporte

t should addthe prefix arres

on Windowswe use. The

r entities ayed as nodese

ons (%TEile will be searched for in

AP_RESOURCES%/MapViews, Cy default).

iven class are displayed witprefer to specify their coProfile file; see sectioattribute in the topology file, unless the entity does not follow the commclass-level graphic representation

with a Specified Sy

< l_TypGraphica e> <Node> <Associated_Symbol>reference_books_icon</Associated_Symbol> </Node> </Graphical_Type>

N ymbol

ode with a Default S

<Graphical_Type> <Node> <Associated_Symbol></Associated_Symbol> </Node> </Graphical_Type>

79

C

T nnector end can be attached).

onnection Points Attribute

he list of connection points (where a co

Diagram

Type Point

Attributes Name

Type

Use

ul

X

quir

0

Defa t

Float

Required

0

Y

Float

Re ed

Default No Default

Source <Connection_Points> X="30" Y="40"/> X="40" Y="50"/>

<Point <Point </Connection_Points>

Zoomable Attribute

Tvi

he <Zoomable> attribute defines if this symbol will zoom in the map ewer with the backdrop or not.

Diagram

Type Boolean

Default True

Source <Zoomable>true</Zoomable>

Full Node Example

< cal_TypGraphi e> <Node> on <Positi > <Point Y="30"/> X="12" </Position> <Scale X="2.0" Y="3.2"/> <Rotation_Angle>30</Rotation_Angle> <Associated_Symbol>france</Associated_Symbol>

80

<Connection_Points> <Point 30" Y="40"/> X=" <Point Y="50"/> X="40" </Connection_Points> <Zoomable>True</Zoomable> </Node> </Graphical_Type>

2.3.6.2 Connector The Connector at :

• Connector Ends : The items or points that define the ends of ector

• Connector Lines : Sequence of parallel lines that is used to

Connector Path : The path by which the connector should go

• ector St : The connector Style {Plain, Dots, Dashes, _Space_Dash, Long Dash-Dash, Long Dashes}.

• or E e style of the connector ends {none, arrow,

Start Symbol : The start symbol of the connector.

• mbol : The middle symbol of the connector.

• End Symbol : The end symbol of the connector.

tributes are

the conn .

display the connector.

•through.

ConnDash

yle

Connect nd Style : Thcircle, square}.

•

Middle Sy

Diagram

Connector Ends Attribu e

The <Connector_Ends> attribute defines the two ends of the connector d can be a p

t

map item. A connector en oint or an object ide ed by an iand a connection id; see Sections 4.8 and 4.8.2.4 for more information

ntifi d .

81

Diagram

End Point Attribute

Diagram

Type Point

Attributes

Name

Type

Use

Default

X

Float

Required

0

Y

Float

Required

0

Default No Default

End Object ID At

Diagram

tribute

Type String

Default No Default

O ttribute

bject Connection ID a

Diagram

Type integer

Default 0

82

Fu or Ends Example

ll Connect

< ndConnector_E s> <Connector_End> <End_Point> <Point " Y="40"/> X="30 </End_Point> </Connector_End> <Connector_End> <End_ObjectID>box box1</End_ObjectID> </Connector_End> </Connector_Ends>

Connector Lines Attribute

The <Connector_Lines> attribute describes the sequence of parallel lines used to display th ctor.

A line is describe _Desc> that contains a <Color> and a <Line_Width>.

e conne

d by a <Line

Diagram

Diagram

Diagram

Type Float

Default 1.0

Diagram

Attributes Name

Type

Use

efault

0

Integer (0..255)

D

Red

Integer (0..255)

Required

Green

83

Required

0

blue

er (0..255)

0

Integ

Required

Default (0,0,0)

Full Connector Lines Example

<Connector_Lines> <Line_Desc> <Line_Width>1.2</Line_Width> <Color Red="100" Green="110" Blue="90"/> </Line_Desc> </Connector_Lines>

Connector Path Attribute

Path> attribute defines the path of the Connector map em. A path is a list of point.

m

The <Connector_it

Diagra

Type Point

Attributes Name

Type

Use

Float

Required

0

Y

Required

Default

X

Float

0

Default No Default

Source <Connector_Path>

<Point X="50" Y="50"> </Connector_Path>

<Point X="40" Y="40">

84

Connector Style Attribute

<Connector_Style> attribute defines the style of the Connector lines.

Diagram

The

Type Enum (Plain, Dots, Dashes, Dash_Space_Dash, Long_Dash_Dash, Long_Dashes)

Default Plain

Source <Connector_Style>Plain</Connector_Style>

Connector Ends Style Attribute

The <Connector_Ends_Style> attribute defines the style of the connector end points.

Diagram

Type Enum (None, Arrow, Circles, Squares)

Default None

Source <Connector_Ends_Style>Circles</Connector_Ends_Style>

Note

“None” is the only value used by the TeMIP Client V5.0.

Start/Middle/End Symbol Attributes16

The <Start_Symbol> attribute defines the start symbol of the Connector map item.

The <Middle_Symbol> attribute defines the middle symbol of the Connector map item.

The <End_Symbol> attribute defines the middle symbol of the Connector map item.

A symbol contains a name and position behavior.


85

Diagram

Name Attribute

Diagram

Type String

Default No Default

Symbol Position Behavior Attribute

Diagram

Type Enum (Perpendicular, Parallel)

Default Parallel

<Connector> <Start_Symbol> <Name>start</Name> <Symbol_Position_Behaviour>parallel</Symbol_Position_Behaviour> </Start_Symbol> <Middle_Symbol> <Name>middle</Name> <Symbol_Position_Behaviour>parallel</Symbol_Position_Behaviour> </Middle_Symbol> <End_Symbol> <Name>end</Name> <Symbol_Position_Behaviour>parallel</Symbol_Position_Behaviour> </End_Symbol> </Connector>

86

Full Connector Example

<Graphical_Type> <Connector> <Connector_Ends> <Connector_End> <End_Point> Y="40"/> <Point X="30" </End_Point> </Connector_End> <Connector_End> <End_ObjectID>item1</End_ObjectID> </Connector_End> </Connector_Ends> <Connector_Lines> <Line_Desc> <Line_Width>1.2</Line_Width> <Color Red="100" ="110" Blue="90"/> Green </Line_Desc> </Connector_Lines> <Connector_Path> <Point X="40" Y="40"/> <Point X="50" Y="50"/> </Connector_Path> <Connector_Style>Plain</Connector_Style> <Connector_Ends_Style>Circles</Connector_Ends_Style> <Start_Symbol> <Name>start</Name> <Symbol_Position_Behaviour> Parallel </Symbol_Position_Behaviour> </Start_Symbol> <Middle_Symbol> <Name>middle</Name> <Symbol_Position_Behaviour> Parallel </Symbol_Position_Behaviour> </Middle_Symbol> <End_Symbol> <Name>end</Name> <Symbol_Position_Behaviour> Parallel </Symb ion_Bol_Posit ehaviour> </End_Symbol> </Connector> </Graphical_Type>

2.3.6.3 Extended ed attribute is:

nd of Extended Map Item:

.

The Extend

• Color.

There are two ki

• Lined Item

• Text Item.

87

Diagram

Source <Extended> <Color … /> <Extended_Type>…</Extended_Type></Extended>

Co

tem.

Diagram

lor Attribute

The <Color> attribute sets the color of the extended map i

Attributes Name

Type

Use

Default

Red

Integer (0..255)

Required

0

Green

Integer (0..255)

Required

0

Blue

Integer (0..255)

Required

0

Default (0,0,0)

Source <Color Red="100" Green="110" Blue="90"/>

2.3.6.4 Lined Item Here, a Lined Item can be:

• A Line.

• A Box.

• A Spline.

88

• A Polyline.

• A Circle.

butes are:

_Space_Dash, Long Dash-Dash, Long Dashes}.

• ine : The status that indicates if it is a double line.

• idth

• s e of points that defined the figure.

• art Po t point defined {None, le}.

tyle : The Style of the last point.

Fill Style : The Fill Style {Opaque, Transparent}.

• tyle : The Pattern Style {Plain, Dots, Dashes, Dash_Space_Dash, Long Dash-Dash, Long Dashes}.

• olor Ba

• Fill Color Fo .

The Lined Item attri

• Line Style : The Line Style {Plain, Dots, Dashes, Dash

Double L

Line W : The Line width.

End Point : The sequenc

Line StArrow, Circ

int Style : The Style of the firs

• Line End Point S

• Closed figure : If the figure is closed.

•

Pattern S

Fill C ckground : The Fill Color Background.

reground: The Fill Color Foreground

Diagram

89

Line Type Attribute

The <Line_Type> attribute defines the type of lined item.

Diagram

Type (Circle, Box, Spline, Line, Polyline) Enum

Required Mandatory

Source e>Box</Line_Type> <Line_Typ

Line Style Attribu

The <Line_Style defines the line style of the lined item.

Diagram

te

> attribute

Type in, Dots, Dashes, Dash_Space_Dash, h_Dash, Long_Dashes)

Enum (PlaDasLong_

Default Plain

Source <Line_Style>Dots</Line_Style>

Double Line Attribute

The <Double_Line> attribute indicates if the lined item must be represented with a double line.

Diagram

Type Boolean

Default False

Source <Double_Line>True</Double_Line>

Line Width Attrib

he <Line_Width> attribute defines the line width of the lined item.

Diagram

ute

T

Type Float

Default 1.0

Source <Line_Width>1</Line_Width>

90

End Points Attribute

The <End_Points> attribute defines the list of points that delimit the e information.

Diagram

lined item; see Section 4.8.2.3 for mor

Attributes

Default

Required

Name

Type

Use

X

Float

0

Y

Float

Required

0

Default No Default

Source <End_Points>

<Point X="120" Y="150"/>

<Point X="130" Y="160"/>

</End_Points>

Line Start/End Point Style Attribute

Th e_Start

attributes define item.

e <Lin _Point_Style> and <Line_Start_Point_Style>

the style of the end points of the lined

Diagram

Type Enum (None, Arrow, Circle)

Default None

Source <Line_Start_Point_Style>Arrow</Line_Start_P

<Line_End_Point_Style>Circle</Line_End_Poin

oint_Style>

t_Style>

91

Closed Figure Attribute

Th _Figure> attribute defines if the lined item is closed.

e <Closed

Diagram

Type n Boolea

Default False

Source gure>True</Closed_Figure> <Closed_Fi

Fill Style Attribut

The <Fill_Style defines the style used to fill the lined item.

Diagram

e

> attribute

Type sparent) Enum (Opaque, Tran

Default Tran sparent

Source l_Style>Opaque</Fill_Style> <Fil

Pattern Style Attr

The <Pattern_St ute defines the pattern style used to fill the lined item.

ibute

yle> attrib

Diagram

Type sh_Space_Dash, Enum (Plain, Dots, Dashes, DaLong_Dash_Dash, Long_Dashes)

Default Plain

Source <Pattern_Style>Dots</Pattern_Style>

Fill Color Background/Foreground Attributes

The <Fill_Color_Background> and <Fill_Color_Foreground> attributes defines the color of the foreground and the background of the lined item.

Note

T ound is not supported by TeMIP Client.

he Fill Color Backgr

92

Diagram

Name

Default

Red

ger (0..255)

Blue

Attributes

Type

Use

Inte

Required

0

Green

Integer (0..255)

Required

0

Integer (0..255)

Required

0

Default (0,0,0)

Source <Fill_Color_Background> <Color Red="0" Green="0" Blue="255"/> /Fill_Color_Background> <Fill_Color_Foreground> <Color Red="100" Green="110" Blue="90"/>

ll_Color_Foreground>

<

</Fi

B

T th, line color and fill c ed.

A es the lower left c per right corner of the box.

ox Example

he following example defines a box with the line widolor. The default line width and line color are assum

box is defined by two end points. The first one definorner of the box; the second one defines the up

<Graphical_Type> <Extended> <Color Red="100" Green="110" Blue="90"/> <Extended_Type> <Lined_Item> <Line_Type>Box</Line_Type> <Line_Width>1</Line_Width> <End_Points> <Point X="120" Y="150"/> <Point X="130" Y="160"/>

93

</End_Points> <Fill_Color_Background> <Color Red="100" Green="110" Blue="90"/> </Fill_Color_Background> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type>

ith the line width, line color and fill lt line width and line color are assumed.

by two end points.

Line Example

The following example defines a line wcolor. The defau

A line is defined

<Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Line</Line_Type> <Line_Style>Plain</Line_Style> <Double_Line>True</Double_Line> <Line_Width>1</Line_Width> <End_Points> <Point X="30" Y="40"/> <Point X="40" Y="50"/> </End_Points> <Line_Start_Point_Style>None</Line_Start_Point_Style> <Line_End_Point_Style>Arrow</Line_End_Point_Style> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type>

P

olyline Example

<Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Polyline</Line_Type> <Line_Style>Plain</Line_Style> <Double_Line>True</Double_Line> <Line_Width>1</Line_Width> <End_Points> <Point X="30" Y="40"/> <Point X="40" Y="50"/> <Point X="50" Y="60"/> </End_Points> <Line_Start_Point_Style>None</Line_Start_Point_Style> <Closed_Figure>True</Closed_Figure> <Fill_Style>Transparent</Fill_Style> <Pattern_Style>Dots</Pattern_Style> <Fill_Color_Background> <Color Red="100" Green="110" Blue="90"/>

94

</Fill_Color_Background> <Fill_Color_Foreground> <Color Red="100" Green="110" Blue="90"/> </Fill_Color_Foreground> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type>

Note

A Polyline with the <Double_Line> attribute sets to true cannot be displayed in the TeMIP Client V5.0.

Circle Example

<Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Circle</Line_Type> <Line_Style>Plain</Line_Style> <Line_Width>1</Line_Width> <End_Points> <Point X="30" Y="40"/> <Point X="40" Y="50"/> </End_Points> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type>

Spline Example

<Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Spline</Line_Type> <Line_Style>Plain</Line_Style> <Double_Line>True</Double_Line> <Line_Width>1</Line_Width> <End_Points> <Point X="30" Y="40"/> <Point X="40" Y="50"/> </End_Points> <Closed_Figure>True</Closed_Figure> <Fill_Style>Transparent</Fill_Style> <Pattern_Style>dots</Pattern_Style> <Fill_Color_Background> <Color Red="100" Green="110" Blue="90"/> </Fill_Color_Background> <Fill_Color_Foreground> <Color Red="100" Green="110" Blue="90"/> </Fill_Color_Foreground> </Lined_Item> </Extended_Type>

95

</Extended> </Graphical_Type>

2.3.6.5 Te

Text Position : The position of the Text Item.

• he text associated to the Text Item.

• Text Is Visible : The visibility status of the Text Item.

• Name : t name of the text.

• : T ize of the text.

• Font Modifie font modifiers of the text (Italic ,Bold or Underlined

xt Item The Text Item attributes are:

•

Text : T

Font The fon

Font Size he font s

r : The ).

Diagram

96

Text Position Attribute

The <Text_Position> attribute defines the position of the text item; see ections 4.8 and 4.8.2.2 for more information.

Diagram

S

Type Point

Attributes

X

loat

Float

Name

Type

Use

Default

F

Required

0

Y

Required

0

Default No Default

Source <Text_Position> <Point X="20" Y="20"/>

_Position> </Text

Text Attribute

Th attr in the text item.

Diagram

e <Text> ibute defines the text displayed

Type String

Default No Default

Source <Text>Text</Text>

97

Text Is Visible Attribute

The <Text_Is_Visible> attribute defines if the text item is visible.

Diagram

Type Enum (Default_Visibility, Visible, Not_Visible)

Default Default_Visibility

Source Is_Visible>Default_Visibility</Text_Is_Vis<Text_ible>

Font Name Attrib

The <Font_Name> defines the font name of the text item.

Diagram

ute

attribute

Type String

Default Arial

Source >Courier New</Font_Name> <Font_Name

Font Size Attribu

The <Font_Size> fines the font size of the text item.

Diagram

te

attribute de

Type Float

Default 12

Source >10</Font_Size> <Font_Size

98

Font Modifier Attribute

The <Font_Modifier> attribute defines the font modifiers of the text item.

Diagram

Attributes Name

Type

Use

Default

lse

False

rlined

Italic

Boolean

Required

Fa

Bold

Boolean

Required

Unde

Boolean

Required

False

Source <Font_Modifier Italic="True" Bold="False" Underlined="True"/>

2.3.7 Full Text Item Example <Extended_Type> <Text_Item> <Text_Position> <Point X="20" Y="20"/> </Text_Position> <Text>Text</Text> <Text_Is_Visible>True</Text_Is_Visible> <Font_Name>Courier New</Font_Name> <Font_Size>10</Font_Size> <Font_Modifier Italic="True" Bold="False" Underlined="True"/> </Text_Item> </Extended_Type>

99

2.4 Profile File f profile. It is optional. A profile contains

mplete the graphical representation of the map ir geographical positioning.

Note

The profile file contains a list oinformation used to coitems and to resolve the

Child elements in the profile file must be strictly ordered.

l description of the profile file syntax. Refer to Appendix D for a ful

Diagram

Source ile>…</Profile>

>

<Profiles> <Profile>…</Profile> <Prof</Profiles

Naming Convention

le

). The time stamp should follow the


se name is the same as the profile file, except for the

not process the data file. This synchronization file must also e located in the input directory under the TNDL_WORKSPACE path (for xample profile_20020320123410.xmlok).

The profile file must be named: profile_<timestamp>.xml, and created inthe input directory under the TNDL_WORKSPACE directory (for examp/var/opt/temip//TNDL/inputformat: yyyymmddhhmmss (for example profile_20020320123410.xml) and is optional.

An empty file, whoextension (.xmlok), notifies the TNDL that the profile file is available for processing. If the profile file exists, but not its synchronization file, the TNDL does be

100

2.4.1 Profile Overview A profile must contain:

• A Profile Name.

It may contain:

• A Coordinates Attribute.

• A Graphical Representation.

Diagram

Source <Profile> <Name>profile</Name> <Coordinates_Attribute>…</Coordinates_Attribute> <Graphical_Representation>…</Graphical_Representation> </Profile>

2.4.2 ProfTa c map item.

Eoi

2.4.2.1 FreThe profile name could be a free form name. It indicates that this profile w o map items that contain a graphical profile that match

ile Name his is the profile name. It is used to determine when a profile must be pplied to a specifi

ach profile name must be unique. If this rule is not observed, the TNDL nly considers the first occurrence of that profile, other occurrences are gnored.

e Form Name

ill be applied tthis value.

<Name>profile1</Name>

2.4.2.2 Entit ates that this profile will

ed entity that match this alue.

y Name It could represent a specific entity name. It indicbe applied to map items that contain an associatv

<Name>BOX box1</Name> <Name>BOX box1 CARD card1</Name>

101

2pecify the full class

at this ill be applied to map items that contain an associated entity

lass matches this value.

.4.2.3 Class Name It could represent the class of an entity. You must shierarchy from the global class to the local one. It indicates thprofile wwhose c

<Name>BOX</Name> <Name>BOX CARD</Name>

2.4.2.4 How Associate a Profile and a Map Item ofile and a map item is the following

ile which name corresponds to the value of the

ofile which name corresponds to the class of the <Associated_Entity> of a map item (See the following example to

ofiles have been defined in the profile file below:

e “profile1” profile will match the map items whose Graphical_Profile> field is set to “profile1”.

card card1” profile will match the map items whose <Associated_Entity> field is set to “box box1 card card1”.

ociated_Entity>

card” (box box1 card card2 for example).

to The algorithm used to associate a prone: a prof<Graphical_Profile> of a map item takes precedence over a profile which

orresponds to the <Associated_Entity> of a map item that takes name cprecedence over a pr

illustrate this mechanism).

Three pr

• Th<

• The “box box1

• The “box card” profile will match the map items whose field is set to an entity that correspond to the <Ass

class “box

<Profiles> <Profile> <Name>profile1</Name> <Graphical_Representation>…</Graphical_Representation> </Profile> <Profile> <Name>box box1 card card1</Name> <Graphical_Representation>…</Graphical_Representation> </Profile> <Profile> <Name>box card</Name> <Graphical_Representation>…</Graphical_Representation> </Profile> </Profiles>

Four map items have been defined in the Topology file above.

ccording to the rule previously defined:

• The map item “item1” will match the profile “profile1”.

• The map item “item2” will match the profile “box box1 card card1”.

ap item “item3” will match the profile “box card”.

• The map item “item4” will match no profile.

A

• The m

102

<Tndl_Element> <Entity> <Name>box box1 card card1</Name> </Entity> <Map_Items> <Default_Graphical_Representation>…</Default_Graphical_Representation> <Map_Item> <Id>item1</Id> … <Graphical_Profile>profile1</Graphical_Profile> <Graphical_Representation>…</Graphical_Representation> </Map_Item> <Map_Item> <Id>item2</Id> … <Graphical_Representation>…</Graphical_Representation> </Map_Item> </Map_Items> </Tndl_Element> <Tndl_Element> <Entity> <Name>box box1 card card2</Name> </Entity> <Map_Items> <Default_Graphical_Representation>…</Default_Graphical_Representation> <Map_Item> <Id>item3</Id> … <Graphical_Representation>…</Graphical_Representation> </Map_Item> </Map_Items> </Tndl_Element> <Tndl_Element> <Entity> <Name>box box1</Name> </Entity> <Map_Items> <Default_Graphical_Representation>…</Default_Graphical_Representation> <Map_Item> <Id>item4</Id> … <Graphical_Representation>…</Graphical_Representation> </Map_Item> </Map_Items> </Tndl_Element>

ox box1 card card1”.

h the profile “box card”.

The following example is a variant from the previous example. It represents the previous map items declared in the Map Definition file.

According to the rule previously defined:

• The map item “item1” will match the profile “profile1”.

• The map item “item2” will match the profile “b

• The map item “item3” will matc

• The map item “item4” will match no profile.

103

<Maps> <Map> <Map_Header> <Map_Name>map map1</Map_Name> … </Map_Header> <Map_Items> <Map_Item> <Id>item1</Id> … <Graphical_Profile>profile1</Graphical_Profile> <Associated_Entity>box box1 card card1</Associated_Entity> <Graphical_Representation>…</Graphical_Representation> </Map_Item> <Map_Item> <Id>item3</Id> … <Associated_Entity>box box1 card card2</Associated_Entity> <Graphical_Representation>…</Graphical_Representation> </Map_Item> <Map_Item> <Id>item4</Id> … <Associated_Entity>box box1</Associated_Entity> <Graphical_Representation>…</Graphical_Representation> </Map_Item> </Map_Items> </Map> <Map> <Map_Header> <Map_Name>map map2</Map_Name> … </Map_Header> <Map_Items> <Map_Item> <Id>item2</Id> … <Associated_Entity>box box1 card card1</Associated_Entity> <Graphical_Representation>…</Graphical_Representation> </Map_Item> </Map_Items> </Map> </Maps>

2.4.3 Coordinates Attribute This attribute is the name of the class MSL attribute defining the geographical coordinates of the entity. When computing graphical

rdinates of an entity within a map, the TNDL may need the inates; see Section 4.8.2.5. In this case it searches the

or the attribute holding the geographic ses them appropriately in the graphical coordinates

ternative way to specify an entity’s geographical he <Center_Coordinates> attribute of the map

tion takes precedence over the Profile specification.

coogeographical coordentity MSL attribute list fcoordinates, and ucomputation.

The TNDL offers an alcoordinates, through titem. The <Center_Coordinates> specificavalue of coordinates attribute found in the

104

The MSL attribute value must follow the syntax applicable to s; see Section 2.3.5.1.

2 on attribute defines the graphical representation to be used to display a

map item associated to this profile in maps. All graphical types are supported: node, connector, line, polyline, box, circle, text, and spline.

The TNDL offers alternative ways to specify the graphical representation map item, The graphical representation can be set directly in the map

lt graphical representation part of the <Map_Items>

ll determine the final graphical representation of a map llowing principle:

e merge of each field of the l Representation that is associated to a map

esentation found in the map item specification takes ult graphical representation that takes

phical representation found in the profile specification.

If a field is not set after the expansion mechanism some default value (line

2.4.5 Exaify

n created for that class: box_switch_icon.

geographical coordinate

.4.4 Graphical RepresentatiThis

of aitem or in the defausection; see Section 2.2.6.

The TNDL wiitem by applying the fo

• The expansion mechanism consists in thdifferent Graphicaitem.

• The graphic al reprprecedence over the defa

recedence over the grap

color) can be found in the configuration file.

mple Profile Definition Records This example illustrates the use of an MSL attribute (Location) to specgeographical coordinates for entities of the BOX class. A dedicated iconhas bee

<Profile> <Name>BOX</Name> <Coordinates_Attribute>Location</Coordinates_Attribute> <Graphical_Representation> <Graphical_Type> <Node> <Associated_Symbol>box_switch_icon</Associated_Symbol> </Node> </Graphical_Type> </Graphical_Representation> </Profile>

This example illustrates the default graphic representation for all entities of efined

and

cords below are equivalent:

of the CIRCUIT class. They must be displayed as blue single lineswidth 10. The default color and width for line entities have been din the configuration file: <Color Red="0" Green="0" Blue="255"/>10 respectively.

The two re

<Profiles> <Profile>

105

<Name>CIRCUIT</Name> <Graphical_Representation> <Graphical_Type> <Extended> <Color Red="0" Green="0" Blue="255"/> <Extended_Type> <Lined_Item> <Line_Type>line</Line_Type> <Line_Width>10</Line_Width> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Profile>

</Profiles> <Profiles> <Profile> <Name>CIRCUIT</Name> <Graphical_Representation> <Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>line</Line_Type> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Profile> </Profiles>

ond d, the ion computation n file.

he follow ys to specify a default onic representation for all entities of the BSC BTS class. The class

de bts has been created in the default TeMIP directory for icons.

In the sec graphical representat rules automatically use the default line width specified in the configuratio

ing example illustrates the different wa

recor

Tic

dicated icon

<Profiles> <Profile> <Name>BSC BTS</Name> <Graphical_Representation> <Graphical_Type> <Node> <Associated_Symbol>bts</Associated_Symbol> </Node> </Graphical_Type> </Graphical_Representation> </Profile> </Profiles>

106

2.5 Delta Topology File and Delta Map File From TNDL V5.0 ible to provide a delta topology file and a delta map file.

These files use th d topology file and map file.

The only differen h <Entity>, <Scoped_Element>, <Wildcarded_Ele Header> and <Map_Item> section has to be m s insert

The TNDL V5.0 d is done by the new option “-d”: DataLoad –d.

he delta topology file and the delta map file have the same name as the standard input files:

T logy_<timestamp>.xml and map_<t y must be created in the input directory under t ectory. The time stamp should follow the f 0123410.xml a

S

T delta map synchronization f ndard synchronization files:

E e same as the delta topology and map file, e lok), notify the TNDL V5.0 of the data file ava e data file exists, but not its s does not process the data file. This s ory under the T 20020320123410.xmlok a ok).

A sent.

2.5.1 EntitT eMIP entity are specified in the <Entity> section o ment>.

The > e of the <Entity> indicates if the <

, it is poss

e same grammar as the standar

ce is that eacment>, <Map_

arked a ed, modified or deleted.

elta launch

Naming Convention

T

hey must be named topoimestamp>.xml. The

E dirhe TNDL_WORKSPACormat: yyyymmddhhmmss (for example topology_2002032nd map_20020320123410.xml).

ynchronization File

he delta topology synchronization file and theile have the same name as the sta

mpty files, whose names are thxcept for the extension (.xm

ilability for processing. If thynchronization file, the TNDL V5.0 ynchronization file must also be located in the input directNDL_WORKSPACE path (for example topology_nd map_20020320123410.xml

t least one topology file or map file must be pre

y he characteristics of a Tf a <Domain> or a <Tndl_Ele

<Entity_Operation attributEntity> must be inserted, modified or deleted.

107

Diagram

Diagram

Attributes Name

Use

Default

Enum (Insert, Modify, Delete)

No Defa

Type

Action

Required

ult

Note The <Previous_Entity> attribute is used internally by the TNDL.

The following example illustrates the insertion, the deletion and the modification of an entity (in delta mode).

<Topology_Elements> <Tndl_Elements> <Tndl_Element> <Entity> <Entity_Operation Action="Insert"/> <Name>BOX .box_test_0</Name> <Attributes> <Attribute> <Name>Location</Name> <Value>east</Value> </Attribute> </Attributes> </Entity> </Tndl_Element> <Tndl_Element> <Entity> <Entity_Operation Action="Modify"/> <Name>BOX .box_test_1</Name> <Attributes> <Attribute> <Name>Location</Name> <Value>north</Value>

108

</Attribute> </Attributes> </Entity> </Tndl_Element> <Tndl_Element> <Entity> <Entity_Operation Action="Delete"/> <Name>BOX .box_test_2</Name> </Entity> </Tndl_Element> </Tndl_Elements> </Topology_Elements>

2.5.2 Scoped/Wildcarded Element Th teristics of a group of wildcarded entities are specified in the <Wildcarded_Element> section.

Th carded_Operation> attribute of the <Wilcarded_Element> in he element must be inserted, modified or deleted.

Diagram

e charac

e <Wildicates if t

Diagram

Attributes Name

Type

Use

Default

Action


Required

No Default

Note ibute is used internally by The <Previous_Wilcarded_Element> attrthe TNDL.

T of scoped entities are specified in the < .

The <Scoped_Operation> attribute of the <Scoped_Element> indicates if e element must be inserted, modified or deleted.

he characteristics of a group Scoped_Element> section

th

109

Diagram

Diagram

Attributes Name

Type

Use

Default

Action


Required

No Default

Note The <Previous_Scoped_Element> attribute is used internally by the TNDL.

The following example illustrates the insertion of a <Wilcarded_Element> and the deletion of a <Scoped_Element> (in delta mode).

<Topology_Elements> <Tndl_Elements> <Wildcarded_Element> <Wildcarded_Operation Action="Insert"/> <Name>BOX box1 card *</Name> <Element> <Of>domain domain1</Of> </Element> </Wildcarded_Element> <Scoped_Element Type="Nth_Sub_Level" Depth="1"> <Scoped_Operation Action="Delete"/> <Name>BOX box1</Name> <Element> <Of>domain domain2</Of> </Element> </Scoped_Element> </Tndl_Elements> </Topology_Elements>

110

2.5.3 Map Header Th ion> attribute of the <Map_Header> indicates if the map must be deleted or modified.

Diagram

e <Operat inserted,

Diagram

111

Attributes Name

Action

t, Modify, Delete)

Required

No Default

Type

Use

Default

Enum (Inser

The following example illustrates the insertion, the deletion and the modification of a map.

<Maps> <Map> <Map_Header> <Operation Action="Insert"/> <Map_Name>map1</Map_Name> … </Map_Header> </Map> <Map> <Map_Header> <Operation Action="Modify"/> <Map_Name>map2</Map_Name> … </Map_Header> </Map> <Map> <Map_Header> <Operation Action="Delete"/> p_N e>map2</Map_Name> <Ma am </Map_Header> </Map> </Maps>

112

2.5.4 MapT ibute of the <Map_Item> indicates if the map item m

Item he <Operation> attrust be inserted, deleted or modified.

Diagram

Diagram

Attributes Name

Type

Use

Default

Action


Required

No Default

The following example illustrates the insertion, the deletion and the modification of a map item.

<Maps> <Map> <Map_Header> <Map_Name>map1</Map_Name> …

113

</Map_Header> <Map_Items> <Map_Item> <Operation Action="Insert"/> <Id>item0</Id> <Graphical_Representation> … </Graphical_Representation> </Map_Item> <Map_Item> <Operation Action="Modify"/> <Id>item1</Id> <Graphical_Representation> … </Graphical_Representation> </Map_Item> <Map_Item> <Operation Action="Delete"/> <Id>item2</Id> </Map_Item> </Map_Items> </Map> </Maps>

114

Chapter 3

Activating the TNDL This chapter describes how to activate the TNDL, and how to check the results of activation.

3.1 Providing Input Files You can have several versions of a topology, map or profile file in the input directory. TNDL selects the one with the newest timestamp. It also purges older versions.

These conditions are typical of a scheduled automated generation of input file(s). Several versions of an input file can thus be generated between two sessions of the TNDL.

Input files can be updated or created at any time between two TNDL sessions. They will take effect the next time the TNDL is activated, unless it is activated to recover from a previous incomplete session. In this case, the updated files will take effect when the TNDL is next activated not for recovery.

Creation or update of the configuration file takes effect the next time the TNDL is activated, whether or not it is in recovery mode (only on changed elements).

3.2 Activating the TNDL

3.2.1 Authorized User The TNDL must be activated with an authorized user. The TNDL is executed on the TeMIP Security environment; you must be root, temip or a valid TeMIP user.

3.2.2 Environment Variables The TeMIP catalog file directory (/usr/opt/temip/%L/%N) must be set in the environment variable NLSPATH and the environment variable LC_ALL set to en_US.ISO8859-1 (for HPTru64 and SUN solaris platform) or en_US.iso88591 (for HP-UX platform)

The TeMIP shared library directory (/usr/opt/temip/lib) must be set in the environment variable LD_LIBRARY_PATH.

The default value for the environment variable TNDL_WORKSPACE is /var/opt/temip/TNDL.

115

3.2.3 Command Line Enter the following command:

# /usr/opt/temip/bin/Dataload [-VRdmtnc] [-r [resourceFileName] ] [-g LogFileName] [-l LastFileName]

Options:

-V: Print the version of the TNDL.

-d: Take delta file as input file.

-m: Generate reference files from input files (no TeMIP call performed).

-t: No call to TeMIP.

-n: Disable entity creation and deletion; see Section 3.2.4.1.

-c: IP autoconfig option; see Section 3.2.4.5.

-r resourceFileName: Set map resource file location.

-R: Publish the map resource file using the “temip_publish_resource” tool.

-g LogFileName: Override the Log File Name that is by default dataload.log in TNDL_WORKSPACE directory.

-l LastFileName: Override the Last File Name that is by default dataload.last in TNDL_WORKSPACE directory.

The TNDL executable (/usr/opt/temip/bin/DataLoad) is started in foreground mode. It looks for input topology files, determines all update operations and performs them.

If the previous session of the TNDL did not complete normally (aborted or stopped), the TNDL resumes at the point where it was stopped.

3.2.4 Command Line Options Detailed Description

3.2.4.1 Option Delta As Input: -d Run the TNDL with delta file as input file (a modified item will replace its previous reference).

This option indicates that the topology and map files must be considered as delta files.

The TNDL will do appropriate actions to update the TeMIP environment. It will update its reference files.

3.2.4.2 Option Regenerate Reference: -m Regenerate new reference files according to the input files but do not perform any TeMIP update.

This option indicates that the TNDL reference must be regenerate according to information found into input files. No TeMIP call will be performed. This option will be useful on Tru64 platforms, to migrate TNDLV4.1 (or TNDLV4.0) reference files into TNDL V5.0 (after the execution of the migration tool.

116

3.2.4.3 Option No TeMIP Call: -t When running the TNDL with the “No TeMIP Call” option. All TNDL processing are performed but TeMIP is not called and the TNDL reference is not updated.

The input files will be left unchanged after TNDL run.

This option will be useful to validate the input files.

3.2.4.4 Option No Create/No Delete : -n One important feature of the TNDL is to create or delete TeMIP entities. There are some cases where the creation or the deletion is not wanted. For instance, when you split the TNDL run in successive runs (as it is the case in IP Auto-configuration), only one run is dedicated to the creation/deletion of the TeMIP entities, the other runs being dedicated to the characterization of the entities (example: an entity is member of a given domain. In No Create/No Delete mode, creation/ registration and deletion/de-registration of entities is disabled, while modification of MSL attributes is still enabled (set).

3.2.4.5 Option IP autoconfig: -c It is a variant of the option no create/no delete. It performs no create, no delete, no set operations on entities where domain memberships are specified. Creation, deletion and modification of entities without specified membership is performed normally.

3.2.4.6 Option Resource File: -r/-R The generation (or the publication) of the map resource files is driven by this option.

A resource file is generated for each map header present in the map file.

The map resource file name is derived from the map name: all characters are in lowercase, blank and dot characters are replaced by “_” character and the suffix “.map” is used.

The “.map” resource files generated by a previous run of the TNDL will be overridden.

If the option –r is set with a valid directory as an argument, the resource files will be created in the specified directory.

By default the resource file will be created in the “resource” directory under TNDL_WORKSPACE.

If the option –R is set, the resource file will be published using the “temip_resource_publish” tool.

3.3 Checking TNDL Completion Status After each TNDL session, you can check the completion status. Detailed information is provided in the TNDL log files. Global status is provided through the TNDL executable exit status.

3.3.1 Log Files The TNDL automatically logs two types of data - errors and activation status - into two dedicated text files.

117

The first text file is the log file (by default dataload.log in the TNDL_WORKSPACE directory), which contains the log history of all runs performed. The TNDL keep appending error messages to the existing log file between successive runs. Your system manager should archive and clear the contents of this file regularly.

The second text file is the last file (by default dataload.last in the TNDL_WORKSPACE directory), which contains only the last performed run log. No archiving is needed for this file.

If the error messages cannot be logged to the dedicated text file (for example, if there is no space left on the log file disk), the messages are logged to the standard error device.

See Section 6.4 for a description of the log files and a detailed list of error messages.

3.3.2 Exit Status The exit status of the TNDL executable (for example /usr/opt/temip/TNDL/bin/DataLoad) represents the level of success for the performed run:

0 : run completed without error and without warning.

-1 : run completed without error but with warning(s).

-2 : run failed with a minor fatal error.

-3 : run failed with a major fatal error.

-4 : run failed with a critical fatal error.

3.4 Stopping the TNDL To perform an orderly shutdown of the TNDL, send the default SIGTERM signal to the TNDL executable. The TNDL stops immediately and records its shutdown in the log file. The TNDL supports other types of interrupt (such as orderly shutdown of the machine or power off of the machine). When restarted it resumes at the point where it was stopped, but there is no indication in the log file of the interrupt event; see Chapter 6.

118

Chapter 4

TNDL Processing TNDL considers its input files (topology, map, config, profile) as its sole source of data. It never checks what exists within TeMIP (such as new values for attribute, new child entities or new map memberships).

When a network element is managed by the TNDL, interactions through the TeMIP Client PM or the FCL PM are limited, otherwise inconsistencies will appear in the TeMIP MIR and maps.

The TNDL determines if the input file context is different from the reference file context. If so, it determines the TeMIP update operations and performs them in the following order: MIR update, domain membership update, and map membership update.

Figure 2 describes the standard processing flow applied to the input files (if present).

Figure 2 TNDL Processing Flow for a Topology File

Reference Files

Input Files

Delta Files

MIR Update

Domain Update

Map Update

Expand/Delta

TeMIP

119

4.1 Initialization The initialization step determines if changes have occurred in the input files (topology, map, profile) since the last TNDL run.

A TNDL processing is needed if:

At least one of the topology file, map file or profile file is different from its reference. When one of the reference files is not present (first activation of the TNDL) this is also considered as a difference. But the absence of an input file cannot be considered as a difference. It just means no new data is available.

4.2 Expand If the TNDL processing is needed, the expand mechanism is performed.

The first task of this step is to complete the characteristics of the map items defined in the topology file or in the map file.

These characteristics may be defined in the default graphical representation section or in the profile file.

The second task is to move each map item from the topology file (if present) to the map file.

This step produces the expanded topology and map files.

4.3 Delta The delta phase differs according to the kind of input files provided to the TNDL.

4.3.1 Standard Input Files The newest (expanded) topology file and map file are compared to their corresponding reference file, in order to identify what need to be created, deleted or modified.

Comparison Mechanism

• If the expanded file is not present in reference, the delta is considered to be the insertion of each element of the expanded file.

• If the expanded file in input is present but empty, the delta is considered to be the deletion of each element of the expanded file.

When both input and reference expanded files are present, the processing is the following one:

• If an element is present in the expanded file but not in the reference file, it will be inserted.

• If an element is present in the reference file but not in the expanded file, it will be deleted.

• If an element is present in both files, it will be modified.

The mechanism is applied on a domain, a network element, a map or a map item.

This step produces the delta topology and map files used in the next step.

120

4.3.2 Delta Input Files The delta topology and map files have been provided in input. They have been expanded in the previous step.

The previous reference files are updated with information found in the delta input files. These files will represent the new reference after the successful completion of the following MIR, Domain and Map update phase.

4.4 MIR Updates When the delta computation identifies a new entity, this entity is created in the MIR (if applicable) with the set of MSL attributes specified in the input topology file. Global entities are registered in TNS with their managing director, and any registration data, if specified.

When the delta computation identifies an obsolete entity, this entity is deleted from the MIR (if applicable). Global entities are also deregistered from TNS. Note that TeMIP automatically deletes the existing entity membership of domain(s).

When the delta computation identifies a modified entity, the MSL attributes that are not the same as their reference counterparts are modified in the MIR.

Note that if TNDL is running with option No Create/No Delete (-n) or option IP autoconfig (-c), default behavior described here concerning creation/deletion/modification of entities is changed. Please refer to Section 3.2.4 for more information.

Interaction of Topology Files with TeMIP PMs

When an entity is specified in the topology file, you should not try to delete it using TeMIP PMs. The TNDL would still believe that the entity is present in the TeMIP configuration.

You may choose to maintain some network elements/domains outside the TNDL. You can integrate these entities in the topology files later. When the TNDL creates them in the MIR, it will simply signal that they already exist.

4.5 Domain Updates When the delta computation identifies a new global entity, this is eventually added as a member of each domain specified in the input topology file.

When the delta computation identifies an obsolete global entity, no explicit deletion of domain membership is performed because TeMIP already does this when it deletes the entity from the MIR; see Section 4.4.

When the delta computation identifies a modified global entity, this is added as a member of each new domain specified in the input topology file, and removed from each obsolete domain specified in the reference topology file.

121

4.6 Map Updates When the delta computation identifies a new map item (specified in the topology or in the map file), this map item is added to its corresponding map (the TNDL creates the map if it does not exist). See Section 2.3.4 for a detailed description of the graphical characteristics of the map item.

When the delta computation identifies an obsolete map item, this map item is removed from its corresponding map.

When the delta computation identifies a modified map item, this map item is added to each new map (found in the input files), or removed from each obsolete map (found in the reference files). Any modification to the map item's graphic characteristics is applied within the current map.

From TeMIP V4.0, if Map Change Notification is enabled, any changes in maps made by the TNDL (V4.0 or higher), will automatically be signaled to the TeMIP Client users. For details of the Map Change Notification feature, see the OpenView TeMIP Iconic Map/Client and FCL User's Guide.

4.7 How Graphical Representation is Computed

There are several places where the <Graphical_Representation> of a <Map_Item> can be defined: topology file, map file, profile file, configuration file, TeMIP. This section explains how TNDL determines the value of the <Graphical_Representation> attributes.

Within the topology or map file, the <Graphical_Representation> specified in the <Map_Item> takes precedence over the <Default_Graphical Representation>. If all or part of the <Graphical_Representation> is missing in the <Map_Item>, it is searched for in the <Default_Graphical_Representation>.

If all or a part of the <Graphical_Representation> is still missing from the topology or map file for a specific <Map_Item>, the TNDL refers to the profile file (if this file contains an entry corresponding to the <Map_Item>).

If at that point, no <Graphical_Representation> has been defined, TNDL uses the <Node> representation, and leaves the TeMIP Client to select the appropriate icon file name (entity class default icon, if present, or default entity icon).

Otherwise, if the <Map_Item> is a lined item or a connector, but the color or width characteristic is missing, the TNDL refers to the configuration file. If it is a text item, but the color characteristic is missing, the configuration file is searched too. If a characteristic is not present, the TeMIP Client default values are applied when the <Map_Item> is displayed. In this case, the default color and width for the current TeMIP Client session are used to display the map items.

4.8 How Graphical Coordinates are Computed The position of a map item in the map is determined by:

• The <Positioning_Type> of the map (defined in the <Map_Header>).

• The <Center_Coordinates> attribute of the map item.

122

• The coordinates specified inside the <Graphical_Type> section of the map item.

The <Positioning_Type> attribute of the map is specific to the TNDL. Its value is either “Graphic” or “Grid”. Its default value is “Graphic”.

If the map has no <Map_Header> declared in the map file, the positioning type is “Grid”.

The “Grid” positioning proposes the automatic placement of a map item in a grid layout; see Section 4.8.3.

The “Graphic” positioning uses the information set in the map item to place it on the map; see Section 4.8.2.

4.8.1 Standard Mode The standard positioning is applied when the following conditions are

encountered:

• The <Positioning_Type> is not specified in the <Map_Header> or set to the “Graphic” value.

• No <Center_Coordinates> are set in the map items.

• The coordinates of each map item are specified in the <Graphical_Type> section.

The standard positioning left unchanged the coordinates of the map items. It implies that the coordinates have been calculated outside the TNDL context.

4.8.2 Graphic Mode The “Graphic” positioning uses the <Center_Coordinates> attribute of a map item if it exists.

The <Center_Coordinates> attribute is specific to the TNDL. It specifies the center of the map item and it is optional.

The coordinates specified inside the <Graphical_Type> section of a map item are considered as its relative coordinates if the <Center_Coordinates> is specified, they will be centered by the TNDL around this position. They are considered as its absolute coordinates and they will be left unchanged if the <Center_Coordinates> is not specified.

The following sections illustrate the positioning of each type of map item in the “Graphic” positioning mode.

4.8.2.1 Node The position of a node is specified by the coordinates specified in the <Position> section.

In absolute mode: the position describes the center of the node.

In relative mode: the position is ignored, it is replaced by the value of the <Center_Coordinates>.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” />

123

</Center_Coordinates> <Graphical_Type> <Node> <Position> <Point X=”20” Y=”20” /> </Position> </Node> </Graphical_Type> </Graphical_Representation> </Map_Item> The final position of the node will be: X=”100” and Y=”100”.

4.8.2.2 Text The position of a Text item is specified by the coordinates specified in the <Text_Position> section.

In absolute mode: the position is the starting point of the text.

In relative mode: the text position is ignored, it is replaced by the value of the <Center_Coordinates>.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Text_Item> <Text_Position> <Point X="20" Y="20"/> </Text_Position> </Text_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item> The final position of the text will be: X=”100” and Y=”100”.

4.8.2.3 Lined Item The coordinates of a Lined item (Box, Line, Circle, Polyline, Spline) are specified in the <End_Points> section.

Box

A Box is described by two points.

In absolute mode: the first point is the lower left end point and the second point is the upper right end point.

In relative mode: the two points are moved around the <Center_Coordinates> in order to keep the height and the width of the box.

124

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Box</Line_Type> <End_Points> <Point X="120" Y="150"/> <Point X="130" Y="160"/> </End_Points> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item> The width of the box is X=“10” and its height is Y=”10”. The final end points of the box will be: X=”95”, Y=”95” and X=”105”, Y=”105”.

Circle

A Circle is described by two points.

In absolute mode: The first one is the center of the circle and the second one is a point of the perimeter.

In relative mode: the first is moved at the <Center_Coordinates> position and the second point is moved in order to keep the radius of the circle.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Circle</Line_Type> <End_Points> <Point X="120" Y="150"/> <Point X="130" Y="160"/> </End_Points> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item>

125

The spacing between the center of the circle and one of its point is: X=”10”, Y=”10”. The final end points of the circle will be: * X=”100”, Y=”100” * X=”110”, Y=”110”.

Line

A Line is described by two points.

In absolute mode: The first one is the starting point of the line and the second one is an ending point of the line.

In relative mode: the two points are moved around the <Center_Coordinates> in order to keep the direction of the line.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Line</Line_Type> <End_Points> <Point X="120" Y="150"/> <Point X="130" Y="160"/> </End_Points> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item> The final end points of the line will be: * X=”95”, Y=”95” * X=”105”, Y=”105”

Polyline

A Polyline is described by a series of two or more points.

In absolute mode: The first one is the starting point of the polyline and the last one is an ending point of the polyline.

In relative mode: The list of point is moved around the <Center_Coordinates/> in order to keep the appearance of the polyline.

<Map_Item> … <Graphical_Representation> <Center_Coordinates>

126

<Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Polyline</Line_Type> <End_Points> <Point X="120" Y="150"/> <Point X="140" Y="160"/> <Point X="100" Y="170"/> </End_Points> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item> The final end points of the polyline will be: * X=”100”, Y=”90” * X=”120”, Y=”100” * X=”80”, Y=”110”

Spline

A Spline is described by a series of two or more points.

In absolute mode: The first one is the starting point of the spline and the last one is an ending point of the spline.

In relative mode: The list of point is moved around the <Center_Coordinates/> in order to keep the appearance of the spline.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Lined_Item> <Line_Type>Spline</Line_Type> <End_Points> <Point X="120" Y="150"/> <Point X="140" Y="160"/> <Point X="100" Y="170"/> </End_Points> </Lined_Item> </Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item> The final end points of the polyline will be: * X=”100”, Y=”90” * X=”120”, Y=”100” * X=”80”, Y=”110”

127

4.8.2.4 Connector The connector is described by two connector ends and eventually a connector path. A connector end can be a point or the identifier of another map item.

In absolute mode: The first connector end is the starting point of the connector and the last connector end is the ending point of the connector. The connector path is used to specify the intermediate points of the connector.

In relative mode: The connector ends specified by the identifier of another map item are left unchanged. The other connector ends and the list of points of the <Connector_Path> describe the form of the connector. They will be moved around the <Center_Coordinates> in order to keep the appearance of the connector.

Note

The original appearance of the connector is not perfectly reproduced when a connector is connected to one or two map items because the TNDL cannot determine their absolute positions.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Graphical_Coordinates X=”100” Y=”100” /> </Center_Coordinates> <Graphical_Type> <Connector> <Connector_Ends> <Connector_End> <End_Point> <Point X="30" Y="40"/> </End_Point> </Connector_End> <Connector_End> <End_ObjectID>box box1</End_ObjectID> </Connector_End> </Connector_Ends> <Connector_Path> <Point X="40" Y="50"/> <Point X="50" Y="60"/> </Connector_Path> </Connector> </Graphical_Type> </Graphical_Representation> </Map_Item> The final starting point of the connector will be: * X=”90” and Y=”90” The connector path will be the following list of point. * X=”100” and Y=”100” * X=”110” and Y=”110”

128

4.8.2.5 Geographical Coordinates Center If the map item is described with geographical coordinates (and the map's geographical coordinates referential is set), the TNDL computes the equivalent graphical coordinates center.

If the map item is described with geographical coordinates, but the map geographical coordinates referential is not set, the grid positioning is applied (a center will be determined automatically).

The geographical coordinates can be specified in standard mode (latitude, longitude) or in Lambert mode.

// Geographical Coordinates <Map_Item> <Graphical_Representation> <Center_Coordinates> <Geographical_Coordinates Latitude=”42-30-12N” Longitude=”2-10-50W” /> </Center_Coordinates> </Graphical_Representation > </Map_Item> // Lambert Coordinates <Map_Item> <Graphical_Representation > <Center_Coordinates> <Lambert_Coordinates X=”5678” Y=”546” /> </Center_Coordinates> </Graphical_Representation > </Map_Item>

4.8.2.6 Automatic Center The TNDL will calculate automatically the center of a map item in the following situations:

• If the <Center_Coordinates> of a map item has been set to “Automatic”.

• If the <Map_Item> does not hold coordinates in its <Graphical_Type> section.

The TNDL will use the grid positioning described in the next section to determine the center of the map item.

The positions of the map items positioned in the grid are computed from the lowest and leftmost coordinates of the other map items.

<Map_Item> … <Graphical_Representation> <Center_Coordinates> <Automatic/> </Center_Coordinates> <Graphical_Type> <Extended> <Extended_Type> <Text_Item> … </Text_Item>

129

</Extended_Type> </Extended> </Graphical_Type> </Graphical_Representation> </Map_Item>

4.8.3 Grid Positioning The “Grid” positioning will be applied to all map items if the <Positioning_Type> of a map is set to “Grid” (or if no map header has been defined for the map).

Grid positioning proposes the automatic placement of the map items in a grid layout. See Section 2.1.8 for a description of the grid layout parameters. Map Items centers are re-computed each time the map is updated. Map Item ordering follows the map ordering policy specified in the configuration file; see Section 2.1.8.4.

If the map item has its coordinates specified in its <Graphical_Type> section, they will be centered on the position calculated by the grid positioning algorithm. When a map item is already present in the map, its position is re-computed.

130

Chapter 5

Data Conversion This chapter discusses examples, guidelines, facilities for Data Conversion and compilation. The optional Data Conversion process is separate from and must precede network data loading. Data Conversion consists in translating a network inventory to TeMIP Network Data Loader (TNDL) input data.

5.1 Data Converter Examples Examples of Data Converter source code are provided in the kit as follows:

• Example 1 is a simple example concerning a set of INTERNET_SYSTEM entities. Main program: DataConverter1.cxx

• Example 2 is a more complex example concerning a network containing various network elements with parent-child relationships. Main program: DataConverter2.cxx

• Example 3 is a simple example of different graphical representations for a Line, a Box, a Polyline, a Ring and a Text. All the graphical representations are described in the profile.xml file. . Main program: DataConverter3.cxx

Each example includes a launcher script (/usropt/temip/TNDL/examples/tndl_launcher1, /usr/opt/temip/TNDL/examples/tndl_launcher2, or /usr/opt/temip/TNDL/examples/tndl_launcher3).

You must be logged in as root or temip to run the scripts.

Within the scripts, the flow is:

1. Start TeMIP

2. Check to make sure that the TNDL is not running

3. Generate the network inventory

4. Run the Data Converter

5. Start the TNDL

You can then run the TeMIP Client or perform an FCL PM Show operation to display the results.

If you customize one of the examples, you will need to recompile, see Section 5.4.

131

5.1.1 Data Converter Example 1 The network inventory file supplied as input in Example 1 is a list of hosts. Any suitable list can be used as a starting point, for example, taking the contents of the /etc/hosts file. The following fields must be entered for each host, separated by blanks or tabs:

• Full host name/IP address.

• System Type (Alpha, Sun, NT).

• Geographical Location.

• Responsible person (optional).

Data Conversion results in a TeMIP INTERNET_SYSTEM entity for each host.

For further details of this example, see the ReadMe file supplied with the examples: /usr/opt/temip/TNDL/examples/DataConverter.README.

5.1.2 Data Converter Example 2 The network inventory file supplied as input in Example 2 is as shown:

Equipment Name

Type System Location Responsible Person

M1 Mux None Lyon John

C1 Card M1 Paris Dupond

C2 Card M2 Paris Dupond

M2 Mux None Paris John

C1 Card M2 Lyon Dupond

Backbone1 Backbone None Paris Regis

Router1 Router Backbone1 Marseille Albert

Fiber1 Fiber Backbone1/Router1 Paris-Lyon Helmut

Router2 Router Backbone1 Lyon Albert

Fiber2 Fiber Backbone1/Router2 Bordeaux-Marseille

Helmut

Paris and Lyon are to be in one collection domain and Bordeaux and Marseille in another.

The network element model for Example 2 is shown in Figure 3.

132

Figure 3 Network Element Model for Data Converter Example 2

Therefore, the TeMIP entities resulting from the input file are as follows:

Multiplexer

BOX

Card

BOX CARD

Backbone

BSS

Router

BSS BTS

Fiber

BSS BTS TCH

• BOX Mux_M1

• BOX Mux_M2

• BOX Mux_M1 CARD Card_C1

• BOX Mux_M2 CARD Card_C2

• BSS Backbone1

• BSS Backbone1 BTS Router1

• BSS Backbone1 BTS Router2

• BSS Backbone1 BTS Router1 TCH Fiber1

• BSS Backbone1 BTS Router2 TCH Fiber2

For further details of this example, see the ReadMe file supplied with the examples: /usr/opt/temip/TNDL/examples/DataConverter.README.

5.2 Data Converter Guidelines When customizing or writing a Data Converter, the aspects that you must consider are: naming entities, ordering entity creation, setting graphical attributes, and activating Data Conversion.

5.2.1 Naming Entities You must apply Naming rules for translating inventory entity names to TeMIP entity names that ensure that all TeMIP entity names generated are unique. In the example programs, the IP Autoconfiguration naming conventions are used, as explained in the ReadMe file.

133

5.2.2 Ordering Entities for Creation The order in which Domain entities are created is important for domain topology. If you have a hierarchical domain topology, Domain entity creation must be top-down.

To ensure that Domain entities are created in a specific order, declare them in this order and then set the NE ALPHASORT configuration parameter to OFF in the TNDL configuration file; also see Section 2.1.9. Remember, however, that with this parameter set to OFF, you must also declare a parent entity before its child entities to ensure that the parent entity exists before an attempt is made to create a child. You must then check that the order reflects any other dependencies, to ensure successful entity creation.

5.2.3 Activating Data Conversion You must perform Data Conversion before Data Loading.

You are recommended to encapsulate both Data Conversion and Data Loading in a UNIX shell script. This script can be scheduled to run regularly, at a suitable frequency for the likely changes to the network inventory, using the cron daemon (system clock).

Use the crontab command to create a Data Conversion schedule table. Enter this command while logged in as root to give your crontab table superuser protection. Your crontab table will be saved as file /var/spool/cron/crontable/root.

5.3 Data Conversion Facilities The examples of Data Conversion are implemented using Data Conversion facilities, which are defined as C++ classes. The class definitions are supplied in the directory /usr/opt/temip/TNDL/examples with the examples.

The following classes are supplied:

Main CV Classes

• CVBackdrop: A CVBackdrop object allows you to specify the backdrop file name, type, and the geographical coordinates.

Main Entity-Related Classes

• TCVEntity: A TCVEntity object is any TeMIP entity maintained using the TNDL.

• TCVEntitySpec: A TCVEntitySpec object refers to any TeMIP Entity (a sequence of pairs of entity class and entity instance name).

• TCVMember: A TCVMember object is a membership relation between a TCVEntity object and a TeMIP Domain.

Main Graphics Classes

• TCVBaseGraphics: A TCVBaseGraphics object is the graphical representation shared by the objects TCVGraphics.

• TCVGraphics: A TCVGraphics object is the graphical representation of the TCVEntity (TCVIcon, TCVLine, TCVPolyline, TCVBox, TCVRing, and TCVText).

134

• TCVMap: This class defines a simple graphical Container. It could contain some items (MapItem) that could have a graphic associated and a possible TeMIP entity.

• TCVMapItem: This class defines a graphical Item. It could be associated to: either a TeMIP entity or a graphic or both.

For details of the constructors and methods of these classes, see Appendix E.

You can use the supplied facilities to write your own Data Converter. If you write your own Data Converter, you will need to recompile.

5.4 Compiling a Data Converter A makefile for the Data Converter examples is delivered as file /usr/opttemip/TNDL/examples/DataConverter.make.

To compile an example Data Converter, enter: #make -f DataConverter.make <Data Converter Name>

You can also use the supplied makefile as a template to create a makefile for your own Data Converter.

135

Chapter 6

Troubleshooting the TNDL This chapter considers the conditions that will prevent the TNDL from running, cause it to exit with a fatal error, or cause updates to TeMIP MIRs or maps to fail. It explains the two phases of TNDL processing, the difference between a TNDL stop and a TNDL abort, and how to use the recovery file. Finally it lists TNDL error messages with corrective actions where appropriate.

6.1 The Parsing and Loading Phases There are two phases to TNDL processing: parsing and loading.

Figure 4 TNDL Processing Phases

HDS FM

Start

Parsing

Loading

Delta Topology

End

Configuration File

Map File

Topology File

Profile File MIR

6.1.1 Parsing Phase During the parsing phase (XML parsing and validation), the input files are moved to the tmp directory and read. The output of this phase is the delta files to use for loading data into TeMIP. Parsing errors are logged showing the faulty input element and the position of the error in the file.

137

Severity of these errors can be warning or fatal errors (minor, major or critical).

In case of parsing warnings, you should correct the faulty elements for next TNDL run, but the run will complete anyway.

In case of parsing fatal errors, TNDL stops. You should re-provide corrected input files. TNDL will restart from beginning: no recovery mechanism during parsing phase.

The duplication of entities (two entities with the same name), map items (two map items with the same id) or maps (two map headers with the same map name) is detected during the parsing phase. When there is duplication, the TNDL issues a warning, takes the first element and ignores subsequent ones.

6.1.2 Loading Phase During the second phase, each element in the delta files is actioned in turn by sending a request to TeMIP.

The effect of the requests sent to TeMIP is to update one or more MIRs or maps or both. MIR and map update errors are logged with a preceding state message and an explanation of the request sent to TeMIP. They may be fatal or nonfatal.

In case of a fatal error, the recovery mechanism applies. You should then re-launch the TNDL that will resume from where it stopped.

6.2 Error Conditions When TNDL activation does not proceed to completion, this is due to one of two conditions:

• External stop

• Internal abort (due to a fatal error)

If TNDL activation does proceed to completion, all nonfatal errors and warnings are logged and counted.

6.2.1 TNDL Stop If the TNDL stops because of external circumstances (for example, temip_stop), this is referred to as a TNDL stop. In this case, you can restart the TNDL once the external constraint has been removed (for example, once TeMIP has been restarted). If parsing was in progress, the TNDL restarts from the beginning. If loading was in progress, the TNDL resumes at the point where it stopped, using the recovery file, see Section 6.3.

6.2.2 TNDL Abort If the TNDL stops after displaying a fatal error message, this is referred to as a TNDL abort. In this case, check the error message in the list below and perform the corrective actions proposed for the particular context. In most cases, you can then restart the TNDL, and it resumes at the point where the error condition was raised, using the recovery file, see Section 6.3.

138

6.2.3 Non-Recoverable Entity Creation Failure If entity creation is attempted with a badly specified attribute value in MSL, the TNDL ignores the attribute value setting. If the attribute is mandatory, the creation request to TeMIP fails, and cannot be recovered.

In this case, first complete the current TNDL activation, either by removing the faulty entity from the files in tmp and restarting the TNDL, or by editing the line number in the recovery file to make the TNDL start from the next line and restarting the TNDL, see Section 6.3. Then make use of the TNDL delta computation feature to create the entity. Remove the entity specification from the next input topology file and run the TNDL. It will try to delete the non-created entity (warning) and the resulting reference topology file will no longer include the faulty entity. Now present an input topology file with the entity specified again. Ensure that the badly specified attribute value is correct, and run the TNDL. The entity is now created in the TeMIP MIR.

This procedure should only be followed when TNDL has identified an entity creation failure as non-recoverable. In all other cases, a TeMIP modification is sufficient to recover failed entity creation.

6.3 The Recovery File The recovery file is created by the TNDL when the loading phase starts: means when TeMIP is updated. No recovery mechanism is provided during parsing phase. It keeps track of the recovery point, so that the TNDL can resume correctly after being stopped or aborted during the loading phase. Under certain circumstances, this file might need manual updating.

6.3.1 Recovery File Content The recovery file is an ASCII file called dataload.rec, located in /var/opt/temip/TNDL by default or specified by the TNDL_WORKSPACE environment variable (see the Installation Guide for TNDL environment variables).

The file format is as follows, with one item on each line:

<mode> <step> <file type> <item number> <time stamp>

<mode> indicates the program activation mode. It can take values from 0 to 2 (input_topology, input_delta or input_reference).

<step> indicates the program step. It can take values from 0 to 11 (error, init, expand, delta, delta_map, delta_entity, update_delta_entity, update_delta_map, topology_update, map_update, finish).

<type> indicates which type of element is currently being processed. It can take values from 0 to 4 (none, domain, tndl_element,wildcarded_element, scoped_element).

<element number> indicates the element number of the next element to process.

139

<time stamp> is the timestamp of the file that is currently being processed (yyyymmddhhmmss). It is used to name all the related temporary files. The default value, when there are no files to process, is the TNDL activation time.

6.3.2 Editing the Recovery File Only edit this file when explicitly requested to in the corrective actions of fatal errors.

• Log in as an authorized user (see Section 3.2.1) and move to the workspace directory (“/var/opt/temip/TNDL” by default or specified by the TNDL_WORKSPACE environment variable, see the Installation Guide for TNDL environment variables).

• Edit the recovery file as follows:

• If you need to regenerate the recovery file, specify the values extracted from the error message in the order defined in Section 6.3.1.

• Otherwise, modify the appropriate value, as stated in the error message.

• Check that the recovery file has the correct ownership and protection (owner read and write access):

chmod 644 dataload.rec

6.4 TNDL Messages A message will be displayed on a single line with following format:

{date} [message severity] {[process state]} {unique message number} {Message Text}(at line {line number} in file {file name})

Where:

• {date}: current date will be in format: dd/mm/yyyy hh:mm:ss

• {message severity}: in INFORMATION, WARNING, MINOR, MAJOR, CRITICAL

• {process state}: in [init/none], [expand/tndl_element], …..

• {unique message number}: number on 3 digits with leading zeros that identify the message.

• {message text}: Message with placeholders replaced by run time values.

• {line number}: the line in source code file where message was logged.

• {file name}: file name of source code file where message was logged.

Message texts are in the UNIX catalog file ndl_messages.cat. A message text may contain placeholder that will be replaced at run time.

The TeMIP catalog file directory (/usr/opt/temip/%L/%N) must be set in the NLSPATH environment variable.

140

In case the UNIX catalog file is not present or inaccessible, an error message will be displayed to the standard error device, and the TNDL current process will be stopped.

Each message will be logged in two files, under the workspace directory (“/var/opt/temip/TNDL” by default or specified by the TNDL_WORKSPACE environment variable, see the Installation Guide for TNDL environment variables). Files are by default named (names can be changed with command line option –s and –g):

• dataload.last: which contains logging information of the last TNDL run.

• dataload.log: which contains logging information of historical TNDL runs.

The exit status of the TNDL executable (/usr/opt/temip/TNDL/bin/DataLoad) represents the level of success for the performed run:

0 : run completed without error and without warning

-1 : run completed without error but with warning(s).

-2 : run failed with a minor fatal error.

-3 : run failed with a major fatal error.

-4 : run failed with a critical fatal error.

A warning does not cause the TNDL process to stop. Any error (minor, major, critical) is considered as fatal, and therefore causes the TNDL process to stop.

In case of a fatal error:

• No recovery mechanism is provided during the input file parsing phase.

• Recovery mechanism is provided during the TeMIP loading phase.

Notes

It is possible to set the following environment variable to activate the TeMIP Framework traces.

# setenv MCC_KERNEL_LOG 0xffffffff

To activate the TAL Tracing the attribute “Framework Trace Mask” of the TeMIP Application “DataLoad” can be set (0xffffffff for all the trace levels).

6.4.1 Information Messages: [0001-0005]

Starting TNDL

Message Text: “Starting …”

Message Number: 0001

Indicates the beginning of TNDL activation. The minimal operational conditions are met. Any error or warning prior to this stage is logged to the standard error device.

141

Resuming Process after Abnormal Completion

Message Text: “Resuming. %s”


This information message only appears on restarting the TNDL after a TNDL process has terminated abnormally (fatal either stopped or aborted), during the loading TeMIP phase. The content of the recovery file will be displayed in the placeholder (%s) of this message (check Section 6.3.1 for recovery file content). Thus the TNDL will restart loading TeMIP from where it stopped.

Please check Section 6.2 for how to properly resume a TNDL process that stopped during the loading phase. Note that recovery does not apply to TNDL process that stopped during parsing phase: just re-provide correct input files.

Completed Successfully

Message Text: “Completed Successfully”


Indicates that the TNDL activation has succeeded.

End Message

Message Text: “"Execution %s with %s warning and %s error.”


Indicates the end of the TNDL activation.

First placeholder will be one of [success, aborted, stopped].

Second placeholder will contain the number of warnings for the run.

Third placeholder will contain the number of errors for the run

142

End Message Entities

Message Text: “"Execution %s with %s warning and %s error. %s

entities created, %s entities modified, %s entities deleted."”


Indicates the end of the TNDL activation.

First placeholder will be one of [success, aborted, stopped].

Second placeholder will contain the number of warnings for the run.

Third placeholder will contain the number of errors for the run.

Fourth placeholder will contain the number of TeMIP entities created.

Fifth placeholder will contain the number of TeMIP entities modified.

Last placeholder will contain the number of TeMIP entities deleted.

6.4.2 Warning Messages [1001-1329]

6.4.2.1 General Warning [1001]

No Difference to Process

Message Text: "No Difference to Process"


When TNDL was activated, the input directory did not contain any input files, or these files were identical to the reference ones.

No corrective action is needed.

6.4.2.2 System Warnings [1004-1006]

Failure Removing File

Message Text: “Failure Removing File : %s. %s”


Indicates that program failed in trying to remove the file.

First placeholder will give the file name.

The second one will give the process state step.

143

Failure Renaming File

Message Text: “Failure Renaming File from: %s to: %s. %s”


Indicates that program failed in trying to rename the file.

First placeholder will give the original file name.

The second one will give the destination file name.

The third placeholder will give the process state step.

System Error while Issuing Command

Message Text: “ System Error while issuing command: %s (%s: %s). %s ”


Indicates that program failed in trying to execute a UNIX system command. System command can be “touch”, “scandir”.

First placeholder will be the issued command.

The second one will be the severity.

The third placeholder will be the error status.

The fourth placeholder will be the process state Step.

6.4.2.3 Invalid TNDL Input Warnings [1007-1142]

Monitor Catalog Failure

Message Text: “Message cannot be retrieved from monitor catalog. Please check for location of file: %s and value of environment variable NLSPATH (from memory or environment file). Locale is set to LC_ALL.”


Indicates that the monitor catalog cannot be accessed.

Failed to Retrieve Value from Monitor Catalog

Message Text: "Failed to retrieve value %s from monitor catalog."


Indicates that a value cannot be retrieved from the monitor catalog.

144

Invalid Numeric Value Specified in Configuration File

Message Text: “Invalid Numeric Value Specified in Configuration File: %s. Attribute: %s, Faulty value %s, replaced by default value: %s in line: %s"


Please note that this message will be logged to the standard error device.

TNDL parsing the global configuration file (see Section 2.1), found an invalid numeric value. First placeholder will be the configuration file name. Second placeholder will be the faulty value. Third placeholder will be the replacing value, used by TNDL. Fourth placeholder will be the faulty line. Fifth parameter will be information related to process state step and line.

Corrective action will be to change the invalid value in global configuration file, for next TNDL session.

Entity Attribute not Settable

Message Text: "Entity %s: Attribute %s is not settable. %s"


TNDL is building the TeMIP Set request, but the specified attribute is not settable. First placeholder will be the full entity name. Second placeholder will be the attribute name. The third placeholder will be information related to process state step and line.

Corrective action will be to remove the attribute specification from the topology record for the next TNDL session.

Entity Attribute not in Dictionary

Message Text: "Entity %s: Attribute %s not found in dictionary. %s"


TNDL is building the TeMIP Set request, but the specified attribute is not in dictionary. First placeholder will be the full entity name. Second placeholder will be the attribute name. The third placeholder will be information related to process state step and line.

Corrective action will be to remove the attribute specification from the topology record for the next TNDL session.

145

Entity Does not Support Directive

Message Text: "Entity: %s does not support directive(s): %s. %s"


This child entity does not support the directive. First placeholder will be the full entity name. Second placeholder will be the directive (“create/alias and register”, “delete/unalias and deregister”). Third placeholder will be information related to process state step and line.

Corrective action will be to modify the next input topology file in order not to request that directive on the entity. Use the entity name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

Entity Command Argument not Provided

Message Text: "Entity: %s; Argument: %s not provided to the %s command, invalid value: %s. %s"


The argument value provided is invalid. The command will therefore be issued without the value. First placeholder will be the full entity name. Second placeholder will be the name of the argument. Third placeholder will be the command to be issued. Fourth placeholder will be the invalid value. Fourth placeholder will be information related to process state step and line.

Corrective action will be to modify the next input topology file to change the command argument value. Use the entity name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

XML Invalid Element Value Failure

Message Text: "Invalid value < %s > found for element %s in %s will be ignored."


The argument value provided is invalid. The command will therefore be issued without the value. First placeholder will be the value. Second placeholder will be the name of the element. Third placeholder will be information related to process state step and line.

Corrective action will be to modify the next input topology file to change the element value. Use the element name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

146

XML Bad Name Failure

Message Text: "Incorrect %s < %s > found for %s in %s. %s will not be created."


The XML name provided is invalid. The command will therefore be issued without the value. First placeholder will be the element name. Second placeholder will be the value found in this XML node. Third and Fifth placeholders will be the XML context. Fourth placeholder will be the map item name.

Corrective action will be to modify the next input topology file to change the incorrect element. Use the element name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

XML Bad Graphic Type

Message Text: "Graphic type not found or incorrect value supplied. %s will not be created."


The map item graphic type provided is invalid. The command will therefore be issued without the map item. First placeholder will be the map item name.


XML Connector End Failure

Message Text: "Less than two connector ends found. %s will not be created."


The connector map item provided is invalid. It must not be provided with less than two connector ends. First placeholder will be the map item name.


147

XML Bad Name TAL Failure

Message Text: "Incorrect %s < %s > found for %s in %s. %s will not be created. TAL Exception is: %s"


The XML name provided is invalid. The command will therefore be issued without the value. First placeholder will be the element name. Second placeholder will be the value found in this XML node. Third and Fifth placeholders will be the XML context. Fourth placeholder will be the map item name. Fifth placeholder is the TAL exception returned.


Invalid Element Value TAL Failure

Message Text: "Incorrect %s < %s > found for %s in %s. %s will not be created. TAL Exception is: %s"


The argument value provided is invalid. The command will therefore be issued without the value. First placeholder will be the value. Second placeholder will be the name of the element. Third placeholder will be information related to process state step and line. Fourth placeholder is the TAL exception returned.

Corrective action will be to modify the next input topology file to change the element value. Use the element name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

148

XML Bad Request Entity Remove

Message Text: "Asked to remove entity %s which cannot be found into reference. Request will be ignored. %s"


The entity to update cannot be found into reference. Request will be ignored.

First placeholder will be the entity name. Second placeholder will be information related to process state step and line.


XML Bad Request Entity Update

Message Text: "Asked to update entity %s which cannot be found into reference. Request will be ignored. %s"


The entity to update cannot be found into reference. Request will be ignored.

First placeholder will be the entity name. Second placeholder will be information related to process state step and line.


XML Bad Request Entity Insert

Message Text: "Asked to insert entity %s which already exists into reference. Request will be ignored. %s"


The entity to insert cannot already exist into reference.

First placeholder will be information related to process state step and line.


149

XML Bad Request Map Remove

Message Text: "Asked to remove map %s which cannot be found into reference. Request will be ignored. %s"


The map to remove cannot be found into reference. The request will be ignored.

First placeholder will be information related to process state step and line.


XML Bad Request Map Update

Message Text: "Asked to update map %s which cannot be found into reference. Request will be ignored. %s"


The map to update cannot be found into reference. The request will be ignored.

First placeholder will be the map name.

Second placeholder will be information related to process state step and line.


150

XML Bad Request Map Insert

Message Text: "Asked to insert map %s which already exists into reference. Request will be ignored. %s"


The map to insert is already present in the reference. The request will be ignored.

First placeholder will be the map name.

Second placeholder will be information related to process state step and line.


XML Member Of Child Failure

Message Text: "Asked to created a member of %s which is a child entity. Request will be ignored. %s"


The XML name provided is invalid. The command will therefore be issued without the value. First placeholder will be the element name. Second placeholder will be the value found in this XML node. Third and Fifth placeholders will be the XML context. Fourth placeholder will be information related to process state step and line.


XML No Map Name

Message Text: "No map name found for item %s.. Map Item will not be created."


The item has been provided without a map name. First placeholder will be the item name.

Corrective action will be to provide a map name for this item.

151

XML Multiple Map Definition

Message Text: "Map %s is defined more than once. Only first definition will be taken into account. %s"


The map name provided is defined more than once. First placeholder will be the map name. Second placeholder will be information related to process state step and line.

Corrective action will be to remove the duplicated map.

XML Multiple Entity Definition

Message Text: "Entity %s is defined more than once. Only first definition will be taken into account. %s"


The entity name provided is defined more than once. First placeholder will be the entity name. Second placeholder will be information related to process state step and line.

Corrective action will be to remove the duplicated entity.

XML Multiple Map Item Definition

Message Text: "Map item %s is defined more than once.

Only first definition will be taken into account. %s"


The map item id provided is defined more than once. First placeholder will be the map item id. Second placeholder will be information related to process state step and line.

Corrective action will be to remove the duplicated map item.

152

XML Multiple Profile Definition

Message Text: "Profile %s is defined more than once. Only

first definition will be taken into account."


The profile name provided is defined more than once. First placeholder will be the profile name. Second placeholder will be information related to process state step and line.

Corrective action will be to remove the duplicated profile.

XML Bad Name Profile Failure

Message Text: "Empty name found in profile definition from file: %s. Profile with empty name will be ignored."


The profile name is mandatory. First placeholder will be the profile file name.

Corrective action will be to set the profile name or to remove the profile.

6.4.2.4 TeMIP Warnings [1219-1322]

TAL Unexpected Failure

Message Text: "TAL unexpected exception condition encountered: %s. %s"


TAL returned an exception, but TNDL process continues. First placeholder will be the TAL exception message. Second placeholder will be empty or will contain information related to the process state step and line.

Other TeMIP Signal Received

Message Text: " Other TeMIP Signal Received"


A TeMIP signal was received.

153

Other Warning Message

Message Text: "%s, WARNING: %s. %s"


The operational status of the latest execution of the TAL directive (create, alias, register, set, delete, unalias, deregister) is warning. Possible causes are: entity already exists in TeMIP (create, register), entity does not exist in TeMIP (delete, deregister).

First placeholder will be the full directive string. Second placeholder will be the TAL failure message. Third placeholder will be information related to process state step and line.

TAL Retrieve Map File Failure

Message Text: "Unable to retrieve map file for %s, received Exception type: %s. %s"


TAL returned an exception while making a call on a map. TNDL process continues anyway. First placeholder will be the map name. Second placeholder will be the TAL exception message. Third placeholder will be empty or will contain information related to the process state step and line.

6.4.2.5 Other Warnings [1323-1329]

Map Inconsistent Positioning

Message Text: "Inconsistent graphic positioning between item %s and map %s. Grid positioning will be used."


The graphic positioning type is inconsistent between a map item and its map. The grid positioning will be used to resolve the conflict.

Map Unknown Map Item Type

Message Text: "Unknown type found for map item %s in map %s will be ignored."


The type of the map item is unknown. The map item will be ignored.

154

Entity Creation Failure

Message Text: "Processing error. Following entity has not been created into TeMIP: %s"


An entity cannot be created into the TeMIP environment.

Map Creation Failure

Message Text: "Processing error. Following map has not been created into TeMIP: %s"


A map cannot be created into the TeMIP environment.

Map Item Does Not Exist

Message Text: "Asked to modify map item %s which does not exist into TeMIP. Item will be created. %s"


The map item that should be modified does not exist into TeMIP. The map item will be created instead.

Map Add Entity Failure

Message Text: "Cannot add entity: %s to map: %s, Reason: %s."


Cannot add an entity to the map.

First placeholder will be the entity name. Second placeholder will be the map name. Third placeholder will be the failure reason.

Map Remove Entity Failure

Message Text: "Cannot remove entity: %s from map: %s, Reason: %s."


Cannot remove an entity from the map.

First placeholder will be the entity name. Second placeholder will be the map name. Third placeholder will be the failure reason.

155

6.4.3 Minor Messages [2003]

Abnormal End Message

Message Text: "Abnormal termination of the program due to previous warning(s)"


The succession of previous warning causes the abnormal termination of the TNDL.

6.4.4 Major Messages [3001-3401]

6.4.4.1 System Major Failure [3001-3007]

Cannot get TNDL Process PID …

Message Text: "Cannot get PID"


Cannot get the current process PID

Opening File Failure …

Message Text: "Cannot open file with mode: %s file: %s. %s"


Cannot open file failure. First placeholder will be the opening mode (“in/no create”, “out/ate”, “out”, “PID”). Second placeholder will be the filename. Third placeholder will be empty or contain information related to the process state step.

Corrective action will be to verify that file exists and has correct access mode.

Reading File Failure …

Message Text: "Error reading file: %s. %s"


Cannot read file failure. First placeholder will be the faulty file name. Second placeholder will be empty or contain information related to the process state step and line.

Corrective action will be to check for file corruption.

156

Writing file failure …

Message Text: "Error Writing To File: %s. %s"


Cannot write into file failure. First placeholder will be the faulty file name. Second placeholder will be empty or contain information related to the process state step and line.


Copying File Failure …

Message Text: "Unable to copy file from: %s to: %s. %s"


Could not copy file. First placeholder will be original file. Second placeholder will be the destination file. Third placeholder will be empty or contain information related to process state step.

Corrective action will be to verify for directory structure and available disk space

Writing to Recovery File Failure …

Message Text: "Error writing to recovery file: %s;Message: %s"


Could not write to recovery file. The recovery information will be written to the log files instead. First placeholder will be the recovery file name. Second placeholder will be the recovery information.

Corrective action will be to solve the write access problem on the recovery file (not enough disk space, wrong write access). Then to copy back in the recovery file the recovery information present in log files, prior to resume TNDL process.

UNIX Command System Failure ….



Indicates that program failed in trying to execute a UNIX system command. System command can be “touch”, “scandir”. First Placeholder will be the issued command. The second one will be the severity. The third placeholder will be the error status. The fourth placeholder will be the Process State Step.

157

6.4.4.2 Invalid TNDL input Major Failure [3101-3109]

XML Initialization Failure

Message Text: "XML initialization failure: %s. %s"


The initialization of the XML parser has failed.

XML Parsing Failure

Message Text: "Error on XML parsing. SystemId: %s, line: %s, column: %s, %s. %s"


The parsing of the XML input has failed.

XML Unexpected Parsing Failure

Message Text: "Unexpected error parsing file %s: %s. %s"


An unexpected error has been encountered during the parsing of the XML file.

XML Element Missing Failure

Message Text: "Missing mandatory element %s as child of element %s. %s."


A mandatory element is missing in the XML file.

XML Bad Value Failure

Message Text: "Bad or empty value supplied for %s: %s. %s"


An incorrect value has been provided in the XML file.

158

MSL Attribute not Recognized as an Attribute of Entity …

Message Text: "No Attribute: %s for Class: %s"


In TNDL input file, an entity is specified with an MSL attribute which is not recognized by the TeMIP dictionary as an attribute for the entity. First placeholder will be the attribute name. Second placeholder will be the full entity name.

Corrective action will be to modify the next input topology file. Use the entity name to search the record.

MSL Attribute not Recognized as an Argument for Entity Directive…

Message Text: "No argument: %s, for directive: %s, of class: %s"


In TNDL input file, an entity is specified with an MSL attribute which is not recognized by the TeMIP dictionary as an argument for the entity directive. First placeholder will be the attribute name. Second placeholder will be the directive presentation name. Third placeholder will be the full entity name.

Corrective action will be to modify the next input topology file. Use the entity name to search the record.

6.4.4.3 TeMIP Major Failure [3210-3215]

Initialization Failure …

Message Text: "TeMIP Initialization failure"


Bad initialization of your connection with TeMIP TAL.

TAL Unexpected Failure …



An unexpected TAL failure occurred, that stopped the TNDL process. First placeholder will be the TAL exception message. Second placeholder will be empty or will contain information related to the process state step and line.

159

Fatal Message No Recover …

Message Text: "%s, FATAL(*): %s. %s"


A TeMIP call directive failed, with a fatal exception.

The operation is not recoverable. Possible causes are: entity creation is attempted with a badly specified attribute value in MSL, If the attribute is mandatory, the creation request to TeMIP fails, and cannot be recovered.

First placeholder will be the directive string. Second placeholder will be the TAL failure message. Third placeholder will be information related to process state step and line.

TeMIP Error Exception …

Message Text: "Fatal TTeMIPErrorException Received: %s. %s"


A TeMIP call directive failed, with a fatal exception. First placeholder will be the TAL exception message. Second placeholder will be empty or will contain information related to the process state step and line.

TAL Value Missing Failure …

Message Text: "Cannot get mandatory value from HDS for [%s]: %s %s"


A mandatory value is missing.

First placeholder will be the missing field. Second placeholder will be the incomplete record. Third placeholder will be empty or will contain information related to the process state step and line.

TAL Request Fatal Failure

Message Text: "%s, FATAL: %s. %s"


the operational status of the latest execution of the TAL directive (create, alias, register, set, delete, unalias, deregister) is fatal but recoverable. Possible causes are: entity already exists in TeMIP (create, register), entity does not exist in TeMIP (delete, deregister).


160

TAL Retrieve Map File Failure

Message Text: "Unable to retrieve map file for %s, received Exception type: %s. %s"


TAL returned an exception while making trying to retrieve a flat map file (without option –t and –f). First placeholder will be the map name. Second placeholder will be the TAL exception message. Third placeholder will be empty or will contain information related to the process state step and line.

TAL Update Map File Failure

Message Text: "Unable to update map file for %s, received Exception type: %s. %s"


TAL returned an exception while making trying to update a flat map file (without option –t and –f). First placeholder will be the map name. Second placeholder will be the TAL exception message. Third placeholder will be empty or will contain information related to the process state step and line.

Known problem:

Periodic updates of Map File lead sooner or later to a congestion of the corresponding Oracle tablespace and so even if the successive deletion and creation of Map items do not increase at the end the global numbers of these items.

In such case a typical message looks like this:

Specialized Exception <n>CVR = %MCC-E-INTERNAL_ERROR, Hierarchy FM Abstract API Internal Error<n>CVRText = MAP DB API SaveMap service error<n>Explanation = ORA-01655: unable to extend cluster TEMIPMAP.ITEM_CLU by 1280 in tablespace DATA_TEMIPMAP<n>. (at line 1294 in file ndl_map.cxx)

The only way to prevent this Oracle failure is to extend dramatically the corresponding Oracle tablespace. Note that it will only delay the problem but won’t solve it for good.

6.4.4.4 Other Major Failure [3316-3325]

Security Failure

Message Text: "Security failure: Invalid username %s"


The TNDL has been activated by an unauthorized user. You must be root or temip. First placeholder will be the invalid username.

Corrective action will be to re-launch TNDL with authorized user rights.

161

License Failure

Message Text: "License failure: %s"


The TEMIP-NDL license is not active on the local director. The error message includes the message returned by the license management software, FlexLM. Load the TEMIP-NDL license. First placeholder will be the error message received.

162

Another TNDL Process is already Running …

Message Text: "A TeMIP Network Data Loader (PID = %s) is already running"


Another TNDL process is already running. First placeholder will be the PID or this TNDL process

Corrective action will be to re-launch the TNDL session later.

Unexpected Failure …

Message Text: "Unexpected exception condition encountered"


An unrecognized exception occurred.

Corrective action will be to report the problem to TeMIP support team.

Invalid Case Failure

Message Text: "Internal Error, Invalid Case Value: %s. %s"


Internal error occurred. First placeholder will be the invalid case value. Second placeholder will be empty or will contain information related to the process state step and line


Internal File Selection Failure

Message Text: "Internal Error, Invalid File Selection: %s, %s, %s"


Internal error occurred. Program trying to get an unrecognized file type. First placeholder will be the invalid file type. Second placeholder will be the directory location. Third placeholder will be the file state.


163

6.4.4.5 XML Major Failure [3400-3401]

XML Processing Failure

Message Text: "XML processing error: %s. %s"


XML processing error.


XML Transcoder Init Failure

Message Text: "XML Transcoder initialization failure: %s. %s"


XML Transcoder initialization failure.


6.4.5 Critical Messages [4001]

TeMIP Shutdown Signal Received

Message Text: "Shutdown Signal Received"


TeMIP posted a shutdown message.

Corrective action will be to check for TeMIP running state.

164

Chapter 7

Migration Tool on HP Tru64 UNIX

7.1 TNDL Migration Tool Most TeMIP customers have huge inventory databases (describing the configuration, the location and the characteristics of network elements) outside the TeMIP system.

As TNDL V5.0 changes its input file format (BNF to XML), the customers would have to migrate their whole TNDL input process. But this could not be done in one step:

• It is risky.

• The system is not operational over a long period.

• There are significant upgrading costs.

As a consequence, TNDL V5.0 proposes a Migration Tool in addition to the Data Loader Tool.

7.1.1 Functionality The Migration Tool converts TNDL V4.x input/reference files into TNDL V5.0 input files in order to maintain the compatibility with the old grammar. For each input/reference file, the XML corresponding file will be created.

165

Figure 5 Mapping between Old Input/Reference Files and Xml Files

7.1.2 Migration Tool Launch and Options Before running the Migration Tool, some environment variables should be set to indicate the resources location:

• TNDL_MIR_LOCATION: source directory of the Migration Tool (old BNF files location).

• TNDL_WORKSPACE: target directory of the Migration Tool (XML files location).

The Migration Tool must be activated with an authorized user. The Migration Tool is executed on the TeMIP Security environment; you must be root, temip or a valid TeMIP user.

To activate the Migration Tool enter the following command:

# /usr/opt/temip/bin/tndl_migrate [-Vnr] [-f hds map format] [-d dtd directory] [-g LogFileName] [-s LastFileName]

TndlV50_migrate

Log File

dataload.cf

config.xml map[_timestamp].xml

backdrop.cf

topology[_timestamp].xmlprofile[_timestamp].xml

class.cf

full_domain[_timeStamp].dat+

full_ne[_timeStamp].dat

166

Options:

• -V: prints TNDL’s version.

• -f <hds_map_format>: specifies the HDS map format (“Map_File” or “Oracle”)

• -d <dtd_directory>: indicates the location of the TNDL grammar definition files.

• -g <log_name>: indicates the name of the log file.

• -s <last_log>: indicates the name of the last log file.

The Migration Tool proposes two execution modes:

• –n : to migrate input files.

• –r : to migrate reference files.

If the TNDL_WORKSPACE variable is not set, it will be considered as equal to the TNDL_MIR_LOCATION variable.

If none of these two variables are set, the default directory will be: /var/opt/temip/TNDL.

Note

The TNDL_WORKSPACE variable is also used by TNDL V5.0 out of the Migration Tool pre-processing, so be careful while setting it.

The list of files you have to place in the source directory is:

• in -n mode

• TNDL_MIR_LOCATION/config/dataload.cf

• TNDL_MIR_LOCATION/input/backdrop.cf

• TNDL_MIR_LOCATION/input/full_domain_<timeStamp>.dat

• TNDL_MIR_LOCATION/input/full_ne_<timeStamp>.dat

• TNDL_MIR_LOCATION/input/full_domain_<timeStamp>.datok

• TNDL_MIR_LOCATION/input/full_ne_<timeStamp>.datok

• TNDL_MIR_LOCATION/input/class.cf

• in -r mode

• TNDL_MIR_LOCATION/config/dataload.cf

• TNDL_MIR_LOCATION/reference/backdrop.cf

• TNDL_MIR_LOCATION/reference/full_domain.dat

• TNDL_MIR_LOCATION/reference/full_ne.dat

• TNDL_MIR_LOCATION/reference/class.cf

The list of files generated in the target directory is:

• TNDL new input files:

• TNDL_WORKSPACE/config/config.xml,

• TNDL_WORKSPACE/input/map_<timeStamp>.xml

• TNDL_WORKSPACE/input/map_<timeStamp>.xmlok

• TNDL_WORKSPACE/input/topology_<timeStamp>.xml

• TNDL_WORKSPACE/input/topology_<timeStamp>.xmlok

167

• TNDL_WORKSPACE/input/profile_<timeStamp>.xml

• TNDL_WORKSPACE/input/profile_<timeStamp>.xmlok

Note

It is mandatory to have at least the input file dataload.cf present in the TNDL_MIR_LOCATION/config directory. This file must contain the TNS namespace, otherwise the tndl_migrate won’t start whatever the presence of any other input file(s). Other files are optional: if such input file is not present the corresponding xml file will not be generated. But if an input file is empty, the corresponding xml file will be generated as empty.

7.1.2.1 How to Use the Migration Tool The first use of TNDLV5.0 via the Migration Tool, should follow this procedure:

• migrate the TNDL reference files and config file (option –r).

• - launch the DataLoader tool in an -m mode to only generate corresponding expand files (No call to TeMIP performed). or

• launch the DataLoader tool in normal mode to repopulate TeMIP with network elements and maps and to regenerate reference files.

• migrate TNDL input files (option –n).

• launch the DataLoader in normal mode.

For other occasions, the first two steps are useless.

Figure 6 TNDL V4.1 Input Process

TNDL V4.x Input Files

TNDL V4.x Reference Files and Expanded Reference Files

DataLoader V4.x TeMIP V4

TAL

168

Compatibility Tool V4.x -> V5

TNDL V5 Reference Files

DataLoader V5

TNDL V5 Reference Files and

Expanded Reference Files

TNDL V4.x Reference Files

TAL TNDL V4.x Input Files Compatibility

Tool V4.x -> V5

TNDL V5 Input Files DataLoader

V5 TeMIP V5

TNDL V5 Reference Files and

Expanded Reference Files

Figure 7 TNDL V5.0 Two Phase Input Process

7.2 Migration Tool Messages The Migration Tool uses the same error format as the TNDL: the error format will contain the date and the time, the severity, the processing phase, the error number, a message text and the origin of the error.

A message will be displayed on a single line with following format:

{date} [message severity] {[process state]} {unique message number} {message text}(at line {line number} in file {file name})

where:

• {date}: current date will be in format: dd/mm/yyyy hh:mm:ss

169

• {message severity}: in INFORMATION, WARNING, MINOR, MAJOR, CRITICAL

• {process state}: in [Initialization], [Reading dataload.cf], [Writing config.xml], [Migrating class.cf], [Parsing name server instances], [ Migrating backdrop.cf], [Migrating full_domain.dat], [Migrating full_ne.dat], [Termination].

• {unique message number}: number on 3 digits with leading zeros that identify the message.

• {message Text}: message with placeholders replaced by run time values.

• {line number}: the line in source code file where message was logged.

• {file name}: file name of source code file where message was logged.

• Message texts are in the UNIX catalog file “ndl_m_messages.cat”.

A message text may contain placeholder that will be replaced at run time. The UNIX catalog file should be in the directory specified in NLSPATH environment variable. In case the UNIX catalog file is not present or inaccessible, an error message will be displayed to the standard error device, and the TNDL current process will be stopped.

Each message will be logged in two files, under the workspace directory (“/var/opt/temip/TNDL” by default or specified by the TNDL_WORKSPACE environment variable, see the Installation Guide for TNDL environment variables).

The default names of the log files are:

• dataload.last: which contains logging information of the last Migration Tool run.

• dataload.log: which contains logging information of historical TNDL and Migration Tool runs.

The name of the log files can be changed with command line option: –s and –g.

The exit status of the Migration Tool represents the level of success for the performed run:

• 0 : run completed without error and without warning.

• -1 : run completed without error but with warning(s).

• -2 : run failed with a minor exception.

• -3 : run failed with a major exception.

• -4 : run failed with a critical exception.

A warning does not cause the Migration Tool process to stop. Any error (minor, major, critical) is considered as fatal, and therefore causes the Migration Tool process to stop.

No recovery mechanism is provided in case of fatal errors.

7.2.1 Messages Message text is in the UNIX catalog file ndl_m_messages.cat. A message text may contain placeholder that will be replaced at run time. The UNIX catalog file should be in the directory specified in NLSPATH environment variable. In case the UNIX catalog file is not present or inaccessible, an

170

error message will be displayed to the standard error device, and the Migration Tool current process will be stopped.

7.2.2 Information Messages : [001-005]

Starting TNDL

Message Text: “Starting …”

Message Number: 001

Indicates the beginning of Migration Tool activation. The minimal operational conditions are met. Any error or warning prior to this stage is logged to the standard error device.

Completed Successfully

Message Text: “Completed Successfully”

Message Number: 004

Indicates that program succeeded.

End Message

Message Text: “Execution %s with %s warning and %s error”

Message Number: 005

Indicates the end of Migration Tool processing. First placeholder will be one of [success, aborted, stopped]. Second placeholder will contain the number of warnings for the run. Last placeholder will contain the number of errors for the run.

7.2.3 Warning Messages [104-121]

7.2.3.1 System Warnings [104-106]

Failure Removing File ….

Message Text: “Failure Removing File: %s. %s”

Message Number: 104

Indicates that program failed in trying to remove the file. First Placeholder will give the file name. The second one will give the Process State step.

171

Failure Renaming File …

Message Text: “Failure Renaming File: %s to: %s. %s”

Message Number: 105

Indicates that program failed in trying to rename the file. First Placeholder will give the original file name. The second one will give the destination file name. The third placeholder will give the Process State Step.

UNIX Command System Failure …


Message Number: 106


7.2.3.2 Invalid Migration Tool Input Warnings [107-118]

Global Configuration File Invalid Tag

Message Text: "Invalid Tag Specified in configuration file: %s, invalid Tag is: %s"

Message Number: 107

Migration Tool parsing the global configuration file, found an invalid tag. Valid tags are : “NAMESPACE”, “LINE WIDTH”, “LINE COLOR”, “FILL COLOR”, “TEXT COLOR”, “GRID ICONS PER LINE”, “GRID SPACING X”, “GRID SPACING Y”, “MAP ORDERING POLICY”, “NE ALPHASORT, “GRID START POSITION”. The invalid tag will be ignored. First placeholder will be the faulty file name. Second placeholder will be the invalid tag.

Corrective action will be to change the invalid tag in global configuration file, for next Migration Tool session.

172

Global Configuration File Invalid Numeric Value …

Message Text: "Invalid Numeric Value Specified in Configuration File : %s. Faulty value %s, replaced by default value: %s in line: %s. %s"

Message Number: 108

Migration Tool parsing the global configuration file found an invalid numeric value. First placeholder will be the configuration file name. Second placeholder will be the faulty value. Third placeholder will be the replacing value. Fourth placeholder will be the faulty line, used by Migration Tool. Fifth parameter will be information related to process state step and line.

Corrective action will be to change the invalid value in global configuration file, for next Migration Tool session.

Global Configuration File Invalid Alphanumeric Value

Message Text: "Invalid Alpha Numeric Value Specified in Configuration File: %s, Attribute: %s, value: %s, replaced by default value: %s in line: %s"

Message Number: 109

Migration Tool parsing the global configuration file found an invalid alphanumeric value. First placeholder will be the configuration file name. Second placeholder will be the concerned tag. Third placeholder will be the faulty value. Fourth placeholder will be the replacing value, used by Migration Tool. Fifth placeholder will be the faulty line.

Corrective action will be to change the invalid value in global configuration file, for next Migration Tool session.

Entity Attribute Re-Definition

Message Text: "%s redefined in line: %s. %s"

Message Number: 112

The specified TNDL-attribute is defined more than once. The Migration Tool uses the first definition of the TNDL-attribute. First placeholder will be the type of attribute (location, coordinates, URL). Second placeholder will be the line as given by the process state line. The third placeholder will be information related to process state step and line.

Corrective action will be to modify the next input topology file to keep only one definition of the TNDL-attribute. Use the entity name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

173

Duplicated Attribute Definition Ignored

Message Text: "Duplicate %s definition ignored in line: %s. %s"

Message Number: 113

The specified TNDL-attribute is defined more than once. The Migration Tool uses the first definition of the TNDL-attribute. This specification will therefore be ignored. First placeholder will be the type of attribute (location, coordinates, url, …). Second placeholder will be the line as given by the process state line. The third placeholder will be information related to process state step and line.

Corrective action will be to modify the next input topology file to keep only one definition of the TNDL-attribute. Use the entity name to search the record. The line number specified in the state message might be out of scope if the input topology file has already been modified to include new network elements or domains.

Invalid Numeric Value Provided

Message Text: "Invalid Numeric Value Specified. %s: %s, replace by default value: %s in line: %s. %s"

Message Number: 117

An invalid numeric value was provided. First placeholder will be the argument name (Ring width, Line width). Second placeholder will be the invalid numeric value provided. Third placeholder will be the replacing default value. Fourth placeholder will be the faulty line, where the invalid numeric value is marked with “<>”.

Corrective action will be to modify the next input topology file to change the invalid numeric value.

Invalid Alphanumeric Value Provided

Message Text: "Invalid Alpha Numeric Value Specified. File: %s, Attribute: %s, value: %s, replace by default value: %s in line: %s"

Message Number: 118

An invalid alphanumeric value was provided. First placeholder will be the file name. Second placeholder will be the argument name. Third placeholder will be the invalid alphanumeric value provided. Fourth placeholder will be the replacing default value. Fifth placeholder will be the faulty line, where the invalid alphanumeric value is marked with “<>”.

Corrective action will be to modify the next input topology file to change the invalid alphanumeric value.

174

7.2.4 TeMIP Warnings [119-121]

TAL Unexpected Failure


Message Number: 119

TAL returned an exception, but migration tool process continues. First placeholder will be the TAL exception message. Second placeholder will be empty or will contain information related to the process state step and line

Other TeMIP Signal Received

Message Text: " Other Temip Signal Received"

Message Number: 120

A TeMIP signal was received.

TAL Request Warning

Message Text: "%s, WARNING: %s. %s"

Message Number: 121

The operational status of the latest execution of the TAL directive (create, alias, register, set, delete, unalias, deregister) is warning. Possible causes are : entity already exists in TeMIP (create, register …), entity does not exist in TeMIP (delete, deregister) ….

First placeholder will be the full directive string. Second placeholder will be the TAL failure message. Third placeholder will be information related to process state step and line.

175

7.2.5 Minor Message [202]

Invalid Line Syntax Failure

Message Text: "%s at line: %s. %s"

Message Number: 202

Syntax error in line from Migration Tool input file. First placeholder will give the problem description. Second placeholder is the faulty line which is marked with “<>” at the start position of the incorrect syntax. Third placeholder will be empty or will contain information related to the process state step and line

Problem Description will be in the list : "Missing “(“ at beginning", "Incomplete entity definition", "Missing ")" at the end", "Missing separator", "Invalid Entity name definition", "Incomplete entity definition", "Missing separator or attribute value", "Invalid MSL attribute name definition", "Incomplete MSL attribute definition", "Invalid MSL attribute value", "Invalid TNDL attributes definition", "Incomplete entity definition", "Unknown TNDL attribute", "Shortcut not supported for non-domain entities", "Shelf association not supported for domain entities", "Invalid TNDL attributes definition", "Invalid views graph list definition 1", "Unknown views graph list attribute", "Invalid views graph list definition 2", "Incomplete coordinates definition", "Invalid coordinates definition", "Incomplete map coordinates definition", "Invalid map coordinates definition", "Incomplete location definition", "Incomplete technology definition", "Incomplete Managing director definition", "Incomplete associated shelf definition", "Invalid shelf definition”, "Incomplete URL definition", "Incomplete Nickname definition", "Incomplete Layers definition", "Invalid layers list definition", "Incomplete Collection Domain definition", "Invalid collection domains list definition", "Incomplete Visualization Domain definition", "Invalid visualization domains definition", "Incomplete Shelf Views definition", "Invalid shelf views definition", "Invalid shelf view name", "Invalid shelf view characteristics definition”, "Non-shortcut representation not supported for domain entities in shelf views", "Incomplete Domains definition", ….

7.2.6 Major Messages [301-322]

7.2.6.1 System Major Failure [301-307]

Cannot get Migration Tool Process PID …

Message Text: "Cannot get PID"

Message Number: 301

Cannot get the current process PID

176

Opening File Failure …

Message Text: "Cannot open file with mode: %s file: %s. %s"

Message Number: 302

Cannot open file failure. First placeholder will be the opening mode (“in/no create”, “out/ate”, “out”, “PID”). Second placeholder will be the filename. Third placeholder will be empty or contain information related to the process state step.

Corrective action will be to verify that file exists and has correct access mode.

Reading File Failure …

Message Text: "Error reading file: %s. %s"

Message Number: 303

Cannot read file failure. First placeholder will be the faulty file name. Second placeholder will be empty or contain information related to the process state step and line.


Copying File Failure …

Message Text: "Unable to copy file from: %s to: %s. %s"

Message Number: 305

Could not copy file. First placeholder will be original file. Second placeholder will be the destination file. Third placeholder will be empty or contain information related to process state step.

Corrective action will be to verify for directory structure and available disk space

UNIX Command System Failure ….


Message Number: 307


177

7.2.6.2 TeMIP Major Failure [310-311]

Initialization Failure …

Message Text: "TeMIP Initialization failure"

Message Number: 310

Bad initialization of your connection with TeMIP TAL.

TAL Unexpected Failure …


Message Number: 311

An unexpected TAL failure occurred, that stopped the migration tool process. First placeholder will be the TAL exception message. Second placeholder will be empty or will contain information related to the process state step and line

7.2.6.3 Other Major Failure [316-322]

Security Failure

Message Text: "Security failure: Invalid username %s"

Message Number: 316

An unauthorized user has activated the Migration Tool. You must be root or temip. First placeholder will be the invalid username.

Corrective action will be to re-launch Migration Tool with authorized user rights

License Failure

Message Text: "License failure: %s"

Message Number: 317

The migration tool license is not active on the local director. The error message includes the message returned by the license management software, FlexLM. Load the migration tool license. First placeholder will be the error message received.

178

Another Migration Tool Process is Already Running …

Message Text: "A Migration Tool (PID = %s) is already running"

Message Number: 318

Another migration tool process is already running.

First placeholder will be the PID or this migration tool process

Corrective action will be to re-launch the migration tool session later.

Unexpected Failure …

Message Text: "Unexpected exception condition encountered"

Message Number: 319

An unrecognized exception occurred.

Internal Invalid Case Failure

Message Text: "Internal Error, Invalid Case Value: %s. %s"

Message Number: 320

Internal error occurred. First placeholder will be the invalid case value. Second placeholder will be empty or will contain information related to the process state step and line.

Internal File Selection Failure

Message Text: "Internal Error, Invalid File Selection: %s, %s, %s"

Message Number: 322

Internal error occurred. Program trying to get an unrecognized file type. First placeholder will be the invalid file type. Second placeholder will be the directory location. Third placeholder will be the file state.

7.2.7 Critical Messages [401-402]

TeMIP Shutdown Signal Received

Message Text: "Shutdown Signal Received"

Message Number: 401

TeMIP posted a shutdown message.

Corrective action will be to check for TeMIP running state.

179

TAL Request Fatal Failure

Message Text: "%s, FATAL: %s. %s"

Message Number: 402

the operational status of the latest execution of the TAL directive (create, alias, register, set, delete, unalias, deregister) is fatal but recoverable. Possible causes are: entity already exists in TeMIP (create, register), entity does not exist in TeMIP (delete, deregister).


180

Chapter 8

Usage Recommendations

8.1 TNDL and TNS Confidence Level It is recommended to set the “TNS confidence level” to “High” (on all TeMIP directors) before each Data Loader run in case you are in a TNS Master + Replica servers configuration.

If you do not set the “TNS confidence level” to “High”, you may face to pure TNS/registration limitation problems. In fact, the TNS master server propagates data changes to replica servers 5 seconds (by default) later in order to group several changes.

8.2 Special Characters for Attribute Value To put special characters (commas, double quotes, quotes, space) when setting attributes with the TNDL, use doubles quotes at the beginning and at the end of the attribute value.

Warning: The attribute type must be a string (Datatype =Lating1string).

The following example shows how to set the characters comma and space for an attribute value.

<Tndl_Element> <Entity> <Name>BSS BSSTest1</Name> <Attributes> <Attribute> <Name>BSS Equipment Manufacturer</Name> <Value>" manufacturer1, manufacturer2 "</Value> </Attribute> <Attribute> <Name>Location</Name> <Value>"Paris, Avenue de la paix"</Value> </Attribute> <Attribute> <Name>Remarks</Name> <Value>"remark1,remark2,"</Value> </Attribute> <Attribute> <Name>Responsible Person</Name> <Value>"Dupont Martin"</Value> </Attribute> </Attributes>

181

</Entity> </Tndl_Element>

Result in TeMIP after the TNDL Run

TeMIP> show BSS BSSTest1 all attr

BSS test_ns:.BSSTest1 On director: test_ns:.temip.test_director … Managing Director = -- Attribute Not Available BSS Name = test_ns:.BSSTest1 BSS Equipment Manufacturer = " manufacturer1, manufacturer2 " BSS Location = -- Attribute Not Available BSC Type = -- Attribute Not Available BSC Errors Ceased = 0 Errors Defined Channels = -- Attribute Not Available Available Channels = -- Attribute Not Available Call Attempts = -- Attribute Not Available TCH Busy Hour = Thu Feb 22 13:04:29 BSS Info = ( MaintenanceVersion = V2.0.0, CreationDate = Thu Feb 22 13:04:29, TextInfo = "No Remarks" ) Sent Attribute Value Change Events = 1 BSS Admin State = Unlocked Location = "Paris, Avenue de la paix" Implementation Desc = -- Attribute Not Available Responsible Person = "Dupond Martin" Phone Number = -- Attribute Not Available MAIL Account = -- Attribute Not Available Remarks = "remark1,remark2," Text File = -- Attribute Not Available Communication Alarms Received = -- Attribute Not Available Environmental Alarms Received = -- Attribute Not Available Equipment Alarms Received = -- Attribute Not Available Processing Error Alarms Received = -- Attribute Not Available Quality Of Service Alarms Received = -- Attribute Not Available Number Of Suspend = -- Attribute Not Available

8.3 Special Characters for Entity Name The following example shows how to set an entity name that contains a Latin1String identifier.

<Tndl_Element> <Entity> <Name>OSI_SYSTEM .mon_osi_idf TESTOBJ "t0_bsm S10213"</Name> </Entity> </Tndl_Element>

182

8.4 Special Characters for XML Some characters have a special meaning in XML and cannot be used directly in texts: the left angle bracket, ampersand, and other delimiters. A set of general definitions, called Predefined Entities, is specified for this purpose (amp, lt, gt, apos, quot). Numeric character references may also be used; they are expanded immediately when recognized and treated as character data, so the numeric character references "<” and “&” may be used to escape < and & when they occur in character data.

Character XML Representation < < > > & & ‘ ' “ "

183

Appendix A

Samples of the Log File The log file for the TNDL contains activation messages issued at the beginning and end of an activation, and may include state, warning, and error messages issued during the activation. The examples in this appendix each show a complete log file and indicate the types of message present.

A.1 Success Log The following example shows the basic three activation messages for a successful activation of the TNDL.

mm/dd/yy hh:mm:ss [INFORMATION] [init/process] 0001 Starting ... (at line XXX in file ndl_main.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0004 Completed successfully (at line XXX in file ndl_main.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0006 Execution success with 0 warning and 0 error. 30 entities created, 0 entities modified, 0 entities deleted. (at line XXX in file ndl_main.cxx)

A.2 One Warning The following example shows a data load completed with a warning.

mm/dd/yy hh:mm:ss [INFORMATION] [init/process] 0001 Starting ... (at line XXX in file ndl_main.cxx) mm/dd/yy hh:mm:ss [WARNING] [topology_update/undefined] 1321 CREATE Domain domain2 , WARNING: Attempt to create duplicate entity rejected.<n>. Step: MIR Update, file: /var/opt/temip/TNDL/tmp/delta_entities_$TIMESTAMP.xml, current: DOMAIN domain2 (at line XXX in file ndl_temip_directive.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0006 Execution aborted with 1 warning and 0 error. 2 entities created, 0 entities modified, 0 entities deleted. (at line XXX in file ndl_main.cxx)

185

A.3 TNDL Stop and Resumption The following example shows data load stopped by a temip_stop command and then resumed.

19/01/2001 12:40:52 [INFORMATION] [init/process] 0001 Starting ... (at line XXX in file dltt.cxx) 19/01/2001 12:40:52 [INFORMATION] [init/process] 0003 Resuming.Resuming TNDL at step: 1, file type: 1, line number: 1, NE time stamp: 20001218000000, domain time stamp: 20001218000000 (at line 415 in file ProcessState.cxx) 19/01/2001 12:41:03 [INFORMATION] [stop/process] 0004 Completed successfully (at line XXX in file dltt.cxx) 19/01/2001 12:41:03 [INFORMATION] [stop/process] 0006 Execution success with 0 warning and 0 error. 2 entities created, 0 entities modified, 0 entities deleted. (at line XXXin file ndl_main.cxx)

A.4 Parsing Error The following example shows a parsing error. Entity loading did not start, and so no recovery file "dataload.rec" was created. The parsing error is fatal and so the TNDL aborts.

mm/dd/yy hh:mm:ss [INFORMATION] [init/process] 0001 Starting ... (at line XXX in file ndl_main.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [init/undefined] 0010 Start Initialization (at line XXXin file ndl_dataloader.cxx) mm/dd/yy hh:mm:ss [MAJOR] [expand/undefined] 3102 Error on XML parsing. SystemId: /var/opt/temip/TNDL/tmp/topology_$TIMESTAMP.xml, line: 12, column: 16, Element 'Tag' is not valid for content model: '(Name,Tag)'. Step: Expansion, file: /var/opt/temip/TNDL /tmp/topology_$TIMESTAMP.xml (at line XXX in file ndl_xml_util.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0005 Execution aborted with 0 warning and 1 error (at line XXX in file ndl_main.cxx)

A.5 Fatal Error and Recovery The following example shows an activation that aborts with a fatal error message, and subsequent successful activation in recovery mode.

mm/dd/yy hh:mm:ss [INFORMATION] [init/process] 0001 Starting ... (at line XXX in file dltt.cxx) mm/dd/yy hh:mm:ss [MAJOR] [map_update/network_element] 0314 Unable to retrieve map for Domain .domain_test, received Exception type: Specialized Exception. (at line XXX in file MapNT.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0006 Execution aborted with

186

0 warning and 1 error (at line XXX in file dltt.cxx) … mm/dd/yy hh:mm:ss [INFORMATION] [init/process] 0001 Starting ... (at line XXX in file ndl_main.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [init/process] 0003 Resuming.Resuming TNDL at step: 1, file type: 1, line number: 1, NE time stamp: 20001218000000, domain time stamp: 20001218000000 (at line XXX in file ndl_process_state.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0004 Completed successfully (at line XXX in file ndl_main.cxx) mm/dd/yy hh:mm:ss [INFORMATION] [stop/process] 0006 Execution success with 0 warning and 0 error. 5 entities created, 0 entities modified, 0 entities deleted. (at line XXX in file ndl_main.cxx)

187

Appendix B

DTD Syntax

B.1 ELEMENT Declaration • <!ELEMENT element1 (element2, element3)>

element1 is composed by element2 followed by element3

• <!ELEMENT element1 (element2 | element3)> element1 is composed element2 or element3

• <!ELEMENT element1 (element2 ?)> element1 is composed by 0 or one element2

• <!ELEMENT element1 (element2 *)> element1 is composed by 0 or several element2

• <!ELEMENT element1 (element2 +)> element1 is composed by 1 or several element2

• <!ELEMENT element1 (#PCDATA)> element1 is composed by "parsable" characters

• <!ELEMENT element1 EMPTY> element1 is always empty

• <!ELEMENT element1 ANY> element1 contains any element defined in DTD or (#PCDATA)

B.2 ENTITY Declaration • <!ENTITY % entity_name "substitute_string">

parameter entity used in DTD

B.3 Attribute Declaration A list of attribute may be associated to an element.

An attribute is composed of an attribute name, a type and a default value.

• Syntax: <!ATTLIST element_name attribute_name type default_value> <!ATTLIST element_name attribute_name type default_value attribute_name type default_value .... >

• Attribute type

• (value1 | value2 | ...) list of possible values for the attribute

189

• CDATA non "parsed" text

• ID unique identifier

• IDREF reference to an unique identifier of the document

• ENTITY entity name of the DTD.

• NOTATION name of a notation (reference to a non XML entity)

• ...

• Attribute default value

• #REQUIRED attribute value is mandatory

• #IMPLIED attribute value is optional

• "defaultValue"

• #FIXED "fixedValue"

190

Appendix C

Configuration File DTD This Appendix defines the DTD grammar of the configuration file.

The root element of the Configuration file is <Configuration_Elements>.

<?xml encoding="ISO-8859-1"?> <!ELEMENT Configuration_Elements ( Temip_Name_Space?, Name_Server?, Default_Map_Format?, Line_Width?, Line_Color?, Fill_Color?, Text_Color?, Grid_Start_Position?, Grid_Spacing?, Grid_Icons_Per_Line?, Map_Ordering_Policy?, Network_Element_Alphasort?, Publish_Resource_Command?)> <!ELEMENT Temip_Name_Space (#PCDATA)> <!ELEMENT Temip_Name (#PCDATA)> <!ELEMENT Default_Map_Format (#PCDATA)> <!ELEMENT Name_Server (#PCDATA)> <!ELEMENT Grid_Icons_Per_Line (#PCDATA)> <!ELEMENT Grid_Spacing (Value)> <!ELEMENT Value EMPTY> <!ATTLIST Value X CDATA #REQUIRED Y CDATA #REQUIRED> <!ELEMENT Line_Width (#PCDATA)> <!ELEMENT Line_Color (Color)> <!ELEMENT Color EMPTY> <!ATTLIST Color Red CDATA #REQUIRED Green CDATA #REQUIRED Blue CDATA #REQUIRED> <!ELEMENT Fill_Color (Color)> <!ELEMENT Text_Color (Color)> <!ELEMENT Map_Ordering_Policy (#PCDATA)> <!ELEMENT Network_Element_Alphasort (#PCDATA)> <!ELEMENT Grid_Start_Position (Point)> <!ELEMENT Point EMPTY> <!ATTLIST Point X CDATA #REQUIRED Y CDATA #REQUIRED> <!ELEMENT Publish_Resource_Command (#PCDATA)>

191

Appendix D

Topology/Map/Profile File DTD This Appendix defines the common DTD grammar of the topology, map and profile files.

The root element of the Topology file is <Topology_Elements>.

The root element of the Map file is <Maps>.

The root element of the Profile file is <Profiles>.

<?xml encoding="ISO-8859-1"?> <!ENTITY % ELEMENT_GROUP "Element"> <!ENTITY % ENTITY_GROUP "Attributes?, Synonyms?, Element?, Member?"> <!ENTITY % GRAPHICAL_REPRESENTATION_GROUP "Center_Coordinates?, Name?, Layer?, Matched_Filters?, Associated_URL?, Sticker?, Url_Properties?, Url_Position?, Graphical_Type?"> <!ELEMENT Profiles (Profile*)> <!ELEMENT Profile (Name, Coordinates_Attribute?, Graphical_Representation?)> <!ELEMENT Name (#PCDATA)> <!ELEMENT Coordinates_Attribute (#PCDATA)> <!ELEMENT Topology_Elements (Domains?, Tndl_Elements?)> <!ELEMENT Domains (Domain+)> <!ELEMENT Domain (Entity, Map_Items?)> <!ELEMENT Tndl_Elements (Tndl_Element*, Wildcarded_Element*, Scoped_Element*)> <!ELEMENT Tndl_Element (Entity?, Map_Items?)> <!ELEMENT Scoped_Element (Scoped_Operation?, Name, %ELEMENT_GROUP;)> <!ATTLIST Scoped_Element Type (Base_Object | One_Level_Down | Whole_Subtree | Nth_Sub_Level | To_Nth_Sub_Level) #IMPLIED Depth CDATA #IMPLIED > <!ELEMENT Previous_Scoped_Element (%ELEMENT_GROUP;)> <!ATTLIST Previous_Scoped_Element Type (Base_Object | One_Level_Down | Whole_Subtree | Nth_Sub_Level | To_Nth_Sub_Level) #IMPLIED Depth CDATA #IMPLIED > <!ELEMENT Scoped_Operation (Previous_Scoped_Element?)> <!ATTLIST Scoped_Operation Action (Delete | Insert | Modify) #REQUIRED > <!ELEMENT Wildcarded_Element (Wildcarded_Operation?, Name, %ELEMENT_GROUP;)>

193

<!ELEMENT Previous_Wildcarded_Element (%ELEMENT_GROUP;)> <!ELEMENT Wildcarded_Operation (Previous_Wildcarded_Element?)> <!ATTLIST Wildcarded_Operation Action (Delete | Insert | Modify) #REQUIRED > <!ELEMENT Entity (Entity_Operation?, Name, %ENTITY_GROUP;)> <!ELEMENT Previous_Entity (%ENTITY_GROUP;)> <!ELEMENT Entity_Operation (Previous_Entity?)> <!ATTLIST Entity_Operation Action (Delete | Insert | Modify) #REQUIRED > <!ELEMENT Attributes (Attribute+)> <!ELEMENT Attribute (Name, Value)> <!ELEMENT Value (#PCDATA)> <!ELEMENT Member (Of+)> <!ELEMENT Element (Of+)> <!ELEMENT Of (#PCDATA)> <!ELEMENT Synonyms (ASCIISynonym*, OSIDNSynonym*)> <!ATTLIST Synonyms Name_Server CDATA #IMPLIED > <!ELEMENT ASCIISynonym (Name, Tag)> <!ELEMENT Tag (#PCDATA)> <!ELEMENT OSIDNSynonym (#PCDATA)> <!ELEMENT Map_Items (Default_Graphical_Representation?, Map_Item+)> <!ELEMENT Default_Graphical_Representation (%GRAPHICAL_REPRESENTATION_GROUP;)> <!ELEMENT Map_Item (Operation?, Id?, Map_Name?, Graphical_Profile?, Associated_Entity?, Associated_Map?, Severity_Display?, Parent_Propagation?, Synonym_Tag?, Date_Range?, Validity_String?, Graphical_Representation?)> <!ELEMENT Operation EMPTY> <!ATTLIST Operation Action (Delete | Insert | Modify) #REQUIRED > <!ELEMENT Id (#PCDATA)> <!ELEMENT Map_Name (#PCDATA)> <!ELEMENT Graphical_Profile (#PCDATA)> <!ELEMENT Associated_Entity (#PCDATA)> <!ELEMENT Associated_Map (#PCDATA)> <!ATTLIST Associated_Map Associated_MapType (Submap | Transient | Default | Shortcut) "Default" Associated_Hierarchy CDATA #IMPLIED > <!ELEMENT Severity_Display (Severity+)> <!ELEMENT Severity EMPTY> <!ATTLIST Severity Type (Own | Child | Submap) #REQUIRED > <!ELEMENT Parent_Propagation (#PCDATA)> <!ELEMENT Synonym_Tag (#PCDATA)> <!ELEMENT Date_Range (Begin_Date, End_Date)> <!ELEMENT Begin_Date (#PCDATA)> <!ELEMENT End_Date (#PCDATA)> <!ELEMENT Validity_String (#PCDATA)> <!ELEMENT Center_Coordinates (Graphical_Coordinates | Geographical_Coordinates | Lambert_Coordinates | Automatic)> <!ELEMENT Graphical_Coordinates EMPTY> <!ATTLIST Graphical_Coordinates X CDATA #REQUIRED Y CDATA #REQUIRED > <!ELEMENT Geographical_Coordinates EMPTY>

194

<!ATTLIST Geographical_Coordinates Latitude CDATA #REQUIRED Longitude CDATA #REQUIRED > <!ELEMENT Lambert_Coordinates EMPTY> <!ATTLIST Lambert_Coordinates X CDATA #REQUIRED Y CDATA #REQUIRED > <!ELEMENT Automatic EMPTY> <!ELEMENT Graphical_Representation (%GRAPHICAL_REPRESENTATION_GROUP;)> <!ELEMENT Layer (#PCDATA)> <!ELEMENT Matched_Filters (Identifier+)> <!ELEMENT Identifier (#PCDATA)> <!ELEMENT Associated_URL (#PCDATA)> <!ELEMENT Sticker (#PCDATA)> <!ELEMENT Url_Properties (Font_Color?, Font_Size?, Font_Modifier?, Font_Name?, Text_Is_Visible?)> <!ELEMENT Font_Color (Color)> <!ELEMENT Color EMPTY> <!ATTLIST Color Red CDATA #REQUIRED Green CDATA #REQUIRED Blue CDATA #REQUIRED > <!ELEMENT Font_Size (#PCDATA)> <!ELEMENT Font_Modifier EMPTY> <!ATTLIST Font_Modifier Italic (True | False) #REQUIRED Bold (True | False) #REQUIRED Underlined (True | False) #REQUIRED > <!ELEMENT Font_Name (#PCDATA)> <!ELEMENT Text_Is_Visible (#PCDATA)> <!ELEMENT Url_Position (Point)> <!ELEMENT Point EMPTY> <!ATTLIST Point X CDATA #REQUIRED Y CDATA #REQUIRED > <!ELEMENT Graphical_Type (Node | Extended | Connector)> <!ELEMENT Node (Position?, Scale?, Rotation_Angle?, Associated_Symbol?, Connection_Points?, Zoomable?)> <!ELEMENT Position (Point)> <!ELEMENT Scale EMPTY> <!ATTLIST Scale X CDATA #REQUIRED Y CDATA #REQUIRED > <!ELEMENT Rotation_Angle (#PCDATA)> <!ELEMENT Associated_Symbol (#PCDATA)> <!ELEMENT Connection_Points (Point+)> <!ELEMENT Zoomable (#PCDATA)> <!ELEMENT Extended (Color?, Extended_Type)> <!ELEMENT Extended_Type (Lined_Item | Text_Item)> <!ELEMENT Lined_Item (Line_Type, Line_Style?, Double_Line?, Line_Width?, End_Points?, Line_Start_Point_Style?, Line_End_Point_Style?, Closed_Figure?, Fill_Style?, Pattern_Style?, Fill_Color_Background?, Fill_Color_Foreground?)> <!ELEMENT Line_Type (#PCDATA)> <!ELEMENT Line_Style (#PCDATA)> <!ELEMENT Double_Line (#PCDATA)> <!ELEMENT Line_Width (#PCDATA)>

195

<!ELEMENT End_Points (Point+)> <!ELEMENT Line_Start_Point_Style (#PCDATA)> <!ELEMENT Line_End_Point_Style (#PCDATA)> <!ELEMENT Closed_Figure (#PCDATA)> <!ELEMENT Fill_Style (#PCDATA)> <!ELEMENT Pattern_Style (#PCDATA)> <!ELEMENT Fill_Color_Background (Color)> <!ELEMENT Fill_Color_Foreground (Color)> <!ELEMENT Text_Item (Text_Position?, Text?, Text_Is_Visible?, Font_Name?, Font_Size?, Font_Modifier?)> <!ELEMENT Text_Position (Point)> <!ELEMENT Text (#PCDATA)> <!ELEMENT Connector (Connector_Ends?, Connector_Lines?, Connector_Path?, Connector_Style?, Connector_Ends_Style?, Start_Symbol?, Middle_Symbol?, End_Symbol?)> <!ELEMENT Connector_Ends (Connector_End+)> <!ELEMENT Connector_End (End_Point | (End_ObjectID, Object_ConnectionID?))> <!ELEMENT End_Point (Point)> <!ELEMENT End_ObjectID (#PCDATA)> <!ELEMENT Object_ConnectionID (#PCDATA)> <!ELEMENT Connector_Lines (Line_Desc+)> <!ELEMENT Line_Desc (Line_Width?, Color?)> <!ELEMENT Connector_Path (Point+)> <!ELEMENT Connector_Style (#PCDATA)> <!ELEMENT Connector_Ends_Style (#PCDATA)> <!ELEMENT Start_Symbol (Name, Symbol_Position_Behaviour)> <!ELEMENT Symbol_Position_Behaviour (#PCDATA)> <!ELEMENT Middle_Symbol (Name, Symbol_Position_Behaviour)> <!ELEMENT End_Symbol (Name, Symbol_Position_Behaviour)> <!ELEMENT Maps (Map*)> <!ELEMENT Map (Map_Header?, Map_Items?)> <!ELEMENT Map_Header (Operation?, Map_Name, Positioning_Type?, Coordinates_Referential?, Geographical_Coordinates_Referential?, Backdrop_Type?, Backdrop_Name?, Format?, Defined_Viewports?, Defined_Filters?, Current_Layer?, Associated_Entity?, Is_Top_Map?, Default_Text_Properties?, Default_Url_Properties?, Map_Sticker?, Coordinates_Units?, Layers?)> <!ELEMENT Positioning_Type (#PCDATA)> <!ELEMENT Geographical_Coordinates_Referential (Geographical_Lower_Left, Geographical_Upper_Right)> <!ELEMENT Geographical_Lower_Left (Geographical_Coordinates | Lambert_Coordinates)> <!ELEMENT Geographical_Upper_Right (Geographical_Coordinates | Lambert_Coordinates)> <!ELEMENT Format (#PCDATA)> <!ELEMENT Coordinates_Referential (Lower_Left_Corner, Upper_Right_Corner)> <!ELEMENT Lower_Left_Corner (Point)> <!ELEMENT Upper_Right_Corner (Point)> <!ELEMENT Defined_Viewports (Defined_Viewport+)> <!ELEMENT Defined_Viewport (Name, RefPoint, Zoom, RefPointType)> <!ELEMENT RefPoint (Point)> <!ELEMENT Zoom (#PCDATA)> <!ELEMENT RefPointType (#PCDATA)> <!ELEMENT Defined_Filters (Filter+)> <!ELEMENT Filter (Name, Identifier)> <!ELEMENT Current_Layer (#PCDATA)> <!ELEMENT Backdrop_Type (#PCDATA)> <!ELEMENT Backdrop_Name (#PCDATA)> <!ELEMENT Is_Top_Map (#PCDATA)> <!ELEMENT Default_Text_Properties (Font_Color?, Font_Size?, Font_Modifier?, Font_Name?, Text_Is_Visible?)> <!ELEMENT Default_Url_Properties (Font_Color?, Font_Size?, Font_Modifier?,

196

Font_Name?, Text_Is_Visible?)> <!ELEMENT Map_Sticker (#PCDATA)> <!ELEMENT Coordinates_Units (#PCDATA)> <!ELEMENT Layers (Layer_Description+)> <!ELEMENT Layer_Description (Id, Name, Minimum_Zoom?, Maximum_Zoom?, Detectability?, Visibility?, Backdrop_Tiles?)> <!ELEMENT Backdrop_Tiles (Tile+)> <!ELEMENT Tile (File, Low_Left_Extent, Upper_Right_Extent)> <!ELEMENT Minimum_Zoom (#PCDATA)> <!ELEMENT Maximum_Zoom (#PCDATA)> <!ELEMENT Detectability (#PCDATA)> <!ELEMENT Visibility (#PCDATA)> <!ELEMENT File (#PCDATA)> <!ELEMENT Low_Left_Extent (Point)> <!ELEMENT Upper_Right_Extent (Point)>

197

Appendix E

Data Conversion Classes This appendix gives details of the datatypes, constructors, operators, and methods of the example Data Conversion classes: CVBackdrop, TCVEntity, TCVEntitySpec, TCVMember, TCVBaseGraphics, TCVGraphics, TCVAbstractContainent, TCVAbstractMap, TCVMap, TCVAbstractContainerItem and TCVMapItem.

The Data Converter classes are split into two categories.

The first allows you to construct and to dump TeMIP entities (TCVEntity, TCVEntitySpec, TCVMember).

The second allows you to construct and to dump maps and their items (TCVAbstractContainent, TCVAbstractMap, TCVMap, CVBackdrop, TCVAbstractContainerItem and TCVMapItem).

Figure 8 Data Conversion Main Classes

TCVAbstractContainerItem

TCVGraphic

TCVAbstractContainment

TCVEntity

0 1 TCVAbstractMap

TCVMapItem

TCVMap

TCVIcon TCVPolylineLine TCViLineTCVText TCVRing

0 1

0 1

0 1

0 1

CVBackdrop 0 1

199

E.1 TCVEntity Class A TCVEntity object represents any TeMIP entity that will be maintained using the TeMIP Network Data Loader. The methods defined in this class manage attributes and membership (using the TCVMember object).

Constructors

TCVEntity(const TCVEntitySpec &entitySpecRef)

The entity name is defined as an Entity Spec.

TCVEntity()

Creates an empty entity object.

Operators

Assignment operators: TCVEntity& operator=(const TCVEntity &EntityRef) TCVEntity& operator=(const TCVEntity *EntPtr)

Dump to file operator: ostream& operator<<(ostream&, const TCVEntity&)

Equality operator: RWBoolean operator ==(const TCVEntity&) const

Methods

Appendvoid Append(const RWCString &classRef, const RWCString &valueRef)

Adds a class/instance pair to the entity definition.

Clearvoid TCVEntity::Clear()

Clears entity name, membership.

Depthsize_t Depth()

Gets the depth of the entity.

Dumpfriend ostream& operator<<(ostream& stream, const TCVEntity& Entity)

Dumps the entity definition to a file in TNDL input format.

SetAttributevoid TCVEntity::SetAttribute(const RWCString& AttributeName, const RWCString& AttributeValue)

Sets an MSL attribute name and value for the entity.

SetMembervoid TCVEntity:SetMember(const TCVMember *MemberPtr)

Creates a membership relation for the entity.

Note

Do not create several membership relations within the same TeMIP domain.

200

SetNamevoid TCVEntity::SetName(const TCVEntitySpec &entitySpecRef)

Sets the entity name; does not affect attributes or membership.

GetTNDLNameRWCString TCVEntity::GetTNDLName() const

Returns the entity name in TNDL format (example: "Operation Context", "MyOC").

GetFullNameRWCString TCVEntity::GetFullName() const

Returns the entity name in TeMIP format (example: Operation Context MyOC).

GetClassRWCString GetClass(const unsigned int ) const;

Returns the class name.

GetInstanceRWCString GetInstance(const unsigned int ) const;

Returns the instance name.

SetInstanceRWCString GetInstance(const unsigned int ) const;

Returns the instance name.

GetEntitySpecTCVEntitySpec GetEntitySpec() const {return entitySpec_;}

Returns the entitySpec attribute.

GetAttributeTCVEntitySpec GetEntitySpec() const {return entitySpec_;}


UpdateAttributeTCVEntitySpec GetEntitySpec() const {return entitySpec_;}


RemoveAttribute RWBoolean RemoveAttribute(TCVAttribute&);

Removes an attribute.

AppendToAttribute void AppendToAttribute(const RWCString& ,const RWCString&, TCVAttribute::TCVAttributeType);

Appends a value to an attribute of set of type.

RemoveFromAttribute RWBoolean RemoveFromAttribute(const RWCString& ,const RWCString& , TCVAttribute::TCVAttributeType);

Removes a value from an attribute of set of type.

GetElements RWTValSlist<TCVMember>& GetElements()

Returns the list of elements.

GetElement RWBoolean GetElement(const RWCString &, TCVMember&) const;

201

Gets a specific element.

SetElement void SetElement(const TCVMember *);

Creates a membership relation.

StScopedElementName void SetScopedElementName(const RWCString &);

Sets the scoped elements name.

SetWildcardedElementName void SetScopedElementName(const RWCString &);

Sets the scoped elements name.

GetWildcardedElementName RWCString GetWildcardedElementName()

Gets the elements name.

GetScopedElementName() RWCString GetWildcardedElementName()

Gets the elements name

GetDomains RWTValSlist<TCVMember>& GetDomains()

Returns the list of Members

GetMember RWBoolean GetMember(const RWCString &, TCVMember&) const;

Gets a specific Member

UpdateMember RWBoolean GetMember(const RWCString &, TCVMember&) const;

Gets a specific Member

E.2 TCVMember Class A TCVMember object represents a membership relation between a TeMIP entity maintained by the TNDL (TCVEntity object) and a domain. The methods defined for this class manage the relation type (collection).

Note

The TCVMember class governs only the membership relation. The related TeMIP entity (domain) must also be created as a TCVEntity object.

Datatypes typedef typedef enum { collection_domain, domain, member_error } TCVMemberTyp

This enumeration is used to set the type of the membership relation.

Constructors TCVMember(TCVMemberType Type, const RWCString& GlobalClass, const RWCString& GlobalName, const RWCString& SubClass = "", const RWCString& SubName = "")

The member name is defined as a list of class/instance pairs. TCVMember()

202

Creates an empty TCVMember object. The SetType and SetName methods must be called to make the object valid. TCVMember(const TCVMember&)

Operators TCVMember& TCVMember::operator=(const TCVMember & MemberRef) TCVMember& TCVMember::operator=(const TCVMember * MemberPtr) RWBoolean TCVMember::operator ==(const TCVMember& MemberRef) const

Two TCVMember objects are identical if they have the same name.

Methods

Clear void TCVMember::Clear()

Clears member name.

Dump friend ostream& operator<<(ostream& stream, const TCVMember& MemberRef)

Dumps the TCVMember object to file in TNDL input format.

Note

Do not call this method directly; use the TCVEntity << operator.

GetFullName RWCString TCVMember::GetFullName() const

Returns the member name in TeMIP name format.

GetTNDLName RWCString TCVMember::GetTNDLName() const

Returns the member name in TNDL format.

GetType TCVMemberType TCVMember::GetType() const

Returns the member type.

SetCollection void TCVMember::SetCollection()

SetName void TCVMember::SetName(const RWCString& GlobalClass, const RWCString& GlobalName, const RWCString& SubClass = "", const RWCString& SubName = "")

Sets the member name to the class/instance pairs.

SetType void TCVMember::SetType(TCVMemberType type)

GetTNDLName RWCString GetTNDLName() const;

Returns the member name in TNDL format

GetFullName RWCString GetFullName() const;

Returns the member name in TeMIP name format

GetClass RWCString GetClass(const unsigned int ) const;

203

Returns the class name

GetInstance RWCString GetInstance(const unsigned int ) const;

Returns the instance name

SetInstance void SetInstance(const unsigned int, const RWCString &);

Sets an instance value

E.3 TCVEntitySpec Class A TCVEntity object represents a TeMIP entity specification.

Datatypes typedef enum { single, setOf, record } TCVAttributeType;

Constructors TCVEntitySpec()

Creates an empty Entity Spec object. TCVEntitySpec(const RWCString &classRef, RWCString &valueRef)

Creates an Entity Spec object.

Destructors

Destroys an Entity Spec object: ~TCVEntitySpec()

Operators

Dumps an Entity Spec object: ostream& operator<<(ostream &streamRef, const TCVEntitySpec &entitySpecRef)

Methods

Append void Append(const RWCString &classRef, RWCString &valueRef)

Appends a Class-Instance pair to an entity specifier.

Clear void Clear()

Clears the entity name and members.

Depth size_t Depth()

Gets the Depth of the entitySpec.

GetFullName RWCString GetFullName() const

Returns the entity name in TeMIP format.

GetTNDLName RWCString GetTNDLName () const

Dumps entity name as an RWCString.

SetAttribute

204

void TCVEntity::SetAttribute(const RWCString& AttributeName,const RWCString& AttributeValue, TCVAttribute::TCVAttributeType AttrType=TCVAttribute::single);

E.4 Graphical Classes The Graphical classes are based on two abstract classes: a container (AbstractContainer class) that contains items (AbstractContainerItem class). A container can be associated to an item.

The Map class corresponding to a simple representation of a visualization map that contains a list of members (MapItem class) that has a graphical representation and a possible TeMIP entity associated.

The Entity class is a TeMIP entity with its associated EntitySpec object (pointer) and it has Attributes. It can be attached to an Item object.

One graphic object (line, icon, box,…) can be attached to an Item object.

E.4.1 TCVAbstractMap Class This class defines the graphical abstract container. It inherits from TCVAbstractContainer for using containment features. It could contain some items (MapItem) that could have a graphic associated and a possible TeMIP entity.

Constructors virtual ~TCVAbstractMap();

It is responsible for the deletion of the Items contained.

Empty Constructor TCVAbstractMap();

Constructor with a TEMIP entity associated TCVAbstractMap(TCVEntity*);

Copy constructor TCVAbstractMap(const TCVAbstractMap&);

Operators operator<< friend ostream& operator<<(ostream&, const TCVAbstractMap&);

Dumps the graphical container to file operator.

Methods

Dump void Dump(ostream& ,ostream& );

Dumps the container and all its items in the map file and the topology file.

DumpDomain void DumpDomain(ostream&);

Dumps the associated entity (domain) of the container in the topology file.

DumpMap void DumpMap(ostream&);

Dumps the container and all its items in the map file and the topology file.

AddFilter

205

virtual void AddFilter(const RWCString& filterName, const RWCString& filterID);

Adds a filter.

GetMapName RWCString GetMapName()

Gets the map name.

AddItem void AddItem(TCVMapItem*);

Adds a new item in the container. The graphical Abstract container is responsible for the deletion of this graphical Item.

SetEntity void SetEntity(TCVEntity*);

Sets the entity name of the map container.

E.5 CVBackdrop Class A CVBackdrop object represents the characteristics of a map object, namely backdrop map file, map size, geographical position. It is used to update the map header of a map. There are two kinds of backdrop object: CVPixBackdrop (for pixmap backdrops) and CVVectBackdrop (for vector backdrops).

Datatypes typedef enum { pixmap, vector } CVBackdropType;

Constructors CVBackdrop(const RWCString& name, CVBackdropType type) CVPixBackdrop(const RWCString& name) CVVectBackdrop(const RWCString& name)

Methods

SetBackdropFile void SetBackdropFile(const RWCString& filename)

Sets the backdrop file value of the Backdrop object.

SetGeoCoordinates void SetGeoCoordinates(const RWCString& CoordX, const RWCString& CoordY)

Sets the Geographical coordinates of the backdrop object.

SetSize void SetSize(const int sizeX, const int size Y)

Sets the dimensions of a pixmap backdrop. This method is available in CVPixBackdrop objects only.

SetCoordinates void SetCoordinates(const RWCString& BottomLeft, const RWCString& UpperRight)

Sets the position of a vector backdrop. This method is available in CVVectBackdrop objects only.

206

Operators

Assignment operators CVPixBackdrop& operator=(const CVPixBackdrop&) CVVectBackdrop& operator=(const CVVectBackdrop&)

Dump to file operators ostream& operator<<(ostream&, const CVPixBackdrop&) ostream& operator<<(ostream&, const CVVectBackdrop&)

Equality operator RWBoolean operator ==(const CVBackdrop&) const

Two backdrops are equal if they have same map owner name.

E.5.1 TCVMap Class This class defines a simple graphical Container. It could contain some items (MapItem) that could have a graphic associated and a possible TeMIP entity.

Constructor TCVMap() {} TCVMap(const RWCString&);

Copy constructor TCVMap(const TCVMap&);

Destructor virtual ~TCVMap();

Methods

AddItem void AddItem(TCVMapItem*);

Adds a new graphical item in the map. The map container is responsible for the deletion of this graphical Item.

SetMapName void SetMapName(const RWCString& mapName)

Sets the MAP name

SetBackdrop void SetBackdrop(CVBackdrop*);

Sets backdrop information

SetMapFormat void SetMapFormat(const RWCString& mapFormat)

Sets map format

SetTopMap void SetTopMap(const RWCString& topMap)

SetDomainEntity void SetDomainEntity(TCVEntity* p_entityMap)

Sets domain associated

E.5.2 TCVMapItem Class This class defines a graphical Item. It is contained in a simple graphical container (TCVMap class). It could be associated to either a TeMIP entity or a graphic or both.

207

Constructor TCVMapItem(TCVEntity*);

Constructor with a TEMIP entity associated TCVMapItem(const RWCString&, TCVGraphics*);

Constructor with a Graphic associated TCVMapItem(TCVEntity*, TCVGraphics*);

Full constructor: enables you to create a graphical item with a TeMIP associated.

Destructor ~TCVMapItem();

It is responsible for the destruction of graphic, entity, container possibly associated.

Operator operator<< friend ostream& operator<<(ostream&, const TCVMapItem&);

Dumps to file operator

Methods

Delete virtual void Delete();

Enables you to delete the pointers associated (entity, container, graphic).

DeleteAssociatedGraphic void DeleteAssociatedGraphic();

Enables you to delete the graphic only.

SetAssociatedGraphic void SetAssociatedGraphic(TCVGraphics*);

Sets an associated Graphic to the MapItem. Be careful, the user is responsible for first deleting the old one.

SetAssociatedContainer void SetAssociatedContainer(TCVAbstractMap*);

Sets a container. Be careful, the user is responsible for first deleting the old one.

SetFilter void SetFilter(const RWCString&);

Sets a Filter to this graphical item in the map.

Dump void Dump(ostream& ,ostream& );

Dumps the Map Item and the associated entity in the topology file.

DumpMap void DumpMap(ostream&);

Dumps the container and all its items only in the map file.

GetID RWCString GetID()

Returns the map item ID.

SetID void SetID(const RWCString& id)

208

Sets the map item ID.

GetGraphicName RWCString GetGraphicName()

Gets the graphic name (Map item name)

SetGraphicName void SetGraphicName(const RWCString & graphicName)

Sets the graphic name (Map Item Name)

GetAssociatedGraphic const TCVGraphics* GetAssociatedGraphic()

Retrieves the associated Graphic

SetUrl void SetUrl(const RWCString&);

Sets default URL

SetProfile void SetProfile(const RWCString&);

Sets default Profile used for this Item

SetAssociatedMap void SetAssociatedMap(const RWCString&);

Sets Associated Map used for this Item

SetAssociatedMapFormat void SetAssociatedMapFormat(const RWCString&);

Set Associated Map Format used for this Item

SetAssociatedMapType void SetAssociatedMapType(const RWCString&);

Sets Associated Map Type used for this Item

SetCoordinates void SetCoordinates(const RWCString&, const RWCString&);

Sets coordinates for the map item.

E.5.3 TCVGraphics Class A TCVGraphics object represents a graphical representation of a TeMIP entity in a map file, which is maintained by the TNDL. The TCVGraphics class is the base class of TCVIcon, TCVLine, TCVPolyline, TCVBox, TCVRing.

The class TCVIcon inherits from TCVBaseIcon and TCVGraphics

The class TCVLine inherits from TCVGraphics and TCVBaseLine

The class TCVPolyline inherits from TCVGraphics and TCVBasePolyline

The class TCVBox inherits from TCVGraphics and TCVBaseBox

The class TCVRing inherits from TCVGraphics and TCVBaseRing

The class TCVText inherits from TCVGraphics and TCVBaseText

The class TCVBaseLine inherits from TCVBaseGraphic

The class TCVBasePolyline inherits from TCVBaseXYListCoordinates

The class TCVBaseRing inherits from TCVBaseGenericRing

209

The class TCVBaseText inherits from TCVBaseGenericText

Datatypes

typedef enum { icon, line, double_line, polyline, box, ring, graphic_error } TCVGraphicType

Constructors TCVIcon(const RWCString& FileName) An Icon object is defined by its filename. TCVGraphics *TCVIcon::Clone() const

Clones the object and returns a pointer to the clone. TCVLine()

Empty simple line TCVGraphics *TCVLine::Clone() const

Clones the double line object and returns a pointer to the clone. TCVPolyine()

Empty polyline TCVGraphics *TCVPolyline::Clone() const

Clones the polyline object and returns a pointer to the clone. TCVBox()

Empty box TCVGraphics *TCVBox::Clone() const

Clones the double box object and returns a pointer to the clone. TCVRing()

Empty ring TCVGraphics *TCVRing::Clone() const

Methods

Dump const RWCString TCVIcon::Dump() const RWCString TCVLine::Dump() const RWCString TCVPolyline::Dump() const RWCString TCVBox::Dump() const RWCString TCVRing::Dump()

Dumps the graphic object to a string in TNDL input format.

SetIcon void TCVBaseIcon::SetIcon(const RWCString& iconRef)

Sets icon name

SetCoordinates void TCVBaseIcon::SetCoordinates(const RWCString&, const RWCString&); void TCVBaseText:SetCoordinates(const RWCString&, const RWCString&);

SetText void TCVBaseGenericText::SetText(const RWCString& textRef)

GetTNDLGenericTex const RWCString TCVBaseGenericText::GetTNDLGenericText();

Gets the text characteristics in TNDL Format.

SetStartCoordinates

210

void TCVLine::SetStartCoordinates(const RWCString &coordXRef, const RWCString &coordYRef) void TCVPolyline::SetStartCoordinates(const RWCString &coordXRef, const RWCString &coordYRef) void TCVBox::SetStartCoordinates(const RWCString &coordXRef, const RWCString &coordYRef)

SetEndCoordinates void TCVLine::SetEndCoordinates(const RWCString &coordXRef, const RWCString &coordYRef) void TCVPolyline::SetEndCoordinates(const RWCString &coordXRef, const RWCString &coordYRef) void TCVBox::SetEndCoordinates(const RWCString &coordXRef, const RWCString &coordYRef)

SetStartEntity void TCVLine::SetStartEntity(const TCVEntitySpec &startEntityRef)

SetEndEntity void TCVLine::SetEndEntity(const TCVEntitySpec &endEntityRef)

Append void TCVPolyline::AppendCoordinates(const RWCString &coordXRef, const RWCString &coordYRef)

Append a new coordinates just before the End Coordinates or the End entity

SetCenterCoordinates void TCVRing::SetCenterCoordinates(const RWCString &coordXRef, const RWCString &coordYRef)

Sets center XY coordinates

SetCirclePointCoordinates void SetCirclePointCoordinates(const RWCString &coordXRef,const RWCString &coordYRef)

Sets one point on the circle

E.5.4 TCVAbstractContainer Class This class defines an abstract Container. It could contain some items (graphical or not, TeMIP or not).

Note

This class cannot be used directly (c++ abstract class).

The items are inserted as pointers and are the responsibility of the container. The destruction of the container involves the destruction of all Items.

Constructors TCVAbstractContainer(); TCVAbstractContainer(const TCVEntity&); TCVAbstractContainer(TCVEntity*)

Constructor with a TEMIP entity associated.

211

Destructor virtual ~TCVAbstractContainer();

Operator friend ostream& operator<<(ostream&, const TCVAbstractContainer&);

Dumps to file operator. Note that this method does not dump the items.

Method


Enables you to delete the container.

Clear void Clear();

Enables you to clear the list without deleting any Items contained.

ClearAndDestroy void ClearAndDestroy();

Enables the deletion of all the Items contained.

GetEntity const TCVEntity& GetEntity() const

GetList const RWTPtrSlist<TCVAbstractContainerItem>& GetList()

Retrieves the entity name of the container. Gives the list of items contained in the container.

E.5.5 TCVAbstractContainerItem Class This class defines an abstract Item. It could be contained in a container (TCVAbstractContainer class). A TeMIP entity could be associated to an item (SetEntity method).

Note

This class cannot be used directly (c++ abstract class).

The TeMIP entity or container are pointers allowing you to have several items using the same entity and to also have a container. These are the responsibility of the Item. The destruction of the Item includes the destruction of this information.

Constructor TCVAbstractContainerItem(); TCVAbstractContainerItem(TCVEntity*);

Constructor with a TEMIP entity associated.

A pointer is required enabling you to have several Items using the same TeMIP entity.

The Item is responsible for the deletion of the associated Entity or container.

Operator friend ostream& operator<<(ostream&, const TCVAbstractContainerItem&);

212

Dumps to file.

Method


Enables the deletion of the associated pointers (entity, container).

DeleteAssociatedTeMIPEntity void DeleteAssociatedTeMIPEntity();

Enables the deletion of the associated TeMIP entity only.

DeleteAssociatedContainer void DeleteAssociatedContainer();

Enables the deletion of the container only.

GetAssociatedTeMIPEntity const TCVEntity* GetAssociatedTeMIPEntity() const { return p_associatedTeMIPEntity; }

Retrieves the associated TeMIP entity.

213

Glossary

DTD

Document Type Definition

FCL PM

Framework Command Line Presentation Module

HDS

Hierarchy and Decoration Server

MIR

Management Information Repository (TeMIP database)

TeMIP

Telecommunications Management Information Platform

TMN

Telecommunications Management Network

TNDL

TeMIP Network Data Loader

TNS

TeMIP Name Service

XML

eXtensible Markup Language

215

Date post:	24-Oct-2014
Category:	Documents
Upload:	arun-prakash
View:	46 times
Download:	1 times