Liferay User setting navigation override

Liferay

Problem: Liferay gives lots of user settings. Here we provide a solution for removing or hiding unnecessary settings.

Solution: We want to customize it better to remove the unnecessary settings from the user setting navigation.

Benefits : 

  • The Liferay default user setting with some user settings and customize it according to user need.

Prerequisites :

  • Java 
  • Liferay  portal 7.2 +
  • Basic knowledge of Liferay

Environment Requirements :

  • JDK 11
  • Eclipse/Liferay Dev Studio
  • Liferay Portal
Create a Liferay fragment module using the following steps.
  1. Go to Liferay workspace project → modules → new
  2. Select other → Liferay → Liferay Module Project Fragment
  1. Enter the project name.
Navigate to Liferay workspace project
  1. If you don’t have configured the server follow the following steps:
    1. Go to the “windows” setting on the eclipse navigation bar
    2. Select the “show view” -> “other”.
    3. Search servers
Configure server in Eclipse for deployment
    1. Now open the “Servers”.
    2. Create a new server.
Open Servers and creating new server
    1. Select the Liferay server configuration from the menu and press “next”.
Choose Liferay server config
    1. Browse your Liferay in your local and select the Liferay.
Explore Liferay and choose your local option
    1. Press “next” and after that press “finish”.
    2. The Liferay server has been configured and started.
  1. Click on “Next”. And select the following Icon. to browse.
Adding host OSGi bundle
  1.  the “com.liferay.users.admin.web” jar file of user-admin-web.select the jar.
Selecting host OSGi bundle jar file
  1. Select the “Add File From OSGI”.
Selecting override file from liferay icon
  1. Select the following files.
    1. edit_user.jsp:-
      • This file resides in the path “META-INF/resources/edit_user.jsp”.
List of available ODGi bundle to override
  1. Click on “finish”. Finally, a fragment module has been created.
  2. Now, We have to update the “edit_user.jsp” file. 
  3.  we have to add an if statement to only add a custom screen navigator id if the portlet id is equal to my account portlet id. Luckily this is easy to do since my account portlet id is set in the init.JSP
				
					// Update formNavigatorId
/* Begin override of My Account */
//initialize to the real form navigator id.
String formNavigatorId = 
UserScreenNavigationEntryConstants.SCREEN_NAVIGATION_KEY_USERS;
if (portletName.equals(myAccountPortletId)){
    // include the special prefix 
    formNavigatorId = "my.account." + formNavigatorId;
}
/* End override of My Account */
  1. We have concat the “my.account” with the formNavigatorId. So We have to pass this updatedFormNavigatorId in <liferay-frontend:screen-navigation/>Key attribute.
				
					// Update Liferay_Frontend_screen_navigation
<liferay-frontend:screen-navigation
containerCssClass="col-lg-8 registration-sheet"
containerWrapperCssClass="container-fluid container-fluid-max-xl  container-from-lg scad-user-setting"
context="<%= selUser %>"
key="<%=formNavigatorId%>"
menubarCssClass="menubar menubar-transparent menubar-vertical-expand-lg"
navCssClass="col-lg-3 rounded bg-light registration-tabs p-2"
portletURL="<%= portletURL %>"
/>
  1. It should be look like following with the updated edit_user.jsp
  2. With the help of updatedFormNavigatorId. The Liferay User Navigation Setting Will be hidden and We will get a blank screen if We access the user setting.
  3. So, We have to override the Liferay User navigation taglib to show specific user settings.
  4. There were two most important factors of liferay-frontend:screen-navigation which are following.
    1. ScreenNavigationCategory
      • This category will be responsible for the top-level navigation.
Admin account details screen
    1. ScreenNavigationEntry 
      • This Entry will be responsible for the left-side navigation.
Admin account details screen
  1. We have to take The navigation category and the navigation entry taglib classes from the source code that we have to show on the page.
  2. For example:-
    1. We want to show information and the password in the left navigation on user settings under the “general” category navigation.
    1. Then We want the following classes from the taglib from the source code of Liferay. From the following path.
      The blog follows the Liferay dxp 7.4.13.u24. 

/liferay-dxp-src-7.4.13.u24/modules/apps/users-admin/users-admin-web/src/main/java/com/liferay/users/admin/web/internal/frontend/taglib/servlet/taglib

    1. The classes are as follows.
      1. For the Category navigation.
        • UserGeneralScreenNavigationCategory
      1. For the Entry navigation
        • BaseUserScreenNavigationEntry
        • UserDisplaySettingsScreenNavigationEntry
        • UserInformationScreenNavigationEntry
        • UserPasswordScreenNavigationEntry
  1. Now, create a Mvc Portlet.
  2. Remove the portlet class and resource folder from the portlet.
  3. Create a constant named “ACCOUNT_PREFIX”. And assign value “”.that we have used in the “edit_user.jsp”. While updating the form navigator.
  4. Now add the following respective gradle/Maven dependency.
				
					// Required Dependency
