BSP/How-To: Navigation between BSP Applications: Part-I

[raja_thangamani]

Introduction:- This blog will narrate "Navigation between BSP Applications".



This blog is described into two parts for better understanding.

• BSP Application using MVC Architecture
• 
  
  1. 
     
  2. From MVC-BSP Application to MVC-BSP Application
  3. 
     
  4. From MVC-BSP Application to Flow Logic BSP Application
  5. 
     
  
  
  
• BSP Application using Flow Logic Methodology
• 
  
  1. 
     
  2. From Flow Logic-BSP Application to MVC-BSP Application
  3. 
     
  4. From Flow Logic-BSP Application to Flow Logic BSP Application
  5. 
     
  
  

Let's look at Part-I...

Scenario: The scenario which i took here to explain the Navigation process is: The main BSP Application will accept the Employee's personal Number as input from user & pass it to another BSP Application which shows the details of employee and comes back to main BSP Application when event is triggered.


To pass the data: I used two approaches to pass the data's between the BSP Application.

1. 
   
2. Via URL -You can use this approach just to pass one or two variables between applications.
3. 
   
4. Via cookies - Server/Client side cookies -
5. 
   If you need to pass Structures or Internal tables you can use this approach.
   

1. Let's start how to navigate from MVC-BSP Application to MVC-BSP Application...



Highlights: - We're going to create the following objects:

1. 
   
2. Model Class of Source BSP Application- ZCL_MVC_PERNR.
3. 
   
4. Source BSP Application- YMVC_NAV
5. 
   
6. Controller class -YMVC_NAV_CTRL.
7. 
   
8. Model class of Target BSP Application-ZCL_MVC_PERNR_DETAIL.
9. 
   
10. Target BSP Application-YMVC_TARGET.
11. 
    
12. Controller calss-YMVC_TARGET_CTRL.
13. 
    

Let's see in detail: Steps involved to create the Source BSP Application:-YMVC_NAV

1. 
   
2. Create Model Class-ZCL_MVC_PERNR
3. 
   
   
   

!https://weblogs.sdn.sap.com/weblogs/images/11786/MVC2.JPG|height=342|alt=image|width=353|src=https:/...!

1. Assign the Super Class as CL_BSP_MODEL to Model Class
2. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/MVC3.JPG|height=125|alt=image|width=348|src=https:/...!
   
   
   
3. Create Model Class attribute as follows:
4. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/MVC4.JPG|height=127|alt=image|width=414|src=https:/...!
   
   
   
5. Create Source BSP Application called YMVC_NAV
6. 
   
   
7. Create Controller called main.do
8. 
   
   

1. Mention the Controller Class name as "YMVC_NAV_CTRL" & double click on class
2. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/BSP1-2.JPG|height=170|alt=image|width=401|src=https...!
   
   
   
3. Define the following Attributes in Controller class
4. 
   
   

1. Write below code in DO_INIT method of controller class
2. 
   
   
   
   <span>METHOD DO_INIT..  MODEL_ID ?= ME->CREATE_MODEL( CLASS_NAME = 'ZCL_MVC_PERNR' MODEL_ID = 'model' ).ENDMETHOD.</span>
   
3. Write below code in DO_REQUEST method.
4. 
   
   
   
   <span>METHOD DO_REQUEST.  DATA: VIEW TYPE REF TO IF_BSP_PAGE.  ME->DISPATCH_INPUT( ).  IF ME->VIEW_NAME IS INITIAL.    ME->VIEW_NAME = 'main.htm'.  ENDIF.  VIEW = ME->CREATE_VIEW( VIEW_NAME = ME->VIEW_NAME ).  IF VIEW IS BOUND.    VIEW->SET_ATTRIBUTE( NAME = 'model' VALUE = ME->MODEL_ID ).    ME->CALL_VIEW( VIEW ).  ENDIF.ENDMETHOD.</span>
   
   
   
5. Write below code in DO_HANDLE_EVENT method
6. 
   
   
   
   <span>METHOD DO_HANDLE_EVENT.  DATA: V_TARGET_URL TYPE STRING,        W_APP_NAME TYPE STRING,        V_COOKIE TYPE STRING.  IF HTMLB_EVENT IS BOUND.    CASE HTMLB_EVENT-></span>

