Anda di halaman 1dari 93

User Manual

Clarity Discovery(Forms)

Document Version: 2.1


Date: 27 Feb 2012
Copyright Information
Copyright Clarity International Pty Ltd (ACN 063 732 883)
2012 All Rights Reserved
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
1.3 27 Jan 2010 Updated the section Swati Mohanty Author
on the Clarity
predefined Object
Types
Updated for C10.6.0
1.4 19 Mar 2010 Added information Swati Mohanty Author
on the Copy
Mappings function.
Updated for C10.6.4
1.5 07 Apr 2010 Updated screenshot Swati Mohanty Author
for Transactions
screen (INTTEST-
2265). Version
released in C10.6.5
1.6 21 May 2010 Added information Swati Mohanty Author
based on JIRA issue
PTTIVB-71.
Version released in
C10.6.8

2
Document History
Version Date Amendment Name Role
1.7 20 June 2011 Updated Chapter2- Jeevanthi Technical
Clarity Objects and Dharmasena Writer
Chapter 4 -
Discovery
Transactions to
incorperate the
changes done in
PTVII-1
Document released
for C11.1.1
1.8 01 Augt 2011 Updated the Jeevanthi Technical
document to Dharmasena Writer
incorperate the
changes done in
INTTEST-3329.
A new chapter was
introduced for
reference data
(chapter 5).

Document released
in C11.2.0
1.9 24 Oct 2011 Updated the Jeevanthi Technical
document with the Dharmasena Writer
copyright clause,
about Clarity and
also with the latest
graphic for the cover
page.

Version released in
C11.2.5

3
Document History
Version Date Amendment Name Role
2.0 21 Nov 2011 Updated the Jeevanthi Technical
document to Dharmasena Writer
incorperate the
changes done to the
following JIRA
tickets:
-INTTEST-3339
-INTTEST-3474
-INTTEST-3475
-INTTEST-3695
Version released in
C11.2.6
2.1 27 Feb 2012 Updated the Jeevanthi Technical
copyright clause to Dharmasena Writer
2012.

Version released in
C11.3.0

4
CONTENTS

Chapter 1 Overview
Module Overview ........................................... 8
Discovery Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Discovery Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2 Clarity Objects


Discovery Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Features of the Discovery Object Types Window . . . . . . . . . . . . . . . . . . . . 18
Clarity Predefined Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
NE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Card and Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Port Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Other Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Creating Object Types and Defining Parameters . . . . . . . . . . . . . . . . . . . . 29
Creating Clarity Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Defining Object Type Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Querying Records in the Object Types window . . . . . . . . . . . . . . . . . . . . . . 30
Querying an Object Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Querying Object Type Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Modifying an Object Type Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Deleting an Object Type Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 3 NEMS Objects


NEMS Object Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Features of the NEMS Object Mapping Screen . . . . . . . . . . . . . . . . . . . . . . 39
Mapping NEMS Objects and Defining Parameter Rules . . . . . . . . . . . . . . . 40
Mapping NEMS objects to Clarity objects . . . . . . . . . . . . . . . . . . . . . . . . 40
Defining Rules to Extract Parameter Values . . . . . . . . . . . . . . . . . . . . . . 40
Defining Alias for Inventory Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Querying Records in the NEMS Object Mapping screen . . . . . . . . . . . . . . . 45
Querying Management System Records . . . . . . . . . . . . . . . . . . . . . . . . . 45

5
CONTENTS

Querying Object Mapping Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45


Querying Parameter Mapping Records . . . . . . . . . . . . . . . . . . . . . . . . . 46
Modifying Records in the NEMS Object Mappings screen . . . . . . . . . . . . . 47
Modifying Object Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Modifying Parameter Mapping Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Copying Object Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deleting Records in the NEMS Object Mappings screen . . . . . . . . . . . . . . . 49
Deleting Parameter Mapping Records . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deleting Object Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deleting Management System Classes . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Translate Language Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Built-in Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Composite Translation Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Interface String Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Chapter 4 Discovery Transactions


Transactions Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Features of the Transactions Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Searching for Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Processing Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Manual Transaction Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Modifying and Re-running Existing Transactions . . . . . . . . . . . . . . . . . . . 84
Discovery Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 5 Reference Data


Discovery Reference Data Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Discovery Sweep Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Index ................................................................ 91

6
CHAPTER 1

Overview

This section provides an overview of the Clarity Discovery module.

7
OVERVIEW
Module Overview

Module Overview
Various technologies and equipment model network inventory differently by
referring to standard elements (such as ports or cards) by different names.
For example, the following table lists some standard Clarity objects with the
corresponding TMF terminology.

Clarity Terminology TMF Terminology

Network Element / Equipment (NE) Managed Element (ME)

Card Equipment Holder and Equipment

Circuit

Cross Connect

Port Termination Point (TP)


Physical Physical Termination Point (PTP)
Logical Connection Termination Point
(CTP)

Service Service and its associated features

Table 11. Example of Different Terminologies

To address this problem, Clarity Discovery maps all management system objects
(NEMS objects) to a set of standard Clarity objects. Each Clarity object is made up
of a set of parameters that require specific information. This information is
extracted from the NEMS object using defined rules.

8
OVERVIEW
Discovery Process

Discovery Process
Discovering objects on a NEMS and then converting them to Clarity objects that
can be used in the Clarity OSS database involves the following process:
1. Identify the Clarity object types
2. Define the parameters within the Clarity object type.
See Creating Object Types and Defining Parameters on page 29 for more
information.
3. Map the NEMS objects to Clarity objects
4. Define the parameter rule to extract NEMS information
See Mapping NEMS Objects and Defining Parameter Rules on page 38 for
more information.
5. Modify parameter information if errors were found.

9
OVERVIEW
Discovery Menus

Discovery Menus
Options in the Integration menu and the windows they access are described in
the table below.

Menu Option Accesses Use window to

Discovery > Object Discovery List the Clarity object types and
Definitions Object Types define the parameters that exist for
window those object types.

MDD Configuration > NEMS Object Map NEMS objects to Clarity


Discovery > Object Mappings objects and specify translate rules
Mappings window to extract parameter information
from these objects

10
CHAPTER 2

Clarity Objects

This section describes how to use the Discovery windows to list the Clarity object
types and define the parameters that exist for those objects.

11
CLARITY OBJECTS
Discovery Objects

Discovery Objects
Use the Discovery Object Types window to list the Clarity object types and define
the parameters that exist for those object types. The Clarity object types are used
by the Discovery MDD (Mediation Device Driver) to map NEMS objects to Clarity
objects.

Note
Clarity object types are pre-configured and should not be changed. See
Clarity Predefined Object Types on page 19 for more information.

This window has the following tabs and areas:


Header area
Object Types area
Lists the Clarity object types. These object types are pre-configured and do
not need to be changed. If a new object type name is created it cannot be
modified once saved.
Defined Parameters tab
Defined Parameters area
Defines the parameters that make up the information associated with an
object type. The information includes the name of the table that stores this
information and the column in which the information is recorded.
Logic tab
Logic area
This area displays the Discovery transaction or the process during which the
selected object type is discovered the backend process that is run during this
transaction.

12
CLARITY OBJECTS
Discovery Objects

To open the Discovery Object Types window


In the Integration menu, point to Discovery, and then click Object
Definitions.
The Discovery Object Types window is displayed.

Figure 21. The Discovery Object Types window

13
CLARITY OBJECTS
Discovery Objects

Figure 22. The Discovery Objects/Logic tab window

14
CLARITY OBJECTS
Discovery Objects

Fields
The following are the field descriptions for the Discovery Object Types window:

Field Description

Object Types Area

Object Name The name of the object that will be discovered.

Parent If the object is a child, for example a card, then its parent
object type, for example Network element.

Description Description of the object type

Table Name The name of the Clarity table which contains this object
type details

Sequence Sequence that is used to populate primary keys.

Attributes Definition of the attribute for the given object.

Alias Definition of the alias for the given object.

Defined Parameters Tab

Parameter Name The parameter defined in the table for the selected object
type

Table 21. The Discovery Object Types window; fields

15
CLARITY OBJECTS
Discovery Objects

Field Description

Data Type This field defines the data type of a parameter. When a
user enters a value in the User Value field in the
Transaction window, this value will be validated against
the specified data type of the parameter. For more details
on the Transaction window please refer page 64.
Valid data types are as follows:
Alpha - Valid values are those that contain characters
from a to z, A to Z and 0 to 9.
Number- Valid values are those that contain
characters from 0 to 9.
Char- Valid values are those that contain characters
from a to z and A to Z.
Date- Valid values are those that contain dates in the
format of DD-MON-YYYY.
No Validation- No validation will be performed for
this data type. This is the default value for this field.

Default Value The default value if any that will be populated when the
object is discovered and if the network parameter value
results in a null.

Column Name Name of the column in the Clarity table for that
parameter.

Table Name Name of the table where the parameter is defined.


If the table name is defined as:
ATTRIBUTE - then the parameter is stored in the
attribute table (as defined in the Attribute column of
the Object Types section) of the object.
CONFIG - then the parameter is stored in the Name-
Value pair tables. This is applicable only for CONFIG-
ELEMENTS and CONFIG-ELEMENT-DETS objects.

Mandatory/Read Indicates if the column is read-only, mandatory or an Id


Only/Id column.

Update Inventory This check box determines if the corresponding record of


the inventory could be modified.
If this check box is selected, the specified parameter
could be updated.

Table 21. The Discovery Object Types window; fields

16
CLARITY OBJECTS
Discovery Objects

Field Description

Visible This check box determines if the corresponding


parameters will be visible or not in the Parameters area
of the Transactions/Details tab.

Logic Tab

