ESS Personal information scenario is one of the most commonly and heavily customized scenario. With Enhancement package 5 a newly architected ESS Personal profile was released based on WD ABAP and FPM. The backend parts remained mostly same as JAVA scenarios but some new layers and customizing options are introduced. This blog gives  “Architectural Deep-Dive” to understand what are extension possibilities and in which layers.

This blog assumes that you are familiar with basic infotype concept, with using customizing tables, BAdIs and FPM configurations.

See diagram below to understand layers of coding and configurations

Layer 1: PA Infotype framework

IMG: Personnel Management -> Personnel Administration -> Customizing Procedures -> Infotypes

ESS personal information scenario uses “Decoupled Infotype framework”  . In this layer the actual business logic is implemented. This logic is independent of ESS and is reused in other layers as well. The logic is implemented by means of a business logic check class.  If you decide to implement a change in logic of existing infotype or decided to create a new infotype then you start at this layer.

Customizing options

Transaction PM01 – Enhance or create new infotypes

Business logic check classes: V_T582ITVCLAS, V_T582ITVCHCK

BAdIs:

HRPAD_SUBTY_CHECK – Validation of permissible subtypes (normally not needed due to standard customizing tables)

HRPAD00INFTYBL – To create customer specific validations and update logic

HRPAD00INFTYDB – To write DB update logic (e.g. to write additional customer tables or log tables)

Customizing field attributes: V_T588MFRPOPS (SAP standard), V_T588MFPROC (customer specific)

Test Transaction: PUIT_UI can be used to validate the changes made

Layer 2: PA UI Conversion Layer

IMG: Personnel Management -> Personnel Administration -> Customizing Procedures -> Infotypes

In this layer the infotype structures are adapted so that they can be easily consumed in UI consumption layers built above. Screen structures are created so that they have fields required for UI layers like description and text fields, fields from infotype views ..etc. For infotypes which have repeat fields (like wagetypes in 0008) line structures are created. For each UI structure a conversion class (defined in T588UICONVCLAS) is used which performs input/output conversion from infotype stuctures to screen structures. In this layer the screen structures are created such that each country version has its own structure.

This layer needs to be considered if you have created a custom infotype or extended standard infotype structures with custom fields which require some explicit input/output conversion.

You can use this layer if you need to change some metadata of UI fields (like mandatory, hidden)

Customizing options

Transaction PM01 – Enhance or create new infotype UI parts

UI Logic Conversion classes: V_T588UICONVCLAS

BAdI: HRPAD00INFTYUI – To write UI conversion logic, mapping of fields and field attribute determination

Test Transaction: PUIT_UI can be used to validate the changes made

NOTE: Enhancements done in Layer1 and Layer2 are independent of ESS and are also applicable for other scenarios like HCM Processes and Forms and in future releases for HR Administration UI. If you write any logic or change any attributes then they will be also applied in other UI screens

Layer3: ESS Adapter Layer

IMG: Personnel Management -> Employee Self-Service (Webdynpro ABAP) -> Service-Specific settings  -> Personal Information

On top of UI conversion layer ESS Adapter CL_HRPA_PERNR_INFTY_XSS is developed. This layer performs ESS specific operations like Create,Read,Update,Delete. This layer performs some specific extensions to business logic by providing specific customizing options.

Examples of customizing options: ESS specific timeconstraint handling also known as ESS use cases which control visibility of Create, Delete, Update buttons and display of validity fields. This layer also restricts which subtypes are allowed for ESS. In this layer also specific logic of reuse of country version structures for other countries are allowed.

Customizing options

V_T7XSSPERSUBTY – Assign permissible infotypes and Use cases (time constraints and validity periods)

BAdI HRXSS_PER_SUBTYPE – Programmatically control visibility of subtypes and use cases that can not be statically defined via V_T7XSSPERSUBTY

V_T7XSSPERFORADD & BAdI: HRXSS_PER_FOREIGN_ADDRESS  – Define permissible Foreign Address handling

V_T7XSSREUSEUISN – Allow reuse of country versions screens in other country versions

BAdI: HRXSS_PER_BEGDA – Control visibility of records and set default begin dates[GK1] . For e.g., to enable past data editing. Or, restrict editing to starting from future date – for e.g., begin of next month.

Layer4: BOL/GenIL layer

IMG: Personnel Management -> Employee Self-Service (Webdynpro ABAP) -> Service-Specific settings  -> Personal Information

