Generic Templates Liferay 6.2

Before Liferay 6.2, each template had to be associated with a structure. Now, we can create a generic template and reuse its code for any structure. Generic templates can be embedded in other templates, which allows for reusable code,

Suppose you have three different web content articles and structures with similar requirements. Instead of creating three different templates from scratch, you can use the same generic template for all three and build off of it. This creates a smarter and more efficient process when creating a multitude of similar web content articles. Generic templates are created the same way as regular, structure-based templates. The only setting that differs is the Structure option, which you’ll need to leave blank to create a generic template.

Embedding Generic Template in other template:

In FreeMarker:
<#include "${templatesPath}/<generic-template-key>" />


In Velocity:

#parse ("$templatesPath/<generic-template-key>")

Refresh Portlet After Saving Custom Portlet Configurations

In Liferay custom portlet, when we save our custom configuration page, changes are not reflected without refreshing the portlet and we have to do it manually. Instead of this we can use following script in processAction method of Configuration class -


LiferayPortletConfig liferayPortletConfig = (LiferayPortletConfig) portletConfig;
String portletResource = ParamUtil.getString(actionRequest, "portletResource");
SessionMessages.add(actionRequest, liferayPortletConfig.getPortletId() + SessionMessages.KEY_SUFFIX_REFRESH_PORTLET, portletResource);
SessionMessages.add(actionRequest, liferayPortletConfig.getPortletId() + SessionMessages.KEY_SUFFIX_UPDATED_CONFIGURATION);


Hope it will be helpful.

Implementing Application Display Template in Custom Portlet

In the following post we will see how to implement Application Display Template to a custom portlet. We are assuming that we have a custom portlet as created in previous post.

Following are steps that we need to follow -


1. Create StudentPortletDisplayTemplateHandler.java class. This class extends BasePortletDisplayTemplateHandler class provided by Liferay.

	package com.test.template;
	import java.util.List;
	import java.util.Locale;
	import java.util.Map;
	import com.liferay.portal.kernel.language.LanguageUtil;
	import com.liferay.portal.kernel.portletdisplaytemplate.BasePortletDisplayTemplateHandler;
	import com.liferay.portal.kernel.template.TemplateVariableGroup;
	import com.liferay.portal.kernel.util.StringPool;
	import com.liferay.portlet.portletdisplaytemplate.util.PortletDisplayTemplateConstants;
	import com.test.model.Student;
	public class StudentPortletDisplayTemplateHandler extends BasePortletDisplayTemplateHandler{
	@Override
	public String getClassName() {
	return Student.class.getName();
	}
	@Override
	public String getName(Locale locale) {
	String students = LanguageUtil.get(locale, "students");
	return students.concat(StringPool.SPACE).concat(
	LanguageUtil.get(locale, "template"));
	}
	@Override
	public String getResourceName() {
	return "TestStudent_WAR_TestStudentportlet";
	}
	@Override
	public Map<String, TemplateVariableGroup> getTemplateVariableGroups(
	long classPK, String language, Locale locale)
	throws Exception {
	Map<String, TemplateVariableGroup> templateVariableGroups =
	super.getTemplateVariableGroups(classPK, language, locale);
	TemplateVariableGroup templateVariableGroup =
	templateVariableGroups.get("fields");
	templateVariableGroup.empty();
	templateVariableGroup.addCollectionVariable(
	"students", List.class, PortletDisplayTemplateConstants.ENTRIES,
	"student", Student.class, "curStudent", "name");
	return templateVariableGroups;
	}
	}

view raw StudentPortletDisplayTemplateHandler hosted with ❤ by GitHub

2. Declare StudentPortletDisplayTemplateHandler class in liferay-portlet.xml file.

<template-handler>com.test.template.StudentPortletDisplayTemplateHandler</template-handler>

view raw liferay-portlet-entry hosted with ❤ by GitHub