SERVER_EVENT.
      WHEN 'navigate'.

1. Construct the Target URL

        CALL METHOD RUNTIME->CONSTRUCT_BSP_URL
          EXPORTING
            IN_PROTOCOL       = 'http'
            IN_APPLICATION_NS = RUNTIME->APPLICATION_NAMESPACE
            IN_APPLICATION    = RUNTIME->APPLICATION_NAME
            IN_PAGE           = '**/YMVC_TARGET/main.do'
          IMPORTING
            OUT_ABS_URL       = V_TARGET_URL.
        CONCATENATE RUNTIME->APPLICATION_NAME '/**/' INTO W_APP_NAME.
        REPLACE W_APP_NAME IN V_TARGET_URL WITH SPACE.

1. Pass the Emp. Personal Number via URL

        CONCATENATE V_TARGET_URL '?pernr=' MODEL_ID->PERNR INTO V_TARGET_URL.

1. Set Server side cookie to store the source BSP appl detail

        V_COOKIE = 'YMVC_NAV/main.do'.
        CALL METHOD CL_BSP_SERVER_SIDE_COOKIE=>SET_SERVER_COOKIE
          EXPORTING
            NAME                  = 'source_bsp'
            APPLICATION_NAME      = 'NONE'
            APPLICATION_NAMESPACE = 'NONE'
            USERNAME              = SY-UNAME
            SESSION_ID            = 'NONE'
            DATA_VALUE            = V_COOKIE
            DATA_NAME             = 'sbsp'
            EXPIRY_TIME_REL       = 3600.
        NAVIGATION->GOTO_PAGE( V_TARGET_URL ).
      WHEN OTHERS.
    ENDCASE.
  ENDIF.
ENDMETHOD.

1. Write the below code inside the method GET_DETAIL
2. 
   
   <span>METHOD GET_DETAIL.  DATA: L_PERNR TYPE PERNR_D.  L_PERNR  = ME->PERNR.  CALL FUNCTION 'HR_READ_INFOTYPE'    EXPORTING      PERNR                 = L_PERNR      INFTY                 = '0006'    TABLES      INFTY_TAB             = ME->I_DETAIL   EXCEPTIONS     INFTY_NOT_FOUND       = 1     OTHERS                = 2.  IF SY-SUBRC <> 0.  ENDIF.ENDMETHOD.</span>
   
3. Create the Controller method called main.do
4. 
   
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/BSP2.JPG|height=151|alt=image|width=337|src=https:/...!
   
   
   
5. Assign the Controller Class called YMVC_TARGET_CTRL
6. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/BSP21.JPG|height=170|alt=image|width=483|src=https:...!
   
   
7. Create the following Controller Class attribute
8. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/BSP22.JPG|height=159|alt=image|width=496|src=https:...!
   
   
9. Write the below code into the DO_INIT method of Controller class
10. 
    
    
    <span>METHOD DO_INIT..  MODEL_ID ?= ME->CREATE_MODEL( CLASS_NAME = 'ZCL_MVC_PERNR_DETAIL' MODEL_ID = 'model_id' ).ENDMETHOD.</span>
    
11. Write the below code into the DO_REQUEST.
12. 
    
    
    <span>METHOD DO_REQUEST.  DATA: VIEW TYPE REF TO IF_BSP_PAGE.  DATA: LV_FIELD TYPE STRING,        V_COOKIE TYPE STRING.  ME->DISPATCH_INPUT( ).  IF ME-></span>

VIEW_NAME IS INITIAL.

1. Get the value of Page level variables.
2. Get the values from source BSP Application which was set via URL

    MODEL_ID->PERNR = REQUEST->GET_FORM_FIELD( 'pernr' ).
    IF MODEL_ID->SOURCE_BSP IS INITIAL.

1. Get the values  from source BSP Application which was set via Cookies

      CALL METHOD CL_BSP_SERVER_SIDE_COOKIE=>GET_SERVER_COOKIE
        EXPORTING
          NAME                  = 'source_bsp'
          APPLICATION_NAME      = 'NONE'
          APPLICATION_NAMESPACE = 'NONE'
          USERNAME              = SY-UNAME
          SESSION_ID            = 'NONE'
          DATA_NAME             = 'sbsp'
        CHANGING
          DATA_VALUE            = MODEL_ID->SOURCE_BSP.
    ENDIF.

