Simplified UI - Help
As the ICI will be fully available with SP12 and not every Solution Manager can be upgraded right now we developed an extension for ICI which is easy to install and configure.
Here in short the differences and advantages of both versions.
standard ICI dashboard
|SP level needed||SP12||No known restrictions, tested with SP05|
|Automation||fully automated||automation possible if the full iCI is available (SP12)|
|Customizing||limited||Delivered as a Z-Package therefore easy to adapt|
|Delivery||standard in SP12||On special request as a customer coding package, no warranty|
Below you can get a brief overview about the basic page layout and how to navigate throught the simplified UI application (SUI),
leaving out functional details at this point. How to create, edit and delete Scorecards, Groups and KPIs can be found here
'Simplified UI - Usage' instead
The SUI consists of three visually seperated areas.
Here you can find tool-icons to accomplish almost every tasks.
It can be opened and closed by the "Open/Close Scorecard list" button. The side bar contains a treetable storing all the
available Scorecards. Scorecards will reveal their Versions as child nodes by clicking on the [+] icon. To collapse a Scorecard
press the [-] icon. At the upper left corner a "Refresh" button enables you to refresh the Scorecards rather than refreshing the
whole browser page instead. A selected Scorecard or Version is shown in the data area in detail.
The Scorecard which is selected in the side bar appears in this view. Below the title a list of the Scorecard's
Versions is displayed. Selecting one of the Versions takes you to its Group View.
This view represents a selected Version of a Scorecard. In this example Version "Q1 2020" in Scorecard
"Airport" has been selected. The Scorecard title is always followed by squared brackets with the Version
name in it. In this example the headings of the two displayed groups are "Flights" and "Weather Germany".
The group lists contain KPIs (Key Performance Indicators) visualized in different ways e.g. a value with
a colored bubble indicating the KPI status, a traffic light or just a value itself, which can be text or a
number with or without an unit.
Selecting a KPI of a group list will open a pop-up holding a chart.
The x-coordinate of the chart represents the Versions (in this example the quarters of year 2020).
The y-coordinate scales automatically depending on the KPI values. In this example every Version within the Scorecard
"Airport" is looked up for the group "Flights" and the value of KPI "Guest BER" to plot the graph.
In case a value of a KPI can not be parsed to a floating-point number (e.g. it is only text) the appropriate
Version will be ignored inside the chart. Numbers with an unit will be recognized but the unit will be ignored.
Once a KPI of the type "traffic light" is selected, the chart will plot three graphs. Each for one bubble of
the traffic light (green value, yellow value, red value).
Basically the simplified UI provides two modes:
- view mode
- edit mode
You can switch between both modes by clicking on the "Edit Scorecard" button.
The "Edit Scorecard" button changes its color to blue, other tool-icons grey out
because they can not be used at this point and the side bar closes.
The UI elements change to editable elements. Editing is possible in Version and Group views.
If you want to switch back to view mode, just click on the "Edit Scorecard" button again.
If meanwhile changes were made, a dialog appears asking to save the changes.
In this example the Scorecard "Airport" is edited in its Version view. All possible actions can be seen inside
the figure below.
In this example the Scorecard "Airport" its version"Q1 2020" is edited in its Group view. All possible actions
can be seen inside the figure below.
If you click on a KPI within a group list a pop-up appears which provides you a variety of options to set
for your KPI. To apply changes of the pop-up press the "Apply" button. In additon there is a "Delete"
button next to it to delete the selected KPI.
In this example a manual KPI is edited. You can see this because the type is set to "manual".
That means that the value and status color of the KPI can only be changed manually in edit mode.
In this example a traffic light KPI is edited. It has the type "traffic". It has three values, each for a
color (green, yellow, red) and can only be edited manually as well.
In this example an automatic KPI is edited. Its newest value and status are automatically
received by the classic ICI infrastructure if the subtype is set to "normal". If you set it to
"Batch Job" go to 'Simplified UI - Batch Job' for more details.
The KPI is linked with the ICI by its KPI ID which has to be typed in manually or you can
select it from the KPI catalog by pressing the "Catalog..." button.
In the KPI catalog just select the KPI you want to show in the SUI and click the "Apply" button.
The SUI can be edited inside an integrated XML editor as well. Open it by pressing the "Open/Close XML Editor" button.
The "Open Scorecard list" button can still be used in this mode. To enable this special mode a configuration entry in the
table "ZPOC_CONF" must be enabled (see: 'Simplified UI - Integration and customizing').
Inside the XML Editor it looks like this:
To get an idea how to configure the UI by XML go to 'Simplified UI - Data Format' .
Add or Copy Scorecard
To add a new Scorecard press the [+] tool-icon in the menu bar to open a pop-up.
Press the "New" button to insert a new Scorecard. It then appears at the end of the Scorecard list in the side bar
and is selected automatically.
To create a Copy of an existing Scorecard select the Scorecard you want to copy and press the [+] tool-icon.
Now press the "Copy" button instead and a copy of your selected Scorecard is generated and automatically
selected at the end of the Scorecard list in the side bar.
To delete a Scorecard select the Scorecard you want to delete and press the "Delete Scorecard" tool-icon in the menu bar
(it looks like a bin). A pop-up will ask you if you are sure about deleting the Scorecard. Press "Yes" to confirm the action.
Report creates a new quarter version based on the last scorecard version of the Simplified UI
2106032 - Batch Job for ICI Simplified UI
The attachment of the note contains the transport of the batch job.
The note text discribes how to set up the batch job as a periodical job (and save a variant to start the job with the start parameters).
--> The parameter bBatchJob need to be enabled in the zpoc_conf table.
- copies the last version of scorecard
- the copied version is labeled with a name for the last quarter like „<YYYY> <quarter> - created on <date>"
all KPIs are checked:
- if KPI type is "automatic" and subtype is "batch job" and kpi id is available —> the batch job retrieves from BW Query "0ESR_ICIDB_ALL" the last month values of the 3 month of the last quarter and calculates the average of the values
--> this value will be fornatted user specific with the unit and is written into „value“
- if KPI type is "manual" --> the value will be set empty + rating will be set to neutral (rating = „N“)
- if range KPI ID „000900000004“ --> the batch job calculates the average as '%-value > +-100‘ as deliverd from the query –> then the rating is set like:
- red traffic light if budget variance is greater than +/- 10%
- yellow traffic light if budget variance is greater than +/- 5%
- green traffic light if budget variance is less than or equal to +/- 5%
Runs every quarter year on 8th day of new quarter as a periodic job. Runs with a variant.
Job can be executed via transaction code SM38.
Set up (as described in SAP Note 2106032):
Save a variant for Report (define start parameter)
To start the report periodically with parameters a variant have to be saved.
For the batch job there are 2 parameters:
- Scorecard ID: The parameter „Scorecard ID“ is the ID of the ScoreCard in table „zpoc_xml“ (field: „SCORECARD“). This scorecard id is used as template for the batch job. The last version of the scorecard will be copied and saved as an own quarter version.
- The flag „Copy version and activate?“ means:
empty (default) = creates a testversion with sort=„0“
„X" = creates version as last version in scorecard
Start transaction "SE38" and fill as program "Z_KPI_DB_BATCH_JOB".
- Select "Variants" as subobject
- Click button "Change"
- Click button "Create"
- Fill in name for variant, e.g. "Z_BATCH"
- Click button "Create"
- Fill in ScoreCard ID
- Flag entry "Copy version and activate?" with "X" (to activate the generated version)
- Go Back and save.
Configure a periodical job
Start transaction "SM36"
- To create a new job you have to click the button "Job Wizard".
- On the next screen fill in the name of the job (e.g. "Batch Job for Simplified UI") and continue.
- Select the radio button "ABAP program step" and continue.
- On the next screen insert the name of the report: "Z_KPI_DB_BATCH_JOB" and continue.
- It is optional to add additional steps. You don't need to check anything.
- In the following you choose the start condition (period) "Date/time".
- Continue and insert the scheduled start date and time:
the 8th day of next quarter, e.g. january 8th, April 8th, July 8th or October 8th and any time
Check "Period" Checkbox and continue
- Then choose the periodicity "None of the above" and "Other periods"
- Fill in: "3" Months and click "Create" and Continue
- Click "Complete"
The batch job will run quarterly and will create a new version of scorecard for the last quarter.
(available from version 0.6)
The look and feel and the general behavior can be configured in a configuration table.
The settings can be set globally and per user. If a setting exists for global ("GLOBAL") and for a user ("<userid>") exists in the table, the user setting will overwrite the global setting.
Settings have to be stored in the table "ZPOC_CONF".
Activate or deactivate the text based editor
1 | 0
Activate or deactivate the UI editor
1 | 0
fixed width of the group layout in pixel or %
<none> | "width"
activate or deactivate a special mode for batch job processing. It's usually not needed.
0 | 1
shows the technical names (scorecard ID's) in the list of available scorecards
0 | 1
available from 0.9
The Simplified UI can be integrated into other Web-Pages. There are several URL parameter available to modify the look and feel to your needs.
The header with the toolbar can be excluded with this parameter:
true | false
The title above the table area can be excluded with this parameter:
true | false
The scorecard to be opened can be configured with this parameter.
<ID of the scorecard>
The version of the scorecard to be shown. This parameter is useful only together with the "First" parameter.
The scorecards available in the scorecard selection can be filtered with this parameter. The different Scorecard ID's can be separated with a comma.
Enable or disable the standard background. Especially for integration the parameter could be set to false.
true | false
Available from v0.4
Enable auto refresh of the page.
Refresh=120 reloads the pages after 120 seconds.
Available from 0.9
<frame src="/sap/bc/bsp/sap/z_kpi_dashboard/index.html?First=SC_900052&ShowHeader=false&ShowTitle=false" name="Daten" border="0">
Access without password
Accessing content of an SAP system requires a user and a password. Anonymous access is not possible. One way to open a BSP to every user without having to provide user and password you can create an anonymous user and assign the user and password to the security settings of the BSP service. That user will be used for every access to the application.
Open transaction SICF
Navigate to the BSP, in our case: sap/bc/bsp/sap/z_kpi_dashboard
Double click on the entry and edit the Logon Settings
As the BSP page also calls an OData service to retrieve data you have to change the OData Service for anonoymous access as well. In order to differentiate between read-only and write access. We have 2 Odata Services (starting from v0.4). If you want to enable the read access, please change the OData Service: ZPOC_ODATA_SERVICE_R_SRV. In order to enable the write access as well change the OData Service: ZPOC_ODATA_SERVICE_SRV.
If you click on the "Open/Close XML Editor" button an XML editor will open.
The simplified Scorecard will be saved in an XML format. Up to version 0.5 the dashboard structure and content have to be edited in an XML editor. Adding the following XML text:
...results into the following scorecard:
|<SCORECARD name="Test" layout="0" image="">|
|<VERSION vname="Version 1" sort="1">|
|<GROUP name="Group 1">|
<KPI name="KPI 1" value="25" rating="G" />
name - name of the KPI
type - type of value: "S" - simple KPI - not automated | "C" classic KPI - automated - requires ICI backend
Note: "K" was used instead of "C" in older versions. Every read operation should replace the "K" by a "C" internally and then save back a "C"
subtype - optional
For type="S" subtype can be empty or "T" for a traffic light
Note: "A" was used instead of "T" in older versions. Every read operation should replace the "A" by a "T" internally and then save back a "T"
For type="C" subtype can be empty or "B". B is special type only used for special cases (like "Batch Job").
value - "<value>", the value can have a unit. For the graph the unit will be ignored. For type="S" and subtype="T" the value field can have 3 values, separated by ",".
kpiid - the ID of the KPI to be retrieved from the ICI backend
|rating - N | G | Y | R|
|Simple KPI||<KPI name="KPI2" type="S" subtype="" value="34" rating="Y"/>|
|<KPI name="KPI2" type="S" subtype="T" value="34,4,67" rating=""/>|
<KPI name="KPI2" type="C" subtype="" value="" kpiid="3000" rating=""/>
The typical use case for automated KPI's is setting the value on the dashboard with a value retrieved from a service provided by somebody else. This can be the Classic ICI, available from SP12 or even any other data source. Value and rating will be provided from that external data source.
<KPI name="KPI2" type="C" subtype="B" value="34" kpiid="3000" rating="G"/>
This is a very special case. The configuration above provides the information for value and rating as well as for a KPI to be retrieved from a different data source. The UI will interpret this like a manual (simple) KPI.
The data replacement can be done later, e.g. in a batch job which manioulates the ScoreCard by changing the XML.