Transaction Type The Discovery transaction or process during which the


selected object type is discovered.

Logic Name The backend process that is run during this transaction.

Table 21. The Discovery Object Types window; fields

17
CLARITY OBJECTS
Features of the Discovery Object Types Window

Features of the Discovery Object Types Window


The features of the Discovery Object Types window are:

Feature See

Opening the Object Types window page 12

Clarity predefined object types page 19

Creating an object type record page 29

Defining parameters for object types page 29

Querying an object type record page 30

Modifying an object type record page 31

Deleting an object type records page 32

18
CLARITY OBJECTS
Clarity Predefined Object Types

Clarity Predefined Object Types


Clarity has the following predefined object types:
NE
CARD
PORT
SYSTEM_CONFIGURATION
CONFIG ELEMENTS
CONFIG_ELEMENT_DETS
This section describes the parameters for each object type.

Note
M = Mandatory, R = Read only, I = Identifier.

NE
The following table describes some of the parameters for the NE object type.

Optionality Optionality
(HEADER (PHYSICAL
Parameter Details COLLECTION) AUDIT)

NEMS_NE_NAME This is used to identify M M


the equipment in the
Network and to
populate the
EQUA_ALIAS for future
use by Discovery.

EQUP_EQUT_ABBREVIATION This is used to identify M M


the equipment in the
Network and to
populate the
EQUA_ALIAS for future
use by Discovery.

EQUP_INDEX Defines the index M M


assigned to the NE.
This index is unique to
a site / location to help
distinctly identify the
NE.

Table 22. NE Object Type Parameters (sheet 1 of 6)

19
CLARITY OBJECTS
Clarity Predefined Object Types

Optionality Optionality
(HEADER (PHYSICAL
Parameter Details COLLECTION) AUDIT)

EQUP_LOCN_TTNAME Defines the physical M M


location of the NE. The
value is validated
against the location
defined in the Clarity
Inventory table.

EQUP_CUSR_ABBREVIATION Defines the valid O O


abbreviation for the
customer. The value is
validated against the
customers defined in
the Clarity OSS. If not
supplied this will default
to 'SELF'

EQUP_MANR_ABBREVIATION Defines the M M


abbreviation for the
manufacturer of the
NE, The value is
validated against the
manufacturers defined
in the Clarity OSS.

EQUP_STATUS Defines the state of the M M


NE. This value is
validated against the
equipment states
defined in the Clarity
Inventory table.

EQUP_INSERVICE Defines the date when M M


the NE was put into
service

EQUP_SERIALNUMBER Defines the serial O O


number assigned to the
NE.

Table 22. NE Object Type Parameters (sheet 2 of 6)

20
CLARITY OBJECTS
Clarity Predefined Object Types

Optionality Optionality
(HEADER (PHYSICAL
Parameter Details COLLECTION) AUDIT)

EQUP_IPADDRESS Defines the O (Optional only O (Optional only


Management IP for NON-IP for NON-IP
Address of the NE. based based
This is Optional only for equipment.) equipment.)
NON-IP based
equipment. For all IP
based equipment this is
Mandatory. Separate
Discovery Processes will
use this value in the
future.

EQUP_NODEID Defines the node O (Optional only O (Optional only


identifier as it is known for IP based for IP based
in the network by the equipment) equipment)
management system.
This is optional only for
IP based equipment.
For all NON-IP based
equipment this is
Mandatory. Separate
Discovery Processes will
use this value in the
future.

EQUP_EQUM_MODEL Defines the model type O M


used to identify the NE.

EQUP_CLEI Defines the standard O O


code used to identify
telecommunications
equipment for inventory
management and
provisioning.

Table 22. NE Object Type Parameters (sheet 3 of 6)

21
CLARITY OBJECTS
Clarity Predefined Object Types

Optionality Optionality
(HEADER (PHYSICAL
Parameter Details COLLECTION) AUDIT)

EQUP_RELM_NAME Defines the realm M M


name that this NE Optional only if Optional only if
belongs to. the other 4 the other 4
The 'Realm' of an parameters parameters
equipment can be DOMAIN, DOMAIN,
defined either at this FUNCTION, FUNCTION,
parameter or the below AREA, and AREA, and
described parameters REALM_TYPE) REALM_TYPE)
(DOMAIN, FUNCTION, has been defined has been
AREA, and defined.
REALM_TYPE) can be
used to define the
individual components
that can be used to
derive the realm.

DOMAIN This is Realm Domain M M


used in the Header Optional only if Optional only if
Reconcile to help the the
determine the EQUP_RELM_NA EQUP_RELM_NA
Equipment's Realm. ME parameter ME parameter
This defines the current has been has been
list of Domains namely: defined. defined.
Switching, Data,
Transmission and
Applications. The first
three are applicable to
Equipment,
Connections and Telco
Services. The
Application Domain is
used for IT or non Telco
functions.

Table 22. NE Object Type Parameters (sheet 4 of 6)

22
CLARITY OBJECTS
Clarity Predefined Object Types

Optionality Optionality
(HEADER (PHYSICAL
Parameter Details COLLECTION) AUDIT)

FUNCTION This is the Realm M M


Function used by the Optional only if Optional only if
Header Reconcile to the the
determine the EQUP_RELM_NA EQUP_RELM_NA
Equipment's Realm. ME parameter ME parameter
This defines the has been has been
Equipment / defined. defined.
Connection type having
a function component
and Service Type. For
equipment, there would
be L2 access type, L2 to
L3 Bridge, L3 Access
type, Provider Edge,
Network Core, STM 1,
etc.

AREA This is the Realm Area M M


used by the Header Optional only if Optional only if
Reconcile to determine the the
the Equipment's Realm. EQUP_RELM_NA EQUP_RELM_NA
This is based on the ME parameter ME parameter
Area definitions that has been has been
currently exists. defined. defined.

REALM_TYPE This is the REALM TYPE M M


used by the Header Optional only if Optional only if
Reconcile to determine the the
the Equipment's Realm EQUP_RELM_NA EQUP_RELM_NA
i.e., Equipment, ME parameter ME parameter
Connection, Service. has been has been
defined. defined.

NEMS_CLASS This is the Class of the M M


Management System.

NEMS_VERSION This is the version of the M M


Management System.

Table 22. NE Object Type Parameters (sheet 5 of 6)

23
CLARITY OBJECTS
Clarity Predefined Object Types

Optionality Optionality
(HEADER (PHYSICAL
Parameter Details COLLECTION) AUDIT)

NEMS_INSTANCE This is the instance of O O


the Management
System. If this
parameter is not
defined in 'Object
Mappings' screen then
Discovery uses the
'Realm Name' as the
instance to determine
management system
name.

Table 22. NE Object Type Parameters (sheet 6 of 6)

Card and Port


The following tables describes the parameters for the CARD and PORT object
types.

Card Parameters

Parameter Optionality Description

NEMS_NE_NAME M This is used to identify the equipment in the


network to which this card belongs.

NEMS_CARD_NAME M Defines the unique identifier used by the


NEMS to identify the card. This is used to
identify the card in the network and to
populate the CARA_ALIAS for future use by
Discovery.

CARD_SLOT M Defines the physical slot within the device


that the card occupies.

CARD_NAME M Defines the unique identifier used to


identify the card.

Table 23. Card Object Type Parameters (sheet 1 of 2)

24
CLARITY OBJECTS
Clarity Predefined Object Types

Parameter Optionality Description

CARD_MODEL O Defines the unique identifier used to


identify the model of the card.

CARD_REVISION O Defines the inventory information for


hardware revision.

CARD_MODE M Defines the operating mode of the card.

CARD_STATUS M Defines the status of the card and defaults


to 'SPARE'.

CARD_SERIAL O Defines the unique number assigned to


identify the card.

CARD_LOCN_TTNAME O Defines the physical location of the card.

CARD_POTE_NAME O Defines the valid port template name. If this


is supplied, then the ports for the card will
not be discovered, they will be created
based on the port template.

CARD_DEVIATION O The variation in the software revision.

CARD_UNITSTATUS O Defines the unique identifier used to


identify the card unit status.

CARD_MAXPORTS O Defines the unique identifier used to


identify the maximum number of physical
ports allowed for the card.

CARD_OLDSTATUS O Defines the previous status of the card.

Table 23. Card Object Type Parameters (sheet 2 of 2)

Port Parameters

Parameter Optionality Description

NEMS_NE_NAME M This is used to identify the equipment in the


network to which this port belongs.

Table 24. Port Object Type Parameters (sheet 1 of 2)

25
CLARITY OBJECTS
Clarity Predefined Object Types

Parameter Optionality Description

NEMS_CARD_NAME M This is used to identify the card in the


network to which this port belongs.

NEMS_PORT_NAME M This is used to identify the port in the


network and to populate the PORA_ALIAS
for future use by Discovery.

NEMS_PARENT_PORT_NAME O This is used to identify the Parent Port and


will be the same as NEMS_PORT_NAME for
Port that is this ports parent. Parent ports
can be Physical Ports but may also be
Logical or other Child Ports as some
equipment provide a multi-level hierarchy
for Port breakdowns. This is Mandatory for
Child/Logical Ports.

PORT_CARD_SLOT O Defines the unique identifier used to


identify the port's card slot.

PORT_NAME O Defines the unique identifier used to


identify the card where the port belongs.
This is a unique value within the device.

PORT_SPED_ABBREVIATION O Defines the operating speed or bandwidth


(PORT CAPACITY) of the port.

PORT_STATUS O Defines current state of the port.

PORT_LOCN_TTNAME O Defines the physical location of the port.

