How-To-Guide How to Use Data from Easy Queries for MSS KPIs

Transcription

1 How-To-Guide How to Use Data from Easy Queries for MSS KPIs Target Audience System Administrators PUBLIC Document version:

2 Document History CAUTION Before you start the implementation, make sure you have the latest version of this document. You can find the latest version at the following location: The following table provides an overview of the most important document changes. Version Date Description First version Corrections in chapter Creating an OData Service for an Easy Query 2/24 PUBLIC

3 Table of Contents Chapter 1 Introduction... 5 Chapter 2 Architecture... 7 Chapter 3 SAP Web Dispatcher... 9 Chapter 4 Generation of an OData Service for a BEx Query Chapter 5 KPI Configuration PUBLIC 3/24

4 This page is left blank for documents that are printed on both sides.

5 1 Introduction 1 Introduction This guide describes which settings you have to make to be able to use data from an easy query as a data source for the key performance indicators (KPIs) on the KPI lane of Manager Self-Service. Easy queries allow external access from front-end tools to queries. As soure system from which you retrieve your data, you can use your SAP Business Information Warehouse or your productive SAP ERP system by using operational data provisioning (ODP). Prerequisites Type of Component Software Component SAP NetWeaver GateWay 2.0, SP04 Component EA-HRGXX 607 SP14 EA-HRRXX 607 SP14 NW 731 SP07 SAP UI5 SP04 IW_BEP 200 SP06 You have activated the business function HCM_MSS_UI5_1 (HCM, Manager Self-Service on SAP UI5) in your SAP ERP system. If you want to use your SAP Business Information Warehouse (BW) as source system, you have to use BW system based on SAP NetWeaver 7.31 SP07 or higher. NOTE Easy Query is available with SAP NetWeaver 7.31 SP07. If you want to use data from your operational system you have to activate the business function HCM_ANALYTICS_2 (HCM, Operational Data Provisioning for Analytics) to enable the ODP technology PUBLIC 5/24

6 This page is left blank for documents that are printed on both sides.

7 2 Architecture 2 Architecture The figure below illustrates the architecture for linking a SAP UI application and an easy query with data from SAP Business Information Warehouse (BW). Figure 1: Architecture with SAP Business Information Warehouse The figure below illustrates the architecture for linking a SAP UI application and an easy query with data from a productive SAP ERP system using operational data provisioning (ODP) PUBLIC 7/24

8 2 Architecture Figure 2: Architecture with Operational Data Provisioning 8/24 PUBLIC

9 3 SAP Web Dispatcher 3 SAP Web Dispatcher The SAP Web Dispatcher is the single point of entry for requests from the SAP UI5 applications in the browser to your systems. The single point of entry is necessary due to Single Origin Policy (SOP). SAP Web Dispatcher manages the access to your application server and Gateway server. You have to add the following paths in the configuration file of SAP Web Dispatcher: To connect the application system that contains the SAP UI5 sources: /sap/bc/ui5_ui5/ To connect the Gateway system that transforms the OData request into RFC format of the launchpad service: /sap/opu/odata/ NOTE You have to maintain a trusted ABAP connection from the SAP NetWeaver Gateway system to your SAP ERP system to access the launchpad service, for example, by using the Configuration of RFC Connections (SM59) transaction. If the SAP NetWeaver Gateway system runs inside your SAP ERP system, you have to maintain a local RFC connection. In the application system you have to assign the Manager Self-Service Composite Role Consisting of Manager Specific Lanes (SAP_MANAGER_MSS_CR_UI5_1) role to the user. You can embed the lane service in your manager application with the following URL: dispatcher:port>/sap/bc/ui5_ui5/sap/arsrvc_suite_pb/main.html?page=hr_selfservices More Information For general information about SAP Web Dispatcher, see helpdata/en/42/5cfd3b0e59774ee a114084/content.htm PUBLIC 9/24

10 This page is left blank for documents that are printed on both sides.

