Nokia Siemens Networks

NetAct Reporting Suite

KPI and Report Editor Guide

2Reporting Suite KPI and Report Editor Guide

Id:0900d805807785ba

The information in this document is subject to change without notice and describes only the product defined in the introduction of this documentation. This documentation is intended for the use of Nokia Siemens Networks customers only for the purposes of the agreement under which the document is submitted, and no part of it may be used, reproduced, modified or transmitted in any form or means without the prior written permission of Nokia Siemens Networks. The documentation has been prepared to be used by professional and properly trained personnel, and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomes customer comments as part of the process of continuous development and improvement of the documentation.

The information or statements given in this documentation concerning the suitability, capacity, or performance of the mentioned hardware or software products are given "as is" and all liability arising in connection with such hardware or software products shall be defined conclusively and finally in a separate agreement between Nokia Siemens Networks and the customer. However, Nokia Siemens Networks has made all reasonable efforts to ensure that the instructions contained in the document are adequate and free of material errors and omissions. Nokia Siemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues which may not be covered by the document.

Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NO EVENT WILL Nokia Siemens Networks BE LIABLE FOR ERRORS IN THIS DOCUMENTA-TION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDI-RECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA,THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT.

This documentation and the product it describes are considered protected by copyrights and other intellectual property rights according to the applicable laws.

The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademark of Nokia Corporation. Siemens is a registered trademark of Siemens AG.

Other product names mentioned in this document may be trademarks of their respective owners, and they are mentioned for identification purposes only.

Copyright Nokia Siemens Networks 2011/4/15. All rights reserved

f Important Notice on Product Safety Elevated voltages are inevitably present at specific points in this electrical equipment. Some of the parts may also have elevated operating temperatures.

Non-observance of these conditions and the safety instructions can result in personal injury or in property damage.

Therefore, only trained and qualified personnel may install and maintain the system.

The system complies with the standard EN 60950 / IEC 60950. All equipment connected has to comply with the applicable safety standards.

The same text in German:

Wichtiger Hinweis zur Produktsicherheit

In elektrischen Anlagen stehen zwangslufig bestimmte Teile der Gerte unter Span-nung. Einige Teile knnen auch eine hohe Betriebstemperatur aufweisen.

Eine Nichtbeachtung dieser Situation und der Warnungshinweise kann zu Krperverlet-zungen und Sachschden fhren.

Deshalb wird vorausgesetzt, dass nur geschultes und qualifiziertes Personal die Anlagen installiert und wartet.

Das System entspricht den Anforderungen der EN 60950 / IEC 60950. Angeschlossene Gerte mssen die zutreffenden Sicherheitsbestimmungen erfllen.

3

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785ba

Table of ContentsThis document has 19 pages.

1 About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82.1 Content Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

3 Report Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.1 Report Editor GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.1.1 Report Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.1.2 Performance Indicators List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.1.2.1 Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123.1.2.2 Graph Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123.1.2.3 Y-Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123.1.2.4 Markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133.1.3 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133.1.4 Return To Content Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4 KPI Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154.1 KPI Editor GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154.1.1 KPI Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164.1.2 Revision Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174.1.3 Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174.1.4 KPI Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174.1.5 Supporting Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4Reporting Suite KPI and Report Editor Guide

Id:0900d805807785ba

List of FiguresFigure 1 Content Browser Areas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Figure 2 Content Browser with a set of KPIs selected in Your Report . . . . . . . . . 11Figure 3 Performance Indicators List example . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Figure 4 Grouping editor window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Figure 5 Result with markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Figure 6 Markup edition window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Figure 7 Report Editor Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Figure 8 Return to Content Browser options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Figure 9 KPI Editor GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Figure 10 KPI Information area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Figure 11 Revision Information area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Figure 12 Technology selection area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Figure 13 KPI Formula area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Figure 14 Multiple measurement tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Figure 15 Supporting Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

5

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785ba

List of TablesTable 1 Options description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Table 2 KPI Editor areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

6Reporting Suite KPI and Report Editor Guide

Id:0900d805807785ba

7

Reporting Suite KPI and Report Editor Guide About this document

Id:0900d805807785b1

1 About this documentIn this document you can find information regarding the KPI Editor and Report Editor.

8Reporting Suite KPI and Report Editor Guide

Id:0900d805807785b3

Introduction

2 IntroductionKPI Editor and Report Editor are powerful tools that you can use to customize or create new reports and Key Performance Indicators.

Report Editor is used to create or customize reports in a faster and easier way through the Reporting Suite graphical user interface. With Report Editor you can add or remove KPIs and counters, from the reports.

In a similar way the KPI Editor provides you a graphical user interface for custom KPI creation, based on technologies supported by Reporting Suite, and standard arithmetic functions.

You can use the Content Browser tool to search for pre-defined or customized reports, KPIs and counters. Customized reports are stored in a specific folder, meaning that they are not changed if you upgrade the RS.

g Customize reports are easily identified by the letter c that is added to the report. See Figure 1 Content Browser Areas

2.1 Content BrowserContent Browser allows you to search for Reports, KPIs and Counters.