PORT_PHYSICAL M Defines if the port is a physical or logical


port. Acceptable values are "Y" or "N".
A value of "Y" represents that the port is
physical or logical otherwise.

Table 24. Port Object Type Parameters (sheet 2 of 2)

26
CLARITY OBJECTS
Clarity Predefined Object Types

Other Object Types


The following table describes the parameters for the SYSTEM_CONFIGURATION,
CONFIG ELEMENTS, and CONFIG_ELEMENT_DETS object type

Clarity Object Parameter Name Optionality Description

SYSTEM_CONFIGURATION NEMS_NE_NAME M This is used to identify


the equipment in the
Network.

SYSC_NAME M This is the name used


to identify the system,
usually a hostname,
node id or IP address.

SYSC_VERSION M This is the version of the


system, usually IOS
level or firmware
version.

SYSC_DATE M This is the date when


the system
configuration record
was created.

CONFIG_ELEMENT NEMS_NE_NAME M This is used to identify


the equipment in the
Network that the
Configuration Element
is configured on.

NEMS_PORT_NAME O This used to identify the


Port that the
Configuration Element
is linked to.

PARENT_ELEMENT_N O This is the name of the


AME Parent Element.

PARENT_ELEMENT_V O This is the value of the


ALUE Parent Element.

VRF_NAME O

Table 25. Other Object Type Parameters (sheet 1 of 2)

27
CLARITY OBJECTS
Clarity Predefined Object Types

Clarity Object Parameter Name Optionality Description

VLAN O

STP_INSTANCE O

QUEUE O

CoS O

POLICY O

EQP_NBR_DEVICE O

EQP_NBR_INTERFAC O
E

IPADDRESS O

CONFIG_ELEMENT_DET NEMS_NE_NAME M This is used to identify


the equipment in the
Network that the
Configuration Element
is configured on.

PARENT_ELEMENT_N M This is the name of the


AME Parent Element.

PARENT_ELEMENT_V M This is the value of the


ALUE Parent Element.

RT_EXP O

RT_IMP O

ROUTE_MAP O

SUBNETMASK O

FAR_END_IP O

EVC_ID O

Table 25. Other Object Type Parameters (sheet 2 of 2)

28
CLARITY OBJECTS
Creating Object Types and Defining Parameters

Creating Object Types and Defining Parameters


The following procedures describe how to create a Clarity object type record and
then how to define the parameters that are associated with that object type.

Note
Clarity object types are pre-configured and should not be changed,
however, new object types can be added. See Clarity Predefined Object
Types on page 19 for more information.

Creating Clarity Object Types


The following procedure describes how to create object type records.
To create a Clarity object type.
1 Open the Discovery Object Types window.
See Discovery Objects on page 12 for more information.
2 Click the Insert button on the toolbar.
3 Enter the required information in the Object Types area.
See Discovery Object Types on page 53 for more information about the fields
in this section.
4 To save the record, click Save.

Defining Object Type Parameters


The following procedure describes how to define the parameters that make up the
information associated with an object type.
To define the object parameters
1 Select the Clarity object type.
See Querying Records in the Object Types window on page 30 for more
information.
2 Enter the parameter information in the Defined Parameters tab.
See Discovery Object Types on page 53 for more information about the fields
in this section.
3 Repeat step 2 until all criteria is entered.
4 To save the record, click Save.

Note
Ensure that column names and table names are identical to those in the
database. Note that names are case sensitive.

29
CLARITY OBJECTS
Querying Records in the Object Types window

Querying Records in the Object Types window


The following procedures describe how to find an object type and a parameter of
an object type in the Discovery Object Types window.

Querying an Object Type


Use this procedure to perform a query on an object type record in the Object
Types area of the Alarm Clearing window.
To query a record in the Object Types section
1 Open the Discovery Object Types window.
See Discovery Objects on page 12 for more information.
2 Click the Query button in the toolbar.
The window is now in query mode.
3 Enter your search criteria in the fields in the Object Types area.
4 Click the Query button in the toolbar.
Matching records are displayed.
5 Use the scroll bar to select the record you want.

Querying Object Type Parameters


Use this procedure to search for parameters that relate to an object type record.
To query a record in the Defined Parameters section
1 Open the Discovery Object Types window.
2 Query a record in the Object Types area.
See Querying an Object Type on page 30 for more information.
3 Click any field in the Defined Parameters tab.
4 Click the Query button in the toolbar.
The Defined Parameters tab is now in query mode.
5 Enter your search criteria in the Defined Parameters tab.
6 Click the Query button in the toolbar.
Parameters that match the search criteria are displayed.
7 Use the scroll bar to view the search results.

30
CLARITY OBJECTS
Modifying an Object Type Record

Modifying an Object Type Record


The following procedure describes how to modify an object type record.

Note
You cannot modify the object type name. You can only modify the object
type description and the information in the Defined Parameters section.

Ensure that column names and table names are identical to those in the
database. Note that names are case sensitive.

To modify information in an object type record


1 Select the object type record.
See Querying an Object Type on page 30 for more information.
2 Click the field that you need to change and perform the required
modifications.
3 Repeat step 2 until you have made all required changes.
4 Click the Save button to save the updated record.

31
CLARITY OBJECTS
Deleting an Object Type Record

Deleting an Object Type Record


The following procedure describes how to delete an object type record.

Note
Clarity object types are used by the Discovery MDD to map NEMS objects
to Clarity objects. Thus, a Clarity object type may only be deleted once all
mappings using it have been deleted. See Deleting Records in the NEMS
Object Mappings screen on page 44 for more information.

To delete an object type record


1 Select the object type record.
See Querying an Object Type on page 30 for more information.
2 Select a record in the Defined Parameters section.
3 Click the Delete button.
The parameter record is deleted.

Note
Mandatory parameters can only be deleted after the optional parameters
have been deleted.

4 Repeat steps 2 and 3 until all parameters are deleted.


5 In the Object Types section, select the object type record.
6 Click the Delete button.
7 Click the Save button.
The record is deleted from the database.

32
CHAPTER 3

NEMS Objects

This section describes how to use the Discovery screens to map NEMS objects to
Clarity objects. It also shows how to use translate rules to extract parameter
information from these objects.

33
NEMS OBJECTS
NEMS Object Mappings

NEMS Object Mappings


Use the NEMS Object Mappings window to map NEMS objects to Clarity objects
and to specify the rules for extracting parameter values from the NEMS objects.
This screen has the following areas/tabs:
Management System
Lists the classes of management systems that exist in the Clarity system.
Object Mappings
Lists the object types associated with the selected management system class
and maps these to valid Clarity object types.
Parameter Mappings
Lists the parameters associated with the selected Clarity object and defines
the rules for extracting the required information from the NEMS object.
Alias Mapping
Allows the user to set up alias creation rules for the for the creation of aliases
for Inventory objects during discovery or reconciliation.

34
NEMS OBJECTS
NEMS Object Mappings

To open the NEMS Object Mappings screen


From the Integration menu, select MDD Configuration, click
Discovery and then click Object Mappings.
The NEMS Object Mappings window is displayed.

Figure 31. The NEMS Object Mappings window

Fields
The fields in the NEMS Object Mappings window are:

Field Description

Management System
Note: The combination of class and version must be unique.

Table 31. NEMS Object Mappings window; fields

35
NEMS OBJECTS
NEMS Object Mappings

Field Description

Class Specific NEMS class. Use LOV to select a value.


Values for the LOV are defined using the application
variable NEMS_CLASS. Refer to the Getting Started with
Clarity OSS for more information about application
variables.

Version Specific NEMS software version.

Object Mappings
The information in this section is directly related to the record selected in the
Management System area

NEMS Objects The name of the NEMS object type, e.g. Managed
Element.

Clarity Objects The Clarity object type that maps to the NEMS object
type, e.g. NE. Use LOV to select a value.

Parameter Mapping
The information in this tab is directly related to the record selected in the Object
Mappings area.

Clarity Parameters Name of the Clarity object parameter, e.g.


NEMS_NE_NAME. Use LOV to select a value.

Rule Syntax The rule for extracting parameter values from the NEMS
object, e.g. ME_ABBR+":"+ME_LOCN+":"+ME_INDEX).
See Translate Language Statements on page 46 for more
information about constructing rules.

Table 31. NEMS Object Mappings window; fields

36
NEMS OBJECTS
NEMS Object Mappings

Field Description

Ignore Recon Select this check box to turn the reconciliation off for
those parameters whose values can't be discovered from
the network. If this option is checked, the Physical Audit
process will ignore these parameters. This will ensure that
no discrepancies are reported about parameters that
cannot be discovered from the network.
Status for these parameters will be set to Ignored and
displayed as such in the Transactions window and
Discovery GUI.
Note: Turning reconciliation off only applies to Network
Elements, Cards, Ports and System Configuration. It
does not apply to Config Elements.

Stored Proc Select this check box to perform the following functions:
To populate a parameter by executing a stored
procedure which does not have any parameters.
Example of such a case is to execute a stored
procedure to get the next sequence of numbers.
To populate a parameter by executing a stored
procedure which has parameters. Any number of
input parameters can be sent to stored procedures.
The parameters should be the parameters belonging
to the same object.

Copy From Select this check box to populate a parameter with a


value in another parameter belonging to the same
object. Example of this is to populate NENO_EQUP_ID
with the value in EQUP_ID parameter. This will avoid
having to execute a stored procedure again if we already
have a value in a parameter.

Alias Mapping
The information in this tab is directly related to the record selected in the Object
Mappings area.

Module The module in which the alias is being created. Drop-