3. Configure permissions to allow users to manage application display templates.

	<?xml version="1.0"?>
	<!DOCTYPE resource-action-mapping PUBLIC "-//Liferay//DTD Resource Action Mapping 7.0.0//EN" "http://www.liferay.com/dtd/liferay-resource-action-mapping_7_0_0.dtd">
	<resource-action-mapping>
	<portlet-resource>
	<portlet-name>TestStudent</portlet-name>
	<permissions>
	<supports>
	<action-key>ADD_PORTLET_DISPLAY_TEMPLATE</action-key>
	<action-key>ADD_TO_PAGE</action-key>
	<action-key>CONFIGURATION</action-key>
	<action-key>VIEW</action-key>
	</supports>
	<site-member-defaults>
	<action-key>VIEW</action-key>
	</site-member-defaults>
	<guest-defaults>
	<action-key>VIEW</action-key>
	</guest-defaults>
	<guest-unsupported/>
	</permissions>
	</portlet-resource>
	</resource-action-mapping>

view raw templatestpermission hosted with ❤ by GitHub

4. Use tag to show ADT options in configuration jsp.

	<%@page import="com.test.model.Student"%>
	<%@page import="com.liferay.portal.util.PortalUtil"%>
	<%@page import="com.liferay.portal.kernel.template.TemplateHandlerRegistryUtil"%>
	<%@page import="com.liferay.portal.kernel.template.TemplateHandler"%>
	<%@page import="com.liferay.portal.kernel.util.GetterUtil"%>
	<%@page import="com.liferay.portal.kernel.util.Constants"%>
	<%@ include file="init.jsp" %>
	<liferay-portlet:actionURL portletConfiguration="true" var="configurationURL" />
	<liferay-portlet:renderURL portletConfiguration="true" var="configurationRenderURL" />
	<aui:form action="<%= configurationURL %>" method="post" name="fm">
	<aui:input name="<%= Constants.CMD %>" type="hidden" value="<%= Constants.UPDATE %>" />
	<aui:input name="redirect" type="hidden" value="<%= configurationRenderURL %>" />
	<aui:fieldset>
	<div class="display-template">
	<%
	String displayStyle = GetterUtil.getString(portletPreferences.getValue("displayStyle", StringPool.BLANK));
	long displayStyleGroupId = GetterUtil.getLong(portletPreferences.getValue("displayStyleGroupId", null), scopeGroupId);
	TemplateHandler templateHandler = TemplateHandlerRegistryUtil.getTemplateHandler(Student.class.getName());
	%>
	<liferay-ui:ddm-template-selector
	classNameId="<%= PortalUtil.getClassNameId(templateHandler.getClassName()) %>"
	displayStyle="<%= displayStyle %>"
	displayStyleGroupId="<%= displayStyleGroupId %>"
	refreshURL="<%= PortalUtil.getCurrentURL(request) %>"
	showEmptyOption="<%= true %>"
	/>
	</div>
	</aui:fieldset>
	<aui:button-row>
	<aui:button type="submit" />
	</aui:button-row>
	</aui:form>

view raw templateconfiguration hosted with ❤ by GitHub

