Reporting Suites

and Report customization

CPS

Soc Classification level

1 © Nokia Siemens Networks /
Subject

Introduction
Reporting Suite overview
Report definitions and interface
Counters files
KPI file
Report file
Report Customisation with Report Customizer

Soc Classification level

2 © Nokia Siemens Networks /
A standard Reporting Suite delivery package

The components of a Reporting Suite

• KPI & Report definitions
The actual content of the package which also
has the highest Intellectual property value to
Nokia Siemens Network NetAct Reporting Suite

• Query Engine
A multi-pass engine for efficient extraction of KPI & Report definitions
(XML files)
data based on report definitions
• Adaptation Support
Technology specific (e.g. RAN, BSS …)
configuration of the engine enabling support Query engine
for different object topologies and DB layout
The NetAct components used by a RS
• NetAct Reporting API Adaptation support
In current deliveries this is the Perl based
ODR, but porting to the Java based NetAct Reporting API
WebScripting is ongoing
• Netact Database NetAct Database
The RC or GR Oracle DB storing the PM data

Soc Classification level

3 © Nokia Siemens Networks /
Reporting Suites supporting different NW technologies

The Reporting Suites supports a range of

different NW technologies
Each technology has a package with own 3G RAN NSS MGW
adaptation support and KPI & reports
R AN S W
3G NS MG

3G
3G RAN
RAN NSS
NSS MGW
MGW …

Note
The query engine is the same for all
NW technologies. Only the adaptation
support and content (i.e. KPIs and
reports) are changed.

Soc Classification level

4 © Nokia Siemens Networks /
Customizing Reporting Suites

The RS offers 2 interfaces for customization

The Reporting Interface
• Used for customizing the KPI and report definitions
• Typically done by changing or extending standard NetAct Reporting Suite
reports
• Open for customers to use as well as NSN in KPI & Report definitions
customization projects (XML files)
The Adaptation Interface
Reporting Interface
• Used for customizing the adaptation support for
reporting on new NW technologies (e.g. MVI) or adding Query engine
new object levels to already supported technologies
• Not available for customer use – only for Nokia internal Adaptation Interface
use Adaptation support
• This interface is still under development
Customizations should be done as additions to the standard NetAct Reporting API
KPI and report definitions
Maintenance of customized solutions are of course the NetAct Database
responsibility of customisation team or customer

Soc Classification level

5 © Nokia Siemens Networks /
Engine Design Principles

The core task of the reporting engine is to transform the raw counters into KPIs that enables
efficient analysis of the network performance and capacity utilization
To do this the engine needs definitions of the KPIs and reports. When defining KPIs and
reports there are a number of principles that should be taken into considerations
• Key priorities for the engine and the KPI definition format
– Generic KPI definitions
ƒ Reports are needed on many different object and time aggregation levels
ƒ Open possibilities for advanced UI operations such as drill down and KPI analysis
– Focus on reuse
ƒ KPIs are typically required in different contexts, which typically means that a KPI will appear in multiple
reports
ƒ To ensure correctness and maintainability it is important that a KPI is defined only once.
– Focus on documentation
ƒ The KPI definition and the related documentation should be kept in close proximity to ensure consistency
– Clarify and Transparency
ƒ keep it simple
– Performance

Soc Classification level

6 © Nokia Siemens Networks /
Reporting Interface

The Reporting Interface’ is used to create reports and KPIs

There are two types of reports
• A self-contained report consists of a single xml file that can be executed by the
engine without any further dependencies. This means that both counter
aggregations and KPI formulas are specified in a single file.

• A reference reports on the other side contains references to KPIs that again
contains references to counters. This means that KPIs and counter aggregation
definitions can be used in multiple reports and still having all definitions made
only once. This generally makes report definition a lot easier and simplifies
maintenance as definitions are made only once and then reused as needed.

Soc Classification level

7 © Nokia Siemens Networks /
A Self Contained Report
1. Info
<conf_file> 2. column order
<info>
<header>Really simple rrc report</header> 3. temp table
</info>
4. kpi/formula
<column_order>
<simple_kpi/>
</column_order>

<temp_table meas_level="PLMN/RNC/WBTS/WCEL" name=”servlev" pragma=”oss4ran" master="yes">

<counters>
<counter alias=”rrc_conn_stp_att"> rrc_conn_stp_att)</counter>
</counters>
<table_name>nokrww_ps_servlev_wcel_day</table_name>
<alias_name>servlev</alias_name>
</temp_table>

