Liferay Beginner’s Guide

Table of Contents

Liferay

Credits

About the Authors

About the Reviewers

www.PacktPub.com

Support files, eBooks, discount offers and more

Why Subscribe?

Free Access for Packt account holders

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Time for action – heading

What just happened?

Pop quiz – heading

Have a go hero – heading

Reader feedback

Customer support

Downloading the example code for this book

Errata

Piracy

Questions

1. Planning Your Portal

What is Liferay Portal?

Time for action – browsing sites based on Liferay Portal

What just happened?

Definition of a portal

Horizontal vs. vertical portals

Time for action – comparing Yahoo! and YouTube

What just happened?

Open source vs. commercial portals

Time for action – finding the source code of Liferay Portal

What just happened?

Pop quiz – multiple choices

Liferay Portal architecture

Web service provider

Liferay is flexible

Liferay is standard compliant

Pop quiz – multiple choices

Main Liferay Portal features

Theme and layout

Communities and organizations

Content Management System and Web Content Management

Time for action – watching Liferay Portal portlets in action

What just happened?

Pop quiz

Preparation for Liferay Portal installation

Hardware requirements

Time for action – finding RAM information

What just happened?

Software requirements

Operating systems

Java Development Kit

Time for action – installing JDK

What just happened?

Application servers and servlet containers

Database servers

Time for action – installing MySQL database server

What just happened?

Web browser

Installing OpenOffice

Time for action – installing OpenOffice

What just happened?

Time for action – starting OpenOffice service

What just happened?

Time for action – checking the OpenOffice service

What just happened?

Archive tools

Pop quiz

Summary

2. Installing a Liferay Portal Instance

Getting started

Liferay with Apache Tomcat

Time for action – deploying on Tomcat

What just happened?

Liferay with JBoss Application Server

Time for action – deploying on JBoss AS

What just happened?

Liferay with GlassFish

Time for action – deploying in GlassFish

What just happened?

Liferay with Oracle WebLogic

Time for action – configuring Weblogic

Configuring Oracle WebLogic

What just happened?

Deploying Liferay on WebLogic

What just happened?

Liferay on existing Tomcat

Time for action – deploying Liferay

What just happened?

Database configuration

Time for action – creating the database

What just happened?

Configuring Liferay to use MySQL

Time for action – changing the file

What just happened?

Summary

3. Understanding Portal Basics and Theming

Understanding a portal

Navigating Liferay

Time for action – signing in to Liferay Portal

What just happened?

Getting familiar with the Dockbar

The Add option

Time for action – creating a new page and adding a portlet

What just happened?

Have a go hero – installing a new portlet

Pop quiz – true or false

Using the Manage option

Time for action – accessing a portal with a normal user account

What just happened?

Pop quiz – select the correct answer

Getting an overview of Liferay Portal Architecture

Understanding the Liferay building blocks

User

User group

Role

Community

Organization

Teams

Pop quiz

Basics of the Control Panel

Visiting the Control Panel

Time for action – creating a new user

What just happened?

Changing Portal's look and feel with themes

Time for action – installing a new theme and applying it to the portal

What just happened?

Summary

4. Tips and Tricks-Advanced Configuration

Renaming our portal

Time for action – changing our portal name

What just happened?

SSO with OpenID

Time for action – using OpenID for authentication

What just happened?

Ask users to accept terms before accessing Liferay

Time for action – enabling Terms of Use

Time for action – changing Terms of Use

What just happened?

E-mail notifications

Time for action – enable notification for account creation

What just happened?

Adding custom attributes for User

Time for action – giving the option to add a user's favorite sport

Have a go hero – add more custom attributes

OpenOffice integration

Time for action – enabling OpenOffice integration

What just happened?

Changing the hostname

Time for action – changing our portal name

What just happened?

Mail server

Time for action – enabling the mail server

Summary

5. Building your First Liferay Site

Designing the site – painting the full picture

Users

Content

Applications

Security

Have a go hero – finding out information for an intranet portal

Knowing the portal requirements

CIGNEX Neighborhood portal

Organizing users in an organization and a community

Organization—structured grouping of users

Adding the organization