down list has three values by default: Alarms,
Performance, and Provisioning. Values selected from the
drop down list of modules are not saved anywhere; it is
there just so that the users know the purpose of creating
a particular alias.

Table 31. NEMS Object Mappings window; fields

37
NEMS OBJECTS
NEMS Object Mappings

Field Description

Domain The domain to which the inventory object will belong.


When setting up an alias creation rule, the value of this
field in the Alias Mapping tab is a parameter name that
has been defined in the Parameter Mapping tab, for
example a parameter called DOMAIN. When the alias is
created, the domain for the inventory object is the value
set for the parameter in the NEMS Object mappings
form.

Alias Name by which the object is known in the network.


Similar to the domain, the value set for the Alias field in
the Alias Mapping tab is a parameter already defined in
the Parameter Mapping tab. The alias creation process
substitutes the value of the parameter when it creates an
alias.

Table 31. NEMS Object Mappings window; fields

Buttons
The button on the NEMS Object Mappings screen is:
Copy Mappings: Allows the user to copy the object mappings from one
management system record onto another.

38
NEMS OBJECTS
Features of the NEMS Object Mapping Screen

Features of the NEMS Object Mapping Screen


The features of the NEMS Object Mapping screen are:

Feature See

Opening the NEMS Object Mapping screen page 35

Mapping NEMS object types to Clarity object types page 40

Defining rules to extract NEMS parameter values page 40

Defining Alias for Inventory Objects

Querying records in the NEMS Object Mapping screen page 45

Modifying records in the NEMS Object Mapping screen page 47

Deleting records in the NEMS Object Mapping screen page 49

Translate Language Statements page 51

39
NEMS OBJECTS
Mapping NEMS Objects and Defining Parameter Rules

Mapping NEMS Objects and Defining Parameter Rules


The following procedures describe how to use the NEMS Object Mappings
screen to:
Map NEMS objects to Clarity objects
Define rules to extract parameter values
Define aliases for the Inventory objects

Mapping NEMS objects to Clarity objects


This procedure describes how to map the various NEMS object types to Clarity
object types.
To map NEMS object types to Clarity object types
1 Open the NEMS Object Mappings screen.
See NEMS Object Mappings on page 34 for more information.
2 Enter the management system class and version in the Management System
section.
3 Enter the NEMS object types and the corresponding Clarity object types in the
Object Mappings section.
See NEMS Object Mappings on page 77 for more information about the
fields in this screen

Hint
If there are no spare fields to create more records, click the Insert
button on the toolbar.
4 Click the Save button to save the new records.
The Parameter Mappings section is automatically populated with the Clarity
object parameters.

Defining Rules to Extract Parameter Values


The following procedure describes how to define the rules to extract parameter
values from a NEMS object.
For example:
NEMS_NE_NAME is a parameter for the NE Clarity object type. Information
required for this parameter in the Clarity system is a concatenation of the NEMS
class, version and instance. To retrieve this information from a NEMS object called
Managed Element the rule syntax could be:

ME ABBR+:+ME LOCN+:+ME INDEX

40
NEMS OBJECTS
Mapping NEMS Objects and Defining Parameter Rules

See Translate Language Statements on page 51 for more information about


constructing rules.
To define rules to extract parameter values from a NEMS object
1 Select the required NEMS object.
See Querying Object Mapping Records on page 45 for more information
2 In the Parameter Mapping tab enter the rule for extracting the parameter
values.
See Translate Language Statements on page 51 for more information about
constructing rules.
3 Click the Save button.
When configuring an MDD, the following rules should be followed:
CONFIG_ELEMENT's do not apply to all devices or management
systems, but if they do, a SYSTEM_CONFIGURATION Object must be
discovered as well.
All CONFIG_ELEMENT objects must have the NEMS_NE_NAME
parameter populated, and the value should be the same as that used
during the Header Collect and/or Physical Audit.
A CONFIG_ELEMENT object should use the NEMS_PORT_NAME
parameter when linking to a port is required, and the value should be
same as that used during the Physical Audit (for Ports) or the Logical
Audit for Logical/Child Ports.
A CONFIG_ELEMENT object should use the PARENT_ELEMENT_NAME
and PARENT_ELEMENT_VALUES when it is required to link a
CONFIG_ELEMENT with a parent CONFIG_ELEMENT.
All CONFIG_ELEMENT_DET objects must have the NEMS_NE_NAME,
PARENT_ELEMENT_NAME and PARENT_ELEMENT_VALUE parameters
populated. The NEMS_NE_NAME parameter should have the same
value as used during the Header Collect and/or Physical Audit.
If a VRF_NAME CONFIG_ELEMENT is discovered, it should be linked
with at least one of each RT_EXP and RT_IMP CONFIG_ELEMENT_DET
objects and the CONFIG_ELEMENT object should have a
NEMS_PORT_NAME parameter to link it with a port.
If a VLAN CONFIG_ELEMENT is discovered and is part of a Ring, it
should be linked to an STP_INSTANCE using the
PARENT_ELEMENT_NAME and PARENT_ELEMENT_VALUE parameters.
In the case where there is a tunnel configured joining the two rings (at
33 the PE or L2/L3 Switch) the CONFIGURATION_ELEMENT_DET
objects for FAR_END_IP and EVC_ID should linked to the VLAN.
If CoS is discovered, it should be linked to a QUEUE using the
PARENT_ELEMENT_NAME and PARENT_ELEMENT_VALUE parameters.

41
NEMS OBJECTS
Mapping NEMS Objects and Defining Parameter Rules

If POLICY is discovered, it should be linked to a CoS using the


PARENT_ELEMENT_NAME and PARENT_ELEMENT_VALUE parameters and also
linked to a PORT via the NEMS_PORT_NAME parameter.
If EQP_NBR_DEVICE and EQP_NBR_INTERFACE are discovered, they both should
be linked to a PORT via the NEMS_PORT_NAME parameter.
If an IP ADDRESS is discovered, it should be linked to the SUBNETMASK
CONFIG_ELEMENT_DET object and also linked to a PORT via the
NEMS_PORT_NAME parameter.

Defining Alias for Inventory Objects


An alias of an inventory object is the name by which the object is known in the
network. An inventory object (such as Network Element, Card, and Port) could be
known in different logical domains by different names. Therefore, an inventory
object could have more than one alias.
The NEMS Object Mapping form is used to set up the alias creation rules that will
be used by the Clarity Discovery module to create an alias when an inventory
object is discovered or reconciled.
To set up Alias Creation Rules
1 In the NEMS Object Mappings form, click on the Alias Mapping tab to access
the Alias Mapping sub-form. See image below.

Figure 32. Alias Mapping tab

42
NEMS OBJECTS
Mapping NEMS Objects and Defining Parameter Rules

2 To set up an Alias creation rule, the user must define the following:
Module --> The module that the alias is being created for. The following
three modules are available for selection: Provisioning, Performance,
and Alarms.
Domain --> The domain in which the inventory object will be identified
by the alias created.
Alias --> The format for creating the alias, i.e. the naming convention
that will be used to create the alias.
The 'Domain' and the 'Alias' can only be parameter names defined in the
'Parameter Mapping' tab. The alias creation process substitutes the values of
the parameters when it creates an alias and its domain. See example below:

Figure 33. Example of Alias Creation Rule

For example, using the rule set up in the form above, the Discovery process will
create two aliases for the NE object. The first alias will be created for the Alarms
module using the value of NEMS_CLASS parameter as the Naming Domain and
the value of EQUP_NODEID parameter as the Alias. Another alias will be created

43
NEMS OBJECTS
Mapping NEMS Objects and Defining Parameter Rules

for the Performance module, using the value of EQUP_MANS_NAME parameter


as the Naming Domain and the value of EQUP_SERIALNUMBER parameter as the
Alias.
Note the following regarding the Alias creation and reconciliation process:
Any combination of 'Naming Domain' and 'Alias' that doesn't exist in
Clarity inventory will be created during discovery/reconciliation.
If an existing 'Naming Domain' and/or 'Alias' is modified then the alias
creation process creates a new alias for that change. That is, the
existing alias will not be modified; instead a new alias will be created.
If an existing alias mapping is deleted completely then the process will
not delete the corresponding alias from Clarity Inventory.
The above alias creation process is applicable only for EQUIPMENT, CARD(s),
and PORT(s). Any other Alias Mapping defined for objects other than
EQUIPMENT, CARD, and PORT will be ignored by Discovery.
Users will be able to define multiple different 'Aliases' for the same application
modules. If more than one alias needs to be created in the same module, note
that:
you do not use the same Parameter to define the Domain or Alias field
if the value of an alias will be found to be null, then that alias will not
be created
if the value of an alias will be found to be exactly the same as the
value of a previously found alias for the same object, then this alias
will not be created: aliases for the same type of object must be unique
As a general rule, aliases for the same module must be unique (have unique
values).
For network elements, aliases are created during Header Collection. For
Cards/Ports, aliases are created during Physical Audit.

44
NEMS OBJECTS
Querying Records in the NEMS Object Mapping screen

Querying Records in the NEMS Object Mapping screen


This section describes how to search for records in the NEMS Object Mapping
screen.

Querying Management System Records


The following procedure describes how to search for a record in the Management
System section of the NEMS Object Mappings screen.
To search for a management system class record
1 Open the NEMS Object Mappings screen.
See NEMS Object Mappings on page 34 for more information.
2 Click the Query button in the toolbar.
The screen is now in query mode.
3 Enter your search criteria in the fields in the Management System section.
4 Click the Query button in the toolbar.
Records matching the search criteria are displayed.
5 If multiple records are retrieved, use the scroll bar to view all records.

Querying Object Mapping Records


