Professional Documents
Culture Documents
XML
XML
</conf_file>
Soc Classification level
/ 24 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
/ 25 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>
</kpi>
</conf_file>
Soc Classification level
/ 27 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
/ 28 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
/ 29 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
/ 30 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
/ 31 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>
<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>
</info>
</conf_file>
Soc Classification level
/ 36 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
/ 37 Nokia Siemens Networks
Create a new report
The next step is to make a reference entry in the report XML to existing KPIs 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 KPIs are referenced with the <kpi_ref> tag.
The KPI library file used in this example is /sbm_kcc.xml. Multiple KPIs
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
/ 38 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>