1. Get the details of Employee

    IF MODEL_ID->PERNR IS NOT INITIAL.
      CALL METHOD MODEL_ID->GET_DETAIL.
    ENDIF.
    ME->VIEW_NAME = 'target.htm'.
  ENDIF.
  VIEW = ME->CREATE_VIEW( VIEW_NAME = ME->VIEW_NAME ).
  IF VIEW IS BOUND.
    VIEW->SET_ATTRIBUTE( NAME = 'model_id' VALUE = ME->MODEL_ID ).
    ME->CALL_VIEW( VIEW ).
  ENDIF.
ENDMETHOD.

1. Click on Submit.
2. 
   
3. You can see detail of given Employee No.
4. 
   Note: Now we're in YMVC_TARGET BSP Application.
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/Test12.JPG|alt=image|src=https://weblogs.sdn.sap.co...!
   
   
   
5. Now to go back to source BSP Application,Click on Back button.
6. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/Test13.JPG|alt=image|src=https://weblogs.sdn.sap.co...!
   
   
   
   so far Now we completed the Navigation between MVC--BSP Application to MVC-BSP Application.
   
   
   
   2. Let's look at How to Navigate from MVC-BSP Application to Flow logic-BSP Application.
   
   
   
   
   Highlights: We're going to create/change the following objects:
   
   
   

1. 
   
2. We can re-use the Model class of Source BSP Application- ZCL_MVC_PERNR - No Change required
3. 
   
4. Source BSP Application- YMVC_NAV - No change Required
5. 
   
6. Controller class -YMVC_NAV_CTRL - Need to change the DO_HANDLE_EVENT to call the Flow Logic BSP Application.
7. 
   
8. Create Flow logic BSP Application (Target)-YFL_TARGET.
9. 
   

Let's see in detail:

1. 
   
2. Change the DO_HANDLE_EVENT method with following: Check the comments, I mentioned different ways to pass the datas to Target application
3. 
   
   
   
   <span>METHOD DO_HANDLE_EVENT.  DATA: V_TARGET_URL TYPE STRING,        W_APP_NAME TYPE STRING,        V_COOKIE TYPE STRING.  IF HTMLB_EVENT IS BOUND.    CASE HTMLB_EVENT-></span>

SERVER_EVENT.
      WHEN 'navigate'.

1. Construct the Target URL

        CALL METHOD RUNTIME->CONSTRUCT_BSP_URL
          EXPORTING
            IN_PROTOCOL       = 'http'
            IN_APPLICATION_NS = RUNTIME->APPLICATION_NAMESPACE
            IN_APPLICATION    = RUNTIME->APPLICATION_NAME
            IN_PAGE           = '**/YFL_TARGET/target_Page.htm' "'**/YMVC_TARGET/main.do'
          IMPORTING
            OUT_ABS_URL       = V_TARGET_URL.
        CONCATENATE RUNTIME->APPLICATION_NAME '/**/' INTO W_APP_NAME.
        REPLACE W_APP_NAME IN V_TARGET_URL WITH SPACE.

1. Set Server side cookie to store the source BSP appl detail

        V_COOKIE = 'YMVC_NAV/main.do'.
        CALL METHOD CL_BSP_SERVER_SIDE_COOKIE=>SET_SERVER_COOKIE
          EXPORTING
            NAME                  = 'source_bsp'
            APPLICATION_NAME      = 'NONE'
            APPLICATION_NAMESPACE = 'NONE'
            USERNAME              = SY-UNAME
            SESSION_ID            = 'NONE'
            DATA_VALUE            = V_COOKIE
            DATA_NAME             = 'sbsp'
            EXPIRY_TIME_REL       = 3600.
        NAVIGATION->SET_PARAMETER( NAME = 'pernr' VALUE = MODEL_ID->PERNR ).

1. Or Even you can Pass the Emp. Personal Number via URL
2.        CONCATENATE V_TARGET_URL '?pernr=' MODEL_ID->PERNR INTO V_TARGET_URL.

        NAVIGATION->GOTO_PAGE( V_TARGET_URL ).
      WHEN OTHERS.
    ENDCASE.
  ENDIF.
