Download as pdf or txt
Download as pdf or txt
You are on page 1of 58

Use pursuant to applicable agreements

Title page

Alcatel-Lucent 9959
Network Performance Optimizer | M4
Export Interface User Guide

expintug
3BK174465119PCZZA
Alcatel-Lucent – Proprietary
Use pursuant to applicable agreements
Issue 21
October 2011
Use pursuant to applicable agreements

Legal notice

Legal notice

Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent. All other trademarks are the property of their respective
owners.

The information presented is subject to change without notice. Alcatel-Lucent assumes no responsibility for inaccuracies contained herein.
Copyright © 2011 Alcatel-Lucent. All rights reserved.
Contains proprietary/trade secret information which is the property of Alcatel-Lucent and must not be made available to, or copied or used by anyone outside
Alcatel-Lucent without its written authorization.
Not to be used or disclosed except in accordance with applicable agreements.

Alcatel-Lucent – Proprietary
Use pursuant to applicable agreements
Contents

Preface
Purpose ............................................................................................................................................................................................ vii
vii

Reason for reissue ....................................................................................................................................................................... vii


vii

Document pertinence ................................................................................................................................................................. vii


vii

Audience ......................................................................................................................................................................................... vii


vii

Assumed knowledge .................................................................................................................................................................. vii


vii

Product names ............................................................................................................................................................................. viii


viii

How to comment ........................................................................................................................................................................ viii


viii

1 Export interfaces using EQL requests

Overview ...................................................................................................................................................................................... 1-1


1-1

Introduction ................................................................................................................................................................................. 1-2


1-2

Execute data query ................................................................................................................................................................... 1-2


1-2

Execute report request ............................................................................................................................................................. 1-4


1-4

Export global parameters ....................................................................................................................................................... 1-7


1-7

Export global indicators ......................................................................................................................................................... 1-8


1-8

Execute dynamic Excel page ................................................................................................................................................ 1-9


1-9

Export interface examples ................................................................................................................................................... 1-10


1-10

Executed data query output format .................................................................................................................................. 1-14


1-14

Executed report request output format ........................................................................................................................... 1-17


1-17

Global parameter export format ........................................................................................................................................ 1-22


1-22

Global indicator export format .......................................................................................................................................... 1-22


1-22

Command line for EQL ........................................................................................................................................................ 1-23


1-23

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary iii
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Contents

....................................................................................................................................................................................................................................
2 Access EQL from programing language

Overview ...................................................................................................................................................................................... 2-1


2-1

Introduction ................................................................................................................................................................................. 2-1


2-1

Procedure 2-1: Install certificates on Java client ........................................................................................................... 2-2


2-2

Procedure 2-2: Start Java client application .................................................................................................................... 2-3


2-3

Sample code to retrieve certificate from Web server ................................................................................................... 2-6


2-6

Sample code to retrieve XML result of EQL query ................................................................................................... 2-13


2-13

3 Export and import of object zone & working zone definition

Overview ...................................................................................................................................................................................... 3-1


3-1

Introduction ................................................................................................................................................................................. 3-1


3-1

Export Object Zones ................................................................................................................................................................ 3-1


3-1

Import Object Zones ................................................................................................................................................................ 3-2


3-2

Export Working Zones ............................................................................................................................................................ 3-3


3-3

Import Working Zones ............................................................................................................................................................ 3-3


3-3

....................................................................................................................................................................................................................................
iv Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
List of procedures

2 Access EQL from programing language

2-1 Install certificates on Java client .......................................................................................................................... 2-2

2-2 Start Java client application ................................................................................................................................... 2-3


2-3

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary v
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
List of procedures

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
vi Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Preface
Preface

Purpose
This guide describes how to access EQL from a programing language and export NPO
public interfaces using EQL requests.

Reason for reissue


Refer to the following Editions for a list of technical and editorial updates to the current
guide.
In Edition 10
First release of document for M4 R5
In Edition 02
First official release of document for Release M4 R3.
In Edition 01
First official release of document for Release M4.

Document pertinence
This document applies to the NPO M4.1 projects.

Audience
This document is intended for:
• Field service technicians
• Site administrators
• System support engineers (specialists)
• Occasional users (e.g. subcontractors).

Assumed knowledge
You must have a basic understanding of the:
• Alcatel-Lucent operations and maintenance concepts for the BSS and RNS
• Java programming language.

...................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary vii
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Preface

....................................................................................................................................................................................................................................
Product names
This document uses the following NPO naming convention: 9959 NPO and the generic
term NPO refer to the Alcatel-Lucent 9959 Network Performance Optimizer.

How to comment
To comment on this document or indicate an error, please contact your customer
representative.

....................................................................................................................................................................................................................................
viii Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
1 1xport interfaces using
E
EQL requests

Overview
Purpose
This section describes how to export interfaces using EQL requests.

Contents

Introduction 1-2
Execute data query 1-2
Execute report request 1-4
Export global parameters 1-7
Export global indicators 1-8
Execute dynamic Excel page 1-9
Export interface examples 1-10
Executed data query output format 1-14
Executed report request output format 1-17
Global parameter export format 1-22
Global indicator export format 1-22
Command line for EQL 1-23

...................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-1
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Introduction

....................................................................................................................................................................................................................................

Introduction
Note: EQL queries return only the active objects from the database.
The NPO offers a public web interface called the Extensible Query Layer (EQL), used to
retrieve data through external tools such as web browsers (Mozilla, Internet Explorer) or
web-enabled applications (for instance, Excel). This can be done by executing queries or
report requests.
Both services are accessible over secured HTTP (HTTPS).
The request is done via the URL using a:
• GET HTTPS request
• POST HTTPS request.
Note: EQL queries return only the active objects from the database.
The objective is to be able to retrieve the result of these requests within any Java
application.
The maximum URL length is usually around 2048 bytes (for instance, in Internet
Explorer), so for very large requests, use the POST method.
By default, EQL requests are expressed in GMT time, but any time zone can be used by
the EQL interface (via the tz argument).

Execute data query


Using the EQL interface, an external system can query QoS data (indicators) or radio data
(telecom parameters) and retrieve it in various formats (HTML, XML, CSV, SCSV, Excel
(XLS & IQY)).
Note: For Excel 2003, there is a limitation when exporting interfaces to worksheets
containing a maximum of 65,536 rows and 256 columns.
Use the following URL to execute a data query:
https://<server_name>:<server_port>/maat/report?otype=<type>
&eids=<extid0,extid1...>&periodicity=<period>&&firstdate=<date>
&seconddate=<date>[&tz=<timezone>]&datalist=<data0,data1...>
<[&interpolation=method>][&spatialaggregation=
<spatialAggregationChoice>]&format=<output_format>

Attribute Name Description