The Business Object Layer (BOL) model is a programming concept that allows for uniform application development, decoupled from interface changes in the underlying business-object-specific Application Programming Interfaces (APIs).

This layer initially built for CRM UI is now used in many business suite applications.

For HCM the model name is HRPAD. As of now this model is used for ESS but in future releases this model is used for even HR Administration scenarios. The model is implemented by a Generic Interaction Layer class CL_HRPAD_IL.

This layer needs to be considered only when a new custom infotype needs to added.

Customizing options

Transaction: HRPAD_EDIT_MODEL – To introduce new infotypes

Transaction: GENIL_MODEL_EDITOR – To check and transport models

Test Transaction: GENIL_BOL_BROWSER  can be used to validate the changes made and data is visible in BOL (This transaction needs some knowledge and not very easy to test)

Layer 5: ESS UI Layer using FPM

FPM Layer offers countless number of possibilities to enhance the standard applications so you need to decide what really needs to be changed and for which portions you want to copy standard configurations or feeder classes.

http://scn.sap.com/community/erp/hcm/employee-self-service/blog/2012/06/07/enhancing-essmss-wd-abap-applications-based-on-fpm

Layer 5.1: UI Feeder classes

Personal information Overview and detail screens are built using FPM GUIBB. The metadata, actions and events are processed using FPM feeder classes CL_HRESS_PER_OVERVIEW and CL_HRESS_PER_DETAIL. In some cases there may be infotype specific feeder classes.  In case if you are not able to achieve logic enhancements using any layers below then this is your last fallback option.

Layer 5.2: UI Configurations

Personal information scenario uses FPM Overview floorplan (OVP).  HRESS_CC_PER_OVP is the component configuration that can be enhanced to add/enhance the UI blocks

For every infotype screen a list and detail configuration is created. Example HRESS_CC_PER_OVR_BANK_XX and HRESS_CC_PER_DTL_BANK_XX. You need to enhance these to create customer specific configurations

Layer 5.3: UI Composition Configuration

Personal information profile uses various country specific configurations dynamically. This is achieved by Application controller component HRESS_C_PERSINFO_CONFIG. You can configure HRESS_CC_PER_CONFIG to dynamically replace the UIBBs.

In standard implementation the dynamic assembly is done based country/molga of employee but you can use BAdI HRESS_PER_CONFIG_KEY so that other parameters like Employee group, Subgroup can also be used.

WD ABAP Application

WD Application HRESS_A_PERSINFO is used with application configuration HRESS_AC_PERSINFO. You can also pass some application parameters to influence the UI behavior (e.g. starting from enhancement pack 6 you can make profile read only)

Some typical scenarios to enhance ESS Personal profile

Note: You have many alternative ideas to implement every scenario but this table just gives a guidance

Layer 1-4 requires backend customizing and development knowledge to implement BAdI

Layer 5 requires FPM knowledge

Apart from this you may go for implicit coding enhancement options at various layers but it is not recommended since SAP may change internal processing logic in future releases.

If you have more scenarios which you have customized using different technique then do let me know and I can try to include them in the blog!

Customers and Consultants always have questions about possibilities and recommendations for adopting ESS Menu. This blog tries to address certain topics that will help to make decisions for best possible apporach that fits your requirements. This blog is not meant to give a step by step instructions since there are already few discussion/blogs on this forum regarding this.

First of all always read documentation:

http://help.sap.com/erp2005_ehp_05/helpdata/en/ae/f1788ae9084f0bb85c962b9e38c2ed/frameset.htm

Question 1: Why so many roles - PFCG role, Launchpad role and Portal role and what should I use?

Launchpad Role: Launchpad role/instance is required to visualize the ESS menu using WD ABAP application HRESS_A_MENU with configuraiton HRESS_AC_MENU. This application uses a WD Component that reads the lauchpad role/instance (ESS/MENU) and displays the UI.

PFCG Role: PFCG role is required for 2 purposes. The first purpose is very important since it is how the backend ABAP server decides the authorization profile for performing activities. Second purpose is for UI visualization if customer wants to use NWBC HTML or NWBC Desktop version instead of SAP Portal. This role acts as entry point for menu rendering. Standard SAP role is SAP_EMPLOYEE_ESS_WDA_1

Note: Even in case of NWBC HTML or Desktop version you can use the WD Application HRESS_A_MENU and instead of NWBC visualization you can use launchpad based menu. In case of NWBC It is recommended to use the default NWBC visualization since it is a lightweight stateless UI.