<kpi name="simple_kpi">
<formula>
servlev.rrc_conn_stp_att
</formula>
<kpi_alias>Simple KPI</kpi_alias>
<kpi_format>float:2</kpi_format>
<kpi_info> ... </kpi_info>
</kpi>
</conf_file>

Soc Classification level

8 © Nokia Siemens Networks /
A Self Contained Report

– Self-contained reports are used in previous RS (perl based), which can be

imported to new RS with some modifications
– Difficult to maintain as we need to update KPI in every files

Soc Classification level

9 © Nokia Siemens Networks /
Reference Reports
KPI Library

Counters KPIs Reports

XML XML XML

… … …

Counters KPIs Reports

RNC_183c.xml RSRAN000.xml
cellres.xml

RNC_232c.xml RSRAN009.xml
service.xml

M1013C0.xml RSRAN046.xml
autosho.xml

Soc Classification level

10 © Nokia Siemens Networks /
 Report: RSRAN004.xml
<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<info>
<header>RSRAN004 - RRC connection setup</header>
Reference Reports
....
</info>
<column_order> .... </column_order>
<master_temp_table_names>cellres</master_temp_table_names>
<kpi_ref ref="rsran/kpis/RNC_326a.xml#RNC_326a" />
<kpi_ref ref="rsran/kpis/RNC_328a.xml#RNC_328a" />
</conf_file>

KPI Library: RNC_328a.xml

<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<temp_table_ref src=“rsran/counters/SERVLEV.xml"/>

<kpi name="RNC_328a">
<formula>servlev.RRC_CONN_STP_FAIL_HC</formula>
</kpi>
</conf_file>

Counter Library: Service.xml

<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<info>...</info>
<column_order>...</column_order>

<temp_table name=“servlev" meas_level="PLMN/BSC/BCF/BTS“ pragma=“oss4ran">

<counters>
...
RED: Reference <counter alias="RRC_CONN_STP_FAIL_HC">SUM(RRC_CONN_STP_FAIL_HC)</counter>
</counters>
GREEN: Referenced Item <table_name>NOKRWW_PS_SERVLEV_{OBJ_AGG}_{TIME_AGG}</table_name>
<alias_name>servlev</alias_name>
</temp_table>
</conf_file>
Soc Classification level
11 © Nokia Siemens Networks /
Physical Overview
All customized content and configuration
should be put in the custom directory. All
directories marked with italics are read-only.
Report Developer Report User
All files outside the custom directory will be Tier 1
overwritten on upgrades

RS RS
/m/ossvar/shared/content3/
├───conf
│ └───doc Scheduler
├───bss Web Web
│ ├───conf Script Script
│ ├───ui_conf Shared
disk
│ ├───counters Tier 2
│ ├───kpis
│ └───reports
├───rsran
│ ├───conf Shared disk
│ ├───ui_conf NetAct
│ ├───counters DB Mail
│ ├───kpis Server
WS Quartz
│ └───reports Cache tables
└───custom
├───conf Tier 3
│ ├───doc
│ ├───nav HTTP JDBC, RS intiated
│ └───ui_conf File Access JDBC, WS intiated
└───ran
SMB Mount File copy, eg
├───conf
SMTP ftp, usb disk etc
├───ui_conf
├───counters
12
├───kpis
Soc Classification level
© Nokia Siemens Networks /
└───reports
Measurement Tables Result of aggregation The Final Report

Measurement A
Date obj obj2 att fail
01-jan 00:00 bts1 trx1 11 1
01-jan 00:00 bts1 trx2 9 2
Date obj att fail
01-jan 12:00 bts1 trx1 9 7
01-jan 12:00 bts1 trx2 5 1
01-jan bts1 34 11
02-jan 00:00 bts1 trx1 11 2 02-jan bts1 31 6
Succ HO
02-jan 00:00 bts1 trx2 3 1 Date obj Rate Succ
02-jan 12:00 bts1 trx1 5 2 01-jan bts1 68% 86%
02-jan 12:00 bts1 trx2 12 1 02-jan bts1 81% 82%
Measurement B
Date obj ho_succ ho_fail
01-jan 00:00 bts1 9 3 Date obj ho_succ ho_fail
01-jan 12:00 bts1 21 2 01-jan bts1 30 5
02-jan 00:00 bts1 11 2 02-jan bts1 14 3
02-jan 12:00 bts1 3 1

