The Proposals Wiki has been deprecated in favor of creating Feature Requests in JIRA. If you wish to propose a new idea for a feature, visit the Community Ideas Dashboard and read the Feature Requests Wiki page for more information about submitting your proposal.
« Back to FrontPage

Rules Based Portlet Rendering

This is "Work in Progress"#

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:

  1. Display a promotion portlet during first 7 days of every month.
  2. Display a portlet to users who login from IP address that matches 19.168..
  3. 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.

##

    1. Portlet Render Rules
  1. Specify comma separated render rules evaluator chain.
  2. The evaluator chain executes in the specified order and returns
  3. false when any one of them returns false.
  4. BasicRenderRulesEvaluator is a built-in evaluator which allows one to
  5. specify render rules based on user attributes, day, date and time.
  6. 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

1 Attachment
14438 Views
Average (2 Votes)
The average rating is 4.5 stars out of 5.
Comments
Threaded Replies Author Date
hi. i am using liferay 5.2.3 bundle.I am not... ankit yakkundi December 29, 2010 1:12 AM
Nice feature... It is available from which... Jay Patel March 17, 2011 10:56 PM
I've created an EXT plug-in for Liferay 6 that... Timmy M. May 6, 2011 6:53 AM
Tim - yes, we would be very interested in such... alex winner May 17, 2011 9:08 AM
Hi Tim, Can I use this to render portlet based... Rajender Reddy Nagulapalle March 26, 2012 1:06 PM
This post is really good, but how to get... Saurabh Gupta March 4, 2013 9:53 PM

hi.
i am using liferay 5.2.3 bundle.I am not able to find " Portlet Render Rules" under portal.properties stored under portal-impl.jar under \tomcat-5.5.27\webapps\ROOT\WEB-INF\lib directory.
Can you help from where i can get the above specified code?
Posted on 12/29/10 1:12 AM.
Nice feature...
It is available from which version of Liferay?
Posted on 3/17/11 10:56 PM.
I've created an EXT plug-in for Liferay 6 that enables this rule based portlet rendering. Somebody interested in it?
Posted on 5/6/11 6:53 AM.
Tim - yes, we would be very interested in such a plugin. Have you published or posted it anywhere?
Thanks,
-- Alex
Posted on 5/17/11 9:08 AM in reply to Tim FoX.
Hi Tim,
Can I use this to render portlet based on region? Like Aisa Pacific, Europe etc?
Posted on 3/26/12 1:06 PM in reply to alex winner.
This post is really good, but how to get RenderRules. i am using liferay 6.6.1 version. yes, Ia m interested in this, i want to show the particular portlet based on particular role.

Thanks in advance for helping me.
Posted on 3/4/13 9:53 PM in reply to Tim FoX.