Kontakt

Ansicht
Dokumentation

WCF_CRMC_UI_BI - Display SAP NetWeaver BI Reports

WCF_CRMC_UI_BI - Display SAP NetWeaver BI Reports

PERFORM Short Reference   Fill RESBD Structure from EBP Component Structure  
This documentation is copyright by SAP AG.
SAP E-Book

The following information gives you the detailed steps involved in defining reports in SAP NetWeaver Business Intelligence (SAP NetWeaver BI) for reuse and how to display them with the WebClient UI Framework.

There is a BI report reuse component that you can use to display any BI report based on the BW 3.x and 7.x technology within the WebClient UI Framework. As is the case with any other reuse component, you can embed it in a view set or navigate to it in the components window. It can be used in work center pages and overview pages.

You need to maintain the BI reports in Customizing with a unique ID. This ID must be specified when the component is called. In addition, the Customizing allows you to specify cross-navigation targets from objects in the BI report to the WebClient UI components.

Note

It is recommended to restrict to the following within this Customizing activity:

  • Define Cross Navigational Links for InfoObjects
  • Define BI Report Replacements
  • Assign Cross Navigation Links

In the business role Analytics Professional you can use the Import Wizard to import BI reports, SAP BusinessObjects Xcelsius dashboards and SAP BusinessObjects Crystal reports.

If you want to customize a BI report in the WebClient UI Framework and you are not familiar with SAP NetWeaver BI, make sure you contact someone who knows the technical data of the BI reports that you want to use.

The minimum entry required to display a BI report is an entry in Define BI Reports. Here you must maintain at least the following settings:

  • BI Report ID - this is an ID you define, for example, TOP10_OPPORTUNITIES. Use this ID when calling the BI report component.
  • BI Object Type - this is the type of BI report.
Currently, the following types are supported:
  • Template 3.x - you have to specify the technical name of the BI template in the field BI Object Key.

  • Query views 3.x - this is the generic template for query views; specify the query view name in the field BI Object Key.

The following BI report types require a BI 7.0 system:
  • Template 7.x - you have to specify the technical name of the BI template in the field BI Object Key.

  • Query Views 7.x - this is the generic template for query views; specify the query view name in the field BI Object Key.

  • Query 7.x - this is the generic template for queries; specify the query name in the field BI Object Key.

  • Info Provider 7.x - this is the generic template for info provider; specify the info provider name in the field BI Object Key.

Enterprise Report 7.x - you have to specify the technical name of the enterprise report in the field BI Object Key.
The following BI report types require a BI 7.0.2 system (with continuous improvement pack):
  • SAP BusinessObjects Xcelsius dashboards

  • SAP BusinessObjects Crystal reports

You have to specify the technical name of the BI reports (ID) in the field BI Object Key.
  • BI Object Key - this is the key that identifies the object which is based on the BI object type.

Note

Note that the SAP NetWeaver BI system name and the RFC destination of SAP NetWeaver BI are needed only if the report should not be started in the default SAP NetWeaver BI system. We recommend you do not make an entry in this field, as it is too restrictive.

  • Cross Navigation Links
You can make Customizing settings to define cross navigation links to WebClient UI components from any characteristic in a BI report. For example, if you have a list of business partners (BPs) in the BI report, you could define the Customizing for the characteristic Business Partner to be able to right click on one of the BPs and select Display Business Partner Details. This would trigger direct navigation to the BP Details component that is specified in your cross navigation Customizing.
  • Define Cross Navigational Links for InfoObjects