Time for action – creating organization for CIGNEX Neighborhood

Time for action – understanding actions associated with the organization

What just happened?

Have a go hero – adding a sub-organization to Neighborhood Congress

Understanding the difference between a Location and Regular Organization

Pop quiz – true or false?

Community—a collection of users having common interests

Adding the community

Time for action – creating a community for CIGNEX Neighborhood

What just happened?

Time for action – understanding actions associated with the community

Have a go hero – adding more communities to the CIGNEX Neighborhood

Pop quiz – true or false?

What suits your portal—organization or community?

Using organizations

Using communities

User groups—arbitrary collection of users

Time for action – adding a user group to CIGNEX Neighborhood

Time for action – understanding the actions associated with the group

What just happened?

User group and page templates

Time for action – creating a page template for the Bowlers user group

What just happened?

Pop quiz – multiple choice

Summary

6. Managing Pages, Users, and Permissions

Checklist

Creating pages for the Neighborhood site

Creating pages for Neighborhood communities

Time for action – creating pages for Neighborhood communities

What just happened?

Have a go hero – other top-level and child pages

Setting page-level attributes to define page characteristics

Time for action – providing a HTML title and friendly URL for a page

What just happened?

Pop quiz – true or false?

Exploring the User section

Configuration for user pages' default porltets

Creating an administrator user to manage the Neighborhood site

Time for action – creating a user and assigning an administrator role

What just happened?

Editing the user profile

Time for action – modifying user details

What just happened?

Assigning users to Neighborhood communities and organizations

Time for action – assigning a user to communities and organizations

What just happened?

Have a go hero – adding additional users to site

Disabling the option to register for the site for guest users

Time for action – disabling the Register option for a guest user

What just happened?

Pop quiz

Exploring role/permission management in Liferay

Creating a role to manage pages of the Neighborhood site

Time for action – creating a role to manage pages

What just happened?

Portal scoped roles

Community/Organization roles

Assigning users to community/organization administrator role

Time for action – assigning community/organization Administrator role

What just happened?

Have a go hero – creating a community role to grant blog creation permission

What just happened?

More on permissions

Defining resource-level permissions

Time for action – defining permissions for a bookmark entry

What just happened?

Have a go hero – defining the View permission for the Bookmark portlet

Pop quiz

Summary

7. Creating and Publishing Content

Content management preview

Analyzing online content

Organizing content

Purpose of Liferay content management

Uploading images

Time for action – uploading an image file

What just happened?

Pop quiz

Have a go hero – uploading another image

Creating web content

Regular web content

Time for action –adding content to the welcome page

What just happened?

Web content with a structure and template

Time for action – creating a structure

What just happened?

Time for action – creating a template

What just happened?

Time for action – creating template-based content

What just happened?

Migrated web content

Time for action –migrating static content from an existing site using the web content portlet

What just happened?

Pop quiz

Have a go hero – exploring the content creation process

Displaying web content

Welcome page

Time for action – adding content to the Welcome page

What just happened?

Houses-on-Sale page

Time for action – selling houses online

What just happened?

Registration page

Time for action – populating the registration page

What just happened?

Pop quiz

Have a go hero – tweaking content display

Uploading documents

Time for action – uploading a video file

What just happened?

Time for action – uploading a PDF file

What just happened?

Pop quiz

Have a go hero – find out more about file uploading

Showing a PDF file link in web content

Time for action – embedding a link for a PDF file

What just happened?

Pop quiz

Have a go hero – checking file permissions

Enabling comments for web content

Time for action – enabling comments for content

What just happened?

Pop quiz

Have a go hero – adding comment about content

Disclosing decrypted Congress documents

Time for action – displaying documents

What just happened?

Pop quiz

Have a go hero – adding comments

Managing content

Reviewing web content

Time for action – using the web content list portlet

What just happened?

Pop quiz

Have a go hero – filtering content

Monitoring other content

Time for action – adding the asset publisher portlet

What just happened?

Pop quiz

Have a go hero – updating content

Converting web content to formatted files

Time for action – adding a file conversion feature

What just happened?

Pop quiz

Have a go hero – performing conversion

Summary

8. Exploring Communities

Prerequisite