The following procedure describes how to search for a record in the Object
Mappings section of the NEMS Object Mappings screen.
To search for an object mapping record
1 Select the parent management system record.
See Querying Management System Records on page 45 for more
information.
2 Click in the Object Mappings section and then click the Query button in the
toolbar.
This section of the screen is now in query mode.
3 Enter your search criteria in the fields in the Object Mappings section.
4 Click the Query button in the toolbar.
Records matching the search criteria are displayed.
5 If multiple records are retrieved, use the scroll bar to view all records.

45
NEMS OBJECTS
Querying Records in the NEMS Object Mapping screen

Querying Parameter Mapping Records


The following procedure describes how to search for a record in the Parameter
Mappings section of the NEMS Object Mapping screen.
To search for a parameter mapping record
1 Select the parent NEMS object.
See Querying Object Mapping Records on page 45 for more information.
2 Click in the Parameter Mappings section and then click the Query button in
the toolbar.
This section of the screen is now in query mode.
3 Enter your search criteria in the fields in the Parameter Mappings section.
4 Click the Query button in the toolbar.
Records matching the search criteria are displayed.
5 If multiple records are retrieved, use the scroll bar to view all records.

46
NEMS OBJECTS
Modifying Records in the NEMS Object Mappings screen

Modifying Records in the NEMS Object Mappings screen


The NEMS Object Mappings screen has hierarchical dependencies. This means
that the Management System section is parent to the Object Mappings section
which in turn is parent to the Parameter Mappings section. When records are
modified in this screen some child records may be deleted.
The following rules apply:
Rule syntaxes can be modified at any time
Object mapping records can be modified at any time however if the
Clarity object is changed any information for the child parameters will
be deleted.
Management system records can not be modified only deleted. See
Deleting Management System Classes on page 50 for more
information.

Modifying Object Mappings


The following procedure describes how to modify a record in the Object
Mappings section of the NEMS Object Mappings screen.

Note
Take care when modifying records in the Object Mappings sections as the
rules set up for the child parameters will be lost if the Clarity object is
changed.

To modify an object mapping record


1 Display the required NEMS object type.
See Querying Object Mapping Records on page 45 for more information.
2 Click in the field that you want to change, delete the old information and
enter the new information.
3 Repeat step 2 until all you have made all required changes.
4 Click the Save button to save the updated record.

Modifying Parameter Mapping Rules


The following procedure describes how to modify a record in the Parameter
Mappings section of the NEMS Object Mappings screen.
To modify an parameter mapping record
1 Display the required parameter.
See Querying Parameter Mapping Records on page 46 for more information.
2 Click in the field that you want to change, delete the old information and
enter the new information.

47
NEMS OBJECTS
Modifying Records in the NEMS Object Mappings screen

3 Repeat step 2 until all you have made all required changes.
4 Click the Save button to save the updated record.

Copying Object Mappings


Object mappings can be copied from one management system onto one or more
management system records using the Copy Mappings button on the NEMS
Object Mappings screen.
To copy object mappings
1 In the NEMS Object Mappings screen, query for and select the management
system record whose object mappings you would like to copy.
2 Click on Copy Mappings. The Copy Mappings screen will be displayed.

Figure 34. Copy Mappings screen

3 Use the LOV button to select the management system record(s) that you want
to copy the mappings to.
4 Click Copy. The object mappings will be copied to the selected management
system records.

48
NEMS OBJECTS
Deleting Records in the NEMS Object Mappings screen

Deleting Records in the NEMS Object Mappings screen


The NEMS Object Mappings screen has hierarchical dependencies. This means
that the Management System section is parent to the Object Mappings section
which in turn is parent to the Parameter Mappings section. To delete records from
this screen all child records must first be deleted.
The following rules apply:
Parameter mapping records can be deleted at any time
Object mapping records can be deleted only after all child parameter
mapping records are deleted.
Management system records can be deleted only after all child object
mapping and parameter mapping records are deleted.

Deleting Parameter Mapping Records


The following procedure describes how to delete a record from the Parameter
Mappings section of the NEMS Object Mappings screen.
To delete a parameter mapping record
1 Select the required parameter record.
See Querying Parameter Mapping Records on page 46 for more information.
2 Click the Delete button.
The record is deleted
3 Click the Save button to save your changes.

Deleting Object Mappings


The following procedure describes how to delete a record from the Object
Mappings section of the NEMS Object Mappings screen.
All child parameter records must be deleted before you can delete an object
mapping record. See Deleting Parameter Mapping Records on page 49 for more
information.
To delete an object mapping record
1 Select the required object mapping record.
See Querying Object Mapping Records on page 45 for more information.
2 Click the Delete button.
The record is deleted
3 Click the Save button to save your changes.

49
NEMS OBJECTS
Deleting Records in the NEMS Object Mappings screen

Deleting Management System Classes


The following procedure describes how to delete a record from the Management
System section of the NEMS Object Mappings screen.
All child object mapping records must be deleted before you can delete a
management system record. See Deleting Object Mappings on page 49 for more
information.
To delete a management system record
1 Select the required management system record.
See Querying Management System Records on page 45 for more
information.
2 Click the Delete button.
The record is deleted
3 Click the Save button to save your changes.

50
NEMS OBJECTS
Translate Language Statements

Translate Language Statements


This section describes how to use a Translate language statement to extract
parameter information from a NEMS object in the Clarity Discovery module. A
Translate language statement is constructed from the following types of
expressions:

Expression See page...

Built-in Functions page 51

Parameters page 57

Operators page 58

Literals page 58

Built-in Functions
Built-in functions provide most of the string manipulation functionality in the
Translate language. They can be used individually to perform basic manipulations
or can be joined to build more complex and functional operations.
The following functions are available:
Concat
FormatDate
Java
FileLookup
Regex
Replace
ReplaceFirst
Split
Substr
ToLower
ToUpper
Trim
TrimAfter
TrimBefore
Truncate
Format
The functions are explained in more detail below.

51
NEMS OBJECTS
Translate Language Statements

Concat

Concat(string s1, string s2)

Returns the concatenation of s1 and s2.

Note
The same result can be achieved using the concat operator (s1 + s2).

For example:

Concat("Hello ", "World")


# Returns "Hello World"

FormatDate

FormatDate(string string, string format1, string format2)

Converts the parameter string from the date format specified in format1 to the
date format specified in format2.

Note
The parameter string must be in the date format specified by format1 for
the conversion be successful.

All date format strings must conform to the date formats accepted by the Java
class java.text.SimpleDateFormat. The documentation for legal date format strings
can be viewed at the following location:
http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html
For example:

FormatDate("2002-02-01", "yyyy-MM-dd ", "dd-MM-yyyy")


# Returns "01-02-2002"

Java

Java(string className)

Extends the Translate language by providing custom functions.


These functions can be used by writing a Java class that implements the
com.clarity.oss.eval.lang.StringExpression interface. See Interface String
Expression on page 61 for more information

52
NEMS OBJECTS
Translate Language Statements

Use the Java function, with the name of your custom implementation class, to call
a custom function.
For example:

Java("com.mycompany.CustomTranslateClass")

FileLookup

FileLookup(string file, string key)

Retrieves the value for key from the specified lookup file.

Note
The lookup file must be placed in the directory defined by the environment
variable DBCONFIG_DIR.

A lookup file contains mappings from keys to values. Each mapping appears on a
single line with key and value separated by a single '=' character.
The following is an example of a simple lookup file.

key1=value1
key2=value2
key3=value3
key4=value4

For example:
Assume the lookup file listed above is in a file named simple.lookup and is in the
directory defined as DBCONFIG_DIR. We can lookup the value of key2 using the
following expression.

FileLookup("simple.lookup", "key2")
# Returns "value2"

Regex

Regex(string string, string regex)

Returns the result of matching regex to string. This is equivalent to the


expression:

Match(s, regex, 0)

53
NEMS OBJECTS
Translate Language Statements

For example:

Regex("Match this!", "this")


# Returns "this"

Regex

Regex (string s, string regex, int group)

Returns the string from the group when regex is applied to the string s.
For example:

Regex("first-second-third", "(.*)-(.*)-(.*)", 2)
# Returns "second"

Replace

Replace(string s, string regex, string repl)

Replaces all strings that match regex with the repl string in s.
For example:

Replace("SYD:123-SYD:456", "SYD", "SYDNEY")


# Returns "SYDNEY:123-SYDNEY:456"

ReplaceFirst

ReplaceFirst(string s, string regex, string repl)

Replaces the first string that matches regex with the repl string in s.
For example:

ReplaceFirst("SYD:123-SYD:456", "SYD", "SYDNEY")


# Returns "SYDNEY:123-SYD:456"

54
NEMS OBJECTS
Translate Language Statements

Split

Split(string string, string regex, int item)

Partitions the string into parts where regex specifies the delimiter between the
parts, and then returns the part that corresponds to the integer item.

Note
The first part is item 0, second item 1, etc.

For example:

Split("PORT:232:838:102", ":", 0)
# Returns "PORT"

Split("PORT:232:838:102", ":", 1)
# Returns "232"

Split("PORT:232:838:102", ":", 3)
# Returns "102"

Substr

Substr(string string, int index, int length)

Returns a substring of string. The substring returned starts at position index and
contains length number of characters. Strings are indexed starting at 0.
For example:

Substr("example text", 2, 3)
# Returns "amp"

ToLower

ToLower(string string)

Converts all of the alpha characters in string to lowercase. Numeric and


punctuation characters are left unchanged.
For example:

ToLower("Contact NUMBER 9828383")


# Returns "contact number 9828383"

55
NEMS OBJECTS
Translate Language Statements

