How to integrate BO reports into CRM WEB UI by using OpenDocument URL’s

How to integrate BO reports into CRM WEB UI by using OpenDocument URL’s

Applies to:

SAP BO 4.0, CRM 7.0 and above, SAP BI/BW 7.0 and above

Summary

This article describes how to integrate BO reports into CRM WEB UI. It details out step by step procedure that are involved in integrating reports placed in BO CMS in to CRM Web UI.

	Author: Suresh Babu Kommuri Designation: SAP BO Consultant Created on:   8 February 2013
	Author: Suresh Kumar Ramadurgam Designation: SAP BI Consultant Created on:   8 February 2013
	Author: Pravin Bayaskar Designation: SAP CRM Consultant Created on:   8 February 2013
	Author: Omkar Uthale Designation: SAP CRM Consultant Created on:   8 February 2013

Table of Contents

	Overview	3
	Assumptions	3
	OpenDocument Syntax’s	3
	Types of Document	4
	Generating OpenDocument Urls	4
	Testing Phase	5
	Cloning AdaptiveProcessingServer in CMC	5
	Configuring Urls & Parameters in CRM SPRO	6
	Creating Launch Transaction ID	7
	Creating Logical Link IDs	8
	Creating Group IDs	9
	Assign Logical Link IDs to the Group ID created above	10
	Create Work Center Page	10
	Create a Logical Link ID of Type Work Center	12
	Create a New Work Center	12
	Assign the Group IDs to Work Center	13
	Assign Work Center to Navigation BarProfile (Business Role)	14
	Enable Work Center visibility in Business Role	15
	Opening the report in CRM WEB UI	16
	Related Content	16
	Disclaimer and Liability Notice

Overview

Purpose of this document is to demonstrate the integration process of BO reports in CRM web UI using OpenDocument concept. This article explains the step by step mechanism of how to build an OpenDocument URL based on reports which are placed in CMS. It also explains on how to configure SPRO components in CRM to display these reports in CRM WEB UI.

2. Assumptions

The document assumes that the target audience is aware of the process that involve

• Creation of BO reports.
• CMC Administration.
• Configuring SPRO in CRM.
• UI Component creation in CRM.
• Target ID creation using Work Area Component repository.

3.   OpenDocument URL creation syntax

An OpenDocument URL is generally structured as follows in a java implementation as is the case in this example.

1. Ampersand (&) is used to join all the parameters.
2. ServerName and port refers to the BO Enterprise ServerName and port.
3. Parameters to be used in our example are iDocID, sType, sRefresh, sWindow, lsS and lsM.

Following is the brief description of the parameters to be used.

Parameter	Description	Valid Values
iDocID	Document identifier.	Document identifier (InfoObjectID).
sType	The file type of target document or report.	wid rpt car
sRefresh	Indicates whether a refresh should be forced when the target document or report is opened.	Y N
sWindow	Indicates whether the target report will open in the current browser window or a new window will be launched.	Same (current browser window). New (new browser window is launched).
lsS[NAME]	Specifies a value for a single prompt. [NAME] is the text of the prompt.	Hard-coded value or dimension object.
lsM[NAME]	Specifies multiple values for a prompt. [NAME] is the text of the prompt.	Hard-coded values separated by semicolon (;) or dimension object.

4. Types of Documents

We can use OpenDocument feature in Business Objects Enterprise to create cross-system links. The following document types are:

.wid:   Web Intelligence version 6.x documents

.rep:    Desktop Intelligence documents

.rpt:     Crystal reports

.xlf:      XCelsius file

.swf:   XCelsius output file or flash files

.car:    OLAP Intelligence Reports

5. Generating OpenDocument URLs

As per configurations of BO CMC web application and its folders path in tomcat server in [windows/Linux/Unix] server we can identify the URL method. It depends on BI launch pad / infoview configurations that we have to identify by visible examinations.

Take some examples.

1. http://<servername>:<port>/OpenDocument/opendoc/openDocument.jsp
2. http://<servername>:8080/BOE/BI
3. http://<servername>:<port>/InfoViewApp/logon/logon.do

Here, we have to generate correct URL followed by document IDs and its name.  The following steps will help to us to accomplish this task.

Step 1:           Open the BI Launch pad / infoview and check its URL structure.

http://<servername>:8080/BOE/BI