5. Update the view jsp to render the data using selected ADT.

	<%@page import="com.liferay.portal.kernel.util.GetterUtil"%>
	<%@page import="com.liferay.portal.kernel.dao.orm.QueryUtil"%>
	<%@page import="com.test.service.StudentLocalServiceUtil"%>
	<%@page import="com.liferay.portlet.portletdisplaytemplate.util.PortletDisplayTemplateUtil"%>
	<%@page import="com.test.model.Student"%>
	<%@page import="com.liferay.portal.kernel.util.ListUtil"%>
	<%@page import="javax.portlet.PortletURL"%>
	<%@ include file="init.jsp" %>
	<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
	<portlet:renderURL var="addStudentJSP">
	<portlet:param name="myaction" value="addStudentForm"></portlet:param>
	</portlet:renderURL>
	<a href="<%=addStudentJSP%>">Add New Student</a>
	<br/><br/>
	<%
	String displayStyle = GetterUtil.getString(portletPreferences.getValue("displayStyle", StringPool.BLANK));
	long displayStyleGroupId = GetterUtil.getLong(portletPreferences.getValue("displayStyleGroupId", null), scopeGroupId);
	long portletDisplayDDMTemplateId = PortletDisplayTemplateUtil.getPortletDisplayTemplateDDMTemplateId(displayStyleGroupId, displayStyle);
	boolean showLocationAddress_view = GetterUtil.getBoolean(portletPreferences.getValue("showLocationAddress", StringPool.TRUE));
	%>
	<c:choose>
	<c:when test="<%= portletDisplayDDMTemplateId > 0 %>">
	<% List<Student> students = StudentLocalServiceUtil.getStudents(QueryUtil.ALL_POS, QueryUtil.ALL_POS); %>
	<%= PortletDisplayTemplateUtil.renderDDMTemplate(pageContext, portletDisplayDDMTemplateId, students) %>
	</c:when>
	<c:otherwise>
	<liferay-ui:search-container emptyResultsMessage="No Students were found!!">
	<liferay-ui:search-container-results results="${students}" />
	<liferay-ui:search-container-row className="com.test.model.Student" keyProperty="studentId" modelVar="student">
	<liferay-ui:search-container-column-text name="Name" value="${student.name}" />
	<liferay-ui:search-container-column-text name="Subject" value="${student.subject}" />
	<liferay-ui:search-container-column-jsp path="/WEB-INF/jsp/studentActions.jsp" align="right" />
	</liferay-ui:search-container-row>
	<liferay-ui:search-iterator paginate="false" />
	</liferay-ui:search-container>
	</c:otherwise>
	</c:choose>

view raw templateviewjsp hosted with ❤ by GitHub

6. Create the template and test. Following Freemarker sample code snippet is from liferay documentation page.

	<#if entries?has_content>
	Quick List:
	<ul>
	<#list entries as curEntry>
	<li>${curEntry.name} - ${curEntry.streetAddress}, ${curEntry.city}, ${curEntry.stateOrProvince}</li>
	</#list>
	</ul>
	</#if>

view raw samplefreemarker hosted with ❤ by GitHub

Please share your feedback if any ....

Not getting parameters in controller class in Liferay 6.2 (Namespaced Parameters)

Starting from Liferay 6.2 only allows namespaced parameters. If we want to send unnamespaced parameters we need to turn the filter off. To achieve the same we need to add the following property in portlet's liferay-portlet.xml file.

<requires-namespaced-parameters>false</requires-namespaced-parameters>

Ajax call using jQuery in Liferay Spring Portlet

1. JSP Code

	<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
	<liferay-portlet:resourceURL var="sampleUrl" />
	<input type="button" value="Ajax Call" onclick="ajaxMethod('${sampleUrl}');" />
	<script>
	function ajaxMethod(sampleUrl){
	$.ajax({
	type: 'GET',
	url: sampleUrl,
	cache:false,
	async:true,
	error: function(){
	alert('error');
	},
	dataType : "html",
	data :{
	name:"hello123"
	},
	success: function(htmlData) {
	alert('response : ' + htmlData);
	},
	complete: function(){
	}
	});
	}
	</script>

view raw jquery-ajax-jsp hosted with ❤ by GitHub

2. Method code in controller class

	@ResourceMapping
	public void serveResource(ResourceRequest request, ResourceResponse response)
	{
	System.out.println("method called");
	try {
	response.getWriter().write("<h1>Hello</h1>");
	} catch (IOException e) {
	// TODO Auto-generated catch block
	e.printStackTrace();
	}
	}

view raw jquery-ajax-controller hosted with ❤ by GitHub

Whats new in liferay 6.2 API - Part 1

In this post we will cover the changes that comes along with Liferay Portal 6.2 in liferay-portlet.xml DTD file.

	<ddm-display>
	The ddm-display value must be a class that implements com.liferay.portlet.dynamicdatamapping.util.DDMDisplay and is called when displaying the portlet.
	<requires-namespaced-parameters>
	Set the requires-namespaced-parameters value to true if the portlet will only process namespaced parameters. The default value is true.
	<staged-model-data-handler-class>
	The staged-model-data-handler-class value must be a class that implements com.liferay.portal.kernel.lar.StagedModelDatahandler and is called to handle export and import logic for a staged model entity.
	<template-handler>
	The template-handler value must be a class that implements com.liferay.portal.kernel.template.TemplateHandler and is called when displaying the portlet.
	<trash-handler>
	The trash-handler value must be a class that implements com.liferay.portal.kernel.trash.TrashHandler and is called to manage trash entries.
	<user-notification-definitions>
	The user-notification-definitions points to the XML file that defines the user notifications for this portlet. This file is read by the class loader.
	<user-notification-handler-class>
	The user-notification-handler-class value must be a class that implements com.liferay.portal.kernel.notifications.UserNotificationHandler is called to interpret requests into friendly messages that are easily understandable by a human being.