Setting up an online game using Flash Portlet

Time for action – setting up an online game using Flash Portlet

What just happened?

Have a go hero – displaying a Vegetable schedule

Adding Web Content Display to announce a cricket match

Time for action – announcing a cricket match

What just happened?

Using Video Portlet to share Neighborhood videos

Time for action – sharing Neighborhood videos

What just happened?

Sharing Neighborhood photos using Image Gallery

Time for action – sharing Neighborhood photos

What just happened?

Pop quiz – multiple choice

Exploring chat functionality to enable chat between Neighborhood members

Time for action – exploring chat functionality

What just happened?

Pop quiz – True or false

Integrating Open Social Gadgets in Neighborhood site

Time for action – integrating Open Social Gadgets

What just happened?

Creating bookmark of useful links using Bookmark Portlet

Time for action – creating bookmarks of useful links

What just happened?

Conducting polls in the Neighborhood site using Polls Portlet

Time for action – creating bookmarks of useful links

What just happened?

Pop quiz – multiple choice

Have a go hero – creating more polls

Changing language of Neighborhood site using Language Portlet

Time for action – changing language using Language Portlet

What just happened?

Have a go hero – change user language

Displaying breaking news as a carousel on the Neighborhood site

Time for action – displaying breaking news as a carousel

What just happened?

Defining a search on the Neighborhood site

Setting site wide search on the Neighborhood site

Time for action – searching all content

What just happened?

Setting Web Content search on the Neighborhood site

Time for action – searching for Web Content

What just happened?

Have a go hero – searching only general content

Summary

9. Setting up an Online Shop

Getting started with online store setup

Online shop configuration

Page configuration

Time for action – configuring an online shop page

What just happened?

Payment configuration

Time for action – configuring tax rate and currency

What just happened?

Payment method configuration

Time for action – configuring payment through PayPal

What just happened?

Adding PayPal Sandbox environment support in the Shopping portlet

Time for action – installing a plugin to provide PayPal Sandbox environment support

What just happened?

What about payment with credit cards?

Shipping cost configuration

Time for action – configuring the shipping cost

What just happened?

Percentage formula for shipping cost calculation

Insurance cost configuration

Time for action – configuring the insurance cost

What just happened?

E-mail configuration

Time for action – configuring the e-mail templates

What just happened?

Pop quiz

Shopping items

Item categories

Time for action – item category creation

What just happened?

Changing the Parent Category

Have a go hero – define another subcategory

Shopping items

Time for action – item creation

What just happened?

Basic attributes

Fields section attributes

Prices section attributes

Images section attributes

Have a go hero – defining a complete set of items for our shop

Pop quiz

Shopping cart

Have a go hero – creating a login id for our customer

Let's do shopping

Time for action – adding items to the shopping cart

What just happened?

Item listing view (category listing view)

Item details view

Shopping cart view

Pop quiz

Checkout process

Time for action – making a payment

What just happened?

Address details

Order confirmation

Have a go hero – verifying PayPal accounts

Order management

Time for action – processing the order

What just happened?

Order listing

Order details

Promotion offers

Time for action – promoting offers

What just happened?

Coupon listing

Edit coupon details

Have a go hero – advertising

Pop quiz

Summary

10. Liferay Server Administration

Getting started with server administration

Monitoring and managing server resources

Time for action – monitoring and controlling Liferay resources

Memory utilization

Used Memory versus Total Memory

Used Memory versus Maximum Memory

Memory management operations

General maintenance operations

Managing log levels

Time for action – configuring the log levels

What just happened?

What if the class or package entry is not found?

Configuring the log levels permanently

Time for action – changing log levels permanently

What just happened?

Managing file upload size and types

Time for action – configuring document library file settings

What just happened?

Monitoring portal sessions

Time for action – monitoring live user sessions

What just happened?

Configuring multiple portals on the same Liferay server

Time for action – configuring another portal instance

What just happened?

Virtual hosting of communities and organizations

Time for action – virtual host configuration

What just happened?

Implementing the staging environment

Time for action – configuring staging environments

What just happened?

Staging configuration

Publish to Live Now

Scheduled publication