You first need to create a cross navigational link. A cross navigational link is based on characteristics' names (that is the technical name of the InfoObject) in SAP NetWeaver BI. You can define several cross navigational links for one InfoObject.
  • InfoObject - the technical name of the characteristic from which you want to navigate.

  • Nav. Link ID - the ID for the cross navigational link.

  • Sequence - a number that is used to sort the menu entries within the BI report's context menu.

  • Object Type - determines the target of the navigation.

  • Object Action - determines the target of the navigation.

  • Object Key Name - the name of the field that corresponds to the value that was selected in the BI report. For example, you selected a BP in the BI report. This is generally the ID of a BP (not the GUID). So we need to tell the framework that the value that is transferred is an ID.

  • Menu Text - the text that appears in the BI report's context menu.

  • The parameters object type, object action and object key name allow the framework to create the entity that is based on the value it obtained from SAP NetWeaver BI for the receiving component. For example, the BP ID '01234567890' is selected in the BI report. The framework tries to create a business object layer (BOL) entity of the correct type based on that ID. The entity that is created is transferred to the receiver.

  • Use a Cross Navigation Link
To use a cross navigation link in a report, you must assign the report to it.
Note
Navigation for Crystal report is not supported.
Cross navigational links for Xcelsius dashboards are supported. Define the links in the IMG activity Define Cross Navigational Links for InfoObjects and assign them to the dashboard in the Assign Cross Navigation Links step of the customizing. In addition, the Xcelsius dashboard must be designed to handle the navigation.
  • Report Replacement
This is an optional feature if customers want to replace any shipped customizing. For example, SAP ships a report ID TOP10_OPPORTUNITIES which calls BI template 0TPLI_TOP10_Q0001_V01. You then create a version of this BI template with the technical name ZTPLI_TOP10_Q0001_V01. To display your own version in the WebClient UI Framework, you need to define a report replacement.
First you create a copy of the basic Customizing for report ID TOP10_OPPORTUNITIES, for example, ZTOP10_OPPORTUNITIES. Then you change the BI object key to ZTPLI_TOP10_Q0001_V01 and save it.
Now you need to create a new entry in Define BI Report Replacement from TOP10_OPPORTUNITIES to ZTOP10_OPPORTUNITIES.
  • Display a BI Report in the WebClient UI Framework
  • Define as a Logical Link

If you define a logical link for a particular BI report, you can use the link in:
- Workcenter link groups
- Direct link groups
For more information on these groups, refer to the most up-to-date version of the WebClient UI Framework application help.
You define the logical link in transaction CRMC_UI_NBLINKS using the following parameters:
Type BI Report
Target ID DISPLAY
Parameter ID of the BI report from basic customizing
Parameter Class CL_CRM_GEN_UI_BI_UTIL
Title Title (for example, for display in the navigation bar)

  • Display a BI Report in Your Component
To display a BI report in your component, you must create a component usage for every BI report that you want to display. This allows you to use it anywhere that a reuse component can be used.
  • Create a Component Usage for the BI Report

Create the usage with the following parameters:
ID A unique ID in your component
Used Component GSBIRP
Interface View MainWindow

Note

Ensure you add the inbound plug DISPLAY. You need this if you want to navigate in your component to the embedded BI report.

  • Set the ID of the Report to the Component Usage

If the BI report is to be displayed without navigation (for example, as part of a view set or a dynamic page), you must specify the parameter REPID in the method WD_USAGE_INITIALIZE. Here is an excerpt from the coding:
METHOD wd_usage_initialize.
DATA: bicontext TYPE REF TO cl_bsp_wd_context_node.
CASE iv_usage->usage_name.
WHEN 'BIREPORT_1'.
TRY.
bicontext = iv_usage->get_context_node( 'BIREPORT_1' ).
bicontext->set_s_struct(
attribute_path = '' component = 'REPID' value = 'SAMPLE6' ) .
CATCH cx_root.
ENDTRY.
ENDCASE.
ENDMETHOD.
You should replace SAMPLE6 with the BI report ID from basic Customizing.
If you do want to navigate to the BI report, you could also transport a collection with the navigation. You can create the collection with the static method CL_CRM_GEN_UI_BI_UTIL=>CREATE_COLLECTION.
Here is an excerpt from the coding that that you could use in an event handler or outbound plug:
DATA: lv_bo_coll TYPE REF TO if_bol_bo_col.
lv_bo_coll = cl_crm_gen_ui_bi_util=>create_collection( 'SAMPLE7' ).
view_manager->navigate( source_rep_view = rep_view
outbound_plug = 'NAVLINK'
data_collection = lv_bo_coll ).
You should replace SAMPLE6 with the BI report ID from basic Customizing.
You need to replace NAVLINK with the name of your navigational link that will navigate to the BI report component.
  • Optional: Specify Additional Parameters