ENDMETHOD.

1. Now all we've to do is, creation of BSP Application using Flow logic methodology to show the Employee details.
2. 
   
   
3. Create BSP Application called YFL_TARGET & Page Target_Page.htm (Page with Flow logic) as follows:
4. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/BSP31.JPG|height=162|alt=image|width=340|src=https:...!
   
   
   
5. Create the following Page Attributes:
6. 
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/BSP32.JPG|height=191|alt=image|width=478|src=https:...!
   
   
   Note: Remember to check the "AUTO" option for all the variables which we're going to receive from source BSP Application via SET_PARAMTER & URL.
   
   
   
7. Write below code in OnInitialization.
8. 
   
   
   

1. event handler for data retrieval

    IF SOURCE_BSP IS INITIAL.

1. Get the values  from source BSP Application which was set via Cookies

      CALL METHOD CL_BSP_SERVER_SIDE_COOKIE=>GET_SERVER_COOKIE
        EXPORTING
          NAME                  = 'source_bsp'
          APPLICATION_NAME      = 'NONE'
          APPLICATION_NAMESPACE = 'NONE'
          USERNAME              = SY-UNAME
          SESSION_ID            = 'NONE'
          DATA_NAME             = 'sbsp'
        CHANGING
          DATA_VALUE            = SOURCE_BSP.
    ENDIF.
    DATA: L_PERNR TYPE PERNR_D.
    L_PERNR  = PERNR.
    CALL FUNCTION 'HR_READ_INFOTYPE'
      EXPORTING
        PERNR                 = L_PERNR
        INFTY                 = '0006'
      TABLES
        INFTY_TAB             = I_DETAIL
     EXCEPTIONS
       INFTY_NOT_FOUND       = 1
       OTHERS                = 2
              .
    IF SY-SUBRC <> 0.

ENDIF.

1. Write below code in Oninputprocessing.
2. 
   
   
   

1. event handler for checking and processing user input and
2. for defining navigation

DATA EVENT TYPE REF TO CL_HTMLB_EVENT.
DATA: V_TARGET_URL TYPE STRING,
        W_APP_NAME TYPE STRING.
IF NOT EVENT_ID IS INITIAL.
  EVENT ?= CL_HTMLB_MANAGER=>GET_EVENT_EX( REQUEST ).
  IF NOT EVENT IS INITIAL.
    CASE EVENT->SERVER_EVENT.
      WHEN 'back'.
        CALL METHOD REQUEST->GET_FORM_FIELD
          EXPORTING
            NAME  = 'source_bsp'
          RECEIVING
            VALUE = SOURCE_BSP.
        CONCATENATE '**/' SOURCE_BSP INTO SOURCE_BSP.
        CALL METHOD RUNTIME->CONSTRUCT_BSP_URL
          EXPORTING
            IN_PROTOCOL       = 'http'
            IN_APPLICATION_NS = RUNTIME->APPLICATION_NAMESPACE
            IN_APPLICATION    = RUNTIME->APPLICATION_NAME
            IN_PAGE           = SOURCE_BSP
          IMPORTING
            OUT_ABS_URL       = V_TARGET_URL.
        CONCATENATE RUNTIME->APPLICATION_NAME '/**/' INTO W_APP_NAME.
        REPLACE W_APP_NAME IN V_TARGET_URL WITH SPACE.
        NAVIGATION->GOTO_PAGE( V_TARGET_URL ).
    ENDCASE.
  ENDIF.
ENDIF.

1. Click on Submit.
2. 
   
3. You can see detail of given Employee No.
4. 
   Note: Now we're in YFL_TARGET BSP Application.
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/Test12.JPG|alt=image|src=https://weblogs.sdn.sap.co...!
   
   
   Now to go back to source BSP Application, Click on Back button.
   
   
   !https://weblogs.sdn.sap.com/weblogs/images/11786/Test13.JPG|alt=image|src=https://weblogs.sdn.sap.co...!
   
   

Last but not the least, my special Thanks to Payal Sinha who helped me to narrate this...