Portal Role: Portal role is required in case you use SAP Enterprise portal to provide an entry point. Portal role provided with Business Package for Employee Self-Service (WDA) 1.50. This is a lightweight role which just has few iViews. Most important iView contains menu application (HRESS_A_MENU) and few other iViews for navigation purpose (OBN).

In Summary:

For Portal customers you need: Launchpad role (UI Visualization), PFCG role (authorization), Portal role (entry point)

For NWBC customers you need: PFCG role (UI Visualization + authorization)

Question 2: How to customize Launchpad role?

Most common misunderstanding is that standard role ESS/MENU must be copied. Customers are allowed to edit standard launchpad since SAP maintains a different version for SAP and customer. Even if SAP ships changes then customer version is not overwritten. At any point customer can see SAP delivered version even if they add/edit some entries in ESS/MENU. You can see a menu in LPD_CUST -> Extras -> Show SAP Version

Steps if you directly edit standard launchpad role ESS/MENU:

• Just edit ESS/MENU directly using transaction LPD_CUST

Steps if you copy standard role launchpad ESS/MENU:

• Copy and change launchpad role using transaction LPD_CUST
• Create a new Application/Application Configuration, Copy the Component configuration (alternatively in config/admin mode or enhancement mode change the component configuration)
• In the component configuration add the new/copied launchpad role
• In Portal copy the standard BP (with delta links) and create/copy the iView for Menu application and change the application/Application configuration parameters (this step is not required if you enhaced/configured standard component configuration)

Still wondering which way to proceed?

Note: For PFCG and Poral role customizing there are established practices so this blog will not discuss this point.

Question 3: I need different menu for different set of users, how to proceed?

Most common requirement is that I have different set of services offered based on employee groups, regions and what not ....

There are 2 choices:

Choice 1: Dynamic menu rendering

In this case you create only 1 launchpad role/instance (or PFCG role) and based on BAdI HRESS_MENU you decide which users get which links visible. In SAP standard implementation only COUNTRY is used decide which applications are visible per country of user

Note: Same BAdI works for PFCG based roles as well since NWBC processes the BAdI at runtime after PFCG tree is built

Steps:

• Go to LPD_CUST or PFCG depending upon access channel or portal or NWBC, Select roles and define application alias for every application where dynamic filtering should happen
• Create a BAdI implementation and assign alias as a filter value, implement your own logic

Advantages:

• No duplicate copies of same applications in different roles
• A common portal/pfcg role can be assigned to all users.
• No change in role assignment required for different set of users whenever they move across organizations, jobs, locations, countries (Global employment)

The only disadvantage is you need ABAP programmer to do this BAdI but is that a real problem?

Choice 2: Static menu structure and duplicate copies

Steps:

• Create multiple role/instance in LPD_CUST or PFCG roles (you may use the repository type of launchpad to reduce maintenance)
• Create multiple copies of Application Configuration, Component Configurations (not required for NWBC)
• In case of Portal consumption - Create multiple iViews for menu application and create multiple roles with different entry points
• Assign Portal roles to users or PFCG roles to users
• Forever maintain whenever employees change their organizations, jobs, locations ..etc

Disadvantages:

• Multiple copies of roles leads to long term maintenance
• Additional efforts for copying of WD configurations and portal iViews and roles
• User maintenance is more complicated

Still wondering which way to proceed?

Question 4: I need better visualization and custom pages, integration in other portals (e.g. Sharepoint)

Many customers decide to go this way by creating static/dynamic custom HTML pages, portal content editing tools to create menu structures. This option is always available but more expensive to implement and long term maintenance.

Check these blogs which may help

Embedding WD ABAP Self Services in custom buit pages and external portals

Adding custom pages (HTML or simple text) in ESS Homepage/Areapages (WD ABAP)

As you can see there are lots of configuration possibilities and Hope this information helps in making better informed decisions regarding which way to go.

Do let me know with your comments if there are more scenarios that you have faced which made you to go in a different solution direction!!!

Some customers (who were earlier using WD JAVA ESS and Homepage customizing) are using the homepage framework feature to add custom help pages/additional info pages on the ESS Areapages. This feature is not supported out of the box in the new WD ABAP ESS homepage based on launchpad customizing. The main reason for dropping this feature was to simplify ESS menu definition and encourage the use help center and related links concept. In addition many customers did setup complete homepages using content development tools and deployed as HTML without using homepage framework.