view raw liferay62-liferay-portlet hosted with ❤ by GitHub

Kaleo Workflow Configuration for Custom Portlet in Liferay 6.1

1. Make sure you have deployed kaleo workflow war in your liferay portal.

2. Create the service.xml

	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 6.1.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_6_1_0.dtd">
	<service-builder package-path="com.sample.harish">
	<author>harish.kumar</author>
	<namespace>harish</namespace>
	<entity name="Feedback" uuid="true" local-service="true" remote-service="false">
	<column name="feedbackId" type="long" primary="true" />
	<column name="feedbackDate" type="Date" />
	<column name="feedbackText" type="String" />
	<column name="status" type="int" />
	<column name="statusByUserId" type="long" />
	<column name="statusByUserName" type="String" />
	<column name="statusDate" type="Date" />
	<column name="companyId" type="long" />
	<column name="groupId" type="long" />
	<column name="userId" type="long" />
	<order>
	<order-column name="feedbackId" order-by="asc" />
	<order-column name="feedbackDate" order-by="desc" />
	</order>
	<finder name="GroupId" return-type="Collection">
	<finder-column name="groupId" />
	</finder>
	<finder name="CompanyId" return-type="Collection">
	<finder-column name="companyId" />
	</finder>
	<finder name="feedbackText" return-type="Collection">
	<finder-column name="feedbackText" />
	</finder>
	<finder name="G_S" return-type="Collection">
	<finder-column name="groupId" />
	<finder-column name="status" />
	</finder>
	<reference package-path="com.liferay.portal" entity="User" />
	<reference package-path="com.liferay.portlet.asset" entity="AssetEntry" />
	<reference package-path="com.liferay.portlet.ratings" entity="RatingsStats" />
	</entity>
	</service-builder>

view raw service.xml hosted with ❤ by GitHub

3. Build the service

4. Edit the FeedbackLocalServiceImpl class and add the following methods:

	public Feedback addFeedback(Feedback newFeedback, long userId,
	ServiceContext serviceContext) throws SystemException,
	PortalException {
	Feedback feedback = feedbackPersistence.create(counterLocalService
	.increment(Feedback.class.getName()));
	feedback.setCompanyId(newFeedback.getCompanyId());
	feedback.setGroupId(newFeedback.getGroupId());
	feedback.setUserId(serviceContext.getUserId());
	feedback.setFeedbackDate(newFeedback.getFeedbackDate());
	feedback.setFeedbackText(newFeedback.getFeedbackText());
	feedback.setStatus(WorkflowConstants.STATUS_DRAFT);
	feedbackPersistence.update(feedback, false);
	assetEntryLocalService.updateEntry(userId, feedback.getGroupId(),
	Feedback.class.getName(), feedback.getFeedbackId(),
	serviceContext.getAssetCategoryIds(),
	serviceContext.getAssetTagNames());
	WorkflowHandlerRegistryUtil.startWorkflowInstance(
	feedback.getCompanyId(), feedback.getGroupId(), userId,
	Feedback.class.getName(), feedback.getPrimaryKey(), feedback,
	serviceContext);
	return feedback;
	}
	public void deleteFeedbacks(Feedback feedback) throws SystemException,
	PortalException {
	assetEntryLocalService.deleteEntry(Feedback.class.getName(),
	feedback.getFeedbackId());
	feedbackPersistence.remove(feedback);
	}
	public Feedback updateStatus(long userId, long resourcePrimKey, int status,
	ServiceContext serviceContext) throws PortalException,
	SystemException {
	User user = userLocalService.getUser(userId);
	Feedback feedback = getFeedback(resourcePrimKey);
	feedback.setStatus(status);
	feedback.setStatusByUserId(userId);
	feedback.setStatusByUserName(user.getFullName());
	feedback.setStatusDate(serviceContext.getModifiedDate());
	feedbackPersistence.update(feedback, false);
	if (status == WorkflowConstants.STATUS_APPROVED) {
	assetEntryLocalService.updateVisible(Feedback.class.getName(),
	resourcePrimKey, true);
	} else {
	assetEntryLocalService.updateVisible(Feedback.class.getName(),
	resourcePrimKey, false);
	}
	return feedback;
	}