<server_name> Server hostname or IP address running with Tomcat.
<server_port> TCP Port used by Tomcat
Default value: 8443

....................................................................................................................................................................................................................................
1-2 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Execute data query

....................................................................................................................................................................................................................................

Attribute Name Description


<type> Network object type.
Object zone types are also supported (for example: OZ_CELL2G).
Examples:
• CELL2G, for GSM
• CELL3G, for W-CDMA
• BSCELL, for WIMAX
• CELLLTE, for LTE
• ENODEB, for LTE.
<extid> External ID of the network object. It can be obtained from the
properties of the network object.
The network object external identifiers are under the following
formats:
• MCC / MNC / LAC / CI for GSM
• fddCell userLabel for W-CDMA
• LteCell uniqueName for LTE in case of LteCell
• eNodeB uniqueName for LTE in case of eNodeB.
For the Object zone, as objects do not have external IDs, use the
name of the object zone.
<period> {h|d|w|m} for Hourly, Daily, Weekly or Monthly.
<date> Any past date (the current day included), using the “YYYY.MM.DD
HH24.MI” format.
Depending on the selected periodicity; the dates included in the
request are expressions relative to the current hour, the current day,
the current week, or the current month.
Example: 2009.04.15 18.00
<timezone> A timezone name or abbreviation designates the server local time
zone.
The NPO takes the list of Oracle time zones, the list of Java
supported time zones, the list of Window supported time zones and
the list of Solaris time zones, then extrapolates the data which is
common to the lists.
The time zones are expressed as a string such as “Europe/Paris” or
as a string providing the shift from GMT such as "Etc/GMT-1”
(according to the POSIX standard).
<datalist> Short name of a QoS indicator or name (SYSTEM_NAME) of a
radio telecom parameter prefixed by PARAM_. Each item of the list
can appear only once in the list.
<method> Interpolation method (DEFAULT, NONE or LINEAR).
This is optional and applicable only for QoS indicators.

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-3
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Execute data query

....................................................................................................................................................................................................................................

Attribute Name Description


<spatialAggregation- {yes|no}
Choice> If selected, a temporary object zone will be built that embeds whole
selected objects (from<extid>) and its value for selected indicators
will also be added in results (with Aggr. as the title). Default value if
not specified is No.
<output_format> html | xml | csv | scsv | xls | pdf

Note: When the URL contains a date interval, the two date expressions are of the
same type, either dynamic expressions or literals.
The following restrictions apply to the EQL interface concerning QoS queries:
• Only Hourly, Daily, Weekly and Monthly data is available
• The interpolation parameter has no effect on a Daily/Weekly/Monthly query
because the interpolation is already done during the consolidation phases
• The number of objects is limited to 2000
This limitation does not apply to global export features.
• The number of indicators and radio telecom parameters is limited to 50
• As the result of a QoS query must not exceed 2MB (2097152 bytes), the MAAT
server checks that the query fulfills the following rule:
<nr objects> x <nr indicators> x <nr periods> x 8 < 2097152
This limitation does not apply to global export features.
Note: Do not use the same indicator or the same network object several times in the
same query.
Example of what not to do:
https://gkar:8443/maat/report/?otype=CELL2G& eids=002/F02/2/
10&periodicity=d&firstdate=2006.12.30%2018.00&seconddate=
2006.12.31%2005.00&datalist=GTCAVAN,GTCAVAN&format=xml

Execute report request


Using the EQL interface, an external system can build its own report request and retrieve
data in various formats (HTML, XML, CSV, SCSV, Excel or PDF).
Note: There is a limitation when exporting interfaces in Excel to worksheets
containing a maximum of 65,536 rows and 256 columns.
Use the following URL to execute a report request:
https://<server_name>:<server_port>/maat/report?
reporttemplatename=<rName>&otype=<type>&eids=<extid0, extid1...>
&periodicity=<period>&firstdate=<date>[&seconddate=<date>]
[&tz=<timezone>][&spatialaggregation=<spatialAggregationChoice>]
&format=<output_format>[&scheduledate=<scheduledate>

....................................................................................................................................................................................................................................
1-4 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Execute report request

....................................................................................................................................................................................................................................
&reportname=<name>[&rsperiodicity=<repeat_periodicity>&rsenddate=
<repeat_end_date>&rsfreg=<repeat_every>[&rson=<repeat_on>][&rsby=
<repeat_on>]]]

Attribute Name Description


<server_name> Server hostname or IP address running with Tomcat.
<server_port> TCP Port used by Tomcat
Default value: 8443
<rName> Report template name
<type> Network object type.
Object zone types are also supported.
Examples:
• CELL2G, for GSM
• CELL3G, BSC, RNC for W-CDMA
• BSCELL, for WIMAX
• CELLLTE, for LTE
• ENODEB, for LTE.
<extid> External ID of the network object. It can be obtained from
the properties of the network object.
The network object external identifiers are under the
following formats:
• MCC / MNC / LAC / CI for GSM
• fddCell userLabel for W-CDMA
• LteCell uniqueName for LTE in case of LteCell
• eNodeB uniqueName for LTE in case of eNodeB.
<period> {h|d|w|m} for Hourly, Daily, Weekly or Monthly.
<date> Any past date (the current day included), format:
“YYYY.MM.DD HH24.MI”.
Relative date are supported
In case of scheduled report, the date is relative to the
execution date.
<timezone> A timezone name or abbreviation designates the server
local time zone.
The NPO takes the list of Oracle time zones, the list of Java
supported time zones, the list of Window supported time
zones and the list of Solaris time zones, then extrapolates
the data which is common to the lists.
The time zones are expressed as a string such as
“Europe/Paris” or as a string providing the shift from GMT
such as "Etc/GMT-1” (according to the POSIX standard).

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-5
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Execute report request

....................................................................................................................................................................................................................................

Attribute Name Description


<spatialAggregationChoice> {yes|no}
If selected, a temporary object zone will be built that
embeds whole selected objects (from<extid>) and its value
for selected indicators will also be added in results (with
Aggr. as the title). Default value if not specified is No.
<output_format> html | xml | csv | scsv | xls | pdf (also used as file extension
for the resulting report in the case of a scheduled report).
<scheduledate> Schedule date format: (YYYY.MM.DD)
The schedule date must be greater than the current date.
This is optional and applicable only for scheduled reports.
<name> Output filename prefix for the report to be scheduled.
<repeat_periodicity> {d|w|m} for Daily, Weekly or Monthly.
<repeat_end_date> Date after which the report is no longer evaluated, format:
YYYY.MM.DD.
This date must be greater than the <schedule_date>
parameter.
<repeat_every> Integer value for the repetition frequency.
• For daily repetitions the value is between 1 and 30
• For weekly repetitions the value is between 1 and 5
• For monthly repetition the value is between 1 and 12
If an incorrect value is entered the error message will
clearly state those intervals.
<repeat_on> A comma separated list of days: sun|mon|tue|wed|thu|fri|sat
for Sunday, Monday, Tuesday, Wednesday, Thursday,
Friday, and Saturday.
To be used (mandatory) only for weekly repetitions.
Empty list are not valid.
<repeat_by> date | day meaning if the report is to be re-executed on the
given date (e.g. the 5th of each month) or the given day
(e.g. 3rd Tuesday of each month).
To be used (mandatory) only for monthly repetition.

