Chat Support

Gaurav Joshi
Collaboration & Knowledge Sharing
The chat support portlet named “May I Help You?” is a production ready chat support system for Liferay DXP / 7, which after deployment, is available under collaboration category . The portlet can also be easily used for peer to peer communication. The chat has fastest performance comparable to leading chat platforms. It renders excellent display in mobile and tablets along with desktop and larger screens. It is implemented using industry strength components like [Google closure templates], [Vert.x] and [nodejs] with the help of [Vert.x Integration module].
The portlet is highly configurable. The system configuration is available under System setting >> Collaboration tab. The portlet also has portlet instance configuration for various aspects like portlet user category selection, default images and CSS for some chat div’s. The portlet CSS can also be modified within custom theme as there is no extra custom CSS used in the portlet UI.
The portlet uses only standard UI components from Liferay lexicon and bootstarp3 for UI customization flexibility. The portlet can be scoped system wide (default), portal instance wide, site wide and in page scope. The portlet has three modes (non-portlet) in portlet configuration, to render different UI for each selection. This mode selection along with page level permissions facilitates the access control for the portlet. For example, a page can be permissioned to be visible by only service operators (via Liferay role) and on this page service operator mode can be selected for the portlet. This will enable only service operators to access the page with service operator UI. The portlet on guest pages can have guest mode to render guest specific UI etc. The adding and removing of guest, members and service operator in the user list is implemented in real time without page refresh and without any polling. The implementation is event driven with the help of an industry strength bus system. There are two list, one containing guest (un-registered users) and members (registered non service operators) and the other containing service operators. The guest users are uniquely identified with the help of niche and reliable browser identification technique. Clicking an item in service operator list transfers the current live chat session to the clicked service operator. A guest user is free to send messages which are displayed to all service operators in left hand side panel on top right. However, the chat session can only be started by a service operator. The service operator on starting session gets all the chat history of the guest so that he can know the problem. If the service operator closes the chat session, the guest messages are again stored in history list on server. The history list is closed when the guest navigates away from the portlet / page. The members can also chat by selecting the member mode.
The chat port (7929) is different than the portal port, so please make sure that it is open from client / browser. The port can be configured from System setting as mentioned above.
The module is open and flexible for further enhancements as per specific user requirements. Some implementations are disabled for various reasons, like encryption of data over wire. This can be enabled on request with choice of algorithm, if feasible. The LZW-encoded / decode and Base64 are currently available / implemented in the module.
Please send queries, bugs and feature requests to [email protected]. It would be great if subject lines can start with Query: Bug: and Ftr: for filtering convenience.
Please do visit documentation URL for full details of the module and it's configuration.
----------------------------- Links -----------------------------
[Vert.x Integration module]
[Google closure templates]
The instance configuration requires a bundle that implements configuration provider. The implementation is distributed as a bundle called Liferay Portal Configuration Module Configuration. Please check version of Liferay Portal Configuration Module Configuration from gogo shell as below (terminal screen shot above)
lb | grep Module
download the appropriate module from below link if the module is not found by above command https://mvnrepository.com/artifact/com.liferay/com.liferay.portal.configuration.module.configuration/
DXP with FP27
https://mvnrepository.com/artifact/com.liferay/com.liferay.portal.configuration.module.configuration/ 2.0.10
Liferay CE 7.0 GA4
https://mvnrepository.com/artifact/com.liferay/com.liferay.portal.configuration.module.configuration/ 2.0.8
Liferay CE 7.0 GA3
https://mvnrepository.com/artifact/com.liferay/com.liferay.portal.configuration.module.configuration/ 2.0.3
Please verify and install the correct implementation.
[Configurable modules]
Liferay is trademark of Liferay, Inc., Liferay International Limited and/or Liferay Affiliate, registered in the United States and/or other countries.
  • 1 standard instance, perpetual: 300.0 USD
  • 5 standard instance, perpetual: 400.0 USD
  • 10 standard instance, perpetual: 500.0 USD
  • 50 standard instance, perpetual: 650.0 USD
  • 500 standard instance, perpetual: 800.0 USD
  • 1 developer instance, perpetual: 10.0 USD
  • 10 developer instance, perpetual: 25.0 USD
  • 30 developer instance, perpetual: 30.0 USD
  • 50 developer instance, perpetual: 45.0 USD
  • 500 developer instance, perpetual: 100.0 USD
All prices displayed are in USD. For pricing specific to your country/currency, please follow the installation instructions below for accessing and purchasing this app through your Control Panel.
Release Summary and Release Notes
Version Change Log Supported Framework Versions Date Added
Liferay CE Portal 7.0 GA3+
Liferay CE Portal 7.0 GA4+
Liferay DXP 7.0 GA1+
Gaurav Joshi
Published Date
September 09, 2017
Supported Versions
Help & Support
Terms & Conditions

Installation Instructions

This is a Legacy App that is no longer available in the new App Marketplace. You are able to acquire it from your installed DXP or CE instance and install it by following the instructions below.

Acquiring this App through the legacy Liferay Portal Store

  1. Review app documentation for any specific installation instructions.
  2. Login to your Liferay Portal instance with administrative permissions.
  3. Navigate to the Control Panel, Marketplace (or Apps for 7.3 and prior), then Store.
  4. If needed, login to your Liferay.com account by choosing Sign In.
  5. Search for the app name in the Search dialog.
  6. Once the app is found, click on the app in the search results.
  7. On the app details page, choose to acquire the app by selecting the Free, Buy, or Trial button.
  8. Follow the instructions on the screen to complete the acquisition.

Installing this App through legacy Liferay Portal Purchased Apps

  1. After acquiring the app, login to your Liferay Portal instance with administrative permissions.
  2. Navigate to the Control Panel, Marketplace (or Apps for 7.3 and prior), then Purchased.
  3. If needed, login to your Liferay.com account by choosing Sign In.
  4. Click the Install button to install your app on your Liferay Portal instance.

See the legacy App Marketplace help documentation for more information.