ToUpper

ToUpper(string string)

Converts all of the alpha characters in string to uppercase. Numeric and


punctuation characters are left unchanged.
For example:

ToUpper("cisco_gw_syd_mel")
# Returns "CISCO_GW_SYD_MEL"

Trim

Trim(string string)

Removes all white space from the beginning and end of string. White space
characters include spaces, tabs and new line characters.
For example:

Trim(" SN#3938282 ")


# Returns "SN#3938282"

TrimAfter

TrimAfter(string string)

Removes all white space from the end of string.


For example:

TrimAfter(" SN#3938282 ")


# Returns " SN#3938282"

TrimBefore

TrimBefore(string string)

Removes all white space from the beginning of string.

56
NEMS OBJECTS
Translate Language Statements

For example:

TrimBefore(" SN#3938282 ")


# Returns "SN#3938282 "

Truncate

Truncate(string string, int maxLength)

Truncates string so that it is no more than maxLength characters in length. The


string remains unchanged if it is already less than maxLength characters.
For example:

Truncate("NE:93829:CN:93823:PN:93829", 8)
# Returns "NE:93829"

Format

Format(string format, arg1, arg2, , argn)

Format the string by substituting the supplied arguments into the places defined in
the format string. The format string is defined in documentation of the java class
java.util.Formatter (java 1.5). This documentation can be found at the following
location http://java.sun.com/j2se/1.5.0/docs/api/java/text/Format.html.

Note
The Format function can only accept format string parameters of string
and number types. Other types are not supported by the Translate
language.

Parameters
In the Clarity Discovery module, translation rules are always in the context of the
parameter related to the NEMS object that is being translated. See Discovery
Objects on page 12 for more information about object parameters.
When a parameter is referenced in a statement, the Translate language will
attempt to locate the value for the parameter within the context of the object. If the
object contains the parameter then the value for that parameter is returned. If
there is no such parameter for the object then the statement will fail.
Parameters are referenced using a $ sign followed by the name of the parameter.
The name of the parameter is case sensitive.

57
NEMS OBJECTS
Translate Language Statements

For example:

$PARAM
$_PARAM
$PARAM01
$NAME
$DATE

Operators
The Translate language provides two operators, these are the:
concatenation operator
guard operator

Concatenation Operator
The Concatenation Operator (+) is used to join two strings together. This operator
provides the same functionality of the Concat built-in function. This operator is
provided to enhance the readability of the Translate language.

Guard Operator
The Guard Operator ([ ]) is used around another expression to signify that if the
expression contained inside the guard fails then instead of raising an error the
empty string ( "" ) should be returned. If the expression inside the guard is
successful then the guard has no effect.
The guard operator can also be used to specify an optional portion of a string
translation. For example, if it is not certain that the context will contain a particular
parameter the guard operator can be used around the parameter reference. This
way if the parameter is available in the context at the time of execution its value
will be added to the transformed string otherwise the empty string will be added.

Literals
String Literals consist of zero or more characters enclosed in double quotes.
For example:

"String1*@!"
"hello"
"abc defg"

Number Literals are expressed using a sequence of numeric digits. The language
supports decimals and negative numbers.

58
NEMS OBJECTS
Translate Language Statements

For example:

138
33928
-3
3.293

Composite Translation Example


This example shows how to use function composition to construct a statement that
coverts a circuit name to another format.

Context

CNAME ' "STM4 Circuit Sydney equip 00838 to Melbourne equip 093293 - circt
number 2032"

Statement

ToUpper(Truncate(Split($CNAME," ", 2), 3) )


+ Split($CNAME, " ", 4 ) + " - "
+ ToUpper(Truncate(Split($CNAME," ", 6), 3) )
+ Split($CNAME, " ", 8 ) + " "
+ Split($CNAME, " ", 0) + " "
+ Split($CNAME, " ", 12)

Result

"SYD00838 - MEL093293 STM4 2032"

59
NEMS OBJECTS
Translate Language Statements

Diagrammatic Representation
Complex expressions such as this can be hard to understand at first glance. The
following diagram shows a graphical representation of the operation.

Figure 35. Composite Translation Example

60
NEMS OBJECTS
Interface String Expression

Interface String Expression


com.clarity.oss.eval.lang
All Superinterfaces:
Expression

public interface StringExpression


extends Expression

Method Summary

java.lang.String evaluate (java.util.Map context)


Evaluate the StringExpression

Method Detail

evaluate
java.lang.String evaluate (java.util.Map context)
throws EvalException
Evaluate the StringExpression
Specified by:
evaluate in interface Expression
Throws:
EvalException

61
NEMS OBJECTS
Interface String Expression

62
CHAPTER 4

Discovery Transactions

This section describes how to use the Transactions window to view and edit the
data that has been loaded from a management system before it gets processed
into the Clarity OSS database.

63
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Transactions Window
Once a Discovery MDD completes its discovery process, it inserts all the network
objects which it found into a database, and updates the transaction table. These
network objects are then converted into Clarity objects and inserted into the
Clarity OSS.
Once the conversion is complete, the transaction table is updated with the state of
the conversion (whether it was processed, or an error occurred). If an error
occurred, then a transaction error table is updated, listing the cause of the error.
The Transactions window can be used to view, possibly edit and then process the
objects that have been discovered during a discovery request. When a transaction
is processed, the information is entered into the Clarity OSS database.
The Transactions window consists of the following tabs and areas:
Header area
See Figure 41 on page 66.
Request Details tab
This tab is used to select the transactions you wish to view, and to re-run the
conversion process.
When a transaction is selected, the Transaction window is populated with
information regarding that transaction (including the network objects
inserted, the parameters for each object, and errors which may have
occurred). The most recent transaction is always displayed first.
Details tab
See Figure 41 on page 66 or See Figure 42 on page 66.
Objects area
Lists the parent of the object selected in the Related Object tab window.
Parameters area
Lists the parameters for the selected object in the Objects area of the Object
View tab.
Errors tab
See Figure 41 on page 66.
Errors area
Lists any errors that occurs during the conversion process concerning the
transactions selected in the Request Details area in the header.

64
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Related Objects tab


This tab displays the related network objects which were discovered and
inserted by the Discovery MDD.
See Figure 42 on page 66.
Child Objects area
When an object is selected, all the network objects which are children to this
object are displayed in the Child Objects area of the Related Objects tab
window.
Parent Objects area
The parents of the selected network object is displayed in the Parent Objects
area of the Related Objects tab.
User Objects area
All the changes that are begin done to an object by the user will be captured
in this area. The user name and the time stamp will also be displayed for
auditing purposes.
Objects tab
Object View
This tab displays all the Discovery objects created for a Discovery request. You can
filter the displayed information as required.
See Figure 43 on page 67.
Also please See Discovery Objects on page 85 to refer the procedure.
Parameters tab
Parameter View area
This tab displays all the parameters of all the Discovery objects. You can also filter
the displayed information as required.
See Figure 43 on page 67

65
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

To open the Transactions window


From the Integration menu, select Discovery and then click Request
Results.
The Transactions window is displayed. Click the appropriate tabs as per
your requirement.

Figure 41. The Transactions window.

Figure 42. The Transaction/Request Details/Related Objects tab window.

66
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Figure 43. The Transactions/Request Details/Objects tab window.

Figure 44. The Transactions/Request Details/Parameters tab window.

67
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Figure 45. The Transactions/Sweep Details tab window.

Note
The highlighted grey areas are read only fields and the white areas can
be modified for all the above tabs.

68
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Fields
The following are the field descriptions for the Transaction window and the tabs:

Field Description

Request Details tab

Request ID The unique identification number of the transaction


request ID.

Sweep ID If the discovery is caused by a Sweep Row, then its ID is


stored here.

Types The type of the Transaction.

Mans Name The name of the unique identifier used within the OSS to
identify the management system responsible for
interfacing with the equipment.

Status The status of the discovery transaction. Options are:


IN PROGRESS
COMPLETED
PENDING
ERROR
COMPARE_INPROGRESS
COMPARED
CREATE_INPROGRESS
CREATED
See Transaction States on page 80 for more details.

Date Received The date and the time the transaction was received from
the MDD. hh:mm dd-mm-yyyy is the format used by the
system to generate the automatic time and date stamp.

Date Processed The date and the time that the transaction request was
processed. hh:mm dd-mm-yyyy is the format used by the
system to generate the automatic time and date stamp.

Details This is optional. Enter the details of the discovery


transaction.

Table 41. The Transaction window

69
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Transactions/Request Details/Details Tab - Objects area

Parameter Name Enter the required user defined name of the parameter.
This is used to filter the displayed objects in the Objects
area of the Details tab window.

Value Enter the required Network value.

Status Select the required reconcile status of the parameter from


this list. Available statuses are as follows:
ALL
EQUAL
NOT_EQUAL
NOT_IN_CLARITY
CREATED
UPDATED
IGNORED

Object ID The unique Identification number of the Network object.

Network Object Name of the Clarity object that is known in the Network.

Clarity Object The Clarity object type that maps to the NEMS object
type, e.g NE, CARD, CIRCUIT. Use the List of Values.

Network ID The identification number of the Network of the relevant


object.

Clarity ID The unique identification number of the object in the


Clarity database.

Parent Object Indicates the parent object ID (if any).

Source Indicates whether the object has been discovered from


the network of created by Clarity Reference to the
selected Clarity object.
Valid values are:
NETWORK
CLARITY

Reference Reference to the selected CLARITY object.

Table 41. The Transaction window

