User Manual

Clarity Inventory Suite

Document Version: 3.9

Date: 20-June-2011
Copyright Information
Copyright © 2011. Clarity International Limited. All rights reserved. Clarity
International and the Clarity logo are registered trademarks of Clarity International
Limited, in Australia and other countries. All other trademarks or registered service
marks in this document are the property of Clarity International or their respective
owners. All specifications are subject to change without notice. Clarity International
assumes no responsibility for any inaccuracies in this document or for any obligation to
update information in this document. Clarity International reserves the right to change,
modify, transfer, or otherwise revise this publication without notice.

Document Information
Document History
Version Date Amendment Name Role
3.0 22 Feb 2010 Added a new Swati Mohanty Author
chapter on Regions
and made changes to
the Areas, Location,
and Reference Data
(Area Types)
chapters to include
changes for the
same.
Version released in
C10.6.2
3.1 19 Mar 2010 Updates for Swati Mohanty Author
INTTEST-1644
Version released in
C10.6.4
3.2 12 Apr 2010 Updates for TM- Swati Mohanty Author
210, TMSPT-175,
and VIVACOMIA-
261.Version released
in C10.6.5

2
Document History
Version Date Amendment Name Role
3.3 16 Apr 2010 Updated for JIRA Swati Mohanty Technical
issues WPWRII-67 Writer
and VIVACOMIA-
241. Version
released in C10.6.6
3.4 21 May 2010 Updated for JIRA Swati Mohanty Technical
issue VIVACOMIA- Writer
416.
Version released in
C10.6.8
3.5 14 Feb 2011 Updated the Jeevanthi Technical
document to Dharmasena Writer
incorperate the
changes done for
INTTEST-2856 and
VIVACOMIB-229

Also updated with

the new logo.

Version released for

C11.0.0

3
 Document History
Version Date Amendment Name Role
3.6 14 Mar 2011 Updated the Jeevanthi Technical
document to Dharmasena Writer
incorperate the
changes done for
INTTEST- 2465 in
chapter 10.

Apart from the

above change,
chapter 10 was
updated with the
following changes:
-The Acess
Connection window
and also the
Infrastructure
connection window
updated with the
latest screen
captures.
-The two tables
describing the fields
of the above
windows were re-
organized as per the
current view.
3.7 19 Apr 2011 Updated the Jeevanthi Technical
document to Dharmasena Writer
incorperate the
changes done for
CPD- 38 in chapter
23 and 24.

Version released for

C11.0.5.

4
Document History
Version Date Amendment Name Role
3.8 23 May 2011 -Included a Hint Jeevanthi Technical
section in Chapter Dharmasena Writer
13-the procedure
describing the
creation of cable
sheath mulitiple
terminations.

-Incorperated the
suggested changes
for INTTEST- 2992.

Version released for

C11.1.0.

5
 Document History
Version Date Amendment Name Role
3.9 20 June 2011 Updated the chapter Jeevanthi Technical
on Network Dharmasena Writer
Elements to
incorporate the
changes done for
PTTVII-5.
-Copy Network
Elements dialog box
was replaced with
the new one.
-Definition of the
new checkbox was
included.
-The procedure
describing copy
network
connections was
also updated to
accommodate the
new check box.
Version released for
C11.1.1

6
 TABLE OF CONTENTS

Chapter 1 Overview
Clarity Inventory Suite Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Inventory Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Setting Up Data in the Inventory Suite . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Chapter 2 Circuit Path Query

Circuit Path Query Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Opening the Circuit Path Query Window . . . . . . . . . . . . . . . . . . . . . . . . 26
Query Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Circuit Paths Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Circuits Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Features of the Circuit Path Query Window . . . . . . . . . . . . . . . . . . . . . . . . 30
Querying Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Displaying Circuit Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Clearing Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 3 Querying Records

Generic Query Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Circuits Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Navigate Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Display Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Reports Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Network Elements Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Display Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Customer Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Search Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Display Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Service Orders Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

7
TA B L E O F C O N T E N T S

Display Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Frames Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Display Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Cables Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Results Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Display Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Features of the Generic Query Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Querying Records ........................................... 66
Displaying Circuit Capacity Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Viewing Circuit Capacity and Spare Configured Ports . . . . . . . . . . . . . . . 67
Using the Navigate Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Zoom Up to Bearers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Zoom Down to Tributaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Opening Additional Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Circuit Editing Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Network Elements Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Chapter 4 Facility Query

Facility Query Module Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Neighbour’s Phone Number Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Location Address Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Service Address tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Query Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Frames Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Network Elements Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Features of the Facility Query Module Window . . . . . . . . . . . . . . . . . . . . . 84
Querying Available Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 5 Query Event History

Config Change History Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Search Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Frame Appearances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Frame Containers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Frame Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Port Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Port Link Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Rings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

8
 TA B L E O F C O N T E N T S

Chapter 6 Editing Circuits

Circuit Design Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Circuit Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Cross Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Bearers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Tributaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Features of the Circuit Design Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Querying Circuit Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Circuit Affecting Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Opening the Network Elements Window . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Creating Circuit Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Creating Circuit Detail Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Inserting Alternate Name Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Inserting Cross Connection Records . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Inserting Bearer and Tributary Records . . . . . . . . . . . . . . . . . . . . . . . . . 129
Modifying Circuit Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Modifying Circuit Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Modifying Circuit Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Modifying Circuit Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Associating Circuit Attributes with Circuits . . . . . . . . . . . . . . . . . . . . . . . 134
Copying Circuit Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Copying Circuit Cross Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Deleting Circuit Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Deleting Circuit Detail Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Deleting Cross Connection Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Deleting Alternate Name Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Using the Navigate Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Zooming Up To Bearers for Circuit Details . . . . . . . . . . . . . . . . . . . . . . . 145
Zooming Down to Tributaries for Circuit Details . . . . . . . . . . . . . . . . . . . 145
Specifying Backup Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Viewing Backup Circuits for a Selected Circuit . . . . . . . . . . . . . . . . . . . . 146
Customer and Account Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Viewing the Customer and Account Address for a Selected Circuit . . . . . . 148
Bearer Path Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Port Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Viewing the Port Transfer options for a Selected Circuit . . . . . . . . . . . . . . 152
Ring Cross Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Provisioning Ring Cross Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Creating Ring Cross Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Creating Sub-Network Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Service Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

9
TA B L E O F C O N T E N T S

Verify Ports Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Viewing the Other Circuits Reserving these Ports . . . . . . . . . . . . . . . . . . 163
View Reservation Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Viewing the Reservation Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Chapter 7 Ring Definitions

Rings Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Ring Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Ring Bearers Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Ring Paths Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Inter-Network Bearers Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Features of the Rings Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Querying Rings ............................................. 175
Creating Rings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Modifying Rings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Viewing Network Element Detail Records . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Viewing Circuit Detail Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Chapter 8 Sub-Network Definitions

Sub-Network Definition Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Chapter 9 Routing Definitions

Route Definition Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Chapter 10 Data Connections

Data Connections - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Access Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
...................................................... 195
Infrastructure Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Data Connections Tool Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Setting up Data Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Setting up Reference Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Chapter 11 Network Elements

Network Elements Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Network Elements Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Network Element Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . 225
Network Elements Section Tool Palette . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Card Slots Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

10
 TA B L E O F C O N T E N T S

Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Card Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Card Slots Section Tool Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Ports section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Port Details Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Port Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Port Details Section Tool Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Additional Port Details Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Connections Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Features of the Network Elements Window . . . . . . . . . . . . . . . . . . . . . . . . . 286
Querying a Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Creating Network Element Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Creating Network Element Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Inserting Card Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Inserting Port Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Modifying Network Element Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Deleting Network Element Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Deleting Network Element Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Deleting Card/Slot Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Deleting Port Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Network Elements Feature Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Chapter 12 Frames
Frames Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Frame Container Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Frame Unit Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Frame Appearance Service Type Templates . . . . . . . . . . . . . . . . . . . . . . 319
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Features of the Frames Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Creating Frame Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Creating Frame Containers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Creating Additional Frame Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Querying Records in the Frames Window . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Querying Frame Container Records . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Querying Frame Unit Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Querying Frame Appearance Records . . . . . . . . . . . . . . . . . . . . . . . . . . 326

11
TA B L E O F C O N T E N T S

Chapter 13 Cables
Cables Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Cable Sheath Details Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Cable Core Terminations Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Terminations Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Features of the Cables window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Creating Cable Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Creating Cable Sheath Details Records . . . . . . . . . . . . . . . . . . . . . . . . . 340
Creating Cable Sheath Terminations . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Creating Cable Sheath Multiple Terminations . . . . . . . . . . . . . . . . . . . . 341
Querying a Cable Sheath Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Deleting Cable Sheath Terminations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

Chapter 14 UnNamed Connections

UnNamed Connections Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Manage tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
UnNamed Connections section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Terminate Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Features of the UnNamed Connections Window . . . . . . . . . . . . . . . . . . . . 353
Tracing an UnNamed Connection Record . . . . . . . . . . . . . . . . . . . . . . . . . 354
Terminating UnNamed Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

Chapter 15 Management Systems

Management Systems Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Chapter 16 Manage Service Type Templates

Manage Service Type Templates Window . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Network Element Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Managing Network Element Service Type Templates . . . . . . . . . . . . . . . 367
Frame Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Managing Frame Service Type Templates . . . . . . . . . . . . . . . . . . . . . . . 381

Chapter 17 Topologies
Topologies Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Topologies Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Creating Topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Creating Topologies Reference Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Creating a Generic Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Example - GSM / CDMA Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Creating a Mobile Switching Center Topology (MSC Topology) . . . . . . . . 399

12
 TA B L E O F C O N T E N T S

Creating a Base Station Controller Topology (BSC Topology) . . . . . . . . . 400

Creating Infrastructure Topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Creating Metro Ethernet (Layer 2) Topology . . . . . . . . . . . . . . . . . . . . . . 401
Creating a (Layer 3) Provider Edge Topology . . . . . . . . . . . . . . . . . . . . . 402
Creating a (MPLS) Core Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Broadcast Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Creating an FTTH Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Creating Customer (Access) Topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Creating a VLAN topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Creating a VPN topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Chapter 18 Generic Objects

Generic Objects Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Generic Objects Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Defining Generic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Chapter 19 Clouds
Clouds Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Clouds Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Defining Clouds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Chapter 20 Templates
Templates Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Cable Details Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Card Details Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Circuit Details Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Frame Unit Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Frame Container Details Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Network Element Template Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Network Elements Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Network Element Template Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Card Slot Template Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Features of the Network Element Template Window . . . . . . . . . . . . . . . . 438
Querying Network Element Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Creating Network Element Templates . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Defining an Network Element Template . . . . . . . . . . . . . . . . . . . . . . . . . 439
Creating Card Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Creating a Slot Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Mapping Slots with Card Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

13
TA B L E O F C O N T E N T S

Creating Slot Card Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Network Element Details Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Equipment Feature Templates Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Port Templates Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Features of the Port Templates Window . . . . . . . . . . . . . . . . . . . . . . . . . 450
Querying a Port Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Creating Port Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Creating Port Templates for Child Ports . . . . . . . . . . . . . . . . . . . . . . . . . 451
Creating Port Templates for Parent Ports . . . . . . . . . . . . . . . . . . . . . . . . 452
Creating Large Range Port Templates . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Using the Create Range Window to Create Port Templates . . . . . . . . . . . 453
Create Port Range Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Additional Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Modifying a Port Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Deleting a Port Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Port Details Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Service Types Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Trunk Group Details Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

Chapter 21 Areas
Areas Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Areas Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Features of the Areas Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Creating an Area Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Creating RTOM Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Creating LEA Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Creating EC Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Creating Geographical based Parent Records . . . . . . . . . . . . . . . . . . . . 473
Assigning Work Groups to Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Querying an Area Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Querying Parent Area Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Deleting Area Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Chapter 22 Regions
Regions Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Setting up Regions Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Adding Areas to the Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

14
 TA B L E O F C O N T E N T S

Adding Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

Chapter 23 Locations/Sites
Locations Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
Locations tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Child Locations tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Features of the Locations Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Creating Location/Site Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Creating a Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Creating an Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Querying Location/Site Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Modifying Location/Site Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Deleting Location/Site Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Creating and Querying Costed Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Creating a Costed Item for a Location . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Querying or Displaying Costed items for a Location . . . . . . . . . . . . . . . . 513
Assigning Alternate Names to Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Location Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Location Attributes for Locations/Child Locations . . . . . . . . . . . . . . . . . . . . 518
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Chapter 24 Reference Data windows

Inventory Suite Reference Data windows .......................... 522
Address Serviceability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Area Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Exchange Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Manufacturers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Pay Load Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Reservation Threshold Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Speeds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Trunk Group Parameter Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

15
TA B L E O F C O N T E N T S

Fields ................................................. 536

Utilisation Threshold Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Cable Sheath Product Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Cable Sheath Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Cable Parameter Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Card Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Card Parameter Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Alternate Name Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Circuit Costs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Circuit Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Circuit Parameter Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
Cross Connection Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Frame Container Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Frame Container Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Frame Unit Product Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
Location/Site Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Location Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Network Element Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Network Element Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571

16
 TA B L E O F C O N T E N T S

Fields ................................................. 572

Network Element Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Network Element Parameter Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Port Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Port Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Port Parameter Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578

Chapter 25 Traffic Management

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Traffic Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Transmission Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Traffic Management Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Routes Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Routes Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Trunk Groups Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Trunk Groups Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Trunk Group Parameters window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Link Sets Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Link Sets Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Circuits Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Data Connections Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Link Set Parameters window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Traffic Destinations Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Traffic Destinations Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Destination Codes Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Destinations Codes Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
......................................................... 600
Routes to Destinations Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Destinations Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Routes Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Destination Codes to Destinations Window . . . . . . . . . . . . . . . . . . . . . . . . 605
Search Criteria Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Destinations Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Destination Codes Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Trunk Group and Link Sets to Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Routes Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Trunk Groups and Link Sets Section . . . . . . . . . . . . . . . . . . . . . . . . . . . 611

17
TA B L E O F C O N T E N T S

Circuits to Trunk Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

Trunk Groups Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Circuits Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Features of the Traffic Management windows . . . . . . . . . . . . . . . . . . . . . . 616
Creating a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Creating a Trunk Group or Link Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Creating a Traffic Destination .................................. 621
Creating a Destination Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Associating a Route with a Traffic Destination ...................... 623
Associating a Destination Code with a Traffic Destination . . . . . . . . . . . . . 624
Associating a Trunk Group/Link Set with a Route . . . . . . . . . . . . . . . . . . . . 625
Associating a Circuit with a Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . 626

Chapter 26 Reports
Inventory Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Report Parameters Specific to Inventory . . . . . . . . . . . . . . . . . . . . . . . . . 628
Cable Sheath Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Circuits Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Bearers Over Given Capacity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Capacity of Bearer Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Circuit Design Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Circuit Hierarchy (Down) Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Circuit Hierarchy (Up) Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Circuit Routing Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Circuit Due In Service Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Circuit Costed Items Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Commissioned Circuit Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . 636
Inservice Circuit Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Out of Service Circuit Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . 637
Reserved Capacity on Planned NE Report . . . . . . . . . . . . . . . . . . . . . . . 638
Circuit Expiry Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
Rings Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Routing Definition Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Sub Network Definition Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643

18
 CHAPTER 1

Overview

This section provides an overview of the Clarity Inventory Suite.

19
OVERVIEW
Clarity Inventory Suite Overview

Clarity Inventory Suite Overview

The Clarity Inventory Suite manages the logical and physical configuration of
telecommunications networks.
It provides full integration of network elements and network element management
systems. It also includes number management, planned events, and
diagrammers.
The Inventory Suite can interface with other support systems such as materials
management or geographical information systems (GIS), and can track the
following physical network inventories:
• Sites (customer, carrier, common, inter-connect)
• Manholes and network access points network elements (NEs)
• Wireline and wireless transmission.
For more information about the Clarity Network and Circuit Diagrammers that
are available as part of the Inventory Suite, refer to the Network Diagrammer
and Circuit Diagrammer manuals.

20
 OVERVIEW
Inventory Menu

Inventory Menu
The following table lists the various windows (along with their navigation path)
that you will access to perform the different functions under the Inventory
module.

Menu Option Accesses Use window to…

Inventory > Circuit Path Query circuit path information in the

Query > Circuit Query window Clarity system.

Inventory > Generic Query Query network elements, customers,

Query > window service orders, frames, and cables in
Generic the Clarity system.

Inventory > Facility Query View the facilities available for

Query > Facility Module window providing a service in a specific area.

Inventory > Config Change Display the history of changes made

Query > Event History window to entities in the Clarity Inventory
History Suite, for example changes made to
cards, network elements, frame
units, and so on.

Inventory >Data Topologies window Create and maintain topologies.

Services >
Topology Object
Types

Inventory Circuit Design Create, modify, or delete circuit

>Circuits> window records.
Circuit Design

Inventory Rings window Create SDH/SONET rings.

>Circuits>Rings

Inventory Sub-Network Identify sub-network circuit routes

>Circuits Definition window within the Clarity system.
>Subnetwork

Inventory Route Definition Define a route to be used between

>Circuits window two end points of a sub-network.
>Routing

Table 1–1. Inventory menu items (sheet 1 of 3)

21
OVERVIEW
Inventory Menu

Menu Option Accesses Use window to…

Inventory Network View and edit network elements for a

>Components > Elements window selected circuit.
Network
Elements

Inventory Server Set up the network element feature

>Components > Equipment hierarchy.
Network window
Elements
Feature
Hierarchy

Inventory Frames window Set up the physical frame equipment

>Components > used to connect elements in a
Frames telecommunications network.

Inventory Cables window Define cable sheath details and

>Components > cable core terminations.
Cables

Inventory UnNamed Define pre-wired pre-installed

>Components > Connections network infrastructures such as LAN
UnNamed window ports.
Connections

Inventory Management Maintain a list of valid network

>Components > Systems window element management systems
Management (NEMS) configuration details.
Systems

Inventory Template windows Access the templates for various

>Templates entities in the Inventory module, for
example Cable Details Template,
Card Details Template, Circuit
Details Template, and so on.

Inventory Areas window Create, view, and edit area records.

>Areas

Inventory Locations window View, edit, or create location and site

>Locations/Sites details.

Table 1–1. Inventory menu items (sheet 2 of 3)

22
 OVERVIEW
Inventory Menu

Menu Option Accesses Use window to…

Inventory > Reference data Access the various reference data

Reference Data windows windows to set up the list of values
that will be used across various
functions in the Inventory module.

Inventory Reports windows Access various reports related to

>Reports Inventory.

Table 1–1. Inventory menu items (sheet 3 of 3)

Setting Up Data in the Inventory Suite

Many fields in Inventory Suite’s windows are completed through selection of a
value in a List of Values screen, accessed though use of the LOV button.
The values on such windows are set up in the reference windows which are
accessed through the Reference menu item.
Many Reference windows have specific and dependant inter-relationships with
other reference windows and other components. Data needs to exist in a
reference window, before it can be made available for use in other windows.

23
OVERVIEW
Inventory Menu

Clarity recommends that you complete data entry in the Inventory Suite reference
windows in the sequence shown below:
• Manufacturers
• NE Types
• NE Models
• Speeds
• Cross Connection Types
• Exchange Codes
• Port Cables
• Card Models
• Circuit Costs
• Frame Container Types
• Frame Unit Templates
• Frame Unit Product Types
• Cable Sheath Product Types
• Pay Load Mapping
• Card Validation
• Card Details Templates
• Network Element Validation
• Network Element Details Template
• Port Validation
• Port Details Template
• Circuit Validation
• Circuit Details Templates
• Trunk Group Validation
• Trunk Group Details Template
• Address Serviceability
• Cable Details Template
• Cable Sheath Types
• Cable Validation
• Network View Types
• Network Views
Refer to Using Reference Screens in Getting Started with Clarity OSS for details
about entering data in each of the above windows.

Note
You will require the necessary authorization to create, modify or delete
reference screen data. Some reference windows that use LOVs will need
to have those LOVs set up first, i.e. some reference windows have
prerequisite reference windows.

24
 CHAPTER 2

Circuit Path Query

Use this section to learn about using the Circuit Path Query window. This is a
generic query window and is used to search for circuit paths information in the
Clarity system.

25
CIRCUIT PATH QUERY
Circuit Path Query Window

Circuit Path Query Window

Use this form to map the general connectivity of cards and frames by searching
for information about circuit paths between 2 points.
The form will search for circuits that match the query type and filters that you
choose.

Opening the Circuit Path Query Window

To open the Circuit Path Query window
• From the Inventory menu, select Query and then click Circuit.
The Circuit Path Query window is displayed.

Figure 2–1. Circuit Path Query window

The Circuit Path Query window has the following sections.

Section See…

Query Section page 27

Circuit Paths Section page 28

Circuits Section page 28

26
 CIRCUIT PATH QUERY
Circuit Path Query Window

Query Section
Use the Query section to search for circuit paths running between any two of the
specified sites and that match the specified speed.

Fields
The fields in the Query section are:

Field Description

Location A The location from which the path search should start.

Location Z The location at which the path search should end.

Speed The speed of the circuits between the specified A and Z

locations.

Service Type The service type supported by the circuits.

Max. Hops The maximum number of hops of the circuits between the
specified A and Z locations.

Max. Paths The maximum number of paths (that is, the maximum
number of parallel routes) between the specified A and Z
locations.

Additional Circuit Additional circuit type to be added to the criteria (e.g.

Type INTERCONNECT). Considers circuit types of BEARER,
TRUNK, PATHS, JUNCTION by default.

Table 2–1. Query section; fields

Button
The button in the Query section is:

Button Description

Search The Search button populates the Circuit Paths and

Circuits sections with the results matching the search
conditions. See Querying Circuits on page 31.

Table 2–2. Query section; button

27
CIRCUIT PATH QUERY
Circuit Path Query Window

Circuit Paths Section

The Circuit Paths section shows the path of the circuit location, hops and cable
length and will be populated if the search results are successful.

Figure 2–2. Generic Query window; Circuit Paths section

Fields

Field Description

Location Path A collection of location paths from location A to location

Z as specified in the Query section.

Hops Number of hops (number of circuits between location A

and Z).

Total Cable Length Combine length of cables in the circuit.

Table 2–3. Circuit Paths section; fields

Circuits Section
The Circuits section shows the circuit information between two single points within
a location path. Information such as the name, status and individual cable length
of the circuit can be displayed by clicking an entity in the Circuit Paths section.
See Displaying Circuit Details on page 32 for more information.

Figure 2–3. Generic Query window; Circuits section

28
 CIRCUIT PATH QUERY
Circuit Path Query Window

Fields

Field Description

Name Displays the circuit name.

Status Displays the status of the circuit, e.g. Inservice.

Cable Length The combine length of cables in the circuit.

Table 2–4. Circuits section; fields

29
CIRCUIT PATH QUERY
Features of the Circuit Path Query Window

Features of the Circuit Path Query Window

The features of the Generic Query window are:

Feature See…

Opening the Circuit Path Query window page 26

Querying Circuits page 31

Displaying Circuit Details page 32

Clearing Search Results page 32

30
 CIRCUIT PATH QUERY
Querying Circuits

Querying Circuits
This procedure describes how to query a circuit in the Circuit Path Query
window.

Note
The search is based on the default customer defined in the application
variables. Refer to the chapter on Application Variables in the Getting
Started with Clarity OSS user manual for more information.

To query a circuit
1 Open the Circuit Path Query window.
See Opening the Circuit Path Query Window on page 26 for more
information.
2 In the search value fields (Location A, Location B, Speed), enter either:
– the full search value of the location from which the circuit path search
should start,
or
– a partial search value using the% character as a wildcard,
or
– Use the LOV to select a search value.
3 Click the Search button.
The query results are displayed in the Circuit Paths and Circuits tables.

Hint
When you open the Circuit Path Query window it is already in search
mode.

You can enter further information in the additional fields to narrow the
search.

31
CIRCUIT PATH QUERY
Querying Circuits

Displaying Circuit Details

From the Circuit Paths section of the Circuit Path Query window you can
display the following Circuit Details:
• Name
Displays the name of the single path between 2 points in a circuit path.
• Status
Displays the status of the circuit, e.g. Inservice.
• Cable Length
The length of the cable between Location A and Location B. The default
measurement unit is set up in the Application Variables window.

Note
Only locations where the connecting bearers have a status of INSERVICE
will be displayed.

To display circuit details for a location path

1 Query a circuit path in the Circuit Path Query window.
See Querying Circuits on page 31 for more information on querying a circuit.
2 Click the Location Path in the Circuit Paths section.
The Circuits section displays circuit information.
3 Double click a circuit name from the Circuits section.
The Circuit Design window is displayed.
To use the Circuit Design window, See Circuit Design Window on page 106

Clearing Search Results

To clear all sections of the window
1 Click the Clear/Rollback button in the toolbar.
2 Data display in the Query, Circuit Paths and Circuits sections are cleared.

32
 CHAPTER 3

Querying Records

Use this section to learn about using the Generic Query window. This is a
generic query window and is used to look for circuits, network elements,
customers, service orders, frames and cable records in the Clarity system.

33
QUERYING RECORDS
Generic Query Window

Generic Query Window

Use this window to search for information about network elements, customers,
service orders, frames and cables in the Clarity system. The query type and filters
that you choose will directly affect the search results.
All query results windows are dynamically linked to the source information. To
access this source information, double-click a field in the results section of the
window.
To open the Generic Query window
• From the Inventory menu, select Query and then click Generic.
The Generic Query window is displayed.

Figure 3–1. Generic Query window

The Generic Query window has the following tabs:

Tab See…

Circuits page 36

Network Elements page 44

Customer page 49

Service Orders page 53

34
 QUERYING RECORDS
Generic Query Window

Tab See…

Frames page 57

Cables page 61

35
QUERYING RECORDS
Circuits Tabs

Circuits Tabs
The Circuits tab has the following sections:

Section See…

Search Conditions page 36

Results Table page 41

Navigation Buttons page 42

Display Buttons page 42

Reports Buttons page 43

Figure 3–2. Generic Query window; Circuits tab

Search Conditions
Use the Search Conditions section to enter a value and perform a query. The
records you retrieve will depend on the:
• search criteria
• query type
• filters

36
 QUERYING RECORDS
Circuits Tabs

Search Criteria
The search criteria is the value or word that you enter in the Search For field. This
information helps the database find the information you are looking for.
Use the Copy button to copy information from the results table and use it as
search criteria in the other tabs.
To use the Copy button
1 Query the first item, for example, circuits or network elements. In the Results
table, click in the field whose information you want to copy.
2 Click the Copy button.
The information is displayed in the Search For field.
3 To copy this information to another Query window, click the tab you require
then click the Copy button again.
The information is displayed in the Search For field.
For example, you can query for circuits; select a particular circuit from the
results table, copy it, and use it as a search parameter in the Customer tab
to query for customers who own that circuit.

37
QUERYING RECORDS
Circuits Tabs

You can enter your search criteria with wildcard characters to narrow or broaden
the search results. The following table describes the wildcard characters.

Character Description

% The percent wildcard character specifies that any characters can

appear in multiple positions represented by the wildcard.
Using the Circuits tab as an example:
• If you enter%, the Clarity system retrieves all circuit records.
• If you enter DILI%, the Clarity system retrieves all circuits that
begin with the letters DILI, such as DILI0001 or DILI0002.
• If you enter%0001, the Clarity system retrieves all circuits that
end with 0001, such as DILI0001, or GLEB0001.
• If you enter%DILI%, the Clarity system retrieves all circuits that
contain the letters DILI.

_ The underscore wildcard specifies a single position in which any

character can occur.
For example:
• If you enter DILI000_, the Clarity system retrieves all circuits
that begin with the characters DILI000 and end with a single
character, such as DILI0001 and DILI0002.

Table 3–1. Wildcard characters

Note
The Query window uses the% wildcard as the last character by default.
This removes the need for users to enter a wildcard after their search
criteria.

Query Types
To search the database you need to select a query type.

Note
The information that is returned in the Circuit Query window is always a
list of circuits.

38
 QUERYING RECORDS
Circuits Tabs

The query types are:

Query Type Description

All Bearers Assumes the search criteria entered is a circuit name and
returns a hierarchical list of circuits.

Alternate Name Searches for a circuit using an alternative name that has
been specified.

All Services Affected Assumes the search criteria is a circuit name and returns
a list of carriers and customer leased child circuits.

Cables Searches for circuits that use the entered cable name.

Circuit Name This is a direct search of circuit names (default).

Customer Searches for circuits that are owned or leased by the

specified customer.

Network Element Returns a list of circuits that use the entered network
element. You need to at least enter the type and location,
e.g. MUX DILI. Instance is optional. It will find all circuits
that have a certain type of equipment in a particular
location.

Frames Searches for circuits that use the entered frame name.

Area Retrieves all circuits that belong to an area.

Locations Retrieves all circuits running between any two of the

specified sites. You must specify at least two locations. Up
to five locations will be accepted.

Service Order No. Searches for circuits that are associated with the specified
service order.

Service Type Searches for circuits that supply the specified service type.

Services Affected Assumes the search criteria is a circuit name and returns
a list of child circuits that are customer leased.

Speed Searches for circuits with the specified operation speed.

Table 3–2. Query types

39
QUERYING RECORDS
Circuits Tabs

Filters
You can also apply one or more filters to your search. The filters are described in
the table below.

Filter Type Description

Proposed Includes circuits with the status of proposed, confirmed or

reviewed.

Inservice Includes circuits with the status of Commissioned or

Inservice.

Out of Service Includes circuits with the status of Out of Service,

Cancelled, Pending, Delete.

ANSI Includes circuits that use the ANSI naming compliance

standard.

ITU Includes circuits that use the ITU naming compliance

standard.

ITU-NS Includes circuits whose display name complies with the

ITU-NS standards.

No Compliance Includes circuits whose display name does not comply

with any naming standard.

Show Bearers Displays the first level bearers or parents of each circuit
returned.

Capacity Check Displays a Y in the Capacity column if the circuit has

exceeded the specified threshold level. This level is
displayed in the% Threshold field.

Check for alarms Displays a Y in the Alarm column if the circuit has a
on displayed circuit current alarm.

Show Cable Length Calculates the total length of cables utilized by a

circuit/bearer and displays it in the Cable Length field in
the results table.

Table 3–3. Filter types

40
 QUERYING RECORDS
Circuits Tabs

Results Table
This table displays the results of the query.

Note
The number of circuits retrieved, total number of rows and current row are
displayed underneath the results table.

The fields in this section are:

Field Description

Circuit Name The name that identifies the circuit.

Bearer The bearers used by the circuit. This column will only
display data if the Show Bearer option is checked.

Customer The customer that leases or owns the circuit.

Path The path of the associated circuit.

Cable Length Displays the cable length utilized by the bearer/circuit if

the Show Cable Length check box is selected.

Status The status of the circuit. See Filters on page 40 for more
information on the filter types.

Cap Displays a Y in the Capacity column if the circuit has

exceeded the specified threshold level. This column will
only display data if the Capacity Check option is
checked.

Alm Displays a Y in the Alarm column if the circuit has a

current alarm. This column will only display data if the
Check for alarms on displayed circuits? option is
checked.

Cmp Indicates the standard to which this circuit complies.

I indicates ITU
A indicates ANSI

Table 3–4. Results Tables section; fields

41
QUERYING RECORDS
Circuits Tabs

Navigate Buttons
Use the navigate buttons to Zoom up or Zoom down to the bearers or
tributaries of a selected circuit. These buttons are:

Button Description

Click the Zoom Up button to zoom up through the circuit hierarchy

and view the bearers for a particular circuit.

Click the Zoom Down button to zoom down through the circuit
hierarchy and view the tributaries for a particular circuit.

Table 3–5. Navigate buttons

Display Buttons
The buttons in the Display section of the Circuits tab are shown in the table
below.

Button Description

Click the Circuit Edit button to display the Circuit Editing window.
See Circuit Editing Window on page 71 for more information on
displaying circuit details.

Click the Network Element button to display the Network

Elements window.
See Network Elements Window on page 71 for more information on
displaying network elements.

Click the Spare Capacity Information button to display the

Circuit Capacity window.
See Displaying Circuit Capacity Details on page 67 for more
information on displaying the circuit capacity.

Table 3–6. Display buttons

42
 QUERYING RECORDS
Circuits Tabs

Reports Buttons
The buttons in the Reports section of the Circuit Query window are listed below.
Use them to produce a report for the selected circuit.

Button Description

Shows the Hierarchy Up report for selected circuit.

Shows the Hierarchy Down report for selected circuit.

Shows the Circuit Design report for the selected circuit.

Shows the Circuit Configuration report for the selected circuit.

Table 3–7. Report buttons

43
QUERYING RECORDS
Network Elements Tab

Network Elements Tab

The Network Elements tab has the following sections:

Section See…

Search Conditions page 44

Results Table page 47

Display Button page 48

Figure 3–3. Generic Query window; Network Elements tab

Search Conditions
Use the Search Conditions section to enter a value and perform a query. The
records you retrieve will depend on the:
• search criteria
• query type
• filters.

44
 QUERYING RECORDS
Network Elements Tab

Search Criteria
The search criteria is the value or word that you enter in the Search For field. This
information helps the database find the information you are looking for.
See Search Criteria on page 37 for more information on using the wildcard
characters and the Copy button to further define your search criteria.

Query Types
To search the database you need to select a query type.

Note
The information that is returned in the Network Element Query tab is
always a list of network elements.

The Query Types are:

Query Type Description

Alternate Name Retrieves the network element that uses the specified
alternate name.

Cables Displays all network elements related to the specified

cable name.

Circuit Name Displays all network elements that are used by the
specified circuit.

Excc Code Displays all network elements that match the Common
Language Equipment Identifier (CLEI) you enter as your
search criteria.

Customer Displays all network elements that are used by the

specified customer.

Network Element Displays a specific network element that matches the

equipment, location and index entered as your search
criteria. Separate search criteria with a semi-colon.

Frames Displays all network elements related to the specified

frame (type;location required as minimum search
conditions).

Table 3–8. Query Types

45
QUERYING RECORDS
Network Elements Tab

Query Type Description

Locations Displays all network elements located at the specified

site.

Area Displays all network elements belonging to the specified

area.

Manufacturer Displays all network elements that match the specified

manufacturer.

Model Type Displays all network elements that match the specified
model type.

NE Type Displays all network elements that have the specified

network element type.

Service Type Displays all network elements that have the specified
service type.

Service Order No. Displays all network elements that are associated with the
specified service order.

Table 3–8. Query Types

Filters
You can also apply one or more filters to your search. A ticked check box will
include a network element record that has that status.
The filters are:

Filter Type Description

Spare Includes network elements that have a status of spare.

Planned Includes network elements that have a status of planned.

Commissioned Includes network elements that have a status of

commissioned.

Inservice Includes network elements that have a status of inservice.

Table 3–9. Filter types (sheet 1 of 2)

46
 QUERYING RECORDS
Network Elements Tab

Filter Type Description

Out of Service Includes network elements that have a status of out of

service.

Table 3–9. Filter types (sheet 2 of 2)

Results Table
This table displays the results of the query.

Note
The number of network element records retrieved and the currently
selected row are displayed underneath the results table.

The fields in the Results Table section are:

Field Description

Network Element Abbreviation for the network element type.

Type

Network Element The physical location of the network element.

Location

Index Index number assigned to the network element. This

number is unique to a site to facilitate identification.

Customer The abbreviation for the leased services customer.

Manufacturer The abbreviation for the manufacturer of the network

element.

Status The current status of the network element.

Exchange Code The exchange code for the network element.

Inservice Date The date the network element was placed inservice.

Port Utilization Indicates the no. of ports utilized compared to the no. of
free ports for the network element.

Table 3–10. Results Table section; fields

47
QUERYING RECORDS
Network Elements Tab

Display Button
The button in the Display section is:

Button Description

Click the Network Element button to display the Network

Elements window in the context of the selected record.
Note: A record must be selected to open this window.

Table 3–11. Display section; buttons

48
 QUERYING RECORDS
Customer Tab

Customer Tab
The Customer tab has the following sections:

Section See…

Search Conditions page 49

Results Table page 52

Display Button page 52

Figure 3–4. Generic Query window; Customer tab

Search Condition
Use the Search Conditions section to enter a value and perform a query. The
records you retrieve will depend on the:
• search criteria
• query type
• filters.

49
QUERYING RECORDS
Customer Tab

Search Criteria
The search criteria is the value or word that you enter in the Search For field. This
information helps the database find the information you are looking for.
See Search Criteria on page 37 for more information on using the wildcard
characters and the Copy Current Value button to further define your search
criteria.

Query Types
To search the database you need to select a query type.

Note
The information that is returned in the Customers Query window is
always a list of customers.

The query types are:

Query Type Description

Alternate Name Retrieves the details of the customer that match the
alternate name.

Cables Retrieves the details of all customers who are assigned to

circuits which are defined for any cable given the cable
sheath name.

Circuit Name Retrieves the details of the customer that owns the
specified circuit.

Abbreviation Retrieves the details of all customers that match the

specified abbreviation.

Customer Name Retrieves the details of the customer that matches the
specified search criteria.

Customer Type Retrieves the details of all customers that match the
specified type.

Network Element Retrieves the details of all customers using the specified
network element. Search criteria must include equipment,
location and index, separated with a semi-colon.

Table 3–12. Query types

50
 QUERYING RECORDS
Customer Tab

Query Type Description

Frames Retrieves the details of all customers assigned to circuits

using the specified frame name.

Locations Retrieves all customers that reside at the specified

location.

Service Order No. Retrieves the details of the customer that is associated
with the specified service order.

Service Type Retrieves the details of all customers utilizing services of

the specified type.

Speed Retrieves the details of all customers that are using

services that match the specified speed.

Status Retrieves the details of all customers that match the

specified status.

Table 3–12. Query types (continued)

Filters
You can also apply one or more filters to your search.
The filter types are:

Filter Type Description

Active Includes customers that have a status of Active

Inactive Includes customers that have a status of Inactive.

Staged Includes customers that have a status of Staged.

Table 3–13. Filter types

51
QUERYING RECORDS
Customer Tab

Results Table
The Results Table section displays the results of the query.

Note
The number of customer records retrieved and the currently selected row
are displayed underneath the results table.

The fields in the Result Table section are:

Column Description

Abbreviation Unique abbreviation for the customer.

Name The complete customer or company name.

Type The customer classification, e.g. Telco, Corporate, etc.

Status The current status of the customer.

Company Number The customer company registration/ABN number.

Industry Code Industry classification.

Table 3–14. Results Table section; fields

Display Button
The button in the Display section of the Customer tab is shown in the table
below.

Button Description

Click the Customer Accounts button to display the Customer

Accounts window in the context of the selected record.
Note: A record must be selected to open this window.

Table 3–15. Display button

52
 QUERYING RECORDS
Service Orders Tab

Service Orders Tab

The Service Orders tab has the following sections:

Section See…

Search Conditions page 53

Results Table page 55

Display Button page 56

Figure 3–5. Generic Query window; Service Orders tab

Search Conditions
Use the Search Conditions section to enter a value and perform a query. The
records you retrieve will depend on the:
• search criteria
• query type
• filters.

53
QUERYING RECORDS
Service Orders Tab

Search Criteria
The search criteria is the value or word that you enter in the Search For fields.
This information helps the database find the information you are looking for.
See Search Criteria on page 37 for more information on using the wildcard
characters and the Copy button to further define your search criteria.

Query Types
To search the database you need to select a query type.

Note
The information that is returned in the Service Order Query window is
always a list of service orders.

The query types are:

Query Type Description

Cables Displays all service orders that contain the specified cable
as part of the order.

Circuit Name Displays the details of the service order that is associated
with the specified circuit.

Customer Displays all service order details for the specified

customer.

Network Element Displays all service orders that involve the specified
network element. Search criteria must include equipment,
location and index, separated with a semi-colon.

Frames Displays all service orders that contain the specified

frame as part of the order.

Locations Displays all service orders that contain the specified

location as part of the order.

Order Type Displays all service order details that match the specified
service order type.

Priority Displays all service order details that match the specified
service order priority.

Table 3–16. Query Types section (sheet 1 of 2)

54
 QUERYING RECORDS
Service Orders Tab

Query Type Description

Service Order No. Displays the details of the service order that matches the
criteria.

Service Type Displays all service order details that match the specified
service type.

Speed Displays all service order details that match the specified
speed.

Status Displays all service order details that match the specified
status.

Table 3–16. Query Types section (sheet 2 of 2)

Filters
You can also apply one or more filters to your search.
The filters are:

Filter Type Description

Proposed Includes service orders with a status of Proposed.

Approved Includes service orders with a status of Approved.

Cancelled Includes service orders with a status of Cancelled.

Closed Includes service orders with a status of Closed.

Table 3–17. Filters

Results Table
This Results Table section displays the results of the query.

Note
The number of service order records retrieved and the currently selected
row are displayed underneath the results table.

55
QUERYING RECORDS
Service Orders Tab

The fields in the Results Table section are:

Field Description

S.O. Number Unique service order number.

Service Type The type of service requested by the customer.

Priority The level of importance assigned to this service order.

Customer Abbreviation for the customer requesting the service.

Order Type The type of service requested.

Status The current status of the service order.

Status Date The date the status was last updated.

Speed The operational speed of the circuit or bearer for this

service.

Table 3–18. Results Table section; fields

Display Button
The button in the Display section is:

Button Description

Click the Service Order Details button to display the Service

Orders window in the context of the selected record.
Note: A record must be selected to open this window.

Table 3–19. Display section; button

56
 QUERYING RECORDS
Frames Tab

Frames Tab
The Frames tab has the following sections:

Section See…

Search Conditions page 57

Results Table page 59

Display Button page 60

Figure 3–6. Generic Query window; Frames tab

Search Conditions
Use the Search Conditions section to enter a value and perform a query. The
records you retrieve will depend on the:
• search criteria
• query type
• filters.
See Search Criteria on page 37 for more information on using the wildcard
characters.

57
QUERYING RECORDS
Frames Tab

Query Types
To search the database you need to select a query type.

Note
The information that is returned in the Frames tab is always a list of
frames.

The query types are:

Query Type Description

Alternate Name Displays the frames that are associated with the alternate
name.

Cables Displays the details of the cables that are associated with
the specified frame.

Circuit Name Displays the details of the frame that is associated with
the specified circuit.

Customer Displays all frames for the specified customer.

Network Element Displays all frames that are related to the specific
network elements search criteria.

Frames Displays all frames that are related to the specific frames
search criteria.

Locations Displays all frames at the specified location.

Manufacturer Displays all frames made by the specified manufacturer.

Frame Type Displays all frames of the specified frame type.

Product Type Displays all frames of the specified product type.

Service Type Displays all frames that supply the specified service type.

Service Order No. Displays the details of the service order that matches the
criteria.

Table 3–20. Query Types section

58
 QUERYING RECORDS
Frames Tab

Filters
You can also apply one or more filters to your search.
The filters are:

Filter Type Description

Spare Includes frames that have a status of Spare.

Planned Includes frames that have a status of Planned.

Commissioned Includes frames that have a status of Commissioned.

Inservice Includes frames that have a status of Inservice.

Out of Service Includes frames that have a status of Out of service.

Table 3–21. Filter types

Results Table
This table displays the results of the Frames query.

Note
The number of records retrieved and the currently selected row are
displayed underneath the results table.

Field Description

Frame Container The name of the frame container.

Frame Location The location of the frame.

Type The type of frame.

Index The index number assigned to the frame. This number is

unique to a site to facilitate identification.

Frame Unit The name of the frame unit.

Table 3–22. Results Table section fields (sheet 1 of 2)

59
QUERYING RECORDS
Frames Tab

Field Description

Unit Position The unit position in the frame or rack.

Table 3–22. Results Table section fields (sheet 2 of 2)

Display Button
The button in the Display section is:

Button Description

Click the Frame button to display the Frames window for the
selected frame record. See Frames Window on page 300 for more
information.

Table 3–23. Display section buttons

60
 QUERYING RECORDS
Cables Tab

Cables Tab
The Cables tab has the following sections:

Section See…

Search Conditions page 57

Results Table page 59

Display Button page 60

Figure 3–7. Generic Query window; Cables tab

Search Conditions
Use the Search Conditions section to enter a value and perform a query. The
records you retrieve will depend on the:
• search criteria
• query type
• filters.
See Search Criteria on page 37 for more information on using the wildcard
characters.

61
QUERYING RECORDS
Cables Tab

Query Types
To search the database you need to select a query type.

Note
The information that is returned in the Cables tab is always a list of
cables.

The query types are:

Query Type Description

Alternate Name Displays the cables that are associated with the alternate
name.

Cables Displays the details of the cables that match the search
conditions.

Circuit Name Displays the details of the cable that is associated with
the specified circuit.

Customer Displays all cables for the specified customer.

Frames Displays all frames that are related to the specific cable
search criteria.

Locations Displays all cables at the specified location.

Manufacturer Displays all cables made by the specified manufacturer.

Network Element Displays all cables that are related to the specific network
elements search criteria.

Product Type Displays all cables of the specified product type.

Table 3–24. Query Types section

Filters
You can also apply one or more filters to your search.

62
 QUERYING RECORDS
Cables Tab

The filters are:

Filter Type Description

Spare Includes cables that have a status of Spare.

Planned Includes cables that have a status of Planned.

Commissioned Includes cables that have a status of Commissioned.

Inservice Includes cables that have a status of Inservice.

Out of Service Includes cables that have a status of Out of service.

Table 3–25. Filter types

Results Table
This table displays the results of the Cables query.

Note
The number of cables retrieved and the currently selected row are
displayed underneath the results table.

Field Description

Cable Name The name of the cable.

Cable Type The type of cable.

Manufacturer The name of the cable’s manufacturer.

Number of Cores The number of cores in the cable.

Cable Core(s) The actual cable cores being used by the circuit. This field
is only displayed when Circuit Name is used as the
query type.

Status The status of the cable, e.g. Inservice.

Cable Length The length of the cable.

Table 3–26. Results Table section fields

63
QUERYING RECORDS
Cables Tab

Display Button
The button in the Display section is:

Button Description

Click the Cable button to display the Cable Editing window for
the selected cable record. See Cables Window on page 328 for
more information.

Table 3–27. Display section buttons

64
 QUERYING RECORDS
Features of the Generic Query Window

Features of the Generic Query Window

The features of the Generic Query window are:

Feature See…

Opening the Generic Query window page 34

Querying Records page 66

Displaying Circuit Capacity Details page 67

Using the Navigation Buttons page 70

Opening Additional Windows page 71

65
QUERYING RECORDS
Querying Records

Querying Records
This procedure describes how to query a record in the Generic Query window.
To query a record
1 Open the Generic Query window.
See Generic Query Window on page 34 for more information.
2 Select the tab for the type of query you want to perform.
3 Type your search criteria in the Search For box.
See Search Criteria on page 37 for more information about search criteria.
4 Select the Query Type you require.
5 Click the Filters that you want to apply to your search.
6 Click the Search button.
The query results are displayed in the results table.
7 Repeat steps 1-5 for each new search.

Note
For more information about the query types and filters for each tab, refer
to the following sections:

– see Circuits Tabs on page 36 for the Circuits tab

– see Network Elements Tab on page 44 for the Network Elements tab
– see Customer Tab on page 49 for the Customer tab
– see Service Orders Tab on page 53 for the Service Orders tab
– see Frames Tab on page 57 for the Frames tab
– see Cables Tab on page 61 for the Cables tab

Hint
When you open the Generic Query window it is already in search mode.

Check that the correct Query Type is selected for the search criteria you
are using.

Double-click a record in the results table to open the corresponding

record in read-only mode.

66
 QUERYING RECORDS
Displaying Circuit Capacity Details

Displaying Circuit Capacity Details

From the Circuit tab of the Generic Query window you can display the following
details for a selected circuit:
• Spare Bearer Capacity
Spare bearer capacity refers to the unused bandwidth available for a
selected circuit. This is calculated by comparing the speed (in Kbps) for the
bearer record with the total speed of its tributaries.
• Spare Configured Ports
The A end and B end ports on the terminating network element of the circuit
that are free for use.

Additional Spare Configured Port Details

Additional details about spare configured ports are also available by opening the
Network Elements window for the circuit record you have queried.
Scroll through these records and view the cards/slots, parent ports and child ports
for each network element used by the selected circuit.

Viewing Circuit Capacity and Spare Configured Ports

To display spare bearer capacity and spare configured ports for a
circuit
1 Query a circuit record in the Circuits tab of the Generic Query window.
See Querying Records on page 66 for more information on querying a
circuit.
2 Select the circuit record then click the Spare Capacity Information display
button.
The Circuit Capacity window is opened.
3 Compare the values in the Speed and Speed of Tributaries fields to
calculate spare bearer capacity.

67
QUERYING RECORDS
Displaying Circuit Capacity Details

4 Use the Spare Configured Ports section of the window to view the existing
spare configured ports for the circuit.

Hint
The value in the Speed (Kbps) field relates to the circuit record in the
Circuit field.

The value in the Speed of Tributaries field relates to the total value of
the speeds for child records in the Tributaries section of the window.

Figure 3–8. Circuit Capacity window

Note
Card may be null, e.g. where logical ports are used.

Fields
The fields in the Circuit Capacity window are:

Field Description

Circuit Circuit name.

ServiceID Unique service order identification number.

Speed (Kbps) The speed in kilobits per second of the nominated circuit
(bearer).

Table 3–28. Circuit Capacity window; fields (sheet 1 of 2)

68
 QUERYING RECORDS
Displaying Circuit Capacity Details

Field Description

Speed of Tributaries The total sum of the speed (in kilobits per second) of all
child circuits.

Number of The number of child circuits associated with this circuit.

Tributaries

Over X% Capacity? A flag to indicate if the speed of tributaries is greater

than the specified bearer speed.
The percentage value defaults to 85% if it has not been
changed in the Circuits tab of the Generic Query
window.

Tributaries section

Tributary The child circuits for the selected bearer.

Trib# The logical number for the tributary in an internal

breakdown of the bearer.

Speed Circuit speed of the child.

Spare Configured Ports Section

Terminating The terminating network element at the A end of the

Network Element A circuit.
End

Port Name (A End) The port name at the A end of the circuit.

Card Name (A End) The card name at the A end of the circuit.

Terminating The terminating network element at the B end of the

Network Element B circuit.
End

Port Name (B End) The port name at the B end of the circuit.

Card Name (B End) The card name at the B end of the circuit.

Table 3–28. Circuit Capacity window; fields (sheet 2 of 2)

69
QUERYING RECORDS
Using the Navigate Buttons

Using the Navigate Buttons

Use the Navigate buttons to browse the circuit records. You can:
• zoom up to bearers
• zoom down to tributaries.

Zoom Up to Bearers
This section describes how to browse up the circuit hierarchy and view the bearers
for a particular circuit.
To zoom up to bearers
1 Query a circuit in the Circuits tab of the Generic Query window.
See Querying Records on page 66 for more information about querying
records.
2 Click the circuit record that you want to view.
3 Click the Zoom up display button.
A list of all bearers that exist for the selected circuit record are displayed in
the Circuit Name field.

Zoom Down to Tributaries

This section describes how to browse down the circuit hierarchy and view the
tributaries for a particular circuit.
To zoom down to tributaries
1 Query a circuit in the Circuits tab of the Generic Query window.
See Querying Records on page 66 for more information about querying
records.
2 Click the circuit record that you want to view.
3 Click the Zoom Down display button.
A list of all tributaries that exist for the selected circuit record are displayed in
the Circuit Name field.

Hint
You need to have circuit records displayed in the results panel of the
Circuits tab before you zoom up or down.

70
 QUERYING RECORDS
Opening Additional Windows

Opening Additional Windows

From the tabs in the Generic Query window you can open these additional
windows by clicking the related Display button when a record is selected in the
results table:
• Circuit Editing window from the Circuits tab
• Network Elements window from the Circuits and Network
Elements tabs
• Customer Accounts window from the Customer tab
• Service Order Details window from the Service Orders tab
• Frames window from the Frames tab
• Cables window from the Cables tab.

Note
All additional windows, except the Network Elements window, are
opened in the same way as the Circuit Editing window by clicking on the
related Display button.

Circuit Editing Window

This section describes how to open the Circuit Editing window from the Circuit
tab.
To open the Circuit Editing Window
1 Query a circuit in the Circuits tab of the Generic Query window.
See Querying Records on page 66 for more information.
2 From the Circuit tab, select the circuit you want and then click the Circuit
Edit display button.
The Circuit Editing window is displayed.

Note
This window contains detailed information about circuits on the network.
It is used to view and maintain circuit details. Refer to the Editing Circuits
chapter for a detailed explanation of this window.

Hint
You need to have circuit records displayed in the results panel.

Network Elements Window

This section describes how to open the Network Elements Window from the
Circuit tab and Network Element tab.

71
QUERYING RECORDS
Opening Additional Windows

To open the Network Elements window

1 Query a circuit in the Circuits tab or Network Elements tab of the Generic
Query window.
See Querying Records on page 66 for more information.
2 From the Circuits tab or Network Elements tab, select the circuit you want
and then click the Network Elements display button
or
3 From the Network Elements tab, double-click a record in the Results
section.
The Network Elements window is displayed.

Note
Use this window to query, create, modify and delete network element
information. See Chapter 11, Network Elements for more information on
the Network Elements window.

72
 CHAPTER 4

Facility Query

This section describes how to use the Facility Query Module window to view
facilities available for a requested service.

73
FACILITY QUERY
Facility Query Module Window

Facility Query Module Window

Use the Facility Query Module to view facilities available for providing a service
in a particular area. You can query the available facility in an area using the
following three search criteria:
• Neighbour’s Phone Number
• Location Address
• Service Address
To open the Facility Query Module window
• From the Inventory menu, select Query and then click Facility.
The Facility Query Module window is displayed.

Figure 4–1. Facility Query Module window

The Facility Query Module window will only be displayed under the Inventory
module in the Clarity menu if the product feature ALL:00341 has been enabled
in the Product Features Parameters form.

74
 FACILITY QUERY
Facility Query Module Window

The Facility Query Module window has the following sections:

Section See…

Neighbour’s Phone Number tab page 75

Location Address tab page 77

Service Address tab page 78

Query section page 78

Frames tab page 79

Network Elements tab page 81

Neighbour’s Phone Number Tab

Use this tab to query available facilities using the neighbour’s phone number.

Figure 4–2. Neighbour’s Phone Number tab

75
FACILITY QUERY
Facility Query Module Window

Fields
The fields in the Neighbour’s Phone Number tab of the Facility Query
Module window are:

Field Description

Neighbour’s number The neighbour’s telephone number that will be used to

identify the facilities in the area where the service
needs to be provided. Use LOV to select a value. This
number is derived from the value stored under the
Service Order attributes for the related Service Order.
The specific attribute under which a number must be
stored for a particular service is determined by the
product feature SM:00321. For example, for a PSTN
Service, the number will be stored under the attribute
SA_NEIGHBOURS_PHONE_NUMBER, and for D-P2P
service, it will be stored under the attribute NEAREST
SLT PH0NE B-END.

Exchange Details

Exchange Code Automatically populated with the code of the exchange

that provides the neighbour’s service.

Area Code The code that represents the charging area.

Type The name of the service type provided.

Location The location of the exchange.

Index The instance of the exchange at the displayed location.

Table 4–1. Neighbour’s Phone Number tab fields

76
 FACILITY QUERY
Facility Query Module Window

Location Address Tab

Use this tab to query available resources using the location of the facility, which is
closest to the customer, and which will be used to connect a service to that
customer.

Figure 4–3. Location Address tab

Fields
The fields in the Location Address tab of the Facility Query Module window
are:

Field Description

Level Number The floor level in the building.

Suite Number The room suite number.

Street Number The street number.

Street Name The name of the street.

Suburb The name of the suburb in which the street resides.

Post Code The post code of the displayed suburb.

City The name of the city in which the suburb is located.

State The name of the state in which the city is located.

Country The name of the country.

Table 4–2. Location Address tab fields

77
FACILITY QUERY
Facility Query Module Window

Service Address tab

Use this tab to query facilities using the address of the customer as a search
parameter.

Figure 4–4. Service Address tab

Note
The field definitions are the same as the Location Address field
descriptions.

Query Section
Use this section to query all details, or just frames or network element
information.

Figure 4–5. Query section of Facility Query Module window

Fields
The fields in the Query section of the Facility Query Module window are:

Field Description

Query Select a query type from the drop-down list:

• All
• Frames
• Network Element.

Entity Type The frame container type. Use LOV to select a value.

Use the Query button to execute the facility query.

Table 4–3. Query section fields

78
 FACILITY QUERY
Facility Query Module Window

Frames Tab
Use this tab to view frames information.

Figure 4–6. Frames tab of Facility Query Module window

Fields
The fields in the Frames tab of the Facility Query Module window are:

Field Description

Type The type of frame container. This will be same as the

type selected in the Frame Container Types search
field.

Location The location of the frame container.

Index The instance of the frame container type at the

specified location.

Address The address details for the frame container.

Frame Unit Name The name of the unit within the frame container.

Frame Unit Location The location of the frame unit.

Table 4–4. Frames tab fields (sheet 1 of 2)

79
FACILITY QUERY
Facility Query Module Window

Field Description

Frame Appearances

Position The position number of the termination on the frame

unit.

Side The side of the frame unit where the cable terminates,
i.e. front or rear.

Circuit Name The name of the circuit connected to the frame

position. Double click to display the circuit details in the
Circuit Design window. See Circuit Design Window on
page 106 for more information.
Note that non-active circuits, i.e. those whose status is
not 'Reserved' or 'In-service will be displayed only when
product feature IM:01009 is enabled.

New Circuit Status The current status of the circuit, e.g. Inservice,
Proposed.

Unnamed Connection Indicates if this appearance has been pre-cabled to

provide connections to other facilities.

Table 4–4. Frames tab fields (sheet 2 of 2)

80
 FACILITY QUERY
Facility Query Module Window

Network Elements Tab

Use this tab to view network elements information.

Figure 4–7. Network Elements tab of Facility Query Module window

Fields
The fields in the Network Elements tab of the Facility Query Module window
are:

Field Description

Network Element Details

Type The equipment type of the network element.

Location The location of the network element.

Index The unique instance of the selected network element at

the selected location.

Exchange Code The exchange code for the network element.

Status The current status of the network element, e.g. Spare,

Planned, Commissioned, In Service.

Table 4–5. Network Elements tab fields (sheet 1 of 3)

81
FACILITY QUERY
Facility Query Module Window

Field Description

In Service date The date on which the network element will be in

service. The date format is DD-MMM-YYYY.

IP The IP or internet address of the network element.

Customer The customer owning or leasing the network element.

Manufacturer The manufacturer of the network element.

Model Type The manufacturer’s model type of the network

element.

Card Details

Slot The card slot on the network element.

Card Type The card type (or name) of the card currently in the
slot.

Model The model of the card type.

Revision The software revision of the card.

Card Status The status of the card, e.g. Spare, Planned,

Commissioned, In Service.

Card Mode The card mode, e.g. Working, Protect or Neither.

Port Details

Slot The port slot on the network element.

Port Name The generic port name.

Port Usage The usage of the port, e.g. AMS-HMS.

Status The current status of the port, e.g. Spare, Planned,

Commissioned, In Service.

Table 4–5. Network Elements tab fields (sheet 2 of 3)

82
 FACILITY QUERY
Facility Query Module Window

Field Description

Name The circuit name associated with the port. Note that
non-active circuits, i.e. those whose status is not
'Reserved' or 'In-service will be displayed only when
product feature IM:01009 is enabled.

Phone Number The phone number associated with the port.

Table 4–5. Network Elements tab fields (sheet 3 of 3)

83
FACILITY QUERY
Features of the Facility Query Module Window

Features of the Facility Query Module Window

The features of the Facility Query Module window are:

Feature See...

Opening the window page 74

Querying available facilities page 85

84
 FACILITY QUERY
Querying Available Facilities

Querying Available Facilities

The following procedures describes how to search for available facilities in the
Facility Query window.
To query a facility query record
1 Open the Facility Query Module window.
See Facility Query Module Window on page 74 for more information.
2 Use LOV to select the Neighbour’s Number. Optionally, click on the
Location and the Service Address tab and enter the parameters to search
for a facility based on the location of the facility or the customer address.
3 Use the Entity Type LOV to select a valid frame container type.
4 Click the Query button in the Query options section of the Facility Query
Module window.
5 The results display in the Frames and Network Elements tabs.

85
FACILITY QUERY
Querying Available Facilities

86
 CHAPTER 5

Query Event History

This section describes the window accessed from the Query Event History menu
option in the Inventory Suite.

87
QUERY EVENT HISTORY
Config Change History Window

Config Change History Window

Use the Config Change History window to track the changes made to entities in
the Clarity Inventory Suite. You can use this window as an audit trail to track
what happens to a specific entity throughout its lifecycle.
To open the Config Change History window
1 From the Inventory menu, select Query and then click Event History.
2 Click on the tab of the entity you want to track.
The following entities are available:
– Cards
– Circuits
– Network Elements
– Frame Appearance
– Frame Containers
– Frame Units
– Ports
– Port Links
– Port Link Ports
– Rings.

Search Values
Use the drop-down list in the search criteria section of each tab to select a search
category. All tabs can search by:
• DATE
The date the change was made
• OPERATIONS
The operation performed on the entity, e.g. update, delete.
• USERS
The username of the person that made the change.
You can also search directly for the entity by name. In these instances an LOV is
provided.

Note
If no search criteria is provided, then all records are retrieved.

88
 QUERY EVENT HISTORY
Config Change History Window

Cards
To view the change history of card records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Cards tab to display the card history window.
3 In the Search For box, use the drop-down list to select one of the following
values:
– CARDS
– DATES
– OPERATIONS
– USERS.
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
For information about the fields in the display area:
• See Card Slots Section on page 257
• See Card Models on page 546

Figure 5–1. Config Change History window; Cards tab

89
QUERY EVENT HISTORY
Config Change History Window

Circuits
To view the change history of circuit records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Circuits tab to display the circuit history window.
3 In the Search For box, use the drop-down list to select one of the following
values:
– CIRCUITS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Circuit Details on page 107 for more information about the fields in the
display area.

Figure 5–2. Config Change History window; Circuits tab

90
 QUERY EVENT HISTORY
Config Change History Window

Network Elements
To view the change history of network element records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Network Elements tab to display the network element history
window.
3 In the Search For box, use the drop-down list to select one of the following
values:
– EQUIPMENTS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Network Elements Section on page 208 for more information about the fields
in the display area.

Figure 5–3. Config Change History window; Network Elements tab

91
QUERY EVENT HISTORY
Config Change History Window

Frame Appearances
To view the change history of frame appearance records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Frame Appearances tab to display the frame appearance history
window.
3 In the Search For box, use the drop-down list to select one of the following
values:
– FRAME APPEARANCE
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Frames Window on page 300 for more information about the fields in the
display area.

Figure 5–4. Config Change History window; Frame Appearances tab

92
 QUERY EVENT HISTORY
Config Change History Window

Frame Appearance Status

Status Description

Spare This status is applicable to frame

appearances that are physically
present but have no connectivity and
thus are not actively use in the
network.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance of the Spare status.

Planned This status is applicable to frame

appearances that are not yet present
in a frame container but a plan is in
place to install them at a later date.
Planned frame appearances are
usually present on Planned frame
units.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance of the Planned status.

Table 5–1. Frame Appearance - status descriptions

93
QUERY EVENT HISTORY
Config Change History Window

Status Description

Inservice This status is applicable to frame

appearances that are available for
use.
The frame appearances of this status
will be visible in the List of Values of
the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility
It is possible to change the status of a
circuit to “In Service” via the Circuit
Design window if all the frame
appearances of the cross connections
of the circuit are in Inservice status.

Out of Service This status is applicable to frame

appearances that are temporary
unavailable for use.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance in Out of Service status.

Table 5–1. Frame Appearance - status descriptions

94
 QUERY EVENT HISTORY
Config Change History Window

Status Description

Bad Pin This status is applicable to frame

appearances that are faulty.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance in the Bad Pin status.

Locked This status is applicable to frame

appearances that for the time being
cannot be terminated to.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance in Locked status.

Table 5–1. Frame Appearance - status descriptions

95
QUERY EVENT HISTORY
Config Change History Window

Status Description

Pending OSP BC This status is applicable when the

status of the corresponding Outside
Plant (OSP) bulk change event is
changed to the Commissioning
status.
This status cannot be selected from the
Status list in the Frame Appearance
area of the Frame window.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance in the Pending OSP BC
status.

Frozen This status is applicable when the

status of the corresponding Outside
Plant (OSP) bulk change event is
changed to Frozen status.
This status cannot be selected from the
Status list in the Frame Appearance
area of the Frame window.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance in the Frozen status.

Table 5–1. Frame Appearance - status descriptions

96
 QUERY EVENT HISTORY
Config Change History Window

Status Description

Blocked This status is applicable when a frame

container is temporary unavailable for
use. Changing the status of the frame
container to “Blocked”, automatically
changes the status of the frame units
and frame appearances to the
Blocked status. Changing the status
of the frame container from Blocked
status to In Service status,
automatically changes the status of the
frame unit and the frame
appearances to their previous status.
The main purpose of this status is to
temporally block objects without
having to modify the associated cables
and circuits.
This status cannot be selected from the
Status list in the Frame Appearance
area of the Frame window.
The frame appearances of this status
will not be visible in the List of Values
of the valid Frame Appearances in the
Cross Connections area of the
Circuit Design window.
The frame appearances of this status
will be ignored by the Reserve Facility.
It is not possible to change the status
of a circuit to “In Service” via the
Circuit Design window if the circuit
has a cross connection with a frame
appearance in the Blocked status.

Table 5–1. Frame Appearance - status descriptions

Frame Containers
To view the change history of frame container records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Frame Containers tab to display the frame container history
window.

97
QUERY EVENT HISTORY
Config Change History Window

3 In the Search For box, use the drop-down list to select one of the following
values:
– FRAME CONTAINERS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Frames Window on page 300 for more information about the fields in the
display area.

Figure 5–5. Config Change History window; Frame Containers tab

Frame Units
To view the change history of frame unit records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Frame Units tab to display the frame unit history window.

98
 QUERY EVENT HISTORY
Config Change History Window

3 In the Search For box, use the drop-down list to select one of the following
values:
– FRAME UNITS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Frames Window on page 300 for more information about the fields in the
display area.

Figure 5–6. Config Change History window; Frame Units tab

Ports
To view the change history of port records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Ports tab to display the Port History window.

99
QUERY EVENT HISTORY
Config Change History Window

3 In the Search For box, use the drop-down list to select one of the following
values:
– PORTS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Port Details Tab on page 275 for more information about the fields in the
display area.

Figure 5–7. Config Change History window; Ports tab

Port Links
To view the change history of port link records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Port Links tab to display the port link history.

100
 QUERY EVENT HISTORY
Config Change History Window

3 In the Search For box, use the drop-down list to select one of the following
values:
– SEQUENCES
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Cross Connections on page 117 for more information about the fields in the
display area.

Figure 5–8. Config Change History window; Port Links tab

Port Link Ports

To view the change history of port link ports records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Port Link Ports tab to display the port link ports history.

101
QUERY EVENT HISTORY
Config Change History Window

3 In the Search For box, use the drop-down list to select one of the following
values:
– LINKS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.
See Cross Connections on page 117 for more information about the fields in the
display area.

Figure 5–9. Config Change History window; Port Link Ports tab

Rings
To view the change history of ring records
1 Open the Config Change History window.
See Config Change History Window on page 88 for more information.
2 Click the Rings tab to display the ring history window.
3 In the Search For box, use the drop-down list to select one of the following
values:
– RINGS
– DATES
– OPERATIONS
– USERS
4 Enter the corresponding search criteria in the Search Value field.
5 Click the Search button.
Matching records are displayed.

102
 QUERY EVENT HISTORY
Config Change History Window

See Ring Definitions on page 169 for more information about the fields in the
display area.

Figure 5–10. Config Change History window; Rings tab

103
QUERY EVENT HISTORY
Config Change History Window

104
 CHAPTER 6

Editing Circuits

This section shows you how to open and use the Circuit Design window. This
window is used to create, modify, and delete circuit records.

105
EDITING CIRCUITS
Circuit Design Window

Circuit Design Window

This window contains detailed information about circuits on the network. It is used
to view and maintain circuit details.
To open the Circuit Design window

• From the Inventory menu, select Circuits, and then click Circuit
Design.
The Circuit Design window is displayed.

Figure 6–1. Circuit Design window

The Circuit Design window has the following sections:

Section See…

Circuit Details page 107

Buttons page 112

Cross Connections page 117

Bearers page 118

Tributaries page 120

106
 EDITING CIRCUITS
Circuit Design Window

Circuit Details
Use this section to enter and modify circuit detail information.

Figure 6–2. Circuit Details section in the Circuit Design window

Fields
The fields in the Circuit Details section are:

Field Description

Name The unique circuit name that has been created and
saved in the database. This field is used to query a circuit
in the database.

Alt Name Displays the alternative name assigned to the circuit. The
button on the right of this field invokes the Alternate
Circuit Names window which can be used to define an
alternate name for the circuit. This button is disabled in
the Enter-Query mode.
Use this window to add, modify or delete alternative
names for the selected circuit. See Inserting Alternate
Name Records on page 127 for more information.

Table 6–1. Circuit Details section; fields (sheet 1 of 4)

107
EDITING CIRCUITS
Circuit Design Window

Field Description

Compliance The compliance standard for the circuit name. The

compliance standards available are as follows:
• ANSI
• ITU
• ITN-NS
The fields that are displayed directly to the right of the
Compliance field change according to the compliance
standard selected. The Circuit Name is derived from the
the values entered by the user in these additional fields.
See ANSI Circuit Name Compliance Fields on page 110
for a description of the fields when you select ANSI.
See ITU Circuit Name Compliance Fields on page 111 for
a description of the five fields when you select ITU.
See ITU-NS Circuit Name Compliance Fields on page 112
for information on this compliance standard.
Optionally, the user can choose not to enforce any
naming standard and select None from the
Compliance drop-down list. When None is selected, a
mandatory Circuit Name field is displayed adjacent to
the Compliance field. It is a free text field and any value
that the user enters here is automatically populated in the
Name field which reflects the name of the circuit.

Customer The name of the customer that owns or leases the circuit.
Use LOV to select a value. (Mandatory)
Customer records are set up in the Customer Accounts
window. Refer to Getting Started with Clarity OSS for
more information.

Cust Name The full name of customer who owns or leases the circuit.

Service ID Service order identifier assigned number concatenated

with the service order revision number.
This number is automatically generated if this circuit is
part of a work order.

Table 6–1. Circuit Details section; fields (sheet 2 of 4)

108
 EDITING CIRCUITS
Circuit Design Window

Field Description

Service Type The type of service that is supported on the currently

selected circuit. If a service type is selected when creating
or querying a circuit, only those ports will be available
for selection in the Cross Connections section that
support the selected service type or are associated with a
service type template that includes that service type.

Account The customer account. A customer can have many

accounts and multiple services. This parameter allows
users to query a circuit based on a specific customer
account.

Telco/DP A End Displays the Location address of the starting point of the
Address service. For point to point services, this will be the
customer’s A-end location address. For non-data
services, this will be the switch location code address,
indicating the point of service origination.

DP B End Address Displays the location address of the terminating point of

the service, indicating the point of service termination on
the telco equipment.

Status Current status of the circuit, e.g. Commissioned. Use the

drop-down list to select a value.

Inservice Date The date the service is expected or placed into service.
Format is DD-MMM-YYYY.

Out of Service Date The date the circuit becomes out-of-service.

Format is DD-MMM-YYYY.

Speed Guaranteed speed of operation for this service.

Circuit Type Classification of this service. “Lease”, “Bearer”, etc. Use

the drop-down menu to make a selection. This
information is set up in the Check Constraints window.
Refer to Getting Started with Clarity OSS for more
information.

Designer Person who designed (created) the circuit including the

network element interconnections.

Table 6–1. Circuit Details section; fields (sheet 3 of 4)

109
EDITING CIRCUITS
Circuit Design Window

Field Description

Comments Free text area for comments.

Press Ctrl-E to display the Editor window. In the Editor
window you can view, enter, delete or modify text.

Include Alarm Select this box if a check is to be made on alarms as part

Check in query of a query.

unnamed Alarm indicator. (Read-only)

If alarms are associated with the circuit, the alarm
indicator displays (in red) the text Alarms.
If alarms are not associated with the circuit, the alarm
indicator displays (in green) the text No Alarms.

unnamed Planned event indicator. (Read-only)

If the circuit is associated with a planned event, the
planned event indicator displays (in red) the text PEs.
If the circuit is not associated with a planned event, the
planned event indicator displays (in green) the text No
PEs.
If the planned event indicator is red, double-clicking it
invokes a Planned Events window which displays the
numbers of the planned events with which the circuit is
associated.

For Inter-Ring If the circuit is used to connect two Rings, select the A end
bearers: of the ring.
‘A’ Ring

For Inter Ring If the circuit is used to connect two Rings, select the B end
bearers: of the ring.
‘B’ Ring

Table 6–1. Circuit Details section; fields (sheet 4 of 4)

ANSI Circuit Name Compliance Fields

When you change the Compliance field to ANSI, the five fields displayed to the
right of the Compliance field change names.

Figure 6–3. ANSI circuit name compliance section

110
 EDITING CIRCUITS
Circuit Design Window

The fields displayed for ANSI circuit names are:

Field Description

Location A The A end location name.

Location Z The Z end location name.

Ch/Ts The channel or time slot code.

Type Code The facility type code.

Desig Code The facility designation code.

Table 6–2. ANSI circuit name compliance fields

ITU Circuit Name Compliance Fields

When you change the Compliance field to ITU, the five fields displayed to the
right of the Compliance field change names.

Figure 6–4. ITU circuit name compliance section

The fields displayed for ITU circuit names are:

Field Description

Location A The A end location name.

Location B The B end location name.

Note: When the ITU Circuit Name Compliance is
selected, the Location B value must be
alphabetically greater than the Location A value
else they will be swapped. The Circuit Name is a
concatenation of Location A, Location B, Prefix,
and Index, where Location A and Location B are
alphabetically sorted (smaller to greater). Thus the
Location A name must always come before the
Location B Name in the alphabetical order.

Table 6–3. ITU circuit name compliance fields (sheet 1 of 2)

111
EDITING CIRCUITS
Circuit Design Window

Field Description

Prefix A prefix that is placed within the circuit name. This prefix
is often used to identify the speed of the circuit.

Index The sequence number of the circuit.

Suffix An optional suffix that can be appended to the circuit

name.

Table 6–3. ITU circuit name compliance fields (sheet 2 of 2)

ITU-NS Circuit Name Compliance Fields

The ITU-NS or ITU - Non Sorted compliance is the same as the ITU naming
compliance with the exception that it does not follow the sorting algorithm used in
the ITU compliance standard, i.e., the location names are not alphabetically
sorted (from smaller to greater) when deriving the Circuit Name. The Circuit
Name is a concatenation of Location A, Location B, Prefix, and Index and is
displayed in the same order irrespective of whether Location B is alphabetically
greater or smaller than Location A.

Note
The Location A and Location B fields can only be manually updated if
Product Feature IM:00523 is enabled.

Buttons
The following buttons are available on the Circuit Design window:
• Tool Palette
• Navigate buttons
• Display buttons

Tool Palette
The Tool Palette button displays a list of the functions available from the Circuit
Design window.
Note that the Tool Palette button is disabled when the user is in the Enter-Query
Mode.

112
 EDITING CIRCUITS
Circuit Design Window

The table below describes each option.

Option Description

Alternate Names Opens the Alternate Circuit Names window.

Use this window to add, modify or delete alternative names
for the selected circuit. See Inserting Alternate Name
Records on page 127 for more information.

Attach Files Opens the File Attachments window.

Use this window to attach associated files, such as
documents and spreadsheets to the circuit record. See
Getting Started with Clarity OSS for more information on
creating and deleting links to external files.

Backup Circuits Opens the Backup Circuits window.

Use this window to specify backup circuits to use during
network outages or network degradation. See Specifying
Backup Circuits on page 146 for more information.

Change Name Opens the Circuit Name Change window.

This option is unavailable for circuits that have been created
via a service order. See Modifying Circuit Names on page
130 for more information.

Circuit Attributes Open the Circuit Attributes window. The window displays
attributes for the circuit. See Associating Circuit Attributes
with Circuits on page 134 for more information.

Circuit Opens the Clarity Circuit Diagrammer application.

Diagrammer See the Clarity Circuit Diagrammer User Manual for more
information about this application.

Contacts Opens the Contacts window.

Use this window to record the contact details at the A and B
end of the circuit. See Modifying Circuit Contacts on page
130 for more information.

Table 6–4. Tool Palette Options

113
EDITING CIRCUITS
Circuit Design Window

Option Description

Copy Circuit Opens the Copy Circuit window.

Use this window to copy the details of an existing circuit
record to help in creating a new circuit record. See Copying
Circuit Records on page 137 for more information about
copying circuits.

Copy Opens the Copy Cross Connections window.

Xconnections Use this window to copy the cross connection definitions of
an existing circuit record to the current circuit record. See
Copying Circuit Cross Connections on page 140 for more
information about copying circuit cross connections.

Costed Items Open the Costed Item List for Circuits window.
Use this window to record the costs associated with the
circuit. Costed items are set up in the Costed Items
reference window. Refer to the Clarity Provisioning Suite
Reference for more information.

Customer and Opens the Customer and Account Address window.

Accounts Use this window to view customer and account addresses
related to the circuit. See Customer and Account Address on
page 148 for more information on the customer and
account address.

Design Assistant Opens the Bearer Path Options window.

Use this window to bundle the number of ports required to
produce a required circuit speed and copy the details to the
Circuit Design window. See Bearer Path Options on page
149 for more information on opening the bearer window
and adding the cross connection.

Port Transfer Opens the Port Transfer window.

Use this window to transfer the source bearer (the currently
selected circuit) to a destination bearer and termination
port. See Port Transfer on page 152 for more information
on transferring ports.

Provision Ring Opens the Ring Cross Connections window.

Use this window to create cross connections through a ring
for a selected circuit. See Ring Cross Connections on page
154 for more information on creating cross connections.

Table 6–4. Tool Palette Options

114
 EDITING CIRCUITS
Circuit Design Window

Option Description

Provision Sub- Opens the Provision a Sub-Network window.

Network Use this window to define a route for a circuit through a
sub-network. See Creating Sub-Network Connections on
page 159 for more information on creating sub-network
connections.

Reverse Reverses the order of the cross connections in the current

Xconnections circuit.

Service Address Opens the Service Address window. See Service Address
on page 162 for more information.

Verify Ports Use to check that the ports selected in the cross connections
Usage are not reserved for use by other circuits. If there are ports
reserved by other circuits, such as circuits with a status of
Out Of Service, the Other Circuits Reserving These Ports
window is displayed, listing the ports and associated circuit
names. See Verify Ports Usage on page 163 for more
information.

View Reservation Opens the View Reservation window.

Details Use this window to the view and modify the Expiry Date and
Notify date for the proposed circuit. See View Reservation
Details on page 165 for more information.

Table 6–4. Tool Palette Options

Note
Customers can define additional buttons to execute a database
procedure or call an Oracle form. This button can be defined in the
Application Tool Palette window under the Applications > Settings menu.

115
EDITING CIRCUITS
Circuit Design Window

Navigate Buttons
The Navigate buttons are:

Button Description

Zooms up through the circuit hierarchy and view the bearers for the
selected circuit detail record.

Zooms down through the circuit hierarchy and view the tributaries
for the selected circuit detail record.

Table 6–5. Navigate buttons

Display Buttons
The Display buttons are:

Button Description

Click the Alarms button to display the Circuit Affecting Alarms

window in context sensitive mode for the selected circuit.
See Circuit Affecting Alarms on page 124 for more information on
displaying alarms that have affected a circuit.

Click the Network Elements button to display the Network

Elements window in context sensitive mode for the selected circuit.
See Opening the Network Elements Window on page 126 for more
information on viewing network element details for the selected
circuit.

Table 6–6. Display buttons

116
 EDITING CIRCUITS
Circuit Design Window

Cross Connections
This section of the Circuit Design window shows the cross connections for the
selected circuit.

Figure 6–5. Cross Connections section in the Circuit Design window

Fields
The fields in the Cross Connections section are:

Field Description

Seq# Order number for the cross connection appearance in

the window.

Xconnect Describes the type of cross connection, e.g. Physical or

Jumper.

(From) Location Location of network element. Use the LOV button to

select a valid location.
Double-clicking this field will open either the Network
Elements window or the Frames window, depending
upon the record selected in the Type field.

(From) Type Type of network element. Use the LOV button to select a
valid network element type.

(From) Index Instance of network element. Use the LOV button in this
field to select a valid network element.

(From) [Card] Port Terminating port name of the network element (1 or

more) and the slot where the card is located.
Double-click this field to open the Port Name window.
Use this window to view the full port name in instances
where the port name is larger than the field width.

Table 6–7. Cross Connections section; fields (sheet 1 of 2)

117
EDITING CIRCUITS
Circuit Design Window

Field Description

(From) Set Port Allows ports/frame appearances to be filtered when

Display designing cross connections.

(To) Location Location of network element or frame. Use the LOV

button to select a valid location.
Double-clicking this field will open either the Network
Elements window or the Frames window, depending
upon the record selected in the Type field.

(To) Type Type of network element.

(To) Index Instance of network element.

(To) [Card] Port Terminating port name of the network element (1 or

more) and the slot where the card is located.
Double-click this field to open the Port Name window.
Use this window to view the full port name in instances
where the port name is larger than the field width.

(To) Set Port Display Allows ports/frame appearances to be filtered when

designing cross connections.

Table 6–7. Cross Connections section; fields (sheet 2 of 2)

Button
The button in the Cross Connections section is:

Button Description

Opens the Port Parameters window.

Use this window to add or load port parameters to the
selected network elements.

Table 6–8. Cross Connections section; button

Bearers
This section displays the bearer circuits associated with the ports selected in the
Cross Connections section.

118
 EDITING CIRCUITS
Circuit Design Window

When a circuit created in the proposed status uses a parent port, it becomes the
bearer circuit. When you create another circuit that uses a child port, then the new
circuit will become a tributary of the circuit that was created earlier.

Note
To refresh the records displayed in the Bearers section, re-query the
Circuit Details record. See Querying Circuit Details on page 123 for more
information.

Figure 6–6. Bearers section of the Circuit Design window

To view the bearer details in the Circuit Design window, select a bearer and use
the Zoom Up button in the Navigate section.

Fields
The fields in the Bearers section are:

Field Description

Bn# Number indicating the order of bearers where more than

one are chained to provide a path for the circuit.

Bearer Name Unique circuit name.

Status Indicates the status of the bearer. This section will show
bearers with the states such as:
• (P) Planning Stage
• (I) Inservice
• (O) Out of Service.

Table 6–9. Bearers section; fields (sheet 1 of 2)

119
EDITING CIRCUITS
Circuit Design Window

Field Description

Path The path the bearer is used for. This is the value
allocated for the bearer in the Routing Definition
window.
You can change the value of this field by selecting one of
the following values from the drop down list:
• Normal
• Span Protect
• Ring Protect
• Path Protect
• Diverse

Table 6–9. Bearers section; fields (sheet 2 of 2)

Tributaries
This section displays the tributary circuits that are associated with the ports defined
in the Cross Connections section.
When a circuit created in the proposed status uses a parent port, it becomes the
bearer circuit. When you create another circuit that uses a child port, then the new
circuit will become a tributary of the circuit that was created earlier. See Inserting
Bearer and Tributary Records on page 129 for more information about tributaries.

Note
To refresh the records displayed in the Bearers section, re-query the
Circuit Details record. See Querying Circuit Details on page 123 for more
information.

Figure 6–7. Tributaries section in the Circuit Design window

To view the tributary circuit details in the Circuit Design window, select a tributary
record and use the Zoom Down button in the Navigate section.

120
 EDITING CIRCUITS
Circuit Design Window

Fields
The fields in the Tributaries section are:

Field Description

Trib# Tributary order within bearer. May be the logical tributary

number.

Tributary Name Unique circuit name.

Status Indicates the status of the tributaries. This section will

show tributaries with the states such as:
• (P) Planning Stage
• (I) Inservice
• (O) Out of Service

Path The path the tributary is used for. This is the value
allocated for the tributary in the Routing Definition
window.
You can change the value of this field by selecting one of
the following options from the drop down list:
• Normal
• Diverse.

Table 6–10. Tributaries section; fields

121
EDITING CIRCUITS
Features of the Circuit Design Window

Features of the Circuit Design Window

The features of the Circuit Design window are.

Feature See…

Opening the Circuit Design window page 106

Querying circuit details page 123

Circuit affecting alarms page 124

Opening the Network Elements window page 126

Creating circuit records page 127

Modifying circuit records page 130

Copying circuit records page 137

Copying circuit cross connections page 140

Deleting circuit records page 142

Using the Navigate buttons page 145

Specifying Backup Circuits page 146

Viewing the Customer and Accounts page 148

Address

Viewing Bearer Path options page 149

Viewing Port Transfer options page 152

Creating ring cross connections page 154

Create sub-network connections page 159

Verifying port usage page 163

Viewing reservation details page 165

122
 EDITING CIRCUITS
Querying Circuit Details

Querying Circuit Details

To query circuit details
1 Open the Circuit Design window
See Circuit Design Window on page 106 for more information.
2 Click the Query button.
The window is now in query mode.
3 Click the field that you want to query.
4 Enter your search criteria.
5 Click the Query button.
The query results are displayed in the Circuit Details section. Any cross
connections, bearers or tributaries are also shown in the corresponding
sections of the window.
6 Repeat steps 1 to 4 for each new search.

Note
When there are multiple circuits with the same circuit display name but
different statuses, by default, the oldest circuit will be displayed first on
query. However, if Product Feature IM:00841 is enabled, the circuits will
be sorted based on the display name and the order of their status in the
check constraint values screen.

Note
Use the scroll bar in the Circuit Details section to look at the other
retrieved records.

Hint
Choose fields for queries that are unique for the circuit that you are
looking for. For example, query by customer to find all circuits for a
customer within the network.

123
EDITING CIRCUITS
Circuit Affecting Alarms

Circuit Affecting Alarms

You can display alarms that have affected a circuit in a recent specified period.
To see if a selected circuit has been affected by alarms
1 Query a circuit detail in the Circuit Design window.
See Querying Circuit Details on page 123 for more information.
2 Click the Display Alarms button.
The Circuit Affecting Alarms window is displayed. This window shows all
previous and current alarms within the specified period.
3 Type the number of previous hours that you want to use.
4 Click the Search button.

Figure 6–8. Circuit Affecting Alarms window

Hint
Enter the value in the hours field within the Circuit Affecting Alarm
window to reflect the alarm period that you need.

Use the scroll bar to search the retrieved records.

Fields
The fields in the Circuit Affecting Alarms window are:

Field Description

Hours The period (in hours) that you want the database to
search for circuits that have been affected by alarms.

Alarm ID Alarm identification number.

Table 6–11. Circuit Affecting Alarms window; fields (sheet 1 of 2)

124
 EDITING CIRCUITS
Circuit Affecting Alarms

Field Description

NE Type Type of network element reporting alarm.

Index Instance of the network element type at location.

Location The location of the network element reporting alarm.

Port The name of the port that is attached to the circuit and
alarm.

NEMS Network element management system.

Alarm Type The type of alarm that has been set off.

Reported The time the alarm was set off.

Cleared The time when the alarm was cleared. The value is null if
the alarm is current.

Table 6–11. Circuit Affecting Alarms window; fields (sheet 2 of 2)

125
EDITING CIRCUITS
Opening the Network Elements Window

Opening the Network Elements Window

Open the Network Elements window to view network element details for a
selected circuit.
To open the Network Elements window
1 Query a circuit record in the Circuit Design window.
See Querying Circuit Details on page 123 for more information on querying
a circuit detail record.
2 Display the required circuit.
3 Click the Display Network Elements button.
The Network Elements window is displayed.

Note
The Network Elements window is displayed in the context of the current
circuit. That is, all elements this circuit passes through at its base level are
displayed in the Network Elements window. See Chapter 11, Network
Elements for further information about this window.

126
 EDITING CIRCUITS
Creating Circuit Records

Creating Circuit Records

You can insert the following types of records in the Circuit Design window:
• circuit detail records
• alternate names (other names)
• cross connections
• bearers
• tributaries

Creating Circuit Detail Records

A circuit detail record is made up of the fields in the Circuit Detail section of the
Circuit Design window.
To insert a Circuit Detail record
1 Open the Circuit Design window.
See Circuit Design Window on page 106 for more information on opening
the Circuit Design window.
2 Click on the Location A field and use LOV to select an A end location for the
circuit.
3 Press the TAB key and then use LOV to enter a B end for the circuit.
4 Tab to the Type Code or Prefix field and enter the circuit type, e.g. 1.5 Mbs.
5 Press the TAB key.
A unique circuit sequence number is generated and is displayed in the Desig
Code or Index field.
6 Complete the remaining required fields and then click the Save button.
See Circuit Details on page 107 for more information about the fields in the
Circuit Details section.

Hint
The LOV button is highlighted for those fields that allow values to be
selected.

If you have just executed a query, click the Insert button to place the
window in insert mode.

Inserting Alternate Name Records

To insert an Alternate Name record
1 Open the Circuit Design window and query a circuit detail record.
See Querying Circuit Details on page 123 for more information.

127
EDITING CIRCUITS
Creating Circuit Records

2 Click the Tool Palette button and then click Alternate Names.
The Alternate Circuit Names window is displayed.
Optionally, click on the Alternate Names button displayed on the right of the
Alt Names field in the Circuit Design window. This will also bring up the
Alternate Circuit Names window.
3 Click the Name field and enter an alternate circuit name.
4 Click the Type field and enter the type as a grouping for the name, e.g.
Customer or Other Carrier.
5 Click the Exit button to close the window.
6 Click the Save button.

Note
Alternate names are unique in the context of the related circuit. In
contrast, circuit names are unique across the system. Alternate names can
be used as a query criteria in the Circuit Query window.

Figure 6–9. Alternate Circuit Names window

Fields
The fields in the Alternate Circuit Names window are:

Field Description

Name The alternate circuit name.

Type The type of alternate circuit.

Table 6–12. Alternate Circuit Names window; fields

128
 EDITING CIRCUITS
Creating Circuit Records

Inserting Cross Connection Records

To insert a record in the Cross Connection section
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for more information
2 Click the Seq# field in the Cross Connections section of the window.
3 Complete all the fields in the Cross Connections section.
4 Click the Save button.

Hint
The Circuit Design window opens in insert mode by default. However, if
there is no empty space in a section that requires additional records, you
will need to use the Insert button to create the extra space in this section.

Within the circuit creation process it is possible to add ports already

assigned to an existing circuit and that has been commissioned or placed
Inservice. However, the application prevents you from changing the status
of this new circuit to Inservice or Commissioned.

Inserting Bearer and Tributary Records

The bearer and tributary section are automatically populated. These records are
dependent upon the ports selected in the Cross Connections section. Port
hierarchy is determined by the parent and child ports definition in the Network
Elements window and if these records are updated, the bearer and tributary
records will also be updated in the Circuit Design window after the Circuit
Details record is re-queried.
See Querying Circuit Details on page 123 for more information about querying
circuit detail records. Also see Creating Network Element Records on page 288 for
more information on creating port records.

129
EDITING CIRCUITS
Modifying Circuit Records

Modifying Circuit Records

You can modify the following types of records from the Circuit Design window:
• circuit names
• circuit contacts
• circuit details.
You can also associate service attributes with circuits.

Modifying Circuit Names

This section shows you how to modify an existing circuit name in the Circuit
Design window.
To change a Circuit Name
1 Query a circuit detail.
2 Click the Tool Palette button and then click Change Name.
The Circuit Name Change window is displayed.
3 Enter the new circuit name.
See ANSI Circuit Name Compliance Fields on page 110 and also see ITU
Circuit Name Compliance Fields on page 111 for more information about
naming circuits.
4 Click the Change Name button.
5 Click on the Save button.
The changes are saved to the database.

Figure 6–10. Circuit Name Change window

Modifying Circuit Contacts

This section shows you how to link and de-link circuit contact details in the Circuit
Design window.
To modify a Circuit Contact detail
1 Query a Circuit detail.

130
 EDITING CIRCUITS
Modifying Circuit Records

2 Click the Tool Palette button and then click Contacts.

The Circuit Contacts window is displayed.
3 Click the A End or B End contact that you want to change.
4 Use LOV to enter the new record required.
5 Click the Save button.
The changes are saved to the database.
6 Click the Close button to return to the Circuit Design window.

Hint
Location contacts are automatically linked based on the Customer field
in the Circuit Details section of the Circuit Design window. The values
in the Contact Person and Designation fields (and the Other Contacts
section) reflect the current A end or B end contact.

Figure 6–11. Contacts window

Fields
The fields in the Contacts window are:

Field Description

Circuit Name The name of the currently selected circuit.

A End Contact

Seq Numeric sequence number, starting from 1.

Table 6–13. Contacts window; fields (sheet 1 of 3)

131
EDITING CIRCUITS
Modifying Circuit Records

Field Description

Site Name The name of the site at the A end location of the circuit.

Contact Type The method of contact at the A end of the circuit, e.g.
phone, fax.

Contact Numbers The numbers used to reach the selected contact person at
the A end of the circuit.

Availability The hours of availability for the contact person.

Contact Person The name of the contact person at the A end of the
circuit.

Designation The classification or job description of the contact person

at the A end of the circuit.

B End Contact

Seq Numeric sequence number, starting from 2.

Site Name The name of the site at the B end location of the circuit.

Contact Type The method of contact at the B end of the circuit, e.g.
phone, fax.

Contact Numbers The numbers that can be used to reach the selected
contact person at the B end of the circuit.

Availability The hours of availability for the contact person.

Contact Person The name of the contact person at the B end of the
circuit.

Designation The classification or job description of the contact person

at the B end of the circuit.

Other Contacts

Seq Numeric sequence number, starting from 3.

Site Name The name of the site where the other contact is located.

Table 6–13. Contacts window; fields (sheet 2 of 3)

132
 EDITING CIRCUITS
Modifying Circuit Records

Field Description

Customer The name of the customer where the other contact is

located.

Contact Type The method of contact, e.g. phone, fax.

Contact Numbers The numbers used to reach the selected contact person.

Availability The hours of availability for the contact person.

Name The name of the contact person.

Designation The classification or job description of the contact person.

Table 6–13. Contacts window; fields (sheet 3 of 3)

Modifying Circuit Details

This section shows you how to modify circuit details in any section of the Circuit
Design window.
To modify any circuit detail
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for further information on
querying a circuit.
2 Click in the field that you want to modify.
3 Highlight the value or text that you want to change.
4 Type the new information that you want to enter.
You can use the LOV button to select the information for those fields where
selection is available from a list of values.
5 Click the Save button.
Your changes are now saved to the database.

Note
Circuits that are created via a service order can only be modified via a
service order. However, if Product Feature IM:00342 is enabled, the status
of a circuit created by a Service Order, can also be modified or updated
in the Circuit Design window.

Product feature IM:00421 allows customers to specify the service types for
which the Location B field should be automatically updated when a
distribution point at a different location is selected in a cross connection.
Formerly, the service types for which the Location B field should be updated

133
EDITING CIRCUITS
Modifying Circuit Records

were hard-coded. By default, this functionality is disabled). If customers

require this functionality, they must enable the product feature(IM:00421) first
via the Product Features Parameters window and then define the service types
(as parameter value) based on the instructions below:
The 'Value' field that is associated with feature parameter IM:00422 must
be set according to the service types for which the Location B field should
be automatically updated. The required format is
'ServiceType1,ServiceType2,ServiceType3' etc. If '%' is included, a wildcard
match will be performed. For example, if 'Value' is set to
'PSTN%,ADSL%,CCB', the Location B field will be updated for circuits
whose service type is 'PSTN', 'PSTN1', 'PSTN2' etc., 'ADSL', 'ADSL1',
'ADSL2' etc. or 'CCB'. (Note that single quotes should not be included in
the string)
Product feature IM:00521, when enabled, provides functionality such that for a
specific set of services, the circuit's display name is automatically updated when
the Location A or Location B field is updated either manually or automatically. This
feature is turned off by default. Customers who require this functionality must first
enable product feature IM:00521, and then define service groups under the
parameter IM:05222. The circuit display name of those circuits will be
automatically updated (when the location field is updated) whose service type is
included in the comma-separated list defined by product feature parameter
IM:05222.
Location A/Location B field is updated only when the cross connection's status is
'CHANGED' (i.e. the cross connection has already been committed

Associating Circuit Attributes with Circuits

The section shows you how to associate a set of circuit attributes with a circuit.
To associate a set of circuit attributes
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for further information on
querying a circuit.
2 Click the Tool Palette button and then click the Circuit Attributes button.
The Circuit Attributes window is displayed.
3 Click the Load Circuit Attributes button.
This loads a set of predefined service attributes for the selected Service used
on the circuit. This set of predefined service attributes is maintained in the
Circuit Details Template reference window. See Circuit Details Templates
on page 426 for more information about this window.
You can also manually add additional service attributes.
4 Click the Save button.

134
 EDITING CIRCUITS
Modifying Circuit Records

5 Click the Exit button to close the window.

Figure 6–12. Circuit Attributes window

Fields
The fields in the Copy Attributes window are:

Field Description

Name The name of the circuit attribute.

Data Type The data type. Select from:

• Character
• Number Date
• Alphanumeric
• No Validation

Value The value of the circuit attribute (read only).

Specified By Identifies the person specifying the circuit attribute:

• Customer
• Engineer
• Customer

Optionality Select from:

• Create
• Close
• Optional
• Fixed

Table 6–14. Copy Attributes window; fields

135
EDITING CIRCUITS
Modifying Circuit Records

Button
The button on the Copy Attributes window is:

Button Description

Load Circuit This button loads a set of predefined service attributes for
Attributes the selected Service used on the circuit.

Table 6–15. Copy Attributes window; button

136
 EDITING CIRCUITS
Copying Circuit Records

Copying Circuit Records

You can copy a circuit record displayed in the Circuit Design window.
To copy a circuit record
1 Query the circuit record to copy in the Circuit Design window.
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click the Copy Circuit button.
The Copy Circuit window is displayed.
3 In the No of New Circuits field, enter the number of copies you want to
create.
4 From the Allocation Rule drop-down list, select one of the following:
– Choose next available - The system uses the existing circuit design as
a template and copies the cross connect details from this existing design
choosing the next available free port or frame appearance when
creating the cross connections.
– Choose next available, trace cable - Same as above but if there are
cables connecting the entities, the system checks for the next available
free port or frame appearance, then traces the connecting cable to find
and select the entity connected at the opposite end.
– Reuse existing design - The system copies all the cross connect
information from the existing circuit design.
– Header Only - If this allocation rule is selected, the system copies only
the circuit header.
5 From the New Circuit Status drop-down list, select the status of the copied
circuit(s).
6 If you wish to have the copied circuit named with the same display name as
the source circuit, select Re-use Display Name check box.

Note
If you select the above check box, you can create only one copy.
7 If you wish to copy the service id of the source circuit to the copied circuit(s),
select Copy Service ID check box.

Note
The service type of the source circuit is copied regardless of the
above selection.
8 Click the Copy Circuit button.
The new circuit(s) are created. The names of these new circuits are displayed
in the New Circuits section.
9 Click the Save button.

137
EDITING CIRCUITS
Copying Circuit Records

10 Click the Exit button to close the window.

Figure 6–13. Copy Circuit Window

138
 EDITING CIRCUITS
Copying Circuit Records

Fields
The fields in the Copy Circuit window are:

Field Description

Source Circuit

Circuit Name The name of the circuit, that is to be copied.

No. of New Circuits The number of copies that are to be created.

Allocation Rule Select from the following rules:

• Choose next available
• Choose next available, teace cable
• Reuse existing design
• Header Only

New Circuit Status The status of the new circuit. Select from:
• Proposed
• Recommended
• Reviewed
• Commissioned
• In service
• Out of Service
• Cancelled
• Pending delete

Re-Use Display If this check box is selected, the copied circuit will have
Name the same display name as the source circuit, provided
that there is no other existing circuit with the same display
name and status

Copy Service ID If this check box is selected, the service id of the source
circuit is copied. Note that, regardless of wether or not
this check box is selected, the service type is copied.

New Circuits

Circuit Name Name of the new circuit(s).

Table 6–16. Copy Circuit window; fields

139
EDITING CIRCUITS
Copying Circuit Cross Connections

Copying Circuit Cross Connections

When you are creating or editing a circuit, you can copy the cross connection
definitions in an existing circuit record to the current circuit.

Note
Cross connections can only be copied to a circuit with a Proposed status.

To copy a circuit cross connection

1 Create a new circuit record, or query the circuit record that you want to add
the cross connections.
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click the Copy Xconnection button.
The Copy Cross Connections window is displayed.
3 In the Circuits field, use LOV to select the circuit name the contains the cross
connections that you want to copy.
4 From the Apply following rule drop-down menu, choose one of the
following:
– Choose next available - The system uses the existing circuit design as
a template and copies the cross connect details from this existing design
choosing the next available free port or frame appearance when
creating the cross connections.
– Choose next available, trace cable - Same as above but if there are
cables connecting the entities, the system checks for the next available
free port or frame appearance, then traces the connecting cable to find
and select the entity connected at the opposite end.
– Reuse existing design - The system copies all the cross connect
information from the existing circuit design.
5 Click the Copy button.
The cross connection details are copied from the selected circuit to the
current circuit.
6 Click the Exit button on the Copy Cross Connections window.

Figure 6–14. Copy Cross Connections window

140
 EDITING CIRCUITS
Copying Circuit Cross Connections

Fields
The fields in the Copy Cross Connections window are:

Field Description

Circuit The name of the circuit where cross connections have to

be copied from.

Start with Cross The starting order sequence number for the cross
Connect Seq# connection.

Apply the following Select from the following rules:

rule • Choose next available
• Choose next available, teace cable
• Reuse existing design

Reserve Cross Checkbox option to reserve the cross connections

Connections

Table 6–17. Copy Cross Connections window; fields

141
EDITING CIRCUITS
Deleting Circuit Records

Deleting Circuit Records

You can delete the following types of records from the Circuit Design window:
• circuit details
• cross connections
• alternate names

Deleting Circuit Detail Records

To delete a circuit detail record
1 Query a circuit detail record.
Use the scroll bar to select the circuit detail record.
2 Click the Name field.
This will select the circuit detail record.
3 Click the Delete button.
The message dialog box is displayed.
4 Click the Yes button to confirm the deletion.
5 Click the Save button. The record is deleted.

Circuit Expiry and Deletion

Circuits can also be automatically deleted or expired through Product feature
IM:00541, which allows the user to specify the number of days that will be used
as a default value for setting the expiry date of circuits that should be expired. This
product feature is disabled by default. The user must enable it and configure the
parameter value in order to set up the automatic deletion and expiration of
circuits. This product feature enables the following:
A database procedure is set up to automatically delete the expired circuits. The
expiry and notification dates are automatically set when a circuit conforms to the
following criteria:
i. Circuit status is CANCELLED and its expiry date is null
ii. Circuit status is RESERVED, its expiry date is null, it has no associated
active service order and it has a reservation id.

142
 EDITING CIRCUITS
Deleting Circuit Records

The rule for setting the expiry date is as described below:

– If the circuit is associated with a service type then
set the expiry date for the CANCELLED circuits based on quarantine
days (sert_quarantine_days)
set the expiry date for the RESERVED circuits based on reserve days
(sert_reserve_days)
– In case any of the reserve/quarantine days was null, use a default value
(which has been set in product feature IM:00541)
Else:
– Set the expiry date based on the default value which has been set in
product feature IM:000541. Product feature IM:00541 is disabled by
default.
In both cases, the notification date is set as = expiry date - notify days
(sert_reserve_notify_days). So, if the notify days is null in the service
definition, then the notification date would be null and no notification will be
issued
Issuing Delete Notification
A delete notification is issued when a circuit conforms to the following
criteria:
– Circuit status is RESERVED, it has no associated active service order, it
has a reservation id and its notification date is less than or equal to the
sysdate
– Circuit status is CANCELLED and its notification date is less than or
equal to the sysdate
Deleting Expired Circuits
Circuits which conform to the following criteria will be automatically deleted:
– Circuit status is PENDINGDELETE
– Circuit status is RESERVED, it has no associated active service order, it
has a reservation id and its expiry date is less than or equal to the
sysdate.
– Circuit status is CANCELLED and its expiry date is less than or equal to
the sysdate.
Note that all the parent circuits are excluded from the process.

Deleting Cross Connection Records

To delete a Cross Connection
1 Query a circuit detail record.
Use the scroll bar to select the circuit detail record.
2 Click the Seq# field in the Cross Connections section.

143
EDITING CIRCUITS
Deleting Circuit Records

3 Click the Delete button.The Cross Connection is deleted from the database.

Note
All bearers and tributaries related to the cross connection port are
also removed from Bearers and Tributaries sections.
4 Click the Save button.

Note
If you close the Circuit Design window after deleting records without
saving the changes, a message dialog box is displayed. Click Yes to save
all changes. Click No to discard changes. Click Cancel to return to the
Circuit Design window.

Deleting Alternate Name Records

To delete an Alternate Name record
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for more information.
2 Click the Tool Palette button and then click the Alternate Names button.
The Alternate Circuit Names window is displayed.
3 Delete the alternate name record that you no longer require using the
Delete button that is available in the toolbar.
4 Click the Close button.
5 Click the Save button.

Note
Alternate names are unique in the context of the related circuit. In
contrast, circuit names are unique across the system. Alternate names can
be used as a query criteria in the Circuit Query window.

144
 EDITING CIRCUITS
Using the Navigate Buttons

Using the Navigate Buttons

Use the Navigate buttons to browse related circuit detail records. You can
perform the following browses:
• zoom up to bearer circuit details
• zoom down to tributary circuit details.

Zooming Up To Bearers for Circuit Details

This section describes how to browse through the circuit hierarchy and view the
bearers for a particular circuit detail.
To zoom up to bearer circuit details
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Bearer Name in the Bearers section that you want to view.
3 Click the Zoom Up button.
The bearer record is retrieved and shown in the Circuit Details section.

Hint
You need to have bearer records displayed in the Bearers section of the
Circuit Design window before you zoom up. You need to select the
subject bearer.

Zooming Down to Tributaries for Circuit Details

This section describes how to search down through the circuit hierarchy and view
the tributaries for a particular circuit detail.
To zoom down to tributary circuit details
1 Query a circuit in the Circuit Design window.
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tributaries Name in the Tributaries section that you want to view.
3 Click the Zoom Down button.
The tributary record is retrieved and shown in the Circuit Details section.

Hint
You need to have tributary records displayed in the Tributaries section of
the Circuit Design window before you zoom down. You need to select
the subject tributaries.

145
EDITING CIRCUITS
Specifying Backup Circuits

Specifying Backup Circuits

Use the Backup Circuits option in the Tool Palette to access the Backup Circuits
window where you can view and add backup, alternative, diverse, redundant or
stand by circuits for a selected circuit.
Backup circuits can be assigned to any primary circuit that is normally in use.
When a fault occurs in a primary circuit, any one of the assigned backup circuits
can take over, depending on the priority defined.

Note
Backup circuits must already exist in the database to be available via the
LOV button.

Viewing Backup Circuits for a Selected Circuit

To open the Backup Circuits window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click Backup Circuits.
The Backup Circuits window is displayed. This window displays back up,
alternative and stand by circuits that have been specified for the selected
circuit.

Figure 6–15. Backup Circuits window

146
 EDITING CIRCUITS
Specifying Backup Circuits

Fields
The fields in the Backup Circuits window are:

Field Description

Sequence Defines the sequence in which the backup circuit will be

used.

Circuit Name The name of the circuit. Use LOV to select a circuit.

Type The type of restoration method. Use drop-down list to

select one of the following options:
• Back Up
Selected when the primary circuit needs to be
substituted.
• Stand By
Selected as a stand by circuit for the primary circuit
• Alternate
Selected as the alternate path to the path normally
used by the primary circuit.

Table 6–18. Backup Circuits window; fields

147
EDITING CIRCUITS
Customer and Account Address

Customer and Account Address

Use the Customer and Accounts option in the Tool Palette to access the
Customer and Account Address window where you can view the address of a
selected circuit.

Viewing the Customer and Account Address for a Selected Circuit

To open the Customer and Accounts Address window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click Customer and Accounts.
The Customer and Account Address window is displayed. This window
displays the address that have been specified for the selected circuit.

Figure 6–16. Customer and Account Address window

Fields
The fields in the Customer and Account Address window are:

Field Description

Customer and The full address of the specified circuit.

Account Address

Table 6–19. Port Transfer window; fields

148
 EDITING CIRCUITS
Bearer Path Options

Bearer Path Options

This section describes how to bundle the number of ports required to produce a
required circuit speed and copy the details to the Circuit Design window.
To open the Bearer Path Options window and add the cross
connection
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for more information on querying
a circuit detail record.
2 Select an entry in the Cross Connections section.
3 Click the Tool Palette button and then click the Design Assistant button.
The Bearer Path Options window is displayed.
4 In the Bearer Path Options window, click the Find Paths button.
A list of path options is displayed.
5 Select a path option from the list.
The related information is displayed in the fields.
6 Select which side you would like to copy the cross connection from in the
drop-down menu. Loc A path option will be copied into the From field and
Loc Z path option will be copied into the To field.
7 Click the Copy Selection button to copy the entry to the Cross Connections
section in the Circuit Design window.

Figure 6–17. Bearer Path Options

149
EDITING CIRCUITS
Bearer Path Options

Fields
The fields in the Bearer Path Options window are:

Field Description

Loc A The location from which the path search should start.

Loc Z The location at which the path search should end.

Additional Filtering Allows filtering on the query by the circuit display name.
by Circuit Name

Speed The speed of the circuits between the specified A and Z

locations.

Service Type The service type supported by the circuits.

Circuit Type Classification of this service.

Path Options to Circuit which starts at Loc A and ends at Loc Z.

next Location

Free Tribs Number of free tributaries for the circuit.

Total Tribs Total number of tributaries for the circuit.

Near End NE / The Network Element or Frame at each end of the circuit.
Frame Details

Manufacturer The manufacturer model type of the network element.

Model

Slot / Frame Unit The port’s slot / frame unit name.

Card Name / Unit The card name and unit card position in the frame or
Position rack.

Port / Frame Name The port/frame at each end of the circuit.

Speed The speed of the port/frame.

Sequence Numeric sequence number, starting from 1.

Table 6–20. Provision a Sub-Network window; fields (sheet 1 of 2)

150
 EDITING CIRCUITS
Bearer Path Options

Field Description

Link Type Cross connection link type.

Side Cross connection side.

Table 6–20. Provision a Sub-Network window; fields (sheet 2 of 2)

Buttons
The buttons in the Bearer Path Options window are:

Button Description

Find Paths Finds the path matching the criteria between Loc A and
Loc Z.

Copy Selection Copies the cross connection details into the cross
connections block of the circuit edit window.

Selection Selects all ports.

Table 6–21. Provision a Sub-Network window; buttons

151
EDITING CIRCUITS
Port Transfer

Port Transfer
Use the Port Transfer option in the Tool Palette to access the Port Transfer
window where you can view the port transfer options for a selected circuit.

Viewing the Port Transfer options for a Selected Circuit

To open the Port Transfer window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click Port Transfer.
The Port Transfer window is displayed.

Figure 6–18. Port Transfer window

152
 EDITING CIRCUITS
Port Transfer

Fields
The fields in the Port Transfer window are:

Field Description

Select the source The name of the source bearer.

bearer

Select the port to Select from the radio button options:

transfer the ports • No end port was found
from • No end port was found

Select the source The child termination port that is the source for the
child termination source bearer.
port

Destination Bearer Where there are multiple possible destination bearers,

select a single destination bearer to use.

Select the The destination child termination port

destination child
termination port

Table 6–22. Port Transfer window; fields

Buttons
The buttons in the Port Transfer window is:

Field Description

Transfer This button transfers the bearer to the new destination

port.

Table 6–23. Port Transfer window; fields

153
EDITING CIRCUITS
Ring Cross Connections

Ring Cross Connections

This section describes how to create ring cross connections for a circuit from the
Circuit Design window. These types of cross connections can be used to provide
path diversity using a combination of selected network elements over one or two
rings. These rings can be adjoining, that is, directly connected, or the rings can be
connected by one or more additional rings.
The intermediate rings section is used to specify additional rings that you may
want to pass through during your path design. This is not mandatory.

Note
Rings need to be created before ring cross connections are added to a
circuit. See Chapter 7, Ring Definitions for more information about using
the Rings windows to create ring definitions.

Rings must be connected to each other by an inter-ring bearer. You define

an inter-ring bearer in the Circuit Design window. To create an inter-ring
bearer, you create a bearer circuit that connects a network element in one
ring (the ‘A’ ring) with a network element in the other ring (the ‘B’ ring). In
this bearer circuit definition, you select the name of each ring in the ‘A’
Ring and ‘B’ Ring fields in the Circuit design window.

Provisioning Ring Cross Connections

To open the Ring Cross Connections window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.

154
 EDITING CIRCUITS
Ring Cross Connections

2 Click the Tool Palette button and then click Provision Ring.
The Ring Cross Connections window is displayed.

Figure 6–19. Ring Cross Connections window

Fields
The fields in the Ring Cross Connections window are:

Field Description

Enter At

Ring Name The name of the ring for the starting point of the cross
connection. Use LOV to select the ring name.

XConnect Type The type of cross connection that will be used for the
starting cross connection. Use LOV to select the cross
connect type.

Direction to The direction to be followed around the ring. Use the

allocate drop-down menu to make a selection. These values are
hard coded i.e. East, West and Both.

Location Network element location for the starting point of the

cross connection. Use LOV to select the location.

Table 6–24. Ring Cross Connections window; fields (sheet 1 of 3)

155
EDITING CIRCUITS
Ring Cross Connections

Field Description

NE Type Network element type used for the starting point of the
cross connection. Use LOV to select the network element
type.

Index Network element index used for the starting point of the
cross connection. Use LOV to select the index number.

Port Name of the port used to create the starting point of the
cross connection. Use LOV to select the port name.

Leave At

Ring Name The name of the ring for the end point of the cross
connection. This ring name can be the same ring name
entered in the Ring Name field in the Enter At section,
or it can be a another ring name. Use LOV to select the
ring name.

XConnect Type The type of cross connection that will be used for the
endpoint cross connection. Use LOV to select the cross
connection type.

Direction to The direction to be followed around the ring. Use the

allocate drop-down menu to make a selection. These values are
hard coded, i.e. East, West and Both.

Location Network element location for the end point of the cross
connection. Use LOV to select the location.

NE Type Network element type used for the end point of the cross
connection. Use LOV to select the network element type.

Index Network element index used for the end point of the
cross connection. Use LOV to select the index number.

Port Name of the port used to create the end point of the
cross connection. Use LOV to select the port name.

Intermediate Rings (in order of allocation)

Table 6–24. Ring Cross Connections window; fields (sheet 2 of 3)

156
 EDITING CIRCUITS
Ring Cross Connections

Field Description

Ring Name The name of the ring that connects the Ring Name
entered in the Enter At section with the Ring Name
entered in the Leave At section.
You can define a sequence of rings that connect the
Enter At and Leave At rings. The ring names must be
listed in sequence order, starting from the ring connected
to the Enter At ring and finishing with the ring connected
to the Leave At ring. Use LOV to select the ring names.

Direction to The direction to be followed within the ring entered in the

allocate Ring Name field in the Intermediate Rings section.
Use the drop-down menu to make a selection. These
values are hard coded.

Intermediate The type of cross connection that will be used for the
Xconnect Type intermediate cross connection. Use LOV to select the
cross connection type.

Start Xconnect The sequence number for the first cross connection.
Sequence At

Table 6–24. Ring Cross Connections window; fields (sheet 3 of 3)

Button
The button in the Ring Cross Connections window is:

Button Description

Assign Xconnect Click this button to assign a cross connect. The ring cross
connections are created and linked to the circuit.

Table 6–25. Ring Cross Connections window; button

Creating Ring Cross Connections

To create cross connections through a ring for a circuit
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for more information about
querying a circuit detail record.

157
EDITING CIRCUITS
Ring Cross Connections

2 Click the Tool Palette button and then click the Provision Ring button.
The Ring Cross Connections window is displayed.
– In the Ring Name field, use LOV to select the ring name that you want
to use.
– In the Location field, use LOV to select the location containing the
network element.
– In the NE Type field, use LOV to select a network element type for the
cross connection.
– In the Index field, use LOV to select the network element index number.
– In the Port field, use LOV to select the network element port name.
– In the Xconnect Type field, use LOV to select a valid crossconnect type.
– In the Direction to allocate field, select one of the following directions
to follow in the ring: Both, East or West.
3 Repeat the above steps to enter values for the fields in the Leave At section
of the window.
4 If the rings are not adjoining, that is, the Enter At and Leave At rings are not
directly connected, you need to identify the rings that provide a path between
them. In the Ring Name and Direction to allocate fields in the
Intermediate Rings section, list the ring names and path directions that
provide the path. The ring names must be listed in sequence order, starting
from the ring that connects to the Enter At ring and finishing with the ring that
connects to the Leave At ring.
5 In the Start XConnect Sequence At field, enter the starting sequence
number of the cross connection.
6 In the Intermediate Xconnect Type field, use LOV to select a valid
crossconnect type for intermediate rings (rings between the Enter At and
Leave At rings).
7 Click the Assign XConnect button.
The ring cross connections are created and linked to the circuit.
8 Click the Exit button on the window.

158
 EDITING CIRCUITS
Creating Sub-Network Connections

Creating Sub-Network Connections

This section describes how to define a route for a circuit through a sub-network. A
sub-network is collection of circuits connected by network elements for a
particular network segment.
To create sub-network connections for a circuit
1 Query a circuit detail record.
See Querying Circuit Details on page 123 for more information on querying
a circuit detail record.
2 Click the Tool Palette button and then click the Provision Sub-Network
button.
The Provision a Sub-Network window is displayed.
3 Enter the starting sequence for the first cross connection.
4 Enter the fields in the window using LOV.
5 Click the Assign XConnect button to start the provisioning process.
A confirmation message will display when the route has been successfully
defined.

Figure 6–20. Provision a Sub-Network window

159
EDITING CIRCUITS
Creating Sub-Network Connections

Fields
The fields in the Provision a Sub-Network window are:

Field Description

Start Seq# The starting sequence number for the first cross
connection.

Sub-Network Name The identifying name of the template. The template

identifies the sub-network definition that is used when
provisioning the service.

Preferred Route The preferred route path for the sub-network. This is a
sequence of sub-network bearers between two sub-
network NEs. Use LOV to select a valid route path.
Note: Multiplexer NEs are not part of a route, and the
preferred route has to be built prior to designing a
sub-network, using the Routing Definition
reference window.
See Routing Definitions on page 185 for more
information about this window.

Enter Sub Network At/Exit Sub Network At

Location The A-end and B-end sites between which the service is
provisioned.

NE Type The network element at the A-end and B-end of the

service.

Index The index of the network element at the A-end and B-

end of the service.

Line Number The network element port with allocated time slots. The
sub-network enters and exits at the ports defined. Use
LOV to choose a network element port for this field.

Starting TS The time slot assigned to the port defined in the Line
Number field. Use LOV to choose a starting time slot.

Logical Port Virtual port defined by the line number and starting
timeslot.

Table 6–26. Provision a Sub-Network window; fields (sheet 1 of 2)

160
 EDITING CIRCUITS
Creating Sub-Network Connections

Field Description

DLCI Dynamic Link Customer Identifier.

DLCI is the Child / Logical port within a Port, e.g. PVC.
The DLCI is allocated to a customer and generates an
alarm when it fails.
The number of DLCIs within a port depends on the Port
capacity.
A DLCI can be used as a port within a circuit. however a
DLCI with a status of Inservice cannot be used in more
than one circuit.
DLCI’s within a port start with a numerical number 016
and is incremented by 1 when a new customer is added.

Table 6–26. Provision a Sub-Network window; fields (sheet 2 of 2)

Button
The button in the Provision a Sub-Network window is:

Button Description

Assign Xconnect Click this button to assign a cross connect. A path is

assigned between the entry and exit ports via the sub-
network indicated.

Table 6–27. Provision a Sub-Network window; button

161
EDITING CIRCUITS
Service Address

Service Address
Use the Service Address option in the Tool Palette to access the Service
Address window to assign/change the starting or end point of a service.
To open the Service Address window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click Service Address.
The Service Address window is displayed.

Figure 6–21. Service Address window

Fields
The fields in the Service Address window are:

Field Description

A End Displays the Location address of the starting point of the

service. For point to point services, this will be the
customer's A-end location address.

B End Displays the location address of the terminating point of

the service, indicating the point of service termination on
the telco equipment.

Table 6–28. Service Address window; fields

162
 EDITING CIRCUITS
Verify Ports Usage

Verify Ports Usage

Use the Verify Ports Usage option in the Tool Palette to access the Other
Circuits Reserving These Ports window where you can view a list of ports and
associated circuit names.

Viewing the Other Circuits Reserving these Ports

To open the Other Circuits Reserving These Ports window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click Verify Ports Usage.
The Other Circuits Reserving These Ports window is displayed.

Figure 6–22. Other Circuits Reserving These Ports window

Fields
The fields in the Other Circuits Reserving These Ports window are:

Field Description

Location The location of the circuit reserving the ports.

Type The type of circuit reserving the ports.

Index Instance of the circuit.

[Card]Port Terminating port name of the circuit and the slot where
the card is located.

Table 6–29. Other Circuits Reserving These Ports window; fields (sheet 1 of 2)

163
EDITING CIRCUITS
Verify Ports Usage

Field Description

Circuit The name of the circuit.

Status Current status of the circuit, e.g. Commissioned.

Circuit Type Classification of this service - Lease, Bearer etc.

Table 6–29. Other Circuits Reserving These Ports window; fields (sheet 2 of 2)

164
 EDITING CIRCUITS
View Reservation Details

View Reservation Details

Use the View Reservation Details option in the Tool Palette to access the View
Reservation Details window where you can view and modify the Expiry Date and
Notify Date for the proposed circuit.

Viewing the Reservation Details

To open the View Reservation Details window
1 Query a circuit in the Circuit Design window
See Querying Circuit Details on page 123 for more information on querying
a circuit.
2 Click the Tool Palette button and then click View Reservation Details.
The View Reservation Details window is displayed.

Figure 6–23. View Reservation Details window

Fields
The fields in the View Reservation Details window are:

Field Description

Expiry Date The expiry date for the specified circuit.

Notify Date The notify date for the specified circuit.

Table 6–30. View Reservation Details window; fields

165
EDITING CIRCUITS
View Reservation Details

166
 CHAPTER 7

Ring Definitions

This section shows you how to use the Rings window. This window is used to
define the bearers that make up synchronous digital hierarchy (SDH) rings or
synchronous optical network (SONET) rings. These rings are used to build path
diversity in the Inventory Suite database.

167
RING DEFINITIONS
Rings Window

Rings Window
This window is used to create SDH/SONET rings that can be used to build path
diversity within the network.
To open the Rings window
• From the Inventory menu, select Circuits and then click Rings.
The Rings window is displayed.

Figure 7–1. Rings window

The Rings window has the following sections:

Section See…

Ring Definitions page 169

Ring Bearers tab page 170

Ring Paths tab page 171

Inter-Network Bearers tab page 172

168
 RING DEFINITIONS
Rings Window

Ring Definitions
Use the Ring Definitions section to enter the primary details that identify the ring
in the Inventory Suite.

Figure 7–2. Rings Definitions section in the Rings window

Fields
The fields in the Ring Definitions section are:

Field Description

Name A free text field that provides an identification name for

the ring.

Type Valid ring type. Select one of the following values from
the drop-down list:
• Metropolitan
• Regional
• National
• Other.

Speed The speed of the ring. Use the LOV button to select a
value.

Topology The network protection mechanism. Select one of the

following values from the drop-down list:
• Cloud
• Linear
• Linear 1+1
• Linear 1:n
• Mesh
• Star
• Hub
• Uni-directional path switched ring
• Bi-directional line switched ring 2 fibre
• Bi-directional line switched ring 4 fibre.

Table 7–1. Rings Definitions section; fields (sheet 1 of 2)

169
RING DEFINITIONS
Rings Window

Field Description

Description Free text field to further describe the use of the ring.

Table 7–1. Rings Definitions section; fields (sheet 2 of 2)

Ring Bearers Tab

The Ring Bearers tab shows the bearers that make up the ring.

Figure 7–3. Ring Bearers tab in the Rings window

Fields
The fields in the Ring Bearers tab are:

Field Description

Seq Logical sequence of the bearer. This is for display

purposes only.

Bearer Name Name of the bearer. Use the LOV button to select a
bearer.

A Direction The direction of traffic from the A-end of the bearer.

Select from the drop-down list either:
• East
• West.

Network Element A The terminating network element at the A-end of the

End bearer. This field is auto-populated.

Table 7–2. Ring Bearer tab fields

170
 RING DEFINITIONS
Rings Window

Field Description

B Direction The direction of traffic from the B-end of the bearer.

Select either:
• East
• West

Network Element B The terminating network element at the B-end of the

End bearer. This field is auto-populated.

Table 7–2. Ring Bearer tab fields

Ring Paths Tab

The Ring Paths tab describes the path types and NEMS states of the bearers
between the selected network elements.

Figure 7–4. Ring Paths tab in the Rings window

171
RING DEFINITIONS
Rings Window

Fields
The fields in the Ring Paths tab are:

Field Description

Path Type Select one of the following values from the drop-down
list:
• Working
• Span Protection
• Ring Protection
• Path Protection.

Network Element The network element at the A-end of the bearer.

From

Network Element The network element at the B-end of the bearer.

To

Seq A logical sequence number for display purposes only.

Bearer Name The name of the bearer. Use the LOV button to select a
value.

Current NEMS States whether the bearer is a working bearer or a

status protection bearer.

Table 7–3. Ring Paths tab fields

Inter-Network Bearers Tab

This tab is view only and shows the inter-connecting bearers between rings. Inter-
Ring Bearer details are set up in the Circuit Design window.

Figure 7–5. Inter-Network Bearers tab in the Rings window

172
 RING DEFINITIONS
Rings Window

Fields
The fields in the Inter-Network Bearers tab are:

Field Description

Circuit Name The name of the circuit.

Network ‘A’ The network at the A-end of the bearer.

Network ‘B’ The network at the B-end of the bearer.

Table 7–4. Inter-Network Bearers tab fields

173
RING DEFINITIONS
Features of the Rings Window

Features of the Rings Window

The features of the Rings window are:

Feature See…

Opening the Rings window page 168

Querying rings page 175

Creating rings page 176

Modifying rings page 177

Viewing network element detail records page 178

Viewing circuit detail records page 179

174
 RING DEFINITIONS
Querying Rings

Querying Rings
This procedure describes how to search for ring records in the database.
To query a ring record
1 Open the Rings window.
See Rings Window on page 168 for more information on opening the Rings
window.
2 Click the Query button.
The window is now in query mode.
3 Click the field that you want to query.
You can only enter search criteria in the Ring Definitions section.
4 Enter your search criteria.
5 Click the Query button.
Any matching records are displayed.
6 Repeat steps 1- 5 for each new search.

Note
Use the scroll bar in the Ring Definitions section to view all matching
records if multiple records are retrieved for your search.

Hint
Use the wildcard characters (% and _) to search for records.

175
RING DEFINITIONS
Creating Rings

Creating Rings
To create a ring
1 Open the Rings window.
See Rings Window on page 168 for more information on opening the Rings
window.
2 Click the Name field and type a short name to identify the ring you want to
create.
3 Enter information in the remaining fields in the Ring Definitions section.
See Ring Definitions on page 169 for more information about these fields.
4 Click the Save button.
5 Enter values in the Ring Bearers and Ring Paths tabs of the window to
further define the ring.
See Ring Bearers Tab on page 170 for more information on the Ring Bearer
tab fields.
See Ring Paths Tab on page 171 for more information on the Ring Paths tab
fields.
6 Click the Save button.
The ring is created.

Hint
The Rings window is in Insert mode by default.

176
 RING DEFINITIONS
Modifying Rings

Modifying Rings
This section shows you how to modify records in the Rings window.
To modify a Ring record
1 Query a ring record.
See Querying Rings on page 175 for more information on querying ring
records.
2 Modify the fields you want to update.
3 Click the Save button.
The Ring record is updated and saved to the database.

177
RING DEFINITIONS
Viewing Network Element Detail Records

Viewing Network Element Detail Records

This section describes how to open the Network Elements window from the
Rings window in the context of the selected network element.
To view a network element detail records from the Rings window
1 Query a Ring record.
See Querying Rings on page 175 for more information on querying ring
records.
2 Double-click the Name field in the Ring Definitions section.
The Network Elements window is opened with the details of the selected
network element displayed.

178
 RING DEFINITIONS
Viewing Circuit Detail Records

Viewing Circuit Detail Records

This section describes how to open the Circuit Design window from the Rings
window in the context of the selected Bearer.
To view circuit detail records from the Rings window
1 Query a Ring record.
See Querying Rings on page 175 for more information on querying ring
records.
2 Double-click the Bearer Name field.
The Circuit Design window is opened with the details of the selected bearer
displayed.

179
RING DEFINITIONS
Viewing Circuit Detail Records

180
 CHAPTER 8

Sub-Network Definitions

Use the Sub-Network Definition window to identify sub-network circuit routes

within the Clarity system.

181
SUB-NETWORK DEFINITIONS
Sub-Network Definition Window

Sub-Network Definition Window

Use the Sub-Network Definition window to identify sub-network circuit routes
within the Clarity system.
Before you can create records in this window, circuits must exist in the Circuit
Design window.
To open the Sub Network Definition window
• From the Inventory menu, point to Circuits, and then click
Subnetwork.

Figure 8–1. Sub-Network Definition window

Fields
The fields in the Sub-Network Definition window are:

Fields Description

Sub-Network Definition

Name The identifying name of the template.

Table 8–1. Sub-Network Definition window; fields (sheet 1 of 2)

182
 SUB-NETWORK DEFINITIONS
Sub-Network Definition Window

Fields Description

Description Free text field to further define the template.

Sub-Network Circuits

Seq A number used to order the circuits.

Circuit Name The name of the circuit that is part of the sub-network.

Termination The terminating network element at the A-end of the

Network Element 1 circuit. This field is auto-populated.

Termination The terminating network element at the B-end of the

Network Element 2 circuit. This field is auto-populated.

Table 8–1. Sub-Network Definition window; fields (sheet 2 of 2)

183
SUB-NETWORK DEFINITIONS
Sub-Network Definition Window

184
 CHAPTER 9

Routing Definitions

Use the Route Definitions window to define routes between two end points of a
sub-network.

185
ROUTING DEFINITIONS
Route Definition Window

Route Definition Window

Use this window to define a route to be used between two end points of a sub-
network.
Before you can create records in this window, values must be entered in the
following windows:
• Sub-Network Definition window
• Circuit Design window
To open the Route Definition window
• From the Inventory menu, point to Circuits, and then click Routing.

Figure 9–1. Route Definition window

Fields
The fields in the Route Definition window are:

Field Description

Sub-Network Route Definition

Name A descriptive name for the route.

Table 9–1. Routing Definition window; fields (sheet 1 of 2)

186
 ROUTING DEFINITIONS
Route Definition Window

Field Description

Routing Option The routing option if circuit failure occurs. Select one of
the following:
• Preferred
Traffic is lost if failure occurs)
• Directed
Traffic is re-routed if failure occurs).

Cost The cost of using this route per service.

Creation Date The date on which the route definition was created.
Double-click to populate this field.

Description A free text field to further describe the route.

Sub-Network Name A name that describes the collection of bearers that

make up the sub-network.

Sub-Network Routing Selection

Seq The sequence (order) of the bearers in the route.

Trunk Route The name of the circuit.

Termination The terminating equipment at the A-end of the circuit.

Equipment 1 This field is auto-populated.

Termination The terminating equipment at the B-end of the circuit.

Equipment 2 This field is auto-populated.

Table 9–1. Routing Definition window; fields (sheet 2 of 2)

187
ROUTING DEFINITIONS
Route Definition Window

188
 CHAPTER 10

Data Connections

This chapter describes how to create Data Connections using the Inventory
module.

189
DATA CONNECTIONS
Data Connections - Overview

Data Connections - Overview

Data Connections model network connectivity which allows equipment within the
Carrier's network to communicate with each other. It supports data traffic within or
into a network. Data Connections may be carried by one or more other circuits,
may be carried by other data connections, may be routed over a cloud, topology
or ring, or may be unrouted. In Clarity, the following two types of data
connections can be modelled:
• Access (Customer)- defining the connectivity between the customer's
site (CPE) and the network core (Provider Edge)
• Infrastructure - defining connectivity within the carrier's network
All connections share certain similarities:
– They have a header with important information about the Connection;
– They have two terminating points;
– They are routed over layers of connectivity.

Access Connections

To launch the Access Connections window, on the Inventory>Connections

menu, click Access Connections. The Access Connections window is displayed.

Figure 10–1. The Access Connections window

190
 DATA CONNECTIONS
Data Connections - Overview

The Access Connections window has the following two main areas/blocks:
Access Connections Area
The Access Connection area holds the main information about a Connection.
The fields are described below:

Field Description

Name A way of uniquely identifying a Connection.

Connection Type The data connection type. List of values is derived from
the Connection Types reference data window. The
attributes of a connection type determine the name,
synchronicity, directionality, and class of the data
connection. The connection type is class specific (i.e. you
may see different connection types for Infrastructure
Connections compared to Access).

Status Describes a stage in the Connection lifecycle. Users can

select from a Clarity defined list of values.

Priority The CoS (class of service) or QoS (quality of service) of a

Connection.The list of values is derived from the
Priorities reference data window which stores both CoS
and QoS values. The higher the CoS value the higher the
priority. This essentially means that higher priority data
will be transferred before lower priorities.

Speed The bit rate at which the Connection operates. It is

usually represented as a user friendly string (e.g.
10MBPS). Symmetrical and Uni-directional connections
only require the speed field to be populated.
Note: The data connection speed should be less than or
equal to the speed of the port that will support this
connection. This is validated when the ports are
selected and a warning is displayed if the
connection speed exceeds the port speed
(capacity). If port speed is null, no validation will
be done.

Uplink Speed It represents the data speed from the customer to the
network. Uplink speed is only necessary if the
Connection type is asynchronous.

Table 10–1. The Access Connections; fields in the Access Connections Area (sheet 1 of 2)

191
DATA CONNECTIONS
Data Connections - Overview

Field Description

Customer Define the ownership or usage of a Connection. This

mechanism associates Connections with end user
customers (Wholesale or Retail) but also can be used to
define internal (to a carrier) use of network infrastructure.

Service ID Automatically populated from the Service Definition

screen if the Access Connection is created from Service
Manager.

Service Type Indicates what the connection actually is, for example
ADSL. Users can choose from a list of values. The LOV
displays service types defined in the Service Definition
screen and belonging to the group Data Services.

Comments Free text field that is used for storing notes.

Utilisation Indicates the percentage of utilisation of the access

connection.

Start Point The starting point of the access connection.

Details The details of the starting termination point. For

example, the Location or Address details. Note that
when you select Network Element as the starting point,
the additional fields described below will be displayed.

End Point The end point of the access connection.

Details The details of the end termination point. This field is

displayed only when an object type other than a network
element is selected. If a network element is selected as
the End Point, the fields listed below are displayed.

Table 10–1. The Access Connections; fields in the Access Connections Area (sheet 2 of 2)

192
 DATA CONNECTIONS
Data Connections - Overview

Most Connections have two termination points. These points are named Start
Termination and End Termination. Connections can be terminated on different
objects:
• Locations and Addresses are one method for defining the termination
points of a Connection;

Note
Location and Address terminations are only available for Customer
site terminations.
• Network Elements along with their Cards and Ports are an alternate
method for defining the termination points of a Connection.

Note
In this scenario Network Elements define the end point Locations.
• Topologies can also be selected for Start and End connections.
• NULL terminations can be used when there is a need to terminate an
Access Connection on more than one Network Element (e.g. whole
topology). The last Route section will be a Topology.

Note
NULL terminations are only allowed on Connections that are of Class
Access and only on the Network Side termination. It is recommended
that you always specify the Network Side termination.
• Clouds represent a collection of objects for which the provider has no
knowledge of or has any interest in. They can be used to represent
other networks.
• A Generic Object is can be used to represent single object for which
information is not known or is irrelevant.

Note
If the termination object is NULL then the last object in the Connection
layer (for any route) will be a topology.

Note
In most cases the customer side termination will be an address. This is
usually because the provider doesn't model the equipment on the
customer's premises.

For Access Connections, the starting point is mostly a Customer Premise

Equipment.

193
DATA CONNECTIONS
Data Connections - Overview

Data Connections Layer (Routes)

The Connection route section shows one or more routes. The fields in this section
are described below:

Fields Description

Route Number Unique identifier for the route in the context of a

Connection.

Load Share% Allows users to distribute the capacity over multiple

routes. Users can choose to send varying percentages
down different routes. This field indicates what
percentage is allotted to the corresponding route.

Primary Route Indicates is the route is a primary route or not.

Position A route is comprised of multiple sections sequenced in

ascending order, starting at 1. Each section represents a
logical hop in a route. This field indicates the position of
the route section.

Type The type of route object, for example Circuit, Ring,

topology, and so on. Users must select from a Clarity
defined list of values.

Detail The value for the Route object, i.e. the name of the
Topology, Ring, Circuit, or Connection. Double-click on
this field to launch the window containing the details of
the object selected. For example, if you double-click on a
Ring, the Rings window will be launched displaying the
details of the ring selected. double-clicking on a Circuit
name will launch the Circuit Design window in the
context of the selected circuit and so on.

Carried This is a read-only field. Displays any other connection

Connections that is riding on this data connection.

Table 10–2. The Access Connections window; Data Connection Layer area

194
 DATA CONNECTIONS
Data Connections - Overview

Infrastructure Connections

To access the Infrastructure Connections window, on the Inventory>

Connections menu, click Infrastructure Connections. The Infrastructure
Connections window is displayed.

Figure 10–2. The Infrastructure Connections window

Similar to the Access Connections window, the Infrastructure Connections

window has two main areas, an infrastructure connections area and a Data
Connection Layer area to define the routes. The parameters for the Start and End
connections and to define the routes are the same for both the Access and
Infrastructure Connections. The Infrastructure Connections header region contains
some additional fields which are described below:

195
DATA CONNECTIONS
Data Connections - Overview

Infrastructure Connections area

Field Description

Name Name of the Infrastructure Connection. This is a read-

only field. The Infrastructure Connection name is a
concatenation of the Location A, Location Z, Prefix,
Number, and Suffix fields.

Compliance The compliance standard for the infrastructure

connection name. The compliance standards available
are as follows:
• ITU
• ITN-NS
• NONE
IF NONE is selected, the Location A, Location Z,
Prefix, Number, and Suffix fields will be hidden and a
free text field will be displayed for the user to enter the
name manually.

Location A/ The two end points locations of the Connection. Note

Location Z that both locations should be part of the Provider's
network.

Prefix Free text field to enter a prefix for the infrastructure

connection name.

Number Free text field to enter a number for the infrastructure

connection name.

Suffix Free text field to enter a suffix for the infrastructure

connection name.

Connection Type The data connection type. List of values is derived from
the Connection Types reference data window. The
attributes of a connection type determine the name,
symmetry, directionality, and class of the data
connection. The connection type is class specific (i.e. you
may see different connection types for Infrastructure
Connections compared to Access).

Status Describes a stage in the Connection lifecycle.

Table 10–3. The Infrastructure Connections window; fields in the Infrastructure

Connection area (sheet 1 of 3)

196
 DATA CONNECTIONS
Data Connections - Overview

Field Description

Priority The CoS (class of service) or QoS (quality of service) of a

Connection. The list of values is derived from the
Priorities reference data window which stores both CoS
and QoS values. The higher the CoS value, the higher
the priority. This essentially means that higher priority
data will be transferred before lower priorities.

Speed The bit rate at which the Connection operates. It is

usually represented as a user friendly string (e.g.
10MBPS). Symmetrical and Uni-directional connections
only require the speed field to be populated.

%Overbook The overbooking factor allows Connections to carry

other Connections of a higher capacity Connections than
means that carrying Connections (Connections that carry
other Connections) can be used by an unlimited number
of connections as long as the total (demand) capacity
does not exceed the raw capacity (speed) of the carrying
Connection plus the Overbooking allowance.
The Overbooking factor assumes that 100% means that
there is no additional capacity allowed on this
connection - e.g. 10MB raw capacity and 100%
overbooking factor means that the total capacity is
10MB. A Connection with a raw capacity of 10MB and
200% Overbooking factor can carry 20MB of
Connections.
The reason that Overbooking works is that at any one
point in time not all Connections will be actively using
100% of their allocated capacity.
Note: It is recommended that user's have an
understanding of customer behavior before setting
an overbooking factor.

Total BitRate (Kbps)

Customer Define the ownership or usage of a Connection. This

mechanism associates Connections with end user
customers (Wholesale or Retail) but also can be used to
define internal (to a carrier) use of network infrastructure.

Table 10–3. The Infrastructure Connections window; fields in the Infrastructure

Connection area (sheet 2 of 3)

197
DATA CONNECTIONS
Data Connections - Overview

Field Description

Service Template Allows users to select a Service Template to define the list
of services that can be supported on this infrastructure
connection.

Service ID Automatically populated if the connection is create din

Service Manager.

Comments Free text field that is used for storing notes.

Utilisation Indicates the percentage of utilisation of the

infrastructure connection.

Table 10–3. The Infrastructure Connections window; fields in the Infrastructure

Connection area (sheet 3 of 3)

198
 DATA CONNECTIONS
Data Connections - Overview

Data Connections Tool Palette

The Tool Palette on the Access Connections and the Infrastructure
Connections windows allows users to configure additional attributes for the data
connections. The following windows can be launched from the Tool Palette:

Alternate Connection Names

Use this dialog box to assign alternate names to data connections.
To define an alternate connection name:
1. Click the Alternate Names button on the Tool Pallet.
2. Then the Alternate Connection Names dialog box is displayed.
3. In the Name field enter an alternate connection.
4. In the Type field enter the type as a grouping for name.
5. Save the record.

Figure 10–3. The Alternate Connection Names dialog box

Field Description

Name The alternate name for the data connection.

Type The type of the alternate name.

Table 10–4. The field descriptions for the Alternate Connection Names dialog box.

199
DATA CONNECTIONS
Data Connections - Overview

Attach Files
The File Attachments window allows users to attach files, containing extra
information about the data connection, to the connection record.
t

Figure 10–4. The File Attachments dialog box

To attache a file to a data connection record

1 Click the Attach File button on the Tool Pallet.
2 Then the Attach File dialog box is displayed.
3 Click the Attache File 2 DB button, then the Select a file to upload dialog
box is displayed.
4 Select the file that you wish to attache and then click Open.
5 You will be prompted to select the sub-directory to upload the file to. Select
the C:\TEMP directory.
6 Click OK. The file will be attached and the path and name is populated in
the File Attachments dialog box.

200
 DATA CONNECTIONS
Data Connections - Overview

Fields Descriptions

File Path Is automatically populated with the file location when you
attach the file. All files are uploaded or attached under
the C:\TEMP subdirectory.

File Name This is automatically populated with the file name.

Table 10–5. The field descriptions for the File Attachments dialog box.

Connection Attributes
Extra name value pairs which store useful information about the Connection.

Figure 10–5. The Connection Attributes window

201
DATA CONNECTIONS
Setting up Data Connections

Setting up Data Connections

Setting up Reference Data

Connection Types
The Data Connection Types reference data window is used to set up the
Connection Types. To access the Data Connection Types window, from the
Inventory > Reference Data > Connections menu, click on Connection
Types.

Figure 10–6. The Data Connection Types Window

202
 DATA CONNECTIONS
Setting up Data Connections

The fields on this window are described as follows:

Fields Description

Name The name of the data connection.

Unidirectional Unidirectionality implies that the Connection only

transfers data one way. The route taken begins at the A-
end / Star Termination and ends at the Z-end / End
Termination. By default, Connections are bi-directional.
Select this check box only if a connection is
Unidirectional.

Asynchronous Determines whether the speed is the same in both

directions (uplink/downlink) or different. Select the check
box if the uplink and downlink speed are different.

Class The connection class, for example Infrastructure or

Access.

Table 10–6. The Data Connection Types; Fields

Note
User cannot modify the characteristics of a data connection type if it is
already been used by an existing data connection.

203
DATA CONNECTIONS
Setting up Data Connections

204
 CHAPTER 11

Network Elements

This section shows you how to use the Network Elements window. Use this
window to view and edit the network elements for a selected circuit within a
network. This section also describes the Network Elements Feature Hierarchy
window and its functionality.

205
NETWORK ELEMENTS
Network Elements Window

Network Elements Window

Use this window to query, create, modify, and delete network element
information.
To open the Network Elements window
• From the Inventory menu, point to Components, and then click
Network Elements.
The Network Elements window is displayed.

Figure 11–1. Network Elements window

The sections of the Network Elements window are:

Section See…

Network Elements page 208

Card Slots page 257

206
 NETWORK ELEMENTS
Network Elements Window

Section See…

Port Details Tab page 275

Additional Port Details Tab page 283

Connections Tab page 284

207
NETWORK ELEMENTS
Network Elements Section

Network Elements Section

The Network Elements area displays the attributes of the selected network
element.

Figure 11–2. Network Elements area in the Network Elements window

Fields
The fields descriptions of the Network Elements area:

Field Description

Location Physical location of the network element. Double-click on

this field to launch the Location window and view the
location details.

Type Valid abbreviation for the network element type. Use the
LOV button to select a value.

Index Index number assigned to the network element. This

number is unique to a site to facilitate identification.

Exchange Code The exchange code for the location of the network
element.

Table 11–1. The Network Elements area; fields (sheet 1 of 4)

208
 NETWORK ELEMENTS
Network Elements Section

Field Description

Domain This field identifies, at a high level, the owning group of

the NE type, for example, Data, Switching, or
Transmission. Domains are defined using the Domains
reference data window and linked to Equipment Types
through the NE Types reference data window. In the
Network Elements window, when the Equipment Type
is selected, the Domains field is automatically populated
with the domain linked to that Equipment Type. LOV on
this field is only available when querying a network
element record.

Status Current status of the network element. Values include,

Spare, Planned, Commissioned, In Service, Out of
Service, Decommissioned, Pending Removal, Blocked.
Note the following:
• The status of a network element can transition to the
Blocked status only from an In Service status.
• When a Network Element’s status is changed to
Blocked, the status of the Cards and Ports also
changes to Blocked.
• The status will revert to its previous value when the NE
status is reverted from Blocked to In Service. For
example if a Port had a status of "BAD PORT", and the
NE status is changed to Blocked, then the Port will
also be blocked. When the user reverts the NE status
from Blocked to In Service, then the Port status will be
reverted to "BAD PORT".
• Reserve Facility will not select any Ports for reservation
that have a status of Blocked.
• Manual Circuit Design will not use network elements
that are blocked. Any existing circuits using the
facilities will not be modified. New circuits (manual or
reserved facility) will not be able to use the blocked
facilities.

In Service Date Network element inservice date.

IP The Internet Protocol (IP) address of the equipment. This

information is necessary for communication.

Customer The abbreviation for the leased services customer. Click

the LOV button to display the list of values.
Note: The network element is owned by the customer.

Table 11–1. The Network Elements area; fields (sheet 2 of 4)

209
NETWORK ELEMENTS
Network Elements Section

Field Description

Realm LOV to select a Realm and associate it with a Network

Element.

Manufacturer The abbreviation for the manufacturer of the network

element. Click the LOV button to display the list of
values. If the Network Element Type is entered, list of
values will display manufacturers corresponding to that
network element type. If NE type is not spcified, all
manufacturers will be displayed.

Model Type The manufacturer’s model type. Click the LOV button to
display the list of values. This field is linked to the
equipment Type and Manufacturer fields.

Area The charging area that the network element belongs to.

Position The position of the network element within a building.

Value must be entered in the 'LEVEL:SUITE:RACK:SHELF'
format where:
- LEVEL is the building floor level of the network element;
- SUITE is the row of racks the network element is in;
- RACK is the actual rack number within the suite of
racks;
- SHELF is the shelf position in the rack.

Table 11–1. The Network Elements area; fields (sheet 3 of 4)

210
 NETWORK ELEMENTS
Network Elements Section

Field Description

Service Type Displays the highest priority Service Type Template or

Template Service Type linked to the network element. Double-
clicking on this field will bring up the Network Element
Service Type Templates pop-up window (see Network
Element Service Type Templates on page 225 for more
information). This window contains the Service
Templates tab and the Service Types tabbed region.
Only that tabbed region will be displayed that contains
linked data, i.e., if a Service Type Template has been
applied to the Network Element, the Service Templates
tab will be displayed and if Service Types are linked to
the Network Element, the Service Types tab displaying
that data set will be in focus.
This window is used to add, delete, or update service
type templates or service types for a network element. It
can also be invoked by clicking on the Manage Service
Type Details button in the Network Elements Tool
Palette. See Manage Service Type Details on page 244
for more information on this pop-up window.

IP Region The IP Region field holds the value of an area from which
a NGN IP equipment will derive it's IP number resources.
It is an optional value and should only be used for IP
equipment capable of managing IP numbers.

Comments Free text area for comments.

Utilisation Indicates the percentage of utilisation of the network

element. Different percentages are displayed in different
colours as explained below.
Blue: 0% - 19%
Green: 20% - 39%
Yellow: 40% - 59%
Orange: 60% - 79%
Red: 80% - 100%.
The statuses used in the Utilisation calculations appear
next to the Utilisation field as an abbreviation, e.g.
PADBL stands for Planned, Active, InActive, Bad Port and
Locked.

Table 11–1. The Network Elements area; fields (sheet 4 of 4)

211
NETWORK ELEMENTS
Network Elements Section

Buttons
The buttons in the Network Elements area enable you to accomplish the
following functions related to a network element:

Display Rings

Click the Display Rings button to open the Ring Definitions window. Using this
window, you can enter, view and edit ring definitions for the selected network
element.

Note
The Rings window is displayed in the context of the currently selected
network element record.

Figure 11–3. The Rings window

See Rings Window on page 168 for more information on the various fields in this
window and the ring definition process.

Display Alarms

212
 NETWORK ELEMENTS
Network Elements Section

Click the Display Alarms button to open the NE Affecting Alarms window that
displays alarms (if any) for the selected network element.

Figure 11–4. The NE Affecting Alarms window

Fields

Field Description

Alarm Abbreviation for alarm type.

Port Port number.

Reported Time Date and time the alarm was reported.

Priority Alarm priority to determine repair or escalation.

Severity Alarm Severity that determines the impact on the

network.

Table 11–2. The NE Affecting Alarms window; fields

Copy Network Element

Click the Copy Network Element button to display the Copy Network Element
window.
Use this window to create a new network element by copying the network element
details, card, and port information from the currently selected network element
record. You can also copy the Network Element parameters using the options in

213
NETWORK ELEMENTS
Network Elements Section

this window. You must specify a new location, status and in service date for the
new NE.

Figure 11–5. The Copy Network Element window

Fields

Field Description

New Location for The new location or site of the equipment.

this Network Use the LOV on this window to select a valid location for
Element the network element.

Table 11–3. The Copy Network Element window; fields (sheet 1 of 2)

214
 NETWORK ELEMENTS
Network Elements Section

Field Description

New status for this The new network element status. Choose one of the
Network Element following from the LOV:
• Spare
• Planned
• Commissioned
• Inservice
• Out of Service
• Decommissioned
• Pending Removal
• Blocked

New In-Service The new in-service date.

Date for this
Network Element

Check box

Copy Parameters Select this option, to copy all the network element
check box parameters to the new network element.

Copy Internal Selected this option, to copy any internal connections on

Connections check the source network element to the target network
box. element.

Table 11–3. The Copy Network Element window; fields (sheet 2 of 2)

Button

Button Description

Copy Network Copies the current network element to the location

Element specified.

Table 11–4. The Copy Network Element window; button

To copy a network element record

1 Open the Copy Network Element window. See Copy Network Element on
page 213.
2 In the Copy Network Element window, use the List of Values to select a
location for the new network element.
3 Select a status using the List of Values and enter the in-service date.

215
NETWORK ELEMENTS
Network Elements Section

4 Optionally, select the Copy Parameters check box if you want to copy the
parameters to the new network element.
5 If you wish to copy any internal connections on the source network element to
the target network element, select the Copy Internal Connections check
box.This is an optional step.
6 Click Copy Network Element to create the new record.

View/Modify Network Element Asset or Dimension details

Click the View/Modify Network Element or Dimension details button to

access the Assets And Dimensions window. Use this window to maintain the
network element assets and dimension details. You can maintain details such as
the:
• asset number
• purchase and installation dates
• hardware, software, and firmware revisions
• measurement of the item.
The Assets And Dimensions window has two tabs:
• Asset Info tab
• Dimensions tab
The fields in each tab are described in the following sections.

216
 NETWORK ELEMENTS
Network Elements Section

Asset Info Tab

Figure 11–6. Asset Info tab in the Assets And Dimensions window

The fields in the Asset Info tab of the Assets And Dimensions window are:

Field Description

Type The asset type, either Equipment or Card. If you open this
window from the network element section, the asset type
is Equipment. If you open this window from the Card
Slots section, the asset type is Card.

Name The name of the asset. This name is derived from the
network element name or the Card Slot name.

Asset Number The asset number allocated.

Order Number The purchase order number associated with the purchase
of this asset.

Ordered Date The purchase order date.

Due Date The delivery date of the asset from the supplier.

Table 11–5. Asset Info tab fields (sheet 1 of 3)

217
NETWORK ELEMENTS
Network Elements Section

Field Description

Project Number The project number associated with the purchase of the
asset.

Serial Number The serial number assigned to the selected asset.

Batch Number The manufacturer’s batch number.

Part Number The manufacturer’s part number.

Bar Code The asset barcode number.

Manufacturer The manufacturer of the network element or Card.

Manufacture Date The date the asset was manufactured.

Supplier The name of the asset supplier.

Supplier Part Code The supplier’s part number.

Purchased Date The date the asset was purchased from the supplier.

Purchased Price The price paid for the asset.

Depreciation Period The number of years that the value of the asset will be
(In Yrs) depreciated over.

Installed Date The date the asset was installed on site.

Inservice Date The date the asset was placed inservice.

Commissioned The date the asset was commissioned.

Date

Warranty Expiry The expiry date of the manufacturer’s warranty.

Date

Decommissioned The date the asset was decommissioned from service.

Date

Disposal Date The date the asset was disposed of.

Table 11–5. Asset Info tab fields (sheet 2 of 3)

218
 NETWORK ELEMENTS
Network Elements Section

Field Description

Hardware Version The hardware version number.

Software Version The software version number.

Firmware Version The firmware version number.

CLEI The Common Language Equipment Identifier (CLEI) code

for the asset.

Comments Additional comments about the asset.

Table 11–5. Asset Info tab fields (sheet 3 of 3)

Dimensions Tab

Figure 11–7. Dimensions tab in the Assets And Dimensions window

219
NETWORK ELEMENTS
Network Elements Section

The fields in the Dimensions tab of the Assets And Dimensions window are:

Field Description

Type The asset type, either Equipment or Card. If you open this
window from the Network Element section, the asset
type is Equipment. If you open this window from the
Card Slots section, the asset type is Card.

Name The name of the asset. This name is derived from the
network element name or the Card Slot name.

Measurement Units The measurement units for all measurements displayed

on window. You can display measurements in one of the
following units:
• mm (millimeters)
• cm (centimeters)
• inches
• meters.

Distance from Top The distance of the asset from the top of the container.

Asset Height The height of the asset.

Distance from The distance of the asset from the bottom of the
Bottom container.

Container Height The height of the container that holds the asset.

Distance from Left The distance of the asset from the left side of the
container.

Asset Width The width of the asset.

Distance from Right The distance of the asset from the right side of the
container.

Container Width The width of the container that holds the asset.

Distance from Front The distance of the asset from the front of the container.

Asset Depth The depth of the asset.

Table 11–6. Dimensions tab; fields (sheet 1 of 2)

220
 NETWORK ELEMENTS
Network Elements Section

Field Description

Distance from Back The distance of the asset from the back of the container.

Container Depth The depth of the container that holds the asset.

Comments Additional comments about the asset.

Table 11–6. Dimensions tab; fields (sheet 2 of 2)

To set up the assets and dimensions information

1 To set up the assets and dimensions information for an equipment, click on
the View/Modify Network Element Asset or Dimension details button.
The Assets And Dimensions window is displayed.
2 Enter all the information that your require and save your record.

Display Port Breakdown Templates

Click the Display Port Breakdown Templates button to display the Port
Templates window. Use the Port Templates window to set up and maintain port
templates. These templates can then be used to automatically set up the port
details and port hierarchy for the selected network element
A network element can have one or more port levels that make up a port
hierarchy. Each port level has one or more ports. This window enables you to
create a template with a port level that includes relationships to other levels,
forming a port hierarchy.

221
NETWORK ELEMENTS
Network Elements Section

The Port Templates window also accessed from the Inventory > Templates >
Ports menu is discussed in detail in the Templates chapter. For information, see
Port Templates Window on page 448.

Figure 11–8. Port Templates window

Create Ports

Click the Create Ports button to display the Add Ports from Template window.
This window is used to add ports to a network element automatically using the
Port templates.

222
 NETWORK ELEMENTS
Network Elements Section

Note
A breakdown must exist before you can apply a port template. You should
build the templates up from the lowest level of the Parent Child Hierarchy.
That is, if child ports exist they need to be set up before the parent ports.

Figure 11–9. Add Ports from Template window

Fields

Field Description

Port Template The name of the port breakdown template.

Port Parent Name The parent port for the ports in the breakdown template.

Port Slot Number This is the card slot on the network element.

Child Port Prefix Prefix for the ports that will be created. Select the Use
Parent Name as Prefix radio button to use the parent
name, or select Use Prefix and type in the prefix
required. Select No Prefix to add a child port with no
prefix attached to the name.

Table 11–7. Add Ports from Templates window; fields

223
NETWORK ELEMENTS
Network Elements Section

You can use Port templates to do the following:

• Create top level ports
• Create child ports with the parent port as a prefix
To create a top level port
1 Query a network element record. Click the Create Ports button.
The Add Ports from Template window is displayed.
2 Click in the Port Template field and select a Port Template using the LOV
button.
3 Click the Copy button to copy the card slot number.
4 Select the No Prefix radio button under Child Port Prefix. To create ports
with a prefix, select the Use Prefix radio button and enter a prefix in the
space provided.
5 Click the Add Ports button.
To create Child Ports with a Parent Prefix
1 In the Add Ports from Template window, select a Port Breakdown template
using the LOV button.
2 Copy in or enter the Port Parent Name and Port Slot Number.
3 Click the Use Parent Name as Prefix option.
4 Click the Add Ports button.

Add Network Element Alarms

Click on the NEMS button to open the Network Element Alarm and SOP Node
Identifiers window.

Use this window to identify the Network Element Management System (NEMS) that
monitors the selected NE for various functions such as alarms and service
provisioning.

Figure 11–10. Network Element Alarm and SOP Node Identifiers window

224
 NETWORK ELEMENTS
Network Elements Section

Fields

Field Description

Management Use the LOV to select the NEMS.

System

Node ID Network element name as provided by the NEMS.

Type Mediation activity that takes place. Options are MDD

Alarms (indicates whether the NEMS collects alarms for
the NE) and MDD SOP (indicates if the NEMS monitors
service provisioning on that NE).

Table 11–8. Network Element Alarm and SOP Node Identifiers window; fields

To define a Network Element Management System for a network

network
1 In the Network Element Alarm and SOP Node Identifiers window, click
in the Management System field and use the LOV button to select the
Network Element Management System.
2 In the Node ID field, enter the network element name as provided by the
NEMS.
3 In the Type field, use the drop-down list to select the MDD type.
4 Click the Exit button to close the window.
5 Click the Save button.
Your changes are saved to the database.

Network Element Service Type Templates

Use the Network Element Service Type Templates window to assign a Service
Template or a Service Type to a Network Element.
To open the Network Element Service Type Templates window
1 Open the Network Elements window (see To open the Network Elements
window on page 206).
2 Query a Network Element.
3 Double click in the Service Type Template field.
The Network Element Service Type Templates window displays.

225
NETWORK ELEMENTS
Network Elements Section

Figure 11–11. Network Element Service Type Templates window, Service Templates tab

Figure 11–12. Network Element Service Type Templates window, Service Types tab

226
 NETWORK ELEMENTS
Network Elements Section

Fields

Field Description

Service Templates tab

Name A descriptive name for the service template.

Description A meaningful description of the service template.

Priority The order of selection priority when choosing a NE to

support or supply the service.

Service Types tab

Name A descriptive name for the service type.

Description A meaningful description of the service type.

Priority The order of selection priority when choosing a NE to

support or supply the service.

Table 11–9. Network Element Service Type Templates window; fields

227
NETWORK ELEMENTS
Network Elements Section

Network Elements Section Tool Palette

Click the Tool Palette button in the Network Elements section to display the list
of buttons.

Figure 11–13. Buttons in the Network Elements Section Tool Palette

The buttons in the Network Elements Tool Palette provide access to various forms
using which you can define additional features/attributes for and perform certain
functions related to a selected network element.
The various forms available through the Tool Palette and the functionalities they
provide are discussed in the sections below.

Element Utilisation
On the Tool Palette, click on the Element Utilisation button to display the
Element Utilisation window. This window allows each individual user to define
how utilization is calculated for an instance of a NE, i.e. what status values
determine the utilization percentage.
For each network element, a threshold can be defined and the utilisation
calculated against it. This is accomplished through the Utilisation Thresholds
window that is described later in this chapter. The utilisation percentage for

228
 NETWORK ELEMENTS
Network Elements Section

network elements and card slots can be viewed in a vertical bar adjacent to the
Network Elements and Card Slots section in the Network Elements window.

Figure 11–14. Element Utilisation window

Fields

Field Description

Employee The name of the employee who has logged into the
Clarity application.

Element Type The equipment entity, for example the card slot or the
network element.

Statuses The status of the element that is included in the utilisation

calculation. The values are as follows:
• Spare,Planned (P)
• Commissioned, Active (A)
• Inactive (D)
• Bad Port (B)
• Locked (L)
Only the abbreviation (PADBL) is displayed against the
percentage in the utilisation bar.

Table 11–10. Element Utilisation window; fields

To set up the element utilisation options

1 In the Element Utilisation window, select the corresponding check box for
the element status that you want to include in the utilisation calculation. Note
that the Employee name and Element Type appear by default.
2 Save your record.

229
NETWORK ELEMENTS
Network Elements Section

Create NE From Template

Click on the Create NE From Template button to display the Create Network
Element from Template window.
You can use this window to create a network element record derived from the user
defined information in a network element template. Network Element templates
are used to create a prototype for a network element and use this to create
multiple network element records. See Creating Network Element Templates on
page 439 for more information.

Figure 11–15. Create Network Element from Template window

Fields
The fields in the Create Network Element from Template window are:

Field Description

Network Element The name of the Network Element Template which

Template defines the base configuration of the new network
element.

Customer The name of the customer that owns this network

element.

Status The status of the new network element.

Location The physical location of the network element.

Table 11–11. Create Network Element from Template window; fields

230
 NETWORK ELEMENTS
Network Elements Section

Field Description

In-Service Date The date on which the network element will be placed in
service.

Table 11–11. Create Network Element from Template window; fields

Button
The button in the Create Network Element from Template window is:

Button Description

Create Network Create a new network element based on the details

Element entered in the Create Network Element from
Template window and the Network Element Template.

Table 11–12. Create Network Element from Template window; button

To create a network element record from a network element

template
1 Ìn the Create Network Element from Template window, use the LOV
button to select a NE Template.
2 Use the LOV button to select a customer and set up the status and location of
the network element. Enter the In-Service date. By default, the system date
will be displayed in this field.
3 Click Create Network Element to create the record.

Note
To access all other windows using the Tool Palette, you must query or
create a network element record. With the exception of the Create NE
From Template and Element Utilisation windows, you must have a
network element in context to access the windows described in the
following sections.

231
NETWORK ELEMENTS
Network Elements Section

Alternate Names
Click on the Alternate Names button on the Tool Palette to display the Alternate
Network Element Names window. Use this window to assign alternate names
to the network element.

Figure 11–16. Alternate Network Element Names window

Fields

Field Description

Name The alternate name for the network element.

Type The alternate name usage, i.e., it could be a user defined

name or other carrier name. For example, for a network
element, the name could be 012XYZ and the type could
be Óld Name.

Table 11–13. Alternate Network Element Names window;fields

To define an alternate network element name

1 Enter a name and type in the corresponding fields in the Alternate Network
Element Names window.
2 Save your record.

Attach and View Files

Click on the Attach and View Files button to opens the File Attachments
window.

232
 NETWORK ELEMENTS
Network Elements Section

Use this window to attach associated files, such as documents and spreadsheets
to the network element record. See Getting Started with Clarity OSS for more
information on creating and deleting links to external files.

Figure 11–17. File Attachments Window

Fields

Field Description

File Path Is automatically populated with the file location when you
attach the file. All files are uploaded or attached under
the C:\TEMP subdirectory.

File Name Is automatically populated with the file name.

Table 11–14. File Attachments Window;fields

Buttons

Field Description

Attach File Click to attach a file.

View File Click to view the attached file.

Table 11–15. File Attachment Window; buttons

To attach a file to a network element record

1 Click on the Attach File button. In the Select a file to upload window,
choose the file that you want to attach and click Open.
2 You will be prompted to select the sub-directory to upload the file to. Select
the C:\TEMP directory. Click OK. The file will be attached and the path and
name will be populated in the File Attachments window.

233
NETWORK ELEMENTS
Network Elements Section

Bulk Update Service Types

On the Tool Palette, click the Bulk Update Service Types button to display the
Bulk Update Service Type Details window.
Use this window to apply a service Type Template to a range of ports on a
selected card in the network element.

Figure 11–18. Bulk Update Service Type Details window

Fields

Field Description

Card The name of the card.

Starting Select a port range by entering the first and last numbers
Port/Ending Port of the port name range.

Service Type The service type template that will be applied to the ports
Template selected. Use LOV to select a service type template.

Priority The importance of this update,for example, 1 being the

highest value.

Table 11–16. Bulk Update Service Type Details window;fields

234
 NETWORK ELEMENTS
Network Elements Section

Button

Field Description

Update Click to associate the service type template to a range of

ports.

Table 11–17. Bulk Update Service Type Details window; button

To update the service type supported on a range of ports in a card

1 In the Bulk Update Service Type Details window, use the LOV to select a
card in the network element and a range of ports in that card.
2 Choose the Service Type Template that will be supported on the multiple
ports selected. Optionally, enter a priority.
3 Click Update to perform the batch update.

Costed Items
On the Tool Palette, click the Costed Items button to display the Costed Item
List window.
Use this window to create a list of costed items for the selected network element.
The cost of network element items is set up in the Costed Items reference window
available under the Provisioning module.

Figure 11–19. Costed Item List window

235
NETWORK ELEMENTS
Network Elements Section

Fields

Field Description

Item Name The name of the costed item.

Type Type of cost, e.g. fixed, daily, weekly.

Cost Actual cost of the item.

Comments Free text field to enter any additional comments.

Table 11–18. Costed Item List window;fields

To create a costed item list

1 Use the LOV to select the item. The Type and Cost field will be automatically
populated with the values set up for that item in the Costed Items reference
window.
2 Enter comments if required. Save your record.

Create NE Template
Click on the Create NE Template button to display the Create Network
Element Template window.
Use this window to create a network element template derived from the network
element record currently selected.

Figure 11–20. Create Network Element Template window

236
 NETWORK ELEMENTS
Network Elements Section

Field

Field Description

Template Name A meaningful name for the network element template.

Table 11–19. Create Network Element Template window; field

Button

Button Description

Create Template Click this button to create a template with the name
specified in the Template Name field.

Table 11–20. Create Network Element Template window; button

To create a template from the selected network element

1 Enter a template name in the Create Network Element Template window.
2 Click Create Template. In the pop up window that appears, click Yes to
save your changes.

Equipment Features
On the Tool Palette, click the Equipment Features button to display the
Equipment Features window.
Use this window to select a list of service features that are or can be available on
that network element. Service features are set up in the Service Definition
window available under the Provisioning module.
Features can be defined at the NE (equipment) level or the card level. Features
defined at the NE level combine both the features available for the entire NE and
the features available only at the card level (in this case the number of ports on
the card determine the available features). Card features cannot be defined
unless the card model has been flagged as supporting the features. This is set up
in the Card Models window. See Card Models on page 546 for more
information. Once this is done, the feature can be defined at the NE level and will
become available for definition at the card level.

Note
Service features on the Server level are only available for a network
element that has been configured as a server equipment. A Server
Equipment is a network element that is configured as a server providing

237
NETWORK ELEMENTS
Network Elements Section

service features enabled on it to other equipment or network elements. For

example, the Intelligent Network platform. The server equipment is
configured using the Server Equipment window under the Inventory >
Components > Network Elements Feature Hierarchy window. See
Network Elements Feature Hierarchy on page 294 for more information.

When a network element is set up as a server equipment, the service features

that it can support are also set up in the Server Equipment window. These
features will be automatically displayed as configured at the server level when
you query the Equipment Features window for such a network element
using the Network Elements tool palette.

Figure 11–21. Equipment Features Window

Fields

Field Description

Feature Name The name of the service feature.

Total Capacity Indicates the total capacity of the network element to

support that service feature, for example how many cards
or ports.

Usable Capacity Indicates the percentage of the total capacity that will be
in% made available to support the service feature.

Table 11–21. Equipment Features Window;fields (sheet 1 of 2)

238
 NETWORK ELEMENTS
Network Elements Section

Field Description

Total Used Indicates the number of features consumed, i.e. how

much of the total capacity is already being used to
support the feature.

Category Indicated whether the selected service feature is

supported on the equipment or card level. Features at the
server level are automatically populated if the network
element has been set up as a server equipment.

Table 11–21. Equipment Features Window;fields (sheet 2 of 2)

Button

Button Description

Load Features Click this button to launch the Equipment Feature

Templates LOV to select a template and load the features
that are associated with that particular equipment feature
template. See Equipment Feature Templates Window on
page 446 for more information.

Table 11–22. Equipment Features window; button

To set up the features supported on a network element

You can either load multiple features from an Equipment Feature Template
using the Load Features button or use the Feature Name LOV to load one
feature at a time.
1 To load features from the Equipment Feature Templates, click on the Load
Features button. The Equipment Feature Templates LOV is displayed.
Select the template and click OK. The features defined under that template
will be loaded on to the Equipment Features window.
2 Alternatively, in the Equipment Features window, use the LOV button to
select the Feature Name.
3 Enter values (in numbers) in the Total Capacity, Usable Capacity in%, and
Total Used fields.

239
NETWORK ELEMENTS
Network Elements Section

4 From the Category drop-down list, choose either Card, Equipment, or

Server to indicate the level where the service feature is available.
i. Select Equipment to indicate that the feature is supported on all the
cards and ports of this network element.
ii. Select Card to indicate that the service feature is available only on the
ports of the selected card.

Note
Prior to setting up the service features that can be or are available
on the cards of the selected network element, you must ensure that
the card model is capable of supporting that service feature. The
service features that can be supported on each card type is set up in
the Card Models reference data window. See Card Models on page
546 for more information. The service features that can be supported
on a card will depend on the number of ports available on that card.
5 Save your record.

Floor Location Details

On the Tool Palette, click the Floor Location Details window to display the
Network Element Floor Location window.
Use this window to record building location information for the network element.
This includes information such as the building number, floor, room, suite, rack
and shelf.

Figure 11–22. Network Element Floor Locations window

240
 NETWORK ELEMENTS
Network Elements Section

Fields

Field Description

Item Name An attribute name that describes the physical location of

the network element, e.g. Floor, Room, Rack.

Value The value associated with the Item Name. For example, if
the Item Name was Rack, the Value may be D.

Table 11–23. Network Element Floor Locations window; fields

To record the network element floor locations:

1 In the Network Element Floor Locations window, enter a descriptive name
such as Floor, Room, Suite, and so on.
2 Enter the corresponding value for the item name. Save your record.

Internal Connections
On the Tool Palette, click on the Internal Connections button to display the
Internal Connections window.
Use this window to create or delete the connections within the network element.
This can be used when the network element has no hierarchy, i.e. no parent or
child ports. These types of network elements are called passive devices. This can
also be used to identify FIXED devices such as a DME type mux where the physical
I/P ports always ride on a fixed logical time slot.

Figure 11–23. Internal Connections window

241
NETWORK ELEMENTS
Network Elements Section

Fields

Field Description

From and To The From fields indicate where the connection begins
and the To fields indicate where the connection
terminates.

Card Slot The card slot on the network element. See Card Slots
Section on page 257 for more information.

From Port The starting number of the port range, for example, from
P1.

To Port The ending number of the port range, for example, to

P16.

Table 11–24. Internal Connections window;fields

Buttons

Button Description

Create Click this button to create a new internal connection on

that network element.

Delete Click this to delete an existing internal connection.

Table 11–25. Internal Connections window; buttons

To create or delete an internal connection

1 Click in the Card Slot field and use the LOV button to select a card slot in
that network element.
2 Use the LOV to select the From and To ports.
3 To create or delete the connection, click on the corresponding button.

Lock/Unlock Ports
On the Tool Palette, click the Lock/Unlock Ports button to display the
Lock/Unlock Ports window.

242
 NETWORK ELEMENTS
Network Elements Section

Use this window to lock (make unavailable) or unlock (make available) a range of
ports on the selected card slot.

Figure 11–24. Lock/Unlock Ports window

Fields

Field Description

Card Slot The card slot on the network element.

Starting Port The starting number of the port range.

Ending Port The last number of the port number range.

Table 11–26. Lock/Unlock Ports window;fields

Buttons

Button Description

Lock Click to lock the selected ports on the card.

Unlock Click to unlock the selected ports on the card.

Table 11–27. Lock/Unlock Ports window; buttons

To lock/unlock ports on a card

1 Use the LOV to select a card on the network element. Select multiple ports on
that card by specifying the first and last numbers of the port range.
2 Click Lock or Unlock to perform the corresponding function.

243
NETWORK ELEMENTS
Network Elements Section

Manage Service Type Details

This section describes in detail the Network Element Service Type Templates
pop-up window that is displayed when the user double-clicks on the Service Type
Template field in the Network Elements window. For the selected Network
Element record, this window can also be called by clicking on the Manage
Service Type Details button in the Tool Palette. This window is used to add,
delete, or modify the service type template/service types association for the
selected network element record.
If service types have been associated with the network element, this window will
be displayed with the Service Types tab in focus. See figure below.

Figure 11–25. Network Element Service Type Template Window; Service Types Tab

Fields

Field Description

Type The service type supported on the network element.

Description Service Type description.

Priority The order of selection priority when choosing a NE to

support or supply the service.

Table 11–28. Network Element Service Types tab;fields

244
 NETWORK ELEMENTS
Network Elements Section

If service templates are applied to the network element, this window will be
displayed with the Service Templates tab in focus. See figure below.

Figure 11–26. Network Element Service Type Templates Window; Service Templates Tab

Fields

Field Description

Name The service type template associated with the network

element.

Description Service Template description.

Priority The order of selection priority when choosing a NE to

support or supply the service.

Table 11–29. Network Element Service TemplatesTab;fields

The following business rules apply in the Network Element Service Type
Templates pop-up window when querying or managing service types that can be
supported on the equipment:
• When viewing Service Type Templates associated with a network
element, the user can add a new template, delete or update an
associated template. New templates are available for selection from
the LOV in the Name field. Optionally, to update an existing record
by replacing it with a new template, the user must select the record

245
NETWORK ELEMENTS
Network Elements Section

and type in the first few characters of the new template name and
press the Tab or Enter function key. The existing record will be
replaced with the new record which will inherit the priority from the
replaced record. Note that the user can update or delete an existing
record only if it has not been associated with any child object.
• If individual service types are associated with the network element
record, the user can either delete the current service types, or add new
service types. For a card or port, only service types that are supported
by the parent entity are available for selection. At the parent level, any
service type can be linked.
• The user cannot link both a service template definition and a set of
services types against the same object. One or the other is allowed but
not both at the same time. If there are no service types associated with
the network element, and the user attempts to create a Service Type
definition via the Service Types tab, a message will be displayed
prompting the user to either select an existing service type template or
define a new service type template and associate that with the
equipment record rather than defining individual Service Types. The
user can, however, ignore the message and associate independent
service types to the network element.
• Copying a Network Element (Equipment, Cards, Ports) should result in
the templates or service types that are currently defined being copied
to the new instance.
• Multiple service type templates can be associated at the network
element or card level, however, only one service type template can be
associated at the port level.

Note
The same business rules will apply to the Service Type Template field in
the Cards and Ports region of the Network Elements window.

For information on Service Type Templates, see Service Types Template on page
461.

Move Network Element

On the Tool Palette, click the Move Network Element button to display the
Move Network Element window. Use this window to move the network element

246
 NETWORK ELEMENTS
Network Elements Section

to a new location in the network, for example to another distribution point, node,
frame, and so on.

Figure 11–27. Move Network Element window

Fields

Field Description

Please enter the Indicates the new location of the network element.
new location for
this Network
Element

Table 11–30. Move Network Element window;fields

Button

Field Description

Move Network Click to move the network element to the new location
Element selected.

Table 11–31. Move Network Element window;fields

To move the network element to a new location

1 In the Move Network Element window, use the LOV button to select a new
location for the network element in context.
2 Click Move Network Element. A message will be displayed confirming that
the network element has been moved.

247
NETWORK ELEMENTS
Network Elements Section

Move Services
On the tool palette, click on the Move Services button to display the Move
Services window.
Use this window to select a card and move the services that are provisioned on
the ports of this card to a set of ports on another card. The existing phone
numbers will be disassociated from the old ports and moved to the new ports.

Figure 11–28. Move Services window

Fields

Field Description

Source/Destination The cards on the network element.

Card

Starting Port The starting number of the port range.

Ending Port The ending number of the port range.

Table 11–32. Move Services window;fields

Button

Field Description

Transfer Click to transfer the services from the ports on the source
card to the ports on the destination card.

Table 11–33. Move Network Element window;button

248
 NETWORK ELEMENTS
Network Elements Section

To move services from one card to another

1 In the Move Services window, use the LOV button to select the Source and
Destination cards.
2 Select the starting and ending ports for both the cards.
3 Click Transfer to move the services from one card to another.

Network Element Aliases

On the Tool Palette, click the Network Element Aliases button to display the
Network Element Aliases window.
Use this window to define a network alias for the network element in context. A
network element alias is the name used by the external system to identify the
network element.

Figure 11–29. Network Element Aliases window

Fields

Field Description

Alias The network element alias.

Domain The naming domain.

Table 11–34. Network Element Aliases window;fields

To create an alias for the network element

1 In the Network Element Aliases window, enter an Alias and the domain
that the alias is related to in the corresponding fields.
2 Save your record.

249
NETWORK ELEMENTS
Network Elements Section

Network Element Parameters

Displays the Network Element Parameters window.
Use this window to define additional attributes for the NE.

Figure 11–30. Network Element Parameters window

Fields

Field Description

Name The network element parameter validation name.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following:
• Alpha
• Number
• Character
• Date

Value A value associated with the attribute. For example if the

attribute name is IP Address, the value in this field would
be the actual IP address.

Defined by The person that defined the attribute. Select one of the
following:
• Customer
• Engineer
• System

Table 11–35. Network Element Parameters window; fields (sheet 1 of 2)

250
 NETWORK ELEMENTS
Network Elements Section

Field Description

Optionality The status of the attribute value.

Select one of the following:
• Mandatory
• Optional
• Fixed
Value must be entered in the Attribute Value field in
this form. Once this value is saved it cannot be
changed.

Table 11–35. Network Element Parameters window; fields (sheet 2 of 2)

Button
The button in the Network Element Parameters window is:

Button Description

Load NE Click this button to open the Valid Network Element

Parameters Detail Template window and select a Network Element
Details Template name.

Table 11–36. Network Element Parameters window; button

To define attributes for the network element

1 In the Network Element Parameters window, use the LOV button in the
Name field to select a NE parameter name.
2 Choose a data type from the Data Type drop-down list. Enter a value for the
data type in the Value field.
3 Choose whether the parameter is defined by the Engineer, Customer, or
System. Choose whether the value is an optional, mandatory or fixed value.
4 Click the Save button. Alternatively, if the attributes for the selected network
element have already been set up in the Network Element Details
Template window, click the Load NE Parameters button to load these
predefined values.See Network Element Template Details on page 435 for
information on using this window. All the other values will be populated
automatically.

Pre-Provision Ports
On the Tool Palette, click on the Pre-Provision Ports button to display the Pre-
Provision Ports window.

251
NETWORK ELEMENTS
Network Elements Section

Use this window to select a range of spare (no number assigned) switch ports
based on the Card Slot and Number Type, e.g. Gold, Silver, etc. and assign
numbers to the ports. Alternatively, if numbers are already assigned to these
ports, you can use this window to unassign them from the ports.

Figure 11–31. Pre-Provision Ports window

Fields

Field Description

Card Slot The card slot in the selected network element.

Starting The first and last port names of the port range being
Port/Ending Port selected.

Number Type A unique code that identifies a particular Number Type,

e.g. Gold, Silver or Platinum. Number Types are set up in
the Number Technology and Types reference data
window available under the Inventory > Reference
Data > Numbers menu.

Area The area code associated with the number.

Starting Number The first number of the number range.

Ending Number The last number of the number range.

Table 11–37. Pre-Provision Ports window; fields

252
 NETWORK ELEMENTS
Network Elements Section

Buttons

Buttons Description

Provision Click this button to provision the specified numbers on

the selected ports.

Un-Provision Click this button to detach the selected number range

from the ports.

Table 11–38. Pre-Provision Ports window; button

To provision or un-provision ports

1 In the Pre-Provision Ports window, click in the Card Slot field and use the
LOV to select a card slot in the selected network element.
2 Use the LOV button to select the starting and ending port and specify a port
range.
3 Use the LOV button to select the Number Type and area code as well. Enter
the starting and ending numbers.
4 Click Provision to assign these numbers to the selected ports. Alternatively,
click Un-Provision if the numbers are already assigned to the ports and you
want to un-assign them.

System Configuration
On the Tool Palette, click on the System Configuration button to display the
System Configuration window.

253
NETWORK ELEMENTS
Network Elements Section

Use this window to view the system configuration and the configuration elements
information associated with the Network Element.

Figure 11–32. System Configuration window

Fields

Field Description

System The vendor software load, software version and release

Configuration date.
Name, Version,
and Date

Configuration The defined parameters for the NE such as Installed

Elements Name memory, IP Address, Interfaces etc.
and Value

Table 11–39. System Configuration Window; fields (sheet 1 of 2)

254
 NETWORK ELEMENTS
Network Elements Section

Field Description

Configuration The additional configuration details associated with the

Element Details above parameters, for example, an interface such as
Name and Value protocol, Route descriptors, Route Target, Next hopIP
address, and so on.

Table 11–39. System Configuration Window; fields (sheet 2 of 2)

Utilisation Thresholds (NE)

Click on the Utilisation Threshold button on the Tool Palette to display the NE
Utilisation Thresholds window.
Use the NE Utilisation Thresholds window to set, browse and/or modify
threshold levels. By setting thresholds, infrastructure planning can be based on
utilisation. For e.g., if the switch reaches 80% utilisation, a new switch can be
commissioned for that location.

Figure 11–33. NE Utilisation Thresholds window

Fields

Field Description

Threshold Set The name of the Threshold Set.

Name

Critical Threshold The critical utilisation threshold (value between 1 and

100). When the critical level threshold is reached, the
color of the utilisation bar graph in the Network
Elements window will be red.

Table 11–40. NE Utilisation Thresholds window; fields (sheet 1 of 2)

255
NETWORK ELEMENTS
Network Elements Section

Field Description

Major Threshold The major utilisation threshold specified as a value

between 1 and 100 (default 80). When the major level
threshold is reached, the color of the utilisation bar
graph in the Network Elements window will be orange.

Minor Threshold The minor utilisation threshold specified as a value

between 1 and 100 (default 60). When the minor level
threshold is reached, the color of the utilisation bar
graph in the Network Elements window will be yellow.

Warning Threshold The warning utilisation threshold specified as a value

between 1 and 100 (default 40). When the warning level
threshold is reached, the color of the utilisation bar
graph in the Network Elements window will be green.

Table 11–40. NE Utilisation Thresholds window; fields (sheet 2 of 2)

To set up the utilisation threshold parameters for the network

element:
1 In the NE Utilisation Thresholds window, use the LOV to select the
Threshold Set Name to load.
2 Set the values of the Critical Threshold, Major Threshold, Minor
Threshold, and Warning Threshold as desired.
3 Click the Save button.

256
 NETWORK ELEMENTS
Card Slots Section

Card Slots Section

This section shows the cards and slots that exist for a selected network element.

Figure 11–34. Card Slots section in the Network Elements window

Fields
The fields in the Card Slots section are:

Field Description

Slot The physical slot in the equipment chassis that the card
occupies.
Click to display the Card Parameters window.

Card Type Card type, e.g. HSU, CPU, PS or Aggregate. List of

values in this field is determined by the configuration in
the Card Models reference data screen where Card
Types are linked to Network Element Types. The LOV on
the Card Type field in the Network Elements screen
will display the following:
• Card types whose network element type is null in the
Card models screen.
• Card types whose network element type matches the
network element type of the equipment for which the
card is being created.

Model The model number of the card.

Revision The model revision number.

Serial Number The serial number used to identify the card.

NEMS The network element management system name.

Table 11–41. Card Slots section; fields (sheet 1 of 3)

257
NETWORK ELEMENTS
Card Slots Section

Field Description

Service Type Displays the highest priority Service Type Template or

Template Service Type associated with the selected Card. Double-
clicking on this field will bring up the Card Service Type
Templates pop-up window that will display either the list
of service templates or service types depending on the
data associated with the card. The user can also add,
delete, or update the service template or service type
association using this window. For more information see
Card Service Type Templates on page 259.
Note that only those service templates or service types
can be associated with the card that have been defined
at the network element level. However, a particular
service template or service type need not have the same
priority at the card level as it has at the network element
level. For example, a service template of type PSTN can
be assigned priority1 at the Network Element level, and
a priority 2 at the Card level. The Service Type
Template field in the Card Slots section will display the
service template or service type that has been assigned
the highest priority for the selected card.
The Card Service Type Templates window can also be
invoked by clicking on the Manage Service Type
Details button in the Cards Tool Palette.

Card Status Current status of the card, e.g. Active. Use the
drop-down list to select a value.

Card Mode The working mode of the card slot. Valid values are
Neither, Working or Protect. Use the drop-down list to
select a value. Select Protect if the card is to be used for
creating protected paths.

Parent Card Slot The physical slot in the equipment chassis that the parent
card occupies. If the Parent Card Slot has a value, it
indicates that the current slot and card is a child of that
parent.

Card relation The relationship of the current card to any other card.

Table 11–41. Card Slots section; fields (sheet 2 of 3)

258
 NETWORK ELEMENTS
Card Slots Section

Field Description

Utilisation Displays the number of allocated active ports for the

selected card as a percentage. The bar graph is
displayed in different colours depending on the
utilisation.
Green: 0% - 49%
Orange: 50%. - 79%
Red: 80% - 100%.
The statuses used in the Utilisation calculations appear
next to the Utilisation field as an abbreviation, e.g.
PADBL stands for Planned, Active, InActive, Bad Port and
Locked.

Table 11–41. Card Slots section; fields (sheet 3 of 3)

Card Service Type Templates

Use the Card Service Type Templates window to assign a Service Template or a
Service Type to a card.
To open the Card Service Type Templates window
1 Open the Network Elements window (see To open the Network Elements
window on page 206).
2 Query a Network Element card in the Card Slots section (see Card Slots
Section on page 257).
3 Double click in the Service Type Template field.
The Card Service Type Templates window displays.

259
NETWORK ELEMENTS
Card Slots Section

Figure 11–35. Card Service Type Templates window, Service Templates tab

Figure 11–36. Card Service Type Templates window, Service Types tab

260
 NETWORK ELEMENTS
Card Slots Section

Fields

Field Description

Service Templates tab

Name A descriptive name for the card service template.

Description A meaningful description of the card service template.

Priority The order of selection priority when choosing a card to

support or supply the service.

Service Types tab

Name A descriptive name for the card service type.

Description A meaningful description of the card service type.

Priority The order of selection priority when choosing a card to

support or supply the service.

Table 11–42. Card Service Type Templates window; fields

Card Slots Section Tool Palette

Click the Tool Palette button in the Card Slots section to display the list of
buttons.

Figure 11–37. Buttons in the Card Slots Section Tool Palette

The buttons in the Card Slots section Tool Palette provide access to various forms
using which you can define additional features/attributes for and perform certain
functions related to the selected card in the network element.

261
NETWORK ELEMENTS
Card Slots Section

The various forms available through the Tool Palette and the functionalities they
provide are discussed in the sections below.

Note
As a prerequisite to using the functionalities available through the Tool
Palette in the Card Slots section, you must query a network element
record and select a card on that network element.

Aggregate Ports
Click on the Aggregate Ports button on the Tool Palette to display the
Aggregate Ports window.
Use this window to identify a range of ports (either multiple ports or a number of
child ports under a parent port) on the selected card and aggregate them to form
one single port.

Figure 11–38. Aggregate Ports window

Fields

262
 NETWORK ELEMENTS
Card Slots Section

The fields in the Aggregate Ports window are:

Field Description

Network Element

Location Location of the NE.

Type The network element type.

Index The network element index.

Card Slot The card slot on the network element in context.

Note: All of the above fields are auto populated based
on the network element and card slot selected.

Port Name The parent port name. (Select this if you want to
aggregate child ports)

Ports

Port Name Name of the ports that you want to aggregate.

Actions for Selected The options under this section will determine what action
Ports and Child is performed on the selected ports and all its associated
Ports child ports after they have been aggregated to form a
new port.
• No Action - No action will be performed on the ports
being aggregated once the new port is created.
• Change Status - Post aggregation, the status of the
ports selected for aggregation and all its associated
child ports will be changed. When you select this
option, the Status field will be highlighted. You can
select a new status from the drop-down list.
• Delete Ports - The ports selected for aggregation and
its associated child ports will be deleted after the new
port has been created.

Status This option will be available if you have selected the

Change Status radio button in the above mentioned
field. Select the new status for the ports being
aggregated from the drop-down list.

Table 11–43. Aggregate Ports window; fields (sheet 1 of 2)

263
NETWORK ELEMENTS
Card Slots Section

Field Description

New Port

Port Name The name of the new port that will be created after
aggregating the selected ports.

Capacity Capacity, speed or bandwidth for the selected port

Status The status of the new port.

Table 11–43. Aggregate Ports window; fields (sheet 2 of 2)

Buttons

Button Description

Aggregate Ports Click to aggregate the ports.

Table 11–44. Aggregate Ports window; button

To aggregate ports:
1 With the network element and selected card in context, click on the
Aggregate Ports button in the tool palette. The Aggregate Ports window
will be displayed. The Location, Type, Index, and Card Slot fields are
automatically populated from the information in the Network Elements
window. All the ports available on the card will be listed in the Ports section.
2 To aggregate the child ports under a specific parent port, select the parent
port name using the LOV button in the Port Name field in the Network
Elements section. The Ports section will be refreshed with a list of the child
ports under that parent port. Alternatively, double click on the parent port
name in the Ports section. The Port Name field in the Network Element
section will be automatically populated with this value and the child ports will
be available for selection in the Ports section.
3 Select the ports that you want to aggregate. In the Action for Selected Ports
and Child Ports section, select the action that you want to perform on the
selected ports and all its associated child ports after aggregation.
4 In the New Ports section, enter a name for the new port. Optionally, enter
the capacity or bandwidth of the new port.
5 Select a status for the new port from the Status drop-down list.
6 Click the Aggregate Ports button to aggregate the selected ports.

264
 NETWORK ELEMENTS
Card Slots Section

Assets and Dimensions

Click on the Assets and Dimensions button on the Card Slots section Tool
Palette to open the Assets and Dimensions window.
Use this window to maintain the asset and dimension details for the cards in the
network element. This window is also accessed at the network element level to
enter assets and dimension information for the network element. The fields on this
window and the functionality it provides is discussed in detail in the View/Modify
Network Element Asset or Dimension details section on page 216.

Card Aliases
On the Tool Palette, click the Card Aliases button to display the Card Aliases
window.
Use this window to define an alias for the selected card in the network element.
Similar to a network element alias, a card alias is the name used by the external
system to identify the card.

Figure 11–39. Card Aliases window

Field Description

Alias The card alias.

Domain The naming domain.

Table 11–45. Card Aliases window;fields

To create an alias for the card

1 For the selected card, enter the alias and the domain that the alias is related
to in the corresponding fields.
2 Save your record.

265
NETWORK ELEMENTS
Card Slots Section

Card Features
Click on the Card Features button to display the Card Features window.
The Card Features window is a view only window that displays the service
features that are or can be supported on the selected card in that network
element. These values are set up in the Equipment Features window that can be
accessed from the Network Element Tool Palette. See Equipment Features on
page 237 for more information.

Figure 11–40. Card Features window

Fields
The fields in the Card Features window are:

Field Description

Feature Name The name of the service feature that is enabled on the
card.

Total Capacity The number in this field depends on the total number of
ports available on the card.

Total Used The total number of ports being used for the
corresponding service.

Table 11–46. Card Features window; fields

266
 NETWORK ELEMENTS
Card Slots Section

Card Hierarchy
Click on the Card Hierarchy button on the Tool Palette to display the Cards
Hierarchy window.
Use this window to graphically visualise the relationship of cards to each other.

Figure 11–41. Card Hierarchy window

Fields
The fields in the Card Hierarchy window are:

Field Description

Card Details

Slot The physical slot in the equipment chassis that the card
occupies.

Card Type Card type, e.g. HSU, CPU, PS or Aggregate.

Model The model number of the card.

Revision The model revision number.

Table 11–47. Card Features window; fields (sheet 1 of 2)

267
NETWORK ELEMENTS
Card Slots Section

Field Description

Serial Number The serial number used to identify the card.

NEMS The network element management system name.

Card Status Current status of the card, e.g. Active. Use the drop-
down list to select a value.

Card Mode The working mode of the card slot. Valid values are
Neither, Working or Protect.

Card Service Types

Service Type Shows the first supported service type.

Priority The order of selection.

Table 11–47. Card Features window; fields (sheet 2 of 2)

Copy Cards
Click on the Copy Cards button on the Tool Palette to display the COPY CARD
window.
Use this window to copy a card existing in the network element in context to
another card slot in the same network element or a different network element.
The new card will be in a Proposed status. All ports that are copied will also have
a Proposed status.
The following port information is copied:
• Port name
• Port usage
• Capacity
• Cable
The following card attributes are copied:
• Card serial number
• Card type
• Card location
• Card model
Optionally, you can also copy the card parameters from the existing card onto the
new card.

268
 NETWORK ELEMENTS
Card Slots Section

Additionally, when copying cards to a different network element, users can specify
a new card slot for cards that are to be copied. For those cards that a new card
slot has been provided, the card will be copied into the provided slot.

Figure 11–42. COPY CARD window

Fields

Field Description

Different NE tab

NE Location Location of the different network element that the cards

will be copied to.

NE Type NE type of the different network element that the cards

will be copied to.

NE Index NE index of the different network element that the cards

will be copied to.

Card Slot Card Slot of the card which is being copied. Select to use
the same slot in the new network element.

Table 11–48. COPY CARD window;fields (sheet 1 of 2)

269
NETWORK ELEMENTS
Card Slots Section

Field Description

Card Name Name of the card in the selected slot.

New Card Slot Enter a slot name if you want to copy the cards onto a
new card slot in the new network element.

Copy Parameters Copy the card parameters onto the new cards.

Same NE tab

New Card Slot Enter the card slot on the same network element and
click Create New Card.

Copy Parameters Copy the card parameters onto the new cards.

Table 11–48. COPY CARD window;fields (sheet 2 of 2)

Button

Button Description

Copy Selected Copies the selected (ticked) card to the selected record.
Cards

Table 11–49. COPY CARD window; button

To copy cards
1 In the COPY CARD window, select the card slot that you want to copy.
2 Use the LOV button to select the NE Location, NE Type, and NE Index if
copying into a card slot in another network element. Optionally, specify a
new card slot if you do not want to use the existing card slots to be copied.
3 Select the Cop Parameters check box if you would like to copy parameters
from the existing card onto the new card.
4 Click Copy Selected Cards to copy the cards into slots in the new network
element.
5 Alternatively, if copying into a new card slot in the same network element,
click the Same NE tab and enter the new card slot name in the
corresponding field.
6 Click Create New Card to copy the existing card into a new card slot.

270
 NETWORK ELEMENTS
Card Slots Section

Delete Ports
Click on the Delete Ports button in the tool palette to delete all the ports in the
selected card. A message will be displayed warning the user that this function
cannot be undone. Click Yes to confirm the delete action. All the ports in the
selected card will be deleted.

Manage Service Type Details (for cards)

Click on the Manage Service Type Details button on the Tool Palette to display
the Service Types Template window for Cards. This window displays the service
type templates or service types associated with the card, if any, and also allows
the user to add, delete, and update records.

Figure 11–43. Card Service Templates

Note that the service type templates or service types that are available for
selection when adding or updating(replacing the current record with a new one)
are derived from the service templates or service types associated at the parent
level, i.e., with the network element. It must also be noted that the user cannot
delete an existing service template or service type if it is associated with any of the
ports within that card. For information on the business rules that apply, see
Manage Service Type Details on page 244. The business rules that apply to this
window at the Network Element level, apply at the Card level too.
Split Ports
Click on the Split Ports button on the Tool Palette to display the Split Ports
window. While the Aggregate Ports window is used to aggregate multiple ports,

271
NETWORK ELEMENTS
Card Slots Section

the Split Ports window is used to split a port into the desired number of new
ports.

Figure 11–44. Split Ports window

Fields
The fields in the Network Element section and the Ports section in the Split
Ports window are the same as the fields in the corresponding section in the
Aggregate Ports window. See Aggregate Ports on page 262 for field definition.
The fields under the New Ports section specific to the Split Ports window are
described below.

272
 NETWORK ELEMENTS
Card Slots Section

Field Description

From Port/To Port Enter the starting and ending port names to specify the
range of ports into which the selected port will be split.
For example, if you enter10 in the From Port and 15 in
the To Port fields respectively, 6 new ports will be
created named 10, 11,12,13,14,15.

Prefix The prefix for the port name.

Suffix The suffix for the port name

Left Pad Character The character that is used to pad the port number.

Left Pad Width The minimum length of the port name. If the port name
is less than this value, the port name is suffixed with one
or more pad characters to make the length the same
number of characters specified in this field.

Table 11–50. Split Ports window; fields

To split ports:
1 With the network element and the card in context, click on the Split Ports
button in the tool palette. The Split Ports window will be displayed. The
Location, Type, Index, and Card Slot fields are automatically populated
from the information in the Network Elements window. All the ports
available on the card will be listed in the Ports section.
2 To split a child port under a specific parent port, select the parent port name
using the LOV button in the Port Name field in the Network Elements
section. The Ports section will be refreshed with a list of the child ports under
that parent port. Alternatively, double click on the parent port name in the
Ports section. The Port Name field in the Network Element section will be
automatically populated with this value and the child ports will be available
for selection in the Ports section.
3 Select the port that you want to split. In the Action for Selected Ports and
Child Ports section, select the action that you want to perform on the
selected port once it has been split into new ports.
4 In the New Ports section, specify the port number range using the From
Port and To Port fields. Optionally, enter the capacity or bandwidth of the
new port.
5 Optionally, specify a naming convention by entering a prefix, suffix, left pad
character, and left pad width. The new ports will be named based on the
values entered here. See Create Port Range Window on page 454 for
information on how port ranges are created and named.

273
NETWORK ELEMENTS
Card Slots Section

6 Select a status for the new ports from the Status drop-down list.
7 Click the Split Ports button to split the selected port.

Utilisation Thresholds (for Cards)

Click on the Utilisation Threshold button on the Tool Palette to display the Card
Utilisation Thresholds window.
This window is the same as the NE Utilisation Thresholds window and is used to
set, browse and/or modify threshold levels for the card. For field descriptions and
information on setting up utilisation thresholds, see Utilisation Thresholds (NE)
on page 255.

Figure 11–45. Card Utilisation Thresholds window

274
 NETWORK ELEMENTS
Ports section

Ports section

Port Details Tab

This tab shows the user defined logical and physical parent and child ports for the
displayed network element.

Note
Highlight a Parent Port to display its related child ports.

Figure 11–46. Ports Details tab in the Network Elements window

275
NETWORK ELEMENTS
Ports section

Fields
The fields in the Port Details tab are:

Note
These descriptions apply to both the Parent Ports and Child Ports fields.

Field Description

Alias The Alias check box enables the automatic creation of

port aliases. When creating new ports for the network
element, select the Alias check box for all the ports that
you would like to define an alias for. A Port alias is the
name used by the external system to identify the port.
When the user saves the record, port aliases are created
based on the aliases procedure selected using the Port
Aliases Procedure window. The Port Aliases
Procedure window is explained under the Tool Palette
section below.

Slot The card slot.

Port Name Generic port name. Unique in context of NE instance.

Service Type Displays the highest priority Service Type Template or

Template Service Type associated with the selected Port. Double-
clicking on this field will bring up the Port Service Type
Templates pop-up window that will display either the list
of service templates or service types depending on the
data associated with the port. The user can also add,
delete, or update service templates or service types using
this window. For further information see Port Service Type
Templates on page 278.
For information on the business rules that apply, see
Manage Service Type Details on page 244.
Note that only those service templates or service types
can be associated with the port that have been defined at
the card level. However, a particular service template or
service type need not have the same priority at the Port
level as it has at the Card level. The Service Type
Template field in the Port Details section will always
display the service template or service type that has been
assigned the highest priority for the selected port.

Table 11–51. Port Details tab fields (sheet 1 of 2)

276
 NETWORK ELEMENTS
Ports section

Field Description

Capacity Capacity, speed or bandwidth for the selected port.

Status Current port status. Use the drop-down list to select a

value.

Circuit Reservation tab

Name Name of active circuit using this port. A circuit may also
be reserved.

Status Current circuit status. If status is Reserved, double-click

this field to display the Circuit Reserving this Port
window.

Cable Reservation tab

Name The name of the cable sheath.

Core The core of the cable connected to the port.

Cable Status The status of the cable, e.g. Inservice, Planned, etc.

Unnamed Indicates whether the circuit connection is an unnamed

connection.
• Y = Yes
• N = No.

Table 11–51. Port Details tab fields (sheet 2 of 2)

Buttons
The button in the Port Details tab is:

Button Description

Use the Add Port Attributes button to display the Port Parameters
window and add port parameters or load port details from the Port
Details Template by clicking the Load Port Parameters button.

Table 11–52. Port Details tab; button

277
NETWORK ELEMENTS
Ports section

Port Service Type Templates

Use the Port Service Type Templates window to assign a Service Template or a
Service Type to a port.
To open the Port Service Type Templates window
1 Open the Network Elements window (see To open the Network Elements
window on page 206).
2 Query a Network Element card in the Ports section (see Ports section on page
275).
3 Double click in the Service Type Template field.
The Port Service Type Templates window displays.

Figure 11–47. Port Service Type Templates window, Service Templates tab

Fields

Field Description

Service Templates tab

Name A descriptive name for the port service template.

Description A meaningful description of the port service template.

Table 11–53. Port Service Type Templates window; fields (sheet 1 of 2)

278
 NETWORK ELEMENTS
Ports section

Field Description

Priority The order of selection priority when choosing a port to

support or supply the service.

Service Types tab

Name A descriptive name for the port service type.

Description A meaningful description of the port service type.

Priority The order of selection priority when choosing a port to

support or supply the service.

Table 11–53. Port Service Type Templates window; fields (sheet 2 of 2)

Note
The following must be noted regarding service type templates:
• While multiple service type templates can be assigned to the network
element or card, only one service type template can be associated with
the port.
• Also, when defining a Port Template to create ports, only one service
type template can be associated with the port template.
• The automated reservation capability 'Facility Reservation' will check
the associated port level service type template when reserving network
infrastructure.
• At the port level, the user can only assign a template that has been
associated at the card level.

279
NETWORK ELEMENTS
Ports section

Port Details Section Tool Palette

Click the Tool Palette button in the Ports section to display the list of buttons.

Figure 11–48. Buttons in the Port Details Section Tool Palette

The buttons in the Port Details section Tool Palette provide access to various
forms using which you can define additional features/attributes for and perform
certain functions related to that selected port in the card.
The various forms available through the Tool Palette and the functionalities they
provide are discussed in the sections below.

Port Aliases Procedure

Click on the Port Aliases Procedure button on the Tool Palette to display the
Port Aliases Procedure window.
Use this window to specify the database procedure that will be called to derive the
port alias name and domain. This procedure is executed to carry out additional
steps such as customer specific validation of the creation of a customer specific
name and automates the creation of port aliases for all the selected ports
(enabled when the Alias check box is selected for each port). The procedure must
be set up by the user and stored in the database. It will then be available for
selection from a list of values. If no procedure name is specified, no alias will be

280
 NETWORK ELEMENTS
Ports section

associated with the new ports, even if their corresponding Alias check box for
each port is selected.

Figure 11–49. Port Aliases Procedure window

Fields

Field Description

Procedure The name of the procedure.

Name

Table 11–54. Port Aliases Procedure window; field

To define a procedure for creating port aliases

1 In the Port Aliases Procedure window, enter the procedure name or select
one using the LOV button.
All the ports that have the Alias check box selected will have an alias created
based on this selected procedure.

Parent Port Aliases

To define an alias for parent ports, click on the parent Port Name field and then
click on the Parent Port Aliases button on the Tool Palette. The Parent Port
Aliases window is displayed.

281
NETWORK ELEMENTS
Ports section

Use this window to define the parent port alias and domain. The fields in this
window and the procedure is the same as defining network element aliases.See
Network Element Aliases on page 249 for more information.

Figure 11–50. Parent Port Aliases window

Child Port Aliases

To define an alias for child ports, click on the child Port Name field and then click
on the Child Port Aliases button on the Tool Palette. The Child Port Aliases
window is displayed.
Use this window to define an alias and domain for the child port. See Network
Element Aliases on page 249 for field description and process information.

Port Configuration
Select a port and click on the Port Configuration button on the Tool Palette to
display the Port Configuration window. Use this window to view the
configuration data for the port. The information is derived from the system
configuration data for the network element. See System Configuration on page
253 for more information. The configuration windows allow you to take a copy of
the network elements MIB data and store it against the NE card and port in the
database.

282
 NETWORK ELEMENTS
Ports section

Additional Port Details Tab

This tab shows additional details for the user defined logical and physical child
ports for the displayed network element.

Figure 11–51. Additional Port Details tab in the Network Elements window

Fields
The fields in the Additional Port Details tab are:

Note
These descriptions apply to both the Parent Ports and Child Ports fields.

Field Description

Port Name Generic port name. Unique in context of the network

element instance.

Internal Connection The connections within the network element. This is used
when the network element has no hierarchy, i.e. no
parent or child ports. These types of network elements
are called passive devices.

Alarm Name NEMS port name used by the network element

management system.

Table 11–55. Additional Port Details tab;fields (sheet 1 of 2)

283
NETWORK ELEMENTS
Ports section

Field Description

Telephone Number The phone number related to the alarm.

Port Usage The port usage or purpose of the port.

Physical Port A flag to indicate if the port is physical or logical. Y (for

Yes) indicates that the port is physical.

Displayed in GUI A flag to indicate if the port is displayed in the Clarity

Realtime GUI. Y (for Yes) indicates that the port is
displayed.

Table 11–55. Additional Port Details tab;fields (sheet 2 of 2)

Connections Tab
The Connections tab displays information about the frames and cables/network
elements associated with the port.

Figure 11–52. Connections tab in the Network Elements window

284
 NETWORK ELEMENTS
Ports section

Fields
The fields in the Connections tab are:

Note
These descriptions apply to both the Parent Ports and Child Ports fields.

Field Description

Port Name Generic port name. Unique in context of the network

element instance.

Connector Type Connector type used to plug a patch cable into the port
of the network element.

Frame Container / The port’s directly-connected frame container name or

Network Element network element.

Frame Unit / Port The port’s directly-connected frame unit name or port
Name name.

Cable Sheath The cable sheath of the core terminated to port.

Cable Core The cable core terminated to port.

Number

Table 11–56. Connections tab; fields

285
NETWORK ELEMENTS
Features of the Network Elements Window

Features of the Network Elements Window

The features of the Network Elements window are:

Feature See…

Opening the Network Elements window page 206

Querying network elements page 287

Creating network element records page 288

Modifying network element records page 291

Deleting network element records page 292

286
 NETWORK ELEMENTS
Querying a Network Element

Querying a Network Element

To query a network element record
1 Click the Query button to place the window in query mode.
2 Click the field in the Network Elements section that you want to use for your
search.
3 Type your search criteria.
4 Click the Query button.
The first record that matches your search criteria is displayed.
5 Use the scroll bar to view the retrieved records.
6 Repeat steps 1-5 for each new search.

Note
Use the Network Elements section scroll bar to scroll through the other
retrieved records.

Hint
If you do not enter search criteria, all network element records are
displayed.

287
NETWORK ELEMENTS
Creating Network Element Records

Creating Network Element Records

You can insert the following types of records in the Network Elements window:
• network element records
• card records
• port record

Creating Network Element Records

A network element record refers to the fields in the Network Elements section of
the window.
To insert a network element record
1 Open the Network Elements window.
2 Complete the mandatory fields in the Network Elements section of the
window.
See Network Elements Section on page 208 for more information about the
fields in this section.
3 Complete the Slot, Card Type and Card Status fields in the Cards Slots
section.
This can be done manually (see Inserting Card Records on page 288 for
more information) or by clicking the Save button to create a default card for
the main unit.
4 Add ports in the Port Details and Additional Port Details sections of the
window.
This can be done manually (see Inserting Port Records on page 289 for more
information) or automatically by applying a Port Template (See the
information on creating ports on page 222).
5 Click the Save button.

Note
You must complete all mandatory fields before changes can be made in
the Network Elements section.

Hint
If you add ports using a Port Template, you need to make sure that a
template has been created. See Add Network Element Alarms on page
224 for more information on creating a port template.

Inserting Card Records

A card record is inserted in the Card Slots section of the Network Elements
window.

288
 NETWORK ELEMENTS
Creating Network Element Records

To insert a card record

1 Open the Network Elements window.
2 Query a network element record.
3 Use the scroll bar to select the required network element record.
4 Click the Slot field, then click on the Insert button that is available on the
toolbar and enter the card slot instance.
5 Click the Card Type field and use the LOV to enter the type of card currently
in the slot.

Note
The card types that are available for selection will be limited by the
network element type and manufacturer selected in the Network
Elements section. Only those card types will be available for
selection whose network element type in the Card Models reference
data window is set to null or whose value matches the network
element type of the equipment for which the card is being created.
The manufacturer of the network element and card must also be the
same. See Card Models on page 546 for more information about
this reference window.
6 Select the status from the drop-down menu in the Card Status field.
7 Click the Save button.
The card slot record is saved and the Location field is completed by default
to match the location in the network element section of the window.

Inserting Port Records

Port records are inserted in the Port Details and Additional Port Details
sections of the Network Elements window. You can add ports manually or you
can add port records using a port template.
This procedure describes how to manually insert a port record. See Create Ports
on page 222 for more information about using port templates to create port
records.
To insert a port record
1 Open the Network Elements window.
2 Query a network element record.
Use the scroll bar to select the network element record that requires ports.
3 Select the card slot record in the Card Slots section.
4 Click the Port Details tab.
5 Click the Insert button to place the window in insert mode.
6 Enter the details in the Parent Ports and Child Ports sections.
7 Click the Additional Port Details tab and enter any additional details, such
as the alarm name and port usage.

289
NETWORK ELEMENTS
Creating Network Element Records

8 Click the Connections tab and enter the connector type.

9 Click the Save button.

290
 NETWORK ELEMENTS
Modifying Network Element Records

Modifying Network Element Records

This section shows you how to change records in the Network Element window.
To modify a network element record
1 Query a network element record.
2 Click on the field that you want to modify.
3 Highlight the existing value that you need to change.
4 Enter the new value and click the Save button.
The changes are saved to the database.

291
NETWORK ELEMENTS
Deleting Network Element Records

Deleting Network Element Records

This section shows you how to delete records in the Network Elements window.
This includes network elements, cards and ports.

Note
You cannot delete a network element record or card slot record if it is
being used by a circuit or has ports attached. You cannot delete the main
unit card at any time, only individual ports. The main unit card is created
by default.

Deleting Network Element Records

To delete a record from the Network Elements section
1 Query a network element record.
See Querying a Network Element on page 287 for more information on
querying a network element record.
2 Use the scroll bar to select the record you want to delete.
3 Click the Type field in the Network Elements section.
4 Click the Delete button.
5 Click the Save button.
Note the following:
The following product features determine whether or not the user should be
allowed to delete a network element that has active alarms and/or alarm faults,
and determine whether or not alarms and alarm faults should be deleted when a
network element is deleted:
• IM:01051 - Determines whether or not a network element can be
moved or deleted if it has active alarms. ('Off' = network element
cannot be moved or deleted if it has active alarms; 'On' = network
element can be moved or deleted if it has active alarms. Default is
'Off').
• IM:01052 - Determines whether or not a network element can be
moved or deleted if it has alarm faults. ('Off' = network element
cannot be moved or deleted if it has alarm faults; 'On' = network
element can be moved or deleted if it has alarm faults. Default is
'Off').
• IM:01054 - Determines whether or not a network element's alarms
are deleted when a network element is deleted. ('On' = delete alarms;
'Off' = do not delete alarms. Default is 'Off').
• IM:01055 - Determines whether or not a network element's alarm
faults are deleted when a network element is deleted. ('On' = delete
alarm faults; 'Off' = do not delete alarm faults. Default is 'Off').

292
 NETWORK ELEMENTS
Deleting Network Element Records

Deleting Card/Slot Records

To delete a network element card slot record
1 Query a network element record.
See Querying a Network Element on page 287 for more information on
querying a network element record.
2 Use the scroll bar to select the record with the card slot you need to delete.
3 Click the Slot field in the Card Slots section.
4 Click the Delete button.
5 Click the Save button.

Deleting Port Records

To delete a Port record
1 Query a network element record.
See Querying a Network Element on page 287 for more information on
querying a network element record.
2 Use the scroll bar to select the record with the ports that you want to delete.
3 Select the record in the Parents Ports or Child Ports section that you want to
delete.
4 Click the Delete button.
5 Click the Save button.

Note
Child Ports are deleted with parent ports.

You cannot delete a parent port if either the parent or child port has a
circuit assigned.

You cannot delete ports if they are connected to a cable or unNamed

connection.

293
NETWORK ELEMENTS
Network Elements Feature Hierarchy

Network Elements Feature Hierarchy

A network can be configured such that a single network element acts as a server
providing various service features enabled on it to other equipment or network
elements. For example, the Intelligent Network platform.
The Server Equipment window that can be accessed from the Inventory >
Components > Network Elements Feature Hierarchy menu option allows
you to identify a particular NE which will act as the server and define the other
equipment that will consume feature capacity from this parent NE. This window is
currently used during service provisioning and facility reservation.

Figure 11–53. Server Equipment Window

The Server Equipment window has two sections:

• Server Equipment section - This is a query only section that allows
you to select, from the equipment set up in the database, the
equipment or network element that will be configured as the server
equipment. Using the SF button in this section, you will set up the
service features that this equipment will provide.
• Exchange Equipment section - In this section, you can select the
equipment that will consume the services from the server equipment.
Using the SF button in this section, you will select which features each
equipment will use from the server.

294
 NETWORK ELEMENTS
Network Elements Feature Hierarchy

Fields
The fields in the Server Equipment window are:

Field Description

Server/Exchange
Equipment

Location The location or site of the equipment.

Equipment Type The type of network element or equipment.

Index The network element/equipment index.

In Service The date on which the network element will be placed in

service.

Status The equipment status.

Manufacturer The manufacturer of the equipment.

Customer The customer name associated with the location details.

Exchange Code The code of the exchange that will provide the requested
service.

Pri The order of allocation and presentation of the

consuming NEs.

Table 11–57. Server Equipment window; fields

Buttons
The button in the Server Equipment window is:

Button Description

SF Click to open the Service Features window and set up the service
features that are or can be supported on the corresponding network
element.

Table 11–58. Server Equipment window; button

295
NETWORK ELEMENTS
Network Elements Feature Hierarchy

To set up the network elements feature hierarchy

1 From the Inventory > Components menu, click on Network Elements
Feature Hierarchy. The Server Equipment window is displayed.
2 Under the Server Equipment section, query the network element that will be
configured as the server equipment.
3 Click on the SF (Service Features) button to open the Service Features
window.

Figure 11–54. Service Features window for the Server Equipment

4 Using the LOV button in the Feature Name field, select all the service
features that you want to enable on the server equipment. Enter the following
information:
i. In the Total field, enter a numeric value to define the total capacity of
the server equipment to support this feature.
ii. In the Percentage to Allocate field, enter the percentage that will
actually be available for consumption by the other equipment.
iii. The Used field indicates the capacity that is being used for service. The
default value is 0 when a new feature is added. This field is
automatically updated when the features are used or reserved for
service by the Provisioning or Reserve Facility functionality.
iv. The Category field will display Server by default.
Save your record and exit the window.

296
 NETWORK ELEMENTS
Network Elements Feature Hierarchy

5 Under the Exchange Equipment section, use the LOV button in the
Location field to select the network elements that will consume the capacity
from the server equipment.
6 Use the LOV button to select the Type and Index. The remaining fields will
be automatically populated.
7 Click on the SF button for each network element. The Service Feature
window for the exchange equipment will be displayed.

Figure 11–55. Service Features window for the Exchange Equipment

8 Use the LOV button in the Feature Name field to select the service features
that the corresponding equipment will use from the server. The list of values
will depend on the service features enabled on the server equipment. All the
other fields will be populated automatically.
– The Total field indicates the total capacity that is available for use by all
the exchange equipment. For example, for a particular feature the total
capacity available on the server equipment is 50 out of which 40% is
available for use to the other equipment. This means that the total
capacity available for consumption by the exchange equipment will be
40% of 50, i.e., 20.
– The Allocated Capacity field indicates how much of the total capacity
this exchange equipment will use. For example, out of the total capacity
of 20, you can allocate 10 to a particular exchange equipment and 6 to
another. The default value will be the capacity available for use. This
field will be automatically updated as and when you define how much
each equipment should actually use and distribute the capacity. For
example, out of the total capacity of 20, if you have allocated 10 to one

297
NETWORK ELEMENTS
Network Elements Feature Hierarchy

equipment, then only 10 will be available for allocation to the other

equipment.
– The Used field indicates how much of the capacity has already been
used for service. The default is 0. This field gets automatically updated
as and when the features are used (by the Service Provisioning and
Reserve Facility functionalities) to provide service to the customers.
9 Save your record.

298
 CHAPTER 12

Frames

Use the Frames window to set up the physical frame equipment used to connect
elements in a telecommunications network.

299
FRAMES
Frames Window

Frames Window
Use the Frames window to set up the physical infrastructure that connects
elements in a telecommunication network. Each frame must reside at a location
that is specified in the Clarity system.
A frame consists of one container that is configured with frame units and frame
appearances which represent the actual physical connection points (either
electrical or optical).
Before you can create records in this window, values must be entered in the
following windows:
• Locations
See Locations Window on page 498 for more information about this window.
• Frame Container Types
See Frame Container Types on page 559 for more information about this
window.
• Frame Unit Product Types
See Frame Unit Product Types on page 562 for more information about this
window.
• Frame Unit Templates
See Frame Unit Templates on page 429 for more information about this
window.

300
 FRAMES
Frames Window

To open the Frames window

• From the Inventory menu, point to Components, and then click
Frames.
The Frames window is displayed.

Figure 12–1. Frames window

301
FRAMES
Frames Window

Fields
The fields in the Frames window are:

Field Description

Frame Containers

Location The location of the frame container. Use LOV to select a

value (Mandatory.
Double-click on this field to launch the window and view
the location details.

Type The frame container type. Use LOV to select a value.

(Mandatory)
Values for this field are set up in the Frame Container
Types reference window. See Frame Container Types on
page 559 for more information about this window.

Index Automatically populated with the instance of the frame

container type at the selected location.
For example, there may be two instances of a DDF frame
container at location A1. If you were to create another
instance, at the same location, this field would be auto-
populated with an index value of 003.

Table 12–1. Frames window; fields (sheet 1 of 8)

302
 FRAMES
Frames Window

Field Description

Status Defines the status of the container. Use the drop-down

list to select a value, e.g. Spare, Active, Bad Pin, Blocked.
(Mandatory. Note the following:
• The status of a frame container can transition to the
Blocked status only from an Active status.
• When a Frame Container’s status is changed to
Blocked, the status of the Frame Units and Frame
Appearances also changes to Blocked.
• The status of all the impacted objects will revert to its
previous value when the status of the Frame
Container is reverted from Blocked to In Service. For
example if a Frame Appearance had a status of "BAD
PIN", and the Frame Container status is changed to
Blocked, then the Frame Appearance will also be
blocked. When the user reverts the Frame Container
status from Blocked to In Service, then the Frame
Appearance status will be reverted to "BAD PIN".
• Reserve Facility will not select any frame appearances
for reservation that have a status of Blocked.
• Manual Circuit Design will not use frames that are
blocked. Any existing circuits using the facilities will
not be modified. New circuits (manual or reserved
facility) will not be able to use the blocked facilities.

Container Defines whether the container is a frame or a rack. Use

the drop-down list to select a value. (Mandatory)

Floor A free text field to specify the building floor number.

Floor Location A free text field to define the position of the rack on the
floor

Table 12–1. Frames window; fields (sheet 2 of 8)

303
FRAMES
Frames Window

Field Description

Service Type Displays the highest priority Service Type Template or

Template Service Type linked to the Frame Container. Double-
clicking on this field will bring up the Frame Container
Service Type Templates pop-up window (see Frame
Container Service Type Templates on page 313 for
further information). This window contains the Service
Templates tab and the Service Types tabbed region.
Only that tabbed region will be displayed that contains
linked data, i.e., if a Service Type Template is associated
to the Frame Container, the Service Templates tab will
be displayed and if Service Types are linked to the Frame
Container, the Service Types tab displaying that data set
will be in focus.
This window is used to add, delete, or update service
type templates or service types for a frame container. It
can also be invoked by clicking on the Manage Service
Type Details button in the Frame Containers Tool
Palette.

Description Automatically populated with a concatenation of the

location, the frame container type and the index when
the record is saved.

unnamed Planned event indicator. (Read-only)

If a frame container or one or more of its frame
appearances are associated with a planned event, the
planned event indicator displays (in red) the text PEs.
If a frame container and none of its frame appearances
are associated with a planned event, the planned event
indicator displays (in green) the text No PEs.
Note: If the planned event indicator is red, double-
clicking it invokes the Planned Events window
which displays the numbers of planned events with
which frame is associated.

Table 12–1. Frames window; fields (sheet 3 of 8)

304
 FRAMES
Frames Window

Field Description

Utilisation Displays the total number of allocated active frame

appearances on all frame units, displayed as a
percentage. The bar graph is displayed in different
colors depending on the utilisation. The defaults are
specified as follows:
Blue: 0% - 19%
Green: 20% - 39%
Yellow: 40% - 59%
Orange: 60% - 79%
Red: 80% - 100%.
The statuses used in the Utilisation calculations appear
next to the Utilisation field as an abbreviation, e.g.
PADBL stands for Planned, Active, InActive, Bad Port and
Locked.

Total The total number of Frame Containers for all frame

units.

Faulty The total number of faults with the status ‘Bad Pin for all
frame units on container.s

Available Total with status as ‘ACTIVE’ and not in the circuit for all
frame units on container.

Frame Units

Name A free text field to uniquely identify the frame unit.

Note: This field will not accept spaces in the name.

Position The unit position in the frame or rack.

Product Name The frame unit product type.

Cable Distance (m) The actual length of cable including cable slack length
between two items of inventory. This distance is
measured in meters.

Direction The direction of the frame unit. Select In or Out from the
drop-down list.

Table 12–1. Frames window; fields (sheet 4 of 8)

305
FRAMES
Frames Window

Field Description

Status The status of the frame unit. Use the drop-down list to
select one of the following:
• Spare
• Planned
• Active
• In Active
• Bad Pin.

Usage This value is used by the Facility Reservation program.

The default value is standard. If the value specified is
terminate, the Facility Reservation program when
creating a customer service will save all the reservations
it has made up until that frame unit name is encountered
and exit.

Termination Type The termination type of the frame unit.

Manufacturer The manufacturer of the frame unit. Use LOV to select a

value.

Alternate Name Alternate name of the frame unit.

Zone Name The zone name of the frame unit.

Description A free text field to further describe the frame unit.

Table 12–1. Frames window; fields (sheet 5 of 8)

306
 FRAMES
Frames Window

Field Description

Service Type Displays the highest priority Service Type Template or

Template Service Type associated with the selected Frame Unit.
Double-clicking on this field will bring up the Frame
Unit Service Type Templates pop-up window that will
display either the list of service templates or service types
depending on the data associated with the Frame Unit
(see Frame Unit Service Type Templates on page 316 for
further information). The user can also add, delete, or
update the service template or service type association
using this window.
Note that only those service templates or service types
can be associated with the Frame Unit that have been
defined at the Frame Container level. However, a
particular service template or service type need not have
the same priority at the Frame Unit level as it has at the
Frame Container level. For example, a service template
of type ASDL can be assigned priority1 at the Frame
Container level, and a priority 2 at the Frame Unit level.
The Service Type Template field in the Frame Units
section will display the service template or service type
that has been assigned the highest priority for that
selected Frame Unit.
The Frame Unit Service Type Templates window can
also be invoked by clicking on the Manage Service
Type Details button in the Frame Units Tool Palette.

Radial Distance (m) The straight line distance between two items of inventory.
This distance is measured in meters.

Appearances

Total The total number of Frame Appearances for the unit.

Faulty The total number of faults with the status ‘Bad Pin’.

Available Total with status as ‘ACTIVE’ and not in the circuit.

Frame Appearances

Position The position in the unit.

Table 12–1. Frames window; fields (sheet 6 of 8)

307
FRAMES
Frames Window

Field Description

Side Indicates whether the appearance is at the Front or Rear

of the frame. Use the drop-down list to select the side.

Status The status of the frame appearance. Use the drop-down

list to select one of the following:
• Spare
• Planned
• Active
• In Active
• Bad Pin
• In Use
• Locked.

Usage The usage at the specified position. Use the drop-down

list to select one of the following:
• Voice
• Data
• Wideband.

Details Any other details relating to Frame Appearance.

Service Type Displays the highest priority Service Type Template or

Template Service Type associated with the selected Frame
Appearance. Double-clicking on this field will bring up
the Frame Appearance Service Type Templates pop-
up window that will display either the list of service
templates or service types depending on the data
associated with the frame (see Frame Appearance
Service Type Templates on page 319 for more
information). The user can also add, delete, or update
service templates or service types using this window.
Note that only those service templates or service types
can be associated with the Frame Appearance that have
been defined at the Frame Unit level. However, a
particular service template or service type need not have
the same priority at the Frame Appearance level as it has
at the Frame Unit level. The Service Type Template field
in the Port Details section will always display the service
template or service type that has been assigned the
highest priority for the selected Frame Appearance.

Table 12–1. Frames window; fields (sheet 7 of 8)

308
 FRAMES
Frames Window

Field Description

Unnamed Indicates whether the frame appearance is part of an

Connection unnamed connection.
• Y = Yes
• N = No

Drop Wire Indicates if an address id exists for the last mile. If

address exists, it means that the address is wired (last
mile exists). This field is visible only if Product Feature
IM:01046 is enabled or turned on. Valid values are:
N = No address id
Y = Address exists.
Double-click on this field to launch the Dropwire Address
window which offers the following functionality:
• Displays the service address associated with a frame
appearance
• Allows the user to modify the service address
associated with the frame appearance
• Allows the user to delete the service address thus
deleting the dropwire
• If no address exists, allows the user to select a service
address thus adding a dropwire between the service
address and frame appearance

Circuit Reservation tab

Name The name of the circuit reserving the frame appearance.

Non-active circuits will be displayed only when product
feature IM:01008 is enabled.

Status The status of the circuit.

Cable Reservation tab

Name The name of the cable sheath reserving the frame

appearance.

Core The core of the cable connected to the port.

Cable Status The status of the cable, e.g.Inservice, Planned, etc.

Table 12–1. Frames window; fields (sheet 8 of 8)

309
FRAMES
Frames Window

Buttons
The following buttons are available on the Frames window:
• Frames Containers Tool Palette
• Frame Units Tool Palette.

Frame Containers Tool Palette

The Frame Containers section Tool Palette button displays a list of the functions
available from the Frames window.
The table below describes each option.

Option Description

Assets and Opens the Assets And Dimensions window. See

Dimensions View/Modify Network Element Asset or Dimension
details on page 216 for more information about defining
assets and dimensions.

Attach and View Opens the File Attachments window.

Files Use this window to attach associated files, such as
documents and spreadsheets to the frame container record.
See Getting Started with Clarity OSS for more information
on creating and deleting links to external files.

Bulk Update Opens the Bulk Update Service Type Details window.
Service Types Use this window to specify a frame unit range and bulk-
update them with a chosen service type template.

Copy Frame Opens the Copy Frame Container window.

Container Use this window to copy the details of an existing frame
container record to help in creating a new frame container
record.

Costed Items Opens the Costed Item List window.

Use this window to record the costs associated with the
frame container. Costed items are set up in the Costed
Items reference window. Refer to the Clarity Provisioning
Suite Reference for more information.

Table 12–2. Frame Containers Tool Palette options (sheet 1 of 2)

310
 FRAMES
Frames Window

Option Description

Frame Opens the Frame Container Parameters window.

Container Use this window to associate parameters with a frame
Parameters container. The Load Parameters button in this form allows
users to select a Frame Container Parameter template that
automatically assigns a set of frame container parameters
to the frame record.

Manage Service Opens the Frame Container Service Type Template

Type Details window. This window is used to add, delete, or modify the
service type template/service types association for the
selected Frame Container record.
The business rules that apply to the Service Types
Template window for a network element record, apply to
the Frame Container record as well. For more information,
see Manage Service Type Details on page 244.

Table 12–2. Frame Containers Tool Palette options (sheet 2 of 2)

Frame Units Tool Palette

This Tool Palette button displays a list of the functions available from the Frame
Units section of the Frames window.
The table below describes each option.

Option Description

Alternate Names Opens the Alternate Frame Unit Names window.

Use this window to add, modify or delete alternative names
for the selected frame unit.

Assets and Opens the Assets And Dimensions window. See

Dimensions View/Modify Network Element Asset or Dimension
details on page 216 for more information about defining
assets and dimensions.

Copy Frame Opens the Copy Frame Unit window.

Unit Use this window to copy the details of an existing frame unit
record to help in creating a new frame unit record.

Table 12–3. Frame Units Tool Palette options (sheet 1 of 2)

311
FRAMES
Frames Window

Option Description

Delete Frame Click on Yes to confirm the deletion all the frame
Appearances appearances belonging to the selected frame unit.

Lock/Unlock Opens the Lock/Unlock Frame Appearances window.

Appearances Use this window to lock or unlock the selected frame unit’s
frame appearances.

Manage Service This window displays the service type templates or service
Type Details types associated with the Frame Unit, if any, and also allows
the user to add, delete, and update records.
The business rules that apply to the Service Types
Template window for a card, apply to the Frame Unit
record as well. For more information, see Manage Service
Type Details (for cards) on page 271.

Table 12–3. Frame Units Tool Palette options (sheet 2 of 2)

312
 FRAMES
Frame Container Service Type Templates

Frame Container Service Type Templates

Use the Frame Container Service Type Templates window to add, delete, or
modify the service type template/service types association for the selected frame
container record.
To open the Frame Container Service Type Templates window
1 Open the Frame window (see To open the Frames window on page 301).
2 Query a Frame Container.
3 Either:
– Double click in the Service Type Template field.
OR
– Click on the Manage Service Type Details button in the Tool Palette.
The Frame Container Service Type Templates window displays.
If service types have been associated with the frame container, this window will be
displayed with the Service Types tab in focus see Figure 12–2 on page 313.

Figure 12–2. Frame Container Service Type Templates- Service Templates tab

313
FRAMES
Frame Container Service Type Templates

Fields

Field Description

Name The service type template associated with the frame

container.

Description Service Type description.

Priority The order of selection priority when choosing a frame

container to support or supply the service.

Table 12–4. Frame Container Service Type Templates window; Service Templates tab; Fields

If service templates are applied to the frame container, this window will be
displayed with the Service Templates tab in focus. See figure below.

Figure 12–3. Frame Container Service Type Templates window; Service Types tab

314
 FRAMES
Frame Container Service Type Templates

Fields

Field Description

Type The service type supported on the frame container, for

example PSTN.

Description Service Type description.

Priority The order of selection priority when choosing a frame

container to support or supply the service.

Table 12–5. Frame Container Service Type Templates window; Service Types tab; Fields

The following business rules apply in the Service Type Templates pop-up window
when querying or managing service types that can be supported on the frame
container:
• When viewing Service Type Templates associated with a frame
container, the user can add a new template, delete or update an
associated template. New templates are available for selection from
the LOV in the Name field. Optionally, to update an existing record by
replacing it with a new template, the user must select the record and
type in the first few characters of the new template name and press the
Tab or Enter function key. The existing record will be replaced with the
new record which will inherit the priority from the replaced record.

Note
The user can update or delete an existing record only if it has not been
associated with any child object.

• If individual service types are associated with the frame container

record, the user can either delete the current service types, or add new
service types. For a frame unit or frame appearance, only service types
that are supported by the parent entity are available for selection. At
the parent level, any service type can be linked.
• The user cannot link both a service template definition and a set of
services types against the same object. One or the other is allowed but
not both at the same time. If there are no service types associated with
the frame container, and the user attempts to create a Service Types
definition via the Service Types tab, a message will be displayed
prompting the user to either select an existing service type template or
define a new service type template and associate that with the frame
container record rather than defining individual Service Types. The

315
FRAMES
Frame Container Service Type Templates

user can, however, ignore the message and associate independent

service types to the frame container.
• Copying a Frame Container (frame unit, frame appearance) should
result in the templates or service types that are currently defined being
copied to the new instance.
• Multiple service type templates can be associated at the frame
containers or frame unit level, however, only one service type template
can be associated at the frame appearance level.

Note
The same business rules will apply to the Service Type Template field in the
Frame Unit and Frame Appearance region of the Frames window.

For information on Service Type Templates, see Service Types Template on page
461.

Frame Unit Service Type Templates

Use the Frame Units Template Service Type Templates window to display the
service type templates or service types associated with the frame unit, if any, and
also allows the user to add, delete, and update records.
To open the Frame Unit Template Service Type Templates window
1 Open the Frames window (see To open the Frames window on page 301).
2 Query a Frame Unit in the Frame Units section.
3 Either:
– Double click in the Service Type Template field.
OR
– Click on the Manage Service Type Details button on the Tool Palette.
The Frame Unit Template Service Type Templates window displays.
If service templates are applied to the card, this window will be displayed with the
Service Templates tab in focus. See figure below.

316
 FRAMES
Frame Container Service Type Templates

Figure 12–4. Frame Unit Template Service Type Templates window; Service Templates tab

Fields

Field Description

Name The service type template associated with the frame unit.

Description Service Type description.

Priority The order of selection priority when choosing a frame

unit to support or supply the service.

Table 12–6. Frame Container Service Type Templates window; Service Templates tab; Fields

If service types have been associated with the card, this window will be displayed
with the Service Types tab in focus. See figure below.

317
FRAMES
Frame Container Service Type Templates

Figure 12–5. Frame Unit Template Service Type Templates window; Service Types tab

Fields

Field Description

Type The service type supported on the frame unit, for

example PSTN.

Description Service Type description.

Priority The order of selection priority when choosing a frame

unit to support or supply the service.

Table 12–7. Frame Container Service Type Templates window; Service Types tab; Fields

Note
The service type templates or service types that are available for selection
when adding or updating (replacing the current record with a new one)
are derived from the service templates or service types associated at the
parent level, i.e., with the frame unit. It must also be noted that the user
cannot delete an existing service template or service type if it is associated
with any of the frame appearances within that frame unit. For information

318
 FRAMES
Frame Container Service Type Templates

on the business rules that apply, see Manage Service Type Details (for
Frame Containers). The business rules that apply to this window at the
Frame Container level, apply at the Frame Unit level too.

Frame Appearance Service Type Templates

Use the Frame Appearance Service Type Templates window to assign a Service
Template or a Service Type with the frame appearance.
To open the Frame Appearance Service Type Templates window
1 Open the Frames window (see To open the Frames window on page 301).
2 Query a Frame Appearance in the Frame Appearance section.
3 Either:
– Double click in the Service Type Template field.
OR
– Click on the Manage Service Type Details button on the Tool Palette.
The Frame Appearance Service Type Templates window displays.

Figure 12–6. Frame Appearance Service Type Templates window; Service Templates tab

319
FRAMES
Frame Container Service Type Templates

Fields

Field Description

Name The service type template associated with the frame

appearance.

Description Service Template description.

Priority The order of selection priority when choosing a frame

appearance to support or supply the service.

Table 12–8. Frame Appearance Service Type Templates window; Service Templates tab;
fields

If service types have been associated with the frame appearance, this window will
be displayed with the Service Types tab in focus. See figure below.

Figure 12–7. Frame Appearance Service Type Templates window; Service Types tab

320
 FRAMES
Frame Container Service Type Templates

Fields

Field Description

Type The service type supported on the frame appearance, for

example PSTN.

Description Service Template description.

Priority The order of selection priority when choosing a frame

appearance to support or supply the service.

Table 12–9. Frame Appearance Service Type Templates window; Service Templates tab;
fields

Note
• The service type templates or service types that are available for
selection when adding or updating (replacing the current record with a
new one) are derived from the service templates or service types
associated at the parent level, i.e., with the frame appearance.
• It must also be noted that the user cannot delete an existing service
template or service type if it is associated with any of the frame
appearances within that frame unit. For information on the business
rules that apply, see Manage Service Type Details (for Frame
Containers). The business rules that apply to this window at the Frame
Container level, apply at the Frame Appearance level too.
• While multiple service type templates can be assigned to the frame
container or frame unit, only one service type template can be
associated with the frame appearance.
• Also, when defining a Frame Appearance Template to create ports,
only one service type template can be associated with the frame
appearance template.

321
FRAMES
Features of the Frames Window

Features of the Frames Window

The features of the Frames Window are:

Feature See…

Opening the Frames window page 300

Creating frame records page 323

Creating additional frame unit records page 323

Querying records in the Frames page 325

window

322
 FRAMES
Creating Frame Records

Creating Frame Records

The following records are created in the Frames window:
• Frame containers
• Frame units
• Frame appearances
The relationship between these entities is as follows:
• One frame container can have many frame units.
• The configuration of frame appearances for a frame unit is defined in
the Frame Unit Templates reference window. See Frame Unit
Templates on page 429 for more information.
• The number of frame appearances for a frame unit is defined in the
Frame Unit Product Types reference window. See Frame Unit Product
Types on page 562 for more information.

Creating Frame Containers

To create frame container records
1 Open the Frames window
See Frames Window on page 300 for more information.
2 Enter the mandatory fields in the Frame Containers section
3 Click the Save button.
4 Enter the mandatory fields in the Frame Units section.
5 Click the Save button.

Note
Frame Appearances may be entered manually if the product selected at
the frame unit level has no associated frame unit template.

Creating Additional Frame Units

Additional frame units can be created for a frame container.
To create additional frame units
1 Display the required Frame Container.
See Querying Records in the Frames Window on page 325 for more
information.
2 Click in the Name field in the Frame Units section, and then click the Insert
button.
The Frame Units and Frame Appearances section are cleared.

323
FRAMES
Creating Frame Records

3 Enter the Frame Unit information then click the Save button.
The Frame Appearances section is automatically populated if a Frame Unit
Template is selected.

324
 FRAMES
Querying Records in the Frames Window

Querying Records in the Frames Window

You can query the following types of records in the Frames window:
• Frame container records
• Frame unit records
• Frame appearance records.

Querying Frame Container Records

The following procedure describes how to query the Frames window to display
frame container records.
To query frame container records
1 Open the Frames window
See Frames Window on page 300 for more information.
2 Click the Query button.
This places the window in query mode.
3 Enter your search criteria in the appropriate fields in the Frame Containers
section.
Use the% character as a wildcard. For example, entering SM% would display
all records that start with SM. Double-clicking the query button without
entering any search criteria will display all records.
4 Click the Query button again.
All matching records are displayed.
5 Use the scroll bar to view all of the matching records.
6 Use the Exit button to cancel query mode.

Hint
Read the Hint text on the Status Bar to determine if you are in query mode.

Querying Frame Unit Records

The following procedure describes how to query the Frames window to display
frame unit records.

Note
You must display the parent frame container record before you can query
the Frame Units section.

To query frame unit records

1 Display the parent frame container record
See Querying Frame Container Records on page 325 for more information.

325
FRAMES
Querying Records in the Frames Window

2 In the Frame Units section, click in the Name field.

3 Click the Query button.
This places this section of the window in query mode.
4 Enter your search criteria in the appropriate fields in the Frame Units
section.
Use the% character as a wildcard. For example, entering SM% would display
all records that start with SM. Double-clicking the query button without
entering any search criteria will display all records.
5 Click the Query button again.
All matching records are displayed.
6 Use the scroll bar to view all of the matching records.
7 Use the Exit button to cancel query mode.

Querying Frame Appearance Records

The following procedure describes how to query the Frames window to display
frame appearance records.

Note
You must display the parent frame container and frame unit records
before you can query the Frame Appearance section.

To query frame appearance records

1 Display the parent frame unit record
See Querying Frame Unit Records on page 325 for more information.
2 In the Frame Appearances section, click in the Position field.
3 Click the Query button.
This places this section of the window in query mode.
4 Enter your search criteria in the appropriate fields in the Frame
Appearances section.
Use the% character as a wildcard. For example, entering SM% would display
all records that start with SM. Double-clicking the query button without
entering any search criteria will display all records.
5 Click the Query button again.
All matching records are displayed.
6 Use the scroll bar to view all of the matching records.
7 Use the Exit button to cancel query mode.

326
 CHAPTER 13

Cables

This section describes how to use the Cables window to define the cable core
terminations for a cable between specified locations.

327
CABLES
Cables Window

Cables Window
Use this window to define cable sheath details and to record the cable core
terminations for a cable between specified locations.
To open the Cables window
• From the Inventory menu, point to Components, and then click
Cables.
The Cables window is displayed.

Figure 13–1. Cable Editing window

The Cables window has the following sections:

Section See…

Cable Sheath Details tab page 329

Cable Core Terminations page 333

Terminations tab page 336

328
 CABLES
Cables Window

Cable Sheath Details Tab

Use this tab to provide details about the cable sheath.

Figure 13–2. Cable Sheath Details tab

The fields in the Cable Sheath Details tab are:

Field Description

Name Free text field to provide a name for the cable sheath.
(Mandatory)

Type The cable sheath type. Cable sheath types help identify
the purpose of a cable sheath. For example, you may
define several cable sheath types based on the function
of cable sheath, such as a main cable sheath, or a
spur cable sheath. Use LOV to select a value.
(Mandatory)
These values are set up in the Cable Sheath Types
reference window. See Cable Sheath Types on page
542 for more information.

Location A The A-end location of the cable sheath.

Location B The B-end location of the cable sheath.

This field is optional if the intention is to terminate the
cable at multiple locations.

Table 13–1. Cable Sheath Details tab; fields (sheet 1 of 3)

329
CABLES
Cables Window

Field Description

Status The current status of the cable sheath. Use the drop-
down list to select one of the following values:
• Spare
• Planned
• Commissioned
• In Service
• Out of Service
• Working
• Locked
• Faulty
Note:
When a Cable Sheath has Cable Cores defined under
it and the user attempts to update the status of the
Cable Sheath and save the changes, a message will be
displayed asking the user to confirm if the status of the
cable cores should also be changed to match the new
status of the cable sheath. If the user selects Yes, the
status of the associated cable cores will be changed to
reflect the same status as the cable sheath. If the user
selects No, the cable core status will remain the same.

Product Type The cable sheath product type. Cable sheath product
types identify the characteristics of the cable sheath.
For example it defines the number of fibers and tubes
contained in the sheath. The available terminations for
the cable sheath are then displayed in the
Terminations section of the window. Use LOV to
select a value.
These values are set up in the Cable Sheath Product
Types reference window. See Cable Sheath Product
Types on page 540 for more information.
Note: If a product type is not defined for the cable, use
the Start Core and End Core fields to define the
core sequencing.

Alternate Name The alternate name of the cable sheath.

Measured Length The length of the cable.

Comments Free text field to record comments about the cable

sheath.

Table 13–1. Cable Sheath Details tab; fields (sheet 2 of 3)

330
 CABLES
Cables Window

Field Description

Start Core and End Use these fields to define the sequencing of cores
Core within a cable sheath, e.g. the sheath may use 15
cores starting from 40 and ending at 55.
This is usually used for cables with a large numbers of
pairs, e.g. copper cables, which come in a wide variety
of sizes as opposed to fibre cables where the core
numbers are small.
Note: These fields are used instead of selecting a
product type. When the product type is selected,
these fields are automatically populated and
cannot be changed.

Total Cores The total number of cores.

unnamed Planned event indicator. (Read-only)

If a cable sheath is associated with a planned event,
the planned event indicator shall display (in red) the
text PEs. If the cable sheath is not associated with a
planned event, the planned event indicator shall
display (in green) the text No PEs .
Note: If the planned event indicator is red, double-
clicking it invokes the Planned Events window
which displays the numbers of the planned
events with which the cable sheath is associated.

Computed dB Loss Calculated dB loss between locations A and B.

Cable Core Summary

Proposed Cable cores with the status of planned or spare.

In Service Cable cores with the status of Commissioned or In

Service.

Working Cable cores with the status of Working.

Out of Service Cable cores with the status of Out of Service, Locked or
Faulty.

Table 13–1. Cable Sheath Details tab; fields (sheet 3 of 3)

331
CABLES
Cables Window

Buttons
The following buttons are available from the Tool Palette in the Cable Sheath
Details tab of the Cable Editing window.

Button Description

Alternate Names Opens the Alternate Cable Sheath Names window.

Use this window to add, modify or delete alternative names
for the selected circuit. See Inserting Alternate Name
Records on page 127 for more information.

Attach Files Opens the File Attachments window.

Use this window to attach associated files, such as
documents and spreadsheets to the circuit record. See
Getting Started with Clarity OSS for more information on
creating and deleting links to external files.

Cable Sheath Open the Cable Sheath Attributes window. The window
Attributes displays attributes for the cable sheath.

Costed Items Open the Costed Item Lists window.

Use this window to record the costs associated with the
circuit. Costed items are set up in the Costed Items
reference window. Refer to the chapter on setting up
reference data in the Clarity Provisioning Suite User Manual
for more information.

Table 13–2. Tool Palette options

332
 CABLES
Cables Window

Cable Core Terminations Section

Use the Cable Core Terminations section to view the termination information
for the A-end and B-end locations. The fields are automatically populated when a
termination or disconnection occurs in the Terminations tab.

Hint
To edit a particular termination, double-click the Location A or Location B
field. The connection details are displayed in the Terminations tab.

Figure 13–3. Cable Core Terminations section

333
CABLES
Cables Window

The fields in the Cable Core Terminations section are:

Field Description

Number The cable core numbers.

Type Indicates whether the cable has terminated on a

network element or a frame.

Location A The details of the frame or network element that the

cable has terminated on at the A-end location. These
details are specified in the Cable Sheath Details
section.

Type Indicates whether the cable has terminated on a

network element or a frame.

Location B The details of the frame or network element that the

cable has terminated on at the B-end location. These
details are specified in the Cable Sheath Details
section.

Measured Length Length of the cable cores selected for termination. By

default, the field will be populated with the value of the
cable sheath measured length entered at the time of
cable creation. However, if the user has specified an
alternate measured length for the group of cores being
terminated when creating the terminations in the
Terminations tabbed page, this value will replace the
default value.
Note: as the result of termination and un-termination
some cores in a bundle of cores may end up having
different lengths.In such a scenario, the Measured
Length column in the Cable Core Terminations section
will be highlighted in red to inform the user that a
bundle of cores has cores with different lengths. The
user can then double-click on the red field. A popuup
screen will appear displaying the different lengths of
the cable cores (for example a bundle of 500 cores
may have 3 different lengths 500, 800, 1000). User
can then select one of the lengths and apply that
length to all cable cores in that bundle.

Table 13–3. Cable Core Terminations section; fields

334
 CABLES
Cables Window

Note
Double-click on the Type field to launch the Frames window or the
Network Elements window in context of the value displayed in the Type
and Location fields. That is, if the cable core terminates on a frame, the
Type field will display the value Frame; the Location field will be
populated with the identifier of the frame container, frame unit, and frame
appearance; and when you double-click on the Type field, the Frames
window will be launched displaying the details of the corresponding
frame record. Similarly, if the cable core terminates on a network element,
the Type field will display the value NE; the Location field will be
populated with the Network Element details and the Card Slots and Port
identifier. Double-click on the Type field to launch the Network
Elements window displaying the details of the corresponding NE record.

Button
The Cable Core Status button displays the Cable Core Status window from the
Cable Editing window.

Figure 13–4. Cable Core Status window

The fields in the Cable Core Status window are:

Field Description

Number The cable core number.

Cable Core The status of the cable core. Use the drop-down list to select
Status a value, e.g. Spare, Planned, Commissioned, In Service,
Working, Out of Service, Locked and Faulty.

Table 13–4. Cable Core Status window; fields

335
CABLES
Cables Window

Terminations Tab
Use the Terminations tab to define the terminations of cable sheath cores on
frame and network element positions at the defined location end points.
The Frame and NE tab fields are the same for the A location (left side of window)
and the B location (right side of window).

Figure 13–5. Terminations tab

The fields in the Terminations tab are:

Field Description

Frame tab

Type The type of frame that the cable will terminate on at the
location selected in the Cable Sheath Details section.
Use LOV to select a value. (Mandatory)
The values available for selection are limited to the
frames that reside at the selected A or B location. The
relationship between frame types and locations is
established in the Frames window. See Chapter 12,
Frames for more information.

Index The instance of the selected frame container type at the

selected location. Use LOV to select a value.
(Mandatory)
Instances of frame types are set up in the Frames
window. If only one instance is available, the field is
automatically populated with that value.

Table 13–5. Terminations tab; fields (sheet 1 of 3)

336
 CABLES
Cables Window

Field Description

Unit The frame unit in the selected frame container. Use

LOV to select a value. (Mandatory)
The values available for selection are limited to the
units defined for the selected Index.

Unit Position The position of the unit in the selected frame container.
(Mandatory)

Side Use drop-down list to indicate if the connection is at

the front or rear of the frame unit.

Start Position The starting termination position on the frame unit.

Use LOV to select a value. (Mandatory)
The LOV displays the valid frame appearances and will
indicate which positions are used and which are
unconnected.

NE tab

Type The type of network element that the cable will

terminate on at the location selected in the Cable
Sheath Details section. Use LOV to select a value
(Mandatory)
The values available for selection will be limited to the
network elements that reside at the selected A or B
location. The relationship between network element
types and locations is established in the Network
Elements window. See Chapter 11, Network Elements
for more information.

Index The instance of the selected network element type at

the selected location. Use LOV to select a value.
(Mandatory)
Instances of network types are set up in the Network
Elements window. If only one instance is available, the
field is automatically populated with that value.

Card Slot The card slot in the selected in the selected network
element. Use LOV to select a value. (Mandatory)

Start Port The starting termination port on the card. Use LOV to
select a value. (Mandatory)

Table 13–5. Terminations tab; fields (sheet 2 of 3)

337
CABLES
Cables Window

Field Description

Common section

Range (A and B end) The number of cores that are required for termination.

Start Core The core number where termination begins. Use LOV
(A and B end) to select a value. A list of valid cable cores is displayed.
This list indicates which cores are currently allocated
and which are available for connection.

Location A Automatically populated with the A location selected in

the Cable Sheath Details section.

Measured Length The length of the group of cable cores being

terminated. Optional field. If this field is null, the length
of the cable core will by default be the same as the
measured length of the cable sheath.

Cable Sheath Automatically populated with the cable name defined

in the Cable Sheath Details section.

Location B Automatically populated with the B location selected in

the Cable Sheath Details section.

Table 13–5. Terminations tab; fields (sheet 3 of 3)

The buttons in the Terminations tab are:

Field Description

Terminate Click this button to create a termination based on the

information in the Terminations section. When a
termination is created, the Cable Core Terminations
section is updated.

Unterminate Click this button to remove a termination based on the

information in the Terminations section. When a
termination is removed, the Cable Core
Terminations section is updated.

Table 13–6. Terminations tab; buttons

338
 CABLES
Features of the Cables window

Features of the Cables window

The features of the Cables window are:

Feature See...

Opening the window page 328

Creating a cable sheath record page 340

Creating cable sheath terminations page 340

Querying a cable edit record page 342

Deleting cable sheath terminations page 343

339
CABLES
Creating Cable Records

Creating Cable Records

Cable records consist of the cable sheath details and the corresponding
termination details at the A-end and B-end locations.

Creating Cable Sheath Details Records

The following procedures describes how to create a cable sheath record in the
Cables window.
To create a cable sheath details record
1 Open the Cables window.
See Cables Window on page 328 for more information.
2 Enter the information in the Cable Sheath Details tab.
See Cable Sheath Details Tab on page 329 for more information about
which fields are mandatory and the field definitions.
3 Click the Save button.

Creating Cable Sheath Terminations

The following procedures describes how to create terminations for a selected
cable sheath record.
To record cable sheath termination details
1 Display the required cable sheath record.
See Querying a Cable Sheath Record on page 342 for more information.
2 Click the Terminations tab.
3 If the cable core will be terminating on a frame, click the Frame tab. If the
cable core will be terminating on a network element, click the NE tab.
4 Enter the required information.
See Terminations Tab on page 336 for the definitions of the fields in this tab.
5 Click the Terminate button.
The Cable Core Terminations section is updated with the termination
information.
6 Click the Save button.

Hint
For multi-terminations, see Creating Cable Sheath Multiple Terminations
on page 341 for more information.

340
 CABLES
Creating Cable Records

Creating Cable Sheath Multiple Terminations

The following procedures describes how to create multiple terminations for a
selected cable sheath record.
Create multiple termination at Location B end
1 Display or add the required cable sheath record (leave Location B field
empty).
See Querying a Cable Sheath Record on page 342 for more information.
2 Click the Terminations tab.
3 Enter the required information for Location B, Start Core, and Range.
4 If the cable core will be terminating on a frame, enter the required
information in the Frame tab. If the cable core will be terminating on a
network element, enter the required information in the NE tab.
See Terminations Tab on page 336 for the definitions of the fields in this tab.
5 Click the Terminate button.
The Cable Core Terminations section is updated with the termination
information.
6 Click the Save button.

Hint
- Location “A” Side of the termination should not be populated.

- Select the entire range or a part of it, and start core of the already
terminated cable.

341
CABLES
Querying a Cable Sheath Record

Querying a Cable Sheath Record

The following procedures describes how to search for cable sheath records in the
Cables window.

Hint
Read the Hint text on the Status Bar to determine if you are in query mode.

To query a cable sheath record

1 Open the Cables window.
See Cables Window on page 328 for more information.
2 Click the Query button.
The window is now in query mode.
3 Enter your search criteria in the Cable Sheath Details section.
Use the% character as a wildcard. For example, entering SM% would display
all records that start with SM.
4 Click the Query button again.
Matching records are displayed.
5 Use the scroll bar to view all of the matching records.
6 Use the Exit button to cancel query mode.
7 To exit the window when in query mode click the Exit button twice.

Note
To display all records, click the Query button twice without entering
any search criteria.

342
 CABLES
Deleting Cable Sheath Terminations

Deleting Cable Sheath Terminations

The following procedures describes how to delete terminations for a selected
cable sheath record.
To delete cable sheath termination details
1 Display the required cable sheath record.
See Querying a Cable Sheath Record on page 342 for more information.
2 Click the Terminations tab.
3 In the Cable Core Terminations section, double-click the location that you
want to disconnect.
The information is displayed in the Terminations section.
4 Click the Unterminate button
The Cable Core Terminations section is updated.
5 Click the Save button.

343
CABLES
Deleting Cable Sheath Terminations

344
 CHAPTER 14

UnNamed Connections

This section describes how to use the UnNamed Connections window to define
pre-wired pre-installed network infrastructures such as LAN ports or a telephone
exchange.

345
UNNAMED CONNECTIONS
UnNamed Connections Window

UnNamed Connections Window

Use this window to trace or terminate the connections (both forward and reverse)
for a pre-cabled circuit provisioning from any point on the route. You can also use
this window to provide the cross connection details from a port to a circuit
provisioning end in the Circuit Design window.
To open the UnNamed Connections window
• From the Inventory menu, point to Components, and then click
UnNamed Connections.
The UnNamed Connections window is displayed.

Figure 14–1. UnNamed Connections window

The UnNamed Connections window has the following sections:

Section See…

Manage tab page 347

UnNamed Connections section page 348

Terminate tab page 350

346
 UNNAMED CONNECTIONS
UnNamed Connections Window

Manage tab
Use this tab to enter and modify UnNamed Connection information.

Figure 14–2. Manage tab in the UnNamed Connections window

Fields
The fields in the Manage tab of the UnNamed Connections window are:

Field Description

Element Location The location of the network element. Use LOV to select
a value.

Element Type The network element type. Use LOV to select a value.

Element Index The network element instance. Use LOV to select a

value.

Element Position The network element position. Use LOV to select a

value.

Trace Direction The direction of the connection trace. Use the drop-
down list to select either:
• Trace Forward
• Trace Backward.

Port Id This field is automatically populated with the port ID

when the Start Connection Trace button is clicked.

Phyc Id This field is automatically populated with physical ID

when the Start Connection Trace button is clicked.

Cace Id This field is automatically populated with cable core

end ID when the Start Connection Trace button is
clicked.

Table 14–1. Manage tab in UnNamed Connections window fields

347
UNNAMED CONNECTIONS
UnNamed Connections Window

Button
The button in the Manage tab of the UnNamed Connections window is:

Button Description

Start Connection Click this button to begin the cross connection trace.
Trace

Table 14–2. Manage tab in UnNamed Connections window fields

UnNamed Connections section

This section displays UnNamed Connection information for selected network
elements.

Figure 14–3. UnNamed connections section in the UnNamed Connections window

Fields
The fields in the UnNamed Connections section of the UnNamed Connections
window are:

Field Description

Xconnect Describes the cross connection to give meaning, e.g.

Jumper or Patch. Use LOV to select a cross connection
type.

From

Location Location of network element.

Table 14–3. UnNamed Connections section fields (sheet 1 of 2)

348
 UNNAMED CONNECTIONS
UnNamed Connections Window

Field Description

Type Type of network element.

Index Instance of network element.

[Card] Port Terminating card port name of the network element (1

or more).

UC This field displays the UnNamed Connection status, i.e.

<NC> = No Connection, <DC> = Different
Connection or <C> = Connected, when frame or
network element details have been queried in the
Terminate tab.

To

Location Location of network element.

Type Type of network element.

Index Instance of network element.

[Card] Port Terminating port name of the network element (1 or

more) and slot where the card is located.

Table 14–3. UnNamed Connections section fields (sheet 2 of 2)

349
UNNAMED CONNECTIONS
UnNamed Connections Window

Terminate Tab
Use the Terminate tab to query, create, or delete a range of UnNamed
Connections on frame and network element positions at the defined location end
points.

Figure 14–4. Terminate tab

Fields
The fields in the Terminate tab are:

Field Description

Frame tab

Location The location of the frame that the cable will terminate
on. Use LOV to select a value (Mandatory). The list of
values will retrieve only locations at which frame
containers reside.

Type The type of frame that the cable will terminate on at the
location selected in the Location field. Use LOV to
select a value (Mandatory)

Index The instance of the selected frame type at the selected

location. Use LOV to select a value. (Mandatory)

Table 14–4. Terminate tab in UnNamed Connections window fields (sheet 1 of 3)

350
 UNNAMED CONNECTIONS
UnNamed Connections Window

Field Description

Unit The frame unit. Use LOV to select a value. (Mandatory)

The values available for selection are limited to the
units defined for the selected Index.

Position The position of the frame unit is automatically

populated based on the selected Unit.

Side Use drop-down list to indicate if the connection is at

the front or rear of the frame unit.

Start Position The starting termination position on the frame unit.

Use LOV to select a value. (Mandatory)
The LOV displays the valid frame appearances and will
indicate which positions are used and which are
currently connected or unconnected.

Connection Range The range (number) of connections between the two

selected objects.

Network Element tab

Location The location of the network element that the cable will
terminate on. Use LOV to select a value (Mandatory).
The list of values will retrieve only locations at which
frame containers reside.

Type The type of network element that the cable will

terminate on at the location. Use LOV to select a value
(Mandatory)

Index The instance of the selected network element type at

the selected location. Use LOV to select a value.
(Mandatory)
Instances of network types are set up in the Network
Elements window. If only one instance is available, the
field is automatically populated with that value.

Card Slot The card slot in the selected in the selected network
element. Use LOV to select a value. (Mandatory)

Table 14–4. Terminate tab in UnNamed Connections window fields (sheet 2 of 3)

351
UNNAMED CONNECTIONS
UnNamed Connections Window

Field Description

Start Port The starting termination port on the card. Use LOV to
select a value. (Mandatory)

Table 14–4. Terminate tab in UnNamed Connections window fields (sheet 3 of 3)

Buttons
The buttons in the Terminate tab are:

Button Description

Query Records Click this button to display the selected frame or

network element information in the UnNamed
Connections section of the UnNamed Connections
window.

Terminate Click this button to create a termination (or range of

terminations) based on the information in the
Terminate tab.

Unterminate Click this button to remove a termination (or range of

terminations) based on the information in the
Terminate tab.

Table 14–5. Terminations tab; buttons

352
 UNNAMED CONNECTIONS
Features of the UnNamed Connections Window

Features of the UnNamed Connections Window

The features of the UnNamed Connections window are:

Feature See...

Opening the window page 346

Tracing an unnamed connection page 354

Terminating unnamed connections page 355

353
UNNAMED CONNECTIONS
Tracing an UnNamed Connection Record

Tracing an UnNamed Connection Record

The following procedures describes how to create a record in the UnNamed
Connections window.
When an unnamed connection is used in the Circuit Edit window, the cross
connections are copied to the Cross Connections section of the window.
To create an unnamed connections record
1 Open the UnNamed Connections window.
See UnNamed Connections Window on page 346 for more information.
2 Enter the trace information in the Connection Trace section of the Manage
tab.
See UnNamed Connections Window on page 346 for more information
about the fields in this section.
3 Click the Start Connection Trace button.
The UnNamed Connections section is populated.
4 Further define the connection details in this section.
5 Click the Save button.

354
 UNNAMED CONNECTIONS
Terminating UnNamed Connections

Terminating UnNamed Connections

The following procedures describes how to terminate UnNamed connections in
the UnNamed Connections window.
To terminate unnamed connections
1 Open the UnNamed Connections window.
See UnNamed Connections Window on page 346 for more information.
2 Enter the frame or network element information in the relevant tabs of the
Terminate tab.
See UnNamed Connections Window on page 346 for more information
about the fields in this section.
3 Enter the connection range (the number of connections between the selected
frames or elements).
4 Click the Terminate button. The new connections will be listed in the
UnNamed Connections section of the Terminate tab with the value of
<CO> in the UC field to indicate their connected status.
5 To unterminate (disconnect) unnamed connections that have been connected
using the Terminate button, repeat steps 1-3 and click the Unterminate
button.

355
UNNAMED CONNECTIONS
Terminating UnNamed Connections

356
 CHAPTER 15

Management Systems

Use the Management Systems window to maintain a list of valid network

element management systems (NEMS) configuration details. These details also
identify where alarms are collected from, the mediation device drivers that are
required to carry out provisioning and how collected alarm data should be
interpreted.

357
MANAGEMENT SYSTEMS
Management Systems Window

Management Systems Window

Use this window to query, create, modify and delete management system details.
To open the Management Systems window
• From the Inventory menu, point to Components, and then click
Management Systems.

Figure 15–1. Management System window

Fields
The fields in the Management Systems window are:

Field Description

Name Unique name of the NEMS. This field is automatically

populated with the information from the Class, Version
and Instance fields.
(Concatenated: class, version, instance).

Class Specific NEMS class.

Version Specific NEMS software version.

Instance Specific NEMS instance identifier.

Table 15–1. Management System window; fields (sheet 1 of 3)

358
 MANAGEMENT SYSTEMS
Management Systems Window

Field Description

IP Address Internet address of the NEMS.

Supplier Company name providing NEMS. Use LOV to select a

value.

Type Additional grouping attribute.

Locn Name Location of the NEMS. Use LOV to select a value.

MDD SOP (Class) Class of interface for Mediation Device Driver, Service
Order Provisioning. Use the drop-down menu to select
either:
• Internet Protocol
• NFS

MDD SOP Address for Mediation Device Driver, Service Order

(Address) Provisioning class.

MDD Alarm (Class) Class of interface for the Mediation Device Driver alarm.
Use the drop-down menu to select either:
• Internet Protocol
• NFS

MDD Alarm Address for Mediation Device Driver alarm class.

(Address)

SOP (Class) Class of interface for Service Order Provisioning class.

Use the drop-down menu to select either:
• Internet Protocol
• NFS

SOP (Address) Address for Service Order Provisioning class.

APM (Class) Class of interface for Alarm Processing Module. Use the
drop-down menu to select either:
• Internet Protocol
• NFS

APM (Address) Address for Alarm Processing Module class.

Table 15–1. Management System window; fields (sheet 2 of 3)

359
MANAGEMENT SYSTEMS
Management Systems Window

Field Description

Auto Execute Flag to indicate whether automatic service order

provisioning is required. Valid entries are Y or N.

Description Free text field to further describe the management

system.

Attribute Name The name of an attribute of the selected Management

System, e.g. INPUTHOST.

Attribute Value The expected value for the attribute.

Table 15–1. Management System window; fields (sheet 3 of 3)

360
 CHAPTER 16

Manage Service Type

Templates

The Manage Service Type Templates functionality allows users to simultaneously

update the service type templates that are associated with one or more network
elements that reside at a particular location, or with one or more frames that
reside at a particular location. Each Service Type Template captures a set of
service types that will be supported on the NE, Card, Port, Frame Container,
Frame Unit or Frame Appearance. See Service Types Template on page 461 for
more information.
The Manage Service Type Templates window allows users to:
• add a service type template to the selected cards and ports of selected
network elements
• delete service type templates associated with the selected cards and
ports of selected network elements
• delete all service type templates associated with selected cards and
ports of selected network elements, and replace them with one or
more new service type templates
• add a service type template to selected frame units and frame
appearances of selected frame containers
• delete service type templates associated with selected frame units and
frame appearances of selected frame containers
• delete all service type templates associated with selected frame units
and frame appearances of selected frame containers, and replace
them with one or more new service types.

361
M A N A G E S E R V I C E TY P E TE M P L A T E S
Manage Service Type Templates Window

Manage Service Type Templates Window

The Manage Service Type Templates window is used to add, delete, or update
the Service Type Templates associated with Network Elements or Frames.
To open the Manage Service Type Templates window
• From the Inventory menu, point to Components, and then click
Manage Service Type Templates.

Figure 16–1. Manage Service Type Templates window

The Manage Service Type Templates window consists of two tabs:

• Network Element Service Type Templates- allows users to manage
the service type templates for network elements, cards, and ports.
• Frame Service Type Templates- allows users to manage the service
type templates for frame units, frame containers, and frame
appearances.

362
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Network Element Service Type Templates

The Network Element Service Type Templates tab is used to query network
elements and simultaneously update the services type templates applied to the
cards and ports of those network elements. This section provides a description of
the various blocks and fields under the Network Element Service Type
Templates tab and also explains the logic that is applied when bulk updating the
service type templates.

Fields
Query Criteria Section- This section is used to enter the search criteria to retrieve
the network elements whose associated service type templates needs to be
updated. The wildcard character '%' can be used in all the fields. The various fields
in this section are described in the table below.

363
M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Optional
Field Description /Mandatory

NELocation The location of the network elements Mandatory

of interest. You can select a value
using the LOV button. The LOV will
display all locations that are stored
in the reference table 'LOCATIONS'.

NEType The Network Element Type. The LOV Optional if the

for this field will only display the Exchange Code is
types of network elements that reside supplied.
at the specified location.

Exchange Code The Exchange Code that Optional if Type is

corresponds with the network supplied.
elements of interest. The LOV will
display only the exchange codes of
network elements that reside at the
specified location.

Port Service Type The service type template that is Optional

Template associated with the ports of the
network elements being queried. The
LOV will display all service types
templates that correspond with the
network elements that match the
location and type entered in the
Location and Type fields.

Table 16–1. Query Criteria section; fields

364
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Button Description

Port In Circuit This radio button is used to specify the kind of ports that
will be retrieved. Select from the following three options:
All - Choose ALL to specify that a port should be
retrieved regardless of whether or not it is associated with
a circuit.
Yes - Choose Yes to specify that a port should be
retrieved only if it is associated with a circuit (i.e. the port
exists in the table PORT_LINK_PORTS).
No - Choose No to specify that a port should be
retrieved if it is not associated with a circuit (i.e. the port
does not exist in the table PORT_LINK_PORTS).

Query Used to query the network elements, cards, and ports

based on the search criteria entered.

Table 16–2. Query Criteria section; buttons

Network Elements Section- This section displays the network elements that have
been queried. The table below described the attributes that are displayed for each
network element.

Field Description

Location Location of the network element.

Type Type of the network element.

Index Index (i.e. instance) of the network element.

Exchange Code Exchange code of the network element.

Status Status of the network element.

In-Service Date Date on which the network element was put into service.

Manufacturer Manufacturer of the network element.

Model Variant of the network element type.

Table 16–3. Network Elements section; fields

365
M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Cards Section - This section displays the cards for the selected network element.
The following information is displayed about the card.

Fields Description

Card Slot Name of the card slot.

Type Type of the card.

Model Model number of the card.

Status Status of the card.

Table 16–4. Cards section; fields

Ports - This section displays the ports that are available on the card selected.

Fields Description

Port Name Name of the port.

Service Type The service type template that is currently associated with
Templates the port. Double-clicking this field will display the name
of the service type template.

Capacity Port speed.

Status Port status.

Table 16–5. Ports section; fields

Buttons
The Network Element Service Type Templates tab contains the following
buttons:

Buttons Description

Manage Service Invokes the Manage Network Element Service Type

Type Templates Template window.

Table 16–6. Network Element Service Type Templates tab; buttons (sheet 1 of 2)

366
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Buttons Description

LOV (icon) Displays the list of values for the field being queried.

Table 16–6. Network Element Service Type Templates tab; buttons (sheet 2 of 2)

Managing Network Element Service Type Templates

The Manage Network Element Service Type Templates window is used to
add, delete, or update the service type templates for each network element, card,
and port selected in the Network Element Service Type Templates tab.
To open this window, in the Network Element Service Type Templates tab,
select the network elements and the related cards and ports, and then click on the
Manage Service Type Templates button. The Manage Network Element
Service Type Templates window is displayed. Note that if you do not select
specific network elements, the service type templates for all the network elements
retrieved through search will be updated.

367
M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

The following section provides descriptions for the fields and buttons in the
Manage Network Element Service Type Templates window.

Figure 16–2. Manage Network Element Service Type Templates window

Fields
Service Type Templates Section - This section is used to select the service type
templates that will either be added to or deleted from the selected network
elements and their associated cards and ports.

368
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Optional
Fields Description /Mandatory

Service Type Service type template that is to be Mandatory

Template added or deleted. Use the list of
values to view all service type
templates available.

Priority Priority that is to be associated with Mandatory

the service type template.

Table 16–7. Service Type Templates Section; fields

369
M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

Action Section- This section is used to specify the action that will be carried out
on the selected network elements, i.e., whether service type templates will be
added, deleted, or updated.

Fields Description

Action Drop-down menu having the following options:

Add Service Type Templates- Select to add service type
templates to the network elements selected
Delete Service Type Templates- Select to delete the
service type templates already defined for the network
elements
Update Service Type Templates- Select to update the
service type templates defined for the selected network
elements.
Note that the button below this section will change
automatically to reflect the action being selected from the
drop-down menu. The Delete Service Type Templates
options are also enabled only when the Delete Service
Type Templates action has been selected in the Action
drop-down menu.

Table 16–8. Actions section; fields

Button Description

Add Service Type Used to trigger the desired action. This button also
Templates/Delete changes automatically to reflect the action being selected
Service Type from the drop-down menu.
Templates/Update
Service Type
Templates

Table 16–9. Actions section; button

Errors Section - This section displays the errors, if any, that are encountered
when the selected service type templates are applied to the network elements,

370
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

cards and ports selected in the Network Element Service Type Templates tab.
The following information is displayed.

Fields Description

Location Location of the network element selected in the Network

Element Service Type Templates tab.

Type Type of the network element selected.

Index Index of the network element selected.

Card Slot Name of the card slot with which a port is associated.

Port Name Name of the port against which an error was

encountered.

Error Description of the error that was encountered. When this

field is double-clicked, the complete error message shall
be displayed in a multi-line display field. (This will make
it easier for users to view long error messages).

Table 16–10. Errors section; fields

Buttons
The Manage Network Element Service Type Templates window contains the
following buttons:

Buttons Description

LOV Displays the list of values for the field being queried.

Insert Inserts a blank record under the Service Type

Templates field.

Delete Deletes the Service Type Template record currently

selected.

Exit Closes the Manage Network Element Service Type

Templates window.

Table 16–11. Manage Network Element Service Type Templates; fields

371
M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

To update Network Element Service Type Templates

1 In the Network Element Service Type Templates tab, enter the search
parameters and query the network elements that you want to update the
service types for.
2 Select the network elements, cards, and ports using the corresponding check
boxes.
3 Click Manage Service Type Templates. The Manage Network Element
Service Type Templates window is displayed.
4 Use the LOV button to select the service type template. Enter a priority.
5 Select the action that you want to perform using the Action drop-down
menu.

372
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

6 Note the following:

When adding service type templates, the following logic is applied:
– If no network elements, cards and ports have been selected:
The selected service type template will be added to each retrieved
network element and to every card and port associated with it.
– If one or more network elements have been selected, and no
cards/ports have been selected:
The selected service type template will be added to only the selected
network elements and all the cards and ports associated with these
network elements.
– If network elements have been selected, one or more cards have been
selected, and no ports have been selected:
The selected service type template will be added to each of the selected
network elements, to each selected card, and to each port that is
associated with the selected card.
– If network elements have been selected, one or more cards have been
selected, and one or more ports have been selected:
The selected service type template will be added only to the selected
network elements, cards, and ports.
When deleting service type templates, the following logic is applied:
– If no network elements, cards and ports have been selected:
The service type template is deleted from each port that is associated
with every card on the retrieved network elements.
– If one or more network elements have been selected, and no cards or
ports have been selected:
The selected service type template is deleted from each port that is
associated with every card on the selected network elements.
– If network elements have been selected, one or more cards have been
selected, and no ports have been selected:
The selected service type template is deleted from each port that is
associated with the selected cards.
– If network elements have been selected, one or more cards have been
selected, and one or more ports have been selected:
The selected service type template is deleted from the selected ports.
Note that the service type templates are not deleted from the corresponding
cards/network elements because they may be used by ports that were not
selected.
When attempting to delete a service type template from a port, the following
validation shall be performed:
– If the port is associated with a circuit, and the service type template
contains one or more services being provisioned on the circuit, an error
is raised: "Service type template[service type template] could not be

373
M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

deleted from port [port name] because the port is utilised by circuit
[circuit name]".
– If an error is encountered, the details of the error shall be written to the
'Errors' block. The user shall then be prompted to save the changes. If
the user elects not to save the changes, all deletes shall be rolled-back.
If the user elects to save the changes, all deletes shall be committed.

Bulk Update Network Element Service Type Templates

The following logic shall be applied to replace the existing service type templates
applied to the network elements with the newly selected service types:
If no network elements, cards and ports have been selected:
• All the service type templates linked to each retrieved port will be
deleted.
• The selected service type template will be added to each retrieved
network element.
• The selected service type templateswill be added to each retrieved
card.
• The selected service type template will be added to each retrieved
port.
If one or more network elements have been selected, and no cards/ports have
been selected:
• All the service type templates linked to each retrieved port will be
deleted.
• The selected service type template will be added to the selected
network elements.
• The selected service type template will be added to each retrieved
card.
• The selected service type template will be added to each retrieved
port.
If network elements have been selected, one or more cards have been selected,
and no ports have been selected:
• All the service type templates linked to each retrieved port will be
deleted.
• The selected service type template will be added to the selected
network elements.
• The selected service type template will be added to the selected cards.
• The selected service type template will be added to each retrieved
port.

374
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Network Element Service Type Templates

If network elements have been selected, one or more cards have been selected,
and one or more ports have been selected:
• All the service type templates linked to each retrieved port will be
deleted.
• The selected service type template will be added to the selected
network elements.
• The selected service type template will be added to the selected cards.
• The selected service type template will be added to the selected ports.
When attempting to delete a service type from a port, the following validation
shall be performed:
If the port is associated with a circuit, and the service type template contains one
or more services being provisioned on the circuit, an error is raised: "Service type
template[service type template] could not be deleted from port [port name]
because the port is utilised by circuit [circuit name]".
If an error is encountered, the details of the error shall be written to the 'Errors'
block. The user shall then be prompted to save the changes. If the user elects not
to save the changes, all deletes/inserts shall be rolled-back. If the user elects to
save the changes, all deletes/inserts shall be committed.

375
M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Frame Service Type Templates

The Frames Service Type Templates tab allows users to add, delete, or update
the Service Type Templates associated with frame containers, frame units, and
frame appearances:

Figure 16–3.

This section provides a description of the various blocks and fields under the
Frame Service Type Templates tab and also explains the logic that is applied
when bulk updating the service type templates.

376
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Fields
Query Criteria Section - This section is used to enter the search criteria to
retrieve the Frame records whose associated service type templates needs to be
updated. The wildcard character '%' is valid in all fields. The various fields in this
section are described in the table below.

Optional
Field Description /Mandatory

Frame Location Location of the frames of interest. Mandatory

Use LOV to select a frame
location.

Frame Type The Frame Type. The LOV will Mandatory

display only the types of frames
that reside at the specified
location.

Frame Appearance Service type template that is Optional

Service Type associated with the frame
Template appearances of interest. The LOV
will display all service type
templates that correspond with
the frames that match the
location and type entered in the
'Location' and 'Type' fields.

Table 16–12. Query Criteria section; fields

377
M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

The Query Criteria section contains the following radio buttons:

Button Description

Frame Appearance This radio button is used to specify the kind of Frame
In Circuit Appearances that will be retrieved. Select from the
following three options:
All - Specifies that a frame appearance should be
retrieved regardless of whether or not it is associated with
a circuit.
Yes - Specifies that a frame appearance should be
retrieved if it is associated with a circuit (i.e. the frame
appearance exists in table PORT_LINK_PORTS).
No - Specifies that a frame appearance should be
retrieved if it is not associated with a circuit (i.e. the frame
appearance does not exist in table PORT_LINK_PORTS).

Query Used to query the frame containers, frame units and

frame appearances that correspond with the search
criteria entered.

Table 16–13. Query Criteria section; buttons

Frame Containers Section - This section displays the frames that have been
queried. The table below describes the attributes that are displayed for each
frame container:

Fields Description

Location Location of the frame.

Type Type of the frame/

Index Index (i.e. instance) of the frame.

Status Status of the frame.

Container Physical frame type (i.e. 'Frame' or 'Rack').

Table 16–14. Frame Containers Section; fields

378
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Frame Units Section - This section displays the frame units that have been
queried. The table below describes the attributes that are displayed for frame unit:

Fields Description

Name Name of the frame unit.

Position Position of the frame unit within the frame container.

"Direction Direction (i.e. 'In' or 'Out') of the frame unit.

"Status Status of the frame unit.

Table 16–15. Frame Units section; fields

Frame Appearances Section - This section displays the frame appearances that
have been queried. The following attributes are displayed.

Fields Description

Position Position of the frame appearance within the frame unit.

Usage Type of service (e.g. 'VOICE', 'DATA') for which this frame
appearance is utilised.

Service Type The service type template that is currently associated with
Templates the frame appearance. Double-clicking this field will
display the name of the service type template.

Status Frame appearance status.

Table 16–16. Frame Appearances section; fields

Note that the checkboxes displayed to the left of each record is used to select the
specific objects whose service type template association you want to update. To
select all the objects displayed in the various sections, you must select the
checkbox corresponding to the column headings.

379
M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Buttons
The Frame Service Type Templates tab contains the following buttons:

Buttons Description

Manage Service Invokes the Manage Frame Service Type Templates

Type Templates window.

LOV (icon) Displays the list of values for the field being queried.

Table 16–17. Frame Service Type Templates tab; buttons

380
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Managing Frame Service Type Templates

The Manage Frame Service Type Templates window is used to add, delete, or
update the service type templates for each frame container, frame unit and frame
appearance selected in the Frame Service Type Templates tab:

Figure 16–4. Manage Frame Service Type Templates window

To open this window, under the Frame Service Type Templates tab, select the
frame container and the related frame units and frame appearances, and then
click on the Manage Service Type Templates button. The Manage Frame
Service Type Templates window is displayed. Note that if you do not select
specific network elements, the service type templates for all the network elements
retrieved through search will be updated.
The following section provides descriptions for the fields and buttons in the
Manage Frame Service Type Templates window.
Fields

381
M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Service Type Templates Section

This section is used to select the service type templates that will either be added to
or deleted from the selected frame appearances and their associated frame units
and frame containers.

Optional
Fields Description /Mandatory

Service Type Service type template that is to be Mandatory

Template added or deleted. Use the list of
values to view all service type
templates available.

Priority Priority that is to be associated Mandatory

with the service type template.

Table 16–18. Service Type Templates section; fields

382
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Action Section- This section is used to specify the action that will be carried out
on the selected frame appearances, i.e., whether service type templates will be
added, deleted, or updated.

Fields Description

Action Drop-down menu having the following options:

Add Service Type Templates- Select to add service type
templates to the frame appearances selected
Delete Service Type Templates- Select to delete the
service type templates already defined for the frame
appearances.
Update Service Type Templates- Select to update the
service type templates defined for the selected frame
appearances.
Note that the button below this section will change
automatically to reflect the action being selected from the
drop-down menu. The Delete Service Type Templates
options are also enabled only when the Delete Service
Type Templates action has been selected in the Action
drop-down menu

Table 16–19. Actions section; fields

Button Description

Add Service Type Used to trigger the desired action. Note that the button's
Templates/Delete label and the functionality that is invoked are dependent
Service Type on the value selected in the Action drop-down list.
Templates/Update
Service Type
Templates

Table 16–20. Actions section;button

Errors Section - This block displays any errors that are encountered while
attempting to apply the selected service type templates operation to the frame

383
M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

containers, frame units and frame appearances selected in the Frame Service
Type Templates tab.

Fields Description

Location Location of the frame appearance selected in the Frame

Service Type Templates tab.

Type Type of the frame record selected.

Index Index of the frame appearance.

Frame Unit Name Name of the frame unit with which a frame appearance
is associated

Frame Unit Position Position of the frame unit with which a frame
appearance is associated.

Frame Appearance Position of the frame appearance against which an error

Position was encountered.

Error Description of the error that was encountered. When this

field is double-clicked, the complete error message will
be displayed in a multi-line display field. (This will make
it easier for users to view long error messages).

Table 16–21. Errors section; fields

Buttons
The Manage Frame Service Type Templates window contains the following
buttons:

Fields Description

LOV Displays the list of values for the field being queried.

Insert Inserts a blank record under the Service Type

Templates field.

Delete Deletes the Service Type Template record currently

selected.

Table 16–22. Manage Frame Service Type Templates;buttons (sheet 1 of 2)

384
 M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

Fields Description

Exit Closes the Manage Frame Service Type Templates

window.

Table 16–22. Manage Frame Service Type Templates;buttons (sheet 2 of 2)

Bulk Add Frame Service Types

When the user elects to add service types to frames, the logic described in Bulk
Update Network Element Service Type Templates on page 374 shall be applied to
the selected frame containers, frame units and frame appearances.
Bulk Delete Frame Service Types
When the user elects to delete service types from frames, the logic described in
Bulk Update Network Element Service Type Templates on page 374 shall be
applied to the selected frame containers, frame units and frame appearances.
Bulk Update Frame Service Types
When the user elects to update frame service types, the logic described in Bulk
Update Network Element Service Type Templates on page 374 shall be applied to
the selected frame containers, frame units and frame appearances.

385
M A N A G E S E R V I C E TY P E TE M P L A T E S
Frame Service Type Templates

386
 CHAPTER 17

Topologies

This section describes how to create and maintain topologies.

387
TO P O L O G I E S
Topologies Overview

Topologies Overview
Topologies are a flexible way to organise layered networks in a logical fashion.
They group equipment and connections, exposing to the user only the information
that is currently needed, and providing the following benefits:
• A hierarchically-layered network structure that can support network
navigation in a logical manner
• The ability to clearly distinguish the network layer currently of interest,
abstracting away the complexity of the next-lower-level network until
this is needed
• The ability to do assurance and fault reporting on configuration
elements that are part of a backbone network but that impact on the
services of the current layer
There are two classes of Topologies:
Customer (Access) - customer facing topologies provide connectivity between
customer sites.
Infrastructure - logically grouped objects which describe the connectivity of
different parts of the provider's network.
This chapter describes the generic features of a Topology and also lists the
processes for creating different types of Topologies within Clarity.

Topologies Screen
To access the Topologies screen, from the Inventory menu, select Components,
and then click Topologies. The Topologies screen is displayed. The parameters
under the Access tab are used to define Access Topologies whereas the
parameters under the Infrastructure tab are used to define Infrastructure
topologies.

388
 TO P O L O G I E S
Topologies Overview

Figure 17–1. Topologies Screen

All Topologies share certain similarities:

• They have a header which describes the Topology
• They have a list of Topology objects
The following tables describe the various attributes of a topology.

Header
The following attributes are located in the Topology Header:

Field Description

Name Uniquely identifies the Topology. It can be created from

Service Manager using pre-configured business rules.

Type User definable type which is mapped to a Clarity

Function. List of values in this field is derived from the
Topology Types reference data window.

Table 17–1. Topology Header Attributes

389
TO P O L O G I E S
Topologies Overview

Field Description

Layout A graphical guide to the representation of the topology.

Note: The layout is only a guide. The true layout will be
determined by the Topology objects.

Status Describes the current stage in the Topology Lifecycle.

User can select from Clarity defined list of values.

Customer The customer which owns the topology. For infrastructure

topologies the customer is usually the carrier (or an
internal business unit). For access topologies the
customer is usually the entity that requested the service.

Service ID If the topology was created from service manager then

the service id is a reference to the service object.
Available only for Access topologies.

Service Type If the topology was created from service manager then
the service type is derived from the service information.
The information in the service type field will be
dependent on the Service ID. Available only for Access
topologies.

Service Type A template that comprises a list of supported service

Template types. This attribute is available only for Infrastructure
topologies. Services can use the Infrastructure Topology
only if they are a supported service in the service
template.
Note - Double clicking on the service template will bring
up a list of supported services.
Note: Access topologies do not have a service type
template.

Table 17–1. Topology Header Attributes

View Identifiers
The View Identifiers button launches the Topology Identifier Mapping window
that allows the user to define topology identifiers for an access or infrstructure
topology. Since there may be more than one way to identify a topology (e.g. VLAN
IDs, VRF IDs), it is necessary to have a list of Identifiers. For example, a Customer
VPN maybe use two metro Ethernet networks and the PE network; as such it would

390
 TO P O L O G I E S
Topologies Overview

require two VLAN IDs and one VRF ID. Some of these identifiers may have been
assigned by Service Manager.

Figure 17–2. Topology Identifier Mapping window

Field Description

Name The string representation of this identifier.

Value The value/ID of this Identifier Object.

Table 17–2. Topology Identifier Attributes

Topology Objects
In the Topology Objects section, the Connection Class and Name paring will
uniquely identify the topology object. The various attributes in this section are
described as follows:

Button Description

Seq The sequence number for the Topology object.

Table 17–3. Topology Objects Attributes (sheet 1 of 2)

391
TO P O L O G I E S
Topologies Overview

Button Description

Connection Class The class of the topology object. Possible topology

objects are:
• Network Elements - NEs are the main
components of a topology. A topology with only
network elements assumes that all network
elements are connected.
• Connections - Connections make up the
connectivity between network elements.
• Circuits - Where Connections are not available it
is possible to use circuits for connectivity.
• Topologies - In most cases there will be at least
one Topology object present. They represent
other sections of the network that interact with the
current topology.
• Clouds - A valid substitute - for topologies. They
can be used when the provider has no
knowledge or no interest in other networks.
• Generic Objects - Can be used to represent
distinct objects for which information is not
known or irrelevant. In some cases they may be
used as substitutes for Network Elements.

Name The unique name of the object.

Interconnect Point It is possible to flag network elements as

interconnection points. Depending on the layout of
the topology the interconnection point may mean
different things:
• Hub-Spoke - the network element that is the hub
is flagged as the interconnection point
• Ring - the ingress/egress network elements are
flagged as interconnection points
• Tree - The root network elements is the
interconnection point.

Table 17–3. Topology Objects Attributes (sheet 2 of 2)

392
 TO P O L O G I E S
Creating Topologies

Creating Topologies
This section describes how to create topologies using the Topologies screen.

Prerequisites
Prior to defining Topologies, the following data/objects must already have been
defined in Clarity:
• Topology Reference Data, such as Topology Types and Topology
Layouts must have been set up
• Network Elements, Circuits, Connections, Generic Objects, and
Clouds must have been defined
• Service Types must have been defined

Creating Topologies Reference Data

The following processes describe the Topology specific reference data that needs
to be set up.

Topology Layouts
Topologies will have a layout identifying their connectivity shape. This window
allows the user to set up the different kinds of topology layouts.

Figure 17–3. Topology Layouts

393
TO P O L O G I E S
Creating Topologies

Field Description

Name The name of this topology layout, for example BUS,

MESH, RING, STAR, TREE.

Table 17–4. Topology Layouts Window; Fields

To define topology layouts

1 On the Inventory > Reference Data > Topologies menu, click on
Topology Layouts.
2 Define your topology layouts and save.

394
 TO P O L O G I E S
Creating Topologies

Topology Types
The Topology Types reference data window allows the user to define the various
types of topologies.

Figure 17–4. Topology Types Window

Field Description

Name The name of this topology type.

Class A reference to the topology class that is associated

with this topology type. Users can select from the
Topology Classes LOV available on this field.

Function A reference to the topology function that is

associated with this topology type. Clicking the LOV
button will launch the Functions LOV window
displaying a list of all the Clarity defined Functions.
Users can select Functions from this list to assign to
topology types.

Table 17–5. Topology Types Window; Fields

395
TO P O L O G I E S
Creating a Generic Topology

Creating a Generic Topology

The following procedure describes how to create a generic topology using the
Topologies screen.
To create a generic topology
1 Select the appropriate class for the topology, i.e., either Access or
Infrastructure. Clarity Business rules will be applied based on the Topology
class selected.
2 Create a unique name for the topology applying any existing business rules.
A descriptive name will allow easy searching. If the topology was created
through Service Manager (Access class Topology through Process Functions)
then the name will be pre-configured.
3 Select the type which best describes the topology. There will be a Clarity
function mapped to one or more user definable Topology types. This Clarity
function will govern the way the system treats the topology. It can govern:
diagramming, behaviors, interactions with other modules as well as business
rules. Make sure that the function suits the topology purpose.
4 Select the layout that best matches the topology you want to create. The
layout only describes a graphical representation. It does not enforce any
rules when choosing the topology objects.

Hint
If unsure of the layout, then select Mesh.

Note
Note - The diagrammed layout rests entirely on the topology objects
selected.

5 Choose a status for the Topology.

6 Create an Identifier name for the topology. Click on the View Identifiers
button to open the Topology Identifier Mapping window. Enter a name
and value/id for the topology identifier. If the topology header was created
from Service Manager then an Identifier name should have been populated.
The Topology Identifier may list one or more: VLAN IDs, VRF IDs, MAC
addresses. The number and type of identifiers depends on the service and on
the technology it utilises.
7 If it is an Infrastructure topology, select a service template that is appropriate
for the topology. The service template lists all the supported service types of
the topology. Customer (Access) Topologies will not have any service
templates since they are usually created for one service (service type stored in
service type field). For an Access topology, select a Service Type.
8 Add the topology objects. The objects added will determine the true structure
of the topology. It is important that at this stage you double check the
Topology header for correctness.

396
 TO P O L O G I E S
Creating a Generic Topology

9 Identify the network elements that are to be part of the topology. They will all
have the same function. Add each network element to the topology.

Note
A network element may be in more than one topology.

10 Flag the relevant Network Elements as interconnection points. The meaning

of the interconnection point(s) is derived from the Topology layout.
11 Identify the Connections between existing network elements. There may be
multiple Connections between the network elements so only include the
appropriate high level Connection(s).
12 If appropriate, add Topology(s) as Topology objects. These will usually be
higher level parts of the network which are in direct connection to the
topology through either common network elements or Connections.

Note
There will usually be at least one Topology in the topology Objects.

397
TO P O L O G I E S
Example - GSM / CDMA Network

Example - GSM / CDMA Network

The GSM /CDMA network is comprised of:
1. Base Station Controller Topology (BSC Topology) (topology function 112):
contains one BSC network element and its associated BTS network elements.
2. Mobile Switching Controller Topology (MSC Topology) (topology function
111): contains one MSC network element and a set of associated BSC
topologies.
Each BTS communicates with only one BSC. Each BSC communicates with only
one MSC.
The diagram below is an example of a GSM/CDMA Network

Figure 17–5. GSM/CDMA Network

The procedures below describe how to create infrastructure topologies in a

GSM/CDMA network.

398
 TO P O L O G I E S
Example - GSM / CDMA Network

Prerequisites
Prior to creating your topologies, the following must have been completed:
• Mobile Switch Center (MSC) Network Elements must have been
defined.
• Base Station Controller (BSC) Network Elements must have been
defined.
• Base Transceiver Station (BTS) Network Elements must have been
defined.

Creating a Mobile Switching Center Topology (MSC Topology)

A "MSC Topology" is the Clarity description to Topology Function 111. Users can
map any topology type to this function.

Note
There will be a MSC topology for each MSC network element.

To create an MSC topology

1 Use existing business rule(s) to assign a name for the MSC Topology. The
name will uniquely identify the Topology. A well constructed name will make
identifying the topology easier.

Note
A possible name is: "[MSC]-[Location]-[Index]"

2 Select the type which best describes the MSC topology. Ensure that the type
selected is mapped to the "MSC Topology" Clarity Function (function 111).
3 Select "Tree" as the Layout for the Topology. It is important to use "Tree" as the
topology layout because this will allow easy identification of the root MSC.
4 For each MSC you will need to add the following Topology Objects:
– One MSC network element (the root)
– All its associated BSC Topologies.
5 Select one MSC network element and add it to the Topology Objects. You will
need to flag this MSC as an interconnection point. This informs the OSS that
this network element is the root MSC.
6 Identify the BSC topologies which are related to the parent MSC network
element. Each related BSC topology will need to be added as a topology
object.

399
TO P O L O G I E S
Example - GSM / CDMA Network

Creating a Base Station Controller Topology (BSC Topology)

A "BSC Topology" is the Clarity description to Topology Function 112. Users can
map any topology type to this function.

Note
There will be a BSC topology for each BSC network element.

To create a BSC topology

1 Use existing business rule(s) to assign a name for the BSC Topology. The
name will uniquely identify the Topology. A well constructed name will make
identifying the topology easier.

Note
A possible name is "[BSC]-[Location]-[index]"

2 Select the type which best describes the BSC topology. Ensure that the type
selected is mapped to the "BSC Topology" Clarity Function 112.
3 Select "Tree" as the Layout for the Topology. It is important to use "Tree" as the
topology because this will allow easy identification of the root BSC.
4 For each BSC you will need to add the following Topology Objects:
– One BSC network element (root).
– All its associated BTS network elements.
5 Select one BSC network element and add it to the Topology Objects. You will
need to flag this BSC as an interconnection point. This informs the OSS that
this network element is the root BSC.
6 Identify all the BTS network elements that have an association with the BSC.
Add each BTS as a topology object.

400
 TO P O L O G I E S
Creating Infrastructure Topologies

Creating Infrastructure Topologies

The following diagram illustrates an Infrastructure Topology. The procedures
below describe how the Topologies screen can be used to create different types of
Infrastructure topologies.

Figure 17–6. Infrastructure Topologies

Creating Metro Ethernet (Layer 2) Topology

To create a Metro Ethernet (Layer 2) topology
1 Create the topology header like you would for any Topology. Ensure that
Topology type is mapped to the Clarity function of "Ethernet Network". This
will allow the system to recognise the topology as a metro Ethernet network
and apply business rules to the object.

Note
The usual layouts for a metro Ethernet network are either Tree or Ring.

401
TO P O L O G I E S
Creating Infrastructure Topologies

2 Identify the set of Ethernet capable network elements which provide Ethernet
switching functionality and add them to the topology objects. It is important
to only include the switches that are connected together physically.

Note
There will usually be multiple metro Ethernet networks in the
database.
3 Include any PEs that provide both Layer 3 routing and Layer 2 switching
functionality.
Policy - In cases where PEs do not support Ethernet traffic, but are connected
to Ethernet switches using a Layer 3 connection, they must not be included in
the Metro Ethernet Network. However they will be present in another
topology (see below).
4 Identify all Connections that carry Ethernet traffic and that connect any tow
network elements defined in the Topology objects. Add these Connections to
the topology objects.
5 Add the PE Topology to which the metro Ethernet network is connected to as
a Topology Object.

Creating a (Layer 3) Provider Edge Topology

To create a Provider Edge topology

There is usually only one Provider Edge (PE) topology. Even if there are multiple
cores, the PE network elements are usually organised as a single topology. This
ensures that connectivity can be provided to all parts of the provider's network.

Note
The provider would have more than one PE topology only in some special
cases.

1 Create the Topology header like you would for any Topology. Ensure that the
chosen topology type is mapped to the Clarity "PE" function. This will enforce
the appropriate business rules.

Note
The most common layout for the PE topology is mesh since all the PEs can
usually talk to each other.

402
 TO P O L O G I E S
Creating Infrastructure Topologies

2 Identify the amount of detail required in the Topology objects section. The
simplest PE topology will only contain network elements. Use this
methodology when the exact connectivity between the PEs is unimportant.
At a minimum the PE topology will contain a list of network elements.

Note
Note - The above modelling approach can be used to model networks
that are owned and operated by other companies.

3 If there is a need to know connectivity between PEs then you need to add the
Connections to the topology objects. In most cases these connections will be
of type LSP (Label Switched Path).

Note
An alternative way to model the PE topology is to include the Core as a
topology object. In this case the connections will be different and there
will be more topology objects. Clarity doesn't recommend this approach.
We suggest that the core form part of the LSP route sections (see
Connections document).

Creating a (MPLS) Core Topology

To create a MPLS Core topology
1 Ensure that there is a requirement to model the MPLS Core. Creating the
core topology adds an extra layer of data and complexity.
2 Create the Topology header, selecting an appropriate Topology Type that is
mapped to the Clarity Function of "Core".
3 In the Topology Objects section, add the network elements that define the
core.
4 Under Topology objects add only the Connections (or circuits) that link any
two previously defined network elements.

Broadcast Network
The characteristic of a broadcast network is that it sends (broadcasts) every data
packet to all the customers connected to the broadcast network. Encryption is
used to ensure data security. A Passive optical network is an example of a
Broadcast Network. The procedure below describes how to create an FTTH
topology in the Broadcast Network.

403
TO P O L O G I E S
Creating Infrastructure Topologies

Creating an FTTH Topology

To create an FTTH Topology
1 Create the Topology header like you would for any infrastructure topology.
Ensure that the Topology type is mapped to the "Broadcast Network" Clarity
Function. The Layout is usually "tree".
2 Add the network elements which constitute the FTTH network. The network
elements are usually: HE, OLTs, and optical splitters.
3 Flag the root HE as the interconnection point.
4 Add the optical connections between the network elements.
5 Add any topologies to which the HE is connected.

404
 TO P O L O G I E S
Creating Customer (Access) Topologies

Creating Customer (Access) Topologies

The following diagram illustrates Access Topologies. The procedures below
describe how the Topologies screen can be used to create different types of Access
topologies.

Figure 17–7. Access Topologies

Creating a VLAN topology

To create a VLAN topology
1 A Customer VLAN can be created using Service Manager. This will populate
the topology header information with details related to the VLAN service
including a pre-configured name format.
2 If the VLAN header is created manually, ensure that the Clarity Topology
Function is VLAN. This can be done by checking that the topology type is
mapped to the Clarity Topology Function of VLAN.

405
TO P O L O G I E S
Creating Customer (Access) Topologies

3 The most common layout for a customer VLAN are mesh and hub and
spoke. Choose a Topology Layout which best describes the connectivity.

Note
Layout is only used as a drawing guideline. The true shape of the VLAN
will be based on all the topology objects.

4 Create a Topology Identifier for the VLAN. This identifier will hold a list of
VLAN IDs.
5 For each customer site in this VLAN, do the following:
– Add the access Connection to the VLAN Topology objects.
– If the access Connection, customer side termination, is terminated on a
network element then add the network element to the topology objects
– If the network element is the hub in a hub and spoke topology then set
the interconnection point flag to 'Y'.

Note
Only network elements can be hubs.
– Add the Ethernet Topology on which the Access Connection terminates
on (network side termination), unless it already exists.
6 For Each Ethernet Topology you will need to ensure a VLAN ID mapping to
the Topology Identifier. This ensures that the customer VLAN can traverse all
Metro Ethernet networks.
7 For each switch in the Ethernet Topology, add the VLAN ID to its uplink port.
8 You will need to create a pseudo wire to carry the Ethernet frames between
each of the metro Ethernet networks (see How To Connection document on
creating a pseudo wire). This enables the different Ethernet networks to
communicate with each other.

Note
If there is only 1 Ethernet Topology in the Topology objects then no pseudo
wire is required.

9 Add each pseudo wire to the Access VLAN topology objects section.

Creating a VPN topology

To create a VPN topology
1 Topologies can be created from service manager. This will populate the
topology header information with details related to the VPN service including
a pre-configured name format.
2 If you are creating the VPN manually then it is important to select a Topology
Type which is mapped to the Clarity Topology Function of VPN. This will allow
the Clarity OSS to identify the object as VPN.

406
 TO P O L O G I E S
Creating Customer (Access) Topologies

3 Create a Topology Identifier for the VPN.

4 For each Customer Site in this VPN;
– Add the Access Connection to the VPN Topology objects
– Add the network element (Customer Side Termination) as a topology
object
– If the network elements is the hub in a hub and spoke topology then set
the interconnection point flag to 'Y'.

Note
Only network elements can be hubs.
– Add the PE topology that the Access Connection terminates on (network
side termination) as a topology object (unless it already exists).
5 Check that only one PE topology exists in the topology objects. If this isn't the
case then it is not possible to provide the service.
6 For each PE router in the PE topology, create a VRF entry for this VPN to its
VRF list, choosing a suitable Route Distinguisher.

Verify that the Topology Identifier contains all the necessary VLAN and VRF
information.

407
TO P O L O G I E S
Creating Customer (Access) Topologies

408
 CHAPTER 18

Generic Objects

This section describes how to create and maintain Generic Objects.

409
GENERIC OBJECTS
Generic Objects Overview

Generic Objects Overview

There are a number of telecommunications-related objects that need to be
represented as an abstraction. These objects can be configured as Generic
Objects in the Clarity Inventory module.
A Generic Object is any kind of object that may need to be modeled but has no
impact on traffic management, such as mail servers or storage arrays. Such
objects are associated with other inventory objects in one of the following ways:
• They are termination equipment for a data connection
• They are contained in a cloud
• They are associated with a service

Generic Objects Screen

To access the Generic Objects screen, from the Inventory menu, select
Components, and then click Generic Objects. The Generic Objects screen is
displayed.

Figure 18–1. Generic Objects Screen

410
 GENERIC OBJECTS
Generic Objects Overview

The Generic Objects screen has the following fields that define the attributes for
the Generic Object:

Field Description

Name The name of the generic object.

Type The type of the generic object. List of values is derived

from the types set up in the Generic Object Types
reference data window.

Location The location of the generic object.

Table 18–1. Generic Objects Screen; fields

Defining Generic Objects

Prerequisites
Prior to defining Generic Objects, the following reference data must be set up:
• Generic Objects Types

Setting up Generic Object Types

From the Inventory > Reference Data menu, select Generic Object Types. The
Generic Objects Types screen is displayed that allows users to define generic
object types.

411
GENERIC OBJECTS
Generic Objects Overview

Figure 18–2. Generic Object Types screen

To set up Generic Object Types

1 In the Name field, enter a name for the Generic Object type.
2 Save your record.

412
 CHAPTER 19

Clouds

This chapter describes how to define object types called Clouds.

413
CLOUDS
Clouds Overview

Clouds Overview
A Cloud is a new object class that provides the following functionality:
• Logical grouping for a collection of network inventory objects
• Connectivity where the exact path is not known
• Termination point for (unrouted) data connections that exit the network
of interest
Clouds will have neither types nor functions and cloud instances may be created
at any point without preconditions. Clouds may contain network inventory objects,
generic objects or other clouds but not directly circuits or connections. A cloud
may not contain itself. Objects may be contained by more than one cloud.
Figure 18-1 is an example of a Core Network cloud, containing P routers and the
SDH Network cloud that provides the connectivity among them. The SDH Network
cloud in turn contains the Muxes that provide SDH connectivity.
The PE routers provide connectivity into the Core Network cloud; this enables the
top-level data connection to be routed across the Core Network cloud without
specifying the precise route through the Core Network. The top-level data
connection can thus be fully routed without the need to know the equipment and
connectivity within the cloud.
Clouds may be used to represent an external network as traffic terminator, also
shown in the figure below, where a data connection terminates on "the Internet".
Note the absence of ports on clouds.

Figure 19–1. Cloud Functionality

414
 CLOUDS
Clouds Overview

Clouds Screen
To access the Clouds screen, from the Inventory menu, select Components, and
then click Clouds. The Clouds screen is displayed.

Figure 19–2. Clouds

The Clouds screen has the following fields that define its attributes:

Field Description

Clouds

Cloud Name The name of this cloud.

Cloud Objects

Seq The sequence of the object contained in the Cloud.

Object Type List of values containing various object types such as

CLOUD, GENERIC OBJECT or EQUIPMENT.

Table 19–1. Clouds Screen; fields

415
CLOUDS
Clouds Overview

Field Description

Object Detail Click on the LOV button to launch the Object Details LOV
window in the context of the object type selected. i.e., if a
Generic Object is selected in the Object Type column,
the Generic Object LOV window is launched. This
window allows users to query and select instances of the
object type that they want to add to the Cloud being
defined. User can select the record by either clicking on
the OK button or by double clicking on the record.

Table 19–1. Clouds Screen; fields

Defining Clouds
To define Clouds
1 In the Cloud Name field, enter a name for the new Cloud being defined.

Figure 19–3. Define Cloud Name

416
 CLOUDS
Clouds Overview

2 In the Cloud Objects section, select the objects that will be contained in this
cloud.
i. Enter a sequence for the object type.
ii. Use the LOV in the Object Type field to select an object type, for
example Network Element, Cloud, or Generic Object.

Figure 19–4. Select Cloud Objects

iii. Click on the LOV button to launch the LOV window. As the Object Type
selected is a generic object, the Generic Object LOV window will be
launched.

417
CLOUDS
Clouds Overview

Figure 19–5. Network Element LOV window

iv. Query and select the generic object that you would like to add as a
cloud object.
v. Add as many cloud objects as desired and then save the record.

418
 CHAPTER 20

Templates

This chapter shows you how to open and use the Template windows available
from the Templates submenu in the Clarity Inventory Suite.

419
TE M P L A T E S
Templates Windows

Templates Windows
The following windows are available in the Templates menu in the Clarity
Inventory Suite:

Window See…

Cable Details Template page 421

Card Details Template page 423

Circuit Details Template page 426

Frame Units Template page 429

Frame Container Details Template page 432

Network Elements Template page 434

Network Element Details Template page 443

Equipment Features page 446

Ports Templates page 448

Port Details Templates page 458

Service Types Template page 461

Trunk Group Details Template page 465

420
 TE M P L A T E S
Cable Details Templates

Cable Details Templates

Use this window to define a set of attributes that describe the information
associated with a cable sheath product type.
Before you can create records in this window, values must be entered in the
following window:
• Cable Sheath Product Type reference window. See Cable Sheath
Product Types on page 540 for more information on this window.
To open the Cable Details Templates window
• From the Inventory menu, point to Templates, and then click Cable
Details.

Figure 20–1. Cable Details Template window

Fields
The fields in the Cable Details Template window are:

Field Description

Cable Templates

Name A free text field to describe the cable template.

Cable Sheath The product type available from Cable Sheath Product
Product Type Type reference window. Use LOV to select a value.

Table 20–1. Cable Template window; fields (sheet 1 of 2)

421
TE M P L A T E S
Cable Details Templates

Field Description

Description A free text field to further describe the use of the

template.

Cable Template Attributes

Attribute Name A cable attribute name.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following from the drop-
down list:
• Alphabetic
• Numeric
• Character
• Date.

Attribute Value A value associated with the attribute.

Defined by The person that defined the attribute. Select one of the
following from the drop-down list:
• Customer
• Engineer
• System.

Optionality The status of the attribute value.

Select one of the following from the drop-down list:
• Optional
The value does not have to be entered.
• Mandatory
The value must be entered in the Equipment
Parameters form if it is not entered here. The value
can be changed.
• Fixed
The value must be entered in the Attribute Value
field in this form. Once this value is saved it cannot be
changed.

Validation Indicates if the attributes are to be validated (Yes) or not

(No). If the field says Yes, double-click to display the
Cable Parameter Validation window. See Cable
Parameter Validation on page 544 for more information
about this window.

Table 20–1. Cable Template window; fields (sheet 2 of 2)

422
 TE M P L A T E S
Card Details Template

Card Details Template

Use this window to define a set of attributes that describe the information
associated with a card relative to a service.
Before you can create records in this window, values must be entered in the
following windows:
• Manufacturers reference window. See Manufacturers on page 530
for more information on the Manufacturers window.
• Network Element Types reference window. See Network Element
Types on page 571 for more information on the Network Element
Types window.
To open the Card Details Templates window
• From the Inventory menu, point to Templates, and then click Card
Details.

Figure 20–2. Card Details Template window

Fields
The fields in the Card Details Template window are:

Field Description

Card Details Template

Name A free text field to describe the card template.

Table 20–2. Card Details Templates window; fields (sheet 1 of 3)

423
TE M P L A T E S
Card Details Template

Field Description

Manufacturer An abbreviation that identifies the manufacturer of the

card. Use LOV to select a value.

Network Element An abbreviation that identifies the network element type.

Type Use LOV to select a value.

Description A free text field to further describe the use of the

template.

Card Detail Attributes

Attribute Name The card parameter validation name.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following from the drop-
down list:
• Alpha
• Number
• Character
• Date.

Attribute Value A value associated with the attribute. For example if the
attribute name is IP Address, the value in this field would
be the actual IP address.

Defined by The person that defined the attribute. Select one of the
following from the drop-down list:
• Customer
• Engineer
• System.

Table 20–2. Card Details Templates window; fields (sheet 2 of 3)

424
 TE M P L A T E S
Card Details Template

Field Description

Optionality The status of the attribute value.

Select one of the following from the drop-down list:
• Mandatory
The value must be entered in the Equipment
Parameters form if it is not entered here. The value
can be changed.
• Optional
The value does not have to be entered.
• Fixed
The value must be entered in the Attribute Value
field in this form. Once this value is saved it cannot be
changed.

Table 20–2. Card Details Templates window; fields (sheet 3 of 3)

425
TE M P L A T E S
Circuit Details Templates

Circuit Details Templates

Use this window to define a set of attributes that describe the information
associated with a service.
Before you can create records in this window, values must be entered in the
following windows:
• Circuit Validation reference window. See Circuit Parameter Validation
on page 555 for more information on the Circuit Parameter
Validation window.
• Management Systems window. See Management Systems Window
on page 358 for more information on the Management Systems
window.
To open the Circuit Template window
• From the Inventory menu, point to Templates, and then click Circuit
Details.

Figure 20–3. Circuit Template window

426
 TE M P L A T E S
Circuit Details Templates

Fields
The fields in the Circuit Template window are:

Field Description

Circuit Templates

Name A descriptive name for the service template. (Mandatory)

Management The management system that is used to monitor and

System Name provision a group of network elements. Use LOV to
select a value. (Mandatory)

Description A free text field to further describe the use of the

template. (Mandatory)

Circuit Template Attributes

Attribute Name The service parameter validation name. Use LOV to

select a value.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following from the drop-
down list:
• Alphabetic
• Numeric
• Character
• Date.

Attribute Value The value of the service attribute.

Defined by The person that defined the attribute. Select one of the
following from the drop-down list:
• Customer
• Engineer
• System.

Table 20–3. Circuit Template window; fields (sheet 1 of 2)

427
TE M P L A T E S
Circuit Details Templates

Field Description

Optionality The status of the attribute value.

Select one of the following from the drop-down list:
• Create
Optional value used to create a service.
• Close
Optional value used to close a service.
• Optional
Value does not have to be entered.
• Fixed
Value must be entered in the Attribute Value field in
this form. Once this value is saved it cannot be
changed.

Table 20–3. Circuit Template window; fields (sheet 2 of 2)

428
 TE M P L A T E S
Frame Unit Templates

Frame Unit Templates

Use this window to set up frame unit configurations for a range of frame
appearances. The bottom half of the window defines the naming conventions for
the frame appearances in the frame unit.
For example, a frame appearance position labeled 0001 would have:
• Frame Appearance 1 within the specified frame range
• Left pad character = 0
• Left pad width = 3
To open the Frame Unit Templates window
• From the Inventory menu, point to Templates, and then click Frame
Units.

Figure 20–4. Frame Unit Templates window

Fields
The fields in the Frame Unit Templates window are:

Field Description

Frame Unit Templates

Template Name A descriptive name for the frame unit template.

Table 20–4. Frame Unit Templates window; fields (sheet 1 of 3)

429
TE M P L A T E S
Frame Unit Templates

Field Description

Description A free text field to further describe the use of the

template.

Frame Unit Template Details

Sequence The order of display in the Frame Appearances section

of the Frames window.

Frame Appearance The Frame Appearance fields identify a range of

From positions in the frame unit. From is the beginning
position.

Frame Appearance The Frame Appearance fields identify a range of

To positions in the frame unit. To is the end position in the
frame unit.

Left pad frame The character used to pad out the frame appearance
appearance with name from the left. See example on page 429 for more
the character information.

Service Type Specifies the Service type template that will be applied to
Template the frame appearance. To select a service type template
to apply to the record, double-click on this field. The
Frame Unit Template Service Type Templates window
will pop-up with the Service Templates tab in focus.
Use the LOV in the Name field (under the Frame
Template Service Templates section) to select a service
type template. See Service Types Template on page 461
for more information.
Note: The Service Types tab is disabled because the
Frame Unit Template window will only support
the association of Service Type Templates and not
service types.

Left pad frame The number of times to use the pad character in the
appearance to a frame appearance name. See example on page 429 for
width of n more information.
characters

Odd/Even Specifies whether only odd or even numbers should be

generated when naming frame appearances. Select All
to specify a number range that includes both.

Table 20–4. Frame Unit Templates window; fields (sheet 2 of 3)

430
 TE M P L A T E S
Frame Unit Templates

Field Description

Usage The usage at the specified position. Use the drop-down

list to select from:
• Voice
• Data
• Wideband.

Status The status of the frame appearance. Use the drop-down

list to select one of the following:
• Spare
• Planned
• Active
• InActive
• Bad Pin
• In Use
• Locked.

Table 20–4. Frame Unit Templates window; fields (sheet 3 of 3)

431
TE M P L A T E S
Frame Container Details Template

Frame Container Details Template

Use this reference window to create and maintain frame container attribute
templates.
To open the Frame Container Details Templates window
• From the Inventory menu, point to Templates, and then click Frame
Container Details.

Figure 20–5. Frame Container Details Template window

Fields
The fields in the Frame Container Details Template window are:

Field Description

Template

Name A free text field to describe the frame container attributes

template. (Mandatory)

Description A free text field to further describe the use of the

template. (Mandatory)

Attributes

Name The attribute name.

Table 20–5. Frame Container Details Templates window; fields (sheet 1 of 2)

432
 TE M P L A T E S
Frame Container Details Template

Field Description

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following:
• Alpha
• Number
• Character
• Date

Attribute Value A value associated with the attribute.

Defined by The person that defined the attribute. Select one of the
following:
• Customer
• Engineer
• System

Optionality The status of the attribute value.

Select one of the following:
• Mandatory
The value must be entered in the Frame Container
Parameters form if it is not entered here. The value
can be changed.
• Optional
The value does not have to be entered.
• Fixed
The value must be entered in the Attribute Value
field in this form. Once this value is saved it cannot be
changed.

Table 20–5. Frame Container Details Templates window; fields (sheet 2 of 2)

433
TE M P L A T E S
Network Element Template Window

Network Element Template Window

Use this window to query, create, modify and delete network element templates.
You can create a Network Element Template for each network element model.
To open the Network Element Template window
• From the Inventory menu, point to Templates, and then click
Network Elements.

Figure 20–6. Network Element Template window

The sections of the Network Element Template window are:

Section See…

Network Element Models page 435

Network Element Template Details page 435

Card Slot Template Details page 437

434
 TE M P L A T E S
Network Element Template Window

Network Elements Models

The Network Element Models section lists the network element models defined
in the NE Models reference window. You can add one or more templates for
each Network Element Model displayed.

Figure 20–7. Network Element Models section in the Network Element Template window

Fields
The fields in the Network Element Models section are:

Field Description

Network Element The Network Element model type defined in the

Type Network Element Types reference window.

Model The model of the network element defined in the

Network Element Models reference window.

Manufacturer The manufacturer of the network element.

Table 20–6. Network Element Models section; fields

Network Element Template Details

The Network Element Template Details section lists the templates that have
been defined for the Network Element model displayed in the Network Element
Models section.

Figure 20–8. Network Element Template Details section

435
TE M P L A T E S
Network Element Template Window

Fields
The fields in the Network Element Template Details section are:

Field Description

Template Name The template name.

Supplier The supplier of the network element.

Dealer The dealer of the network element.

Maintainer The maintainer of the template.

Exchange Code The exchange code for the location of the network
element.

Comments Additional comments.

Table 20–7. Network Element Template Details section; fields

Buttons
The buttons in the Network Element Template Details section are:

Button Description

Create Card Opens the Create Card Option for a Slot window. Use
Options this window to define the slot requirements for the types
of cards that can be installed in the Network Element
Model. See Creating Card Options on page 440 for
more information on creating card options.

Create Slot Opens the Create Slots window. Use this window to
Template define the slot names for the Network Element Model,
and the sequence of these slots. See Creating a Slot
Template on page 440 for more information on creating
a slot template.

Table 20–8. Network Element Template Details section; buttons

436
 TE M P L A T E S
Network Element Template Window

Button Description

Map Slots and Opens the Slots and Card Mapping Options window.
Card Options Use this window to map the Slot Names defined in the
Create Slots window with the Card Types defined in the
Card Model reference window. See Mapping Slots with
Card Options on page 441 for more information on
mapping slots with card options.

Table 20–8. Network Element Template Details section; buttons

Card Slot Template Details

The Card Slot Template Details section displays the Slot Card Template for
each Network Element Template defined in the Network Element Template
Details section.

Figure 20–9. Card Slot Template Details section in the Network Element Template window

Fields
The fields in the Card Slot Template Details section are:

Field Description

Slot Name The slot name defined by clicking the Create Slot
Template button in the Network Element Template
Details section.

Card Type The card model assigned to the Slot Name. This
relationship is defined by clicking the Map Slots and
Card Options button in the Network Element
Template Details section.

Port Template The name of the parent port template assigned to this
Name slot.

Table 20–9. Card Slot Template Details section; fields (sheet 1 of 2)

437
TE M P L A T E S
Network Element Template Window

Field Description

Status The status of the slot, which is one of the following:

• Empty
No card is assigned to this slot.
• Filled
A card is assigned to this slot.
• Used
The slot is used by a card in another slot.

Table 20–9. Card Slot Template Details section; fields (sheet 2 of 2)

Button
The button in the Card Slot Template Details section is:

Button Description

Create Slots from Use this button to populate the fields in the Slot Card
Slot Template Template Details section of the window with the Slot
Names and Card Types you defined and associated in
the Network Element Template Details section.

Table 20–10. Card Slot Template Details section; button

Features of the Network Element Template Window

The features of the Network Element Template window are:

Feature See…

Opening the Network Element Template page 434

window

Querying network element models page 439

Creating network element templates page 439

Creating slot card templates page 441

438
 TE M P L A T E S
Network Element Template Window

Querying Network Element Models

To query Network Element Model records and display the
Network Element Templates
1 Click the Query button to place the window in query mode.
2 Enter your search criteria in either the Network Element Type, Model, or
Manufacturer fields. You can also use LOV to select the search criteria.
3 Click the Query button.
The Network Element templates for the Network Element Model are
displayed in the Network Element Template Details section of the
window.

Creating Network Element Templates

A Network Element Template defines the slot and cards contained within a
network element. For example, a network element model may always have a
power card occupying slot 01 and a CPU card occupying slot 02. In a Network
Element Template you can define the allocation of cards in slots.
As you can have multiple templates for each network element model, you can
define templates for common configurations of each network element. You can
also associate a Port template with a Card Slot in a template.
Using Network Element Templates can reduce the effort to add new Network
Elements to the Clarity system.
To create a Network Element Templates:
1. Define the Network Element Template name
2. Create the Card Options
3. Create the Slot Template
4. Map Slots with Card Options.

Defining an Network Element Template

You can have multiple Network Element Templates for each Network Element
model. Each Network Element Template has its own Card Option, Slot Template,
and Slot and Card Options mapping.
To define an Network Element Template
1 Query the Network Element Model.
See Querying Network Element Models on page 439 for more information
on querying an network element model.
2 Position the cursor in the Template Name field in the Network Element
Template Details section of the window.
3 Click the Insert button.

439
TE M P L A T E S
Network Element Template Window

4 Enter the fields for the Network Element Template.

See Network Element Template Details on page 435 for information about
these fields.
5 Click the Save button.
Once you have defined the Network Element Template, you can define the Card
Options and Slot Template and then map the Slots with Card Options.

Creating Card Options

The Card Options window identifies the card requirements of the network
element model for the current Network Element Template. For example, a
network element model may require two power cards and one CPU card. You
identify these requirement in the Card Options.
If you are defining multiple Network Element Templates for common
configurations of a network element model, you set up the Card Options to reflect
the slot requirements for each card type used in the configuration.
To create Card Options
1 In the Network Element Template Details section, select the Network
Element Template name.
2 Click the Create Card Options button.
The Create Card Option for a Slot window is displayed.
3 In the Card Type field, use LOV to select a card type suitable for this network
element model. You define these card types in the Card Models reference
window.
4 In the Slots Required field, enter the number of slots required for this card
type.
5 Repeat steps 3 to 4 for each card type in the network element configuration.
6 Click the Save button.
7 Click the Exit button.

Creating a Slot Template

The Slot Template defines the sequence of slots in the network element
configuration. In the Slot Template you give each slot a name and identify its slot
number in the network element.
To create a Slot Template
1 In the Network Element Template Details section, select the Network
Element Template name.
2 Click the Create Slot Template button.
The Create Slots window is displayed.

440
 TE M P L A T E S
Network Element Template Window

3 In the Slot Name field, enter a meaningful name for the slot. The slot names
must be unique for the template.
4 In the Sequences field, enter the slot number for the Slot Name.
5 Repeat steps 3 to 4 to define each Slot Name.
6 Click the Save button.
7 Click the Exit button.

Mapping Slots with Card Options

Mapping Slots with Card Options allows you to associate the Card Types with the
Slot Name you defined in the Slot Template.
To map Slots with Card Options
1 In the Network Element Template Details section, select the Network
Element Template name.
2 Click the Map Slots and Card Options button.
The Slots and Card Options Mapping window is displayed.
3 In the Slot Name field, use LOV to select a Slot Name that you defined in the
Slot Template.
4 In the Card Type field, use LOV to select a Card Type.
Card types are defined in the Card Models reference window.
5 Repeat steps 3 to 4 for each Slot Name.
6 Click the Save button.
7 Click the Exit button.

Creating Slot Card Templates

Once you have created the Network Element Template that defines the Card
Options and Slot Template, and maps the Slots and Card Options, you can
generate the Slot Card Template.
When you generate the Slot Card Template the Slot Names defined are displayed
and the Status for each Slot Name is set to Empty. In the Slot Card Template you
assign the Card Types to each slot and associate a Port Template Name with
circuit cards.
To create a Slot Card Template
1 In the Network Element Template Details section, select the Network
Element Template name.
2 Click the Create Slots from Slot Template button.
The Slot Names defined for the Network Element Template are displayed in
the Slot Card Template Details section.
3 Select a Slot Name.

441
TE M P L A T E S
Network Element Template Window

4 In the Card Type field, use LOV to select a Card Type.

5 If the slot is used for circuits, i.e. it is not a power or CPU slot, you can select
a Port Template. In the Port Template Name field, use LOV to select a Port
Template.
6 Repeat steps 3 to 5 for each Slot Name.
7 Click the Save button.

442
 TE M P L A T E S
Network Element Details Template

Network Element Details Template

Use this reference window to define a set of attributes that describe the
information associated with a network element relative to a service.
Before you can create records in this window, values must be entered in the
following windows:
• Manufacturers reference window. See Manufacturers on page 530
for more information on the Manufacturers window.
• Network Element Types reference window. See Network Element
Types on page 571 for more information on the Network Element
Types window.
To open the Network Element Details Templates window
• From the Inventory menu, point to Templates, and then click
Network Element Details.

Figure 20–10. Network Element Details Template window

Fields
The fields in the Network Element Details Template window are:

Field Description

Network Element Details Template

Table 20–11. Network Elements Details Templates window; fields (sheet 1 of 3)

443
TE M P L A T E S
Network Element Details Template

Field Description

Name A free text field to describe the network element

template. (Mandatory)

Manufacturer An abbreviation that identifies the manufacturer of the

network element. Use LOV to select a value. (Mandatory)

Network Element An abbreviation that identifies the network element type.

Type Use LOV to select a value. (Mandatory)

Description A free text field to further describe the use of the

template. (Mandatory)

Network Element Detail Attributes

Attribute Name The attribute name. Use LOV to select.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following:
• Alpha
• Number
• Character
• Date.

Attribute Value A value associated with the attribute.

Defined by The person that defined the attribute. Select one of the
following:
• Customer
• Engineer
• System

Table 20–11. Network Elements Details Templates window; fields (sheet 2 of 3)

444
 TE M P L A T E S
Network Element Details Template

Field Description

Optionality The status of the attribute value.

Select one of the following:
• Mandatory
The value must be entered in the Equipment
Parameters form if it is not entered here. The value
can be changed.
• Optional
The value does not have to be entered.
• Fixed
The value must be entered in the Attribute Value
field in this form. Once this value is saved it cannot be
changed.

Table 20–11. Network Elements Details Templates window; fields (sheet 3 of 3)

445
TE M P L A T E S
Equipment Feature Templates Window

Equipment Feature Templates Window

The Equipment Feature Templates window allows users to define equipment
feature templates that can be used to assign a set of service features to a network
element from the Equipment Features window of the Network Elements
screen. This functionality enables users to quickly assign multiple features to the
same kind of network elements, and saves time especially when commissioning
new switching equipment.
To create Equipment Feature Templates:

1. On the Inventory > Templates menu, click on Equipment Features. The

Equipment Feature Templates window is displayed.

Figure 20–11. Equipment Feature Templates window

Fields
The fields in the Equipment Feature Templates window are:

Field Description

Templates

Table 20–12. Equipment Feature Templates window; fields (sheet 1 of 2)

446
 TE M P L A T E S
Equipment Feature Templates Window

Field Description

Name Unique template name.

Description Free text field to further describe the use of the template.

Features

Feature Name The service feature that will be assigned to the network
element.

Total Capacity Indicates the total capacity of the network element to

support that service feature, for example how many
cards or ports.

Usable Capacity Indicates the percentage of the total capacity that will be
in% made available to support the service feature.

Category Indicated whether the selected service feature is

supported on the equipment, card, or server level. Server
level features are intended for those network elements
that are set up as server equipment.

Table 20–12. Equipment Feature Templates window; fields (sheet 2 of 2)

2. Enter a template name and description.

3. From the Feature Name LOV, select the service features that you want to
associate to the template.
4. Enter values for the Total Capacity and Usable Capacity in% fields.
5. From the Category drop-down menu, choose between Card, Equipment,
and Server to indicate the level at which the service feature will be supported.
6. Save your record.

447
TE M P L A T E S
Port Templates Window

Port Templates Window

Use this window to query, create, modify, and delete port template details.
To open the Port Templates window:
• From the Inventory menu, point to Templates, and then click Ports.
The Port Templates window is displayed.

Figure 20–12. Port Template window

Fields
The fields in the Port Templates window are:

Field Description

Template Name Unique template name.

Description Free text field to further describe the use of the template.

Port Name Generic port name, unique in the context of all network
element instances.

Port Alarm Name The Port Name displayed in alarms received by the
Alarm Management System.

Table 20–13. Port Templates window; fields (sheet 1 of 3)

448
 TE M P L A T E S
Port Templates Window

Field Description

Alarm Name Name of the stored procedure that will generate the
Procedure Alarm Name for the port.

Alias Name Name of the store procedure that will generated an alias
Procedure name for the port.

Port Usage The primary purpose of the port, e.g. alarm.

Port Cable The cable name that connects to the port.

Abbreviation

Port Speed The speed of the port.

Abbreviation

Service Type Specifies the Service type template that will be applied to
Template the port. To select a service type template to apply to the
record, double-click on this field. The Service Types
window will pop-up with the Service Templates tab in
focus. Use the LOV in the Name field (under the Frame
Template Service Templates section) to select a service
type template. See Service Types Template on page 461
for more information.
Note that the Service Types tab is disabled because the
Port Template window will only support the association
of Service Type Templates and not service types.

Port Displayed If the Port Name is to be displayed in the Clarity

Network Diagrammer and Circuit Diagrammer
applications, select Y. If the Port Name is not to be
displayed, select N.

Port Physical If the Port Name is a physical port on the card, select Y. If
the Port Name is a logical port or timeslot, select N.

Breakdown Using Used to created port templates for parent ports. Double-
click this field to display the Port Child Name window.
Use this window to select breakdown templates that
define the child port.

Count Indicates the number of templates selected in the

Breakdown Using field.

Table 20–13. Port Templates window; fields (sheet 2 of 3)

449
TE M P L A T E S
Port Templates Window

Field Description

Prefix for Child Determines whether the Parent port name is used as the
Ports prefix. You can select one of the following:
• No Prefix
• Use Parent.

Suffix for Child Specifies whether or not suffixes should be created for
Ports child ports.

Table 20–13. Port Templates window; fields (sheet 3 of 3)

Button
The button in the Port Templates window is:

Button Description

Create Port Range Opens the Create Port Range window. This window is
used to specify the range of ports for a port template. See
Create Port Range Window on page 454 for more
information about this window.

Table 20–14. Port Templates window; button

Features of the Port Templates Window

The features of the Port Templates window are:

Feature See…

Opening the Port Templates window page 448

Querying port templates page 451

Creating port templates page 451

Creating large range port templates page 452

Modifying port templates page 456

Deleting port templates page 457

450
 TE M P L A T E S
Port Templates Window

Querying a Port Template

To query a Port Template
1 Open the Port Template window.
See Port Templates Window on page 448 for further information on opening
the Port Template window.
2 Click the Query button.
This puts the window into query mode.
3 Enter your search criteria in the Template Name field.
4 Click the Query button.
The results are displayed.
5 Use the scroll bar in the top section of the window to view the retrieved port
template records.

Hint
The Port Templates window shows any records that match the search
criteria you enter. If you do not enter search criteria, all port template
records are displayed.

Creating Port Templates

This section shows how to create a Port Template that you can automatically apply
to network elements.
Use this template instead of manually creating parent and child ports within the
Network Elements window.

Note
A breakdown must exist before you can apply a port template. You should
build the templates up from the lowest level of the Parent Child Hierarchy,
i.e. if child ports exist, they need to be set up before the parent ports.

Creating Port Templates for Child Ports

To create a Port Template that contains the child ports used for a
port breakdown
1 Open the Port Templates window.
See Port Templates Window on page 448 for further information on opening
the Port Template window.
2 In the Template Name field, type a template name.
3 In the Description field, type a template description.
4 In the Port Name field, type the port name.

451
TE M P L A T E S
Port Templates Window

5 In the Port Display list, select Y if the port is to be displayed in the Clarity
Network Diagrammer and Circuit Diagrammer applications; otherwise
select N.
6 In the Port Physical list, select Y if this is a physical port; otherwise select N.
7 Click the Save button.
Complete the remaining fields for this port. See Port Templates Window on
page 448 for further information about these fields.
8 Click the Save button.
9 Repeat steps 4 to 8 for each additional child port.

Note
This template can then be selected for use as a port breakdown.

Creating Port Templates for Parent Ports

To create a Port Template that contains the parent ports
1 Open the Port Templates window.
See Port Templates Window on page 448 for further information on opening
the Port Template window.
2 In the Template Name field, type a template name.
3 In the Description field, type a template description.
4 In the Port Name field, type the port name.
5 Double-click the Breakdown Using field to display the Port Child Name
window.
6 Use the LOV to select the port templates that define the child port that you
want to use for the breakdown.
7 Click the Exit button to populate the Breakdown using field.
The Count field is automatically populated with the number of templates
used.
8 In the Prefix for Child Ports field, select No Prefix if you do not want the
child port names to be prefixed with the parent port name. Select Use
Parent to prefix the child port names with the parent name.
9 Click the Save button.

Creating Large Range Port Templates

This section shows you a fast method for creating port templates that contain
many records. These types of port templates can be built quickly using the Create
Port Range window.
Use this window to enter a range of sequential entries that create port templates
without individually entering all port numbers.

452
 TE M P L A T E S
Port Templates Window

Using the Create Range Window to Create Port Templates

To create a port template that contains many entries
1 Open the Port Templates window.
See Port Templates Window on page 448 for further information on opening
the Port Template window.
2 In the Template Name field, enter a unique name for the port template.
3 In the Description field, enter a description for the port template.
4 Click the Save button.
5 Click the Create Port Range button.
The Create Port Range window is displayed.
Port names are created by adding a prefix or suffix to a range of numbers.
For example, for a range of port names from P-01 to P-16: P- is the Prefix, 1
is the From Port number, and 16 is the To Port number.
– In the From Port field, type the first number in the port name range.
– In the To Port field, type the last number in the port name range.
– In the Prefix field, type a prefix for all port names.
– If required, in the Suffix field, type a suffix for all port names.
– The Left pad the port with the character and Left pad the port to a
width of n characters fields are automatically updated to ensure all
port names are the same length. You can change the values in these
fields.
6 Complete the remaining fields for the ports. See Create Port Range Window
on page 454 for more information about these fields.
7 Click the OK button.
The Port Names are generated.
8 Click the Save button.

453
TE M P L A T E S
Port Templates Window

Create Port Range Window

The Create Port Range window allows you to enter a range of sequential entries
to create port templates without entering all port numbers individually.

Figure 20–13. Create Port Range window

Fields
The fields in the Create Port Range window are:

Field Description

From Port The first port number in the Port Template range.

To Port The last port number in the Port Template range.

Prefix The prefix for the port name.

Suffix The suffix for the port name.

Left pad the port The character that is used to pad the port number.
with the character

Table 20–15. Create Port Range window; fields (sheet 1 of 3)

454
 TE M P L A T E S
Port Templates Window

Field Description

Left pad the port to The minimum length of the port name. If the port name
a width of n is less than this value, the port name is suffixed with one
characters or more pad characters to make the length the same
number of characters specified in this field.

From Alarm The first alarm port number in the Port Template range.

To Alarm The last alarm port number in the Port Template range.

Alarm Prefix The prefix for the Alarm Management System port name.

Alarm Suffix The suffix for the Alarm Management System port name.

Left pad the alarm The character used to pad the port name to be received
with the character by the Alarm Management System.

Left pad the alarm The minimum length of the Alarm Management System
to a width of n port name. If the port name is less than this value, the
characters port name is suffixed with one or more pad characters to
make the length the same number of characters
specified in this field.

Procedure to When executed, generates alarm names for the port.

generate Port
Alarm Name

Procedure to When executed, generates port alias names for the port.
generate Alias
Name/Domain

Port Cable The cable name that connects to the port.

Abbreviation

Port Usage The primary purpose of the port, e.g. alarm.

Port Speed The speed of the port.

Abbreviation

Port Displayed If the Port Name is to be displayed in the Clarity

Network Diagrammer and Circuit Diagrammer
applications, select Y. If the Port Name is not to be
displayed, select N.

Table 20–15. Create Port Range window; fields (sheet 2 of 3)

455
TE M P L A T E S
Port Templates Window

Field Description

Port Physical If the Port Name is a physical port on the card, select Y. If
the Port Name is a logical port or timeslot, select N.

Service Type Use LOV to select the Service Type Template that will be
Template applied to the port.

Breakdown using Select an existing Port Template that defines the child
template ports in order to breakdown all ports in the current
parent Port Template you are creating.

No Prefix or Parent Used to determine whether that Parent Port Name is

Prefix used as the prefix. Select either:
• No Prefix
• Use Parent.

Generate Suffix for Specifies whether or not suffixes should be created for
Child Ports child ports.

Table 20–15. Create Port Range window; fields (sheet 3 of 3)

Additional Functions
In addition to creating a port template by specifying the range of port numbers,
the Create Port Range window can also use an existing template to breakdown
all ports in the template you are creating.

Modifying a Port Template

To modify a Port Template
1 Query a Port Template.
See Querying a Port Template on page 451 for more information on
querying a port template.
2 Use the scroll bar to select the port template you want to modify.
3 Click in the field that you want to modify.
4 Highlight the information you want to change.
5 Enter the new information, then click the Save button.

Hint
Template Names cannot be modified.

456
 TE M P L A T E S
Port Templates Window

Deleting a Port Template

To delete a Port Template
1 Query a Port Template.
See Querying a Port Template on page 451 for more information on
querying a port template.
2 Use the scroll bar to select the port template that you want to delete.
3 Click the Template Name field.
4 Click the Delete button.
5 Click the Save button.

Hint
Child Ports are deleted with parent ports.

You cannot delete parents if the parent or child has a circuit assigned.

457
TE M P L A T E S
Port Details Templates

Port Details Templates

Use this reference window to define the attributes for a port based on the
manufacturer, equipment type and service type.
Before you can create records in this window, values must be entered in the
following reference windows:
• Port Validation. See Port Parameter Validation on page 578 for more
information on the Port Validation window.
• Manufacturers. See Manufacturers on page 530 for more
information on the Manufacturers window.
• Network Element Types. See Network Element Types on page 571
for more information on the Network Element Types window.
To open the Port Details Template window
• From the Inventory menu, point to Templates, and then click Port
Details.

Figure 20–14. Port Details Template window

Fields
The fields in the Port Details Templates window are:

Field Description

Port Details Template

Table 20–16. Port Details Templates window; fields (sheet 1 of 3)

458
 TE M P L A T E S
Port Details Templates

Field Description

Name A descriptive name for the template. (Mandatory)

Manufacturer The manufacturer of the network element. Use LOV to

select a value. (Mandatory)

Network Element An abbreviation that represents the network element

Type type. Use LOV to select a value. (Mandatory)

Description A free text field to further describe the use of the

template. (Mandatory)

Port Detail Attributes

Attribute Name The port parameter validation name.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following from the drop-
down list:
• Alpha
• Number
• Character
• Date.

Attribute Value The value of the port attribute.

Defined by The person that defined the attribute value.

Select one of the following from the drop-down list:
• Customer
• Engineer
• System.

Table 20–16. Port Details Templates window; fields (sheet 2 of 3)

459
TE M P L A T E S
Port Details Templates

Field Description

Optionality The status of the attribute value.

Select one of the following from the drop-down list:
• Mandatory
Value must be entered in the Port Parameters form if
it is not entered here. The value can be changed.
• Optional
Value does not have to be entered.
• Fixed
Value must be entered in the Attribute Value field in
this form. Once this value is saved it cannot be
changed.

Table 20–16. Port Details Templates window; fields (sheet 3 of 3)

460
 TE M P L A T E S
Service Types Template

Service Types Template

In Clarity OSS, the automated reservation capability 'Facility Reservation' reserves
network infrastructure required to provision customer services. This automated
process requires that certain information be loaded against the network
infrastructure to enable the 'Facility Reservation' application to determine the best
possible path to use when determining service delivery capability and reserving
the appropriate network path. To enable reservation tracing, Service Types are
linked to Network Elements, Cards, Ports, Frame Containers, Frame Units and
Frame Appearances in a hierarchical manner i.e. for a Network Element, all
services that the NE can support are identified, then for each Card, a subset of
these services are identified, then for each Port a further subset is identified.
Currently, individual services are linked at the various levels within the Network
Element and Frame Infrastructure leading to a significant over head in larger
networks.
For example, a Port inherits its supported Services from its parent entities (Cards
and NE). If a Card has eight Ports and each Port is to support fifteen different
Service Types, then these individual Services Types must be linked to each Port in
turn, resulting in 120 (8 x 15) records being created even if the Services on each
Port are identical. If the user wants to make changes in this model, the user must
select each Port in turn and update the associated Service Type data.
The Service Type Template functionality allows the user to define one or more
templates, and each template will capture a set of Service Types that will be
supported on a per NE, Card, Port, Frame Container, Frame Unit or Frame
Appearance perspective. A single template definition is linked to each entity and
this template will contain a set of supported Services rather than individual
Services being linked at the various levels within the Network Element and Frame
Infrastructure. The template is linked at the lowest level, e.g. Ports, meaning
thereby that only one data set will need to be changed to affect a change for
thousands of Ports. Any changes to a Service Template will also flow through to
thousands of related entities at all levels in the database.
The following business rules will apply on all user applications that display Service
Details, for example the Network Elements window, Frames window, and so on:
• If the object has a Service Type Template, the name of that template
will be displayed otherwise the existing rule will apply and the highest
priority Service Type will be displayed.
• Double clicking on the Service Types field will display a two-tabbed
Service Type window. The first tabbed region will display the Service
Type Template associated with the selected entity and its underlying
Service Types. The second tabbed region will display the Service Type
and Priority details.
• The user can enter data into just one of these two tabs. The user will be
allowed to link either a service template definition or a set of services
types against an object, not both.
• If there is no existing data and the user is creating or linking to a new
Service Template definition and the user attempts to create a Service

461
TE M P L A T E S
Service Types Template

Types definition rather than the new Service Template definition, a

warning message will be displayed advising the user to select an
existing Service Types Template or to define a new Services Types
Template rather than defining individual instances of Service Types.
To create Service Type Templates
• From the Inventory menu, point to Templates and then click Service
Types. The Service Types Template window is displayed.

Figure 20–15. Service Type Template window

462
 TE M P L A T E S
Service Types Template

Fields
The fields in the Service Type Template window are:

Field Description

Service Type Template

Name A descriptive name for the service type template.

Description A meaningful description of the service type template.

Service Types Instance Definition

Service Type The service type supported, such as PSTN, ADSL, and so
on.

Service Type Description of the Service Type

Description

Priority The order of selection priority when choosing a NE to

support or supply the service.

Table 20–17. Service Type Template window; fields

• Enter a name and description for the Service Type template.

• From the Service Type LOV, select a Service Type that will be supported
on the network element, card, port or frame that the template will be
associated with. The Service Type field will be populated
automatically based on the Service Type definition.
• Enter a priority in the Priority field.
• Save the template.
Note the following:
– User can create Templates with different names but containing the same
sets of service types.
– Templates with the same name are not allowed; an error message will
be displayed if the user attempts to create a duplicate template name.
– Once defined, a template cannot be deleted if it is being used by an
existing database object. A message will be displayed identifying at
least one object that the template is currently linked to.
– Templates can be associated with the network element, card, port,
frame container, frame unit, and frame appearance through the

463
TE M P L A T E S
Service Types Template

functions available in the Network Elements and Frames windows

respectively.
– At the Frame Unit, Frame Appearance, Card, and Port level, users can
only assign templates that have been associated with its parent level.
For example, at the card level, users can only choose to associate a
service type template that is associated with the parent network element.
However, if a new card or frame unit, linked to a different service type
template, is added or copied, the new service type template will be
automatically added at the parent level.
– While multiple templates can be associated at the network element,
card, frame container and frame unit level, only one service type
template can be associated at the port and frame appearance level.
Also, when defining port templates or frame appearance templates to
create ports and frame appearances, only one service type template can
be associated with the template.

Note
Templates can only be created, deleted, or updated by users having a CM
Data Manager Role or SM Data Manager Role. Templates can be
associated to a Port, Card or Network Element by any user assigned a
CM_Maintenance role.

464
 TE M P L A T E S
Trunk Group Details Template

Trunk Group Details Template

Use this window to define a set of attributes that describe the information
associated with a trunk group.
Before you can create records in this window, values must be entered in the
following window:
• Trunk Group Parameter Validation reference window. See Trunk
Group Parameter Validation on page 536 for more information.
To open the Trunk Group Details Templates window
• From the Inventory menu, point to Templates and then click Trunk
Group Details Template.

Figure 20–16. Trunk Group Details Templates window

Fields
The fields in the Trunk Group Details Template window are:

Field Description

Trunk Group Details Templates

Name A descriptive name for the trunk group details template.

Switching Equipment The equipment type. Use LOV to select a value.

Table 20–18. Trunk Group Details Template window; fields (sheet 1 of 2)

465
TE M P L A T E S
Trunk Group Details Template

Field Description

Manufacturer The manufacturer’s name. Use LOV to select a value.

Description A free text field to further describe the use of the

template.

Trunk Group Detail Attributes

Short Name The trunk group parameter validation name. Use LOV
to select a value.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following:
• Alphabetic
• Numeric
• Character
• Date

Attribute Short Value Abbreviated attribute value, e.g. SCR.

Attribute Long Value Attribute value in long form, e.g. Same Cost Region.

Defined by The person that defined the attribute. Select one of the
following from the drop-down list:
• Customer
• Engineer
• System.

Optionality The status of the attribute value

• Mandatory
The value must be entered in the Trunk Group
Parameters window if it is not entered here. The
value can be changed.
• Optional
The value does not have to be entered.
• Fixed
The value must be entered in the Attribute Value
field in this form. Once saved, this value cannot be
changed.

Table 20–18. Trunk Group Details Template window; fields (sheet 2 of 2)

466
 CHAPTER 21

Areas

This section describes how to use the Areas window to:

• define exchange based or service provisioning hierarchies
• define parent and child area records
• query area records
• query associated locations, service types and work groups
• delete area records

467
AREAS
Areas Overview

Areas Overview
Areas are used to provide logical groupings of the geographical or exchange
based locations. For example,
– regional telecom offices (RTOMs)
– local exchange area (LEAs)
– exchange codes (ECs)
The relationship between these areas is hierarchical, e.g. one RTOM can have
many associated LEAs, and one LEA can have many associated ECs. Locations
and Work groups can be assigned to any level in the hierarchy. Such hierarchies
are mainly Service Provisioning hierarchies and it is based on this area >
locations > service type > work group association that service orders are
assigned during service provisioning or service assurance.
To create a service provisioning or exchange based hierarchy, the user must:
• Define the hierarchy and the area types that will be part of the
hierarchy using the Area Types reference data window. See “Area
Types” on page 527.
• Create instances of the areas at various levels of the hierarchy using
the Areas window
• Assign locations and set up work group details

468
 AREAS
Areas Overview

Areas Window
To open the Areas window
• From the Inventory menu, select Areas.
The Areas window is displayed.

Figure 21–1. Areas window

Fields
The fields in the Areas window are:

Field Description

Hierarchy Select the hierarchy which you are creating or

modifying from the drop-down list. The list of values
will display the hierarchies defined by the user in the
Area Types reference data window.

Parent Area Search Criteria

Table 21–1. Areas window fields (sheet 1 of 2)

469
AREAS
Areas Overview

Field Description

Search Click on this check box when creating or querying

parent areas to display the following fields:
• Type - the area type of the parent area, e.g. RTOM
(EXC hierarchy).Use LOV to select a value.
• Area - the parent area. Use LOV to select a value.

Description A description of the area. This field is automatically

populated if an area is selected in the Parent Area
search criteria field.

Areas

Code The code that represents the area. (Mandatory)

Type Valid area type. Use LOV to select a value.

Area types for the selected hierarchy are set up in the
Area Types reference window. See Area Types on
page 527 for more information.

Parent This field is automatically populated with the parent

information selected in the RTOM parent name. This
field is empty if the area is the top-most level in the
hierarchy, e.g. RTOM.

Description Free text field to further describe the area. (Mandatory)

Location Details

Code A unique code that identifies the site.

Description The description of the location.

Type The grouping type assigned to the location.

Table 21–1. Areas window fields (sheet 2 of 2)

470
 AREAS
Features of the Areas Window

Features of the Areas Window

The features of the Areas window are:

Feature See...

Opening the window page 468

Creating area records page 472

Querying an area record page 477

Deleting an area record page 478

471
AREAS
Creating an Area Record

Creating an Area Record

The following procedures describe how to create exchanged-based hierarchy of
parent and child area records in the Areas window.

Note
When a Location is linked to either an area in the Locations window, brief
details of the record are displayed in the Location Details section.

Creating RTOM Records

RTOM are parent records and can have multiple child LEA records assigned to
them.
To create a parent area record
1 Open the Areas window.
See Areas Overview on page 468 for more information.
2 Choose the Hierarchy type from the drop-down list, for example the
Exchange Hierarchy. The Exchange Hierarchy and the area types that will be
contained within it must already have been set up in the Area Types
reference data window. Available RTOMs are displayed in the Areas section.
3 Click the Insert button to add a new RTOM record.
4 Type a unique code in the Code field.
If the area code is not unique, an error message is displayed when you
attempt to save the record.
5 In the Description field further describe the area.
6 Click the Save button.
7 Double-click on the new parent in the Areas section and the Type is
automatically set to the next level down in the hierarchy, e.g. LEA, and
Parent field is populated with the new parent name, ready for the creation of
child areas.

Creating LEA Records

LEA records are always related to a single RTOM record. You must select the
parent RTOM record before you can create the child LEA record. LEA records can
have multiple child EC records.
To create a LEA record
1 Open the Areas window.
See Areas Overview on page 468 for more information.
2 Choose the Hierarchy type of EXC from the drop-down list.
3 Click on the Search box in the Parent Area Search Criteria section.

472
 AREAS
Creating an Area Record

4 Query an RTOM record by selecting a Type of RTOM and the Area from the
LOVs.
See Querying an Area Record on page 477 for more information.
5 The parent RTOM name displays in the Parent field of the Areas section, the
Type is changed to the next level down, e.g. LEA, and the State field is
automatically populated from the parent area.
6 Type a unique code in the Code field.
If the area code is not unique an error message is displayed when you
attempt to save the record.
7 In the Description field further describe the area.
8 Click the Save button.
9 Double-click on the new LEA in the Areas section and the Type is
automatically set to the next level down in the hierarchy, e.g. EC, and the
Parent field is populated with the new LEA name, ready for the creation of
EC child areas.

Creating EC Records
EC records are always related to a single LEA record. You must select the parent
LEA record before you can create the child EC record.
To create a LEA record
1 Open the Areas window.
See Areas Overview on page 468 for more information.
2 Choose the Hierarchy type of EXC from the drop-down list.
3 Query an LEA record.
See Querying an Area Record on page 477 for more information.
4 Type a unique code in the Code field.
If the area code is not unique an error message is displayed when you
attempt to save the record.
5 In the Description field describe the area further.
6 Click the Save button.

Creating Geographical based Parent Records

Geographical based areas records are created in the same way as exchange-
based areas. Parent records can have multiple child records assigned to them.
To create a geographical based parent area record
1 Open the Areas window.
See Areas Overview on page 468 for more information.

473
AREAS
Creating an Area Record

2 Choose a Hierarchy type from the drop-down list. For a geographical-based

hierarchy, select GEO. Available top level parent areas are displayed in the
Areas section, e.g. Country type.
3 Click the Insert button to add a new parent record.
4 Type a unique code in the Code field.
If the area code is not unique, an error message is displayed when you
attempt to save the record.
5 In the Description field further describe the area.
6 Click the Save button.
7 Double-click on the new parent in the Areas section and the Type is
automatically set to the next level down in the hierarchy, e.g. State, and the
Parent field is populated with the new parent name, ready for the creation of
child areas.

Assigning Work Groups to Areas

You can use the Provisional Work Groups Details tab and the Inventory/Other
Work Groups tab to assign work groups for the various services available in the
area. Each service type may have a number of assigned work groups that perform
different functions.
For example, Area 1 may provide an ADSL service type. You could assign a work
group that was responsible for outside plant related tasks, another that was
responsible for exchange related tasks and another that was responsible for
billing tasks.
To assign a Provisional work group to an area:
1 Query an RTOM or GEO type record.
See Querying an Area Record on page 477 for more information.
2 Select the required record in the Area section.
3 Click the Provisioning Work Groups tab

Figure 21–2. Provisioning Work Groups tab window

474
 AREAS
Creating an Area Record

4 Use the List of Values to enter the required values in the Service Type, Work
Group Name and Work Group Type columns.

Hint
Use the button heading in each of the Provisional Work Groups tab
columns to toggle the sort order of displayed records in ascending order.

5 Click Save.

Fields Descriptions

Service Type The type of service available in the selected area. Use List
of Values to select a value. (Mandatory)
Service types are set up in the Service Definition
reference window. Refer to the Clarity Provisioning Suite
User Manual for more information.

Work Group Name The name of the provisioning work group assigned to
carry out work for the select service type. Use the List of
Values to select a value. (Mandatory)
Work groups are set up in the Work Groups window.
Refer to the Getting Started with Clarity OSS for more
information.

Work Group Type The type of work carried out by the work group, e.g.
Billing. Use the List of Values to select a value.
(Mandatory)
Work group types are set up in the Work Group Types
reference window. Refer to the Getting Started with
Clarity OSS for more information.

Table 21–2. Field descriptions for Provisioning Work Groups tab window

To assign a Inventory/Others Work Group to an area:

1 Query an RTOM or GEO type record.
See Querying an Area Record on page 477 for more information.
2 Select the required record in the Area section.

Hint
Use the button heading in the Inventory/Others Work Group tab
column to toggle the sort order of displayed records in ascending order.

475
AREAS
Creating an Area Record

3 Click the Inventory/Others Work Groups tab.

Figure 21–3. Inventory/Others Work Groups tab window

4 Use the List of Values to enter the work group name in the work group
column.
5 Click Save.

Fields Description

Work Group Name The name of the inventory/others work group assigned to
carry out work for the select service type. Use the List of
Values to select a appropriate work group. (Mandatory)
Work groups are set up in the Work Groups window.
Refer to the Getting Started with Clarity OSS for more
information.

Table 21–3. Field Descriptions for Inventory/Others Work Groups tab window

476
 AREAS
Querying an Area Record

Querying an Area Record

The following procedures describe how to search for parent and child area
records in the Areas window.

Hint
Read the Hint text on the Status Bar to determine if you are in query mode.

Querying Parent Area Records

The following procedure describes how to search for an parent area record.
To query an area record
1 Open the Areas window.
See Areas Overview on page 468 for more information.
2 Select a hierarchy type in the Hierarchy field from the drop-down list, e.g.
EXC (exchange based) or GEO (geographic).
3 Click the Query button.
This places the window in query mode.
4 Enter your search criteria in the Areas section.
Use the% character as a wildcard, for example, entering SM% would display
all records that start with SM or select a value from any available LOVs.

Hint
To display all records leave the search area blank.
5 Click the Query button again.
6 Use the scroll bar to view all of the matching records.

477
AREAS
Deleting Area Records

Deleting Area Records

The following rules apply to deleting exchanged-based area records.
RTOM records cannot be deleted if the record has:
• linked locations
• defined work group details
• child LEA records.
LEA records cannot be deleted if the record has:
• linked locations
• defined work group details
• child EC records.
EC records cannot be deleted if the record has:
• linked locations
• defined work group details.
To delete an area record
1 Query the area record.
See Querying an Area Record on page 477 for more information.
2 Select the record you want to delete
3 Click the Delete button.
4 Click the Save button to save your changes.

478
 CHAPTER 22

Regions

This chapter describes how to set up the Region Hierarchy or geographic

Hierarchy in the Inventory Module.

479
REGIONS
Regions Overview

Regions Overview
The Regions window allows users to set up a hierarchy of physical locations or
geographic hierarchy for their telecommunication network. Region Hierarchy
must be set up to support Faults, Equipment Locations and Realms.
The structure below provides an example of a Regions Hierarchy:

Figure 22–1. Region Hierarchy - Example

Locations can only be assigned to the lowest node of a Region Hierarchy.

480
 REGIONS
Regions Overview

Regions Window
To access the Regions window, on the Inventory menu, click on Regions. When
there is no Regions data, the Regions window is displayed with the message:
Error:There is no region domain defined in Area Types. See example below.

Figure 22–2. Regions window

481
REGIONS
Regions Overview

Setting up Regions Data

To set up a Region hierarchy, the user must:
• Define the hierarchy and the area types that will be part of the
hierarchy using the Area Types reference data window, for example:
– Country
– State
– City, and so on
See “Area Types” on page 527.
• Migrate the data to the Regions table and the Regions window. For
instructions, refer to the migration process described in “Migrating an
existing Geographic Hierarchy” on page 482.
• Add the geographical areas to the various levels in the hierarchy. See
“Adding Areas to the Hierarchy” on page 489
• Add locations to the lowest level of the hierarchy if required

Note
Clarity recommends that if users have an existing Geographic Gierarchy
set up in their Clarity databse, they migrate the existing geographic
hierarchy to the Regions table. If the user tries to create a new hierarchy,
the Area Type code being unique, if an area type has already been used
in the an existing geographic hierarchy, they will not be able to reuse it in
the new hierarchy. Unless you intend to create a new Region Hierarchy
with a different set of area types, do not use this option.

Migrating an existing Geographic Hierarchy

If the user has an existing Geographic Hierarchy defined in the Clarity database,
they can migrate the Geographic Hierarchy as their Region Hierarchy and
populate the Regions table and Regions window.
To migrate an existing Geographic Hierarchy:

482
 REGIONS
Regions Overview

1. On the Inventory > Reference Data menu, click on Area Types. The Area
Types window is displayed.

Figure 22–3. Area Types window

483
REGIONS
Regions Overview

2. The user can do one of the following:

Option 1
i. Select the Region Hierarchy check box. A message will be displayed to
the user notifying that no Regions data exists and asking if an existing
geographical hierarchy needs to be migrated. See example below.

Figure 22–4. Migrate data message

ii. Click Yes to continue.

iii. A Regions Migration pop-up window is displayed prompting the user to
select the geographic area to migrate.

484
 REGIONS
Regions Overview

Figure 22–5. Regions Migration pop-up window

Note that if only one geographic hierarchy is defined in the database,

the same will be automatically populated in the selection list box in the
Regions Migration window.
iv. Select Migrate to trigger the data migration.
Option 2
i. Optionally, in the Area Types window, query the Geographic Hirarchy
that you would like to migrate.

Figure 22–6. Select Geographic Hierarchy to migrate

ii. Select the Region Hierarchy check box. The same notification message
displayed in Option1 will be displayed.

Figure 22–7. Message Displayed

485
REGIONS
Regions Overview

i. Click Yes to continue.

ii. The Regions Migration pop-up window is displayed with the selected
geographic area automatically populated.

Figure 22–8. Geographic Area selected for migration

iii. Click on Migrate to trigger the migration.

3. Once data migration is completed successfully, a message will be displayed
indicating the number of records that were migrated. see example below:

Figure 22–9. Migrated Records No. display

486
 REGIONS
Regions Overview

4. On the Inventory menu, click on Regions to open the Regions window. The
Regions window will now display the migrated Regions Hierarchy.

Figure 22–10. Regions Hierarchy Display

Note
The migration process will migrate all the nodes of the selected
Geographic Hierarchy as well as all locations that are assigned to the
lowest level of the hierarchy.

When the migration is complete, the Region field in the Locations screen will
be automatically populated with the Region code it is associated with.

487
REGIONS
Regions Overview

The fields in the Regions window are:

Field Description

Code Search field that allows the user to query and display a
specific node in the Region Hierarchy using the area
type code as the search parameter, for example the
instance of the city or state or postcode. The tree on the
left pane will be expanded with the selected node in
focus and the same will also be displayed in the
Regions block on the right. To search, enter the area
type code and then click Search.

Hierarchy name The read-only field under the Search field which is
display automatically populated with the node currently in
focus. As the user drills down the hierarchy, the nodes
are automatically added to this display field.

Tree View Displays the objects in the Regions Hierarchy. By

default, the tree is collapsed to display only the parent
nodes. As the user drills down the hierarchy in the tree
view, the Regions and Locations block is
automatically refreshed with the corresponding data.

Regions

Code The code that represents the instance of the area type
or node.

Description Description of the area.

Parent Code The code of the parent node. This field is empty if the
node selected is the top-most level in the hierarchy.

Area Type Code The Area type as set up in the Area Types reference
data window.

Location (read-only area)

Code A unique code that identifies the site.

Description The description of the location.

Type The grouping type assigned to the location.

Table 22–1. Regions window;fields

488
 REGIONS
Regions Overview

5. To drill down to the lower levels in the hierarchy, use the tree view. Optionally,
double-click on the Code field to drill down to the next level in the hierarchy or
double-click on the Parent Code field to navigate to the parent node.

Figure 22–11. Hierarchy display

Adding Areas to the Hierarchy

You can add areas to any node in the Regions Hierarchy using the Regions
window. To add a new record
i. Select the level at which you want to add the record.
ii. Under the Regions block, click on an empty field to insert a new record.
Optionally, click on the Insert Record icon to create a new record. Note
that the Area Type Code will be automatically populated with the

489
REGIONS
Regions Overview

relevant area type at that level. If a parent node exists, the Parent Node
field will also be populated.

Figure 22–12. Insert new record

iii. Enter the new area details and save your record. The area will be added
to the Regions Hierarchy and displayed on the Tree View.

490
 REGIONS
Regions Overview

Figure 22–13. New record creation

Deleting Nodes
To delete areas assigned to the hierarchy:
• Select the record under the Regions block.
• Click on the Delete icon to delete the selected record.

Note
Areas which have locations assigned to it cannot be deleted.

491
REGIONS
Regions Overview

Adding Locations
Locations can only be added to the lowest level of a Regions Hierarchy.
i. To add locations to the areas, on the Inventory menu, click on
Location/Sites to open the Locations window.
ii. Select the location that you want to assign to a node in the Regions
Hierarchy.

Figure 22–14. Locations window

iii. In the Regions field, use the LOV to select the area code of the area.
Note that the LOV will display only the area codes of the areas in the
lowest level of the Regions Hierarchy.

492
 REGIONS
Regions Overview

Figure 22–15. Area Codes Display

iv. Select the area code and click OK. Save your Locations record.

493
REGIONS
Regions Overview

Figure 22–16. Region code assigned to Location

v. In the Regions window, query the area code that you assigned a
location to.

Figure 22–17. Query Region Code

The Locations block will be populated with the details of the location
assigned to that area. See example below.

494
 REGIONS
Regions Overview

Figure 22–18. Locations Display

Optional Functionality
In special circumstances, users can also choose to do the following:
Select an existing hierarchy as the Regions Hierarchy but not migrate the
data
If the user has an existing Geographical Hierarchy but does not want to migrate
the data immediately (for example, when the user is not satisfied with the current
structure of the Geographical Hierarchy) , they can select it as the potential
hierarchy for their Regions table and migrate the data later on. To do so:
1 In the Area Types reference data window, select the Geographic Hierachy
that you would like to migrate in the future.
2 Select the Region Hierarchy check box. The following message will pop-up.

495
REGIONS
Regions Overview

3 Select No.
The selected Geographical Hierarchy will be the default hierarchy available
for migration.
4 When you want to migrate the data, in the Area Types reference data
window, query for the record. Unselect and then select the Region
Hierarchy check box to display the data migration message. Continue as
described in Scenario 1.

496
 CHAPTER 23

Locations/Sites

This section describes the Locations/Sites menu option within the Clarity
Inventory Suite.

497
LOCATIONS/SITES
Locations Window

Locations Window
Use this window to view, edit and enter details about a locations or site. In Clarity
a Location (or site) entity represents the location of equipment, infrastructure or
customer services. A location is the physical site or address and can be linked to
any node of the Exchange or Service Hierarchy and only the lowest node or
branch of the Geographical area hierarchy. Area hierarchies are created in the
Areas window to logically group locations and facilitate inventory management,
service provisioning, and service assurance. Geographical or Region Hierarchy is
created using the Region window to create a hierarchy of actual physical
locations. The following must be noted:
• Locations must be associated with the lowest branch of a
'Geographical' Hierarchy.
• Child Locations must be associated with the same Area as its parent
• If a user extends a Geographic hierarchy by adding new levels then
they must manually move all Locations from their previous Area
Associations to the new, lower level branches.
• The Clarity system, if resolving a Location to an Area Hierarchy will
only search upwards from the Area associated with the Location.
A Child Location is used to provide greater granularity within a site, for example
to define a specific floor, room or other sub location. A child Location is not to be
used to create Location groups that do not physically relate to a physical site or
address.

498
 LOCATIONS/SITES
Locations Window

To open the Locations window

• From the Inventory menu, select Locations/Sites.
The Locations window is displayed.

Figure 23–1. Locations window

The Locations window has the following tabs:

Section See…

Locations tab 499

Child Locations tab 504

Locations tab
This tab is used to enter details of the parent Location, which is any location where
equipment is situated, for example Central Office, POP, Base Station, Customer
Site.

499
LOCATIONS/SITES
Locations Window

Fields
Fields in the Locations tab are:

Field Description

Location Details

Name The name that identifies this site. (Mandatory)

Description Full free text description of the site. (40 alpha-numeric

character maximum) (Mandatory)

Details Further details about the location.

Type The location type is a classification of the site, e.g. nodes,

admin, customer, other Carrier etc. Use LOV to select an
option. Data for this field is set up in the Location/Site
Types reference window. (Mandatory)

Nodes Select Yes or No from the drop down list to indicate if

there are nodes at this location. (Mandatory)

Code This field determines the provisioning area code, ex:-

identifies to which provision area the location code is
mapped to. Use LOV to select an area code. The LOV will
also display the description, area type and parent area
code to allow the user to make a more informed
selection.

Table 23–1. Locations tab fields (sheet 1 of 5)

500
 LOCATIONS/SITES
Locations Window

Field Description

Region This field allow users to map a physical location code to

the lowest level of the geographical area hierarchy.
Identifying the physical location is necessary because
circuit and network diagrammer need to understand that
the location code assigned to the geographic area is a
physical location and all objects associated with this
location code are physical entities.
Use LOV to select the Region code. By default, the LOV
will display the lowest nodes of all the branches in a
Geographic Hierarchy.(Optional).
Note: Child Locations inherit the Region code and area
Code from the parent Locations. That is, the values
selected in the Region and Code field under the
Locations tab will be automatically populated in
the Region and Code field under the Child
Locations tab.

Latitude Coordinate representing the location of the place north

or south of the equator. A set of four input fields are
provided for the user to enter the degree, minutes,
seconds, and direction that will define the latitude. The
various symbols represent the following:
? - input field for Degree
' - input field for Minutes
'' - input field for Seconds
Direction- drop-down to select either North or South
Note the following:
• Latitude Degree values range from 0 to 90 (always
positive
• Minute values range from 0 to 59 (always positive)
• Second values range from 0 to 59 (always positive)
When a user enters or updates the Latitude data, the
entered data is converted to a <± degree.decimal
value> format and stored in the database.
This is not a mandatory field. All the Clarity Workbench
users need to enter this data to ensure that the location is
accurately displayed on the map in the Geographical
View of Clarity Workbench.

Table 23–1. Locations tab fields (sheet 2 of 5)

501
LOCATIONS/SITES
Locations Window

Field Description

Longitude Geographic coordinate used for east-west measurement.

A set of four input fields are provided for the user to enter
the degree, minutes, seconds, and direction that will
define the longitude. The various symbols represent the
following:
? - input field for Degree
' - input field for Minutes
'' - input field for Seconds
Direction- drop-down to select either East or West
Note the following:
• Longitude Degree values range from 0 to 180 (always
positive)
• Minute values range from 0 to 59 (always positive)
• Second values range from 0 to 59 (always positive)
Similar to the Latitude field, this is not a mandatory
parameter however Clarity Workbench users need to
enter this data to represent a location accurately in the
Geographical view.
Note:
Until now, users were able to specify the latitude and
longitude for a location using the Clarity Network
Diagrammer module. However, from this release
onwards, Network Diagrammer will no longer provide
that capability hence the X and Y coordinates must be
specified using the Locations form.

Contact Points

Type The method of communicating with the contact point.

Use the List of Values (LoV) to select an option.
(Mandatory)

Number The preferred phone number for the contact person.

(Mandatory)

Hours The hours in the day that the preferred phone number for
the contact person is available. (Mandatory)

Availability The day of the week or the time of day the contact person
is most likely to be available. (Mandatory)

Table 23–1. Locations tab fields (sheet 3 of 5)

502
 LOCATIONS/SITES
Locations Window

Field Description

Contact Persons

Name The name of the contact person. (Mandatory)

Description A description of the contact person’s job classification.

Address Details

Post Code The zip/postal code for the area. Use LOV to select a
value. These values are set up in the Post Codes
reference window. Refer to Getting Started with Clarity
OSS for more information. (Mandatory)

Suburb The name of the suburb. Use LOV to select a value.

These values are set up in the Post Codes reference
window.

State The name of the state. Use LOV to select a value. These
values are set up in the Post Codes reference window.

Street Number The street number.

Street Name/Type The name of the street. (Mandatory)

City Free text Town or City name. Use LOV to select a value.
These values are set up in the Post Codes reference
window.

Country The country name. Use LOV to select a value. These

values are set up in the Post Codes reference window.

Customers at Location

Customer Code The unique code associated with the customer. This field
is automatically populated when there are customer
details associated with the location.

Customer Name The full customer name. This field is automatically

populated.

Table 23–1. Locations tab fields (sheet 4 of 5)

503
LOCATIONS/SITES
Locations Window

Field Description

Customer Type The customer type, e.g. Business. This field is

automatically populated.

Table 23–1. Locations tab fields (sheet 5 of 5)

Buttons
The buttons in the Locations tab are:

Button Description

Add/Get/View Full Opens the Address Maintenance window used to

Add maintain addresses used in a variety of windows across
the Clarity system.

Attach and View Opens the File Attachments window, used to link a
Files location to a related external document. See Getting
Started with Clarity OSS for more information on creating
and deleting links to external files.

Other Names Opens the Location Other Names window, used to

assign an alternate name/reference to a location. See
Assigning Alternate Names to Locations on page 514 for
more information.

Costed Items Opens the Costed Item List for Location window. See
Creating and Querying Costed Items on page 511 for
more information.

Attributes Opens the Location Attributes window, used to specify

attributes of a location.

Table 23–2. Locations tab buttons

Child Locations tab

Use this tab to enter and view location/site record data for child locations. Floors
or room in the same parent location is the only supported use for a child location.

Fields
Fields in the Child Locations tab are the same as the Locations tab. See
Locations tab on page 499 for more information.

504
 LOCATIONS/SITES
Locations Window

Buttons
Buttons in the Child Locations tab are the same as the Locations tab. See
Locations tab on page 499 for more information.

505
LOCATIONS/SITES
Features of the Locations Window

Features of the Locations Window

The features of the Locations window are:

Feature See…

Opening the Locations window 498

Creating location/site records 507

Querying location/site details 508

Modifying location/site details 509

Deleting location/site records 510

Creating and querying costed items 511

Assigning an alternate name to a location 514

506
 LOCATIONS/SITES
Creating Location/Site Records

Creating Location/Site Records

Use this section to create a new Location/Site record.
For example, a carrier’s registered head office address can be entered into this
window. If the address is the billing address, select Yes for the Billing Point option.
If this billing address is different from the head office address, select No. The
address is nominated as a Billing Point in order to associate the customer/account
with an address in the Customer and Accounts window.

Note
Account information can only be created after the location is created.

Creating a Location
To create a Location/Site
1 Open the Locations window.
See Locations Window on page 498 for more information.
2 Complete all mandatory fields in the Locations tab.
See Locations tab on page 499 for more information about these fields.
3 Click the Save button.
Your changes are saved to the database.

Creating an Address
To create an Address for a Location/Site
1 Open the Locations window
See Locations Window on page 498 for more information.
2 Complete all the required fields in the Address Details section of the
Locations tab.
3 Click the Save button.
Your changes are saved to the database.

507
LOCATIONS/SITES
Querying Location/Site Details

Querying Location/Site Details

Use this instruction to query the following records in the Locations window:
• Locations
• Contacts
• Address details.
To query a detail in the Locations tab
1 Open the Locations window.
See Locations Window on page 498 for more information.
2 Click the Query button.
This places the window in query mode.
3 Click the field where you want to enter search criteria.
4 Enter your search criteria and click the Query button.
All matching records are displayed.

Hint
Use the Exit button to cancel query mode.

508
 LOCATIONS/SITES
Modifying Location/Site Details

Modifying Location/Site Details

Note
You cannot modify the value in the Location/Site code after it has been
used in the application.

To modify a detail in the Locations /Sites window

1 Query a record in the Locations window.
See Querying Location/Site Details on page 508 for more information.
2 Highlight the field in the Locations tab that you want to change.
3 Enter the new value.
4 Click the Save button.
Your changes are saved to the database.

509
LOCATIONS/SITES
Deleting Location/Site Records

Deleting Location/Site Records

Note
You cannot delete any location/site record that is currently associated
with any other window or entity in the Clarity System.

To delete a Location/Site record

1 Query a Location/Site record.
See Querying Location/Site Details on page 508 for more information.
2 Use the scroll bar to select the location/site record you want to delete.
3 Click the Delete button.
4 Click the Save button.
The record is deleted from the database.

510
 LOCATIONS/SITES
Creating and Querying Costed Items

Creating and Querying Costed Items

Use the Costed Item List for Location window to calculate the cost of
implementing a customer site or location, e.g. monthly rentals, discounts. This
includes:
• Creating costed items for a location
• Querying or displaying costed items for a location.

Note
Costed items need to be pre-set up in the Costed Items reference
window of the Provisioning Suite to make them available for selection.
See the Clarity Provisioning Suite User Manual for more information.

Creating a Costed Item for a Location

To create a costed item for a location
1 Display the location record using the Query function.
See Querying Location/Site Details on page 508 for more information.
2 Click the Costed Items button.
The Costed Item List for Locations window is displayed.
3 In the Item Name field use the LOV button to select the costed item you
want.
The Type and Cost fields are completed by default when you when you press
the Tab key.
4 Enter a comment in the Comments field, if appropriate.

511
LOCATIONS/SITES
Creating and Querying Costed Items

5 Click the Save button, and then the Exit button to close the window and
return to the Locations window.

Figure 23–2. Costed Item List for Location window

Fields
Fields in the Costed Item List window are described below.

Field Description

Costed Items Name Abbreviated Name/ID for the costed item. Use the LOV
button to select a valid option.

Type The type of costed item. This is completed by default

when the costed item name is entered.

Cost The cost associated with the selected item. This is

completed by default when the costed item name is
entered.

Comments Free text field for additional cost information.

Table 23–3. Costed Item List window fields

512
 LOCATIONS/SITES
Creating and Querying Costed Items

Querying or Displaying Costed items for a Location

To query or display costed items for a location
1 Display the location record.
See Querying Location/Site Details on page 508 for more information.
2 Click the Costed Items button.
The Costed Item List for Location window displays costed item details for
the selected location.

Note
You can update the Cost and Comments fields against a costed item if
required.

513
LOCATIONS/SITES
Assigning Alternate Names to Locations

Assigning Alternate Names to Locations

This section describes how you can assign various alternate names to locations.
This allows a single location to be referenced with more than one name, which is
vital if you have a non-Clarity Order Entry system.

Note
You need authorization to access the Alternate Names window.

To assign an alternate name or reference to a location

1 Query a record in the Locations window
See Querying Location/Site Details on page 508 for more information.
2 Select the record of the location you want to create an alternate name for.
3 Click the Other Names button.
The Other Names window is displayed.
4 In the Name field, enter the alternative location name as free text.
5 Tab to the Type field to enter a free text value (up to a maximum of 20
characters) for the source of the alternate name.
For example, Other Carrier.
6 Click the Exit button to return to the Locations window.
7 Click the Save button on the main toolbar.

514
 LOCATIONS/SITES
Location Templates

Location Templates
This section explains the prerequisites and the procedure to create location
attributes templates.

Prerequisites
one or more location attributes needs to be predefined. See Location Attributes on
page 567.
To create location attribute templates
1 Open the Location Attribute Templates window.

Note
Menu Path: Inventory/Templates/ Location Attributes.

Figure 23–3. The Location Attribute Template window.

515
LOCATIONS/SITES
Location Templates

Fields
Fields Descriptions

Templates

Name A descriptive name for the location attribute template.

(Mandatory)

Description A free text field to further describe the use of the

template. (Mandatory)

Attributes

Name The location attribute name, as defined in the referance

data. Use the List of Values to select a name.

Data Type The type of data that can be entered in the Attribute
Value field. Select one of the following from the list:
• Alphanumeric
• Number
• Character
• Date
• No Validation

Value The value of the location attribute, based on the data

type selected.

Defined By The person that defines the attribute. Select one of the
following from the list:
• Customer
• Engineer
• System.

Optionality Select from:

• Mandatory
• Optional
• Fixed

Table 23–4. Field descriptions for the Location Attribute Templates window.

2 In the Templates area, enter the template name and its description in the
Name and the Description field respectively.
3 Save the template.
4 In the Attributes area, enter the required attribute using the List of Values.

516
 LOCATIONS/SITES
Location Templates

5 Select a data type from the Data Type list.

6 Enter the required value in the Value field.
7 Select the person who defines the value in the Defined By list.
8 Select the optionality in the Optionality list.
9 Save the record.

517
LOCATIONS/SITES
Location Attributes for Locations/Child Locations

Location Attributes for Locations/Child Locations

Prerequisites
• One or more location attributes needs to be predefined. See Location
Attributes on page 567 for more information.
• If you wish to load location attributes using a template, one or more
location templates needs to be predefined. See Location Templates
on page 515 for more information.
To specify location attributes
1 Open the Locations window.See Locations Window on page 498 for more
information.
2 Click either the Locations tab or the Child Locations tab as per your
requirement.
3 Then query for the required location or the child location details as per your
selection in step 2.
4 Click the Attributes button. The Location Attributes window is displayed.

Figure 23–4. The Location Attributes window, displyed from the Locations window.

518
 LOCATIONS/SITES
Location Attributes for Locations/Child Locations

Fields
Field Description

Name Name of the location attribute.

Table 23–5. Field descriptions for the Location Attributes window.

Data Type The data type. Select from:
• Alphanumeric
• Character
• Date
• No Validation

Value The value of the location attribute.

Specified By Identifies the person specifying the location attribute:

• Customer
• Engineer
• System

Optionality Select the prefered optionality from:

• Mandatory
• Optional
• Fixed

Buttons
Button Description

Load Attributes This button loads location attributes from a template.

Table 23–6. Buttons for the Location Attributes window.

5 Enter the required location attribute in the Name field using the List of
Values. If you wish to load the location attributes using a template, click the
Load Attributes button.
6 Select the data type from the Data Type list.
7 You can specify a value in the Value field. This step is not mandatory.
8 Select the person specifying the location attribute from the Defined By list.
9 Select the required optionality from the Optionality list.
10 Save the record.

519
LOCATIONS/SITES
Location Attributes for Locations/Child Locations

520
 CHAPTER 24

Reference Data windows

Many of the fields in the Clarity Inventory Suite use the List of Values (LOV)
button to enter valid information. These lists are set up and maintained in the
reference windows. This chapter shows you how to open and use the reference
windows.

521
REFERENCE DATA WINDOWS
Inventory Suite Reference Data windows

Inventory Suite Reference Data windows

The reference data windows available in the Inventory menu are:

Window See…

Address Serviceability page 525

Area Types page 527

Exchange Codes page 529

Manufacturers page 530

Pay Load Mapping page 532

Reservation Threshold Matrix page 533

Speeds page 535

Trunk Group Parameter Validation page 536

Utilization Thresholds page 538

Cables submenu

Cable Sheath Product Types page 540

Cable Sheath Types page 542

Cable Validation page 544

Cards submenu

Card Models page 546

Card Validation page 549

Circuits submenu

Alternate Name Types page 551

Circuit Costs page 552

522
 REFERENCE DATA WINDOWS
Inventory Suite Reference Data windows

Window See…

Circuit Names page 554

Circuit Validation page 555

Connections submenu

Cross Connection Types page 557

Priorities page 558

Frames submenu

Frame Container Types page 559

Frame Container Validation page 560

Frame Unit Product Types page 562

Locations submenu

Location Attributes page 567

Location/ Site Types page 566

Network Elements submenu

Domains page 564

Network Element Models page 569

Network Element Types page 571

Network Element Aliases page 573

Network Element Parameter page 574

Validation

Ports submenu

Port Cables page 576

Port Usage page 577

523
REFERENCE DATA WINDOWS
Inventory Suite Reference Data windows

Window See…

Port Validation page 578

Many fields in Clarity’s Inventory Suite use the List of Values (LOV) button to enter
valid information. These lists are set up and maintained in the reference windows.

Note
Any field requiring selection of a value through the LOV means that
reference data for values relevant to that field needs to be previously set
up.

For full details of functions that can be carried out on records in all Clarity system
reference windows, refer to Using Reference windows in Getting Started with
Clarity OSS. This includes:
• querying records
• modifying records
• inserting records.

524
 REFERENCE DATA WINDOWS
Address Serviceability

Address Serviceability
Use this window to map a customer address with an element type, location, index,
and priority and determine the distance from the DP (distribution point) to the
customer’s home.
To open the Address Serviceability window
• From the Inventory menu, point to Reference Data, then click
Address Serviceability.

Figure 24–1. Address Serviceability window

Fields
The fields in the Address Serviceability window are:

Field Description

Element Type Frame Container or Network Element.

Location The unique identifier for a frame location that contains

telecommunications infrastructure. Use the LOV to select
a value. (Mandatory)

Type The frame type. Use LOV to select a value. (Mandatory)

Table 24–1. Address Serviceability window field (sheet 1 of 2)

525
REFERENCE DATA WINDOWS
Address Serviceability

Field Description

Index The frame index. Use LOV to select a value. (Mandatory)

Street Number The number of the street of the customer’s residence.

Street Name The name of the street of the customer’s residence.

Suburb The suburb of the customer’s address.

City The city of the customer’s address.

Post Code The post code of the customer’s address.

State The state (or province) of the customer’s residence.

Priority The order in which the Network Elements should be

selected based on the closest network element that can
reach the customer’s premises, followed by the next best
choice and so on. (Mandatory)

Distance The distance that the Network Element is from the

customer’s residence. (Mandatory)

Table 24–1. Address Serviceability window field (sheet 2 of 2)

Button
The button in the Address Serviceability window is:

Field Description

Get/View Add Allows an address to be selected from the Address

Maintenance window and mapped to the chosen
element.

Table 24–2. Address Serviceability window field

526
 REFERENCE DATA WINDOWS
Area Types

Area Types
Use this window to define charging area types. For example, you may define long
distance charging areas and short distance charging area.
To open the Area Types window
• From the Inventory menu, point to Reference Data, then click Area
Types.
The Area Types window is displayed.

Figure 24–2. Area Types window

Fields
The fields in the Area Types window are:

Field Description

Area Hierarchy

Code The code for the area hierarchy, e.g. EXC for Exchange
based or GEO for geographical based hierarchy.
(Mandatory)

Description Free text field to further describe the area hierarchy.

(Mandatory)

Table 24–3. Area Types window fields (sheet 1 of 2)

527
REFERENCE DATA WINDOWS
Area Types

Field Description

Region Hierarchy Select this check box the first time you create or define
check box your Geographic Hierarchy. The system will prompt you
to migrate the hierarchical structure and data to the
Regions table. You can then use the Regions window to
add areas to your hierarchy.
Note: Areas are added to the exchange or service
hierarchy using the Areas window.

Area Types

Code The code for the area type, e.g. LEA. (Mandatory)

Description Free text field to further describe the area type, e.g. Local
Exchange Area. (Mandatory)

Level The level for the area code in the hierarchy so that rules
can be used to search at these predefined levels.
(Mandatory)

Table 24–3. Area Types window fields (sheet 2 of 2)

528
 REFERENCE DATA WINDOWS
Exchange Codes

Exchange Codes
Use this window to define exchange codes. These codes are used to define which
exchange will provide the requested service.
To open the Exchange Codes window
• From the Inventory menu, point to Reference Data, then click
Exchange Codes.

Figure 24–3. Exchange Codes window

Fields
The fields in the Exchange Codes window are:

Field Description

Exchange Code The code that represents the exchange. (Mandatory)

Description Free text field to further describe the exchange.

(Mandatory)

Table 24–4. Exchange Codes window; fields

529
REFERENCE DATA WINDOWS
Manufacturers

Manufacturers
Use this window to maintain a list of manufacturers that make or provide
equipment that is used in the network.
To open the Manufacturers window
• From the Inventory menu, point to Reference Data, then click
Manufacturers.

Hint
Click the Address List button to display the Manufacturer Address List
window. This window displays the address details for the manufacturer.

To add or edit this information, double-click the Address field in the

Manufacturer Address List window to access the Locations window.
See Locations Window on page 498.

To add or edit the manufacturer’s contact details, click the Location

Contact List button in the Manufacturer Address List window to
display the Contact Details window.

Figure 24–4. Manufacturers window

530
 REFERENCE DATA WINDOWS
Manufacturers

Fields
The fields in the Manufacturers window are:

Field Description

Abbreviation A unique abbreviation for the manufacturer. (Mandatory)

Description A free text field to expand the abbreviation or further

describe the manufacturer. (Mandatory)

Table 24–5. Manufacturers window; fields

531
REFERENCE DATA WINDOWS
Pay Load Mapping

Pay Load Mapping

Use the Pay Load Mapping window to create, modify, and delete payload
mapping information for a circuit.
To open the Pay Load Mapping window
• From the Inventory menu, point to Reference Data, then click Pay
Load Mapping.

Figure 24–5. Pay Load Mapping window

Fields
The fields in the Pay Load Mapping window are:

Field Description

Pay Load Assigned circuit speed. Use LOV to select a pay load
speed. (Mandatory)

Transport Assigned port speed on which the circuit is carried. Use

LOV to select a transport speed. (Mandatory)

Units Number of ports allocated to a circuit. (Mandatory)

Table 24–6. Fields in the Pay Load Mapping window

532
 REFERENCE DATA WINDOWS
Reservation Threshold Matrix

Reservation Threshold Matrix

Use the Reservation Threshold Matrix window to define threshold limits that will
be used when reserving a service.
To open the Reservation Threshold Matrix window
• From the Inventory menu, point to Reference Data, then click
Reservation Threshold Matrix.

Figure 24–6. Reservation Threshold Metric window

Fields
The fields in the Reservation Threshold Matrix window are:

Field Description

Service Type The type of service being provided, for example, ISDN,
PSTN, and so on.

Speed The speed at which the service is provided.

Bitrate kbps Lower The lower limit of the speed.

Limit

Bitrate kbps Upper The upper limit of the speed.

Limit

Table 24–7. Fields in the Reservation Threshold Matrix window

533
REFERENCE DATA WINDOWS
Reservation Threshold Matrix

Field Description

Distance km Lower The minimum distance that the customer using the
Limit service can be from the exchange providing the service.

Distance km Upper The maximum distance that the customer using the
Limit service can be from the exchange providing the service

Return Code The error code that is sent to the calling system if the
service does not fall within the specified limits.

Table 24–7. Fields in the Reservation Threshold Matrix window

534
 REFERENCE DATA WINDOWS
Speeds

Speeds
Use this window to maintain a set of speeds at which circuits may operate within
the limitation of the carrier’s network.
To open the Speeds window
• From the Inventory menu, point to Reference Data, then click
Speeds.

Figure 24–7. Speeds window

Fields
The fields in the Speeds window are:

Field Description

Abbreviation A unique abbreviation for the speed. (Mandatory)

Description A free text field to further describe the speed.

(Mandatory)

Bit Rate (Kbps) Actual bit rate in Kbits/second. (Mandatory)

Table 24–8. Speeds window; fields

535
REFERENCE DATA WINDOWS
Trunk Group Parameter Validation

Trunk Group Parameter Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify trunk group
validation parameters and rules.
To open the Trunk Group Parameter Validation window
• From the Inventory menu, point to Reference Data, then click Trunk
Group Validation.

Figure 24–8. Trunk Group Parameter Validation window

Fields
The fields in the Trunk Group Parameter Validation window are:

Field Description

Trunk Group Parameter Validation

Name A name that identifies the trunk group. (Mandatory)

Description A free text field to further describe the use of the trunk
group. (Mandatory)

Trunk Group Parameter Rules

Procedure Name An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Table 24–9. Trunk Group Parameter Validation window; fields (sheet 1 of 2)

536
 REFERENCE DATA WINDOWS
Trunk Group Parameter Validation

Field Description

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Parameters Indicates if procedure requires input parameters. Select

one of the following:
• Yes
Max Parameters and Input Parameter must be
entered
• No
Input parameters may be specified elsewhere in the
system but no entry is required in this window.
(Mandatory)

Max Parameters Indicates the number of parameters required.

Input Parameters The input parameters. The number of parameters must

match the number indicated in the Max Parameter
field. If inserting a string as an input parameter, enclose
it in single quotes, e.g.’Test’. Separate multiple
parameters with a comma, e.g. ‘Test’,’To’.

Table 24–9. Trunk Group Parameter Validation window; fields (sheet 2 of 2)

537
REFERENCE DATA WINDOWS
Utilisation Threshold Sets

Utilisation Threshold Sets

Utilisation thresholds can be used to plan infrastructure, commission new
switches, avoid potential saturation of switches, etc. This window can be used to
adjust the default values of thresholds, or to assign different levels to various
templates.
To open the Utilisation Threshold Set window
• From the Inventory menu, point to Reference Data, then click
Utilisation Thresholds.

Figure 24–9. Utilsation Threshold window.

Fields
The fields in the Utilisation Threshold Sets window are:

Field Description

Name The name of the Threshold Set. (Mandatory)

Type The Type of equipment to link the threshold set to. E.g.
Network Element, Card. (Mandatory)

Critical Threshold The critical utilization threshold (value between 1 and

100). When the critical level threshold is reached, the
color of the utilization bar graph in the Network
Elements window will be red. (Mandatory)

Table 24–10. Utilization Threshold Sets window; fields (sheet 1 of 2)

538
 REFERENCE DATA WINDOWS
Utilisation Threshold Sets

Field Description

Major Threshold The major utilization threshold specified as a value

between 1 and 100 (default 80). When the major level
threshold is reached, the color of the utilization bar
graph in the Network Elements window will be orange.
(Mandatory)

Minor Threshold The minor utilization threshold specified as a value

between 1 and 100 (default 60). When the minor level
threshold is reached, the color of the utilization bar
graph in the Network Elements window will be yellow.
(Mandatory)

Warning Threshold The warning utilization threshold specified as a value

between 1 and 100 (default 40). When the warning level
threshold is reached, the color of the utilization bar
graph in the Network Elements window will be green.
(Mandatory)

Table 24–10. Utilization Threshold Sets window; fields (sheet 2 of 2)

539
REFERENCE DATA WINDOWS
Cable Sheath Product Types

Cable Sheath Product Types

Use this window to add, modify and delete valid cable sheath product types.
Before you can create records in this window, values must be entered in the
Manufacturers reference window. See Manufacturers on page 530 for more
information on the Manufacturers window.
To open the Cable Sheath Product Type window
• From the Inventory menu, point to Reference Data > Cables and
then click Cable Sheath Product Types.

Figure 24–10. Cable Sheath Product Types window

Fields
The fields in the Cable Sheath Product Types window are:

Field Description

Product Name The name of the cable sheath product. (Mandatory)

Manufacturer The abbreviation of the manufacturer of this product.

Use the LOV to select a value. (Mandatory)
These values are set up in the Manufacturers reference
window. See Manufacturers on page 530 for more
information about this window.

Table 24–11. Cable Sheath Product Types window field (sheet 1 of 2)

540
 REFERENCE DATA WINDOWS
Cable Sheath Product Types

Field Description

No. of Tubes The number of tubes within the cable sheath.

(Mandatory)

No. of Cores The total number of fibres within the cable sheath.
(Mandatory)

Wire Gauge The thickness of the cable.

Description Free text field to further describe the cable sheath

product. (Mandatory)

dB Loss The reduction in signal strength over the length of the

cable and frequency range.

Table 24–11. Cable Sheath Product Types window field (sheet 2 of 2)

541
REFERENCE DATA WINDOWS
Cable Sheath Types

Cable Sheath Types

Cable sheath types help identify the purpose of a cable sheath. For example, you
may define several cable sheath types based on the function of cable sheath, such
as a main cable sheath, or a spur cable sheath.
To open the Cable Sheath Types window
• From the Inventory menu, point to Reference Data > Cables and
then click Cable Sheath Types.

Figure 24–11. Cable Sheath Types window

Fields
The fields in the Cable Sheath Types window are:

Field Description

Type The name of the cable sheath type. For example, you
may choose to identify type based on the use for the
cable, i.e. Long Haul, Spur, etc. (Mandatory)

Description Free text field to further describe the cable sheath type.

Name Format A valid cable sheath name format, e.g a FITL (Fibre In
Description The Loop) type has a name format of EXCH-FITNNNN
where EXCH=Exchange Code, FIT=constant as Fibre In
The Loop and NNNN=Fibre Optic Cable No.

Table 24–12. Cable Sheath Types window field (sheet 1 of 2)

542
 REFERENCE DATA WINDOWS
Cable Sheath Types

Field Description

Validate Name A valid cable sheath name regular expression, e.g. a

using Regular FITL (Fibre In The Loop) type has a regular expression for
Expression a valid cable sheath name of ^EXCH-FIT\d{4}$

Table 24–12. Cable Sheath Types window field (sheet 2 of 2)

543
REFERENCE DATA WINDOWS
Cable Parameter Validation

Cable Parameter Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify cable validation
parameters and rules.
To open the Cable Parameter Validation window
• From the Inventory menu, point to Reference Data > Cables and
then click Cable Validation.

Figure 24–12. Cable Parameter Validation window

Fields
The fields in the Cable Parameter Validation window are:

Field Description

Cable Parameter Validation

Cable Template The name that identifies the cable template. Use LOV to
select a value. (Mandatory)

Template Attribute The template attribute to be validated. Use LOV to select

a value. (Mandatory)

Description A free text field to further describe the attribute.

(Mandatory)

Table 24–13. Cable Parameter Validation window; fields (sheet 1 of 2)

544
 REFERENCE DATA WINDOWS
Cable Parameter Validation

Field Description

Cable Parameter Rules

Procedure Name An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Parameters Indicates if procedure requires input parameters. Select

one of the following:
• Y
Max Parameters and Input Parameter must be
entered
• N
Input parameters may be specified elsewhere in the
system but no entry is required in this window.
(Mandatory)

Max Parameters Indicates the number of parameters required.

Input Parameters The input parameters. The number of parameters must

match the number indicated in the Max Parameter
field. If inserting a string as an input parameter, enclose
it in single quotes, e.g.’Test’. Separate multiple
parameters with a comma, e.g. ‘Test’,’To’.

Table 24–13. Cable Parameter Validation window; fields (sheet 2 of 2)

545
REFERENCE DATA WINDOWS
Card Models

Card Models
Use this reference window to define the card models available from specified
manufacturers.

Note
All fields are mandatory.

Before you can create records in this window, values must be entered in the
Manufacturers reference window. See Manufacturers on page 530 for more
information on the Manufacturers window.
To open the Card Models window
• From the Inventory menu, point to Reference Data > Cards and
then click Card Models.

Figure 24–13. Card Models window

Fields
The fields in the Card Models window are:

Field Description

Card Type Free text field to identify the type of card, e.g. DSL.
(Mandatory)

Manufacturer The manufacturer of the card, e.g. CISCO, Alcatel. Use

LOV to select a value. (Mandatory)

Table 24–14. Card Models window; fields

546
 REFERENCE DATA WINDOWS
Card Models

Field Description

Network Element The equipment type. List of Values will display the
Type equipment types set up in the Network Element Types
reference data window. When cards are being created
for a particular network element instance in the
Network Elements screen > Card Slots section, the
LOV for the field Card Type will display those card
models that are associated with the particular network
element type for which the card is created. The LOV will
also display those card types for which the Network
Element Type field is null when the card model is set up.

Model The model of the card. (Mandatory)

Revision The revision of the card. (Mandatory)

Parent Card Type The type of parent card.

Max No. of Cards The maximum number of child cards that can be
contained within that parent.

Deviation The impact of the latest revision.

Maximum Ports The maximum number of ports available on the card.

Group The group that defines the card model. Select one of the
following from the drop-down list:
• Data
• Transmission. (Mandatory)

Port Template Unique port template name. Use LOV to select a value.
(Mandatory)

Card Detail The card details template name. Use LOV to select a
Template value. Double-click to view the Card Details Template
window.

Description Description of the card model. (Mandatory)

Relation The relation of the current card both to itself and other
cards that may reference this card.

Table 24–14. Card Models window; fields

547
REFERENCE DATA WINDOWS
Card Models

Field Description

Card Slot Prefix A unique slot number used to prefix a child card. (Only
valid for when there is a parent card).

Table 24–14. Card Models window; fields

The button in the Card Models reference window is:

Field Description

SF Opens up the Card Features window to display the

service features associated with the card.

Table 24–15. Terminations tab; buttons

548
 REFERENCE DATA WINDOWS
Card Parameter Validation

Card Parameter Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify card validation
parameters and rules.
To open the Card Parameter Validation window
• From the Inventory menu, point to Reference Data > Cards and
then click Card Validation.

Figure 24–14. Card Parameter Validation window

Fields
The fields in the Card Parameter Validation window are:

Field Description

Card Parameter Validation

Name A name that identifies the card parameter. (Mandatory)

Description A free text field to further describe the use of the card
parameter. (Mandatory)

Card Parameter Rules

Procedure An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Table 24–16. Card Parameter Validation window; fields (sheet 1 of 2)

549
REFERENCE DATA WINDOWS
Card Parameter Validation

Field Description

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Parameters Indicates if procedure requires input parameters. Select

one of the following:
• Y
The Max Parameters and Input Parameters fields
must be entered.
• N
The Input Parameters field may be specified
elsewhere in the system but no entry is required in this
window. (Mandatory)

Max Parameters Indicates the number of parameters required.

Input Parameters The input parameters. The number of parameters must

match the number indicated in the Max Parameters
field. If inserting a string as an input parameter, enclose
it in single quotes, e.g.’Test’. Separate multiple
parameters with a comma, e.g. ‘Test’,’To’.

Table 24–16. Card Parameter Validation window; fields (sheet 2 of 2)

550
 REFERENCE DATA WINDOWS
Alternate Name Types

Alternate Name Types

Alternate Name Types allows you to maintain reference to previous naming
conventions used to name circuits. This window allows an easy transition to a
newer system by allowing you to specify alternative names for circuits.
To open the Alternate Name Types window
• From the Inventory menu, point to Reference Data > Circuits and
then click Alternate Name Types.

Figure 24–15. Alternate Name Types window

Fields
The fields in the Alternate Name Types window are:

Field Description

Alternate Name Alternate name type. (Mandatory).

Type

Description A free text field to further describe the use of the alternate
name type.

Table 24–17. Card Parameter Validation window; fields

551
REFERENCE DATA WINDOWS
Circuit Costs

Circuit Costs
Use this reference window to identify theoretical circuit costs that exist between
locations.
Before you can create records in this window, values must be entered in the
following windows:
• Location/Sites window. See Locations Window on page 498.
• Speeds reference window. See Speeds on page 535 for more
information on the Speeds window.
Providers must also exist in the Clarity system with a Business Type of Telco.
To open the Circuit Costs window
• From the Inventory menu, point to Reference Data > Circuits and
then click Circuit Costs.

Figure 24–16. Circuit Costs window

Fields
The fields in the Circuit Costs window are:

Field Description

Circuit Location Distance

Location A The starting point of the circuit. Use LOV to select an A

location. (Mandatory)

Location B The ending point of the circuit. Use LOV to select a B

location. (Mandatory)

Table 24–18. Circuit Costs window; fields (sheet 1 of 2)

552
 REFERENCE DATA WINDOWS
Circuit Costs

Field Description

Distance A free text field describing the physical distance of the

circuit. (Mandatory)

Cost Method The method of costing the circuit. Select one of the
following values from the drop-down list:
• Exact
• Higher
• Lower. (Mandatory)

Circuit Distance Costs

Distance Auto-populated with the distance information entered in

the Circuit Location Distance section of the window.
The default measurement unit is set up in the
Application Variables window. The variable name is
gis_default_distance_units. Refer to Getting Started with
Clarity OSS for more information. (Mandatory)

Provider The service provider. This will be an existing customer in

the Clarity system with an assigned business type of
TELCO. Use LOV to select a provider. (Mandatory)

Circuit Type The type of circuit. Select one of the following values
from the drop-down list:
• Bearer
• Leased
• Switched Svc
• Host to LU
• Trunk
• International
• Interconnect. (Mandatory)

QoS Free text field to describe quality of service. (Mandatory)

Bandwidth The speed of the circuit. Use LOV to select a value.

(Mandatory)

Install Cost Cost in dollars of installing the circuit.

Periodic Cost Cost in dollars to maintain the circuit.

Deinstall Cost Cost in dollars to de-install the circuit.

Table 24–18. Circuit Costs window; fields (sheet 2 of 2)

553
REFERENCE DATA WINDOWS
Circuit Names

Circuit Names
This window is used to specify circuit names.
To open the Service Circuit Names Configuration window
• From the Inventory menu, point to Reference Data > Circuits and
then click Circuit Names.

Figure 24–17. Service Circuit Names Configuration window

Fields
The fields in the Service Circuit Names Configuration window are:

Field Description

Service Type The service type related to the circuit name, e.g. ISDN.
Use LOV to select a value. (Mandatory)

Seq The sequence number. (Mandatory)

Type Select a circuit type from the drop-down list.

Value Enter the circuit name.

Description A meaningful description of the circuit name.

Table 24–19. Service Circuit Names Configuration window; fields

554
 REFERENCE DATA WINDOWS
Circuit Parameter Validation

Circuit Parameter Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify circuit validation
parameters and rules.
To open the Circuit Parameter Validation window
• From the Inventory menu, point to Reference Data > Circuits and
then click Circuit Validation.

Figure 24–18. Circuit Parameter Validation window

Fields
The fields in the Circuit Parameter Validation window are:

Field Description

Circuit Parameter Validation

Name A name that identifies the service parameter.

(Mandatory)

Description A free text field to further describe the use of the service
parameter. (Mandatory)

Table 24–20. Circuit Parameter Validation window; fields (sheet 1 of 2)

555
REFERENCE DATA WINDOWS
Circuit Parameter Validation

Field Description

Circuit Parameter Rules

Procedure Name An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Parameters Indicates if procedure requires input parameters. Select

one of the following:
• Y
Max Parameters and Input Parameter must be
entered
• N
Input parameters may be specified elsewhere in the
system but no entry is required in this window.
(Mandatory)

Max Parameters Indicates the number of parameters required.

Input Parameters The input parameters. The number of parameters must

match the number indicated in the Max Parameters
field. If inserting a string as an input parameter, enclose
it in single quotes, e.g.’Test’. Separate multiple
parameters with a comma, e.g. ‘Test’,’To’.

Table 24–20. Circuit Parameter Validation window; fields (sheet 2 of 2)

556
 REFERENCE DATA WINDOWS
Cross Connection Types

Cross Connection Types

Use this window to maintain valid names for both logical and physical links. Use
with network elements, both internally and externally, when providing a circuit.
To open the Cross Connection Types window
• From the Inventory menu, point to Reference Data > Connections
and then click Cross Connection Types.

Figure 24–19. Cross Connection Types window

Fields
The fields in the Cross Connection Types window are:

Field Description

Abbreviation A unique abbreviation for the cross connection type.

(Mandatory)

Description A free text field to further describe the cross connection

type. (Mandatory)

Cross Connect The cross connect sub-type status. Select one of the
Subtype following values from the drop-down list:
• Logical (internal or functional)
• Physical (external or tangible). (Mandatory)

Table 24–21. Cross Connection Types window; fields

557
REFERENCE DATA WINDOWS
Priorities

Priorities
Use this window to define priorities for data connections.
To open the Priorities window
• From the Inventory menu, point to Reference Data > Connections
and then click Priorities.

Figure 24–20. Priorities window

Fields
The fields in the Priorities window are:

Field Description

Name A free text field to assign a name to the Priority.

Type Use the drop-down list to select if the priority is being

defined for the Class of Service or the Quality of Service.

Rank The rank or order of the importance of the priority in the

context of a priority type. For example, as displayed in
Figure 23-21 above, priority 7 is ranked 1, i.e., in the
Class of Service it has the highest priority whereas
DiffServ-EF has the highest priority in Quality of Service.

Description A free text field to provide a description for the priority.

Table 24–22. Priorities window; fields

558
 REFERENCE DATA WINDOWS
Frame Container Types

Frame Container Types

Use this window to add, modify and delete valid frame container types, e.g. MDF,
cabinet, etc.
To open the Frame Container Types window
• From the Inventory menu, point to Reference Data > Frames and
then click Frame Container Types.

Figure 24–21. Frame Container Types window

Fields
The fields in the Frame Container Types window are:

Field Description

Type The code that represents the frame container type, e.g.
DP for distribution point. (Mandatory)

Description Free text field to further describe the frame container.

(Mandatory)

Table 24–23. Frame Container Types window field

559
REFERENCE DATA WINDOWS
Frame Container Validation

Frame Container Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify frame container
validation parameters and rules.
To open the Frame Container Parameter Validation window
• From the Inventory menu, point to Reference Data > Frames and
then click Frame Container Validation.

Figure 24–22. Frame Container Validation window

Fields
The fields in the Frame Container Validation window are:

Field Description

Parameters

Name A name that identifies the frame container parameter.

(Mandatory)

Description A free text field to further describe the use of the frame
container parameter. (Mandatory)

Table 24–24. Frame Container Parameter Validation window; fields (sheet 1 of 2)

560
 REFERENCE DATA WINDOWS
Frame Container Validation

Field Description

Validation Procedures

Procedure An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Table 24–24. Frame Container Parameter Validation window; fields (sheet 2 of 2)

561
REFERENCE DATA WINDOWS
Frame Unit Product Types

Frame Unit Product Types

Use this window to identify frame unit product types for specified manufacturers.
Before you can create records in this window, values must be entered in the
Manufacturers reference window. See Manufacturers on page 530 for more
information on the Manufacturers window.
To open the Frame Unit Product Type window
• From the Inventory menu, point to Reference Data > Frames and
then click Frame Unit Product Types.

Figure 24–23. Frame Unit Product Types window

Fields
The fields in the Frame Unit Product Types window are:

Field Description

Product Name A free text field to uniquely identify the product.

(Mandatory)

Manufacturer An abbreviation that identifies the manufacturer of the

product. Use LOV to select a manufacturer. (Mandatory)

Unit Type Indicates the type of unit. Select one of the following from
the drop-down list:
• Block
• Panel. (Mandatory)

Template The name of the Frame Unit template. Use LOV to select
a value.

Table 24–25. Frame Unit Product Types window; fields (sheet 1 of 2)

562
 REFERENCE DATA WINDOWS
Frame Unit Product Types

Field Description

Height The height of the unit. (Mandatory)

Positions The number of positions in the panel or block.

(Mandatory)

Termination Type Indicates the type of termination. Select one of the

following from the drop-down list:
• Optical
• Electrical. (Mandatory)

Splicetrays The number of splice trays in the panel or block.

Description A free text field to further describe the frame unit.

(Mandatory)

Table 24–25. Frame Unit Product Types window; fields (sheet 2 of 2)

563
REFERENCE DATA WINDOWS
Domains

Domains
Use the Domains reference data window to set up domains. A domain, at a high
level, refers to the owning group of the NE type, for example Switching or
Transmission. A network element exists in a domain, for instance, a route exists in
the data domain, a PSTN exchange in the Switch domain, a Mux in transmission,
and so on. Clarity defines three domains by default, i.e., Data, Transmission, and
Switching. Additionally, users can define their own domains. Domains are linked
to Equipment Type through the NE Types reference data window. An equipment
type represents a function within that domain. This association is carried forward
to the Network Element window such that when a network element type is
selected, the Domain field will be automatically populated based on the user
configuration. This association establishes that the particular piece of equipment
exists in a specific domain and performs a specific function.
Since the Domain field is populated automatically based on the Equipment Type
selected, at any given point in time, there can only be one domain-equipment
type association. Multiple equipment types cannot be linked to the same domain
any longer. If such data exists, it must be cleaned up by defining new equipment
types.
To open the Domains window
• From the Inventory menu, select Reference Data, then Network
Elements and then click Domains.
The Domains window is displayed.

Figure 24–24. Domains window

564
 REFERENCE DATA WINDOWS
Domains

Fields
The fields in the Domains window are:

Field Description

Name The Domain name (mandatory).

Description A free text field to enter a description for the domain

(Mandatory),

Table 24–26. Domains window; fields

Note
A Domain name, once configured, cannot be modified or deleted if there
are Equipment Types that reference that Domain.

565
REFERENCE DATA WINDOWS
Location/Site Types

Location/Site Types
Use this window to define location or site types.
To open the Location/Site Types window
• From the Inventory menu, point to Reference Data, then click
Location/Site Types.

Figure 24–25. Location/Site Types window

Fields
The fields in the Location/Site Types window are:

Field Description

Abbreviation A unique abbreviation that represents the location/site

type, e.g. DLC. (Mandatory)

Description Free text field to further describe the location/site type,

e.g. Digital Loop Carrier. (Mandatory)

Table 24–27. Location/Site Types window; fields

566
 REFERENCE DATA WINDOWS
Location Attributes

Location Attributes
Use this window to define the location attributes.
To create location attributes
1 Open the Location Attributes window.

Note
Menu Path: Inventory/Reference Data/ Locations/Location
Attributes

Figure 24–26. The Location Attributes window.

567
REFERENCE DATA WINDOWS
Location Attributes

Fields
Fields Descriptions

Name A descriptive name for the location attribute. (Mandatory)

Description A free text field to further describe the use of the attribute.
(Mandatory)

Table 24–28. The field descriptions for the Location attributes window.

2 Enter the name and the description of the attribute in the Name and the
Description field respectively.
3 Save the record.

568
 REFERENCE DATA WINDOWS
Network Element Models

Network Element Models

Use this window to maintain a list of manufacturer’s model types that can be
selected when entering network elements.
Before you can create records in this window, values must be entered in the
following reference windows:
• Manufacturers. See Manufacturers on page 530 for more
information on the Manufacturers window.
• Network Element Types. See Network Element Types on page 571
for more information on the Network Element Types window.
To open the Network Element Models window
• From the Inventory menu, point to Reference Data > Network
Elements and then click NE Models.

Figure 24–27. Network Element Models window

Fields
The fields in the Network Element Models window are:

Field Description

Net. Element An abbreviation that identifies the network element type.

Abbreviation Use LOV to select a value. (Mandatory)

Manufacturer An abbreviation that identifies the manufacturer of the

Abbreviation equipment. Use LOV to select a value. (Mandatory)

Table 24–29. Network Element Models window (sheet 1 of 2)

569
REFERENCE DATA WINDOWS
Network Element Models

Field Description

NE Model Type A free text field identifying the network element model
type. At least one model type needs to be identified for
each manufacturer as various models of a network
element type can exist. (Mandatory)

MMS Item Number The asset number for the Materials Management System
or Assets Management System.

NE Detail Template The name of the NE detail template. Use LOV to select a
value.

Table 24–29. Network Element Models window (sheet 2 of 2)

570
 REFERENCE DATA WINDOWS
Network Element Types

Network Element Types

The Network Element Types window is used to set up Equipment Types. Clarity
defines an Equipment Type as a description of the function of the equipment, for
example an AXE10 switch can be a Local Trunk or Gateway switch. It must be
noted that many sites use the Type to reflect the vendor and model numbers.
When a network element is defined, it is named by its location and NE Type which
should ideally describe the function of that equipment.
Equipment Types are linked to Domains via the Network Element Types window.
These Equipment Types represent a function within that domain. When this
equipment type is selected when defining a new piece of equipment, the domain
will be automatically linked to the equipment. This allows users to set up a
network model where a particular equipment exists in a specific domain and
performs a specific job.
It is to be noted that with this data model implementation, an Equipment Type can
be linked to only one Domain at a time because an Equipment Type can only
support a single function. If the same vendor and model of Equipment is used for
different functions, then it must have different Equipment Types.
To open the Network Element Types window
• From the Inventory menu, point to Reference Data > Network
Elements and then click NE Types.

Figure 24–28. Network Element Types window

571
REFERENCE DATA WINDOWS
Network Element Types

Fields
The fields in the Network Element Types window are:

Field Description

Abbreviation A unique abbreviation for the network element type.

(Mandatory)

Group List of values derived from the Domains table, for

example, Data, Switching, or Transmission.

Technology The kind of technology related to the Network ELement,

e.g. Legacy, NGN.

Description A free text field to expand the abbreviation or further

describe the network element type. (Mandatory)

Table 24–30. Network Element Types window; fields

Equipment Type Function (to be added in a later release)

This reference data is being added to the system to provide a “Clarity Equipment
Type” capability. It provides Clarity, the ability to associate a specific function to a
piece of equipment. The Equipment Type Function is a numeric code (for
language localization) and is defined by Clarity to have a special meaning. As an
example, a function could be a BTS in a cellular network, or a PE Router in an IP
network, or a STM-16 Mux in a transmission network. These codes give certainty
to Clarity modules as to the purpose and function of a specific Network Element
Type.
A Network Element Type will be associated with a single function code, and if
there are multiple 'types of equipment' with similar functions then each will be
defined with a unique Network Element Type. When creating an Equipment Type
record an Equipment Type Function can be selected from a LOV into the
'Equipment Type Function' field. When an NE Type is associated with a Domain,
the Equipment Type Function is also automatically linked to the domain. While
creating a Realm Hierarchy, when the user selects a particular domain, the
Equipment Type Function specified for NEs in that domain are automatically
populated in the Realm Hierarchy window.

572
 REFERENCE DATA WINDOWS
Network Element Aliases

Network Element Aliases

This window is then used to define equipment alias names for particular
equipment in a naming domain.
To open the Network Element Aliases window
• From the Inventory menu, point to Reference Data > Network
Elements and then click Network Element Alias’.

Figure 24–29. Network Element Aliases window

Fields
The fields in the Network Element Aliases window are:

Field Description

Network Element The network element alias.

Alias

Naming Domain The Naming Domain.

Equipment The equipment to which the alias is associated.

Table 24–31. Network Element Types window; fields

573
REFERENCE DATA WINDOWS
Network Element Parameter Validation

Network Element Parameter Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify network element
validation parameters and rules.
To open the Network Element Parameter Validation window
• From the Inventory menu, point to Reference Data > Network
Elements and then click Network Element Validation.

Figure 24–30. Network Element Parameter Validation window

Fields
The fields in the Network Element Parameter Validation window are:

Field Description

Network Element Parameter Validation

Name A name that identifies the network element parameter.

(Mandatory)

Description A free text field to further describe the use of the network
element parameter. (Mandatory)

Table 24–32. Network Element Parameter Validation window; fields (sheet 1 of 2)

574
 REFERENCE DATA WINDOWS
Network Element Parameter Validation

Field Description

Network Element Parameter Rules

Procedure An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Parameters Indicates if procedure requires input parameters. Select

one of the following from the drop-down list:
• Y
The Max Parameters and Input Parameters fields
must be entered.
• N
The Input Parameters field may be specified
elsewhere in the system but no entry is required in this
window. (Mandatory)

Max Parameters Indicates the number of parameters required.

Input Parameters The input parameters. The number of parameters must

match the number indicated in the Max Parameter
field. If inserting a string as an input parameter, enclose
it in single quotes, e.g.’Test’. Separate multiple
parameters with a comma, e.g. ‘Test’,’To’.

Table 24–32. Network Element Parameter Validation window; fields (sheet 2 of 2)

575
REFERENCE DATA WINDOWS
Port Cables

Port Cables
Use this window to list valid cable types that can be used to connect physical ports
on network elements.
To open the Port Cables window
• From the Inventory menu, point to Reference Data > Ports and
then click Port Cables.

Figure 24–31. Port Cables window

Fields
The fields in the Port Cables window are:

Field Description

Abbreviation A unique abbreviation for the port cable. (Mandatory)

Description A free text field to further describe the port cable.

(Mandatory)

Table 24–33. Port Cables window; fields

576
 REFERENCE DATA WINDOWS
Port Usage

Port Usage
Use this window to list valid ports that are used by the system.
To open the Port Usage window
• From the Inventory menu, point to Reference Data > Ports and
then click Port Usage.

Figure 24–32. Port Usage window

Fields
The fields in the Port Usage window are:

Field Description

Name The name to identify the port usage type. (Mandatory).

Description A free text field to further describe the port usage.

(Mandatory)

Table 24–34. Port Usage window; fields

577
REFERENCE DATA WINDOWS
Port Parameter Validation

Port Parameter Validation

Validation procedures specific to your business can be defined in the database by
a database administrator. This window is then used to specify port validation
parameters and rules.
To open the Port Parameter Validation window
• From the Inventory menu, point to Reference Data > Ports and
then click Port Validation.

Figure 24–33. Port Parameter Validation window

Fields
The fields in the Port Parameter Validation window are:

Field Description

Port Parameter Validation

Name A name that identifies the port parameter. (Mandatory)

Description A free text field to further describe the use of the port
parameter. (Mandatory)

Port Parameter Rules

Procedure Name An identifying name for the procedure. Stored in the

database by a database administrator. (Mandatory)

Table 24–35. Port Parameter Validation window; fields (sheet 1 of 2)

578
 REFERENCE DATA WINDOWS
Port Parameter Validation

Field Description

Description Automatically populated when you select the procedure

name. This entry can be edited if required. (Mandatory)

Parameters Indicates if procedure requires input parameters.

(Mandatory) Select one of the following from the drop-
down list:
• Y
Max Parameters and Input Parameter must be
entered
• N
Input parameters may be specified elsewhere in the
system but no entry is required in this window.

Max Parameters Indicates the number of parameters required.

Input Parameters The input parameters. The number of parameters must

match the number indicated in the Max Parameter
field. If inserting a string as an input parameter, enclose
it in single quotes, e.g.’Test’. Separate multiple
parameters with a comma, e.g. ‘Test’,’To’.

Table 24–35. Port Parameter Validation window; fields (sheet 2 of 2)

579
REFERENCE DATA WINDOWS
Port Parameter Validation

580
 CHAPTER 25

Traffic Management

This section shows you how to open and use the windows in the traffic
management menu.

581
TR A F F I C M A N A G E M E N T
Overview

Overview
Traffic management involves the capturing of route, trunk group, device and
associated data attributes from the telephony switches. The captured data can be
used for the purposes of associating network and switching events back to circuits
and reporting on the impact to these circuits.
This section describes alarm and transmission events, as well as the windows that
capture route, trunk group, device and associated data attributes from telephony
switches.

Traffic Events
Traffic events can be categorised as:
• Route alarms
These alarms provide information about the status of a route to a
destination, for example the counts of devices that are blocked. Threshold
parameters for alarm generation are set at the switch.
• Trunk Group alarms
These alarms are generated to indicate when the working status of a trunk
group has changed. Total and available device counts are also reported.
• DIP alarms
These alarms are generated when either a failure of the connecting E1 trunk
has been detected or a software problem has occurred that has changed the
working status.
• Device alarms
These alarms are assigned the lowest severity level because they have very
little impact on the traffic that is switched to a destination.
• Signalling Link and Link Set alarms
These alarms have varying levels of severity.

Transmission Events
A network generates a variety of alarms that can be classified as either
information or traffic affecting alarms. Typical transmission alarms generated by
an E1 event are as follows:
• AIS (traffic impacting); transmitted downstream informing that an
upstream failure has been detected.
• REM (traffic impacting); other equipment that is connected in the
transmission path is in an alarm state.
• BER (non traffic affecting); Bit Error Alarm. Indicates a degradation in
the performance of the circuit path.

582
 TR A F F I C M A N A G E M E N T
Overview

Traffic Management Menu Options

The Traffic Management sub-menu, accessed from the Inventory menu,
contains the following options:

Menu Option See...

Routes page 584

Trunk Groups page 587

Link Sets page 591

Traffic Destinations page 597

Destination Codes page 599

Routes to Destinations page 601

Destination Codes to Destinations page 605

Trunk Groups and Link Sets to Routes page 609

Circuits to Trunk Groups page 613

Note
The names of the fields in the Traffic Management forms can be
customized using the Boiler Plate Text window.

583
TR A F F I C M A N A G E M E N T
Routes Window

Routes Window
The Routes window allows the user to retrieve, modify and delete existing traffic
routes, and add traffic routes.
To open the Routes window
• From the Inventory menu, click Traffic Management and then click
Routes.

Figure 25–1. Routes window

The Routes window has the following section:

Section See...

Routes page 584

Routes Section
This section displays all routes that have been created in the OSS. The Routes
section is also used to add and delete routes, and to update the details of an
existing route.

584
 TR A F F I C M A N A G E M E N T
Routes Window

Fields
The fields in the Routes section are:

Field Description

Name Name of the route. (Mandatory). On query, the records

in the Routes window are sorted alphabetically based on
the Name field. By default, the names are sorted in the
descending alphabetical order.

Status Current status of the route. Use LOV to select a valid

status. (Mandatory).

Customer Identifies the customer/carrier that the route is servicing.

Use LOV to select a valid customer/carrier. (Mandatory).

Direction Direction of traffic on the route. A route can have

Incoming (I/C) traffic, Outgoing (O/G) traffic, or traffic
can be carried in both directions, i.e. Bothways (B/W).
(Mandatory).

Medium Indicates the transmission medium over which the route

is carried, e.g. Cable, Diverse, Microwave, Satellite.
(Optional).

Signalling Signalling protocol, usually Signalling System # 7 (SS7).

(Optional).

Protocol Network protocol, e.g. PSTN, ISDN. (Optional).

Control Mechanism Type of traffic commands to send to a switch (Optional).

Orig. Switch Remote exchange from which traffic on the route

originates. Use LOV to select valid switches. (Mandatory).

Table 25–1. Routes section; fields (sheet 1 of 2)

585
TR A F F I C M A N A G E M E N T
Routes Window

Field Description

Term. Switch Local exchange at which traffic on the route terminates.

Use LOV to select valid switches. (Mandatory).
Note
The LOV for both the Orig.Switch and Term.Switch will
retrieve network elements that belong to the domain(s)
specified by the product feature IM:00901. The domains
that can be added to the parameter values are set up in
the Inventory > Reference Data > Network elements
> Domains form.
If this product feature is disabled, all originating and
terminating switches that belong to the 'SWITCHING'
domain will be retrieved. If this product feature is
enabled, all originating and terminating switches that
belong to the comma-separated list of domains specified
by product feature parameter IM:00902 will be retrieved.

Description Free text to describe the route. (Mandatory).

Table 25–1. Routes section; fields (sheet 2 of 2)

586
 TR A F F I C M A N A G E M E N T
Trunk Groups Window

Trunk Groups Window

The Trunk Groups window allows the user to retrieve, modify and delete existing
trunk groups as well as add new trunk groups.
To open the Trunk Groups window
• From the Inventory menu, select Traffic Management and then click
Trunk Groups.

Figure 25–2. Trunk Groups window

Trunk Groups Section

This section displays all trunk groups that have been created in the OSS. The
Trunk Groups section is also used to add and delete trunk groups, and to update
the details of an existing trunk group.

Fields
The fields in the Trunk Groups section are:

Field Description

Name Name of the trunk group. (Mandatory). The list of records

retrieved in this window is sorted based on the Name
column in a descending alphabetical order.

Alternate Name An alias for the trunk group. (Optional).

Table 25–2. Trunk Groups section; fields (sheet 1 of 2)

587
TR A F F I C M A N A G E M E N T
Trunk Groups Window

Field Description

Status Current status of the trunk group. Use LOV to select a

valid status. (Mandatory).

Protocol Network protocol, e.g. PSTN, ISDN. (Optional).

Device Count Number of devices allocated to this trunk group.

(Mandatory).

Current Utilisation Number of allocated devices that are actually in use.

(Mandatory).

Control Mechanism Type of traffic commands to send to a switch (Optional).

Direction Direction of traffic on the trunk group. A trunk group can

have Incoming (I/C) traffic, Outgoing (O/G) traffic, or
traffic can be carried in both directions, i.e. Bothways
(B/W). (Mandatory).

Orig. Switch Remote exchange from which traffic on the route

originates. Use LOV to select valid switches. (Mandatory).

Term. Switch Local exchange at which traffic on the route terminates.

Use LOV to select valid switches. (Mandatory).
Note
The LOV for both the Orig.Switch and Term.Switch will
retrieve network elements that belong to the domain(s)
specified by the product feature IM:00901.
If this product feature is disabled, all originating and
terminating switches that belong to the 'SWITCHING'
domain will be retrieved. If this product feature is
enabled, all originating and terminating switches that
belong to the comma-separated list of domains specified
by product feature parameter IM:00902 will be retrieved.
The domains listed in the parameter values of this
product feature are set up in the Inventory > Reference
Data > Network elements > Domains form.

Description Free text to describe the trunk group. (Mandatory).

Table 25–2. Trunk Groups section; fields (sheet 2 of 2)

588
 TR A F F I C M A N A G E M E N T
Trunk Groups Window

Button
The button in the Trunk Groups window is:

Button Description

Trunk Group Retrieves the parameters that are associated with the
Parameters trunk group.

Table 25–3. Trunk Groups window; button

Trunk Group Parameters window

The Trunk Group Parameters window allows the user to retrieve, modify and
delete the parameters that are associated with a trunk group. In addition, this
window can be used to add parameters to a trunk group.

Figure 25–3. Trunk Group Parameters window

Field Description

Name The trunk group parameter name. Use LOV to select a

valid parameter name. (Mandatory).

Data Type Type of data that can be entered in the Short Value and
Long Values fields. (Mandatory).

Short Value The short value associated with the parameter.

(Optional).

Table 25–4. Trunk Group Parameters window; fields (sheet 1 of 2)

589
TR A F F I C M A N A G E M E N T
Trunk Groups Window

Field Description

Long Value The long value associated with the parameter.

(Optional).

Defined by Role of the person who created the parameter.

(Mandatory).

Optionality • Specifies whether or not parameter values are

required. If Optionality is 'Fixed', the parameter value
cannot be changed after the parameter has been
saved. (Mandatory).

Table 25–4. Trunk Group Parameters window; fields (sheet 2 of 2)

Button
The button in the Trunk Group Parameters window is:

Button Description

Load Parameters Adds to the Trunk Group section, the parameters defined
in a template that is associated with the currently selected
trunk group.

Table 25–5. Trunk Group Parameters window; button

590
 TR A F F I C M A N A G E M E N T
Link Sets Window

Link Sets Window

The Link Sets window allows the user to retrieve, modify and delete existing link
sets as well as add new link sets. This form also allows users to add circuits and
data connections to the link sets.
To open the Link Sets window
• From the Inventory menu, select Traffic Management and then click
Link Sets.

Figure 25–4. Link Sets window

Link Sets Section

This section displays all the link sets that have been created in the OSS. The Link
Sets section is also used to add and delete link sets, and to update the details of
an existing link set.

591
TR A F F I C M A N A G E M E N T
Link Sets Window

Fields
The fields in the Link Sets section are:

Field Description

Name Name of the link set. (Mandatory). The list of records

retrieved in this window is sorted based on the Name
column in a descending alphabetical order.

Alternate Name An alias for the link set. (Optional).

Status Current status of the link set. Use LOV to select a valid
status. (Mandatory).

Protocol Network protocol, e.g. PSTN, ISDN. (Optional).

Device Count Number of devices allocated to this link set. (Mandatory).

Current Utilisation Number of allocated devices that are actually in use.

(Mandatory).

Control Mechanism Type of traffic commands to send to a switch (Optional).

Direction Direction of traffic on the link set. A link set can have
Incoming (I/C) traffic, Outgoing (O/G) traffic, or traffic
can be carried in both directions, i.e. Bothways (B/W).
(Mandatory).

Orig. Switch Remote exchange from which traffic on the route

originates. Use LOV to select valid switches. (Mandatory).

Table 25–6. Link Sets section; fields (sheet 1 of 2)

592
 TR A F F I C M A N A G E M E N T
Link Sets Window

Field Description

Term. Switch Local exchange at which traffic on the route terminates.

Use LOV to select valid switches. (Mandatory).
Note
The LOV for both the Orig.Switch and Term.Switch will
retrieve network elements that belong to the domain(s)
specified by the product feature IM:00901.
If this product feature is disabled, all originating and
terminating switches that belong to the 'SWITCHING'
domain will be retrieved. If this product feature is
enabled, all originating and terminating switches that
belong to the comma-separated list of domains specified
by product feature parameter IM:00902 will be retrieved.
The domains listed in the parameter values of this
product feature are set up in the Inventory > Reference
Data > Network elements > Domains form.

Description Free text to describe the link set. (Mandatory).

Table 25–6. Link Sets section; fields (sheet 2 of 2)

Circuits Section
This section allows the user to associate circuits with the link sets. One or more
circuits may be associated with a link set. Furthermore, a circuit may be
associated with more than one link set.
Before an association can be made, circuits must have been created using the
Circuit Design window.

Field Description

Name The circuit name. Users can select from the LOV
available on this field.

Table 25–7. Circuits Section; field

593
TR A F F I C M A N A G E M E N T
Link Sets Window

Data Connections Section

This section allows the user to associate data connections with the link set.

Field Description

Name The name of the data connection. Users can select from
the LOV available on this field. LOV will restrict to data
connections that satisfy all of the below conditions:
• Start Point and End Point are Network Element
• Data connection type is Infrastructure
• Start Point matches either Link Set's Orig Switch or
Term Switch
• End Point matches either Link Set's Orig Switch or
Term Switch

Table 25–8. Data Connections section; field

Link Set Parameters window

Click on the Link Set Parameters button on the Link sets window to launch the
Link Set Parameters window. This window allows the user to retrieve, modify and

594
 TR A F F I C M A N A G E M E N T
Link Sets Window

delete the parameters that are associated with a link set. In addition, this window
can be used to add parameters to a link set.

Figure 25–5. Link Set Parameters window

Field Description

Name The link set parameter name. Use LOV to select a valid
parameter name. (Mandatory).

Data Type Type of data that can be entered in the Short Value and
Long Values fields. (Mandatory).

Short Value The short value associated with the parameter.

(Optional).

Long Value The long value associated with the parameter.

(Optional).

Defined by Role of the person who created the parameter.

(Mandatory).

Optionality Specifies whether or not parameter values are required.

If Optionality is 'Fixed', the parameter value cannot be
changed after the parameter has been saved.
(Mandatory).

Table 25–9. Link Set Parameters window; fields

595
TR A F F I C M A N A G E M E N T
Link Sets Window

Button
The button in the Link Set Parameters window is:

Button Description

Load Parameters Adds to the Link Set Parameters section, the

parameters defined in a template that is associated with
the currently selected link set.

Table 25–10. Link Set Parameters window; button

596
 TR A F F I C M A N A G E M E N T
Traffic Destinations Window

Traffic Destinations Window

The Traffic Destinations window allows the user to retrieve, modify and delete
existing traffic destinations, and add traffic destinations.
To open the Traffic Destinations window
• From the Inventory menu, click Traffic Management and then click
Traffic Destinations.

Figure 25–6. Traffic Destinations window

The Traffic Destinations window has the following section:

Section See...

Traffic Destinations page 602

Traffic Destinations Section

This section displays the traffic destinations that have been created in the OSS.
The Traffic Destinations section is also used to add and delete traffic destinations,
and to update the details of an existing traffic destination.

597
TR A F F I C M A N A G E M E N T
Traffic Destinations Window

Fields
The fields in the Traffic Destinations section are:

Field Description

Mnemonic An alias that is assigned to a traffic destination and is

recognised by the network. (Mandatory)

Name Any meaningful name can be given to a traffic

destination. (Mandatory)

Country/Area The country or area in which the traffic destination is

carried. (Mandatory)

UTC Offset Universal Time Coordinate (UTC) is used as the baseline

for a time offset that is assigned to a traffic destination.
UTC was formerly known as Greenwich Mean Time
(GMT). (Optional).

Description Any meaningful description can be used to describe a

traffic destination. (Mandatory)

Provider Name of the service provider at the traffic destination.

(Optional).

Table 25–11. Traffic Destination section; fields

598
 TR A F F I C M A N A G E M E N T
Destination Codes Window

Destination Codes Window

The Destination Codes window allows the user to retrieve, modify and delete
existing destination codes, and add destination codes.
To open the Destination Codes window
• From the Inventory menu, click Traffic Management and then click
Destination Codes.

Figure 25–7. Destination Codes window

The Destination Codes window has the following section:

Section See...

Destination Codes page 599

Destinations Codes Section

This section displays all destination codes that have been created in the OSS. The
Destination Codes section is also used to add and delete destination codes, and
to update the details of an existing destination code.

Fields
The fields in the Destination Codes section are:

599
TR A F F I C M A N A G E M E N T

Field Description

Code Part of a telephone number, or a complete telephone

number, that is associated with the traffic destination.
(Mandatory).

Owner Telecommunications Company that owns the destination

code. (Mandatory).

Description Any meaningful description can be used to describe a

traffic destination. (Mandatory)

Table 25–12. Destination Code section; fields

600
 TR A F F I C M A N A G E M E N T
Routes to Destinations Window

Routes to Destinations Window

The Routes to Destinations window allows the user to associate routes with
traffic destinations. One or more routes may be associated with a destination.
Furthermore, a route may be associated with more than one destination.

Note
Before an association can be made, routes must be created using the
Routes window, and traffic destinations must be created using the Traffic
Destinations window.

To open the Routes to Destinations window

1 From the Inventory menu, click Traffic Management and then click Routes
to Destinations.

Figure 25–8. Routes to Destinations window

The Routes to Destinations window has the following sections:

Section See...

Destinations page 602

Routes page 603

601
TR A F F I C M A N A G E M E N T
Routes to Destinations Window

Destinations Section
This section displays the traffic destinations that have been created in the OSS.

Figure 25–9. Destinations section

Fields
The fields in the Destinations section are:

Field Description

Mnemonic An alias that is assigned to the traffic destination and is

recognised by the network. When entering query criteria,
use LOV to select an existing mnemonic. (Read only).

Name Name of the traffic destination. When entering query

criteria, use LOV to select the name of an existing
destination. (Read only).

Country Country or area in which the traffic destination resides.

When entering query criteria, use LOV to select a
country/area with which existing destinations are
associated. (Read only).

UTC Offset Universal Time Coordinate (UTC) is used as the baseline

for a time offset that is assigned to a traffic destination.
UTC was formerly known as Greenwich Mean Time
(GMT). (Read only).

Description Free text to describe the traffic destination. (Read only).

Provider Name of the service provider at the traffic destination.

When entering query criteria, use LOV to select a
provider with which a destination is associated. (Read
only).

Table 25–13. Destination section; fields

602
 TR A F F I C M A N A G E M E N T
Routes to Destinations Window

Routes Section
This section displays all routes that are associated with the destination retrieved in
the Destinations section. The Routes section is also used to associate routes with a
destination.

Figure 25–10. Routes section

Fields
The fields in the Routes section are:

Field Description

Name Name of the route. Use LOV to select an existing route.

(Mandatory).

Status Current status of the route. (Read only).

Customer Identifies the customer/customer that the route is

servicing. (Read only).

Direction Direction of traffic on the route. A route can have

Incoming (I/C) traffic, Outgoing (O/G) traffic, or traffic
can be carried in both directions, i.e. Bothways (B/W).
(Read only).

Medium Indicates the transmission medium over which the route

is carried, e.g. Cable, Diverse, Microwave, Satellite.
(Read only).

Table 25–14. Routes section; fields (sheet 1 of 2)

603
TR A F F I C M A N A G E M E N T
Routes to Destinations Window

Field Description

Signalling Signalling protocol, usually Signalling System # 7 (SS7).

(Read only).

Protocol Network protocol, e.g. PSTN, ISDN. (Read only).

Control Mechanism Traffic command to send to a switch (Read only).

Orig. Switch Remote exchange from which traffic on the route

originates. (Read only).

Term. Switch Local exchange at which traffic on the route terminates.

(Read only).

Description Free text to describe the route. (Read only).

Table 25–14. Routes section; fields (sheet 2 of 2)

604
 TR A F F I C M A N A G E M E N T
Destination Codes to Destinations Window

Destination Codes to Destinations Window

The Destination Codes to Destinations window allows the user to associate
destination codes with traffic destinations. One or more destination codes may be
associated with a destination. Furthermore, a destination code may be associated
with more than one destination.

Note
Before an association can be made, traffic destinations must be created
using the Traffic Destinations window, and destination codes must be
created using the Destination Codes window.

To open the Destination Codes to Destinations window

• From the Inventory menu, select Traffic Management and then click
Destination Codes to Destinations.

Figure 25–11. Destination Codes to Destinations window

605
TR A F F I C M A N A G E M E N T
Destination Codes to Destinations Window

The Destination Codes to Destinations window has the following sections:

Section See...

Search Criteria page 606

Destinations page 607

Destination Codes page 608

Search Criteria Section

This section allows the user to select a remote exchange from which traffic
originates.

Figure 25–12. Search Criteria section

The fields in the Search Criteria section are:

Field

Field Description

Originating Switch Remote exchange from which traffic originates. Use LOV
to select an existing switch. Note that the values displayed
will depend on Product Feature IM:00901.

Table 25–15. Search Criteria section; field

Button
The button in the Search Criteria section is:

Button Description

Search Retrieves the traffic destinations that are associated with

the switch entered in the Originating Switch field.

Table 25–16. Search Criteria section; button

606
 TR A F F I C M A N A G E M E N T
Destination Codes to Destinations Window

Destinations Section
This section displays the traffic destinations that are associated with the switch
entered in the Originating Switch field.

Figure 25–13. Destinations section

The fields in the Destinations section are:

Fields

Field Description

Mnemonic An alias that is assigned to the traffic destination and is

recognised by the network. When entering query criteria,
use LOV to select an existing mnemonic. (Read only).

Name Name of the traffic destination. When entering query

criteria, use LOV to select the name of an existing
destination. (Read only).

Country/Area Country or area in which the traffic destination resides.

When entering query criteria, use LOV to select a
country/area with which existing destinations are
associated. (Read only).

Description Free text to describe the traffic destination. (Read only).

Provider Name of the service provider at the traffic destination.

When entering query criteria, use LOV to select a
provider with which a destination is associated. (Read
only).

Table 25–17. Destination section; fields

607
TR A F F I C M A N A G E M E N T
Destination Codes to Destinations Window

Destination Codes Section

This section displays all destination codes that are associated with the destination
currently selected in the Destinations section. The Destination Codes section is
also used to associate destination codes with a destination.

Figure 25–14. Destination Codes section

The fields in the Destination Codes section are:

Fields

Field Description

Code Part of a telephone number, or a complete telephone

number that is associated with the traffic destination. Use
LOV to select an existing code. (Mandatory).

Owner Telecommunications company that owns the destination

code. (Read only).

Description Free text that describes the destination code. May be

used to define the area in which the destination code
resides. (Read only).

Table 25–18. Destination Codes section; fields

608
 TR A F F I C M A N A G E M E N T
Trunk Group and Link Sets to Routes

Trunk Group and Link Sets to Routes

The Trunk Groups and Link Sets to Routes window allows the user to associate
trunk groups or link sets with routes. One or more trunk groups or link sets may
be associated with a route. Furthermore, a trunk group or link set may be
associated with more than one route.

Note
Before an association can be made, trunk groups and link sets must have
been created using the Trunk Groups and Link Sets windows, and
routes must have been created using the Routes window.

To open the Trunk Groups and Link Sets to Routes window

• From the Inventory menu, select Traffic Management and then click
Trunk Groups and Link Sets to Routes.

Figure 25–15. Trunk Groups and Link Sets to Routes window

The Trunk Groups and Link Sets to Routes window has the following sections:

Section See...

Routes page 610

Trunk Groups and Link page 611

Sets

609
TR A F F I C M A N A G E M E N T
Trunk Group and Link Sets to Routes

Routes Section
This section displays the routes that have been created in the OSS.

Figure 25–16. Routes section

The fields in the Routes section are:

Fields

Field Description

Name Name of the route. When entering query criteria, use

LOV to select an existing route. (Read only).

Status Current status of the route. When entering query criteria,

use LOV to select a valid status. (Read only).

Customer Identifies the customer/carrier that the route is servicing.

When entering query criteria, use LOV to select a valid
customer/carrier. (Read only).

Direction Direction of traffic on the route. A route can have

Incoming (I/C) traffic, Outgoing (O/G) traffic, or traffic
can be carried in both directions, i.e. Bothways (B/W).
(Read only).

Medium Indicates the transmission medium over which the route

is carried, e.g. Cable, Diverse, Microwave, Satellite.
(Read only).

Signaling Signalling protocol, usually Signalling System # 7 (SS7).

When entering query criteria, use LOV to select a valid
signaling protocol. (Read only).

Protocol Network protocol, e.g. PSTN, ISDN. When entering query

criteria, use LOV to select a valid network protocol. (Read
only).

Table 25–19. Routes section (sheet 1 of 2)

610
 TR A F F I C M A N A G E M E N T
Trunk Group and Link Sets to Routes

Field Description

Originating Switch Remote exchange from which traffic on the route

originates. When entering query criteria, use LOV to
select a valid switch. (Read only).

Terminating Switch Local exchange at which traffic on the route terminates.

When entering query criteria, use LOV to select a valid
switch. (Read only).

Description Free text that describes the route. (Read only)

Table 25–19. Routes section (sheet 2 of 2)

Trunk Groups and Link Sets Section

This section displays all trunk groups and link sets that are currently associated
with the route retrieved in the Routes section. The Trunk Groups and Link Sets
section is also used to associate trunk groups and link sets with a route.

Figure 25–17. Trunk Groups and Link Sets section

The fields in the Trunk Groups and Link Sets section are:
Fields

Field Description

Name Name of the trunk group or link set. Use LOV to select an
existing trunk group or link set. (Mandatory).

Table 25–20. Trunk Groups and Link Sets section (sheet 1 of 2)

611
TR A F F I C M A N A G E M E N T
Trunk Group and Link Sets to Routes

Field Description

Alternate Name An alternate name for the trunk group or link set. (Read
only).

Status Current status of the trunk group or link set. (Read only).

Protocol Network protocol, e.g. PSTN, ISDN. (Read only).

Device Count Number of devices allocated to this trunk group or link

set. (Read only).

Current Utilisation Number of allocated devices that are actually in use.

(Read only).

Control Mechanism Traffic command to send to a switch (Read only).

Orig. Switch Remote exchange from which traffic on the route

originates. When entering query criteria, use LOV to
select a valid switch. (Read only).

Term. Switch Local exchange at which traffic on the route terminates.

When entering query criteria, use LOV to select a valid
switch. (Read only).

Direction Direction of traffic on the trunk group or link set. A trunk

group/link set can have Incoming (I/C) traffic, Outgoing
(O/G) traffic, or traffic can be carried in both directions,
i.e. Bothways (B/W). (Read only).

Description Free text that describes the trunk group or link set. (Read
only).

Table 25–20. Trunk Groups and Link Sets section (sheet 2 of 2)

612
 TR A F F I C M A N A G E M E N T
Circuits to Trunk Groups

Circuits to Trunk Groups

The Circuits to Trunk Groups window allows the user to associate circuits with
trunk groups. One or more circuits may be associated with a trunk group.
Furthermore, a circuit may be associated with more than one trunk group.
Before an association can be made, circuits must be created using the Circuit
Design window, and trunk groups must have been created using the Trunk
Groups window.
To open the Circuits to Trunk Groups window
• From the Inventory menu, select Traffic Management and then click
Circuits to Trunk Groups.

Figure 25–18. Circuits to Trunk Groups window

The Circuits to Trunk Groups window has the following sections:

Section See...

Trunk Groups page 611

Circuits page 615

613
TR A F F I C M A N A G E M E N T
Circuits to Trunk Groups

Trunk Groups Section

This section allows the user to query all the trunk groups that have been created in
the OSS.

Figure 25–19. Trunk Groups section

The fields in the Trunk Groups section are:

Fields

Field Description

Name Name of the trunk group. When entering query criteria,

use LOV to select a valid trunk group. (Read only).

Alternate Name An alternate name for the trunk group. When entering
query criteria, use LOV to select a valid alternate trunk
group.(Read only).

Status The current status of the trunk group. When entering

query criteria, use LOV to select a valid status. (Read
only).

Protocol Network protocol, e.g. PSTN, ISDN. When entering query

criteria, use LOV to select a valid protocol. (Read only).

Device Count Number of devices allocated to this trunk group (Read

only).

Current Utilisation Number of allocated devices that are actually in use.

(Read only).

Control Mechanism Traffic command to send to a switch (Read only).

Direction Direction of traffic on the trunk group. A trunk group can

have Incoming (I/C) traffic, Outgoing (O/G) traffic, or
traffic can be carried in both directions, i.e. Bothways
(B/W). (Read only).

Table 25–21. Trunk Groups section (sheet 1 of 2)

614
 TR A F F I C M A N A G E M E N T
Circuits to Trunk Groups

Field Description

Orig. Switch Remote exchange from which traffic on the route

originates. Use LOV to select valid switches. (Read only).

Term. Switch Local exchange at which traffic on the route terminates.

Description Free text that describes the route. (Read only).

Table 25–21. Trunk Groups section (sheet 2 of 2)

Circuits Section
This section displays all circuits that are associated with the trunk group currently
selected in the Trunk Groups section. The Circuits section is also used to associate
circuits with a trunk group.

Figure 25–20. Circuits section

The field in the Circuits section is:

Field Description

Name Name of the circuit. Use LOV to select a valid circuit

name. (Mandatory).
When selecting Circuits to add to an existing record, the
LOV will display only those circuits that have the Orig.
Switch for the selected trunk group as the Network
Element used in one of their To/From cross-connects on
the Circuit Design form.

Table 25–22. Circuits section; field

615
TR A F F I C M A N A G E M E N T
Features of the Traffic Management windows

Features of the Traffic Management windows

The features of the Traffic Management windows are:

Feature See...

Creating a route page 617

Creating a trunk group or link set page 618

Creating a traffic destination page 621

Creating a destination code page 622

Associating a route with a destination page 623

Associating a destination code with a destination page 624

Associating a trunk group or link set with a route page 625

Associating a circuit with a trunk group page 626

616
 TR A F F I C M A N A G E M E N T
Creating a Route

Creating a Route
This procedure describes how to create a route in the Routes window.
To create a route
1 Open the Routes window.
See Routes Window on page 584 for more information about opening this
window.
2 In the Name field, enter a name for the route. This must be unique.
3 In the Status field, enter the initial status of the route.
4 In the Customer field, enter the customer/carrier that the route will service.
5 In the Direction field, enter the direction of the route. A route can have
Incoming (I/C) traffic, Outgoing (O/G) traffic, or traffic can be carried in
both directions, i.e. Bothways (B/W).
6 If desired, in the Medium field, enter the transmission medium over which the
route will be carried, e.g. Cable, Diverse, Microwave, Satellite.
7 If desired, in the Signalling field, enter the signalling protocol, e.g. SS7.
8 If desired, in the Protocol field, enter the network protocol, e.g. PSTN.
9 If desired, in the Control Mechanism field, enter the traffic command that is
to be sent to the switch.
10 In the Orig. Switch field, enter the remote exchange from which traffic on the
route will originate.
11 In the Term. Switch field, enter the local exchange at which traffic on the
route will terminate.
12 In the Description field, enter text to describe the route.
13 Click the Save button on the toolbar.
If the appropriate traffic destinations exist in the OSS, the new route can be
associated with a traffic destination. See Associating a Route with a Traffic
Destination on page 623 for more information.
If the appropriate trunk groups exist in the OSS, a trunk group can be
associated with the new route. See Associating a Trunk Group/Link Set with a
Route on page 625 for more information.

617
TR A F F I C M A N A G E M E N T
Creating a Trunk Group or Link Set

Creating a Trunk Group or Link Set

This procedure describes how to create a trunk group.

Note
The same process must be followed to create a link set using the Link Sets
window. The parameters on the Link Sets window are the same as the
Trunk Groups window.

To create a trunk group

1 Open the Trunk Groups window.
See Trunk Groups Window on page 587 for more information about opening
this window.
2 In the Name field, enter a name for the trunk group that you want to create.
This must be unique.
3 If desired, in the Alternate Name field, enter an alias.
4 In the Status field, enter the initial status of the trunk group.
5 If desired, in the Protocol field, enter the network protocol for the trunk
group, e.g. PSTN.
6 In the Device Count field, enter the number of devices that are allocated to
this trunk group.
7 In the Current Utilisation field, enter the number of allocated devices that are
actually in use.
8 If desired, in the Control Mechanism field, enter the traffic command that is
to be sent to the switch.
9 In the Direction field, enter the direction of traffic that will be on the trunk
group. A trunk group can have Incoming (I/C) traffic, Outgoing (O/G) traffic,
or traffic can be carried in both directions, i.e. Bothways (B/W).
10 Select the Originating and Terminating switches.
11 In the Description field, enter text to describe the trunk group.
To manually create trunk group parameters
1 In the Trunk Groups section, click the Trunk Group Parameters button.
The Trunk Group Parameters window opens.
2 In the Name field, use the LOV to select the name of the parameter to be
associated with the new trunk group.
3 In the Data Type field, select the type of data that will be allowed for the Short
Value and Long Value parameters. If 'Character' is selected, any uppercase
or lowercase letter may be entered in the Short Value and Long Value fields.
If 'Number' is selected, any positive number may be entered in the Short
Value and Long Value fields. If 'Date' is selected, any date in the format 'DD-
MON-YYYY' may be entered in the Short Value and Long Value fields. If
'Alphanumeric' is selected, any uppercase or lowercase letter and/or any
positive number may be entered in the Short Value and Long Value fields. If

618
 TR A F F I C M A N A G E M E N T
Creating a Trunk Group or Link Set

'No Validation' is selected, any letter, number and/or symbol may be entered
in the Short Value and Long Value fields.
4 If desired, in the Short Value field, enter a parameter value that corresponds
with the Data Type selected in step 3.
5 If desired, in the Long Value field, enter a parameter value that corresponds
with the Data Type selected in step 3.
6 In the Defined By field, select the role that corresponds with the current user.
7 In the Optionality field, select a value to indicate whether or not the Short
Value and Long Value fields require to be populated. If 'Optional' is selected,
a value is not required for the Short Value and Long Value fields. If
'Mandatory' is selected, a value must be supplied for the Short Value and
Long Value fields. If 'Fixed' is selected, the values in the Short Value and Long
Value fields cannot be changed after the changes have been saved.
8 Click the Save button on the toolbar.
To add trunk group parameters from a template
1 Use LOV to select the trunk group parameter template from which
parameters are to be loaded. This will automatically populate the Trunk
Groups section with the parameters defined in the template.
2 If necessary, modify any of the parameter values.
3 Click the Save button on the toolbar.
If the appropriate routes exist in the OSS, the new trunk group can be
associated with a route. See Associating a Trunk Group/Link Set with a Route
on page 625 for more information.
If the appropriate circuits exist in the OSS, a circuit can be associated with the
new trunk group or link set. See Associating a Circuit with a Trunk Group on
page 626 for more information.
To create a link set
1 Open the Link Set window. See Link Sets Window on page 591 for
information.
2 Follow the same process as described above to create a link set.

Note
Circuits and data connections are associated with the link set in the Link
Sets window itself.

To associate circuits with a link set

1 From the Name LOV in the Circuits block, select the circuit that you want to
associate with the link set. Save you record.
To associate data connections with the link set
1 From the Name LOV in the Data Connections block, select the data
connection that you want to associate with the link set. Only certain kinds of

619
TR A F F I C M A N A G E M E N T
Creating a Trunk Group or Link Set

data connections will be available for selection. See Data Connections

Section on page 594 for information on the conditions that apply.

620
 TR A F F I C M A N A G E M E N T
Creating a Traffic Destination

Creating a Traffic Destination

This procedure describes how to create a traffic destination in the Traffic
Destinations window.
To create a traffic destination
1 Open the Traffic Destinations window.
See Traffic Destinations Window on page 597 for more information about
opening this window.
2 In the Mnemonic field, enter an alias for the new traffic destination.
3 In the Name field, enter a name for the new destination.
4 In the Country/Area field, enter the name of the country or area in which
the destination resides.
5 If desired, in the UTC Offset field, enter the time offset assigned to the new
destination.
6 In the Description field, enter a description for the new destination.
7 Click the Save button on the toolbar.
If the appropriate routes exist in the OSS, routes can be associated with the
new traffic destination. See Associating a Route with a Traffic Destination on
page 623 for more information.
If the appropriate destination codes exist in the OSS, these can be associated
with the new traffic destination. See Associating a Destination Code with a
Traffic Destination on page 624 for more information.

621
TR A F F I C M A N A G E M E N T
Creating a Destination Code

Creating a Destination Code

This procedure describes how to create a destination code in the Destination
Codes window.
To create a destination code
1 Open the Destination Code window.
See Destination Codes Window on page 599 for more information about
opening this window.
2 In the Code field, enter part of a telephone number, or a complete telephone
number that is allocated to the traffic destination.
3 In the Owner field, enter the telecommunications company that owns the
destination code.
4 In the Description field, enter text that describes the destination code.
Alternatively, enter the area in which the destination code resides.
5 Click the Save button on the toolbar.
If the appropriate traffic destinations exist in the OSS, the new destination
code can be associated with the traffic destination. See Associating a
Destination Code with a Traffic Destination on page 624 for more
information.

622
 TR A F F I C M A N A G E M E N T
Associating a Route with a Traffic Destination

Associating a Route with a Traffic Destination

This procedure describes how to associate a route with a traffic destination in the
Routes to Destinations window.
Associating a route with a traffic destination
1 Open the Routes to Destinations window.
See Routes to Destinations Window on page 601 for more information about
opening this window.
2 In the Destinations section, use the Query button to select a traffic
destination.
3 In the Routes section, use the Query button to retrieve the routes that are
already associated with the traffic destination selected in the Destinations
section.
4 In the Name field of the Routes section, use the LOV to select a route to be
associated with the traffic destination selected in the Destinations section. The
remaining fields in the Routes section will be automatically populated.
5 Click the Save button on the toolbar.

623
TR A F F I C M A N A G E M E N T
Associating a Destination Code with a Traffic Destination

Associating a Destination Code with a Traffic

Destination
This procedure describes how to associate a destination code with a traffic
destination in the Destination Codes to Destinations window.
Associating a destination code with a traffic destination
1 Open the Destination Codes to Destinations window.
See Destination Codes to Destinations Window on page 605 for more
information about opening this window.
2 In the Originating Switch field of the Search Criteria section, use the LOV to
select a switch that is associated with the traffic destination to which a
destination code is to be mapped.
3 In the Search Criteria section, use the Search button to retrieve the traffic
destinations that are associated with the switch entered in the Originating
Switch field.
4 In the Destinations section, select the destination to which a destination code
is to be associated. This will automatically retrieve the destination codes that
are currently associated with this destination.
5 In the Code field of the Destination Codes block, use the LOV to select a
destination code that is to be associated with the traffic destination retrieved
in the Destinations section. Upon selection of a valid destination code, the
Owner and Description fields will be automatically populated.
6 Click the Save button on the toolbar.

624
 TR A F F I C M A N A G E M E N T
Associating a Trunk Group/Link Set with a Route

Associating a Trunk Group/Link Set with a Route

This procedure describes how to associate a trunk group or link set with a route in
the Trunk Groups and Link Sets to Routes window.
Associating a trunk group with a route
1 Open the Trunk Groups and Link Sets to Routes window.
See Trunk Group and Link Sets to Routes on page 609 for more information
about opening this window.
2 In the Routes section, use the Query button to select a route. A list of routes
will be retrieved. The trunk groups or link sets that are associated with the
route will be automatically populated into the Trunk Groups and Link Sets
section.
3 In the Name field of the Trunk Groups and Link Sets section, use the LOV to
select a new trunk group or link set that is to be associated with the route.
The remaining fields in the Trunk Groups and Link Sets section will be
automatically populated.
4 Click the Save button on the toolbar.

625
TR A F F I C M A N A G E M E N T
Associating a Circuit with a Trunk Group

Associating a Circuit with a Trunk Group

This procedure describes how to associate a circuit with a trunk group in the
Circuits to Trunk Groups window.
Associating a circuit with a trunk group
1 Open the Circuits to Trunk Groups window.
See Circuits to Trunk Groups on page 613 for more information about
opening this window.
2 In the Trunk Groups section, use the Query button to select a trunk group.
The circuits that are associated with the trunk group will be retrieved into the
Circuits section.
3 In the Name field of the Circuits section, use the LOV to select a circuit that is
to be associated with the trunk group. The remaining fields in the Circuits
section will be automatically populated.
4 Click the Save button on the toolbar.

626
 CHAPTER 26

Reports

This section provides an overview of reports available from the Inventory menu.

627
REPORTS
Inventory Report Types

Inventory Report Types

Reports are available from the Reports menu option in the Inventory suite. The
types of reports available are shown in the following table:

Report Type See…

Cable Sheaths page 631

Circuits page 632

Frames page 640

Rings page 641

Routing Definition page 642

Sub Network Definition page 643

Report Parameters Specific to Inventory

There are some application-specific parameters for accessing Inventory reports.
These parameters are in addition to the commonly used generic parameters and
include:

Parameter Description

Destination Type The place that you want the report to be displayed. Valid
choices are cache, and file.

Destination Name The name of the destination file, if file is chosen as the
destination type.

Circuit Name Unique identification number that represents the

sequence of a service number.

From Date The first date you want the database to search for
records. Sometimes this date is fixed by the system.

Location A The location from which the report should generate data
from.

Table 26–1. Report Parameters specific to Service Manager (sheet 1 of 3)

628
 REPORTS
Inventory Report Types

Parameter Description

Location B The location from which the report should generate data
to.

Report Format Choose the output format of the report. Choices are:
• Delimited
• HTML
• HTML StyleSheet
• PDF
• Spreadsheet
• RTF
• XML

Market Segment Valid market segment, e.g. Business or Corporate.

Order Type Describes an action to a service. Select one of the

following:
• Create
• Delete
• Suspend
• Resume

Request Number The Request ID of the CSRF it is attached to. The CSRF
may have many.

Revision Number Sequential revision number.

Service Order Unique auto-populated sequenced identification number

Number for a service order.

Service Type Type of service the customer has requested, e.g. PVC -
Internet, or PSTN - Analogue.

Test Name Name for type of test carried out to check a circuit
design.

To Date The last date you want the database to search for
records. This is auto-populated with the current date,
which you can modify.

Traffic Application The intended service usage, e.g. leased line, mobile etc.

Table 26–1. Report Parameters specific to Service Manager (sheet 2 of 3)

629
REPORTS
Inventory Report Types

Parameter Description

Work Activity The number on the Test Results of a Work Order.

Number

Work Group The name of a selected group of people within the

(Name) organization.

Work Order The unique auto-populated identification number of a

Number Work Order.

Table 26–1. Report Parameters specific to Service Manager (sheet 3 of 3)

630
 REPORTS
Cable Sheath Reports

Cable Sheath Reports

Use this report to find the cable sheaths between two locations.
To open the Service Order Tasks Report
1 From the Inventory menu, select Reports and select Cable Sheaths.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Location A field, enter the location A value of the cable sheath.
6 In the Location B field, enter the location B value of the cable sheath.
7 Click the Run Report button.
The report is displayed on your window.

631
REPORTS
Circuits Reports

Circuits Reports
Circuits reports available in the Inventory suite include:

Report Name See...

Bearers over Given Capacity page 632

Capacity of Bearer page 633

Circuit Design page 633

Circuit Hierarchy Down page 634

Circuit Hierarchy Up page 634

Circuit Routing page 635

Circuits Due In Service page 636

Circuit Costed Items page 636

Commissioned Circuit Summary page 636

Inservice Circuit Summary page 637

Out of Service Circuit Summary page 637

Reserved Capacity on Planned NE page 638

Circuit Expiry page 638

Bearers Over Given Capacity Report

Use this report to list details about all circuits that have bearers whose capacity
falls between a selected range.
To open the Bearers Over Given Capacity Report
1 From the Inventory menu, select Reports->Circuits, and select Bearers
Over Given Capacity.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.

632
 REPORTS
Circuits Reports

4 Select the preferred Report Format from the drop-down list.

5 In the Between%Low Capacity field, enter the lowest capacity that you want
to use as a parameter.
6 In the And%High Capacity field, enter the highest capacity that you want to
use as a parameter.
7 Click the Run Report button.
The report is displayed on your window.

Capacity of Bearer Report

Use this report to list the available capacity for a selected circuit name.
To open the Capacity of Bearer Report
1 From the Inventory menu, select Reports->Circuits, and select Capacity
of Bearer.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Circuit Name field, enter the name of the circuit or use LOV to select
from a list.
6 Click the Run Report button.
The report is displayed on your window.

Circuit Design Report

Use this report to list the circuit layout details for a selected circuit name. This
report displays account details, customer, locations, circuit bearer details, related
service order no, type, etc.
To open the Circuit Details Report
1 From the Inventory menu, select Reports->Circuits, and select Circuit
Design.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Circuit Name field, enter the name of the circuit.
6 Click the Run Report button.
The report is displayed on your window.

633
REPORTS
Circuits Reports

Circuit Hierarchy (Down) Report

Use this report to see all services that are carried in a bearer at any level of the
circuit hierarchy (i.e. all circuits below this level in the hierarchy). This report is the
reverse of the Circuit Hierarchy (Up) report.
The report consists of two sections:
• The first section displays information about the selected circuit.
• The second section displays hierarchy information, where each level of
tributary in the hierarchy is separated by an indent.

Note
The report will accept a circuit. On start-up, it will calculate and display
information for the circuit.

To open the Circuit Hierarchy (Down) Report

1 From the Inventory menu, select Reports->Circuits, and select Circuit
Hierarchy Down.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Circuit Name field, enter the name of the circuit.
6 Click the Run Report button.
The report is displayed on your window.

Circuit Hierarchy (Up) Report

A circuit may span from one point to another by using spare capacity on one or
more bearers. In turn, these may ride on one of more bearers. Use this report to
see a complete picture of the circuit hierarchy used by a specific circuit. This report
is the reverse of the Circuit Hierarchy (Down) report.
The report consists of two sections:
• The first section displays information about the selected circuit.
• The second section displays hierarchy information, where each level of
bearer is separated by an indent.

Note
The report will accept a circuit. On start-up, it will calculate and display
information for the circuit.

634
 REPORTS
Circuits Reports

To open the Circuit Hierarchy(Up) Report

1 From the Inventory menu, select Reports->Circuits, and select Circuit
Hierarchy Up.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Circuit Name field, enter the name of the circuit.
6 Click the Run Report button.
The report is displayed on your window.

Circuit Routing Report

This report is a variation of the Circuit Hierarchy (Up) report. Use this report to
display complete routing information for a circuit. In addition to illustrating all
bearers at all levels in the hierarchy, it displays the network element configuration
(cross connections) required to establish each of those bearers. This enables users
to walk through each stage of the path.
The Circuit Routing report consists of three sections:
• Circuit details
• Circuit hierarchy
• Network configuration for each entry in the hierarchy.
The following cross connection information is shown for each port involved in the
link:
• Link sequence
• Link type (physical, logical, etc.)
• Location
• Network Element Type
• Index
• Port name
• Any common port
To open the Circuit Routing Report
1 From the Inventory menu, select Reports->Circuits, and select Circuit
Routing.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Circuit Display Name field, enter the name of the circuit.

635
REPORTS
Circuits Reports

6 Click the Run Report button.

The report is displayed on your window.

Circuit Due In Service Report

Use this report to list circuits of a nominated type that are due in service for a
specified time period.
To open the Circuit Due In Service Report
1 From the Inventory menu, select Reports->Circuits, and select Circuits
Due Inservice.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the From Date field, enter the first date that you want the database to
search for circuits that are due to be placed in service.
6 In the To Date field, enter the last date that you want the database to search
for circuits that are due to be placed in service.
7 Select the Circuit Type (use LOV).
8 Click the Run Report button.
The report is generated as per the destination type in step 2.

Circuit Costed Items Report

Use this report to list costed items recorded against a selected circuit.
To open the Circuit Costed Items Report
1 From the Inventory menu, select Reports->Circuits, and select Circuit
Costed Items.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Circuit Name field, enter the name of the circuit.
6 Click the Run Report button.
The report is generated as per the destination type in step 2.

Commissioned Circuit Summary Report

Use this report to list circuits of a given speed that were commissioned during a
specified begin and end date.

636
 REPORTS
Circuits Reports

To open the Commissioned Circuit Summary Report

1 From the Inventory menu, select Reports->Circuits, and select
Commissioned Circuit Summary.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the From Date field, enter the first circuit record date that you want
retrieved from the database.
6 In the To Date field, enter the last circuit record date that you want retrieved
from the database.
7 Select the Circuit Speed to report on.
8 Click the Run Report button.
The report is generated as per the destination type in step 2.

Inservice Circuit Summary Report

Use this report to list circuits for a given speed that were in service between a
selected begin and end date.
To open the Inservice Circuit Summary Report
1 From the Inventory menu, select Reports->Circuits, and select Inservice
Circuit Summary.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the From Date field, enter the first circuit record date that you want
retrieved from the database.
6 In the To Date field, enter the last circuit record date that you want retrieved
from the database.
7 Select the Circuit Speed to report on.
8 Click the Run Report button.
The report is generated as per the destination type in step 2.

Out of Service Circuit Summary Report

Use this report to list circuits for a given speed that were placed out of service
between a selected begin and end date.

637
REPORTS
Circuits Reports

To open the Out of Service Circuit Summary Report

1 From the Inventory menu, select Reports->Circuits, and select Out of
Service Circuit Summary.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the From Date field, enter the first circuit record date that you want
retrieved from the database.
6 In the To Date field, enter the last circuit record date that you want retrieved
from the database.
7 Select the Circuit Speed to report on.
8 Click the Run Report button.
The report is generated as per the destination type in step 2.

Reserved Capacity on Planned NE Report

Use this report to list details of all circuits that have reserved ports on any planned
network element.
To open the Reserved Capacity on Planned NE Report
1 From the Inventory menu, select Reports->Circuits, and select Reserved
Capacity on Planned NE.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 Click the Run Report button.
The report is generated as per the destination type in step 2.

Circuit Expiry Report

Use this report to list details of all circuits that have reserved ports on any planned
network element.
To open the Reserved Capacity on Planned NE Report
1 From the Inventory menu, select Reports->Circuits, and select Circuit
Expiry.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.

638
 REPORTS
Circuits Reports

4 Select the preferred Report Format from the drop-down list.

5 Click the Run Report button.
The report is generated as per the destination type in step 2.

639
REPORTS
Frames

Frames
Use this report to list the number of positions in each unit of a selected frame
container.
To open the Frames Report
1 From the Inventory menu, select Reports, and select Frames.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Frame Location field, enter a frame location to use as search criteria
or use LOV to select from a list.
6 In the Frame Type field, enter a Frame Type to use as search criteria or use
LOV to select from a list.
7 In the Frame Index field, enter a Frame Index to use as search criteria or
use LOV to select from a list.
8 In the Frame Unit field, enter a Frame Unit to use as search criteria or use
LOV to select from a list.
9 Click the Run Report button.
The report is generated as per the destination type in step 2.

Note
All fields are required to generate the frame report.

640
 REPORTS
Rings Report

Rings Report
Use this report to access and print the Rings Report, which lists details about ring
definition.
To open the Rings Report
1 From the Inventory menu, select Reports, and select Rings.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Ring field, enter the name of the ring to use as search criteria or use
LOV to select from a list.
6 In the User Name field, enter the name of the user to filter the search
criteria.
7 Click the Run Report button.
The report is generated as per the destination type in step 2.

Note
All fields are required to generate the rings report.

641
REPORTS
Routing Definition Report

Routing Definition Report

Use this report to list the circuits and bearers in a selected network route.
To open the Routing Definition Report
1 From the Inventory menu, select Reports, and select Routing Definition.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Ring field, enter the name of the ring to report use as search criteria or
use LOV to select from a list.
6 In the Network Routing Name field, enter the name of the network route to
use as search criteria or use LOV to select from a list.
7 In the User Name field, enter the name of the user to filter the search
criteria.
8 Click the Run Report button.
The report is generated as per the destination type in step 2.

Note
All fields are required to generate the routing definition report.

642
 REPORTS
Sub Network Definition Report

Sub Network Definition Report

Use this report to access and print the Sub Network Definition Report, which lists
details about sub networks.
To open the Sub Network Definition Report
1 From the Inventory menu, select Reports, and select Sub Network
Definition.
The Clarity Report Launcher is displayed.
2 Select the Destination Type from the drop-down list.
3 Enter a Destination Name.
4 Select the preferred Report Format from the drop-down list.
5 In the Ring field, enter the name of the ring to report use as search criteria or
use LOV to select from a list.
6 In the Network Routing Name field, enter the name of the network route to
use as search criteria or use LOV to select from a list.
7 In the Sub Network Name field, enter the name of the sub network to use
as search criteria or use LOV to select from a list.
8 In the User Name field, enter the name of the user to filter the search
criteria.
9 Click the Run Report button.
The report is generated as per the destination type in step 2.

643
REPORTS
Sub Network Definition Report

644
 INDEX

A cable sheath details 329

creating records 340
additional port details deleting records 343
network elements screen 283 features 339
address serviceability screen 525 opening 328
alarms querying records 342
circuits 124 terminations 336
network elements 224 cable parameter validation screen 544
alternate name types 551 cable sheath details 329
alternate names 514 cable sheath product types screen 540
circuits 127 cable sheath types screen 542
deleting 144 card details template 423
locations 514 card model screen 546
area types screen 527 card parameter validation screen 549
areas screen 467 card records
assigning work groups 474 creating 288
creating area records 472
card/slot records
deleting records 478
deleting 293
features 471
opening 468 cards 257
querying records 477 change circuit name 130
asset definition screen child port with parent prefix 224
asset information tab 217 child ports
dimensions tab 219 creating 451
circuit affecting alarms 124
circuit attributes 134
B circuit capacity details 67
backup circuits 146 circuit contacts 130
bearers 118 circuit costs screen 552
creating 129 circuit details 32, 107
zooming up 70 creating 127
button deleting 142
create network element template screen 237 modifying 133
circuit details templates 426
C circuit edit buttons 112
circuit editing screen
cable details templates 421 features 122
cable edit buttons 332 opening 106, 388, 410, 414
cable editing screen tool palette 112, 310, 311
cable core terminations, cable core circuit parameter validation screen 555
terminations 333 circuit path query

645
INDEX

circuit paths section 28 equipment templates 439

circuits section 28 frame records 323
query section 27 large range port templates 452
circuit query network element records 288
display buttons 42 network element templates 439
navigate buttons 42 parent ports 452
report buttons 43 port templates 451
circuit records ring cross connections 157
alarms 124 slot card templates 441
alternate names 127 sub-network connections 159
backup circuits 146 cross connection types screen 557
bearers 129 cross connections 117
change circuit name 130 creating 129
circuit attributes 134 deleting 143
circuit contacts 130 rings 154
circuit details 127, 133
copying 137
copying cross connections 140 D
creating 127 deleting
cross connections 129 alternate names 144
deleting 142 card/slot records 293
modifying 130 circuit details 142
navigate buttons 145 circuit records 142
network elements 126 cross connections 143
querying 123 locations 510
ring cross connections 154 network element records 292
sub-network connections 159 port records 293
tributaries 129 port templates 457
viewing bearer path options 149
zooming down to tributaries 145 destination code 622
zooming up to bearers 145 display buttons
circuits circuit query 42
filters 40 network elements screen 212
query types 38 displaying circuit details 32
config change history screen 88
copying E
circuit records 137
cross connections 140 ECs
costed items creating a record 473
creating and querying 511 equipment feature templates screen 446
create card option for a slot screen 440 equipment models 439
create location attribute templates 515 equipment templates 439
create location attributes 567 exchange codes screen 529
create network element template screen
button 237
create port range screen 454
F
create slot template screen 440 facility query module screen
creating address tab fields 77
card records 288 features 84
child ports 451 frames tab 79
circuit records 127 frames tab fields 79
costed items for locations 511 location address tab 77

646
 INDEX

neighbour’s phone number tab 75

neighbour’s phone number tab fields 76
H
network elements tab 81 Heading1
network elements tab fields 81 Cable Sheath Report 631
opening 74 Heading2
query section 78 Creating Cable Sheath Multiple
query section fields 78 Terminations 341
querying records 85
service address tab 78
features I
circuit editing screen 122 ininventory reports
frames screen 322 circuits reports
network elements screen 286 capacity of bearer report 633
filters inserting
cables query 62 port records 289
circuit query 40
internetwork bearers 172
customer query 51
frames 59 inventory reports
network element query 46 cable sheath report 631
service orders query 55 circuits reports 632
bearers over given capacity report 632
frame appearances
circuit costed items report 636
querying 326
circuit design report 633
frame appearnce statuses 93
circuit due inservice report 636
frame container details template 432
circuit expiry report 638
frame container types screen 559 circuit hierarchy (down) report 634
frame container validation screen 560 circuit hierarchy (up) report 634
frame containers circuit routing report 635
creating 323 comissioned circuit summary report 636
querying 325
inservice circuit summary report 637
frame records
out of service circuit summary report 637
creating 323
frame appearances 326 reserved capacity on planned NE
frame containers 323, 325 report 638
frame units 323, 325 frames report 640
querying 325 rings report 641
frame unit product types screen 562 routing definition report 642
frame unit template screen 429 sub networks definition report 643
frame units
creating 323 L
querying 325
frames screen LEAs
features 322 creating a record 472
opening 300 location address tab 77
frames tab 79 location attributes 567
location/site types screen 566
locations 497
G locations/sites
geographical areas alternate names 514
creating a parent record 473 child locations tab 504
creating records 507
deleting records 510

647
INDEX

features 506 display buttons 212

locations tab 499 features 286
modifying 509 network elements section 208
opening the screen 498 network elements tool palette 228
querying 508 opening 206
port details 275
ports tool palette 280
M querying 287
manage service types window network elements tab 81
network element service types 363 new
overview 362 address 507
management systems screen location 507
opening 358
manufacturers screen 530 O
modifying
circuit names 130 opening
circuit records 130 circuit editing screen 106, 388, 410, 414
location details 509 frames screen 300
network element records 291 management systems screen 358
port templates 456 network element template screen 434
network elements screen 206
Overview 19
N
navigate buttons P
circuit query 42
navigation buttons 145 parent area records
neighbour’s phone number tab 75 exchange-based 472
geographical 473
network alarms 224
parent ports
network element alias’ 573
creating 452
network element details template 443
pay load mapping screen 532
network element editing screen 126
port cables screen 576
network element models screen 569
port details
network element records network elements screen 275
card records 288
port details template 458
creating 288
deleting 292 port ranges 454
modifying 291 port records
network alarms 224 creating 289
network element template screen 434 deleting 293
network element types screen 571 port template screen 448
creating records 451
network element validation screen 574
deleting records 457
network elements 208 querying 451
network elements feature hierarchy port templates
server equipment window 294 child port with parent prefix 224
network elements record child ports 451
port records 289 creating large range 452
network elements screen modifying 456
additional port details 283 parent ports 452
card slot tool palette 261, 280 top level port 224
card slots 257 port usage screen 577

648
 INDEX

port validation screen 578 port usgae 577

ports port validation 578
child port with parent prefix 224 priorities 558
top level port 224 reservation threshold matrix 533
priorities screen 558 service circuit names configuration 554
speeds 535
trunk group validation 536
Q utilisation threshold sets 538
report buttons
query section 78 circuit query 43
query types reports 627
cables 62 bearers over given capacity circuits reports 632
circuits 38 cable sheath report 631
customers 50 capacity of bearer report 633
frames 58 circuit costed items report 636
network elements 45 circuit design report 633
service orders 54 circuit due inservice report 636
querying circuit expiry report 638
circuit records 123 circuit hierarchy (down) report 634
costed items 511 circuit hierarchy (up) report 634
equipment models 439 circuit routing report 635
frame records 325 circuits reports 632
locations/sites 508 comissioned circuit summary report 636
network elements 287 frames reports 640
port template 451 inservice circuit summary report 637
out of service circuit summary report 637
reserved capacity on planned NE report 638
R rings reports 641
reference screens 522 routing definition report 642
address serviceability 525 sub networks defintion report 643
alternate name types 551 reservation threshold matrix window 533
area types 527 ring bearers 170
cable parameter validation 544 ring cross connections 154
cable sheath product types 540 creating 157
cable sheath types 542
ring definitions 169
card model 546
card parameter validation 549 ring paths 171
circuit costs 552 rings screen
circuit parameter validation 555 creating ring records 176
cross connection types 557 features 174
domains 564 internetwork bearers tab 172
exchange codes 529 modifying ring records 177
frame container types 559 opening 168
frame container validation 560 querying records 175
frame unit product types 562 ring bearers tab 170
location/site types 566 ring definitions 169
manufacturers 530 ring paths tab 171
network element alias’ 573 viewing circuit details 179
network element models 569 viewing network element details 178
network element types 571 route definition screen
network element validation 574 opening 186
pay load mapping 532 route to a destination screen
port cables 576 opening 597, 599, 601

649
INDEX

routes 623 terminating unnamed connections 355

RTOMs terminations 336
creating a record 472 tool palette
querying records 477 card slots 261, 280
circuit editing screen 112, 310, 311
network elements 228
S ports 280
screens top level port 224
areas 467 tracing unnamed connections 354
card details template 423 traffic destination 621
card details templates 421 traffic destinations 623
circuit details templates 426
traffic management
config change history 88
associating route to a traffic destination 623
create card option for a slot 440
creating a destination code 622
create port range 454
creating traffic destination 621
create slots 440
features 616
equipment features template 446
menu options 583
frame container details template 432
overview 582
frame unit template 429
route to a destination screen 597, 599, 601
locations 498
traffic events 582
network element details template 443
transmission events 582
network element template 434
trunk groups on a route 609
network elements 206
port details template 458 tributaries 120
port template 448 creating 129
route to a destination 597, 599, 601 zooming down 70
service types template 461 trunk group details template 465
slot card template 441 trunk group validation screen 536
slots and card options mapping 441 trunk groups on a route screen 609
trunk group details template 465
trunk groups on a route 609
search criteria 37 U
service circuit names configuration screen 554 unnamed connections screen
slot card template details screen 441 features 353
slot card templates 441 opening 346
slots 257 terminating 355
slots and card options mapping screens 441 tracing 354
spare bearer capacity 67 utilisation threshold sets 538
spare configured ports 67
specify location attributes 518 V
speeds screen 535
viewing bearer paths options 149
sub-network connections 159
sub-network definitions screen
opening 182 W
work groups
T areas 474
templates
cable details 421 Z
templates screens 420
zoom down button 145

650
 INDEX

zoom up button 145

zooming down to tributaries 70
zooming up to bearers 70

651
INDEX

652
About Clarity

Clarity is the telecommunication industry's Operational Support System (OSS) business process
automation company - providing a pre-integrated product and database that streamlines the 17
eTOM elements of OSS into a single suite. This also allows Clarity to provide executive visibility
of the network's impact on revenue and customer experience across both service fulfillment and
assurance.

Having simplified the management of both legacy and next-generation network environments,
Clarity OSS is network and services neutral, driven by templates that are rapidly configurable to
allow operators to cut time to market for any new service by two-thirds. Today Clarity simplifies
network support for over 90 million subscribers worldwide.

Established in 1993, Clarity's global headquarter is in Sydney, Australia, with offices in Asia, the
Middle East, Europe and North America.

For more information, please visit us at www.clarity.com

CLARITY INTERNATIONAL LIMITED

LEVEL 3
15 BLUE STREET
NORTH SYDNEY NSW 2060
AUSTRALIA

TEL: +61 2 9925 5000

FAX: +61 2 9955 9999