view raw FeedbackLocalServiceImpl.java hosted with ❤ by GitHub

5. Make the following entries in liferay-portlet.xml file

	<asset-renderer-factory>com.sample.harish.portlet.asset.FeedbackAssetRendererFactory</asset-renderer-factory>
	<workflow-handler>com.sample.harish.portlet.workflow.FeedbackWorkflowHandler</workflow-handler>

view raw liferay-portlet.xml hosted with ❤ by GitHub

6. create the FeedbackAssetRendererFactory class

	public class FeedbackAssetRendererFactory extends BaseAssetRendererFactory {
	@Override
	public AssetRenderer getAssetRenderer(long classPK, int type)
	throws PortalException, SystemException {
	Feedback feedback = FeedbackLocalServiceUtil.getFeedback(classPK);
	return new FeedbackAssetRenderer(feedback);
	}
	@Override
	public String getClassName() {
	return Feedback.class.getName();
	}
	@Override
	public String getType() {
	return "article";
	}
	}

view raw FeedbackAssetRendererFactory hosted with ❤ by GitHub

7. create the FeedbackAssetRenderer class-

	public class FeedbackAssetRenderer extends BaseAssetRenderer{
	private Feedback _feedback;
	public FeedbackAssetRenderer(Feedback feedback) {
	_feedback = feedback;
	}
	public long getClassPK() {
	return _feedback.getFeedbackId();
	}
	public long getGroupId() {
	return _feedback.getGroupId();
	}
	public String getSummary(Locale arg0) {
	return _feedback.getFeedbackText();
	}
	public String getTitle(Locale arg0) {
	return "Feedback Contest Entry";
	}
	public long getUserId() {
	return _feedback.getUserId();
	}
	public String getUuid() {
	return _feedback.getUuid();
	}
	public String render(RenderRequest request, RenderResponse response, String template)
	throws Exception
	{
	if (template.equals(TEMPLATE_FULL_CONTENT)) {
	return "/html/feedback.jsp";
	}
	else
	{
	return null;
	}
	}
	@Override
	public String getUserName() {
	// TODO Auto-generated method stub
	return null;
	}
	}

view raw FeedbackAssetRenderer hosted with ❤ by GitHub

8. create the /html/feedback.jsp file.


9. create the FeedbackWorkflowHandler class -

	public class FeedbackWorkflowHandler extends BaseWorkflowHandler{
	public String getClassName() {
	return CLASS_NAME;
	}
	public String getType(Locale locale) {
	return LanguageUtil.get(locale, "model.resource." + CLASS_NAME);
	}
	public Object updateStatus(int status,
	Map<String, Serializable> workflowContext) throws PortalException,
	SystemException {
	long userId = GetterUtil.getLong(workflowContext.get(WorkflowConstants.CONTEXT_USER_ID));
	long resourcePrimKey = GetterUtil.getLong(workflowContext.get(WorkflowConstants.CONTEXT_ENTRY_CLASS_PK));
	ServiceContext serviceContext = (ServiceContext) workflowContext.get("serviceContext");
	return FeedbackLocalServiceUtil.updateStatus(userId, resourcePrimKey,status, serviceContext);
	}
	public static final String CLASS_NAME = Feedback.class.getName();
	}

view raw FeedbackWorkflowHandler hosted with ❤ by GitHub

10. We are done with all the changes now, to see our portlet in action go to control panel → Workflow Configuration and set the workflow for your custom portlet.