The content browsers main window is divided in three sections: Search Parameters Search Result Collection Area

Figure 1 Content Browser Areas

Search ParametersTo start the search you must select the search type. Each of the four available options lets you search in its content library. Reports KPIs Counters KPI CreationYou can also use the * wildcard at the beginning of the search string, allowing you to match any character at the beginning of the string.

9

Reporting Suite KPI and Report Editor Guide Introduction

Id:0900d805807785b3

To narrow your search you can specify the technology and also a set of options that identify the search. These options are related with the kind of search that your are per-forming, see the list below.

Search ResultsThe search results are shown at the bottom of the page. By default they are limited to fifty results per page, nevertheless this value can be changed to best suite your needs.

The result list options are related with the kind of search that you perform. There are common options to all kind of searches, for instance the Details and Add/Remove options. You are able to Edit the Reports and KPIs, and also Run the Reports.

Available Options

Reports Title KPI Counter Measurement Description

KPIs Provider Id Counter Measurement Formula Description

Counters Id Title Counter Counter Text Measurement Description

KPI Creation Id Description Table Title Counter Counter Text

Option Description

Details Redirects to the documentation page where you can find detailed information regarding the report, KPI or counter.

Add/Remove Add or Remove a report, counter or KPI to the Report List or Content Basket.

Table 1 Options description

10

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785b3

Introduction

Collection AreaThe collection area is located on the right hand side of the content browser window. It comprises the following lists that are related with the search type. Your Report List

Available for Report searches.Your Report List allows you to create a custom list of reports that you can run, and easily compare the results.

Your ReportAvailable for KPIs and Counters related searches.Your Report collects a list of KPIs and counters that you can add to create a report. By clicking in the Create Report button you are redirected to the Report Editor tool where you can find all the counters and KPIs that you previously added to the Your Report collection.

Your Counter BasketAvailable for KPI Creation.Your Counter Basket is used to add counters to a collection that can be used in the KPI Editor tool.

Edit Redirects you to the Report Editor or KPI Editor, depending on the search your are performing.

Run Runs the selected report.

Option Description

Table 1 Options description (Cont.)

11

Reporting Suite KPI and Report Editor Guide Report Editor

Id:0900d805807785b4

3 Report EditorWith the report editor tool aided by the content browser, you can easily create custom reports. By searching the desired KPIs and Counters, that can be added to the Your Report collection thus facilitating the custom report creation.

Figure 2 Content Browser with a set of KPIs selected in Your Report

3.1 Report Editor GUIThe Report Editor GUI is composed by four different areas. The Report Information area where you can edit the basic report information such as the report title, description and file name.

The Performance Indicators list, with different option for each element.

In the bottom of the page you can find the Options area and also a set of buttons that you can use to return to the Content Browser.

3.1.1 Report InformationIn the report information area you have to fill in the desired title for the report, and the file name for the report XML file.

An optional field (Description) is also available, if you want to add a more detailed description for the report.

3.1.2 Performance Indicators ListIn this list you can find the counters and KPIs that you previously added to you report. You have a set of different options that you can use to customize your report and the way the results are shown. Additional information regarding the counters and KPIs is also available upon clicking on the performance indicators Id or Title. See Figure 3 Performance Indicators List example.

You can easily remove a performance indicator by selecting the Remove column check box and clicking the Remove Checked PIs in the Options area.

12

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785b4

Report Editor

Figure 3 Performance Indicators List example

3.1.2.1 GroupingThe grouping feature allows you to combine several KPIs for analysis. By clicking in the Change button on the Grouping column the Grouping Editor window is displayed (see Figure 4 Grouping editor window).

In the Grouping Editor window you can select a new group for the performance indicator, from the Existing groups list, or create a new grouping using the Add New Grouping field. You can also change the group or remove performance indicator from a group.

Figure 4 Grouping editor window

3.1.2.2 Graph TypeThe Graph Type option lets you choose the graph type, by default it is chosen the Line-And-Shape-Chart. You have the following options: Line-And-Shape-Chart Shape-Chart Stacked-Bar-Chart Bar-Chart Area-ChartYou can also change the graph type for all the performance indicators in a group.

3.1.2.3 Y-AxisThis option allows you to set the performance indicator to be rendered on the first or sec-ondary Y-Axis.

13

Reporting Suite KPI and Report Editor Guide Report Editor

Id:0900d805807785b4

3.1.2.4 MarkupThe markup option lets you choose a color to fill the table cell if the defined condition is valid. In the image below you can see two different markups created.

Figure 5 Result with markup

To edit or add a markup open the Markup edition window by clicking in the Add Markup option.

See Figure 6 Markup edition window.

Figure 6 Markup edition window

3.1.3 OptionsThe options provides a set of useful features to ease the report edition. In the top row you have a collection of options that allow you to remove most of the changes that you could perform in the performance indicators list, such as: Remove Checked PIs Clear Groups Clear Graph Types Clear MarkupsIn the bottom row you have the options that allow you to work with the report: Save & Run Save Download Set UI Defaults

14

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785b4

Report Editor

Figure 7 Report Editor Options