This blog explains how this gap in WD ABAP UI can be plugged easily by customers and include HTML pages on areapage level in new ESS menu based on WD ABAP and launchpad customizing. You can use examples in this blog and create more scenarios to dynamically embed content.

Note:

• This blog is meant for WD ABAP developers with basic FPM knowledge and does not explain every minor detail or step to create WD Objects
• The topics mentioned here are only applicable for service map using WD ABAP application HRESS_A_MENU and launchpad customizing
• In this simple example the App Controller and UIBB are implemented in same WD Component but in real projects you may create different implementations

Steps:

• First Step: Create a new WD Component that has capability to display some custom html webpages
  • Create a view and include iFrame element (iFrame example was chosen to display a webpage but you are free to decide)
  • Create component controller and context variables so that a URL/Content to be displayed can be bound to iFrame element
• Second Step: Make sure that WD Component implements following interfaces so that this can be used in FPM configurations. You can add intefaces from the main property page of WD Component (see tab implemented interfaces next to tab used components)
  • IF_FPM_OVP_CONF_EXIT - For usage in OVP floorplan that is used in application HRESS_A_MENU
  • IF_FPM_UI_BUILDING_BLOCK - To be used as UIBB in OVP floorplan
  • In the method OVERRIDE_EVENT_OVP program the code so that based on the selected area page you can display a particular HTML page in addition to service map (sample code attached)
  • In the sample code there is a example that for a target foler (areapage) launched from homepage a particular help web page is displayed in every areapage. You can decide your own logic to decide which help page should be displayed. In our example a folder alias defined in Launchpad customizing is used to decide which help page can be displayed. If you do not want to harcode the helppages then you need some customizing table where mapping is stored. You can implement your own logic to decide what needs to be displayed in help UIBB
• Third Step: Include the WD Component in FPM configuration
  • In HRESS_CC_MENU_OVP or copied customer configuration go to Edit page (page id CONTENTAREA_2) and add UIBB that was created in First step
  • Go General settings -> Floorplan settings -> Application Controller settings and make sure that WD component created in First step is added as Application Controller
  • Decide on layout options if the help pages are displayed side by side or below using standard FPM options of 1 column layout or 2 column layout

Congratulations. You should be done !! 

With this custom UIBB now you are able to display specific HTML pages (or any other information) you like in addition to standard service map displayed from Launchpad customizing. You can try out various variants to think of more customized stuff you want to create in your custom UIBBs.

Hope this blog helps you to provide a basic understanding of how developers can add custom UIBBs to ESS homepage.

If you have done some similar intersting implementations for Homepage then share them with community.

Feedback/comments welcome if you find this useful.

***********************************************************************************

Detailed Screenshots:

Step I & II: Create WD Component and Views, Implement FPM interfaces

Step II: Code snippet for OVERRIDE_EVENT_OVP

METHOD override_event_ovp .

  DATA: lt_content_areas TYPE if_fpm_ovp=>ty_t_content_area,
        ls_content_area  LIKE LINE OF lt_content_areas,
        ld_link_text     TYPE string,
        lr_event         TYPE REF TO cl_fpm_event,
        lr_parameter     TYPE REF TO if_fpm_parameter.

  DATA:  lv_target_folder_alias TYPE string,
         lv_target_url          TYPE string.

  lr_event = io_ovp->get_event( ).

  IF lr_event->mv_event_id = if_fpm_constants=>gc_event-change_content_area.

    CALL METHOD io_ovp->get_content_areas
      IMPORTING
        et_content_area = lt_content_areas.

    READ TABLE lt_content_areas INTO ls_content_area WITH KEY id = 'CONTENTAREA_2'.
    IF sy-subrc = 0.
      lr_parameter = lr_event->mo_event_data.
*      lr_parameter = io_ovp->mo_event->mo_event_data.
      lr_parameter->get_value(
        EXPORTING
          iv_key = if_fpm_guibb_launchpad=>gc_link_text
        IMPORTING
          ev_value = ls_content_area-title ).
* Set the title to be displayed
      TRY.
          CALL METHOD io_ovp->change_content_area
            EXPORTING
              is_content_area = ls_content_area.

        CATCH cx_fpm_floorplan .
      ENDTRY.

* get the folder alias that was clicked in the homepage
      lr_parameter->get_value(
        EXPORTING
          iv_key = 'TARGET_APPLICATION_ALIAS'
        IMPORTING
          ev_value = lv_target_folder_alias ).