70
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Status The status of this object. The valid states are as follows:
DISCOVERED - Object has been entered into the
Transaction window but has not been processed.
COMPLETED- Objects has ben processed into the
Clarity Operational Support System.
ERROR - There were errors processing this object.
CREATED - Object has been created in the Clarity
Operational Support System.
COMPARED -

Reconcile Status The Reconcile Status describes the difference (if any)
between the object from the Management System and
the object in the Clarity Database. Valid states are as
follows:
ALL
EQUAL
NOT_EQUAL
NOT_IN_CLARITY
CREATED
UPDATED
IGNORED
Note: The Reconcile Status field is populated only for
transactions of type RECONCILE.

Mans Name The name of the unique identifier used within the OSS to
identify the management system responsible for
interfacing with the equipment.

Check box

Select All If you need to delete all the displayed inventory objects,
select this check box.

Select If you need to delete a specific object, select the


corresponding check box.

Table 41. The Transaction window

71
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Transactions/Request Details/Details tab - Parameters area

Name Parameter name.

Network Value The value of the Network Object for the given attribute
name.

Clarity Value This is populated after the Reconciliation. This will hold
the value as in the Clarity Database.

User Value This is created when the user is creating/updating a


particular value.

Status This field is populated and updated after the


Reconciliation is performed. The States are as follows:
EQUAL
NOT_EQUAL
NOT_IN_CLARITY
CREATED
UPDATED
IGNORED

Transactions/Request Details/Details/Errors tab

Level The level at which the error occurred.

Description A brief description of the error.

Date The date and the time which the error occurred.

Transactions/Request Details/Details/Related Objects tab - Child Objects


Area

Object ID The unique object identifier for child objects.

Object Type The type of object.

Details/Related Objects tab - Parent Objects Area

Object ID The unique object identifier for parent objects.

Table 41. The Transaction window

72
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Object Type The type of object.

Transactions/Request Details/Details/Related Objects tab - User Objects


Area

Object ID The unique object identifier for the user objects.

User User ID of the user who created the object.

Timestamp The date and the time the object was created.

User Action The action the user had performed.

Transactions/Request Details/Objects tab

Parameter Name Enter the required user defined name of the parameter.
This is used to filter the displayed objects in the Objects
area of the Details tab window.

Value Enter the required parameter value.

Status Select the required reconcile status of the parameter from


this list. Available statuses are as follows:
ALL
EQUAL
NOT_EQUAL
NOT_IN_CLARITY
CREATED
UPDATED
IGNORED

Objects ID The unique Identification number of the Network object.

Network Object Name of the Clarity object that is known in the Network.

Clarity Object The Clarity object type that maps to the NEMS object
type, e.g. NE.

Network ID The unique identification number of the object in the


Network.

Table 41. The Transaction window

73
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Clarity ID The unique identification number of the object in the


Network.

Parent Object Indicates the parent object id (if any).

Source Indicates whether the object has been discovered from


the network of created by Clarity Reference to the
selected Clarity object.
Valid values are:
NETWORK
CLARITY

Reference Reference to the selected CLARITY object.

Status The status of this object. The valid states are as follows:
DISCOVERED - Object has been entered into the
Transaction window but has not been processed.
COMPLETED- Objects has ben processed into the
Clarity Operational Support System.
ERROR - There were errors processing this object.
CREATED - Object has been created in the Clarity
Operational Support System.
COMPARED

Reconcile Status The reconcile status of the network and the OSS value.

Mans name The name of the Management System the inventory


objects were collected from.

Transactions/Request Details/Parameters tab

Object Type ID The unique identification of the type of object discovered.

Name The name of the parameter.

Network Value The value of the Network Object for the given attribute
name.

Clarity Value This is populated after the Reconciliation. This will hold
the value as in the Clarity Database.

Table 41. The Transaction window

74
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

User Value This is created when the user is creating/updating a


particular value.

Status The status of the object.

Network Element The management element.

Card The equipment holder and the equipment.

Port The parameter for the Port object type.

System Config Parameter value of the system configuration as in the


Network.

Parent Port Parent port name as in the Network.

Additional NEMS Hold any other Network values, that are specific in the
Values current object.

Transactions/Sweep Details tab - Sweep Details area

Sweep ID If the discovery is caused by a Sweep Row, then its ID is


stored here.

Schedule Name This is the identifier of the configuration, i.e. the name for
the Sweep Configuration being added.

Start Time The start time of the run, if applicable. This is filled
automatically when the job starts.

Status Time The end time of the Sweep run. This is updated whenever
a certain status is completed during the sweep run or
collection process and again updated by the Sweeper
Reconciliation tool whenever a certain status is completed
during the reconciliation
process for that run. Sweep Reconciliation is explained in
the next section.

Table 41. The Transaction window

75
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Status Possible values are:


Sweep Pending - defines the sweep collection status
as
pending. This state is set at the initiation of the request.
Sweep Failed - defines the sweep collection status as
fail. This
state is used when an invalid IP range or where
connectivity to
the network is unavailable. An error description with
meaningful comment is generated.
Sweep In Progress - defines the sweep collection status
as in progress.
Sweep Completed - defines the sweep collection status
as completed.

Description This field provides information extracted from the


Scheduler describing the domain being swept. If the
sweep fails, the Description field also provides
information on the reason (this error information is
appended to the record).

Transactions/Sweep Details tab - Sweep Results

Results ID The unique identification number of the sweep result.

Object ID The unique NEMS object identifier.

Recon Time The time when the reconciliation for all the network
elements in that sweep configuration was completed.

Result Result of the sweep run, i.e., whether the equipment


being discovered is active or inactive, or whether the ping
resulted in an error.
Where IP Sweeper is used, then these status values
provide an indication of the ping results. Where a NEMS,
file, etc., is used for the sweep then the only result
supported is ACTIVE.
(as the search only returns active nodes). The ERROR
value is
only used when the IP Sweeper encounters a problem.

Table 41. The Transaction window

76
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Field Description

Action Possible values are as follows:


If Object is in database (Discovery is Active) and in
network: NO_ACTION
If Object is in database (Discovery is Inactive) and in
network: EQUIP_ON
Object is in database and not in network: EQUIP_OFF
Object in network and not in database:
COLLECT_HEADER

Description Any information or error message associated with the


network object.

Table 41. The Transaction window

77
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Buttons

Button Description

Request Details tab- Request Details area

Submit Request Click to manually insert Loadbay


objects that have been flagged as
NOT_IN_CLARITY(RECONCILE state)
to the Clarity Inventory.
In order to submit a request, the
Discovery request should be in either
the ERROR or the COMPARED states.

Report Click this button to generate a report


on all the transaction request.

Details Tab Objects area

Search Click to search discovery objects which


contains the specified parameters.

Delete Inventory Objects Click to delete objects from the


inventory. You can either select a
specific record or all the displayed
records, by selecting either the Select
check box or the Select All check box.

Details Tab Parameters area

Copy Network Value Click to copy the value of the Network


Object for the given attribute into the
user value.

Update Inventory with User Values Update the Clarity Database, User
Value column.

Details/Errors tab

Export Errors Exports all the errors in to a Excel file


(CSV).

Table 42. The Transaction window- buttons

78
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Button Description

Transactions/Request Details/Objects tab

Search Click to search discovery objects which


contains the specified parameters.

Delete Inventory Object Click to delete objects from the


inventory. You can either select a
specific record or all the displayed
records, by selecting either the Select
check box or the Select All check box.

View Details Click to view, the detailed information


of the selected record.

Export Objects Click to export all the displayed


objects, to a csv file.

Transactions/Request Details/Parameters tab

Copy Network Values Copies the Network Value in to the


user value field.

Update Inventory with User Values Updates the Clarity database with the
value in the User Value column.

View Details Displays more details of the


parameter in the Details tab window.

Export Parameters Click to export all the displayed


parameters, to a csv file.

Table 42. The Transaction window- buttons

79
D I S C O V E R Y TR A N S A C T I O N S
Transactions Window

Transaction States
Transactions can have the following states:
In Progress
NEMS objects have been discovered without error and the transaction has
been inserted, but has not yet been processed.
Completed
NEMS objects have been discovered without error, the transaction has been
processed and the data entered into the Clarity OSS database. That is, all
network objects inserted for that transaction were successfully converted into
its corresponding Clarity Object.
Pending
The transaction process is pending.
Error
The discovery MDD encountered errors when collecting or translating the
NEMS objects. The transaction was processed, but failed during the
conversion process.

Hint
The error message for the transaction can be viewed in the Errors tab.

80
D I S C O V E R Y TR A N S A C T I O N S
Features of the Transactions Window

Features of the Transactions Window


The features of the Transactions window are:

Feature See

Opening the Transactions window page 62

Searching for transactions page 66

Processing transactions page 67

Display and search for Discovery page 85


objects.

81
D I S C O V E R Y TR A N S A C T I O N S
Searching for Transactions

Searching for Transactions


All transactions, regardless of status, can be displayed in the Transactions
window. You may need to perform a query in this window to view transactions
that:
require manual processing
errors that require fixing
were received or processed on a certain date
have a certain status
result from a specific NEMS request.
The following procedure describes how to search for transaction records.
To search for transaction records
1 Open the Transactions window.
See Transactions Window on page 62 for more information.
2 Click the Query button on the toolbar to enter the window into query mode.
3 Enter your search criteria in the Request Details section.
4 Click the Query button again.
Records matching the search criteria are displayed.
5 If multiple records are retrieved, use the scroll bar to view all records.

Hint
Double-click the Query button to view all transaction records.

82
D I S C O V E R Y TR A N S A C T I O N S
Processing Transactions