The following restrictions apply to EQL interface concerning report execution


requests:
• Only Hourly, Daily, Weekly and Monthly data are available
• The number of objects is limited to 2000
This limitation does not apply to global export features.
Warning reports are supported.

....................................................................................................................................................................................................................................
1-6 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Execute report request

....................................................................................................................................................................................................................................
Note: When executing an “operational only” parameter view through EQL interface,
both historical and operational parameter values are returned.

Export global parameters


Note: If the exported file has more than 256 columns, it cannot be opened with
Microsoft Excel 2003. You must use another tool, for example, Microsoft Excel 2007.
An external system can query some or all the parameters for a given object type through
the EQL interface and retrieve them in various formats (CSV, SCSV). This service allows
the user to retrieve only the current values of the parameters.
Use the following URL to execute a global parameter export:
https://<server_name>:<server_port>/maat/report/export?
otype=<type>&datalist={<data0,data1...>|ALL}&technology=
<techno>}&format=<output_format>[&wz=<wz>]

Attribute Name Description


<server_name> Server hostname or IP address running with
Tomcat.
<server_port> TCP Port used by Tomcat
Default value: 8443
<type> Network object type
<data> System name of a radio telecom parameter
prefixed by PARAM_ | ALL.
“ALL” is the attribute that requests all
parameters.
<techno> Optional parameter used when ALL
parameters are requested: UMTS | GSM | LTE
<output_format> csv | scsv
<wz> Working zone name (default is global).

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-7
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Export global indicators

....................................................................................................................................................................................................................................

Export global indicators


Use the following URL to execute a global indicator export:
https://<server_name>:<server_port>/maat/report/export?
otype=<type>=<report>=<period>=
<>&[seconddate=<date>]&[format=<output_format>]&[tz=<tz>][=<wz>]

Attribute Name Description


<server_name> Server hostname or IP address running with
Tomcat.
<server_port> TCP Port used by Tomcat
Default value: 8443
<type> Network object type
<report> Name of the report
<period> {h|d|w|m|30mn|15mn|5mn} for Hourly, Daily,
Weekly, Monthly, 30 minutes, 15 minutes or 5
minutes.
<date> Any past date (the current day included),
format: “YYYY.MM.DD HH24.MI”.
<output_format> csv | scsv [default is csv]
<tz> Timezone of the input and output date and
hours (default is GMT).
<wz> Working zone name (default is global).

The list of indicators is retrieved according to the content of the report.


The following restrictions apply to the EQL interface concerning global indicator exports:
• Distribution reports (matrix/vector) are not supported
• Precision and percentage attribute of the indicator are ignored, and only the raw value
of indicators are reported
• The number of the indicator given is not limited, but it must reference at most 1000
indicators.
To allow a massive export, the query used for the indicator export use a greater timeout
than normal when executing the view query (1H for massive export). To avoid
overloading the system, only one thread is used to execute a given global indicator query.
Note: There is no guarantee that the order of indicators in the exported file will be the
order listed in the report properties.

....................................................................................................................................................................................................................................
1-8 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Execute dynamic Excel page

....................................................................................................................................................................................................................................

Execute dynamic Excel page


The execution of a data query produces an IQY file. The IQY file contains an Excel Web
Query that is itself a dynamic MUSE data query executed through the EQL.
Use the following URL to execute a dynamic data query:
https://<server_name>:<server_port>/maat/report/
dynamicquery?otype=<type>&eids=<extid0, extid1...>
&periodicity=<period>&firstdate=<date>
[ &seconddate=<date>][&tz=<timezone>]
&datalist=<data0,data1...>[&interpolation=<method>]

Attribute Name Description


<server_name> Server hostname or IP address running with Tomcat.
<server_port> TCP Port used by Tomcat
Default value: 8443
<type> Network object type
<extid> External ID of the network object. It can be obtained from the
properties of the network object.
The network object external identifiers are under the following
formats:
• MCC / MNC / LAC / CI for GSM
• fddCell userLabel for W-CDMA
• LteCell uniqueName for LTE in case of LteCell
• eNodeB uniqueName for LTE in case of eNodeB.
<period> {h|d|w|m} for Hourly, Daily, Weekly or Monthly.
<date> A date expression relative to the current period.
See the table below.
<tz> A timezone name or abbreviation designates the server local
time zone.
The NPO takes the list of Oracle time zones, the list of Java
supported time zones, the list of Window supported time zones
and the list of Solaris time zones, then extrapolates the data
which is common to the lists.
The time zones are expressed as a string such as
“Europe/Paris” or as a string providing the shift from GMT
such as "Etc/GMT-1” (according to the POSIX standard).
<data> Short or long name of a QoS indicator, or name of a radio
telecom parameter prefixed by PARAM_.
<method> Interpolation method (DEFAULT, NONE or LINEAR).
This is optional and applicable only for QoS indicators.

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-9
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Execute dynamic Excel page

....................................................................................................................................................................................................................................
The following table presents the Date Expressions for dynamic queries.

Periodicity Valid Date Expression


h H | H-x
x is an integer value greater than or equal to 1
d D | Dx
x is an integer value greater than or equal to 1
w Wx
x is an integer value greater than or equal to 1
m Mx
x is an integer value greater than or equal to 1

The following restrictions apply to the EQL interface concerning dynamic MUSE data
queries:
• Only Hourly, Daily, Weekly and Monthly data are available
• The interpolation parameter has no effect on Daily/Weekly/Monthly query because
the interpolation is already done during the consolidation phases
• The number of objects is limited to 2000
• The number of indicators and radio telecom parameters is limited to 50
• As the result of a QoS query must not exceed 2 Mega-Bytes (2097152 bytes), the
MAAT server checks that the query fulfills the following rule:
<nr objects> x <nr indicators> x <nr periods> x 8 < 2097152
This limitation does not apply to global export features.
• Depending on the chosen periodicity; the dates included in the request are expressions
relative to the current hour, the current day, the current week, or the current month
• The output format is HTML.
Warning reports are supported.

Export interface examples