Aggregation Step KPI Step

The data in the measurement tables are When the aggregation has finished the results
aggregated to the report level of the reports. are joined together. On the result of this join
The measurements are handled one by one the KPI formulas are applied
In the example all counters are aggregated In the example the formulas are
with sum •Succ Rate = 1 – att/fail
Soc Classification level •HO Succ = ho_succ/(ho_succ+ho_fail)
13 © Nokia Siemens Networks /
Notes on Engine execution

The formulas for both the Aggregation Step and KPI Step is written in Oracle Sql
syntax, which adds a lot of expressive power to the definitions.
• Aggregation definition examples
<counter alias="prxtot_denom_4">sum(prxtot_denom_4)</counter>
<counter alias="ave_prxtot_class_4">decode(nvl(sum(prxtot_denom_4),0),0,-112,
log(10,(sum(prxtot_denom_4*0.001*power(10,(-
112+ave_prxtot_class_4/10)))/sum(prxtot_denom_4))/0.001))</counter>
• KPI defintion example
<formula>
100*((cellres.prxtot_denom_0 + cellres.prxtot_denom_1+
cellres.prxtot_denom_2 + cellres.prxtot_denom_3+
cellres.prxtot_denom_4)/(cellres.period_duration*60*5))
</formula>

The split of aggregation and kpi calculations has many advantages

• The counter aggregations are generally changing very stable and only very
rarely changing between different KPIs. Hence the counter aggregation can be
kept separate from the KPIs and reused in many different context.
• It makes the formulas cleaner and easier to work with.
Soc Classification level
14 © Nokia Siemens Networks /
Outer joins

When the results of the Aggregation Step is being combined one the
measurements has to be selected as driver. In most cases the driver can be
selected freely between the measurements being used.

Succ HO Succ HO
Date obj Rate Succ Date obj att fail Date obj Rate Succ
01-jan bts1 68% 86% 01-jan bts1 34 11 01-jan bts1 68% 86%
02-jan bts1 81% 82% 02-jan bts1 31 6 02-jan bts1 81% 82%
01-jan bts2 84% 89% 01-jan bts2 43 7 01-jan bts2 84% 89%
02-jan bts2 23 8 02-jan bts2 65%
Report result using bottom Report result using top
table as driver table as driver
Date obj ho_succ ho_fail
01-jan bts1 30 5
02-jan bts1 14 3
01-jan bts2 25 3

Soc Classification level

15 © Nokia Siemens Networks /
Result of Aggregation
Outer joins

In order to ensure the correct output, the Query Engine builds SQL that employees
outer joins between the measurement tables.
A “normal” join finds values in two tables that are in relation is equality (=). It only
returns rows that are present in both tables for the compared columns.
A row whose column-value is not found in the other table’s joined columns is not
returned at all.
As it is required to return the fullest possible result set, outer join is used.
In an outer join you define a master table. When the outer join is made all the
columns in the master will be returned even if they do not have a value in the other
table.

Soc Classification level

16 © Nokia Siemens Networks /
Report Creation Workflow

1. Prepare KPI and its formula to implement

2. List all counters/measurement involved in the formulas
3. (optional) add new counters to the counter file if non exists
4. Create kpi file for each of the KPIs
• Create a new KPI, minimum the following has to be filled
– Formula, title, formula, unit, tables, kpi_alias, kpi_format
• Check that null values are possible divide-by-zero cases are dealt with
5. Create report file
• Add the KPI name to the column_order section
6. Upload and run test
7. later add to ui_conf

Soc Classification level

17 © Nokia Siemens Networks /
 Report: RSRAN004.xml
<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<info>
<header>RSRAN004 - RRC connection setup</header>
Reference Reports
....
</info>
<column_order> .... </column_order>
<master_temp_table_names>cellres</master_temp_table_names>
<kpi_ref ref="rsran/kpis/RNC_326a.xml#RNC_326a" />
<kpi_ref ref="rsran/kpis/RNC_328a.xml#RNC_328a" />
</conf_file>

KPI Library: RNC_328a.xml

<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<temp_table_ref src=“rsran/counters/SERVLEV.xml"/>

<kpi name="RNC_328a">
<formula>servlev.RRC_CONN_STP_FAIL_HC</formula>
</kpi>
</conf_file>

Counter Library: Service.xml

<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<info>...</info>
<column_order>...</column_order>

<temp_table name=“servlev" meas_level="PLMN/BSC/BCF/BTS“ pragma=“oss4ran">

