Navigating to a view on click of a button in Webclient

Question

Hi Gurus,
I am trying to navigate to a view from one view by clicking on a button.
What is the coding to be done in do_handle_event and what is the navigation link to be provided in the customized run-time repository.
Any help would be appreciated and points would be awarded
Thanks,
Jai

Answer 1

This may help.
ashish.
3.4.1 Creating the View Set and Controllers
The following steps are necessary to create your view set:
1. Use the wizard to create a new view set SimpleActivitySet.
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 93
2. Skip through all following steps in the wizard.
3. Redefine the method if_bsp_wd_history_state_descr~get_state_description in the
generated class ZL_Z_CRM_IC_SIMPLEACTIVIT_IMPL as follows:
METHOD if_bsp_wd_history_state_descr~get_state_description .
description = text-001. " 'Simple Activity'
ENDMETHOD.
This method is called by the framework whenever the quick navigation dropdown box is refreshed.
It returns the text to be displayed, in our case, Simple Activity. Double-click on text-001 in order
to create the program text.
4. Add the following code to the layout of the view set:
<%@page language="abap"%>
<%@ extension name="htmlb" prefix="htmlb"%>
<%@ extension name="xhtmlb" prefix="xhtmlb"%>
<%@ extension name="crm_bsp_ic" prefix="crmic"%>
<%@ extension name="bsp" prefix="bsp"%>
<crmic:gridLayout cellPadding="0" cellSpacing="2" columnSize="1" rowSize="1"
width="100%" height="100%">
<crmic:gridLayoutCell columnIndex="1" rowIndex="1" width="100%" height="34%">
<bsp:call comp_id="<%=controller->GET_VIEWAREA_CONTENT_ID( 'SimpAct' )%>"
url="<%=controller->GET_VIEWAREA_CONTENT_URL( 'SimpAct' )%>"/>
</crmic:gridLayoutCell>
</crmic:gridLayout>
This HTMLB code simply creates a grid layout with one cell. Within the cell, we call the view by its
ID (SimpAct). The ID is later on defined in the framework (cf. section 3.4.3.2).
This design has some overhead in our case, but it shows in general how more complex view sets
are to be designed. For example, see the view set definition of the interaction record,
IRecViewSet.htm, in the BSP application CRM_IC.
5. Activate all your objects.
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 94
3.4.2 Creating the View and Controllers
The following steps are necessary to create your view:
1. Start the IC WebClient workbench and right-click on the View Root node to create a new view.
2. In the wizard, enter the following data:
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 95
We do not define value nodes here. Value nodes are context nodes which are not bound to the
BOL model but implemented in the context classes.
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 96
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 97
3. After this step, restart the IC WebClient workbench and see your new view in the hierarchy:
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 98
The following methods will all be created/implemented in the controller implementation class
ZL_Z_CRM_IC_SIMPLEACTIVI_IMPL. The additional controller base class should never be changed!
1. Define the inbound plug. This will be the method that is called by the framework whenever we
navigate to our view set. For more information on the link definition, see section 3.4.3.3.
Sample Code: Inbound Plug
In general, there are two way of passing parameters:
• Via the business data context (BDC), which is represented by a custom controller.
At this custom controller you find the method SET_NAVIGATION_DATA and
GET_NAVIGATION_DATA to pass a context entity.
• Binding to custom controller context nodes which leads to data sharing between views.
In our example we bind BTORDER, the root context node of our new view, to the
context node CURRENTINTERACTION of the BDC (custom controller CuCoBDC).
When our view is created the data of CURRENTINTERACTION is automatically set to
the node BTORDER and the data for the dependant nodes is automatically derived.
2. You can define a dropdown list box for the status as described in section 3.3.
3. The wizard automatically creates two methods that are responsible for the data transfer between
the model/controller and the view:
• set_models
Sends data to the view. It is comparable to the PBO modules of traditional ABAP screen
programming.
• do_handle_data
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 99
Retrieves data from the HTTP request fields. It is comparable to the PAI modules of an
ABAP screen.
3.4.3 Adjusting IC WebClient Framework
After having defined the views, controllers, and classes, we need to assign them to the runtime profile of
IC WebClient.
The first time you do this, there are some preparations needed which are explained in the following
section. After the preparation, the view and view set specific work for our example is explained.
3.4.3.1 Preparation
In order to prepare the IC WebClient framework for custom-built view sets, we need to create a new
runtime profile BSP application in the customer namespace. This BSP application will contain one page,
called CRM_IC.xml. It will contain the definition of all view sets and all navigational links by including the
corresponding files that actually contain the definitions. We build all this according to standard structures,
though it doesn’t necessarily have to be this way.
To make things a bit simpler, we do not split up the repository into runtime and design time. All changes
we make are only relevant for the runtime repository.
Perform the following steps:
1. Create the BSP application Z_CRM_IC_RT_REP in the package Z_CONS_COOK.
2. Copy the file CRM_IC.xml from the BSP application CRM_IC_RT_REP to Z_CRM_IC_RT_REP.
3. Adjust the contents of this file according to the changes shown in bold in the following sample
code:
<?xml version="1.0"?>
<WebDynProDefinitions>
<Application id="CRM_IC">
<ViewSets>
<%@include file="../Z_CRM_IC_RT_REP/CRM_IC_All_Viewsets.xml" %>
</ViewSets>
<NavigationalLinks>
<%@include file="../Z_CRM_IC_RT_REP/CRM_IC_All_NavLinks.xml" %>
</NavigationalLinks>
</Application>
</WebDynProDefinitions>
Hence, CRM_IC.xml includes two more XML files which can be found in BSP application
Z_CRM_IC_RT_REP.
4. Create BSP application Z_CRM_IC_RT_REP in package Z_CONS_COOK.
5. Copy page fragment CRM_IC_All_Viewsets.xml of BSP application CRM_IC_DT_REP to
Z_CRM_IC_RT_REP and replace the file contents with the following lines:
<%@ include file="MainViewSet.xml" %>
<%@ include file="../CRM_IC_DT_REP/BuPaViewSet.xml" %>
<%@ include file="../CRM_IC_DT_REP/CRM_IC_All_Viewsets_wo_BUPA_and_Main.xml"
%>
This definition still works with all standard view sets, but replaces the MainViewSet.xml with our
own definition, since it is now loaded from Z_CRM_IC_RT_REP.
6. Copy page fragment MainViewSet.xml from BSP application CRM_IC_DT_REP to
Z_CRM_IC_RT_REP.
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 100
7. Copy page fragment CRM_IC_All_NavLinks.xml of BSP application CRM_IC_DT_REP to
Z_CRM_IC_RT_REP and replace the file contents with the following line:
<%@ include file="../CRM_IC_DT_REP/CRM_IC_All_NavLinks.xml" %>
This definition makes sure that standard navigational links still work and that we are able to add
our own link definitions later on.
8. Activate all objects.
9. Customize the IC WebClient runtime framework profile in such a way that the new source file is
used, as shown in the following sample code:
<?xml version="1.0"?>
<RuntimeFrameworkSettings>
<RuntimeRepositorySource type="BSP">
<BspApplication>Z_CRM_IC_RT_REP</BspApplication>
<PageName>CRM_IC.xml</PageName>
</RuntimeRepositorySource>
<WorkareaDefinition>
<ViewSet>workViewSet</ViewSet>
<ViewArea>workViewSetArea</ViewArea>
</WorkareaDefinition>
<ControllerReplacements>
<ControllerReplacement>
<ReplacedController>BuPaMoreContactView</ReplacedController>
<ReplacingController>Z_CRM_IC/BuPaMoreContactView</ReplacingController>
</ControllerReplacement>
<ControllerReplacement>
<ReplacedController>IRecReason</ReplacedController>
<ReplacingController>Z_CRM_IC/IRecReason</ReplacingController>
</ControllerReplacement>
</ControllerReplacements>
<InteractionLayerApplication>ALL</InteractionLayerApplication>
</RuntimeFrameworkSettings>
3.4.3.2 Creating View Definitions for Design Time Repositories
Every new view set must be defined in the runtime repository.
1. Create page fragment SimpleActivitySet.xml in BSP application Z_CRM_IC_RT_REP and maintain it
as shown in the following sample code:
<ViewSet id="Z_CRM_IC/SimpleActivitySet">
<ViewArea id="SimpAct" views="Z_CRM_IC/SimpleActivity"/>
</ViewSet>
The view area ID (SimpAct) is the name of the literal used in the bsp:call tag. For more
information, see section 3.4.1.
2. Include this file in the framework. Place the following line into page CRM_IC_All_Viewsets.xml in
BSP application Z_CRM_IC_RT_REP:
<%@ include file="SimpleActivitySet.xml" %>
3. Activate your objects.
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 101
3.4.3.3 Creating Navigational Link Definitions for Design Time Repositories
In order to provide a navigational link for the activity clipboard, we need to define this link.
1. Create page fragment SimpleActivityNavLinks.xml in BSP application Z_CRM_IC_RT_REP and
maintain it as shown in the following sample code:
<NavigationalLink name="SimpleActivity">
<Source viewRef="IRecActivitiesClipboard" outboundPlugRef="default"/>
<Targets>
<Target viewRef="Z_CRM_IC/SimpleActivity"
inboundPlugRef="inboundplugid"/>
</Targets>
</NavigationalLink>
The name of the link is SimpleActivity. We will refer to it in the activity clipboard Customizing. For
more information, see section 3.4.3.5. The link can be activated on the view
IRecActivitiesClipboard and it navigates to the view SimpleActivity in BSP application
Z_CRM_IC. When the target view is activated, method ip_inboundplugid of the view controller
class is called.
The framework adds the prefix “ip_” automatically for this method.
2. Similar to the view definition, include the navigational link into the runtime repository. Add the
following line to the file CRM_IC_All_NavLinks.xml in BSP application Z_CRM_IC_RT_REP:
<%@ include file="SimpleActivityNavLinks.xml" %>
3. Activate your objects.
3.4.3.4 Placing View Sets into Controller Hierarchies
After the view set and the navigational link are defined, we finally add our new view to the possible views
for the work area. We need to adjust the file MainViewSet.xml in BSP application Z_CRM_IC_RT_REP. Add
the reference to our view set and activate the file as shown in the following sample code:
<ViewSet id="ICAPPMainViewSet">
<ViewArea id="navigationArea" views="navigationViewSet"/>
<ViewArea id="workArea" views="workViewSet"/>
<ViewArea id="contextArea" views="contextAreaView"/>
<ViewArea id="breadCrumbsArea" views="BreadCrumbsView"/>
<ViewArea id="globalSearchArea" views="HistoryView"/>
<ViewArea id="helpArea" views="Help"/>
<ViewArea id="statusArea" views="StatusView"/>
<ViewArea id="errorArea" views="ErrorViewSet"/>
</ViewSet>
<ViewSet id="navigationViewSet">
<ViewArea id="navigationViewSetArea" views="NavBarView"/>
</ViewSet>
<ViewSet id="workViewSet">
<ViewArea id="workViewSetArea"
views="<%@include file='../CRM_IC_DT_REP/StdWorkareaOccupation.xml' %>
Z_CRM_IC/SimpleActivitySet"/>
</ViewSet>
Consultant’s Cookbook for Interaction Center (IC) WebClient SAP CRM 4.0 Add-On for Service Industries Page 102