Processing Transactions
A transaction is considered completed when all of the objects collected during the
discovery request are translated and entered in the Clarity OSS database.
The following rules apply for processing transactions:
If the MDD has a value of TRUE for the PROCESS_ON_LOAD attribute
and the transaction has the status NEW, the MDD will automatically
process the data to be entered into the Clarity OSS database.
After processing, the Transaction will have a status of COMPLETED if the
processing was successful or ERROR if there were errors during the
processing step.
If the MDD has a value of FALSE for the PROCESS_ON_LOAD
attribute and the Transaction has status NEW, the MDD will not
attempt to process the data into the Clarity OSS database.
In this situation, the transaction will have to be processed manually. See
Manual Transaction Processing on page 67 for more information.
Transactions with a status of ERROR will never be processed
automatically regardless of the value of the PROCESS_ON_LOAD
property.
At this point you can choose to either:
fix the errors by editing the data in the Discovery Transactions window.
update the MDD configuration and send a new discovery request.

Note
The PROCESS_ON_LOAD property is set up as an attribute in the MDD
Instance reference window. If this attribute is not set up manual
processing will be the default. Refer to the Clarity Configuration Manager
User Manual for more information about this window.

Manual Transaction Processing


The following procedure describes how to manually run a transaction.
To manually run a transaction
1 Open the Transaction window.See To open the Transactions window on
page 66 for more information.
2 Display the transaction record that requires processing.
See Searching for Transactions on page 66 for more information.
3 Ensure that all errors have been fixed.

83
D I S C O V E R Y TR A N S A C T I O N S
Processing Transactions

4 Click the Submit Request button.


If the transaction is successful the status of the transaction will change to
Completed.

Note
The request will be submitted only if the Discovery request is in either
the ERROR status or the COMPARED status.

Modifying and Re-running Existing Transactions


Use the following procedure to describe how to modify and re-run an existing
transaction.

Note
The Transaction window will allow modifications to the Status field in the
Request Details area, and the Value field in the Details tab.

To modify a status
1 Open the Transactions window.
See Transactions Window on page 62 for more information.
2 Perform a search for transactions.
See Searching for Transactions on page 66 for more information.
3 In the Status field, enter the new status.
4 Click the Save button to save the changes.
To modify a parameter
1 Open the Transactions window.
See Transactions Window on page 62 for more information.
2 Perform a search for transactions.
See Searching for Transactions on page 66 for more information.
3 In the Parameters tab, select the value of the parameters you wish to modify
and enter the new values as required.
4 Click the Update Inventory with User Values button.
To re-run an existing transaction
1 Open the Transactions window.
See Transactions Window on page 62 for more information.
2 Perform a search for the required transactions.
See Searching for Transactions on page 66 for more information.
3 Modify any status details as required.
See To modify a status on page 68 for more information.

84
D I S C O V E R Y TR A N S A C T I O N S
Processing Transactions

4 Modify any parameter details as required.


See To modify a parameter on page 68 for more information
5 Click Save.
6 Click Submit Request to re-run the transaction.
Once completed, you can check the result of the execution by performing a
search for the Transaction and checking the Status field. For more
information please See To search for transaction records on page 82.

Note
If any errors occurred, you can determine the cause of the error using the
records displayed in the Errors tab.

Discovery Objects
You can display and search Discovery objects created for a Discovery request, in
the Transactions/Objects tab window. See Figure 43 on page 67.
To display and search for Discovery Objects
1 Open the Transactions window. See Transactions Window on page 64 for
more details.
2 Search for the required transaction record. See To search for transaction
records on page 82 to refer the procedure.
3 Then click the Objects tab.

Note
Once you have selected the Objects tab, all the Discovery objects
created for the selected Discovery request is displayed.
4 If you need to filter the displayed records in this tab: enter the required
information in the Parameter Name field, the Value field and select the
status from the Status list. Then click Search.The filtered records are
displayed.
5 If you need to delete an inventory object, view details of an object or export
an object: select the corresponding Select check box of the record and then
click Delete Inventory Object, View Details or Export Objects as per your
requirement. If you wish to perform one of the above on all the displayed
records, select the Select All check box.

85
D I S C O V E R Y TR A N S A C T I O N S
Processing Transactions

86
CHAPTER 5

Reference Data

This section describes how to use the reference data windows for the Discovery
module. Reference windows are used to maintain information accessed using the
List of Values (LOV).

87
REFERENCE DATA
Discovery Reference Data Window

Discovery Reference Data Window


The following reference window for Discovery can be accessed through
Integration>Discovery menu path.

Window See

Discovery Sweep Configuration page 88


window

Table 51. Discovery Reference window

Discovery Sweep Configuration


Use this window to create discovery sweep configurations from the Clarity
Operational Support System.
To open the Discovery Sweep Configuration window

From the Integration menu, select Discovery and then click Sweep
Configuration.
The Discovery Sweep Configuration window is displayed.

Figure 51. The Sweep Configuration window

88
REFERENCE DATA
Discovery Reference Data Window

Fields

Field Description

Name The name of the configuration. This is


a mandatory field.

Object Range This is the IP address or the IP


range to be sweeped for the IP
network objects. e.g. NE
Free text for non-IP network
objects.
e.g.BTS, which cannot be accessed
directly, only via a NSM, and this
will be then named the NMS knows
Example: 100.10.99.5 or
100.10.99.5, 100.10.99.10, BST1

Connection ID This could be the NEMS name, or a


connection id for a non-IP discovery.

Status The status of the configuration.


Possible states:
Active
Inactive
Note: Only the configurations in the
Active state can be used for
sweeps.

SNMP Type connection used:


Y - for IP network objects
N - for non-IP network objects.

Table 52. The Sweep Configuration window; field descriptions

To create a new sweep configurations


1 Open the Sweep Configuration window. See To open the Discovery Sweep
Configuration window on page 88
2 Create a new record.
3 Enter the required name of the configuring in the Name field.
4 Enter the range of the object in the Object Range field.
5 Enter an identification for the connection in the Connection ID field.
6 Select the required status from the Status list.

89
REFERENCE DATA
Discovery Reference Data Window

7 Select the required SNMP from the SNMP list.


8 Save the record.

Note
The sweep configuration records created by the user from the
Discovery Sweep Configuration window, are displayed/made
available to use in Workbench, under the Discovery/Sweep
Configuration tab.
Also sweep configurations created by the user within the
Workbench/Discovery/Sweep Configuration tab, will be
displayed/made available to use in the Discovery Sweep
Configuration window.
To modify or delete sweep configurations
1 Open the Sweep Configuration window. See To open the Discovery Sweep
Configuration window on page 88
2 Select the record you wish to modify or delete.
3 Perform the required changes or delete the selected record.
4 Save the record.

Note
You can only delete the sweep configuration records that are not
been used by Discovery.

90
INDEX

C functions
Translate language statements 51
Card object type 24
Clarity objects 11, 33
Clarity predefined object types 19 I
Card 24 interface StringExpression 61
NE 19
composite translation example 59
create a new sweep configuration 89 L
creating literals
Clarity object types 29 Translate language statements 58

D M
defining mapping
Clarity object type parameters 29 NEMS objects 34
NEMS object parameter rules 40 NEMS objects to Clarity objects
delete a sweep configuration 90 40
deleting menus 10
object types records 32
modify a sweep configuration 90
records in NEMS Object Mapping screen 49
modifying
Discovery
object types records 31
menus 10
records in NEMS Object Mapping screen 47
overview 8
process 9
Discovery object types 12 N
Discovery Object Types screen
features 18 NE object type 19
opening 13 NEMS Object Mapping screen
discovery referance data windows 87 deleting records 49
features 39
discovery sweep configuration 88
fields 15, 35, 69
Discovery transactions 63 mapping NEMS objects to Clarity objects 40
modifying records 47
opening 35
F querying records 45
features NEMS object parameter rules 40
Discovery Object Types screen 18 NEMS objects
NEMS Object Mapping screen 39 mapping 34
Transactions screen 81
fields
NEMS Object Mapping screen 15, 35, 69

91
INDEX

O T
object type parameters transaction records
querying 30 querying 82
object type records transactions
deleting 32 processing 83
modifying 31 Transactions screen
object types feature 81
Clarity predefined 19 opening 64
creating 29 searching for transaction records 82
Discovery 12 Translate language statements 51
querying 30 built-in functions 51
opening composite translation example 59
Discovery Object Types screen 13 literals 58
NEMS Object Mapping screen 35 operators 58
Transactions screen 64
opening fault attribute list window 88
operators
Translate language statements 58
overview 8

P
parameters
Card object type 24
defining 29
NE object type 19
NEMS object types 40
process 9
processing transactions 83

Q
querying
object type parameters 30
object types 30
records in NEMS Object Mapping screen 45
records in the Object Types screen 30
transaction records 82

R
referance data 87

S
searching for transactions 82

92
About Clarity

Clarity provides an award winning solution that is designed to simplify the operations of communications networks. It
reduces the process times and cost to manage network operations and consequently improves the customer experience.
It is used globally to support fixed, mobile, data and converged networks, and supports any combination of next gener-
ation and legacy networks technologies.

The Clarity portfolio is used to support core business processes, including the deployment and management of network
build and deployments; the creation and selling of products through a unified product catalog; the automation of order
fulfilment through to network activation; and the assurance of network performance and quality. It is architected as a
modular product that streamlines the 17 eTOM elements of OSS into a single unified suite. This optimum architecture
provides executive visibility of network impact on revenue and customer experience across both service fulfilment and
assurance.

Established in 1994, Claritys solutions currently help operators around the world manage over 250 million subscribers.

For more information, please email us at info@clarity.com or visit 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