compileOnly group: 'com.liferay',name:'com.liferay.users.admin.web'
  1. This dependency will include all the dependencies related to the User-admin-web.
  2. Now create two packages  
    1. com.liferay.user.setting.taglib.override.category
    2. com.liferay.user.setting.taglib.override.entry
  3. This package contains the files following.
    1. Category :-
      1. This package contains the classes that will show the categories on the liferay frontend navigation (Top most navigation).
      2. As per the example in the entry package we want the following classes that will be copied from the liferay source code.
        • UserGeneralScreenNavigationCategory.
          • We have to update the return value of the method “getScreenNavigationKey()”.
          • Concat the ACCOUNT_PREFIX with SCREEN_NAVIGATION_KEY_USERS.
				
					// Update Screen_Navigation_Key
@Override
public String getScreenNavigationKey() {
return
          LiferayUserSettingTaglibOverridePortletKeys.ACCOUNT_PREFIX +         
UserScreenNavigationEntryConstants.SCREEN_NAVIGATION_KEY_USERS;
}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.

    1. Entry :-
      1. This package contains the classes that will show the entries on the liferay frontend navigation (left navigation).
      2. As per the example in the entry package we will add the following classes that will be copied from the liferay source code.
        • BaseUserScreenNavigationEntry
          • We have to update the return value of the method getScreenNavigationKey()”.
          • Concat the ACCOUNT_PREFIX with SCREEN_NAVIGATION_KEY_USERS.
				
					// Update Screen_Navigation_Key
@Override
public String getScreenNavigationKey() {
return
          LiferayUserSettingTaglibOverridePortletKeys.ACCOUNT_PREFIX +        
UserScreenNavigationEntryConstants.SCREEN_NAVIGATION_KEY_USERS;
}
    1. Now set the JSP renderer on the entry classes that you want to display on the user navigation setting some are following.
      1. UserDisplaySettingsScreenNavigationEntry
      2. UserInformationScreenNavigationEntry
      3. UserPasswordScreenNavigationEntry
    1. We have to add the following set method of JSPRenderer in every entry class which redirects to the jsp page.
				
					// Required Reference(JSPRenderer)
@Reference(unbind = "-")
      public void setJSPRenderer(JSPRenderer jspRenderer) {
             this.jspRenderer = jspRenderer;
      }
Note:
  • We have to  set JSP renderer at every entry class method, Because we can’t set the JSP renderer the same as in the original implementation.
  • Otherwise it will be null at runtime.
  1. Now deploy both modules to the liferay server and access the user setting.
  2. You will see there are only available settings that you have defined in the “liferay-user-setting-taglib-override” module.
User display data of a user
Loading...

Related Blogs

Loading...

Trusted by clients around the world

    Alessandro Calò
    Alessandro Calò

    I’ve been working with Bhavin Panchani for about a year on our company’s Liferay-based customer portal. Bhavin is always very professional and organized, but also communicative and easygoing. He is super knowledgeable with the Liferay platform, but also works on other technologies that we use with no problem at all, and in a timely manner. I can see that he really cares about our product and is directly responsible for its success. Thanks IGNEK & Bhavin!

      Rick Van Dijk
      Rick Van Dijk

      Working with an Indian company for a project was new for me, so I didn’t knew what to expect concerning the time differences, the possible language barrier/ communication differences. In a project, you always need to know each other at the beginning, but after the first weeks of communicating back and forth concerning our idea, the project went off. With several different expertises that IGNEK has to offer, your project is in good hands in a timely matter. Not only the developing side (we uses liferay as a platform), but also the designs are smooth. In our project, which is quite a niche, IGNEK proves to think with you to provide the best solution. I would definitely recommend IGNEK for your liferay solution.

        Igor Ilic
        Igor Ilic

        Working with IGNEK is smooth like work with internal team. They are punctual, professional with realistic time estimation and pricing. I had no feeling that there is 4 hours in time difference while working with them. My full recommendation.

        5/5
        3 Reviews
        5.0
        5/5
        28 Reviews
        5.0

        Making the world a better place through constructing elegant hierarchies

        Linkedin Facebook Twitter Instagram

        COMPANY

        WHY IGNEK

        SERVICES

        CONTACT

        SALES
        CAREER

        © 2018-2024 IGNEK, Inc. All rights reserved