<counters>
RED: Reference ...
<counter alias="RRC_CONN_STP_FAIL_HC">SUM(RRC_CONN_STP_FAIL_HC)</counter>
GREEN: Referenced Item </counters>
<table_name>NOKRWW_PS_SERVLEV_{OBJ_AGG}_{TIME_AGG}</table_name>
<alias_name>servlev</alias_name>
</temp_table>
Soc Classification level </conf_file>
18 © Nokia Siemens Networks /
Key Terms
Adaptation support
• is all the data that we have to create to support a particular adaptation, eg E/// RAN or Nokia NSS
Templates
• is a part of an xml document that contains an partial SQL statement with placeholders
• Create adaptation support generally involves creating a set of templates.
Report Level
• The object level of the final report
• The report level is a hierarchy string, eg PLMN/RNC/WBTS/WCEL
Measurement base level
• The object that is being measured
• The object level of the raw data
• The report level is a hierarchy string, eg PLMN/RNC/WBTS/WCEL
• meas_level is a property of the measurement and it never changes
– E.g. service level measurement is done on WCEL level, i.e.. PLMN/RNC/WBTS/WCEL and this will always be the
measurement level no matter if using raw or aggregated data.
Pragma
• Part of the template identity.
• It is put in the temp table element in the reports and tells the engine which template to use.
Both the Measurement base level and the Pragma can be found in the RS online documentation
for the measurements supported.
Filter Level
• A level used for object filtering, eg. RNC, WBTS, MSC etc

Soc Classification level

19 © Nokia Siemens Networks /
Create a new counter
<conf_file>
<temp_table name=“servlev" meas_level="PLMN/RNC/WBTS/WCEL" master="yes" pragma=“oss4ran" >
<counters>
<counter alias="period_duration">SUM(period_duration)</counter>
</counters>
<table_name>nokrww_ps_servlev_{OBJ_AGG}_{TIME_AGG}</table_name>
<alias_name>servlev</alias_name>
</temp_table>
</conf_file>

Counters are grouped together in counter-files. Customer specific counters are

situated at /custom/”adaptation”/counters directory.
• Table or view name or view name pattern is given in the tag
<table_name>.The exact table name to be used for the measurement in
question can be found from the Reporting Suite documentation
• Each counter is created within the <counter> tag and has one attribute:
alias. The alias is the name with which the counter is referenced in the KPI.
• In the tag <alias_name> an alias for the temp table is given. This is used in
the KPI definitions to refer to the temp-table temp table entry. It is also
referred to in the report file if it is used as a master in the outer join of
measurement tables.
Soc Classification level
20 © Nokia Siemens Networks /
Create a new counter
Simple complete counter file
<conf_file>
<info>
<header>Counter as report</header>
<help-text>
<![CDATA[ Counter run as a report.]]>
</help-text>
</info>

<temp_table name=“servlev" meas_level="PLMN/RNC/WBTS/WCEL" master="yes"

pragma=“oss4ran" >
<counters>
<counter alias="period_duration">SUM(period_duration)</counter>
</counters>
<table_name>nokrww_ps_servlev_{OBJ_AGG}_{TIME_AGG}</table_name>
<alias_name>servlev</alias_name>
</temp_table>
</conf_file>

Soc Classification level

21 © Nokia Siemens Networks /
 KPI definitions