Time for action – scheduling publication of portal changes

What just happened?

Summary

A. PayPal Test Account Configuration

B. Pop Quiz Answers

Chapter 1, Planning your Portal

Chapter 3, Understanding Portal Basics and Theming

Chapter 5, Building your First Liferay Site

Chapter 6, Managing Pages, Users, and Permissions

Chapter 7, Creating and Publishing Content

Chapter 8, Exploring the Communities

Chapter 9, Setting up an Online Shop

Bonus Chapter, Exploring Social Collaboration

Index

Liferay

Beginner's Guide

Liferay

Beginner's Guide

Copyright © 2011 Packt Publishing

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the authors, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.

Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.

First published: December 2011

Production Reference: 1241111

Published by Packt Publishing Ltd.

Livery Place

35 Livery Street

Birmingham B3 2PB, UK.

ISBN 978-1-84951-700-3

www.packtpub.com

Cover Image by Asher Wishkerman (<wishkerman@hotmail.com >)

Credits

Authors

Robert Chen

Gaurav Barot

Samir Bhatt

Sandeep Nair

Mahipalsinh Rana

Reviewers

Albert Coronado Calzada

Aritz Galdos Otermin

Jordi Carbonell i Soler

Acquisition Editor

Sarah Cullington

Development Editor

Shreerang Deshpande

Technical Editors

Manasi Poonthottam

Sakina Kaydawala

Ankita Shashi

Copy Editors

Leonard D'Silva

Neha Shetty

Project Coordinator

Jovita Pinto

Proofreader

Aaron Nash

Indexer

Monica Ajmera Mehta

Graphics

Valentina D'silva

Conidon Miranda

Production Coordinator

Shantanu Zagade

Cover Work

Shantanu Zagade

About the Authors

Robert Chen is an Architect for Liferay Portal projects. He was a computer game developer and a software testing engineer. He holds an MS degree in Computer Science from California State University, San Bernardino. His focus was on online banking applications. He also has a bachelor's degree from Wuhan University, China. Mr. Chen was a QA engineer at VMware, Inc. He later led a team in developing four educational computer games for a Florida school district. He worked on Geographical Information Systems (GIS). Mr. Chen has rich experience in J2EE technologies. He has extensive experience in Content Management Systems (CMS) including Alfreso. He is an expert in web portal technologies. Mr. Chen has hands-on experience in 10 Liferay Portal projects.

I would sincerely thank Sarah Cullington (Acquisition Editor), Zainab Bagasrawala (Project Coordinator), Shreerang Deshpande (Development Editor) at Packt Publishing. Thank you for reviewing my chapters. I appreciate your invaluable advice – it has helped me improve the quality of my writing. Thanks also go to Eleanor Duffy, Lata Basantani, and the team at Packt Publishing. It has been a happy experience working together 
with you!

I would also thank Dr. Munwar Shariff and Dr. Jonas X. Yuan for their support and encouragement along the way.

Gaurav Barot has worked on Enterprise-level portal development projects in various domains such as media, healthcare, and insurance. He has been working on Liferay for more than three years now. Apart from being involved in full lifecycle of portal development projects, he is also a Certified Liferay Trainer and provides Liferay Trainings worldwide. He holds a Bachelor's degree in Engineering in Information Technologies and Post Graduate Diploma in Network Computing. He has more than six years of industrial experience.

Gaurav is working as a Senior Consultant with CIGNEX Datamatics, a global leader in open source technologies.

I would like to thank all my team members at CIGNEX for making this book a reality. I am also very thankful to Munwar Shariff – CTO, CIGNEX Datamatics and Manish Sheladia – Co-founder and Chief Delivery Officer, CIGNEX Datamatics to provide an opportunity to write this book.

I sincerely thank and appreciate the entire team at Packt Publishing for providing continuous support during this project.

Last but not the least, I would like to thank my parents and my two younger sisters – Kinjal and Yogini for their love and encouragement. A special thanks to my wife Kruti and my lovely daughter Twisha – both of them have been very tolerant and understanding during all the time that I've spent on the computer while working on the book.

