This wiki does not contain official documentation and is currently deprecated and read only. Please try reading the documentation on the Liferay Developer Network, the new site dedicated to Liferay documentation. DISCOVER Build your web site, collaborate with your colleagues, manage your content, and more. DEVELOP Build applications that run inside Liferay, extend the features provided out of the box with Liferay's APIs. DISTRIBUTE Let the world know about your app by publishing it in Liferay's marketplace. PARTICIPATE Become a part of Liferay's community, meet other Liferay users, and get involved in the open source project. Wiki
Rules based portlet rendering
This is "Work in Progress"#
This article has been moved to the Proposals wiki, and is pending deletion on the Main wiki.
Requirement LPS-2909#
Portlets can be configured to have various permissions, like view, configure etc. , based on a role. But there is no way to control when the portlet will be rendered/displayed based on arbitrary rules using user attributes and date/time. Some examples are shown below:
- Display a promotion portlet during first 7 days of every month.
- Display a portlet to users who login from IP address that matches 19.168..
- Display a voter registration portlet to users who are 18 or older.
Solution#
A basic rules engine is provided, which can be enabled using portal.properties.
##
- Portlet Render Rules
- Specify comma separated render rules evaluator chain.
- The evaluator chain executes in the specified order and returns
- false when any one of them returns false.
- BasicRenderRulesEvaluator is a built-in evaluator which allows one to
- specify render rules based on user attributes, day, date and time.
- portlet.render.rules.evaluators=com.liferay.portal.security.permission.BasicRenderRulesEvaluator }}}
When the rules evaluator is enabled by uncommenting the above property, a new tab "Render Rules" shows up for each portlet under configuration.
The UI has a text field where you can enter rules as explained later below. This is a primitive UI which will be fixed soon to make it more intuitive and user friendly. LPS-2910
When a custom rules evaluator is plugged in, another row shows the text field where the rules can be entered for your rules evaluator.
The label for the text field can be localized by adding a key to Language.properties. The key should be of this format,
render.rules.evaluator.com.example.MyRulesEvaluator=My Render Rules
To hide the portlet completely, this property needs to be set.
layout.show.portlet.access.denied=false
To plugin you own rules evaluator, write a class that implements com.liferay.portal.security.permission.RenderRulesEvaluator interface.
public interface RenderRulesEvaluator {public boolean isRenderable(long userId, long groupId, String renderRule); } }}} Basic Rules Evaluator#
BasicRenderRulesEvaluator is the built-in evaluator that uses the basic rules engine.
Examples#
Now lets see how the sample requirements can be fulfilled.
1. Display a promotion portlet during first 7 days of every month but only on weekends.
Rule: date>=/1/&&date<=/7/&&(day==1||day==7)
2. Display a portlet to female users who login from IP address that matches 192.168..
Rule: user.attr.loginIP=192.168..&&user.attr.male!=true
3. Display a voter registration portlet to users who are 17 years and 6 months or older.
Rule: user.attr.age>=17.6