11 4 Generation of an OData Service for a BEx Query 4 Generation of an OData Service for a BEx Query In this process, you generate an Open Data Protocol Service (OData service) for a BEx query. You can use this OData service to display the analytical data of the query when displaying a key performance indicator (KPI) within the KPI lane of Manager Self-Service (SAP UI5). First, you set up an analytical BEx query in your source system as an easy query. BEx queries that are identified as easy queries enable external access to the analytical data. This is necessary to be able to display the data using a key performance indicator (KPI). Next, you create an OData service in your SAP NetWeaver Gateway system that you use to forward the analytical data of the easy query to Manager Self-Service (SAP UI5) in your SAP ERP system in order to display the key performance indicator there. Prerequisites The following prerequisites apply for the source system: You have the necessary authorizations to generate easy queries. For more information, see the SAP NetWeaver Business Warehouse application help and choose Business Warehouse Configuration Configuring Easy Queries You are using BEx Query Designer in version 7.20 with revision level 672 or higher. You can select the By Easy Query option on the Extended tab page of the query properties only as of this revision level. If the source system and the application system are not identical, the date settings of the users in the source system and the date settings of the users who call the key performance indicators in the application system must be identical for each user. You specify the date settings in the user profile in the relevant system by choosing System User Profile Own Data Defaults Date Format. You have set up a trusted RFC connection between the source system and the SAP NetWeaver Gateway system. You have to define the corresponding system alias in the SAP NetWeaver Gateway system. The following restrictions apply for the query definition: Within the query, you only use input variables for time selection. In this way, the key performance indicator value can be provided using Customizing for Manager Self-Service (SAP UI5) for different periods for displaying the key performance indicator on the user interface. The Customizing settings for the KPIs cannot process any other input variables. You have specified that the overall result of the query is depicted in the first row of the results PUBLIC 11/24

12 4 Generation of an OData Service for a BEx Query When defining the query, you have specified technical names for the restricted key performance indicators. This will make the Customizing of the key performance indicators in Manager Self-Service (SAP UI5) easier. For more restrictions within the framework of the query definition, see the SAP NetWeaver application help under Business Warehouse Interfaces Interfaces in the Analytics Server Web Service Interface Managing Easy Queries. NOTE You enter the texts for a key performance indicator in Customizing for Manager Self-Services (SAP UI5) in the Customizing activity Configure Metadata for Key Performance Indicators. Procedure Creating an Easy Query 1. Call the BEx Query Designer in your source system. 2. Define a BEx query or open an existing BEx query inbex Query Designer. 3. Select the By Easy Query checkbox in the extended properties of the query on the Properties tab page under Release for External Access and save the query. 4. The system generates the query as an easy query and thus releases it for external access. NOTE We recommend that you test the query from a technical point of view. To do so, you call the Easy Query Manager transaction (transaction code EQMANAGER) in your source system. Then you select the query and choose the Test Easy Query function. The system checks the easy query and displays a preview of the query results. Creating an OData Service for an Easy Query To create an OData service, you can use transaction SEGW (SAP NetWeaver Gateway Service Builder). After the service is generated, you have to activate the service using transaction /iwfnd/ maint_service (Activate and Maintain Services). All necessary steps for creating and activating an OData service for an easy query are described in the following documents. The process you have to use depends on the support package of the SAP NetWeaver Gateway 2.0 you are using: SAP NetWeaver Gateway 2.0, SP 04 or SP05 f3/13a3ddf4b343db973e375e8597efd1/content.htm SAP NetWeaver Gateway 2.0, SP 06 and higher c72f49fe824fb40809a831a0/content.htm 12/24 PUBLIC

13 4 Generation of an OData Service for a BEx Query Result You have set up external access to the analytical data of a BEx query and created an OData service for this query that you can use to forward the data for displaying a key performance indicator for managers. For information on how to do this see in the KPI Configuration.section in this guide. More Information For general information about Open Data Protocol, see For more information about easy queries, see SAP Community Network under people/uwe.fischer/blog/2011/12/12/easy-queries-on-sap-netweaver-bw. For general information about SAP NetWeaver Gateway Service Builder, see in SAP Help Portal under NetWeaver SAP NetWeaver Gateway Developer s Guides SAP Netweaver Gateway Service Builder. SAP PUBLIC 13/24

14 This page is left blank for documents that are printed on both sides.

