« Back

Embedding a portlet in web content

Company Blogs December 8, 2010 By Barrie Selack

 Many people have asked, "How can I embed a portlet in web content". It's actually quite simple, once you know how. So I'll walk you through it.

It;s done via a runtime-portlet tag. The actual syntax looks like this:

<div id="embedded-welcome-portlet">
  <runtime-portlet name="47" instance="4433" queryString=""/>
</div>

(47 is the Hello World portlet)
 
The divs are not necessary, but in order to style the embeded portlet later we need them there.
 
So here is the Structure for the web content with the three pieces of information to pass to the runtime-portlet tag. (If you want, you can use hard coded values in the template of the web content)
 
 
And the template for the web content..
 
 
The template contains...
 
<p>
This is web content, with an embedded portlet!
</p>
 
<div id="embedded-welcome-portlet-$instance-id.getData()">
   <runtime-portlet name="$portlet-id.getData()" instance="$instance-id.getData()" queryString="$query-string.getData()"/>
</div>
 
Where the values from the template are passed in. We're not using the query string for this example.
 
So when rendered, it looks like this...
 
 
And there we have the Hello World portlet in our web content. But I really don't like that frame and title, so lets use CSS to style it.
 
In the web content use the configuration (little wrench) and select "Look and Feel"
 
Then we'll put the CSS under "Advanced Styling" This will use standard portlet CSS styles to change the look. Below is what gets set. Here's where we use the div id to make sure we only style out portlet.

 

 

Then the rendered web content will look like this.

 

But what if you want to use your own portlet? No problem, just use the name it is given by Liferay. In this case we'll use the Web Form portlet since it's not a Liferay built in portlet.

 

 

And now the web content looks like...

 

If the embedded portlet has a configuration option, you can configure it like any portlet to have different values on every page. You can also use the portlet's own Look and Feel to remove the borders or set a custom title. The WebForm portlet does have it's own configuration options (Hello World does not) Unfortunately at this time, you cannot use it's own configuration Look and Feel to style it, as the Web Content that contains it, overrides it's styling. 

 

Since one of the parameters is an instance-id, you can have multiple embedded instances of the same portlet on the page as below.

And there you are! A portlet embedded in web content.

If you're interested in more leave a comment. Thanks for reading.

 

Threaded Replies Author Date
It is a good inception explained: Unraveling... Shepherd Ching December 8, 2010 8:10 PM
Ok, so I can put portlet instance in my... Szymon Gołębiewski December 9, 2010 3:48 AM
I added a section to the blog to explain this.... Barrie Selack December 9, 2010 4:51 AM
Same Web Content can be displayed automaticaly... Szymon Gołębiewski December 9, 2010 5:18 AM
Can you give me an example of what you would... Barrie Selack December 9, 2010 5:44 AM
For example I have news portal with such... Szymon Gołębiewski December 9, 2010 10:44 AM
this is very cool.. .thanks for sharing! Chris Whittle December 9, 2010 5:52 AM
Nice article, Barrie! Thanks for sharing Juan Fernández December 9, 2010 9:55 AM
very cool article. thanks barrie! Wilson Man December 9, 2010 10:00 AM
Thanks for sharing Barry. This is one of the... Mika Koivisto December 9, 2010 5:23 PM
Good article and good example how you can use... Sampsa Sohlman December 10, 2010 2:12 AM
Hi Barrie, we are using this runtime portlet... Olaf Fricke December 15, 2010 12:47 PM
Nice example.... Dhrutika Vyas December 15, 2010 9:37 PM
Wonderful example.. I tried this its working... Mohammed Azam December 15, 2010 11:13 PM
Hello, can You give a simple example how to... gofri _ December 16, 2010 12:46 AM
Like! Scott Lee January 18, 2011 11:09 AM
Hello Everybody! I'm a student come from... ly tm January 19, 2011 7:14 PM
Cool feature, but how do you set portlet... Francesco Marangi January 28, 2011 6:22 AM
I'm have real trouble getting this to work. I'm... Phill Pover March 21, 2011 7:47 AM
Okay, I fixed the first issue I was having... Phill Pover March 21, 2011 9:35 AM
A serious question... Can this runtime-portlet... Dave Weitzel March 23, 2011 6:51 AM
Hi, Thanks for Good Article.But I am not... vasv kumar July 19, 2011 12:05 AM
[...] Take a look at this blog entry Als... Anonymous July 26, 2011 6:54 AM
[...] Hi philip, you are right...you can also... Anonymous July 27, 2011 12:14 AM
What about WSRP: could both the embedding... P F August 4, 2011 2:10 AM
Hi I was wondering how you would use this to... Mat Gritt August 21, 2011 5:50 PM
[...] Please check this blog which explains how... Anonymous September 10, 2011 8:56 AM
[...] Here's another link that may help... Anonymous November 14, 2011 9:57 AM
do anyone say me how i search name and instance... Miguel Ángel González October 23, 2012 9:13 AM
Hi, All the pictures are gone. Thanks, Akos Ákos Gábriel December 17, 2013 7:22 AM