URL- multiple network object and single indicator
https://10.203.201.156:8443/maat/report/?otype=CELL2G
&eids=208/F01/34305/2810,208/F01/34306/32586,208/F01/34307/35678
&periodicity=d&firstdate=2006.09.07 10.00
&seconddate=2006.09.09 15.00 &datalist=UHRLDDLSU_N&format=html

URL- single network object and single indicator


https://10.203.201.156:8443/maat/report/?otype=CELL2G
=208/F01/34305/2810&periodicity=d
&firstdate=2006.09.07 10.00&seconddate=2006.09.09 15.00
&datalist=UHRLDDLFL_N&format=scsv

....................................................................................................................................................................................................................................
1-10 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Export interface examples

....................................................................................................................................................................................................................................
URL- single network object and single indicator and time zone
https://10.203.201.156:8443/maat/report/?otype=CELL3G
&eids=CESLIF_194035_0/0&periodicity=d&firstdate=2009.09.06 10.00
&seconddate=2009.09.08 15.00&tz=Indian/Mayotte
&datalist=UHRLDDLFL_N&format=scsv

URL- single network object and single indicator and time zone GMT-x
https://10.203.201.156:8443/maat/report/?otype=CELL3G
&eids=CESLIF_194035_0/0&periodicity=d&firstdate=2009.09.06 10.00
&seconddate=2009.09.08 15.00&tz=Etc/GMT-2
&datalist=UHRLDDLFL_N&format=scsv

URL- multiple network object and multiple indicator


https://172.25.240.245:8443/maat/report/?otype=CELL3G
&eids=CESLIF_194035_0/0,CESLIF_194035_1/0,CESLIF_194035_2/0
&periodicity=d&firstdate=2009.09.06 11.00
&datalist=UHRLDDLSU_N,UHRLDDLSU_R,UHRLDDLRQ_N,
UHRLDDLFL_R,UHRLDDLFL_N,UHRLSDLSU_R,UHRLSDLSU_N,
UHRLSDLRQ_N,UHRLSDLER_N, UHRLSDLFL_R&format=html

URL- multiple network object and multiple indicator and time zone
https://172.25.240.245:8443/maat/report/?otype=CELL3G
&eids=CESLIF_194035_0/0,CESLIF_194035_1/0,CESLIF_194035_2/0&periodicity=
d
&firstdate=firtstdate=2009.09.06
11.00&tz=Europe/Paris
&datalist=UHRLDDLSU_N,UHRLDDLSU_R,UHRLDDLRQ_N,
UHRLDDLFL_R,UHRLDDLFL_N,UHRLSDLSU_R,UHRLSDLSU_N,
UHRLSDLRQ_N,UHRLSDLER_N, UHRLSDLFL_R&format=html

URL - report with single network object and single report


https://172.25.240.245:8443/maat/report/?reporttemplatename=11
&otype=CELL3G&eids=CESLIF_194035_0/0&periodicity=d
&firstdate=2009.09.06 11.00&seconddate=2009.09.08 15.00
&format=xls

URL - Multiple Network objects and single report


https://172.25.240.245:8443/maat/report/?reporttemplatename=11
&otype=CELL3G&eids=CESLIF_194035_0/0,CESLIF_194035_1/0,CESLIF_194035_2/0
&periodicity=d&firstdate=2009.09.08 13.00
&format=csv

URL- Multiple network object and single indicator


https://10.203.201.156:8443/maat/report/?otype=CELLLTE&eids=Venise1,
Venise2&periodicity=d&firstdate=2009.09.07 10.00&seconddate=
2009.09.09 15.00&datalist=L_ITRAENB_HOSR&format=html

URL- Single network object and single indicator


https://10.203.201.156:8443/maat/report/?otype=CELLLTE=Venise1=d=
2009.09.07 10.00=2009.09.09 15.00=L_ITRAENB_HOSR=scsv

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-11
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Export interface examples

....................................................................................................................................................................................................................................
URL- Single network object and single indicator and time zone
https://10.203.201.156:8443/maat/report/?otype=CELLLTE&eids=
Venise1&periodicity=d&firstdate=2009.09.07 10.00&seconddate=
2009.09.09 15.00&tz=Indian/Mayotte&datalist=L_ITRAENB_HOSR&format=
scsv

URL- Multiple network object and multiple indicator and time zone
https://172.25.240.245:8443/maat/report/?otype=CELLLTE&eids=Venise1,
Venise2,Naples1&periodicity=d&firstdate=2009.09.0800.00&tz=Europe/
Paris&datalist=L_ITRAENB_HOSR,L_NACR,L_SACR&format=html

URL - Multiple Network objects and single report and scheduling (no repetition)
https://10.203.201.156:8443/maat/report?reporttemplatename=
test_report_t1&otype=CELL3G&eids=46,47,48&periodicity=d&
firstdate=2005.09.08 13.00&format=csv&scheduledate=2005.09.08&
reportname=myreport

URL - Multiple Network objects and single report and scheduling with weekly repetition
https://10.203.201.156:8443/maat/report?reporttemplatename=
test_report_t1&otype=CELL3G&eids=46,47,48&periodicity=d&
firstdate=2005.09.08 13.00&format=csv&scheduledate=2005.09.08&
reportname=myreport&rsperiodicity=w&rsenddate=2009.09.14&
rsfreq=2&rson=mon,tue,wed,thu,fri

URL - Multiple Network objects and single report and scheduling with daily repetition
https://10.203.201.156:8443/maat/report?reporttemplatename=
test_report_t1&otype=CELL3G&eids=46,47,48&periodicity=d&
firstdate=2005.09.08 13.00&format=csv&scheduledate=2005.09.08&
reportname=myreport&rsperiodicity=d&rsenddate=2009.09.14&
rsfreq=1

URL - Multiple Network objects and single report and scheduling with monthly repetition
https://10.203.201.156:8443/maat/report?reporttemplatename=
test_report_t1&otype=CELL3G&eids=46,47,48&periodicity=d&
firstdate=2005.09.08 13.00&format=csv&scheduledate=2005.09.08&
reportname=myreport&rsperiodicity=m&rsenddate=2009.09.14&
rsfreq=1&rsby=day

URL - Global Parameter Export


https://10.203.201.156:8443/maat/report/export?otype=CELL2G
&datalist=ALL&technology=GSM&format=scsv

URL - Dynamic Query


https://10.203.201.156:8443/maat/report/dynamicquery?
otype=CELL2G&eids=208/F01/34305/2810,208/F01/34306/32586,
208/F01/34307/35678&periodicity=d&firstdate=D-5&
seconddate=D-1&datalist=UHRLDDLSU_N

URL - Dynamic Query and time zone


https://10.203.201.156:8443/maat/report/dynamicquery?otype=

....................................................................................................................................................................................................................................
1-12 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Export interface examples