15 5 KPI Configuration 5 KPI Configuration The configuration of the key performance indicators (KPIs) is part of Customizing. You can find the relevant Customizing activities by choosing: Personnel Management Manager Self-Service (SAP UI5) Landing Page Analytics. Execute the activities under Analytics one after the other. Configure Launchpads for Analytics Lanes NOTE For information about this activity, see the documentation in Customizing. Enter a description in the Description field and a KPI_ID in the Additional Information field. NOTE The description is displayed in the quickview in the expanded My KPIs lane. Figure 3: Customizing view for Configure Launchpads for Analytics Lane The Launchpad Role, Launchpad Instance, and KPI_ID fields are the key fields relevant for the metadata table that contains the metadata configuration of the key performance indicators. You access this table in the Customizing activity Configure Metadata for Key Performance Indicators PUBLIC 15/24

16 5 KPI Configuration Figure 4: Customizing view for Configure Metadata for Key Performance Indicators Assign Launchpads to Role For information about this activity, see the documentation in Customizing. Assign Feeder Class for the Lauchpads For information about this activity, see the documentation in Customizing. You assign feeder class CL_MSS_ANALYTICS_LPD_FEEDER to the KPI launchpad (role HRMSS, instance KPI). NOTE Table /UI2/SAPLLPD_FEEDER is a cross-client table. Configure Metadata for Key Performance Indicators For information about this activity, see the documentation in Customizing. In this activity, you can configure the behavior and look of the key performance indicators in the KPI lane. KPI Short Text, KPI Medium Text, KPI Long Text, Description from Launchpad These texts are displayed in the lane and expanded lane as follows: The KPI Short Text from the General section in the metadata customizing is used in the lane to build the header of the KPI. The KPI Long Text is used as the tooltip for the header. Figure 5: Tile with a KPI on the lane The KPI Medium Text from the General section in the metadata customizing is used to build the header of the KPI in the expanded lane and the header of the quickview of the KPI in the expanded lane. 16/24 PUBLIC

17 5 KPI Configuration Figure 6: KPI tile and quickview in expanded lane KPI Type Depending on the KPI Type, you have to maintain the output parameters of the Current Value, Trend Reference Value, and Chart Values in a different way: If KPI Type = Absolute, only the Output Parameter fields of the different values have to be filled. If KPI Type = Ratio, the Base Output Parameter fields of the different values also have to be filled in order to allow a calculation. EXAMPLE The Female Manager Percentage KPI is a KPI of type Ratio which means that the Output Parameter and Base Output Parameter fields have to be filled. The calculation itself is performed in the lane. Time Aggregation Type and Time Mode Together with the Time Reference for Current Value field, these fields control which texts appear in the lanes depending on the values entered in these fields. The figure below shows the texts that are affected: PUBLIC 17/24

18 5 KPI Configuration Figure 7: Texts for Trend Value, Current Value and Chart Values in the lanes EXAMPLE For non-cumulative KPIs (Time Aggregation Type = non-cumulative), end dates are always displayed in the date format of the user. You have entered the following values: Time Reference for Current Value: Current Day, for example 05/31/2013 Time Reference for Trend Reference Value: Last Year Output Texts for These Settings Values Output Texts for KPI Time Mode: Yearly Output Texts for KPI Time Mode: Quarterly Current Value As of Today As of Today Trend Value 12/31/2012 (end date of last year) 12/31/2012 (end date of last year) Chart Value 1 12/31/2010 (end date of third last year) 09/30/2012 (end date of third last quarter) Chart Value 2 12/31/2011 (end date of second last year) 12/31/2012 (end date of second last quarter) Chart Value 3 12/31/2012 (end date of last year) 03/31/2013 (end date of last quarter) EXAMPLE For cumulative KPIs (Time Aggregation Type = cumulative), the texts are displayed as described below: You have entered the following values: Time Reference for Current Value: Current Day, for example 05/31/2013 Time Reference for Trend Reference Value: Last Year 18/24 PUBLIC