Step 2:           Now choose any BO report which is to be displayed in CRM WEB UI and check its properties for getting document ID and its name as shown below.

Step 3:          Generate the URL as shown below using the properties of report.

http://<servername>:8080/BOE/portal/InfoView/OpenDocument/opendoc/openDocument.jsp?sDocName=Activity+Details+in+CRM&iDocID=9490&sType=wid&sRefresh=Y

6. Testing Phase

Finally we have to check the above generated URL in IE Browser to open the same BO report. If the report is not displayed in IE then it could be URL generation error or Load balancing on AdaptiveProcessingServer in CMC. In case the report is opened with the URL then ignore cloning AdaptiveProcessingServer procedure explained in next step.

7. Cloning AdaptiveProcessingServer in CMC

Login to CMC using administrator user ID. In the CMC Home page under Servers List select AdaptiveProcessingServer (primary one) and click clone icon which is on the top of the left side then complete the cloning processes as shown in below screen shot.

 

Caution: Before cloning process make sure to disable and stop the primary AdaptiveProcessingServer. After cloning process enable the server and make sure it’s in Running mode.

 

Note: After completion of above all steps then again check the generated URL in IE tab. If you don’t get the output so you did some mistakes in the URL line. Cross check and rectify the error.

8. Configuring Urls & Parameters in CRM SPRO

Now Login in to CRM system that has authorization to perform in SPRO for to do rest of configurations. Path shown below

1. SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àTransaction Launcher-__MCE_ITEM____MCE_ITEM__àDefine URL’s and Parameters.

Step 1:           Click on New Entries.

Step 2:           Give a technical name starting with ‘Z’, ‘Y’ or ‘X’ as per naming standards.

                                    Ex: ZBO_WEB_ACT_DTLS_CRM

Step 3:           Choose “Get” option from Request Method drop down list.

Step 4:           Click on Non-BSP URL radio button and paste the generated URL into URL textbox. If URL length exceeds then copy and paste the rest of part into URL Continued textbox.

Step 5:           Save and back to previous window.

9. Creating Launch Transaction ID

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àTransaction Launcher-__MCE_ITEM____MCE_ITEM__àConfigure Transaction Launcher

Step 1:           Click on Continue button.

Step 2:           Give any technical name for Launch Transaction ID starts with ‘Z’, ‘Y’ or ‘X’ as per naming standards and in Component set select “ALL” option from the drop down list .Then press Continue

 

Step 3:           Give any technical name for Handler Class starts with ‘Z’, ‘Y’ or ‘X’ as per naming standards. Then click Continue button.

 

Step 4:           In “Further Technical Details” section select “URL Transaction” as a Transaction Type and choose “ZBO_WEB_ACT_DTLS_CRM” for URL ID which is created above then Click Continue button.

 

Step 5:           In “Transaction Parameters” section and “Activity Clipboard Integration” leave blank and press Continue.

Step 7:           Click on Complete button.

10. Creating Logical Link IDs

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Step 1:           Double click on “Define Logical Links” options in the left side and click New Entries option. Give the technical name for Logical link ID start with ‘Z’, ‘Y’ or ‘X’ as per naming standards.

                        Ex: ZBO_WEB_ACT_DTLS_CRM –__MCE_ITEM____MCE_ITEM__à ZBOWEBACTD

Step 2:           Select the “Launch transaction” option for Type and give the Target ID as “EXECLTX”.

Step 3:           Select “ZBO_WEB_ACT_DTLS_CRM” for Parameter option and select the “CL_CRM_UI_LTX_NAVBAR_PARA” option for Parameter Class.

Step 4:           Give the title which displays as report title in CRM WEB UI then enter any description for your report.

Step 5:           Save and back to previous window.

 

11. Creating Group IDs

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Step 1:           Double click on “Define Work Center Link Groups” options in the left side and click New Entries option. Give the technical name for Group ID start with ‘Z’, ‘Y’ or ‘X’ as per naming standards.

                        Ex: ZBOWEBACTD

Step 2:           Group type should be “No Classification” and give any name to title & mention Description. Then save and back to previous window.

12. Assign Logical Link IDs to the Group ID created above

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation bar profile.

Step 1:           Double click on “Assign Links to Work Center Link Group” options in the left side and click New Entries option. Select “logical link id” which has already created “ZBOWEBACTD” and press ENTER. Then save and back to previous window.

 