Samir Bhatt Samir Bhatt has been working on Liferay for more than two years and is a Liferay certified trainer. He is leading Liferay practice at CIGNEX Datamatics. He is also part of architects panel at CIGNEX Datamatics. He has worked as a Liferay Architect in more than 10 projects. He has conducted many Liferay trainings across the globe. Samir has more than 11 years of IT experience. He delivered solutions in various business domains including telecommunication, retail, healthcare, and media. He has also worked on many other technologies including Pentaho BI, Oracle, Java Swing, ICEfaces, and Visual Basic.

I would like to specially thank Munwar Sharif (CTO, CIGNEX Datamatics) and Manish Sheladia (Chief Delivery Officer, CIGNEX Datamatics) for encouraging me to write this book.

I appreciate the whole Packt Publishing team for providing continuous support throughout this project.

Lastly, I want to thank my parents for their encouragement. I specially thank my wife Hetal and my little daughter Shreeya for their support 
and love.

Sandeep Nair has been working on Liferay for more than two years and has overall more than five years of experience in Java and Java EE technologies. He has executed projects using Liferay in various domains such as Construction, Financial, and Medical fields providing solutions such as Collaboration, Enterprise Content Management, Web Content Management systems. He has created a free and open source Google Chartlet plugin for Liferay which has been downloaded and used by people across 90 countries as per Sourceforge statistics. Besides development, consulting, and implementing solutions, he has also been involved in giving trainings in Liferay in other countries. Before he jumped into Liferay, he has had experience in Java and Java EE platforms and had worked in EJB, Spring, Struts, Hibernate, Servicemix. He also has experience in using JitterBit, which is an ETL tool. When he is not coding, he loves to read books and write blogs.

I would like to thank Munwar Shariff and Manish Sheladia who trusted in me and thought me worthy enough to write this book. I would like to thank Robert Chen for being so supportive from the beginning of the book and leading the team that too very efficiently. I would also like to thank rest of the co-authors Samir Bhatt, Mahipalsinh Rana, and Gaurav Barot, who were there to review and discuss each other's work and make sure we give quality book to the readers. I am also very grateful to Zainab Bagasrawala, who took the pains to co-ordinate the chapters and making sure we deliver the chapter in time, Sarah Cullington and Shreerang Deshpande for reviewing my work and giving right advice as to what should or should not be there in the book. Last but not the least, I would like to thank my parents and my brother for supporting me.

Mahipalsinh Rana's stint with portal server technologies started in Sun Microsystems when he started working with Sun Portal Server 7.2. Later Sun became the technology partner of Liferay for development in 5.2.x and he was part of that team. He looked after Internationalization (I18n) and Localization (L10n) of Liferay across various modules. He then joined CIGNEX Technologies as a Liferay Technical Architect and executed more then 10 projects in various domains such as chemical, media, telecommunications. He also enjoys doing Liferay training from time-to-time being a certified trainer from Liferay. He loves exploring other technologies such as BigData and Internationalization (I18n). He has total seven years of Industrial experience.