19 5 KPI Configuration Output Texts for These Settings Values Output Texts for KPI Time Mode: Yearly Output Texts for KPI Time Mode: Quarterly Current Value Current Year Current Quarter Chart Value (third last year) Quarter 3, 2012 (third last quarter) Chart Value (second last year) Quarter 4, 2012 (second last quarter) Chart Value (last year) Quarter 1, 2013 (last quarter) OData Link for KPI You have to enter the OData link in the General section. The OData link consists of the prefix /sap/opu/ odata/sap/, the name of the generated OData service and the technical name of the query. Figure 8: Building blocks of the OData link Current Value Time Reference This field specifies the reference point in time for the calculation of the current value. NOTE This field is mandatory. Time Reference of Trend Reference Value This field specifies the reference point in time when the reference value of the trend is determined. NOTE This field is optional. The figure below shows where this value has an influence on the KPI tile in the lane. EXAMPLE If the Time Reference of the Trend Reference Value is Last Year, then the current value is compared to the value of last year to determine the trend. This trend is displayed in the KPI tile in the lane PUBLIC 19/24

20 5 KPI Configuration Figure 9: Influence on KPI tile Trend Chart Values The chart values on the KPI tile are calculated dependent on the value entered in the Time Mode field in the General section. NOTE You can enter values for one, two, or three chart values. The number of chart values is optional. EXAMPLE For a yearly time mode (Time Mode = Yearly), the chart values are calculated as follows: Chart Value 1 = Third Last Year Chart Value 2 = Second Last Year Chart Value 3 = Last Year Note that Chart Value 1 contains the oldest value. Input Parameter, Output Parameter, Base Qutput Parameter You retrieve the technical names of all parameters from an OData service as follows: Create an OData service in your SAPNetWeaver Gateway system and test the new service with the Call Browser function. For further information see the Generation of OData Services for a BEx Query section in this guide. To see the metadata with the parameters, replace?$format=xml with $metadata in the URL of the OData service. Refresh the page. The system then displays an XML file with the parameters. Copy the names of the parameters into the relevant fields of the Customizing view. NOTE Use the unformatted output parameter names to get the correct values of the output parameters in the lane. 20/24 PUBLIC

21 5 KPI Configuration ²ÕS9Ì K phˇ œ ~ Ü Uàø7Parameters from OData link NOTE The values for the input parameters are determined automatically in the feeder class of the launchpad. For non-cumulative KPIs (Time Aggregation Type = non-cumulative), the input variables must be defined on 0CALDAY. For cumulative KPIs (Time Aggregation Type = cumulative) and a yearly Time Mode, the input variables must be defined on 0CALYEAR. For cumulative KPIs (Time Aggregation Type = cumulative) and a quarterly Time Mode, the input variables must be defined on 0CALQUARTER PUBLIC 21/24

22 Typographic Conventions Example <Example> Example Example Example Example /example Description Angle brackets indicate that you replace these words or characters with appropriate entries to make entries in the system, for example, Enter your <User Name>. Arrows separating the parts of a navigation path, for example, menu options Emphasized words or expressions Words or characters that you enter in the system exactly as they appear in the documentation Textual cross-references to an internet address Quicklinks added to the internet address of a homepage to enable quick access to specific content on the Web Hyperlink to an SAP Note, for example, SAP Note Example Words or characters quoted from the screen. These include field labels, screen titles, pushbutton labels, menu names, and menu options. Cross-references to other documentation or published works Example Output on the screen following a user action, for example, messages Source code or syntax quoted directly from a program File and directory names and their paths, names of variables and parameters, and names of installation, upgrade, and database tools EXAMPLE EXAMPLE Technical names of system objects. These include report names, program names, transaction codes, database table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE Keys on the keyboard 22/24 PUBLIC

23 SAP AG Dietmar-Hopp-Allee Walldorf Germany T +49/18 05/ F +49/18 05/ Copyright 2014 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP AG and its affiliated companies ( SAP Group ) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Please see for additional trademark information and notices. Disclaimer Please see for disclaimer information and notices. Documentation in the SAP Service Marketplace You can find this document at the following address: _SHORTKEY= PUBLIC 23/24

24 SAP AG Dietmar-Hopp-Allee Walldorf Germany T +49/18 05/ F +49/18 05/ Copyright 2014 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.