....................................................................................................................................................................................................................................
CELL3G&eids=CESLIF_194035_0/0,CESLIF_194035_1/0,CESLIF_194035_2/
0&periodicity=d&firstdate=D-5
&seconddate=D-1&tz=Europe/London&datalist=UHRLDDLSU_N

URL - Global Indicator Export (with implicit end date)


https://10.203.201.156:8443/maat/report/export/?otype=CELL2G
&report=Alc_Mono_Call&periodicity=d&firstdate=D-5
&tz=Europe/Paris

URL - Global Indicator Export (with SCSV)


https://10.203.201.156:8443/maat/report/export/?otype=CELL2G
&report=Alc_Mono_Call&periodicity=d&firstdate=D-5
&format=scsv

URL - Global Indicator Export (with start / end date)


https://10.203.201.156:8443/maat/report/export/?otype=CELL2G
&periodicity=h&firstdate=2005.09.08 00.00
&seconddate=2005.09.10 00.00

Download NPO example files


...................................................................................................................................................................................................

1 From the Windows Client PC, type the corresponding server hostname or the server IP
address in an Internet Explorer browser bar:
https://<server_hostname> or <server_IP_address>
If a Security warning page opens, click on Continue to this website (not
recommended).
Result: The Alcatel-Lucent CSA login window opens.
...................................................................................................................................................................................................

2 In the Alcatel-Lucent CSA window:


1. Type the appropriate user name and password
2. Click on Login.
Note: If the Convergent Security Asset (CSA) warning window opens, click
Continue.
Result: The Alcatel-Lucent Welcome page appears.
...................................................................................................................................................................................................

3 In the Alcatel-Lucent Welcome page, click on Install First.


Result: The Install these packages before starting page opens.
...................................................................................................................................................................................................

4 Right click on Download example files and select Save Target As...
Save the Examples_files.zip file on the Windows Client PC. Close the Download
Complete window.

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-13
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Export interface examples

....................................................................................................................................................................................................................................
Result: The Examples_files.zip file is saved on the Windows Client PC and you can
open the needed file.
E...................................................................................................................................................................................................
N D O F S T E P S

Executed data query output format


XML format
The XML Schema (XSD) for the output result of a data query is as follows.

....................................................................................................................................................................................................................................
1-14 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Executed data query output format

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-15
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Executed data query output format

....................................................................................................................................................................................................................................

Item Description
mt Measurement types (QoS indicators or radio
telecom parameter identifiers)
mr Measurement results (per object results)
mv Measurement values (per date results)
vector_data Vector data
matrix_data Matrix data
axis_X X axis for vector and matrix values
axis_Y Y axis for matrix values
vector Holds vector and axis data
matrix Holds matrix and axis data
r Data (QoS indicators or radio telecom
parameters actual values)
oid Object external identifier. Each object OID
must be reported only once per file

The following figure is a generic example of the XML document generated for a data
query.
....................................................................................................................................................................................................................................
1-16 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Executed data query output format

....................................................................................................................................................................................................................................

Executed report request output format


The exported format for executed report requests can be:
• HTML files
• XML files
• CSV files
• SCSV files
• PDF files
• Excel (XLS) files
In HTML documents, data is presented using HTML tables so that the data can be
imported directly into Excel (Web queries into Excel).

XML format
The XSD describing the XML format for the output result of an executed report request is
as follows.

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-17
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Executed report request output format

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
1-18 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Executed report request output format

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-19
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Executed report request output format

....................................................................................................................................................................................................................................

CSV/SCSV format
The generic format of the CSV (SCSV) of executed report requests is as follows.

....................................................................................................................................................................................................................................
1-20 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Executed report request output format

....................................................................................................................................................................................................................................