Mahipal is a very good speaker and has given speeches at various conferences on technical topics. He also writes blogs (http://mahipalrana.blogspot.com/) occasionally and actively participates in the Liferay Community.

I would like to thank all my colleagues at CIGNEX for their help in various scenarios. I would also like thank Munwar Shariff – CTO, CIGNEX (My Mentor, My Guru) from whom learning never ends. I would like to thank Manish Sheladia – Co-founder and Chief Delivery Officer, CIGNEX – to believe in me and provide opportunity to write this book.

I sincerely thank and appreciate the entire team at Packt Publishing for providing continuous support during this project.

Last but not the least, I would like to thanks my parents for their encouragement. I would also like to give big thanks to my wife Nehal to give me company and tea during my writing hours and my daughter Priyanshi to sleep early in my writing hours.

About the Reviewers

Albert Coronado Calzada is a highly experienced Information Technology professional with more than 12 years of experience in Java EE, high performance web portals, and enterprise software solutions. Albert has studied Information Technology Engineering and has a Master in Economic and Financial Management of companies.

Albert is currently working as a freelance software developer, trainer, and consultant for international customers. Albert is an open source software contributor and has released different applications for Liferay and Android.

Albert lives in Girona(Spain) and maintains a blog at http://www.albertcoronado.com.

Aritz Galdos Otermin studied Computer Engineering at UPV / EHU (Euskal Herriko Unibertsitatea) and Coventry University. Aritz has been working as programmer and software architect since 2005 and has specialized in portal development and deployment.

He is especially interested in open source and enjoys developing portlets and integration tools for Liferay with other open source projects, such as video conferencing tools and Android mobile platforms. He releases his developments in his personal projects page http://sareweb.net.

I want to thank every single person that has ever contributed to open source in any way.

Jordi Carbonell i Soler after more than eight years working with JEE technologies is currently a JEE Architect specialized in portal environments. His relation with Liferay started in 2007. Since then, he's been working on many Liferay-based portals along all of those projects' stages: from presales and conceptualization to development and installation; usually, integrating them with a wide range of third-party tools, such as Alfresco ECM, Atlassian products, or BPM Engines. Currently, he's working at IN2, one of the first Spanish IT companies who bet on Liferay and Alfresco as trending technologies.

www.PacktPub.com

Support files, eBooks, discount offers and more

You might want to visit www.PacktPub.com for support files and downloads related to your book.

Did you know that Packt offers eBook versions of every book published, with PDF and ePub files available? You can upgrade to the eBook version at www.PacktPub.com and as a print book customer, you are entitled to a discount on the eBook copy. Get in touch with us at for more details.

At www.PacktPub.com, you can also read a collection of free technical articles, sign up for a range of free newsletters and receive exclusive discounts and offers on Packt books and eBooks.

http://PacktLib.PacktPub.com

Do you need instant solutions to your IT questions? PacktLib is Packt's online digital book library. Here, you can access, read and search across Packt's entire library of books. 

Why Subscribe?

Fully searchable across every book published by Packt

Copy and paste, print and bookmark content

On demand and accessible via web browser

Free Access for Packt account holders

If you have an account with Packt at www.PacktPub.com, you can use this to access PacktLib today and view nine entirely free books. Simply use your login credentials for immediate access.

Robert Chen's Dedication:I would like to dedicate this book to my eldest sister Xinli Chen, who has always been supporting me behind the scene.

This book would not have been possible without your encouragement.

Thank you from the bottom of my heart.

Mahipalsinh Rana's Dedication:I would like to dedicate this book to my Late Grandfather Mr. Vishubha Rana ,who is my constant source of inspiration.

Preface

Liferay Portal is a leading horizontal portal product, written in Java. It has the power to provide the Intranets and Extranets of large corporations. Liferay will allow you to build your company's portal quickly, efficiently, and in a custom way to suit the needs of your corporation.

Liferay Beginner's Guide will show you how to set up your own site from scratch. Most books assume that you have knowledge of portals before working with Liferay and so include more theory than practice. However, only enthusiasm is required for reading this book as the step-by-step instructions, which follow the creation of a sample community site, will make it easy to install and configure Liferay, set up a Liferay Portal instance, and use the out-of-the-box portlets of Liferay.

By following the logical flow of the chapters and the creation of the sample site, you will set up your Liferay site in several quick and easy stages. You will start by installing Liferay in your application server or servlet container of choice. You will learn how to customize the look-and-feel of the portal, change the URL of the site, and create your own communities and organizations within the portal, then add users to them. By the end of the book, you will have a fully operational Liferay Portal and the confidence to maintain and customize it to meet your needs.

What this book covers

Chapter 1, Planning Your Portal, gives an overview of Liferay Portal– the most popular open source portal framework. It briefly talks about Liferay's features and its portlets.

Chapter 2, Installing a Liferay Portal Instance, teaches you how to deploy Liferay in various application servers from a basic servlet container to an enterprise application server.

Chapter 3, Understanding Portal Basics and Theming, talks about the portal basics and portlet concepts. It also discusses Liferay User interface and use of dockbar to navigate in Liferay. It instructs on how to do basic administration in Liferay using Control Panel and different options of the Control Panel. It provides basic idea about the theme as well.

Chapter 4, Tips and Tricks—Advanced Configuration, discloses Liferay's secrets for tweaking the default behavior of portal