How to create a custom web layout for Objective Setting & Appraisals

The web UI is realized via the BSP Application HAP_DOCUMENT. It generates an appraisal document based on a fixed routine. This leaves little possibility for creativity when you are not happy with the standard delivered layout.

Therefore the application has the possibility to give the control over the layout to another BSP application. To achieve this, these few steps are necessary.

Copy the delivered or create you own BSP Application and make sure that the custom BSP application uses application class CL_BSP_HAP_DOCUMENT_UI as this class contains all the necessary methods and constants to perform the eventing.

Create a controller class and implement the do_request method. In here it has to be decided whether to call the main appraisal document or the part appraisal document. The coding within this method will look more or less like:

METHOD do_request .*– References  DATA: l_myview           TYPE REF TO if_bsp_page.  DATA: l_appl             TYPE REF TO cl_bsp_hap_document_ui.*– Data definition  DATA: l_view_name        TYPE string.*– Get application object  l_appl ?= adapter->if_bsp_page~get_application( ).  TRY.      IF application_data IS INITIAL.        application_data = l_appl.      ELSE.        l_appl->doc         = application_data->doc.        l_appl->doc_h       = application_data->doc_h.        l_appl->s_parameter = application_data->s_parameter.      ENDIF.    CATCH cx_root.  ENDTRY.  IF l_appl->doc-s_appraisal_id-part_ap_id IS INITIAL.*– Call appraisal document view    l_view_name = ‘appraisal_document.htm’.    l_myview = create_view( view_name = l_view_name ).    TRY.        call_view( l_myview ).      CATCH cx_root.    ENDTRY.  ELSE.*– Call part appraisal document view    l_view_name = ‘part_appraisal_document.htm’.    l_myview = create_view( view_name = l_view_name ).    TRY.        call_view( l_myview ).      CATCH cx_root.    ENDTRY.  ENDIF.ENDMETHOD.

Now you can program the layout you want to use in your custom BSP. Some examples I have seen include roadmaps, tab-strips and flowbars.
You can directly use the new BSP application however often the layout is for one specific template and not general valid. To make sure a BSP is only used for the right template you can create a BAdI implementation based on definition HRHAP00_BSP_TMPL. In the method ‘BSP_APPLICATION_GET’ you only have to assign the custom BSP application.

METHOD if_ex_hrhap00_bsp_tmpl~bsp_application_get.  application = ‘CUSTOM_BSP_APPLICATION_NAME’.ENDMETHOD.

After you activated the implementation you have to go to the basic setting of OSA (transaction OOHAP_BASIC) and register the new implementation in exit area ‘AW – Web Layout’. Now you can set for a template on the layout tab writer the WEB layout to the custom layout. You will have to call always the HAP_DOCUMENT BSP in the web, and then the standard BSP will make sure the correct custom BSP is called.

Objective Setting & Appraisals within the web environment

To run OSA in a web environment a portal is not necessary. You will need to call on of the following document list pages.

Manager
documents_todo.htm – All open documents where the user is appraiser or part appraiser. The page can also be used to create new appraisal documents.
documents_created.htm – All documents in status ‘completed’ or higher where the user is appraiser
Employee
documents_received.htm– All documents in status ‘completed’ or higher where the user is appraisee
documents_received_open.htm – All open documents where the user is appraisee in display mode
documents_received_open2.htm – All open documents where the user is appraisee in change mode
Other
documents_where_participated.htm – All documents where the user is further participant

When a list page is not providing the data needed for your process you can copy an overview page and adapt this. For example of you want the employee to be able to trigger the appraisal process you can copy the documents_todo.htm and replace appraiser with appraisee. Also you will need to change the data provider, this can be done by replacing the data provider with a call of function module HRHAP_DOCUMENT_GET_LIST_XXL.

All the pages can of course also be included in a portal iview as part of your MSS or ESS process. Important here is to set the parameter SESSION_HANDLING_OFF in the list pages on true. This to avoid conflicts between the portal and the BSP session handling.

Another important parameter, independent of the portal, on the list pages is MODE. A common situation is that an employee needs to approve or reject his completed appraisal. He goes to his list (documents_received_open2.htm) and selects his document. The approve and reject button are there but inactive. This is due to the MODE parameter being initial. Set this to ‘X’ to enable the status change buttons after completion.