Professional Documents
Culture Documents
2 / 46
Contents
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Export Interfaces Using EQL Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Execute Data Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3 Execute Report Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4 Global Parameter Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5 Execute Dynamic Excel Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6 Examples of Export Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7 Output Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.1 Executed Data Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.2 Executed Report Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.3 Global Parameter Export Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Access EQL from a Programing Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.2 Install Certificates on Java Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3 Java Client Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.2 Initialize SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.3 Manage Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.4 Check Hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.5 Send Login/Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.6 SSL GET Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3.7 Buffer xml Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 SQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2 Install/Uninstall SQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2.1 Install SQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2.2 Uninstall SQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3 View Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.1 QoS Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.2 Parameter Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.3 Topology Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4 Examples of SQL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5 Access the SQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5.1 Access the SQL Interface Using SQL*Plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5.2 Access the SQL Interface Using iSQL*Plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5.3 Access the SQL Interface Using JDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5.4 Access the SQL Interface Using Microsoft Query . . . . . . . . . . . . . . . . . . . . . . . . . . Appendix A : Sample Code to Retrieve Certificate from a Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 5 7 8 9 11 12 13 15 16 16 19 23 25 26 26 27 27 27 27 28 28 28 28 29 30 30 30 30 31 31 33 35 38 39 39 39 40 41 43
3 / 46
Contents
4 / 46
Preface
Preface
Purpose Whats New
This guide describes how to access EQL from a programing language and export NPO public interfaces using EQL requests.
In Edition 07
Update the section Global Parameter Export Format (Section 1.7.3) by removing xml file format. Update the sections: Execute Data Query (Section 1.2) and Execute Dynamic Excel Page (Section 1.5) by adding the restrcition about the interpolation parameter.
In Edition 06
Update the Global Parameter Export (Section 1.4) by removing xml file format. A notice is added in Introduction (Section 1.1)
In Edition 05
The definition of <VersionNumber> is updated in Install SQL Interface (Section 3.2.1) A note on Oracle 10g JDBC Thin driver is added in Access the SQL Interface Using JDBC (Section 3.5.3) A note on Oracle 10g client for windows is added in Access the SQL Interface Using Microsoft Query (Section 3.5.4) A new chapter is added: Examples of SQL Commands (Section 3.4).
In Edition 04
Specify that <server_name> is the hostname or IP address of the server.
In Edition 03
New section is added: SQL Interface (Section 3).
In Edition 02
5 / 46
Preface
In Edition 01
Examples of Export Interfaces (Section 1.6) is updated. First proposal of document.
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.
6 / 46
7 / 46
1.1 Introduction
NPO offers a public web interface called EQL (Extensible Query Layer), used to retrieve data through external tools such as web-browsers (Mozilla, Internet Explorer) or web-enabled applications (Excel for instance). 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 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 (in Internet Explorer for instance), so for very large requests the POST method is preferred.
Note:
To be able to export interfaces, the exprole profile profile must be added to a user. The output report file used date with GMT as time zone and not the NPO server time zone.
8 / 46
Server hostname or IP address running with Tomcat. TCP Port used by Tomcat Default value: 8443
<type> <extid>
Network object type List of network object external identifiers, under the following format: MCC / MNC / LAC / CI . {h|d|w|m} for Hourly, Daily, Weekly or Monthly. Any past date (not the current day), format: YYYY.MM.DD HH24.MI. Short name of a QoS indicator, or name of a radio telecom parameter prefixed by PARAM_. Interpolation method (DEFAULT, NONE or LINEAR). This is optional and applicable only for QoS indicators.
<period> <date>
<data>
<method>
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 Daily/Weekly/Monthly query because the interpolation is already done during the consolidation phases. The current day data is not available The number of objects is limited to 200 The number of indicators and radio telecom parameters is limited to 50
9 / 46
As the result of a QoS query must not exceed the size of 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 Do not use the same indicator 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
10 / 46
<period> <date>
<output_format> <scheduledate>
The following restrictions apply to EQL interface concerning report execution requests: Only Hourly, Daily, Weekly and Monthly data are available The current day data are not available The number of objects is limited to 200 Warning reports are not supported.
11 / 46
<output_format>
12 / 46
<period> <date>
<method>
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 Examples H-1 H H-24 d D | Dx x is an integer value greater than or equal to 1 D-1 D D-30
13 / 46
Periodicity Valid Date Expression 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 EQL interface concerning dynamic MUSE data query: 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 200 The number of indicators and radio telecom parameters is limited to 50 As the result of a QoS query must not exceed the size of 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 Warning reports are not supported 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.
14 / 46
15 / 46
16 / 46
Item mt
Description Measurement types (QoS indicators or radio telecom parameters identifiers) Measurement results (per object results) Measurement values (per date results) Vectors data Matrixs data X axis for vector and matrix values Y axis for matrix values Holds vector and axis data Holds matrix and axis data Data (QoS indicators or radio telecom parameters actual values) Object external identifier. Each object OID must be reported only once per file
oid
17 / 46
Find below is a generic example of the XML document generated for a data query:
18 / 46
19 / 46
20 / 46
21 / 46
Note:
CSV documents use the character , as separator while the SCSV documents use ; . The values of type vector 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 values of type matrix 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].
22 / 46
23 / 46
24 / 46
25 / 46
2.1 Introduction
JSSE (Java Secure Socket Extension) from SUN is an API that authenticates peers over an untrusted network and protects the integrity and privacy of data transmitted between them. To implement a secure socket connexion 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 connexion and send the query.
Note:
This initialization can be done at the first connexion, directly copying the certificates in the current JRE.
26 / 46
27 / 46
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) {} }
28 / 46
3 SQL Interface
3 SQL Interface
This section describes how to use the SQL Interface to access the MUSE Database.
29 / 46
3 SQL Interface
3.1 Introduction
This feature is only available starting with B10 MR2, M2.3, UA5.
This feature is only available with the purchased Application Specific Full Use (ASFU) Oracle license. The SQL Interface offers access to a limited part of the NPO database. To use this information in a Muse external software, you can export the NPO table data from the server. For this, a special user npo is automatically created, that is allowed to use a little amount of NPO server availability. Due to the potential big CPU load when exporting the whole database content, a load limitation is set in order to prevent performance degradation for other users. The SQL interface users can only use the remaining available CPU, after giving the needed CPU for the other MUSE users. For security reasons, the user has access to a set of SQL views that are referencing inner tables of NPO. A view is a virtual table based on the results of a SELECT statement. A view contains rows and columns, just like a real table. The fields in a view are fields from one or more real tables in the database. This allows restricting the access to a predefined amount of tables and columns of these tables. A view is read-only, so the user of the SQL interface cannot modify the database. The SQL interface views give access to the following information: Metadata information of the NPO topology Topology objects and relations Parameter values of the topology objects QoS values of the topology objects. To be able to run SQL views, the SQL interface must be installed.
30 / 46
3 SQL Interface
All packages, views, and the user created by the SQL interface are deleted.
If the name is longer than 32 bytes, the VQOS_GroupName_SpatialLevel part is truncated to 29 bytes, allowing 2 bytes for the version number. The index view is called VQOS_INDICATORSNAME_<VersionNumber>.
granularityPeriod
VARCHAR2(10)
OEXID Indicator
VARCHAR2(128) NUMBER
The following table presents the VQOS_IndicatorGroup_SpatialLevel (Relation) QoS View: Field Name timeStamp Type Date Description Start time of the period on which the indicator is calculated. Temporary level on which the indicator is calculated. Can be RRAW, HRAW, NORMALIZED, DAY, WEEK or MONTH. External Id of the relation source.
granularityPeriod
VARCHAR2(10)
SourceID
VARCHAR2(128)
31 / 46
3 SQL Interface
The following table presents the VQOS_INDICATORSNAME QoS View: Field Name Longname Reference_extension Type VARCHAR2(200) VARCHAR2(100) Description Long name of the indicator. Reference of the indicator, which serves as column in the table which contains this indicator values. Group of the Indicator. Spatial level on which daily data are available for the indicator. Spatial level on which weekly data are available for the indicator. Spatial level on which monthly data are available for the indicator.
Indicator_group Daily_Availability_Domain
VARCHAR2(30) VARCHAR2(1000)
Weekly_Availability_Domain
VARCHAR2(1000)
Monthly_Availability_Domain
VARCHAR2(1000)
32 / 46
3 SQL Interface
The following table presents the VPARAM_TechnoName_ObjectType Parameter View: Field Name OEXID First Parameter Type VARCHAR2 (128) VARCHAR2 (4000) Description External Id of the object. Value of the first parameter (the name of the field depends of the table). Number and name of the other fields depends of the TechnoName and of the ObjectType.
...
33 / 46
3 SQL Interface
The following table presents the VPARAM_PARAMNAME Parameter View: Field Name PARAM_ID PARAM_NAME TECHNO OBJECT_TYPE Type VARCHAR2 (50) VARCHAR2 (50) VARCHAR2 (4) VARCHAR2(50) Description Id of the Parameter. Name of the Parameter. Name of the Techno. Type of the object the parameters refers.
34 / 46
3 SQL Interface
The following table presents the Relation Types Metadata, Table VTOPO_RELATIONTYPES: Field Name NAME Type VARCHAR2(128 BYTE) VARCHAR2(128 BYTE) VARCHAR2(128 BYTE) NUMBER(1,0) Description System name of the Object type.
STYPE
TTYPE
IS_ADJACENCY
35 / 46
3 SQL Interface
Description Given the NPO topology , this gives the name of the object Type of the cell source of the relation (adjacency). Example: CELL2G <- relationA -> ECELL2 <- relationB -> ECELL2G <- relationA -> CELL2G MAIN_SOURCE_TYPE(relationB)=CELL2G
MAIN_TARGET_TYPE
VARCHAR2(128 BYTE)
Given the NPO topology, this gives the name of the object Type of the cell target of the relation (adjacency).
The following table presents the Topology Objects, Table VTOPO_OBJECT: Field Name objectExternalId objectType FatherExternalId UserLabel Properties Primary Key Type VARCHAR(100) VARCHAR(100) VARCHAR(100) VARCHAR(100) Description Id of the topology object. Object type of the current id. Id of the father of the object. Friendly name of the object.
The following table presents the Topology Relations, Table VTOPO_RELATIONS: Field Name objectExternalId objectType sourceExternalId targetExternalId UserLabel Properties Primary Key Type VARCHAR(100) VARCHAR(100) VARCHAR(100) VARCHAR(100) VARCHAR(100) Description Id of the relation link. Object type of the current relation id. Id of the source of the relation. Id of the target of the relation. Friendly name of the relation.
36 / 46
3 SQL Interface
The following table presents the Qos and Param Table Name per Object Type, Table VTOPO_QOSPARAMTABLESLIST: Field Name qosParamViews objectType Type VARCHAR(100) VARCHAR(100) Description Name of the table in Oracle. Object type related to the table.
37 / 46
3 SQL Interface
To see the QOS value of indicator GTRPDUN from CELL2G QOS view VQOS_GPQOS_CELL2G_1 for the CELL2G with OEXID=001/F01/1/1 on the date 03/01/08: select OEXID,GTRPDUN, timestamp from MUSE.VQOS_GPQOS_CELL2G_1 where OEXID=001/F01/1/1and GRANULARITYPERIOD=DAY and timestamp=03/01/08 00:00:00; 001/F01/1/1 848 03/01/08 00:00:00
To retrieve the operational parameter value , use the VPARAM_PARAMNAME_1 to get the column name from the name of the parameter: select PARAM_ID from MUSE.VPARAM_PARAMNAME_1 where PARAM_NAME=EN_PBGT_FILTERING; PARAM_GSM_201
To retrieve the parameter value from the VPARAM_GSM_CELL2G_1 for the cell 001/F01/1/1: select OEXID,PARAM_GSM_201 from MUSE.VPARAM_GSM_CELL2G_1 where OEXID=001/F01/1/1; 001/F01/1/1 ENABLE
38 / 46
3 SQL Interface
39 / 46
3 SQL Interface
40 / 46
3 SQL Interface
In case of a Developer, depending of the implementation of the database access classes, the query can vary. The connection creation command is of the following type: Connection con = DriverManager.getConnection("jdbc:oracle:thin:@hostname:1521 :SNM", "npo", "npo");
41 / 46
3 SQL Interface
Server: name of the server /SNM (for example: Tealc/SNM). 5. Click on [ OK ]. Queries from Excel can now be executed.
42 / 46
43 / 46
44 / 46
45 / 46
46 / 46