It is a good inception explained: Unraveling the portlet within the dream

http://www.cinemablend.com/new/inception-explained-unraveling-the-dream-wit­hin-the-dream-19615.html
Posted on 12/8/10 8:10 PM.
Ok, so I can put portlet instance in my webcontent. Does it mean that on every page that web content is displayed that portlet will have the same configuration? An when I change this portlet config will it change on all sites? As I recall I can have many pages with same portlet instance (for example by using Page Templates) but their configuration is separated for every page
Posted on 12/9/10 3:48 AM.
I added a section to the blog to explain this. If the embedded portlet has a configuration option, you can configure it like any portlet to have different values on every page. Thanks for your question.
Posted on 12/9/10 4:51 AM in reply to Szymon Gołębiewski.
Same Web Content can be displayed automaticaly on different pages of Portal. In such case you will have to configure you portlet on multiply pages. In websites as big as news portals you want have time to do that. Is there any way to prepare global configuration for portlet instance?
Posted on 12/9/10 5:18 AM in reply to Barrie Selack.
Can you give me an example of what you would you are trying to do?
Posted on 12/9/10 5:44 AM in reply to Szymon Gołębiewski.
this is very cool.. .thanks for sharing!
Posted on 12/9/10 5:52 AM.
Nice article, Barrie! Thanks for sharing
Posted on 12/9/10 9:55 AM.
very cool article. thanks barrie!
Posted on 12/9/10 10:00 AM.
For example I have news portal with such sitemap:
- home page
-- Sport
---- football
---- tennis
-- Moto
---- Cars
---- Vans