13. Create Work Center page

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Before creating Work Center you have to create work center page as per the requirement. After that create a Logical Link ID of type Work Center and use it while creating Work Center.

Creating Work Center Page:

-Go to tcode BSP_WD_CMPWB

-Create a custom component

-Create Overview page.

-Go to runtime repository and add component usage of component CRMCMP_GS_WC for InterfaceView IFVGroupLinks. Add as many usages as the number of Link group IDs that you are going to assign to this Work Center.

 

-Now add this component usage views to the overview page.

-Go to overview page configuration and select page type as “Work Center Page”.

-Create a new UI configuration and add the available views in the suitable sections.

-Go to component controller’s WD_USAGE_INITIALIZE method and link usage ids with the actual Link group ids that you are going to assign to this work center. Given below is the sample code

CASE iv_usage->usage_name.
WHEN ‘CuCrystalReports’.                                         
TRY.
wccontext = iv_usage->get_context_node( ‘WORKCENTERINF’ ).
wccontext->set_s_struct( attribute_path = ” component = ‘COMPONENT’ value = ‘ZBOREPORTS’ ) .
wccontext->set_s_struct( attribute_path = ” component = ‘INTERFACE_VIEW’ value = ‘ZBOREPORTS/MainWindow’ ) .
wccontext->set_s_struct( attribute_path = ” component = ‘GROUP_ID’ value = ‘ZSLS_CR_RE’ ) .
CATCH cx_root.
ENDTRY.

Where: ‘ZBOREPORTS’ is the UI component name

               ‘CuCrystalReports’ is the component usage name

               ‘ZSLS_CR_RE’ is the Link group id name.

-Publish component window and its default inbound plug in the component interface by going in runtime repository.

-Now add this component in Work Area Component Repository and create a Target ID. Goto to below path:

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Work Area Component Repository.

 

14. Create a Logical Link ID of Type Work Center

Create Logical Link ID of Type Work Center as shown in below path and by using the Target ID created in above section.

Go to SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Double click on “Define Logical Links” options in the left side and click New Entries option. Give technical name for Logical Link ID start with ‘Z’, ‘Y’ or ‘X’ as per naming standards.

 

15. Create a New Work Center

Step 1:           Double click on “Define Work Centers” options in the left side and click New Entries option. Select the created Work Center ID then select the Logical Link ID created in above section and mention any Title & Description for work center.

Step 2:           Save and back to previous window.

 

16. Assign the Group IDs to Work Center

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Step 1:           Double click on “Assign Work Center Link Groups to Work Center” options in the left side and click New Entries option. Select the Work Center ID and Group ID and press ENTER.

Step 2:           Save and back to previous window.

17. Assign Work Center to Navigation Bar Profile (Business Role)

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àTechnical Role Definition-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Step 1:           Double click on “Define Navigation Bar Profile” options in the left side and select any “Nav Bar Profile” from the list.

 

Step 2:           Double click on “Assign Work Centers To Navigation Bar Profile” options in the left side and click New Entries.

Step 3:           Select the work center you have created above and press ENTER and mention the position.

 

18. Enable Work Center visibility in Business Role selected

SPRO-__MCE_ITEM____MCE_ITEM__àSAP Reference IMG-__MCE_ITEM____MCE_ITEM__àCustomer Relationship Management-__MCE_ITEM____MCE_ITEM__àUI Framework-__MCE_ITEM____MCE_ITEM__àBusiness Roles-__MCE_ITEM____MCE_ITEM__àDefine Navigation Bar Profile.

Step 1:           Double click on “Define Business Roles” options in the left side and select any “Business Roles” (earlier we have considered it as “Nav Bar Profile”) from the list.

 

Step 2:           Double click on “Adjust Work Centers” options in the left side and select your Work Center “ZBOWEBACTD” from the list.

 

Step 3:           Double click on “Adjust Work Center Group Links” options in the left side and select your Group Link “ZBOWEBACTD” from the list.

Step 4:           Enable In Menu & Visible options for your Work Center.

 

19. Opening report in CRM WEB UI

Now Log in to CRM Web UI from CRM system using T.code:CRM_UI and choose the Business role for which the Work Center is added. Click on the Work Center created and open the report you are looking for.

Finally you can open your report in CRM WEB UI by selecting your Business Role and clicking the report.

20. Related Content

For more information, visit the Business Objects homepage