3.1.4 Return To Content BrowserIn this area you can return to the content browser, by clicking in one of the available options you are redirected to the specific content browser search.

You have the following options available: Search Reports Search KPIs Search Counters

Figure 8 Return to Content Browser options

15

Reporting Suite KPI and Report Editor Guide KPI Editor

Id:0900d805807785b2

4 KPI EditorThe KPI Editor provides you a graphical user interface for custom KPI creation. With this tool you can easily create custom KPIs, based on technologies supported by Reporting Suite. All the supported technologies counters are available to be used in KPIs creation.

4.1 KPI Editor GUIThe KPI Editor GUI is divided into five distinguished areas, with mandatory and optional fields. KPI Information Revision Information Technology KPI Formula Supporting Buttons

Area Description

KPI Information All the mandatory information used to identify the KPI (KPI Id and Title) is inserted in this area. Additional KPI information (optional) is also displayed in this area. This additional information is useful to describe in more detail the KPI usage, and the KPI formula.

Revision Information In this area you have two fields (Author and Comment) used to store information about the KPI creation.

Technology Select the technologies applicable to the new KPI formula. The KPI Formula Counter Source is updated accordingly.

KPI Formula All the selected technology counters are listed, and a set of mathematical operations are available to create a new formula in the Formula area.

Supporting Buttons The supporting buttons allow you to easily create, test, search or add more counters to basket.

Table 2 KPI Editor areas

16

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785b2

KPI Editor

Figure 9 KPI Editor GUI

4.1.1 KPI InformationThe relevant information regarding the new KPI identification must be filled in the man-datory Id and Title fields. The KPI Id must be an unique identification. The title is useful to identify the KPI column header.

There are also two optional fields: Use KPI Info FormulaThey are used to add more detail to the KPI information. A descriptive text on the KPI usage and formula, is useful for future changes in the KPI.

17

Reporting Suite KPI and Report Editor Guide KPI Editor

Id:0900d805807785b2

Figure 10 KPI Information area

4.1.2 Revision InformationTwo optional fields (Author and Comment) are available in the revision information area. They are used to store information regarding the KPI author and comments when creating or changing the KPI formula or counter.

The Comment field can be used to track changes in the KPI, allowing different users to understand the changes made to the KPI. The comments can be tracked in the Revision History drop down menu. See image below.

Figure 11 Revision Information area

4.1.3 TechnologyThe Reporting Suite supported technologies are listed, and they can be used to create new KPIs.

After the technology is selected the Counter Source is updated accordingly, allowing you to easily find the desired counter.

Figure 12 Technology selection area

4.1.4 KPI FormulaIn this area you are able to create a custom KPI based on the selected technology. The formula field is fully editable, you can copy and paste your own formula into the field.

18

Reporting Suite KPI and Report Editor Guide

Id:0900d805807785b2

KPI Editor

Or simply add counters from the Counters list and complete the formula with an arith-metic function.

In the Counters Source field you can select the source for your counters, from the Counter Basket, All Counters in Technology, or one of the available adaptation mea-surement.

When creating the formula you are able to switch the Counters Sources, thus creating a cross adaptation KPI.

You can use standard arithmetic functions such as: Addition Subtraction Multiplication DivisionTo create more complex formulas it is also available a set of parentheses.

In the Unit field you can select an unit to the custom KPI result.

g Make sure that the formula is mathematically correct, since there is no automated way to check the formula.

Figure 13 KPI Formula area

When creating a KPI you can use counters associated to multiple measurement tables, if this happens a warning message is displayed. The warning message allows you to choose the desired measurement table. You can also click the More Info: link to get more information on the counter.

In the image below you can see an example of two counters associated to different mea-surement tables.

g To be able to complete the KPI creation you must choose the measurement table in the warning message, and click the Recreate KPI button.

19

Reporting Suite KPI and Report Editor Guide KPI Editor

Id:0900d805807785b2

Figure 14 Multiple measurement tables

4.1.5 Supporting ButtonsIn this area you can find the supporting buttons: New KPI

Reset all the fields in the KPI Editor Search KPIs.

Open the KPIs tab in the Content Browser. Add More Counters To Basket

Open the KPI Creation tab in the Content Browser. Test KPI

Test your KPI with real data.

g This button is only available after the KPI is successfully created.

Figure 15 Supporting Buttons

The Counter Basket is a personal counter collection that you can use to easily create KPIs. You can search a specific Performance Indicator in the Content Browser and add it to the counter basket. The advantage of using the content browser to search for PIs relies on the Details button available in the result page. The Details button gives you useful information regarding the PI, that is not available in KPI Editor.

Table of ContentsList of FiguresList of Tables1About this document2Introduction2.1Content Browser

3Report Editor3.1Report Editor GUI3.1.1Report Information3.1.2Performance Indicators List3.1.2.1Grouping3.1.2.2Graph Type3.1.2.3Y-Axis3.1.2.4Markup

3.1.3Options3.1.4Return To Content Browser

4KPI Editor4.1KPI Editor GUI4.1.1KPI Information4.1.2Revision Information4.1.3Technology4.1.4KPI Formula4.1.5Supporting Buttons