Note: CSV documents use the ',' character as a separator while the SCSV documents
use ';'.
The vector type values are exported as a string, with the character:
• '|' as column separator
• '!' as axis separator.
Example of a vector with 3 elements: 3.4|2.7|7.8![50[|[100[|[150[
The matrix type values are exported as a string, with the character:
• '|' as column separator
• '#” as line separator
• '!' as axis separator.
Example of a 2x2 matrix: 1.2|3.4#5.6|6.7!]50]|]100]!]0]|]50].

Scheduled reports
For the scheduled reports there is no immediate output but a confirmation page appears.
The result report must be stored with the name prefix given by the user and must be
accessible with the following URL:
https://<server_name>:<server_port>/maat/report/
scheduled_reports/<name><scheduledate>.<output_format>
The complete listing of all the generated reports is accessible at the following URL:
https://<server_name>:<server_port>/maat/report/
scheduled_reports/

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-21
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Global parameter export format

....................................................................................................................................................................................................................................

Global parameter export format


The first line of the output layout is the header line identifying the different columns of
the output:
• OTYPE is the object type
• OEXID is the object external identifier
• OFN is the object friendly name
• <Parameter System Name>.
The subsequent lines are the requested values for each object.
Example of the generic CSV/SCSV format:

Global indicator export format


The first line of the output layout is the header line identifying the different columns of
the output:
• “id” is the object external identifer of the object
• “name” is the object friendly name of the object
• “starttime” is the first date from which the query is executed
• <Indicator Long Name>.
The subsequent lines are the requested values for each object.
Example of the generic CSV/SCSV format:

....................................................................................................................................................................................................................................
1-22 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Global indicator export format

....................................................................................................................................................................................................................................

The values are displayed in scientific format (for example: 9,6649818085049966E-001).


The formatting of the indicator (precision field) is ignored.

Command line for EQL


Introduction
Use this feature to build and send EQL requests directly through a command line that is
running both under Unix and Windows shells.
The mechanism is as follows:
• All general parameters for connection (hostname, user/password, etc.) and execution
context parameters (objects, indicators, period, etc.) are provided as an argument of
the command; see “Syntax” (p. 1-24).
• The file for results is also provided as an argument (-o option)
• Errors are reported in the current terminal
• In the case of success of the request, results are stored in the result file.

Installation information
An eql.zip archive file is provided on the NPO server at:
/opt/PC_3PP
This zip archive file contains:
• The unix shell for the command line ( eql.sh)
• The Window shell for the command line ( eql.bat)
• The body part of the command line ( eql.jar).

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-23
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Command line for EQL

....................................................................................................................................................................................................................................
Install
...................................................................................................................................................................................................

1 Open an Internet Explorer browser.


Result: The Internet Explorer browser window opens.
...................................................................................................................................................................................................

2 In the address bar, type:


https:// <server_IP_address>/
where <server_IP_address> is the IP address of the NPO server.
Result: The NPO server window opens.
...................................................................................................................................................................................................

3 Click on Install First.


Result: The Install these packages before starting page opens.
...................................................................................................................................................................................................

4 Right click on Download command line version of EQL and select Save Target As...
Save the eql.zip file on the Windows Desktop. Close the Download Complete window.
Result: The eql.zip file is saved on the Windows Desktop.
...................................................................................................................................................................................................

5 From the Desktop, unzip the eql.zip archive file and save it in the required directory.
Result: The eql.zip files are saved in the required directory.
Note: To deploy the command line on a PC under Windows, you have to transfer
(via ftp or any other tool) the eql.jar and eql.bat to any required location.
E...................................................................................................................................................................................................
N D O F S T E P S

Syntax
In the Unix environment, you have to copy the eql.jar and eql.sh to the directory of your
choice. Before using the eql.sh script, you must go to the directory where the eql.sh and
eql.jar files are present and, as the root user, give the execution rights:
chmod 777 eql.sh eql.jar
The following table shows the general syntax.

Unix ./eql.sh <host> <command> [-h][-n <port>]


[-u <user:password>][-uf <user_pwd_file>]
[-p <property_file>] -o <output_file> <options>

....................................................................................................................................................................................................................................
1-24 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Command line for EQL

....................................................................................................................................................................................................................................

Windows eql.bat <host> <command> [-h][-n <port>]


[-u <user:password>][-uf <user_pwd_file>]
[-p <property_file>] -o <output_file> <options>

The following rules apply.

Command Result
<host> Is either a valid hostname or a valid IP address of a NPO server
<command> • view selects a NPO data query
• report selects a Report Export
• parameter selects a Global Parameter Export
• indicator selects a Global Indicator Export
-h Is the option for help/usage display of the command
-n Is the option that allows to fix the connection port (default 8443)
-u Is the option to specify security elements (<user:password>) to have a
connection with the NPO
-uf Is the option that allows hiding the user password from the command line;
<user_pwd_file> is a simple text file containing the line user:password
(empty lines or lines starting with '#' are ignored)
-p Is a debug option. A specific property file can be specified that will
configure some internal parameters (traces level, etc.). This option is for
internal use only.
-o Is used to select the file (<output_file>) to which the result of the request
will be redirected. If you do not specify the path, the file will be saved in
the directory where eql.bat is located. The extension of this file is used to
specify the output format argument of the request, therefore, it must be one
of {csv|scsv}.

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-25
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Command line for EQL

....................................................................................................................................................................................................................................

Command Result
<options> Is a sequence of <argument name>=<value> strings that specifies
arguments that will be included in the URL provided to EQL. These
arguments are used to define the execution context of the request (indicator
list, start/end date, object list, etc.). The syntax used for this sequence
depends on the <command> value.
If the <command>=view, <options> syntax is:
otype=<type> eids=<extid0,extid1> periodicity=<period>
firstdate=<date> [seconddate=<date>] [tz=<timezone>
]datalist=<data0,data1> [&interpolation=<method>
][spatialaggregation=<spatialAggregationChoice>]
Refer to “Execute data query” (p. 1-2) for a detailed description and format
of the arguments/values.
If the <command>=report, <options> syntax is:
reporttemplatename=<report> otype=<type> eids=<extid0,
extid1>periodicity=<period> firstdate=<date>
[seconddate=<date>][tz=<timezone>] [spatialaggregation=
<spatialAggregationChoice>]
Refer to “Execute report request” (p. 1-4) for a detailed description and
format of the arguments/values.
If the <command>=parameter, <options> syntax is:
otype=<type> datalist={<data0,data1>|ALL} technology=
<techno>[wz=<working zone name>]
Refer to “Export global parameters” (p. 1-7) for a detailed description and
format of the arguments/values.
If the <command>=indicator, <options> syntax is:
otype=<type> report=<report> periodicity=<period>
firstdate=<date>[seconddate=<date>]
[tz=<timezone>][wz=<working zone name>]
Refer to “Export global indicators” (p. 1-8) for a detailed description and
format of the arguments/values.
For dates, the format is “YYYY.MM.DD:HH24.MI”

Examples

NPO Data query: single indicator, single eql.bat gkar view -u osmadmin:
object alcatel -o tmp.csv otype=BSC eids=
VNR_BSC2 periodicity=h firstdate=
2006.12.30:00.00 seconddate=
2006.12.31:23.00 datalist=Call_drop_
radio

....................................................................................................................................................................................................................................
1-26 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export interfaces using EQL requests Command line for EQL

....................................................................................................................................................................................................................................

NPO Data query: single indicator, multiple ./eql.sh gkar view -u osmadmin:
object alcatel -o tmp.csv otype=BSC eids=
VNR_BSC2,VNR_BSC3 periodicity=d
firstdate=2006.12.30:00.00
seconddate=2006.12.31:23.00
datalist=Call_drop_radio
NPO Data query: multiple indicator, multiple eql.bat gkar view -u osmadmin:
object (single date) alcatel -o tmp.csv otype=BSC eids=
VNR_BSC2,VNR_BSC3 periodicity=d
firstdate=2006.12.30:00.00 datalist=Call_
drop_radio,Call_drop
NPO Report: one report, csv format ./eql.sh 172.27.234.7 view -u
osmadmin:alcatel -o tmp.csv otype=
BSC eids=VNR_BSC2,VNR_BSC3
periodicity=d firstdate=
2006.12.30:00.00 reporttemplatename=ALARM_
EVOLUTION
Global Parameter Export: latitude and ./eql.sh 172.27.234.7 parameter -
longitude for all cells u osmadmin:alcatel -o tmp.csv
otype=CELL2G datalist=PARAM_LATITUDE,
PARAM_LONGITUDE technology=GSM
Global Indicator Export: indicators for ./eql.sh khan indicator -u
Alc_Mono_Call_Congestion from all BSC osmadmin:alcatel -o tmp.csv otype=
BSC report=Alc_Mono_Call_
Congestion periodicity=d
firstdate=2008.11.15:00.00

Execute EQL for Windows


...................................................................................................................................................................................................

1 From the desktop, select Start -> Run.


Result: The Run window opens.
...................................................................................................................................................................................................

2 Type cmd then click on OK.


Result: The cmd.exe window opens.
...................................................................................................................................................................................................

3 Go to the location where eql.bat is located.


Result: The associated file path is defined.
...................................................................................................................................................................................................

4 Execute the EQL; refer to “Examples” (p. 1-26).


You must ignore the following message:
....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 1-27
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export interfaces using EQL requests Command line for EQL

....................................................................................................................................................................................................................................
Trace initialization exception -
com.alcatel.omc.fwk.utilities.trace.AssertException: Unable to
open trace files java.io.
Result: The Export is successful. message appears.
E...................................................................................................................................................................................................
N D O F S T E P S

Execute EQL for Unix


...................................................................................................................................................................................................

1 Open a terminal window.


Result: The terminal window appears.
...................................................................................................................................................................................................

2 Unzip the archive file in the required directory.


Result: The corresponding files are now unzipped in the required directory.
...................................................................................................................................................................................................

3 Go to the location where eql.sh is located.


Result: The associated file path is defined.
...................................................................................................................................................................................................

4 Execute the EQL; refer to “Examples” (p. 1-26).


You must ignore the following message:
Trace configuration polling period (ms): 300000
20081219104723.562Z Unable to read trace configuration file.
Result: The Export is successful. message appears.

E...................................................................................................................................................................................................
N D O F S T E P S

....................................................................................................................................................................................................................................
1-28 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
2 2 ccess EQL from
A
programing language

Overview
Purpose
This section describes how to access EQL from a programing language.

Contents

Introduction 2-1
Procedure 2-1: Install certificates on Java client 2-2
Procedure 2-2: Start Java client application 2-3
Sample code to retrieve certificate from Web server 2-6
Sample code to retrieve XML result of EQL query 2-13

Introduction
The Java Secure Socket Extension (JSSE) from SUN is an API that authenticates peers
over an untrusted network and protects the integrity and privacy of the transmitted data.
To implement a secure socket connection with Muse HTTPS web services, the Java
application client must meet the following criteria:
• Own and give trusts to the certificates of the web server
• Verify the hostname
• Authenticate with login password
• Open the connection and send the query.

...................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-1
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Procedure 2-1: Install certificates on Java client

....................................................................................................................................................................................................................................

Procedure 2-1: Install certificates on Java client


Note: This task is performed offline. It allows the user to obtain the certificate stored
on a web server.
...................................................................................................................................................................................................

1 Obtain the certificate stored on a web server.


“Sample code to retrieve certificate from Web server” (p. 2-6) provides an example of
how to take the certificate from the server to a file in Java code.
This operation must be done only once. Further calls to the Web server use the
downloaded certificate.
Result: The certificate is downloaded.
...................................................................................................................................................................................................

2 Copy the certificate to the jre/lib/security directory of the NPO Web Server.
Result: The certificate is copied into the jre/lib/security directory.
...................................................................................................................................................................................................

3 Compile this file and run it, giving the correct parameters, host and port of the MUSE
NPO HTTPS access.
The password is the password of the security access of the Java JRE (by default, it is
change it).
The execution produces a file that must be stored in the current jre/lib/security
directory.
Note: This initialization can be done at the first connection, by directly copying the
certificates in the current JRE.
Result: The file is stored in the jre/lib/security directory.
E...................................................................................................................................................................................................
N D O F S T E P S

....................................................................................................................................................................................................................................
2-2 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Procedure 2-2: Start Java client application

....................................................................................................................................................................................................................................

Procedure 2-2: Start Java client application


...................................................................................................................................................................................................

1 Initialize the SSL.


The SSL connection must be initialized using the URL of the EQL request; refer to
Chapter 1, “Export interfaces using EQL requests”.
For example, the following EQL request is used:
https://172.25.240.134:8443/maat/report/?otype=CELL2G
&eids=110/F10/111/1&periodicity=h&firstdate=2006.12.30%2020.30
&secondate=2006.12.31%2003.15&datalist=GAAGCHCTT&format=xml
The following commands are required:
Security.addProvider(new
com.sun.net.ssl.internal.ssl.Provider());
Properties properties = System.getProperties();
System.setProperty("java.protocol.handler.pkgs","javax.net.ssl");
System.setProperties(properties); // put the updated properties
back in System
try {
URL page = new URL(fullURL); // Process the URL far enough to
find tSSLContext sslContext = SSLContext.getInstance("SSLV3");he
right handler
HttpsURLConnection.setDefaultSSLSocketFactory(sslContext.getSocketFacto
Result: The SSL is initialized.
...................................................................................................................................................................................................

2 Manage the certificates.


The certificates trust manager is declared. It automatically uses the information from the
jre/lib/security directory.
TrustManager[] trustManagerArray = getAllTrustingTrustManager();
sslContext.init(null, trustManagerArray, new
java.security.SecureRandom());
The implementation methods are:
public static TrustManager[] getAllTrustingTrustManager(){
return new TrustManager[]{
new X509TrustManager(){
public boolean
checkClientTrusted(java.security.cert.X509Certificate[] chain){

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-3
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Procedure 2-2: Start Java client application

....................................................................................................................................................................................................................................
return true;
}
public boolean
isServerTrusted(java.security.cert.X509Certificate[] chain){
return true;
}
public boolean
isClientTrusted(java.security.cert.X509Certificate[] chain){
return true;
}
public java.security.cert.X509Certificate[]
getAcceptedIssuers() {
return null;
}
public void
checkClientTrusted(java.security.cert.X509Certificate[] chain,
String authType) {}
public void
checkServerTrusted(java.security.cert.X509Certificate[] chain,
String authType) {}
}
Result: The certificates are stored in the required directory.
...................................................................................................................................................................................................

3 Check the hostname


Implement a hostname verifier.
The following example always returns true, but in a real secured connection, the
hostname must be verified.
HostnameVerifier hv = new HostnameVerifier() {
public boolean verify(String urlHostName, SSLSession session) {
System.out.println("Warning: URL Host: "+urlHostName+" vs.
"+session.getPeerHost())
return true;
}
};
HttpsURLConnection.setDefaultHostnameVerifier(hv);

....................................................................................................................................................................................................................................
2-4 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Procedure 2-2: Start Java client application

....................................................................................................................................................................................................................................
Result: The hostname is verified.
...................................................................................................................................................................................................

4 Send the Login/Password.


You must give the login password of the MUSE HTTPS connection to the SSL
connection.
String authString = "osmadmin:alcatel";
String auth = "Basic " + new
sun.misc.BASE64Encoder().encode(authString.getBytes());
connect.setRequestProperty("Authorization", auth);
Result: The SSL connection now has the login password of the MUSE HTTPS
connection.
...................................................................................................................................................................................................

5 Implement the SSL GET command.


The URL can be sent to the MUSE NPO WEB server HTTPS connection.
connect.setRequestMethod("GET");
connect.setRequestProperty("Content-type","text/xml");
connect.setDoOutput(true);
connect.setDoInput(true);
connect.connect();
Result: The URL is sent to the MUSE NPO WEB server HTTPS connection.
...................................................................................................................................................................................................

6 Buffer the XML result.


The XML result is stored in a string buffer.
BufferedReader br = new BufferedReader(new
InputStreamReader(connect.getInputStream()));
String buffer = "";
while (buffer != null) {
try {
System.out.println(buffer);
buffer = br.readLine();
}
catch (IOException ioe) {
ioe.printStackTrace();
break;

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-5
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Procedure 2-2: Start Java client application

....................................................................................................................................................................................................................................
}
Result: The XML result is buffered.
E...................................................................................................................................................................................................
N D O F S T E P S

Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................
2-6 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-7
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
2-8 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-9
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
2-10 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-11
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve certificate from Web server

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
2-12 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................

Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-13
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
2-14 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-15
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
2-16 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 2-17
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Access EQL from programing language Sample code to retrieve XML result of EQL query

....................................................................................................................................................................................................................................

....................................................................................................................................................................................................................................
2-18 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
3 3xport and import of
E
object zone & working
zone definition

Overview
Purpose
This section describes how to export and import object zone & working zone definition.

Contents

Introduction 3-1
Export Object Zones 3-1
Import Object Zones 3-2
Export Working Zones 3-3
Import Working Zones 3-3

Introduction
The ENH aims at defining new operations allowing an administrator to import/export
object zone objects and to import/export working zone objects using either the NPO
Administration Import/Export GUI or new dedicated scripts.

Export Object Zones


The list of object zones is exported into an xml file:
• in the case of the Admin GUI, the export is processed, then the operator can either
save the xml file into a file or open it into an editor.
• in the case of the script, the operator provides the file name where the xml will be
saved.
In both case, an export object zone log file is generated (same format as the log files
already generated when importing other dictionaries).
The export takes the list of object zones into the table TOPD_OZONE.
It also reads the table TOPD_FILTER,TOPD_ZONE_FILTER_MAP to get the object
zone filter definition.
...................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 3-1
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export and import of object zone & working zone definition Export Object Zones

....................................................................................................................................................................................................................................
It reuses the xsd definitions of maatTopoDefinitions/maatTopo to save the object zone
definitions. It reuses the ObjectZoneType type.
The xml content will be the same as the content of the setObjectZoneRequest which
contains the definition of an ObjectZone object to be created.
The only change is to replace the uid of other object zone or working zone reference by
the name of the related object zone or working zone.
As an object zone can be a sub-object zone, the file will be created by first storing the
root object zones definitions, then the sub object zones will be defined.
The "leaf" object zones should be defined at the end of the process.

Import Object Zones


As the xml file is created by defining first the root object zones and then the sub object
zone, they are created in the same order , by reusing the same code as the one used when
processing the setObjectZoneRequest in MaatTopoObject.
Before calling the code, related object zone name and/or related working zone name
should be replaced by their uid, by using the table TOPD_OZONE and/or
TOPD_WZONE.
As the order of creation is important, if the root object zones are created first, then when
creating sub object zone the father object zone will have already been created and so the
uid can be obtained by reading the tables.
There are 2 ways of importing object zones:
• using the NPO Administration, Import/Export GUI: the operator is asked for
providing the xml file which contains the object zone objects. Then it is asked for an
option:
– either replacing all the previous existing object zones: the new imported object
zones will replace the old ones. Old ones are no more existing
– either updating the object zones: new object zones are created. Already existing
object zones, that is to say object zone with the same name, then the definition of
the object zone is replaced by the one provided in the xml file.
• using the import object zone script. As for the GUI, the filename is given. Also, the
script option Replace or Update is proposed
In both case, an import object zone log file is generated (same format as the log files
already generated when importing/exporting other dictionaries).
If an object zone definition is referencing a Working Zone, then there are two cases:
• the working zone exists: the working zone name present in the xml file is replaced by
the working zone id as explained above.
• the working zone doesn't exist: the object zone is not imported and an error message
is generated in the import log file with the name of the non existing working zone. In
that latter case, the operator would have to import first the Working Zone definitions
and then, relaunch the import object zones.
....................................................................................................................................................................................................................................
3-2 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011
Export and import of object zone & working zone definition Import Object Zones

....................................................................................................................................................................................................................................
In case the definition of the object zone filter is referencing an indicator, a parameter, a
free field, a parent object zone or a related working zone which is not existing, then an
error message should be logged in the import working zone log file. The processed object
zone is not created.
Then the other following object zones in the xml file are processed (best effort mode)

Export Working Zones


Procedure is the same as Export Object Zones.
The list of working zones is exported into an xml file:
• in the case of the Admin GUI, the export is processed, then the operator can either
save the xml file into a file or open it into an editor.
• in the case of the script, the operator provides the file name where the xml will be
saved.
In both case, an working zone log file is generated (same format as the log files already
generated when importing other dictionaries).
The export takes the list of object zones into the table TOPD_WZONE. It also reads the
table TOPD_FILTER,TOPD_ZONE_FILTER_MAP to get the working zone filter
definition.
The xml content will be the same as the content of the setWorkingZoneRequest which
contains the definition of an WorkingZone object to be created.The only change is to
replace the uid of other working zones (in case of sub working zone referencing the
parent WZ) by the name of the working zone.
As a working zone can be a sub-object of another working zone, the file will be created
by first storing the root working zone definitions, then the sub working zones will be
defined.
Leaf Working Zone objects are created the last, at the end of the file.

Import Working Zones


Procedure is the same as Import Object Zones.
As the xml file is created by defining first the root working zones and then the sub
working zones, they are created in the same order, by reusing the same code as the one
used when processing the setWorkingZoneRequest in MaatTopoObject.
Before calling the code, related working zone name should be replaced by their uid, by
using the table TOPD_WZONE.
As the order of creation is important, if the root working zones are created first, then
when creating sub working zone the parent working zone will have already been created
and so the uid can be obtained by reading the table TOPD_WZONE.

....................................................................................................................................................................................................................................
Alcatel-Lucent 9959 NPO Alcatel-Lucent – Proprietary 3-3
expintug M4 Use pursuant to applicable agreements
Issue 21 October 2011
Export and import of object zone & working zone definition Import Working Zones

....................................................................................................................................................................................................................................
There are two ways of importing working zones:
• using the NPO Administration, Import/Export GUI: the operator is asked for
providing the xml file which contains the working zone objects. Then it is asked for
an option:
– either replacing all the previous existing working zones: the new imported
working zones will replace the old ones. Old ones are no more existing
– either updating the working zones: new working zones are created. Already
existing working zones, that is to say working zone with the same name, then the
definition of the working zone is replaced by the one provided in the xml file.
• using the import working zone script. As for the GUI, the filename is given. Also, the
script option Replace or Update is proposed
In both case, an import working zone log file is generated (same format as the log files
already generated when importing/exporting other dictionaries).
In case the definition of the working zone filter is referencing an indicator, a parameter, a
free field or a parent working zone which is not already existing, then an error message
should be logged in the import working zone log file. The currently processed working
zone is not created.
Then the other following working zones in the xml file are processed (best effort mode).

....................................................................................................................................................................................................................................
3-4 Alcatel-Lucent – Proprietary Alcatel-Lucent 9959 NPO
Use pursuant to applicable agreements expintug M4
Issue 21 October 2011

You might also like