*    Change the html help area based on the target folder alias
*    You can implement any logic you want and pass the context atttributes for the target view

      DATA lo_nd_helpnode TYPE REF TO if_wd_context_node.
      DATA lo_el_helpnode TYPE REF TO if_wd_context_element.
      DATA ls_helpnode TYPE wd_this->element_helpnode.
      DATA lv_helpurl TYPE wd_this->element_helpnode-helpurl.

* navigate from <CONTEXT> to <HELPNODE> via lead selection
      lo_nd_helpnode = wd_context->get_child_node( name = wd_this->wdctx_helpnode ).

* get element via lead selection
      lo_el_helpnode = lo_nd_helpnode->get_element( ).

      IF lv_target_folder_alias = 'AREA_PERS_INFO'.  "Name of alias in launchpad
        lv_helpurl = 'http://en.wikipedia.org/wiki/Employee_Self_Service'.
      ELSEIF lv_target_folder_alias = 'AREA_WORKING_TIME'. .
        lv_helpurl = 'http://en.wikipedia.org/wiki/Working_time'.
      ELSE.
          lv_helpurl = 'http://help.sap.com'.
      ENDIF.

      lo_el_helpnode->set_attribute(
        name =  `HELPURL`
        value = lv_helpurl ).

    ENDIF.
  ENDIF.

ENDMETHOD.

Step III: Include the WD Component in FPM configuration

And Finally the results

Result 1: Showing Personal Information Area page

Result 2: Showing Record Working Time Area page

SAP delivered with enhancement pack 5 (Business Suite Innovations 2010) & MSS Add-on 1.0 WD ABAP based Self Services UI. The main focus of this delivery was to improve the end user efficiency, effectiveness and intuitiveness based on new UI guidelines. Additionally we addressed many TCO drivers in terms of offering the solution with much UI configuration possiblities and offering the self services without bundling with SAP Enterprise Portal.

With new offering of ESS/MSS there was still a feedback from customers (and our sales folks) that the new UI should look modern, have new fresh icons, remove too many shades of blue in the screen.. etc. For sure there are theming possiblities that are well known using theme editor in portal environment but there is effort to adjust look of WD ABAP applications to detailed level (some things like icon changes not possible). Due to efforts many customers did not do extensive theming efforts of applications but only adjusted shell areas in portal and branding. There was also additional issues related to upgrade of themes with backend upgrades.

To address this we started with a project jointly between Visual designers, rendering experts, application developerss to provide a new visual identity for ESS/MSS applications (to be followed in other HCM and suite areas later). This new visual identity is called by a theme SAP_CORBU. Corbu derives name from Le Corbusier a Modern Swiss architect and designer . The name also indicates the goals that the new theme should be modern, neutral so that it fits very well with various shells/portals and simple from look and feel perspective.

This new theme is now released for ESS/MSS customers based on enhancement pack 6 (Business Suite Innovations 2011). Theme objects are available from NW 7.31 SP02 with enhancements in SP03. Release information and restriction of usage of this can be found in SAP Note 1681640.

What do you get with this theme?

• A new modern, simple looking theme that improves overall look of Self Services; Increased sizes and fonts improves readability
• Newly adopted NWBC HTML shell that matches new theme for applications
• HCM specific flash islands (including Nakisa Org chart viewer) matched to new theme
• Neutral and better fitments of color scheme when used in non SAP portals like sharepoint
• Large set of new icons and pictograms that are modernized with new theme without affecting existing icons in older themes
• Enhanced look for specific controls example: panel stack
• Possibility to activate the theme per backend system and per application (ignoring portal theme when used in SAP Portal environment)

Is there any impact on custom WD ABAP applications?

• In most cases there are no effort for applications since the new theme works for all WD ABAP applications out of the box. However visual verification of UI is recommended to be performed to check for any truncation of texts or misalignment due to increased font sizes and line height
• If applications have used old icon library ICON_* then new icons will not be loaded. Only icons ~icon/* can be used. Please see note 1681640 for details

Hope you like this theme and we would love to hear how you perceive this new theme as a self service developer and end user for self services.

I have attached some comparison screenshots that I find most intersting to give overview of new look.

Screenshot1: Shows the newly designed NWBC HTML shell and pictograms (rendering the ESS Service map based on PFCG role)

Screenshot2: Shows the newly designed MSS Homepage with team view flash islands themed for Corbu

Screenshot3: Shows the employee profile with new panel stack visualizations and complete new icon set

Screenshot4: Shows the employee leave request with new panel stack visualizations, calendar design