The BI templates URL allows you to set variable values (similar to select options) and filter values (for example, 0Country=DE or in more complex forms) and also provides some settings such as Skip first screen.
The syntax of these URL parameters depends on the BI report engine you are using (3.x or 7.x). The 3.x syntax is specified in the BI Web API Reference (also available in German), which you can find in SAP Service Marketplace. The parameters are detailed in the section "Calling Parameterized Web Templates". The 7.x syntax can be found in the SAP Library.
You need to build a string with additional parameters in accordance with the instructions in the BI Web API Reference. Here is an example of how you can filter to a specific country/region (the report should recognize the InfoObject country/region):
DATA:
lv_parameter TYPE string,
lv_bo_coll TYPE REF TO if_bol_bo_col.
lv_parameter = 'FILTER_IOBJNM=0COUNTRY&FILTER_VALUE=DE'.
lv_bo_coll = cl_crm_gen_ui_bi_util=>create_collection(
iv_id = 'SAMPLE7'
iv_addparameter = lv_parameter
).
view_manager->navigate( source_rep_view = rep_view
outbound_plug = 'NAVLINK'
data_collection = lv_bo_coll ).
You need to replace SAMPLE7 with the BI report ID from basic Customizing.
You need to replace NAVLINK with the name of your navigational link that will navigate to the BI report component.
  • Optional: Dynamically Specify the SAP NetWeaver BI RFC Destination

In rare cases it might be necessary to determine SAP NetWeaver BI (if the customer has several, for example) at runtime. If this is the case, you can specify the parameter BISYSTEM, which needs to be the name of an RFC destination (which is maintained in transaction SM59 as an ABAP connection) for SAP NetWeaver BI . If the destination is set at runtime, the BI default destination or a destination defined in basic customizing is overwritten.
You can set the parameter either in method WD_USAGE_INITIALIZE together with the first excerpt of codinge in the section "Set the ID":
bicontext->set_s_struct(
attribute_path = '' component = 'BISYSTEM' value = 'Q73CLNT003' ) .
or you could specify the parameter in navigation by changing the CREATE_COLLECTION method to:
lv_bo_coll = cl_crm_gen_ui_bi_util=>create_collection(
iv_id = 'SAMPLE7'
iv_bisystem = 'Q73CLNT003'
).
You need to replace Q73CLNT003 with the name of the RFC destination or a variable that has the name.
  • Display a BI Report in a Dynamic Page
Once you have created a component usage for the BI report, you can use it in dynamic pages. The following dynamic pages allow you to include component usages:
  • Overview Page

  • Work Center Page

  • Home Page

  • Report and Dashboard Page

For more information, see the documentation for these pages in SAP Service Marketplace to include the BI report component usages that you specified in the section above, 'Create a Component Usage for the BI Report'.
Ensure that you use only BI reports in pages.
  • Default BI RFC Destination
As long as you have not specified a SAP NetWeaver BI system in your basic Customizing settings or in the section 'Optional: Dynamically Specify BI System RFC Destination', the framework always calls the default SAP NetWeaver BI system. You must assign the default SAP NetWeaver BI system (RFC connection) to the logical system CRMBWDEST in transaction BD97. If there is no logical system CRMBWDEST, create this logical system in transaction BD54.
  • Session Termination
If reports are no longer displayed, WebClient UI Framework automatically ends BI sessions as long as the BI system and the connected SAP NetWeaver Portal offer that function.
Interface View




rdisp/max_wprun_time - Maximum work process run time   CL_GUI_FRONTEND_SERVICES - Frontend Services  
This documentation is copyright by SAP AG.

Length: 18453 Date: 20240523 Time: 193249     sap01-206 ( 241 ms )