An example of a KPI definition
<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<temp_table_ref src="rsran/counters/HSDPAW_ext.xml" />
<kpi name="M5000C13">
<formula>(hsdpaw.CQI_DIST_CL_5_1)</formula>
<kpi_info>
<title>Number of reported CQI values matching to "Reported CQI distribution - class 5"
(numbers of CQI value 5).</title>
<use />
<use_experience />
<known_problems />
<open_questions />
<pm_class />
<formula>sum(CQI_DIST_CL_5_1)</formula>
<unit>[#]</unit>
<tables>NOKRWW_PS_HSDPAW_{OBJ_AGG}_{TIME_AGG}</tables>
</kpi_info>
<kpi_alias><![CDATA[Reported CQI Distribution - Class 5]]></kpi_alias>
<kpi_format>float:0</kpi_format>
<kpi_mark />
<area_level>all</area_level>
</kpi>
</conf_file>

Soc Classification level

22 © Nokia Siemens Networks /
 Create a new KPI

All KPI files are placed under the kpis folder in the /custom/”adaptation”/kpis folder.
e.g. /custom/training/kpis/
A KPI file consists of :
• temp table references
• KPI definitions.
The temp table reference is created with the tag <temp_table_ref>.
That has one attribute: src.
The attribute src is used to identify the referenced table, e.g.
src="custom/sbm/counters/kcc.xml“.
It is possible to add new counter aggregations to the referenced temp table, in a basic
inheritance approach. Name clashes will result in an error.

<conf_file>
<temp_table_ref src=“rsran/counters/servlev.xml" />
…
</conf_file>

Soc Classification level

23 © Nokia Siemens Networks /
Create a new KPI

Every KPI added to a KPI file is created within the KPI tag. The KPI tag has a
attribute name.
The attribute name is the id of a KPI. Nokia defined KPIs uses an official Nokia
naming convention, e.g. ava_45.
Max length of this attribute is 30 characters, it is recommended to use lower case
only, and spaces are not allowed.

<conf_file>
<temp_table_ref src="custom/counters/servlev.xml" />
<kpi name=“rnc_5a“>
…
</kpi>
…
</conf_file>

Soc Classification level

24 © Nokia Siemens Networks /
 Create a new KPI
The <kpi_info> tag is defined within the <kpi> tag.
Inside the <kpi_info> tag all the help information about the KPI is stored.
Four sub tags can be defined inside the <kpi_info>: title, use, formula, unit, and
tables
Title
either the same as kpi_alias or a longer and more descriptive title
If this fields is left empty, then kpi_alias will be used as replacement.
Use
Description or explanation. This is the main field for documenting the KPI

…
<kpi_info>
<title>RRC setup success rate</title>
<use>Ratio of RRC setup complete to attempt</use>
…
</kpi_info>
…

Soc Classification level

25 © Nokia Siemens Networks /
Create a new KPI

The KPI formula must be defined within the <formula> tag.

This is the actual formula that will be used in the SQL query. Any functions of Oracle
SQL can be used. A KPI can refer to counters defined in a temp_table or included
temp_table_ref elements in the file containing the KPI.
Only if the counters used are very specific for this particular KPI a new temp table
creation should be made within the KPI file. Otherwise references to a temp_table in
the counter library should be used.

<conf_file>
<temp_table_ref src="custom/sbm/counters/kcc.xml" />
<kpi name=“rnc_154c" impl_stage="functional">
<formula>nvl(decode(
( kcc.RRC_CONN_STP_ATT ),0, null,
100*( kcc.RRC_CONN_ACC_COMP )
/
( kcc.RRC_CONN_STP_ATT )),null)</formula>
…
</kpi>
…
</conf_file>
Soc Classification level
26 © Nokia Siemens Networks /
Create a new KPI

The kpi_alias is a short descriptive name of the KPI. The kpi_alias is the
descriptive header used in the report output.
It should be kept under 40 characters. Spaces between words are encouraged as it
improves the visual appearance of the final report.

<conf_file>
<temp_table_ref src="custom/sbm/counters/kcc.xml" />
<kpi name=“rnc_154c" impl_stage="functional">
<formula>nvl(decode(
( kcc.RRC_CONN_STP_ATT ),0, null,
100*( kcc.RRC_CONN_ACC_COMP )
/
( kcc.RRC_CONN_STP_ATT )),null)</formula>
<kpi_alias>RRC Setup Success Rate</kpi_alias>
</kpi>
…
</conf_file>

Soc Classification level

27 © Nokia Siemens Networks /
Create a new KPI

The <kpi_format> tag must follow the webscript conventions, e.g. float:2 and
float:0.

<conf_file>
<temp_table_ref src="custom/sbm/counters/kcc.xml" />
<kpi name=“rnc_154c" impl_stage="functional">
<formula>nvl(decode(
( kcc.RRC_CONN_STP_ATT ),0, null,
100*( kcc.RRC_CONN_ACC_COMP )
/
( kcc.RRC_CONN_STP_ATT )),null)</formula>
<kpi_format>float:2</kpi_format>
…
</kpi>
…
</conf_file>

Soc Classification level

28 © Nokia Siemens Networks /
Create a new KPI
With the <kpi_mark> defined within the <kpi> tag we can color the background red,
green, yellow or orange in the MS Excel export of the table output. It is a markup
according to Webscript Framework.
<kpi name=“rnc_154c" impl_stage="functional">
…
<kpi_mark>
<![CDATA[
<markup>
<type color="red">
<term test="lt" value="80" />
</type>
<type color="yellow">
<and>
<term test="ge" value="80" />
<term test="le" value="95" />
</and>
</type>
</markup>
]]>
</kpi_mark>
…
</kpi>

The example above marks all cells within a KPI column red that has a value less than
80. It also colors the cells yellow that has values that are equal or greater than 80 but
less than or equal to 95.
Soc Classification level
29 © Nokia Siemens Networks /
Create a new KPI

Because it is a markup according to Webscript Framework the CDATA tag must be

used to encapsulate the <markup> tag.
The <type> tag attribute color defines what color to use.
The tag <term> has a attribute test which defines the condition for the markup. It
also has the attribute value that defines the value the condition is checked against.
There are six different conditions that can be checked:
• Less “lt”
• Greater “gt”
• Not equal “ne”
• Equal “eq”
• Less or equal “le”
• Greater or equal “ge”
There is a possibility to combine different conditions. This is done with the <and>
tag. Inside the <and> tag multiple <term> tags can be defined.

Soc Classification level

30 © Nokia Siemens Networks /
Create a new KPI

<kpi_info> cont.
The <formula> tag is defined within the <kpi_info> tag and is used for
documentation in web pages. It is free format and does not have to adhere to
the SQL syntax. For formatted output is allowed to use html formatting option,
but the text and tags should be enclosed in a CDATA section. If you want to
preserve the indentation it is possible to use the <pre> ... </pre>. If you use
encapsulation by <pre> ... </pre>you have to remember that all spaces counts,
so it is a good idea avoid heading spaces added by indentation in the xml file.

…
<kpi_info>
<title>RRC setup success rate</title>
<use>Ratio of RRC setup complete to attempt</use>
<formula><![CDATA[<pre>
sum(RRC_CONN_STP_ATT) / sum(RRC_CONN_ACC_COMP)
</pre>]]></formula>
…
</kpi_info>
…

Soc Classification level

31 © Nokia Siemens Networks /
Create a new KPI
<kpi_info> cont.
The unit of the KPI defined in the <unit> tag should be in brackets, e.g. [%],
[nbr], [dBm], [sec].
The <tables> tag defines the measurements used by this KPI.

…
<kpi_info>
<title>RRC setup success rate</title>
<use>Ratio of RRC setup complete to attempt</use>
<formula><![CDATA[<pre>
sum(RRC_CONN_STP_ATT) / sum(RRC_CONN_ACC_COMP)
</pre>]]></formula>
<unit>%</unit>
<tables>nokrww_ps_kcc_mnc1_raw</tables>
</kpi_info>
…

Soc Classification level

32 © Nokia Siemens Networks /
Create new KPI

The Unit column is used to specify the unit of the kpi. The current supported list of
units: Whole number = Integer number, nb., number, no., no,[#],#
Percent =%
Decimal = Decimal number, None
Erlang = erlangs, erlang, E, Erl
Minutes = minutes
Kbit per sec = kbps, kbit/s
Mbit = Mbit
dB = dB
seconds = seconds, s, sec
min = min
hrs = h
kB = kB, kbyte, kbytes
MB = MB, Mbyte
GB = GB
TB = TB
Soc Classification level
33 © Nokia Siemens Networks /
Create a new report
A complete report that uses one KPI reference

<conf_file>
<info>
<header>Example report</header>
<help-text>
<![CDATA[ This report is a example report.]]>
</help-text>
<report-description>Example report</report-description>
</info>
<kpi_ref ref="custom/kpis/c090_qos.xml#NBR_OF_TBF_ALLOCATIONS"/>
<column_order>
<NBR_OF_TBF_ALLOCATIONS GROUP=”Test”/>
</column_order>
<master_temp_table_names>
qos
</master_temp_table_names>
</conf_file>

Soc Classification level

34 © Nokia Siemens Networks /
Create a new report
New report files are put in the ”report” subdirectory of the adaptation.
e.g.. custom/training/reports
Every report xml-file has a root tag called <conf_file>.
The <header> tag defines the title of the report. This will be displayed in the
user interface. Recommendation is that it should be kept below 40 characters.

<conf_file>
<info>
<header>Example report</header>
…
</info>
…
</conf_file>

Soc Classification level

35 © Nokia Siemens Networks /
Create a new report
The <help-text> tag is optional. The information given
within this tag is a longer descriptive text about the report. Information entered
here will be displayed in the online help. CDATA is used to get HTML formatting
of the output.
The <report-description> tag is also optional and it is a shorter descriptive text
that also can be given to the report. The report description will be displayed at
the top of the report output table when a report has been executed. It is
therefore recommended that this text is kept short and informative.

<conf_file>
<info>
<header>Example report</header>
<help-text><![CDATA[ This report is a simple example report.]]></help-text>
<report-description>This a example report.</report-description>
…
</info>
…
</conf_file>

Soc Classification level

36 © Nokia Siemens Networks /
Create a new report

The next step is to make a reference entry in the report XML to existing KPI’s in
the KPI library. The existing KPI libraries is divided into different adaptations. The
library is found under the folder custom/”adaptation”/kpis, e.g.
”custom/training/kpis/”
Existing KPI’s are referenced with the <kpi_ref> tag.

…
<kpi_ref ref="custom/training/kpis/sbm_kcc.xml#RNC_154c"/>
…

The KPI library file used in this example is …/sbm_kcc.xml. Multiple KPI’s
may be defined within a file. The hashmark symbol (#) identifies the KPI to
use.
Good behavior is to only keep one KPI definition per KPI file and the filename
the same as the KPI id.

Soc Classification level

37 © Nokia Siemens Networks /
Create a new report

The <column order> tag specifies the order in which the KPIs will be displayed on
the web page. For each KPI-reference in the report, an element with the name
(@name) of the KPI is used as element name.
KPIs can be grouped under different headers in the result output. If the user wants
to use grouping it should be defined here. If several KPIs are part of the same
group attribute the group must be defined for each KPI that belongs to the group.

…
<column_order>
<RNC_154c />
</column_order>
…

Soc Classification level

38 © Nokia Siemens Networks /
Create a new report

By looking within the <formula> tag in a KPI definition one can see that the
temp-table(s) aliases that is used for the counters included. For this example
the KPI uses a counter RRC_CONN_STP_ATT that is defined in temp table
with the alias ”kcc”. The alias “kcc” was defined as a master in the
<master_temp_table_names> tag.

...
<kpi name=" rnc_154c ">
<formula>nvl(decode(
( kcc.RRC_CONN_STP_ATT ),0, null,
100*( kcc.RRC_CONN_ACC_COMP )
/
( kcc.RRC_CONN_STP_ATT )),null)</formula>
...
</kpi>
...

Soc Classification level

39 © Nokia Siemens Networks /
Create a new report
The example of a complete report that uses one KPI reference again.
<?xml version="1.0" encoding="UTF-8"?>
<conf_file>
<info>
<report_version>RSRAN RAS05. 1 ED 4.2.2</report_version>
<release number="5.6" />
<min_obj_agg />
<nw_tp />
<maxrows />
<header>RSRAN031 - Traffic on AAL5</header>
<csv_title>Traffic on AAL5</csv_title>
<obj_number />
<wrap_header />
<nokia_counter_id_help_file />
<nokia_counter_db_help_file />
<nokia_kpi_help_file />
<external_kpi_help_file />
<help_text><![CDATA[<br>]]></help_text>
<report-description>Traffic on AAL5</report-description>
<report-title>Traffic on AAL5</report-title>
</info>
<useFullOuterJoin>true</useFullOuterJoin>
<column_order>
<!-- -->
<!-- ====================================== List of kpi names ====================================== -->
<!-- -->
<RNC_307a />
</column_order>
<kpi_ref ref="rsran/kpis/RNC_307a.xml#RNC_307a" />
</conf_file>

Soc Classification level

40 © Nokia Siemens Networks /
Content Browser and Report Customizer

Content Browser and Report Customizer

ƒ use predefined KPI and counters from default table
ƒ application based

Soc Classification level

41 © Nokia Siemens Networks /
Content Browser
Search/view KPI and Create Report

Soc Classification level

42 © Nokia Siemens Networks /
Detail

Soc Classification level

43 © Nokia Siemens Networks /
Report Customizer functions

Modify Report output

test report Download file to local PC

To directory: custom/customizedReports
Soc Classification level
44 © Nokia Siemens Networks /
Run test report

Soc Classification level

45 © Nokia Siemens Networks /
Report Result

Soc Classification level

46 © Nokia Siemens Networks /
Installation customized report into NetAct

Application Configuration Files

This section explains how to locate, update and change the application
configuration files. All configuration data of Reporting Suites are located in the RW
share, which is physically located in tier 3 and then mapped to tier 2 with Samba.
This means that the path to the configuration directory depends on which system it
is being accessed from.
When accessed from tier 3 the location is
/var/opt/nokiaoss/shared/content3
• Note that this directory is located on a shared volume and hence it can also be
accessed at /m/ossvar/shared/content3
When accessed from tier 2 the location is
/mnt/sharedrw/content3
When working with files in Reporting Suites all paths are given relative to the
content3 directory and hence independent of which system is being used.

Soc Classification level

47 © Nokia Siemens Networks /
Installation customized report into NetAct

The Reporting Suites have two main configuration files to set the
application configuration parameters and to reference external
resources. These files are
conf/engine.properties
custom/conf/custom.properties
The absolute location seen from tier 2 is
/mnt/sharedrw/content3/conf/engine.properties
/mnt/sharedrw/content3/custom/conf/custom.properties
Only files in the custom/ directory may be edited, so to edit properties
it is important to edit custom.properties. The file engine.properties will
be overwritten during later upgrades and any changes will be lost.
custom.properties takes precedence over engine.properties so if any
properties are defined in both files the setting from custom.properties
will be used.
Soc Classification level
48 © Nokia Siemens Networks /
Installation customized report into NetAct

Properties Files Update and Activating Configuration Changes

To enhance performance the configuration data is generally cached in memory.
The validity of the configuration data in memory is checked in two cases
When a new session is created in the web UI
When the user switches to a new ui_conf file
• This typically happens when the user select a new Reporting Suite entry in the
menu.
The cached data is deemed valid if the time stamp of the files engine.properties
and custom.properties are unchanged. If there are any change to the time stamps
all configuration data will be reloaded.
To make sure that the cached configuration data is used the time stamp of
custom.properties should be updated. So if you are updating a template file on tier
3 then the procedure is
Copy the file template to the correct location on tier 3 (and thus overwriting the
existing file)
Run the command touch custom.properties in the custom/conf directory
The templates will then be loaded next time anyone opens the UI.

Soc Classification level

49 © Nokia Siemens Networks /
 Locating Navigation and ui_conf file
Conf/engine.properties: indicate location of custom.properties

# naming of custom.properties
#com.nokia.oss.qengine.customProps=custom/conf/prop/custom.properties
custom\conf
com.nokia.oss.qengine.customProps=custom/conf/custom.properties
linas.com.nokia.oss.qengine.customProps=/mnt/sharedrw/content3/custom/conf/custom.properties
laptop.com.nokia.oss.qengine.customProps=custom/conf/custom.properties

Custom/conf/custom.properties : indicate navigation tree file

# custom.properties
# NavTree location is
com.nokia.oss.qengine.customNavLocation=custom/nav/custom_nav.xml

Soc Classification level

50 © Nokia Siemens Networks /
Navigation and UI Files

•*conf/engine.properties: Indicate customizable directory

“not changed by any user”
• Customizable files/directory under custom
“Configured as needed”
– custom/conf/custom.properties
– custom/nav/custom_nav.xml
– custom/training/ui_conf/training_ui_conf.xml

under custom directory can be customised as needed – recommend to follow

structure as in standard package e.g.
-custom
|-- -ran
|--kpis
|--reports
|--ui_conf

Soc Classification level

51 © Nokia Siemens Networks /
navigation file
custom/nav/custom_nav.xml
- Add customised navigation tree to RS
- indicate ui_conf file

<node>
<navTreeEntry>
<id>Custom Reports</id>
<label>Custom Reports</label>
<type>folder</type>
</navTreeEntry>
<node>
<navTreeEntry>
<id>Test Report</id>
<label>Test Report</label>
<url>/repsuite/jflx.web?uiConf=custom/Test/ui_conf/newConf.xml&amp;reportValidation=true</url>
<helpUrl>/repsuite/doc/reportTutorial.web</helpUrl>
</navTreeEntry>
</node>
</node>

xxx_ui_conf.xml indicates which reports in the drop down selection

Soc Classification level

52 © Nokia Siemens Networks /
ui_conf file

custom/Test/ui_conf/newConf.xml
- indicates which reports in the drop down selection

<?xml version="1.0" encoding="UTF-8"?>

<ui-conf>
<dbpool name="pmwPool">pmwPool</dbpool>
<report>custom/Test/reports/report.xml</report>
</ui-conf>
Soc Classification level
53 © Nokia Siemens Networks /