In news portals same web content is displayed in various places. In this case My article will be shown on pages like Cars, Moto and Home Page (beacuse it's about Batmans new batmobile). Now I want to show under that article a lists of other articles related to this one by tags. So I embedded Asset Publisher and configure it (using Cars page) to show "Web contents containing any tag: batmobile, car".

The problem is I want to define this configuration just once and for every place this article will be shown at (home page and Moto). Is there any way to do that?
Posted on 12/9/10 10:44 AM in reply to Barrie Selack.
Thanks for sharing Barry. This is one of the cool features that got me started using Liferay back in version 3.x.
Posted on 12/9/10 5:23 PM.
Good article and good example how you can use web content.

Adding portlet to wcm template was new for me - anyway with same principles, it is possible to integrate iframe, flash .. youtube.. etc. to Liferay also. This is just by clever using of Web content as configuration repository (which already have editor also).

Btw, how this effect on Liferay and page caching, mainly to cache filter, which does not recognize if the page has embedded portlets on resources (like theme)?
Posted on 12/10/10 2:12 AM.
Hi Barrie, we are using this runtime portlet tag since two years in our web sites as well. In most cases, it is just working fine.

But we encountered some limitations you should be aware of:
1. The tag can only be used in templates; raw HTLM articles just ignore it.
2. The portlets that are included via the runtime portlet tag are not considered when exporting a community into a lar file, doing staging or remote publishing.
3. If you include a web content portlet, it will not be found by a community search, because the entry in the JournalArticleSearchEntry table is missing.
4. You must not include a web content portlet into itself (i.e. use the instance id of the web content portlet that contains the runtine portlet tag as value). If you do so, you will end up with a stack overflow due to infinite recursion.

Best regards,
Olaf
Posted on 12/15/10 12:47 PM.
Nice example....
Posted on 12/15/10 9:37 PM in reply to Olaf Fricke.
Wonderful example.. I tried this its working .But My question is is that possible to show the embedded portlet only to the user who has logged in
Posted on 12/15/10 11:13 PM.
Hello,
can You give a simple example how to embed (core) portlet in another portlet (in view.jsp)? Which libs and tld will be needed?
Posted on 12/16/10 12:46 AM.
Posted on 1/18/11 11:09 AM.
Hello Everybody!
I'm a student come from VietNam!
I'm studying about Richface framework!
I had got a problem in JSF(Richface) Portlet when I used JavaScript!
That problem is : I could not get a value into a <h:inputText /> with JavaScript!
Can anybody help me?
Thank you very much!

This is my code:

<ui:composition xmlns="http://www.w3.org/1999/xhtml"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:ui="http://java.sun.com/jsf/facelets"
xmlns:h="http://java.sun.com/jsf/html">

<f:view>
<script type="text/javascript">
function check() {
var result = document.getElementById("myform:form").value;
alert(result);
}
</script>

<h:form id="myform">

<h3>Hello :</h3>

<h:inputText value="" id="form" />

<h:commandButton value="OK" onclick="check();"/>

</h:form>

</f:view>

</ui:composition>
Posted on 1/19/11 7:14 PM in reply to Scott Lee.
Cool feature, but how do you set portlet preferences? I saw the runtime-portlet tag has a defaultPreferences attribute... how would you pass preferences in a VM journal article template?
Posted on 1/28/11 6:22 AM.
I'm have real trouble getting this to work. I'm running this from a development system, so the potential for a permissions issue is there, but even copying the Hello World example code above is not letting me put the portlet into my template.

What am I missing here? The portlet-runtime tag is coming through, but it doesn't appear to be getting parsed into an actual portlet.
Posted on 3/21/11 7:47 AM.
Okay, I fixed the first issue I was having (this ONLY works through the web content portlet, not asset manager or any of the others), but now I'm having an issue with the queryString parameter. I'm trying to invoke the webProxy portlet in a template and set the url of the page that the portlet is proxying, but no matter how I format the queryString, this is not working.

<runtime-portlet name="66" instance="1284" queryString="initUrl=http://somewebaddress.com"/>

Please help.
Posted on 3/21/11 9:35 AM in reply to Phill Pover.
A serious question...

Can this runtime-portlet tag be used in all other portlets (eg document and image "properties" or blogs and wiki)? I alos think it needs a bit more information - or a link to another blog/wiki article about the query string and other parameters that can be passed to the runtime-portlet tag.

You will see form my forum postings I have been trying to add a pagelet from a new portlet (handling Dublin Core categorization items) into a lot of other portlets but no one even suggested this tag. I would need to pass the current groupId and object Id (blog post etc) to make it work.
Posted on 3/23/11 6:51 AM.
Hi,
Thanks for Good Article.But I am not getting my custom portlets.I am getting Default portlets.
Posted on 7/19/11 12:05 AM in reply to Dave Weitzel.
[...] Take a look at this blog entry Als Antwort markieren [...] Read More
Posted on 7/26/11 6:54 AM.
[...] Hi philip, you are right...you can also customize that if you are embedding OOTB portlets for not showing icons and borders, Refer this link,... [...] Read More
Posted on 7/27/11 12:14 AM.
What about WSRP: could both the embedding portlet and the embedded portlet be WSRP portlets?
Thanks.
Posted on 8/4/11 2:10 AM.
Hi I was wondering how you would use this to insert a webform portlet in to the theme. specifically portal_normal.vm.

any help gratefully received
Posted on 8/21/11 5:50 PM in reply to Veronym Kroun.
[...] Please check this blog which explains how we can add or link a portlet from the Web Content . ~Kamesh Mark as an Answer [...] Read More
Posted on 9/10/11 8:56 AM.
[...] Here's another link that may help http://www.liferay.com/web/barrie.selack/blog/-/blogs/embedding-a-portlet-in-web­-content You can embed one web content within another... Flag Please sign in to flag... [...] Read More
Posted on 11/14/11 9:57 AM.
do anyone say me how i search name and instance of my runtime-portlet?

thanks you in advance
Posted on 10/23/12 9:13 AM in reply to .
Hi,

All the pictures are gone.

Thanks,
Akos
Posted on 12/17/13 7:22 AM.