Portal Administrator's Guide

Richard L. Sezov, Jr.

Liferay Administrator's Guide by Richard L. Sezov, Jr. Copyright © 2009 by Liferay, Inc. ISBN 978-0-578-02729-6 This work is offered under the Creative Commons Attribution-Share Alike Unported license.

You are free: ● to share—to copy, distribute, and transmit the work ● to remix—to adapt the work Under the following conditions: ● Attribution. You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work). ● Share Alike. If you alter, transform, or build upon this work, you may distribute the resulting work only under the same, similar or a compatible license. The full version of this license appears in the appendix of this book, or you may view it online here: http://creativecommons.org/licenses/by-sa/3.0 Contributors: Ray Auge, Jian Cao (Steven), Brian Chan, Alice Cheng, Bryan Cheung, Ivan Cheung, Shepherd Ching, Alexander Chow, Bruno Farache, Jorge Ferrer, Mike Han, JR Houn, Scott Lee, Wei Hong Ma (Sai), Charles May, James Min, Alberto Montero, Jerry Niu, Michael Saechang, Li Ji Shan (Dale), Ed Shin, Joseph Shum, Michael Young

Table of Contents
1. Introduction.......................................................................................15 CREATED FOR THE ENTERPRISE..................................................................................15 Personalization and easy customization..............................................15 Workflow adaptable...............................................................................16 Branding friendly...................................................................................16 Flexible organization.............................................................................16 Built With The End-User In Mind.........................................................16 Award-winning UI............................................................................16 One-Click Look and Feel Changes...................................................16 Web OS..............................................................................................16 TECHNOLOGY TO HELP DEVELOPERS...........................................................................16 Standards Compliant..............................................................................17 Ready Integration...................................................................................17 Liferay Plugins Catalog..........................................................................17 SUPPORTED TECHNOLOGIES ......................................................................................17 LANGUAGES ........................................................................................................17 2. Initial Setup.......................................................................................19 EDITIONS OF LIFERAY.............................................................................................19 OBTAINING LIFERAY...............................................................................................20 INSTALLING A BUNDLE............................................................................................20 INSTALLING LIFERAY FOR AN ENTERPRISE.....................................................................22 Sample Data............................................................................................22 Liferay Home...........................................................................................22 Database Setup........................................................................................23 Default Method: Automatic.............................................................23 Manual Method................................................................................23 Turning a Bundle into an Enterprise Portal.........................................24 The portal-ext.properties File.........................................................25 Installing Liferay on an Existing Application Server..........................27 Installing Liferay in 10 Easy Steps..................................................27 GlassFish 2.x.....................................................................................28 GlassFish 3.x.....................................................................................31 Jetty 6................................................................................................34 JBoss 4.03sp1 / 4.04 / 4.05 / 4.2 / 4.3..............................................36 JBoss 5.x............................................................................................39 Oracle Application Server (OC4J)....................................................42 Resin 3.1.x.........................................................................................47 Resin 3.2.x.........................................................................................49 Tomcat 5.5.X.....................................................................................50 WebLogic 9 / 10................................................................................52 Oracle WebLogic 10.3.......................................................................55 WebSphere 6.1..................................................................................58 WebSphere 7.0..................................................................................69 Making Liferay Coexist with Other Java EE Applications....................74 SUMMARY...........................................................................................................75 3. Configuration.....................................................................................77 LIFERAY'S USER INTERFACE......................................................................................77 iii

Navigating Liferay..................................................................................78 Navigating the Control Panel................................................................80 PORTAL ARCHITECTURE...........................................................................................81 Users........................................................................................................82 User Groups.............................................................................................82 Roles.........................................................................................................82 Organizations..........................................................................................83 Communities...........................................................................................83 USING THE CONTROL PANEL.....................................................................................84 Adding Users...........................................................................................84 User Management..................................................................................86 Organizations..........................................................................................87 Communities...........................................................................................89 Community Provisioning................................................................90 User Groups.............................................................................................92 User Groups and Page Templates...................................................93 Roles.........................................................................................................98 Defining Permissions on a Role......................................................98 Special Note about the Power Users Role....................................101 GLOBAL SERVER SETTINGS.....................................................................................101 Password Policies..................................................................................101 Settings..................................................................................................102 General............................................................................................102 Authentication: General Settings.................................................102 Authentication: LDAP....................................................................103 Single Sign-On................................................................................109 Authentication: Central Authentication Service (CAS)...............109 Authentication: NTLM...................................................................110 Authentication: OpenID.................................................................111 Authentication: OpenSSO..............................................................111 Authentication: SiteMinder..........................................................112 Default User Associations..............................................................112 Reserved Credentials.....................................................................112 Mail Host Names.............................................................................113 Email Notifications.........................................................................113 Identification..................................................................................113 Miscellaneous: Display Settings....................................................113 Monitoring............................................................................................113 Plugins Configuration..........................................................................113 Server Administration.........................................................................114 Resources........................................................................................114 Log Levels........................................................................................114 System Properties..........................................................................114 Portal Properties............................................................................115 Shutdown........................................................................................115 OpenOffice......................................................................................115 Portal Instances....................................................................................116 Plugins Installation..............................................................................116 SUMMARY.........................................................................................................116 4. Liferay Collaboration Suite..............................................................119 SCOPES.............................................................................................................119 ARCHIVED SETUPS...............................................................................................121 iv

PERMISSIONS......................................................................................................121 SHARING...........................................................................................................122 Any Web Site.........................................................................................122 Facebook................................................................................................122 Friends...................................................................................................123 BLOGS..............................................................................................................123 The Blogs Portlet..................................................................................124 Configuring the Blogs Portlet.......................................................125 Aggregating Blog Entries.....................................................................128 CALENDAR.........................................................................................................129 Configuring the Calendar Portlet........................................................129 Event From.....................................................................................129 Event Reminder Email...................................................................129 Display Settings..............................................................................130 Using the Calendar Portlet..................................................................130 CHAT...............................................................................................................131 MAIL...............................................................................................................132 MESSAGE BOARDS...............................................................................................133 Email From............................................................................................134 Message Added Email...........................................................................134 Message Updated Email.......................................................................134 Thread Priorities..................................................................................134 User Ranks.............................................................................................134 RSS.........................................................................................................135 Anonymous Posting..............................................................................135 Ratings...................................................................................................135 Permissions...........................................................................................135 Adding Categories.................................................................................136 Using the Message Boards...................................................................137 Message Board Administrative Functions..........................................139 Moving Threads..............................................................................140 Deleting Threads............................................................................140 Banning Users................................................................................140 Splitting Threads............................................................................140 Editing Posts...................................................................................140 Permissions.....................................................................................141 WIKIS..............................................................................................................141 Getting Started with the Liferay Wiki.................................................141 Managing Wikis....................................................................................142 Adding and Editing Wiki Pages...........................................................143 Page Details...........................................................................................144 Details..............................................................................................144 History.............................................................................................145 Incoming / Outgoing Links...........................................................145 Attachments...................................................................................145 Navigating in the Wiki Portlet.............................................................145 SUMMARY.........................................................................................................146 5. Advanced Liferay Configuration......................................................147 The portal-ext.properties File.............................................................147 Properties Override.......................................................................148 Liferay Home..................................................................................148 Portal Context................................................................................148 v

Resource Repositories Root...........................................................149 Technology Compatibility Kit.......................................................149 Schema............................................................................................149 Upgrade...........................................................................................149 Verify..............................................................................................150 Auto Deploy....................................................................................150 Hot Deploy......................................................................................152 Hot Undeploy..................................................................................153 Plugin..............................................................................................153 Portlet.............................................................................................153 Portlet Coordination......................................................................154 Theme..............................................................................................154 Resource Actions............................................................................155 Model Hints....................................................................................155 Service Builder...............................................................................155 Spring..............................................................................................155 Hibernate........................................................................................156 JDBC.................................................................................................158 Custom SQL.....................................................................................160 Database..........................................................................................160 Ehcache...........................................................................................160 JavaScript........................................................................................161 SQL Data..........................................................................................164 Company.........................................................................................165 Users................................................................................................166 Groups and Roles............................................................................167 Organizations.................................................................................169 Languages and Time Zones...........................................................170 Look and Feel..................................................................................172 Request............................................................................................172 Session.............................................................................................172 JAAS.................................................................................................174 LDAP................................................................................................175 CAS...................................................................................................177 NTLM...............................................................................................177 OpenID.............................................................................................178 OpenSSO..........................................................................................178 SiteMinder......................................................................................178 Authentication Pipeline.................................................................179 Auto Login.......................................................................................181 SSO with MAC (Message Authentication Code)...........................182 Passwords.......................................................................................183 Permissions.....................................................................................184 Captcha...........................................................................................185 Startup Events................................................................................185 Shutdown Events............................................................................186 Portal Events...................................................................................186 Login event.....................................................................................186 Logout event...................................................................................187 Default Landing Page.....................................................................187 Default Logout Page.......................................................................187 Default Guest Public Layouts........................................................187 vi

............................................................................................................................................................213 Widget Servlet..............................................................................................................................................................................................204 Lock..............................................................................................................................................................................................203 Lock..............................................................................204 OpenOffice........................................................................................................................................................................211 Main Servlet.......................................................206 POP...................................207 Social Bookmarks......................................211 Web Server.......................................................................................................................................................................................................................................207 Sharepoint......................................................................................208 Velocity Engine...............................................198 Browser Launcher......196 FileSystemHook..............................................213 Announcements Portlet...................................206 Quartz................................................................191 Portlet URL....................................................................................190 Layouts..................................................209 HTTP....................................................................................................................................................................................................................................................................................................199 SourceForge.......212 Axis Servlet..................................................198 Instant Messenger.............197 Editors..................................197 Mime Types........................................203 Counter......................210 Upload Servlet Request.................................................Default User Private Layouts..........................................................................................................................207 Scheduler..................................................190 Default Settings Layouts......................................................198 Control Panel..................202 Content Delivery Network.......202 Communication Link.....212 Liferay Tunnel Servlet....................................................................................197 Fields.........................................................................................................................................................199 Lucene Search.....................................................213 vii ..................................................................................................................................................................................................................196 Images..........203 JBI................................................................................204 Mail.......................203 JCR.........................................................................195 Preferences...................................................................................................................196 Struts.............................................................................................................211 WebDAV...................................................................................................................................................................................188 Default User Public Layouts.......................................................................................................................212 WebDAV Servlet............203 Live Users.......................................................213 Admin Portlet.............................................................207 Search Container....................................................................................................................212 Spring Remoting Servlet.......................................................212 JSON Tunnel Servlet........................................................209 Servlet Filters.....189 Default Admin..201 Value Object..................................................................................................................................................208 Virtual Hosts.......................................................................................................................................197 Amazon..................................................................................................................

244 LIFERAY SERVICES ORIENTED ARCHITECTURE......................223 PLUGIN MANAGEMENT..............................................................................................................................249 LIFERAY CLUSTERING.....222 Tags Portlet......................................214 Blogs Portlet.................................................................................................................................................253 Pluggable Enterprise Search...............................256 Hibernate Cache Settings....231 Liferay Configuration Issues............................Asset Publisher Portlet...............................................................................................................................................235 How Liferay Is Being Launched...........................235 Creating Your Own Plugin Repository..244 Accessing Liferay's WSDL..............................................................................................................250 All Nodes Should Be Pointing to the Same Liferay Database................................................................227 Installing Plugins Manually...................................................................................................................................................215 Document Library Portlet.............................................................237 Manually Creating A Software Catalog.......................................................................................................227 Installing Plugins from Repositories................................................................................................................................................................................219 Journal Content Search Portlet........236 The Software Catalog......................222 Tags Compiler Portlet..........................221 Software Catalog Portlet...........................................................................................................................................................................226 Layout Templates..............................................................219 Message Boards Portlet.................................256 DISTRIBUTED CACHING................................................................................................................................................................................................................................................................217 Journal Articles Portlet..................................232 The Container Upon Which Liferay Is Running.............................................................230 Plugin Troubleshooting......................................................................................233 Changing the Configuration Options in Multiple Places........216 Invitation Portlet.............................................................................220 Nested Portlets Portlet....................................................214 Communities Portlet..........................................................................244 Connecting to a Software Catalog......251 Document Library Configuration................225 Themes............................... Enterprise Configuration....................................252 Search Configuration..........................................................................222 Tasks Portlet..............................................................................251 Jackrabbit Sharing...................247 6.....221 Shopping Portlet..................................................................225 Portlets.............255 Hot Deploy........223 Translator Portlet......................219 My Places Portlet......227 Hook Plugins..................................................215 Image Gallery Portlet...................................227 Web Plugins.............................................................221 Portlet CSS Portlet.............................................................................220 Navigation Portlet.......................217 Journal Portlet........................................................258 viii .............................................................................................................................................................................................................214 Calendar Portlet..............................................................................223 Wiki Portlet............................................253 Lucene Configuration..............................................................................................................................................................................................................................................................................................................................................................

...........................................................................................................................................259 Installation and Test...............................275 Properties File Changes..................................................................265 Warning Messages................................................................................259 WORKFLOW..........................................272 Frequently Asked Questions................. Communities........................................................................................271 Logging...........................................................................288 Prerequisite ...................289 If Your Developers Have Customized Liferay........................................285 LIFERAY'S LOGGING SYSTEM............................................... Maintaining A Liferay Portal..................................................................................................................................268 Managing Tasks..............................................261 How the Workflow Portlet Works...............................................................288 Upgrading Liferay 4...................279 7...........261 Data Types and Error Checking...................................................................................................272 How do you write a new process definition?............271 Customizable Front-End..............................................................................................................................................289 Converting wiki pages (optional) .........278 Portlets............................................................1..........................................................277 Servlet Filters..284 Liferay's File System.............................................................................................................................................................................................................................................274 Garbage Collection.....285 UPGRADING LIFERAY...............................272 DEPLOYING A CUSTOMIZED LIFERAY................................263 Sample Process Definitions.......................................................................................................................................................................287 Liferay Upgrade Procedure..........261 Process Definitions...................................................................................................................271 File Upload Data Type...........................................................................................278 Read-Writer Database Configuration..................................0....260 Using Different Databases..............................................................................................................288 If Your Developers Have Customized Liferay.............287 Upgrade Steps..4 to Liferay 5.......................................289 Upgrade Troubleshooting .................................................274 PERFORMANCE TUNING.....................................3 to Liferay 4..........................................................................................266 Administration................................................................................................267 Managing Instances...283 BACKING UP A LIFERAY INSTALLATION........................................................267 Deploying Workflows........290 ix ..............................................................290 Upgrading Liferay 5.......................................................................................................................................................................................272 Why are there “Duplicate File” exceptions when I change databases for jBPM?.................273 Deploying from a Client Machine....................................................................................................................................0 to Liferay 5...........................289 Prerequisite .................................285 Database........................4.........................................................................278 Database Sharding.............................288 Upgrading Liferay 4......................................................................................................Clustering Jackrabbit...........................................................................261 Integrating with Users........283 LIFERAY MONITORING USING GOOGLE ANALYTICS.....................................................................284 Source Code.................................................................................................. and Roles..............................................274 Memory......270 Future Enhancements..............272 Deploying Directly on the Server........

............................................................................290 Upgrading Themes .....................................299 CREATIVE COMMONS LICENSE....293 Upgrading PHP Portlets ......................................310 x .........................................................................................................299 Creative Commons Notice........................................................................... Appendix: Documentation License....................................................................290 How to keep the old values ...........1 to Liferay 5..................................Changes in configuration properties ..296 8........................................................................295 Theme Upgrade ........................................................................................................................................294 Prerequisite .............................................................................305 9........ 292 Change in Theme CSS Fast Load....307 Index..............................................................................................................................291 The Parent Element of the Dock May Change Positioning When Upgrading....................................................................................290 If Your Developers Have Customized Liferay................293 Javascript changes ...................293 Upgrading From Liferay 5.................................................2.......290 What has been changed? ........................292 Change in Javascript Fast Load.............................................294 Changes in configuration properties .................................................................................................................................................................. Colophon.........295 API Changes ..292 The Class Names for Different UI Components Have Changed ......................................................................................299 License........................................

how to back it up. From there. and has an impressive download rate (over 60. or anything in between. and will guide you step-by-step through the installation and configuration process. From there we go into advanced administration topics and enterprise configuration.000 downloads a month and over a million downloads total). whether that site is a public Internet site. It has received awards from multiple leading industry publications.PREFACE Liferay Portal is the leading open source portal in the marketplace today. This book was written with the server administrator in mind. including clustering and integrating Liferay with other services. Why is it so popular? Because Liferay Portal has out of the box all of the features you need to run a successful web site. You'll see how to use Liferay's collaboration suite of portlets to enable your users to work together more efficiently and more easily. and how to upgrade Liferay if you are moving from a previous version. a corporate Intranet. The information contained herein has been organized in a way that hopefully makes it easy to locate information. It is a guide for anyone who wants to get a Liferay Portal server up and running. xi . we work all the way through the multiple ways of installing Liferay manually on an application server. and then keep it by your side as you configure and maintain your Liferay-powered web site. how to manage a Liferay installation. to portal administration. We round things out by showing you how to optimize Liferay's performance. Use this book as a handbook to getting your Liferay Portal installation running smoothly. We start at the beginning: downloading and configuring the Liferay bundles.

This edition has been updated so that it covers Liferay Portal up to version 5. and that it will be an indispensable resource as you begin to administer a Liferay portal server. offers training.com/web/guest/services for further information about the services we can provide.What's New in the Third Edition Certainly. and these are designed to make it easy to find information.2. Please see http://www. Tips are used to indicate a suggestion or a piece of information that affects whatever is being talked about in the surrounding text. and support services to fill any need that you might have. Liferay. For this edition of the book. This chapter will guide you through enabling your users to collaborate using the robust set of tools that Liferay provides: blogs. This chapter also goes over portal design. mail. If source code goes multi-line. Page headers denote the chapters. chat. If you need any assistance beyond what is covered in this book. Inc. Chapter 7 (Maintaining a Liferay Portal) now covers database sharding among other things. consulting. Tip: This is a tip. and wikis. For example. Conventions Sections are broken up into multiple levels of headings.liferay. a new chapter on Liferay's unparalleled collaboration suite of portlets has been provided. Liferay Portal has not stood still since the last edition was written. The chapter on Portal Administration (Chapter 3) has been overhauled so that it covers Liferay administration using the new Control Panel. Italics are used to represent links or buttons to be clicked on in a user interface and to indicate a label or a name of a Java class. listing the things you might want to consider as you build your web site on Liferay Portal. Chapter 5 (Advanced Liferay Configuration) has been completely revamped to that it covers all of the new portal properties. the lines will be \ separated by a backslash character like this. Source code and configuration file directives are presented like this. Publisher Notes It is our hope that this book will be valuable to you. Bold is used to describe field labels and portlets. Other chapters have been expanded to include additional information. message boards. and footers denote the particular section within the chapter. and the rest of the book has been exhaustively gone through and updated. They are always accompanied by this gray box and the icon to the left. calendar. and an updated section on upgrading Liferay. xii .

2 Enterprise Edition of the product. but also with the company. The engineering team at Liferay is a fantastic group of people. for her understanding and support. Brian Chan. I had a target deadline to meet: the book had to be ready for the release of the 5. and to help make your experience using Liferay Portal the best it can be. Of course. Nate Cavanaugh. I'd also like to thank my daughter Julia for checking in on me from time to time and bringing some good cheer with her. So special thanks are due to Ray Auge. no one is perfect. If there is any way you think we could make this book better. our users and customers.As always.com/web/rsezov/blog xiii . please feel free to mention it on our forums. A lot of hard work went into polishing the material and making it as error-free as possible.liferay. sometimes) questions. Jorge Ferrer. Bruno Farache. it was rehashed electronically in outline form among a small group of Liferay employees until the final list of content was considered complete. I have endeavored to give credit to everyone who made a contribution (it's on the copyright page). You can also use any of the email addresses on our Contact Us page (http://www. Rich Sezov http://www. I want to thank my wife.com/web/guest/about_us/contact_us).com). we welcome any feedback. And of course. A couple of months later. This seems like a world away now. We are here to serve you.liferay. not a computer) on a plane flying from Philadelphia to Los Angeles. and so if we find any problems with the material. Deborah. but if I missed somebody—which would not be surprising—please let me know so your name is not left out of the next edition! I cannot express enough how wonderful it is to be surrounded by so many talented people who do everything they can to make this product the best it can be—even when a particular task is not their primary job. For this third edition. they will be corrected on the errata page for the book in Liferay's wiki (http://wiki. as Liferay has grown so much in the intervening years. and my job would be a lot more difficult were it not for their patience with me when I interrupt their work with some (pretty dumb. not only with the product. Author Notes The first edition of this book was outlined in a small notebook (paper. and Mike Young. as so much has changed. who continually has to put up with long hours as a computer widow. I couldn't do any of this without her. Alex Chow.liferay.

.

1. INTRODUCTION

Liferay Portal is the world's leading open source enterprise portal solution using the latest in Java and Web 2.0 technologies. 1. 2. 3. 4. 5. 6. Runs on all major application servers and servlet containers, databases, and operating systems, with over 700 deployment combinations JSR-286 Compliant Out-of-the-box usability with over 60 portlets pre-bundled. Built in Content Management System (CMS) and Collaboration Suite Personalized pages for all users Benchmarked as among the most secure portal platforms using LogicLibrary's Logiscan suite

Created for the enterprise, Liferay Portal provides a virtual space where you can centralize, share and collaborate. Built with the end user in mind, Liferay Portal's award winning user interface is easy enough to master by even the least technical of users. Liferay Portal also remains one of the most popular portal technologies within the developer community with an ever-growing list of features that help your IT team deploy business solutions with minimal time and effort.

Created for the Enterprise
Personalization and easy customization
Give the right people the right access to the right applications and documents! A highly granular permissions system allows you to customize the user experience at

Introduction the organizational and personal level.

Workflow adaptable
Liferay’s technology is built to quickly adapt business and organizational changes, ensuring minimal downtime in today’s fast-changing market.

Branding friendly
Liferay Portal is coded to easily adapt to your organization’s desired branding and look and feel.

Flexible organization
Liferay Portal is highly scalable for large, growing user bases. It accommodates the functional needs of even the most complex of enterprises--For example, your sub organizations can each be given its own portal experience with unique URL, login, look and feel and security permissions!

Built With The End-User In Mind
Liferay Portal’s award winning user interface offers dynamic, intuitive and time saving features that fosters user adoption across your entire organization.

AWARD-WINNING UI
Liferay Portal offers dynamic, intuitive and time saving features that foster user adoption across your entire organization. We were the first portal to introduce dragand-drop portlet re-positioning and continue to deliver innovative usability features for even the least technical of users!

ONE-CLICK LOOK WEB OS

AND

FEEL CHANGES

Deploy a new look and feel with one click without having to touch any code!

Work with Liferay’s Document Library like a network drive on your desktop with familiar folders. An optional free-floating portlet theme mimics the look and feel of your desktop environment.

Technology to Help Developers
Protect your development investment. Liferay Portal’s active and mature community always keeps the developer experience in mind.

16

Technology to Help Developers

Introduction

Standards Compliant
Liferay Portal complies with key industry standards, making it easy to work and integrate with.

Ready Integration
Partnerships with leading Open Source players such as Alfresco, ICEsoft, SpringSource, and Pentaho ensure unparalleled integration and support for these widelyused technologies.

Liferay Plugins Catalog
This exclusive feature of Liferay Portal keeps track of new versions of the software and instantly updates the technology without troublesome restarts. Liferay supports ALL major app servers, databases, and operating systems with over 700 deployment configurations. Please see our deployment matrix for more details.

Supported Technologies
Technologies Used: ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● ● Apache ServiceMix ehcache Hibernate ICEfaces Java J2EE/JEE jBPM JGroups jQuery JavaScript Framework Lucene MuleSource ESB PHP Ruby Seam Spring & AOP Struts & Tiles Tapestry Velocity Standards: ● ● ● ● ● ● ● ● AJAX iCalendar & Microformat JSR-286 JSR-127 JSR-170 Seats on the JSR-286 (Portlet 2.0) and JSF-314 (JSF 2.0) committees OpenSearch Open platform with support for web services including: ○ JSON ○ Hessian ○ Burlap ○ REST ○ RMI ○ WSRP WebDAV

Languages
Liferay supports I18N for any language out-of-the-box and ships with default translations for 22 languages. Most of these translations are maintained by native Languages 17

Introduction speakers of the languages from Liferay's open source community. Additional languages can be added very easily, and this has been done many times over the life of the product.

18

Languages

2. INITIAL SETUP

Liferay Portal is one of the most flexible applications with regard to application server environment on the market today. You can install Liferay Portal on everything from a shared Tomcat installation to a multi-node cluster running a commercial application server, and on everything in between. In fact, Liferay is used successfully in all of these scenarios every day. You will find that because Liferay is extremely flexible in its deployment options, it is easy to install as well. If you already have an application server, you can simply use the tools for deployment that came with your application server. If you do not have an application server, Liferay provides several application server bundles from which to choose. These are very easy to install and with a small amount of configuration can be made into production-ready systems.

Editions of Liferay
Liferay ships in two different editions: Liferay Portal Standard Edition (SE) and Liferay Portal Enterprise Edition (EE). SE is the same Liferay Portal that has been available for years: frequently updated and bursting with the latest features, the standard edition of Liferay Portal is offered for free under the business-friendly MIT open source license. Liferay Portal EE is a supported version of Liferay Portal for the enterprise. Hardened for security and designed to be rock solid stable, EE is offered with a subscription and support package, allowing organizations to build their portals on a stable version of the product that is offered over an extended period of time. Because the release cycle for EE is longer than that for SE, each enterprise release is supported for 4 years. All bug fixes in Liferay Portal are backported to your version of Liferay for the duration of your subscription. This gives organizations the peace of mind that comes from knowing that their Liferay-powered web site is stable and will run for years to come, enabling them to build their sites on a proven, stable platform. Additionally, Liferay's professional services team offers training and consulting on the Enterprise Edition to ensure long-term support and stability for our cli-

Initial Setup ents.

Obtaining Liferay
The SE version of Liferay is freely downloadable from our web site at http://www.liferay.com. Click on the Downloads link at the top of the page, and you will be presented with multiple options for getting a copy of Liferay, including our convenient bundles or a .war package for installation on your application server of choice. The EE version of Liferay will be provided to you as a result of your support subscription. You will be provided with download links which will allow you to obtain a copy of a Liferay bundle or a .war package for installation on your application server of choice. If you want to install a bundle, there is a list of bundles available. If you do not currently have an application server, it is best to download the Tomcat bundle, as Tomcat is one of the smallest and most straightforward bundles to configure. If you have an application server preference, you can also choose the server you prefer from the available Liferay Portal bundles. Having a JDK (Java Development Kit) already installed is a prerequisite to running any of the bundles. Please note that Liferay is not able to provide application server bundles for proprietary application servers such as WebLogic, WebSphere, or Oracle Application Server because the licenses for these servers do not allow for redistribution. Liferay Portal, however, runs just as well on these application servers as it does on open source application servers. You will need to use the .war package to install Liferay on these application servers. For a manual install, you will need the Liferay .war file as well as Liferay's dependency .jars. Later in this chapter are instructions for installing Liferay on many of the major application servers available today.

Installing a Bundle
Liferay bundles contain the same directory structure regardless of application server. The top-level folder is named for the release of Liferay. This folder is also sometimes called Liferay Home. Inside this folder, you will find folders for various uses: Data: This folder is used to store the emIllustration 1: Bundle directory bedded HSQL database which the bundles use, structure as well as the configuration and data for the Jackrabbit JSR-170 content repository and the Lucene search index. Deploy: Plugins which you wish to deploy to Liferay can be copied into this folder. It is also used by Liferay's graphical plugin installer utility, which is available from the Control Panel.

20

Installing a Bundle

sh The Liferay / Tomcat bundle will then launch. You can now begin exploring the various features of Liferay. In most cases. If you are on Windows. You can access this site and log in as the various users to get familiar with Liferay and what it Installing a Bundle 21 .. launch your web browser and then go to the following address: http://localhost:8080. This folder contains the application server in which Liferay has been installed.Initial Setup License: Contains both Liferay's license and a file which describes the licenses for many of the other open source projects that are used internally by Liferay. [Application Server]: There will also be an application server folder which is different depending on which bundle you have downloaded. The default Liferay home page will then appear in your web browser. you will see another command prompt window appear with Tomcat's console in it.out Once Tomcat has completed its startup. If you are on Linux. called 7 Cogs. but it is fully functional. For example. If you drop to a command prompt and go to this folder. Tomcat is launched by way of a script which is found in its bin folder. you can see the Tomcat console by issuing the following command: tail -f . installing a bundle is as easy as uncompressing the archive and then starting the application server. Now you would start Tomcat in the same way as you would if you had downloaded it manually. you can launch Tomcat via the following command on Windows: startup or the following command on Linux / Mac / Unix: . it should automatically launch a web browser so you can see the home page. if you were to install Liferay Portal on Tomcat. Illustration 2: Default Page in the Liferay Bundles Liferay ships by default with a sample web site included. It will be using an embedded database for its configuration. you would simply unzip the bundle to a location of your choice./startup. If it does not./logs/catalina.

These three modify Liferay's default behavior in order to make the 7 Cogs application work properly. and then view the portal in your web browser. Because this is by far the quickest and easiest method to get a production Liferay system running. bundles are the easiest way to get started with Liferay. It is easiest to do this by starting with a bundle and then reconfiguring that bundle so that it is enterprise-ready. you will want to remove: • • • sevencogs-hook sevencogs-theme wol-portlet If you forget to undeploy these three applications before you connect Liferay to your real database. after you've completed your evaluation and you want to begin building your web site. In this situation. And with minimal extra configuration (which we will see later). especially if you already have data in your database. Sample Data While the sample 7 Cogs data is a good example of how Liferay might be used. you will want to install Liferay onto a real server. This 22 Installing Liferay for an Enterprise . They come pre-configured with a running Liferay that can be used immediately to explore all of the things that Liferay can do. the sample data will be created in your database and may cause issues. you won't want that data cluttering up your database. however. we will look at this first. there is a new folder defined as Liferay Home. when you are ready to build your own site. Use your application server's method for undeploying applications in order to remove them. So before you connect Liferay to your production database. enterprises will have an established Java EE infrastructure upon which they would like to install Liferay. Most of this section. launch the application server. Installing a different bundle is done in exactly the same way: unzip the bundle into the folder of your choice.0 and higher. will focus on installing Liferay onto an already-established application server.2. So you want to make sure that you get these three applications undeployed before setting up your server. Liferay Home In Liferay 5. There are three applications included in the bundle that you will need to remove. Because we want to revert Liferay's behavior back to its defaults for a clean install. you will want to make sure you have removed the sample 7 Cogs data from your Liferay installation.Initial Setup can do. This is as simple as undeploying the included 7 Cogs applications from the bundle. therefore. As you can see. a bundle will not suffice. Often. bundles can be converted into full production-ready systems. Installing Liferay for an Enterprise Eventually.

Insert. as it allows you to take advantage of Liferay's ability to automatically maintain its database through various plugin installs which may create tables of their own and through upgrades of the platform. For these organizations. it will fall back to defining the home folder in the home folder of the user ID that is running Liferay. you will need to grant those rights to the ID before you start your upgraded Liferay for the first time. If your organization is willing to grant the Liferay user ID permissions to create and drop tables in the database—and this is the recommended configuration—you can skip this section. Select. If Installing Liferay for an Enterprise 23 . As described above in the Bundles section. The aforementioned folders (data. It is by far the best way to set up your Liferay installation. and so we will go over how to set up the database manually. Additionally. or if it finds itself running on certain application servers. This is the recommended way to set up Liferay. the home folder is very important to the operation of Liferay. this folder may be one folder up from the domain in which Liferay is running. Database Setup DEFAULT METHOD: AUTOMATIC If you create your database and grant a user ID full access to it. In the case of a server which defines different domains for different instances of the server. many plugins provided by Liferay require that new tables be added to Liferay's database.properties there. and Delete are generally all the permissions that are granted. This file will be fully documented in Chapter 5: Advanced Liferay Configuration. These plugins cannot be installed if Liferay does not have permission to create these tables automatically. and license) will be created there. and you can also put a special configuration file called portal-ext. Update. If you will be setting up Liferay's database with the recommended permissions. Liferay can use that user ID to create its indexes and tables automatically. you can remove those rights until the next upgrade.Initial Setup folder for most application servers is one folder higher than the location of the application server itself. If the user ID that accesses the database does not have enough rights to create / modify / drop tables in the database. deploy. MANUAL METHOD Even though Liferay can create its database automatically. but we will use it in this chapter for some basic configuration. you can skip the next section. One other caveat is this: Liferay has an automatic database upgrade function which runs when the version of Liferay is upgraded to a new release. including setting up Liferay to talk to our database. If Liferay is unable to create the resources it needs in this folder. Once the upgrade is complete. some enterprises prefer not to allow the user ID configured in an application server to have the permissions over the database necessary for Liferay and its plugins to maintain their tables.

This script creates the necessary Liferay tables in the database. however. This can be useful from a development perspective. with a minimum configuration. Download this file and unzip it. you will need to grant rights to create tables in the database before you attempt to install them. A DBA can use the script provided to create the Liferay database. Once your DBA has created the database and provided the credentials for accessing it. and drop tables and indexes. however.com embedded in it. be sure that the ID that the portal will use to connect to the database has at least Select. You will find that it contains a folder structure that is broken down by the type of script (full. This is most appropriate for a new installation of Liferay. as it contains working examples of the use of many of Liferay's features. complete with the indexes necessary for optimal performance. Preferably.0 Jetty JOnAS+Jetty JOnAS+Tomcat Resin Tomcat 5. Turning a Bundle into an Enterprise Portal Liferay Portal is distributed with the following bundle options for servlet containers and full Java EE application servers: ● ● ● ● ● ● ● ● ● ● Geronimo+Tomcat Glassfish 2 and 3 JBoss+Tomcat 4. is not necessary for the daily operation of Liferay.0 24 Installing Liferay for an Enterprise . Insert. Liferay provides an SQL script archive download on the web site. The create script. It is best to use the create-minimal script if you are installing a fresh version of Liferay on a development. Once this is done. For the EE version. or production server. minimal. by contrast. For the SE version. you are ready to begin 1) making a bundle enterprise-ready or 2) manually installing Liferay on your application server.2 JBoss+Tomcat 5. as this makes upgrading easier. the ID should also have rights to create. you will be provided a link to this archive. QA. and then further by database vendor type. and Delete permissions. Inside the create or create-minimal folders are scripts for every database that Liferay supports.5 Tomcat 6. it is in the Additional Files section of the Downloads page. including the Journal Content Management System. This.liferay. or upgrade).Initial Setup you wish to install these plugins. modify. Update. configures a Liferay database with a portion of the content from http://www.

While this is a good method to have it up and running fast for evaluation or development. [Optional] Create a Data Source called jdbc/LiferayPool in your application server which points to your database and has the proper credentials to access it. THE PORTAL-EXT. This configuration does not scale well and will have performance problems when multiple users are accessing the system. This is because the data is stored on a file on disk and HSQL locks it when doing changes. Create the database in your DBMS of choice (see the above section labeled Database Setup for further information).5 or higher) installed on the machine to which you are installing Liferay.properties file in the Liferay Home folder which either points directly to the database and mail session or points to the application server's Data Source and mail session. 3. but can be summarized as: 1.Initial Setup Choose your preferred bundle and download it from the downloads page on Liferay's web site or via the EE links that were provided to you. [Optional] Create a mail session called mail/MailSession in your application server which points to your mail server. with the exception that Liferay is pre-installed in them. you do not want to be running Liferay against the embedded database. Start Liferay. For example. create a file called portal-ext. Create a portal-ext. Make sure that you have also created the JAVA_HOME environment variable and have pointed it to your Java installation. Unzip the bundle to the location from which you are going to run it. and the JVM settings may have been optimized for use with Liferay. Liferay has great support for a good number of production-ready databases. The exact instructions will depend on the application server and database. 5. you will have had to prepare the database first by running the appropriate create script. This file overrides default properties that come Installing Liferay for an Enterprise 25 . 4. A prerequisite for running any of the bundles is that you have the proper version of the Java Develoment Kit (1. you might use D:\apps in Windows or /opt in Linux or UNIX variants. it has several drawbacks: ● ● ● Only one user can access it at a time. 2. The default bundle installation of Liferay Portal uses an embedded database. There is no difference between the Liferay bundles and the regular distribution archives of the application servers as they are available from their own sites. Obviously. so Liferay can send mail.PROPERTIES FILE To point your Liferay bundle to your database. Fortunately. and it is easy to configure Liferay to use them.properties in your Liferay Home folder. Refer to the manual installation instructions below for further details on configuring the various application servers. Liferay will create the tables automatically and start. The data is stored inside the bundle and might be lost on redeployment. Otherwise.

It should be called jdbc/LiferayPool.mail.jdbc. add the following directives to your portal-ext.auth=false mail.smtp.default.smtp.default.session.session.mail. The template for MySQL is provided as an example below. If you want to use your application server's connection pool.jndi. add the following directive to your portal-ext.pop3.properties file: mail. you have two ways to configure your server: • • Use your application server's mail session.pop3.properties file: jdbc.Driver jdbc.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.password= You would provide the user name and password to the database as values for the username and password directives.mysql.mail. # # MySQL # jdbc. Again.host=localhost mail.session.pop3.mail. For mail.mail.name=jdbc/LiferayPool To use the built-in connection pool—based on C3P0—add the template which is provided in Chapter 5 for your particular database.password= mail.Initial Setup with Liferay. Use the built-in connection pool.session. substituting your mail server information: mail. you will have to create one in your application server that points to your database.mail. You are going to override the default configuration which points Liferay to the embedded HSQL database.password= mail.name=mail/MailSession To use the built-in mail session. To cause Liferay to use this connection pool.port=110 mail.driverClassName=com. To use your application server's mail session.session.session.default.session.smtp.smtp.host=localhost mail.properties file. add the following directive to your portal-ext. There are two ways to set up the connection: • • Use your application server's connection pool.username= jdbc.default.port=25 26 Installing Liferay for an Enterprise .user= mail.mail. there is a similar procedure. Once you have done that.mail.jndi.default.session.pop3.session. Use the built-in mail session. you will have to create one in your application server that points to your mail server.

Installing Liferay for an Enterprise 27 . Shut your application server down.session. Add either the JNDI name of your data source or the JDBC parameters above to connect Liferay to your database. move it to a different context or undeploy it.session. substitute the JDBC driver and URL construct for your database in place of the MySQL ones shown here.Initial Setup mail.protocol=pop3 mail. 10. Liferay supports a wide combination of application servers and databases. for brevity this section assumes MySQL as the database. It is recommended that you have a good understanding of how to deploy Java EE applications in your application server of choice. Decide whether you want to use your application server's data sources or if you want to use the one included with Liferay. that the database has already been created. This allows both Liferay and plugins to access these dependencies.session. Decide whether you want to use your application server's mail session or if you want to use the one included with Liferay. and that you are using your application server's mail session and data source. create one called mail/MailSession.transport.war file and the dependencies archive.properties file and place it in the Liferay Home folder. deploy the Liferay .mail. 8.user= mail. 2. 5. If you do. See the notes on specific application servers below for the location of this folder for your application server. create a data source for Liferay called jdbc/LiferayPool. 4. Start your application server. Obtain the Liferay . and start it.war file.mail. 3. Extract the dependencies to a location on your server's global class path. If you want to use your application server's mail session.store. 6. The instructions below are specific for each application server that Liferay supports. this is one folder up from where your application server is installed. Add either the JNDI name of your mail session or the mail parameters above to connect Liferay to your mail server.mail. 9. Make sure you do not have an application listening at the root (/) of your server. You can now start your application server. 7. Installing Liferay on an Existing Application Server This section contains detailed instructions for installing Liferay Portal using its WAR distribution. This allows system administrators to deploy Liferay in existing application server installations.protocol=smtp Save the file. If you want to use your application server's data source. INSTALLING LIFERAY IN 10 EASY STEPS There are 10 generic steps to installing Liferay on an existing application server: 1. To use other databases.smtp. Generally. Create a portal-ext. Because of this.

4. Illustration 3: Glassfish JDBC Connection Pool DATABASE CONFIGURATION If you want Glassfish to manage your data source.X Liferay Home is one folder above GlassFish's install location.x. 2. If you still need to install your application server. substitute localhost with the host name or IP of the server.4 or lower.x requires JDK 1. If you want Liferay to manage your data source. you will need to upgrade your application server in order to user Liferay 5. Do not attempt to install Liferay 5. GLASSFISH 2. it will not work.4 or lower. Liferay 4. you can skip this section.Initial Setup We also assume your application server is already installed and running successfully. follow the instructions below. When installing to a remote server. password: adminadmin. create your portal-ext. The following instructions assume an installation on a local machine. for all of these application servers. Remember. Copy xercesImpl. however. Download the latest Liferay Portal . Start Glassfish if it hasn't already been started.properties file in the Liferay Home folder and make sure it points to your database connection pool and mail session. Go to the Glassfish Administration Console at http://localhost:4848. Default login credentials are user name: admin. Tip: Note that Liferay 5. 28 Installing Liferay for an Enterprise . where $GLASSFISH_HOME is the directory where Glassfish is installed. Copy the dependencies . will run fine on these application servers.x. 1. 5.jars into $GLASSFISH_HOME/domains/domain1/lib. If you are running an application server that ships with a JDK and that JDK is 1.5 or greater. 3. please follow your vendor's instructions first.war file and dependencies.x on an application server that runs under Java 1.jar and JDBC driver into the same place.

You will see a list of JDBC Resources by JNDI Name. and select MySQL as the Database Vendor.Initial Setup 1. you can skip this section. Under Other Tasks. a Resource Type of javax. If you get a Ping Succeeded message. In the first screen. Find the property called URL. 11. select Create New JDBC Connection Pool.characterEncoding=UTF-8&amp. and add a property called password with a value of the password to connect to the database. Click Next. 2. Click Add Property. Installing Liferay for an Enterprise 29 . click the LiferayPool and click the Ping button. Click OK.sql. If your database is not on the same server as Glassfish. If you want Liferay to manage your mail session. everything has been set up correctly. give it a name of LiferayPool. and add a property called user with a value of the user name to connect to the database. substitute your database server's host name for localhost above. Make the JNDI Name jdbc/LiferayPool and select the LiferayPool you created earlier.emulateLocators=true 3. You will now see a list of Connection Pools. 8. follow the instructions below. 9. Click New. 7. Click JDBC Resources. On the next page. 6. 10. scroll down to the Additional Properties section. and set its value to: jdbc:mysql://localhost/lportal?useUnicode=true&amp. 5. To test your connection. 4. Click Finish.ConnectionPoolDataSource. Click Add Property again. Illustration 4: Glassfish Mail Session MAIL CONFIGURATION If you want GlassFish to manage your mail session.

jndi.sun.mail.user= mail. 6. Click New. add the JNDI name instead: mail. 5.session.ss. Add the following directives to the file: jdbc. 3. add the JNDI name instead: jdbc. Click JVM Settings -> JVM Options.session.session.protocol=pop3 mail.pop3.session.server.x.password=root If you are using GlassFish's data source.host=localhost mail. Give the JavaMail Session a JNDI name of mail/MailSession.session.password= mail. 3.default. Click OK.session.session.port=110 mail.jndi.mysql.mail.pop3.smtp. Create a file called portal-ext.smtp. DEPLOY LIFERAY 1.mail.default.session.mail.jdbc. 4.user= mail.session.properties. and enter the following: -Dcom.name=mail/MailSession 30 Installing Liferay for an Enterprise .mail.x.host=localhost mail. click JavaMail Sessions.session.mail. and fill out the rest of the form with the appropriate information for your mail server. Click Add JVM Option. If you are using the built-in configuration.Initial Setup 1.pop3. 2. 4.transport. set the following properties for your system: mail.driverClassName=com.auth=false mail.war file you downloaded in step 1 into the $GLASSFISH_HOME/domains/domain1/autodeploy directory.smtp.Driver jdbc.protocol=smtp If you are using Glassfish's mail session.mail.port=25 mail. Log out of the Administration Console and stop Glassfish.session.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.default.default.username=root jdbc.name=jdbc/LiferayPool Do the same thing for the Mail Session. Deploy Liferay by copying the liferay-portal-x.ASQuickStartup=false Click Save.session.password= mail.default.store.mail.mail. Click Application Server at the top of the tree hierarchy on the left. 2.mail.smtp.pop3. Under Resources.enterprise.mail.smtp. 7.

1. 1. 4. you will need to modify some settings in the domain you will be using to increase the default amount of memory available. We will assume for these instructions that you are using the default domain stored in [GlassFish Root]/glassfish/domains/domain1. DATABASE CONFIGURATION If you want GlassFish to manage the data source. Change this to: <jvm-options>-Xmx1024m</jvm-options> 3. 5.xml in this folder. Delete or move this file to another location. GLASSFISH 3.Initial Setup Save and close the file. This folder contains a default page for the domain in a file called index. If you want to use the built-in Liferay data source. 8. Open the file called domain. Go to the GlassFish console URL: http://localhost:4848.html. Before starting GlassFish. When Liferay finishes starting. Start GlassFish.X Liferay Home is in the Glassfish root folder. Installing Liferay for an Enterprise 31 . Extract the Liferay dependencies archive into your domain's lib folder. You should see the default Liferay home page. open http://localhost:8080 in your browser. use the following instructions. you will find the following JVM option being set: <jvm-options>-Xmx512m</jvm-options> 2. Add another line after this line with the following JVM option: <jvm-options>-XX:MaxPermSize=256m</jvm-options> Save and close the file. At approximately line 166 of this file. In your domain folder is a config folder. Extract your database's JDBC driver here as well. you can skip this section. In your domain folder is a folder called docroot.

You will see a list of JDBC Resources by JNDI Name.emulateLocators=true 4. MAIL CONFIGURATION At the time of this writing. 3. Click Add Property. 9. If your database is not on the same server as Glassfish. On the next page. In the first screen. 11. and add a property called password with a value of the password to connect to the database. select Create New JDBC Connection Pool. click the LiferayPool and click the Ping button. a Resource Type of javax. 13. substitute your database server's host name for localhost above. 5. 10. JavaMail is not yet implemented in GlassFish 3.Initial Setup Illustration 5: Glassfish JDBC Connection Pool 2.sql. 6. Under Other Tasks.characterEncoding=UTF-8&amp. Click New. and select MySQL as the Database Vendor. 7. 8. If you get a Ping Succeeded message. and add a property called user with a value of the user name to connect to the database. 32 Installing Liferay for an Enterprise . You will now see a list of Connection Pools. Click OK. scroll down to the Additional Properties section.ConnectionPoolDataSource. Click Add Property again. give it a name of LiferayPool. everything has been set up correctly. For this reason. Find the property called URL. and set its value to: jdbc:mysql://localhost/lportal?useUnicode=true&amp. Click Next. Make the JNDI Name jdbc/LiferayPool and select the LiferayPool you created earlier. you will have to use the mail session that is provided by Liferay. Click Finish. Click JDBC Resources. To test your connection. 12.

smtp.port=25 mail.properties. Save and close the file.protocol=pop3 mail.user= mail.session.Initial Setup DEPLOY LIFERAY 1.mail.host=localhost mail. 6.password= mail.mail. Liferay will be deployed and started automatically.mail.session.session.store.mail. Add the following directives to the file: jdbc. set the following properties for your system: mail.mail.session.session.smtp.smtp. If you are using the built-in configuration.password= mail.host=localhost mail.default.jndi.default. 4.session.password=root If you are using GlassFish's data source.mail.transport.default. so you do not have the option to use one via JNDI.name=jdbc/LiferayPool Do the same thing for the Mail Session. 3.username=root jdbc.mail. 5.mail.protocol=smtp GlassFish 3 has not yet implemented JavaMail.mail.session. Click Browse and browse to the location of the Liferay .pop3.Driver jdbc.session. Go to the GlassFish console URL: http://localhost:4848 Click Web Applications in the tree on the left.war file.default.mail.smtp.pop3.auth=false mail.user= mail. Click the Deploy button.port=110 mail. add the JNDI name instead: jdbc.pop3. Leave the rest of the defaults and click OK.default.session. Installing Liferay for an Enterprise 33 .session. Create a file called portal-ext.smtp.session.driverClassName=com.mysql.jdbc.pop3.mail. 2.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.

jdbc. Download the Liferay Portal .characterEncoding=UTF-8</Set> 34 Installing Liferay for an Enterprise .config. Download Liferay Portal Dependencies. 3.Initial Setup JETTY 6 1.JotmService"> name="Name">TransactionMgr</Set> name="addDataSource"> <Arg>jdbc/LiferayPool</Arg> <Arg> <New <Set class="org.xml. Download and install Jetty 6.Driver</Set> <Call Source"> <Set name="Url">jdbc:mysql://localhost/lportal?useUnicode=true&amp.jetty. $(jetty. Create a $JETTY_HOME/lib/ext directory and copy the dependencies to it. Illustration 6: Deploying Liferay in GlassFish 3 Liferay Home is one folder above Jetty's install location.mysql. 2.StandardXADataname="DriverName">com.home)/lib/ext/ $(jetty.standard. 5.enhydra. Create a data source $JETTY_HOME/etc/jetty.plus. 4.jdbc. <Call name="addService"> <Arg> <New <Set bound to jdbc/LiferayPool by editing class="org.mortbay.war file. Edit $JETTY_HOME/extra/etc/start-plus.home)/lib/ext/* 6.

1. Create run.liferay. 10.mortbay. For other platto Installing Liferay for an Enterprise 35 . Create a directory $JETTY_HOME/bin. 2. required.Initial Setup <Set <Set </New> </Arg> <Arg> Source"> <New <Arg <Set <Set </New> </Arg> </Call> </New> </Arg> </Call> class="org. this is for Windows platform.jaas.PortalLoginModule }. Create a mail session bound to mail/MailSession by editing $JETTY_HOME/etc/ jetty.config. This is the JDBC driver for MySQL.bat (Note.pool.jetty.StandardXAPoolDatatype="Integer">4</Arg> name="MinSize">4</Set> name="MaxSize">15</Set> name="User"></Set> name="Password"></Set> 7.jdbc. 11. PortalRealm { com.war file into it.jar and xml-apis. If you are using a different database. Go to $JETTY_HOME/webapps/root/WEB-INF/lib and delete xercesImpl.jar.enhydra.portal. Create directory $JETTY_HOME/webapps/root and unpack the Liferay .jar and copy to to $JETTY_HOME/lib/ext. 9. copy the appropriate driver.MailService"> name="Name">MailService</Set> name="JNDI">mail/MailSession</Set> name="mail. Create batch file.xml: <Call name="addService"> <Arg> <New <Set <Set <Put </New> </Arg> </Call> class="org. Download mysql-connector-java-{$version}-bin. 16.host">localhost</Put> 8. 15. Copy $JETTY_HOME/webapps/root/WEB-INF/lib/commons-logging.kernel.plus.security.smtp.jar $JETTY_HOME/ext (overwriting existing one). Create $JETTY_HOME/etc/jaas.

servlets.catalina.config=. Download and install JBoss AS into your preferred directory. 3.04 / 4.security. 2.05 / 4.OutOfMemoryError exception while starting up Jetty.3 Liferay Home is one folder above JBoss's install location. Download the Liferay Portal ..jar .war file and dependencies.lang..timezone=GMT Djava.DefaultServlet</servlet-class> <init-param> <param-name>debug</param-name> <param-value>0</param-value> </init-param> <init-param> <param-name>listings</param-name> <param-value>true</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> with: 36 Installing Liferay for an Enterprise .xml.deployer/conf/web.auth.login...apache. Start Liferay by running run. configure accordingly). Replace the default servlet (lines 79-91) : <servlet> <servlet-name>default</servlet-name> <servlet-class>org. From now on.2 / 4.03SP1 / 4.config -jar . Open your browser to http://localhost:8080./etc/jetty. @echo off if "" == "%JAVA_HOME%" goto errorJavaHome %JAVA_HOME%/bin/java -Xmx512m -Dfile. You should see the default Liferay home page. the directory where you installed JBoss will be referred to as $JBOSS_HOME. give your JVM more memory by setting -Xmx512m./start. Edit $JBOSS_HOME/server/default/deploy/jboss-web.bat.config -DSTART=. JBOSS 4. Note: If you get a java.xml goto end :errorJavaHome echo goto :end JAVA_HOME end not defined. 4./extra/etc/start-plus./etc/jaas.encoding=UTF8 -Duser.Initial Setup forms.

servlets. you can skip this section. 6. use the following instructions.catalina. download mysql-connector-java{$version}-bin.Initial Setup <servlet> <servlet-name>default</servlet-name> <servlet-class>org. Create $JBOSS_HOME/server/default/deploy/liferay-ds. If you want to use the built-in Liferay data source. If you are using a different database. Put the Liferay Portal dependency .mysql.DefaultServlet</servlet-class> <init-param> <param-name>debug</param-name> <param-value>0</param-value> </init-param> <init-param> <param-name>listings</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>input</param-name> <param-value>4096</param-value> </init-param> <init-param> <param-name>output</param-name> <param-value>4096</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> 5.characterEncoding=UTF-8 </connection-url> <driver-class>com. copy the appropriate driver. DATABASE CONFIGURATION If you want JBoss to manage the data source.jars into $JBOSS_HOME/server/default/lib.jdbc.apache.xml with following content: <datasources> <local-tx-datasource> <jndi-name>jdbc/LiferayPool</jndi-name> <connection-url> jdbc:mysql://localhost/lportal? useUnicode=true&amp. Go to $JBOSS_HOME/server/default/lib/.Driver</driver-class> <user-name></user-name> <password></password> <min-pool-size>0</min-pool-size> </local-tx-datasource> </datasources> Installing Liferay for an Enterprise 37 .jar and copy to this directory. This is the JDBC driver for MySQL.

Initial Setup

MAIL CONFIGURATION
If you want JBoss to manage the mail configuration, use the following instructions. If you want to use the built-in Liferay mail session, you can skip this section. Set mail properties by replacing the contents of $JBOSS_HOME/server/default/deploy/mail-service.xml with:
<?xml version="1.0"?> <server> <mbean code="org.jboss.mail.MailService" vice=MailSession"> <attribute <attribute <attribute <attribute <property <property <property <property <property name="User">nobody</attribute> name="Password">password</attribute> name="Configuration"> name="mail.store.protocol" name="mail.imap.host" name="mail.pop3.host" name="mail.smtp.host" value="imap" /> /> /> /> /> name="jboss:ser-

name="JNDIName">mail/MailSession</attribute>

<configuration> name="mail.transport.protocol" value="smtp"

value="localhost" value="localhost" value="localhost"

</configuration> </attribute> </mbean> </server>

DEPLOY LIFERAY
Configure JAAS. Edit $JBOSS_HOME/server/default/conf/login-config.xml and comment out the entire XML for policy other in lines 140-156.
<!--<application-policy name = "other">--> ... <!--<authentication> <login-module th.spi.UsersRolesLoginModule" flag </authentication> </application-policy>--> = code = "org.jboss.security.au/>

"required"

Deploy the Liferay Portal .war file. ● ● ● Create new directory $JBOSS_HOME/server/default/deploy/liferayportal.war. Unzip liferay-portal-x.x.x.war to directory. Go into $JBOSS_HOME/server/default/deploy/liferay-portal.war/lib. ● ● Move dom4j.jar, jaxen.jar to $JBOSS_HOME/lib. Move commons-collections.jar goes to $JBOSS_HOME/server/default/lib. Installing Liferay for an Enterprise

38

Initial Setup ● remove hibernate3.jar, jboss-hibernate.jar $JBOSS_HOME/server/default/lib. from

Edit $JBOSS_HOME/server/default/deploy/jbossjca-service.xml. Change the Debug attribute in line 63 from true to false:
<attribute name="Debug">false</attribute>

Edit $JBOSS_HOME/server/default/deploy/jms/jbossmq-destinations-service.xml. Clear out text between server tags:
<?xml version="1.0"?> <server> </server>

Create a file called portal-ext.properties. Add the following directives to the file:
jdbc.default.driverClassName=com.mysql.jdbc.Driver jdbc.default.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.default.username=root jdbc.default.password=root

If you are using JBoss's data source, add the JNDI name instead:
jdbc.default.jndi.name=jdbc/LiferayPool

Do the same thing for the Mail Session. If you are using the built-in configuration, set the following properties for your system:
mail.session.mail.pop3.host=localhost mail.session.mail.pop3.password= mail.session.mail.pop3.port=110 mail.session.mail.pop3.user= mail.session.mail.smtp.auth=false mail.session.mail.smtp.host=localhost mail.session.mail.smtp.password= mail.session.mail.smtp.port=25 mail.session.mail.smtp.user= mail.session.mail.store.protocol=pop3 mail.session.mail.transport.protocol=smtp

If you are using JBoss's mail session, add the JNDI name instead:
mail.session.jndi.name=mail/MailSession

Save and close the file. Start JBoss. Open your browser to http://localhost:8080. You should see the default Liferay home page.

JBOSS 5.X
Liferay Home is one folder above JBoss's install location. 1. Download and install JBoss AS 5.0.1 GA into your preferred directory. This directory will be referred to below as $JBOSS_HOME. 39

Installing Liferay for an Enterprise

Initial Setup 2. 3. Download the latest version of the Liferay Portal .war file. Go to $JBOSS_HOME/server/default/lib/. Download mysql-connector-java{$version}-bin.jar and copy to this directory. (This is the JDBC connector for MySQL. Use the appropriate driver for your database.) Download Liferay's Portal Dependencies. Unzip to $JBOSS_HOME/server/default/lib. Configure JAAS. Edit $JBOSS_HOME/server/default/conf/login-config.xml and comment out the entire XML for policy other in lines 115-131.

4. 5.

<!--<application-policy name = "other">--> ... <!--<authentication> <login-module code = "org.jboss.security. auth.spi.UsersRolesLoginModule" flag = "required" /> </authentication> </application-policy>-->

DATABASE CONFIGURATION
If you want JBoss to manage the data source, use the following instructions. If you want to use the built-in Liferay data source, you can skip this section. Create $JBOSS_HOME/server/default/deploy/liferay-ds.xml with following content:
<datasources> <local-tx-datasource> <jndi-name>jdbc/LiferayPool</jndi-name> <connection-url> jdbc:mysql://localhost/lportal?useUnicode=true&amp;characterEncoding=UTF-8 </connection-url> <driver-class>com.mysql.jdbc.Driver</driver-class> <user-name></user-name> <password></password> <min-pool-size>0</min-pool-size> </local-tx-datasource> </datasources>

MAIL CONFIGURATION
If you want JBoss to manage the mail configuration, use the following instructions. If you want to use the built-in Liferay mail session, you can skip this section. Set mail properties by replacing the contents of $JBOSS_HOME/server/default/deploy/mail-service.xml with:
<?xml version="1.0"?> <server>

40

Installing Liferay for an Enterprise

Initial Setup
<mbean code="org.jboss.mail.MailService" name="User">nobody</attribute> name="Password">password</attribute> name="Configuration"> name="mail.store.protocol" name="mail.imap.host" name="mail.pop3.host" name="mail.smtp.host" value="imap" /> /> /> /> /> name="jboss:service=MailSession">

<attribute <attribute <attribute <attribute <property <property <property <property <property

name="JNDIName">mail/MailSession</attribute>

<configuration> name="mail.transport.protocol" value="smtp"

value="localhost" value="localhost" value="localhost"

</configuration> </attribute> </mbean> </server>

DEPLOY LIFERAY
1. 2. 3. 4. 5. 6. Delete all the files and $JBOSS_HOME/server/default/deploy/ROOT.war Unzip the Liferay .war file to the ROOT.war directory. Go to $JBOSS_HOME/server/default/deploy/ROOT.war/lib. Remove jaxen.jar, jaxrpc.jar, stax.jar, xercesImpl.jar, xml-apis.jar from $JBOSS_HOME/server/default/deploy/ROOT.war/WEB-INF/lib Navigate to the Liferay Home folder, which is one folder above JBoss's install location. Create a file called portal-ext.properties. Add the following directives to the file: folders in

jdbc.default.driverClassName=com.mysql.jdbc.Driver jdbc.default.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.default.username=root jdbc.default.password=root

If you are using JBoss's data source, add the JNDI name instead:
jdbc.default.jndi.name=jdbc/LiferayPool

Do the same thing for the Mail Session. If you are using the built-in configuration, set the following properties for your system:
mail.session.mail.pop3.host=localhost mail.session.mail.pop3.password= mail.session.mail.pop3.port=110 mail.session.mail.pop3.user= mail.session.mail.smtp.auth=false mail.session.mail.smtp.host=localhost mail.session.mail.smtp.password=

Installing Liferay for an Enterprise

41

Initial Setup
mail.session.mail.smtp.port=25 mail.session.mail.smtp.user= mail.session.mail.store.protocol=pop3 mail.session.mail.transport.protocol=smtp

If you are using JBoss's mail session, add the JNDI name instead:
mail.session.jndi.name=mail/MailSession

Save and close the file. Start JBoss. Open your browser to http://localhost:8080. You should see the default Liferay home page.

ORACLE APPLICATION SERVER (OC4J)
Liferay Home is located in the home folder of the user running OC4J. These instructions assume you have an installed OC4J container 10.1.3.4.0 in a folder that will be referred to as $OC4J_HOME. Unzip the dependencies archive (which is downloadable from Liferay's web site) into $OC4J_HOME/j2ee/home/applib. Put your JDBC driver here as well. OC4J contains a startup script in the bin folder of the application server directory. You will need to edit this file and change some of the arguments. On Windows systems, the filename of the script is oc4j.cmd. On Linux / Unix systems, the filename of the script is oc4j. Find the line in this file that contains the JVMARGS variable:
JVMARGS=$OC4J_JVM_ARGS

Modify the line so it reads like the following:
JVMARGS=$OC4J_JVM_ARGS -Doc4j.jmx.security.proxy.off=true -Xms512m -Xmx512m -XX:MaxPermSize=256m

DATABASE
1.

AND

CONNECTION POOL

If you are using Liferay's built-in data source, you can skip this section. Click Administration -> JDBC Resources.

2. 3. 4.

Illustration 7: OC4J: JDBC Resources Under Connection Pools, click Create. Select New Connection Pool and click Continue. Give it a name, such as LiferayPool. If you are not using an Oracle database, you will have to specify the connection factory class manually. For example,

42

Installing Liferay for an Enterprise

Initial Setup the connection factory class for MySQL is com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource. 5. Fill out the JDBC URL to your database. You should have already configured your database and optionally run the Liferay create script.

Illustration 8: OC4J: Connection Pool 6. 7. 8. Click Finish. Under Data Sources, click Create. Select Managed Data Source (default) and click Continue. Give it a name (LiferayDataSource) and a JNDI location of jdbc/LiferayPool. Select the Connection Pool you created in the previous step and then click Finish.

Installing Liferay for an Enterprise

43

Initial Setup Illustration 9: OC4J: Liferay Data Source 9. and then click Test. Illustration 10: Deploying the Liferay . If you are not using an Oracle database. If not. 3. Click Applications. Wait a while while OC4J uploads the Liferay . 10. click Next.war file on OC4J With the location of the Liferay . Installing Liferay for an Enterprise 44 .war file. Click Deploy.war file is.war file in the Archive Location field. Browse to where your Liferay . Click the Test Connection icon. Leave the default selected under Archive. change the test SQL to something like SELECT * from User_. INSTALLING LIFERAY 1. 2. You should get a message saying Connection to "LiferayDataSource" established successfully. go back and check your settings. Click the OC4J: home link in the top left of the page. and click the Browse button.

Create a file called portal-ext.host=localhost mail.url=jdbc:mysql://localhost/jettyportal? useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.user= mail. then give it a value of /portal.mail. portal.mail.mail. 8.session.password=root If you are using OC4J's data source. Add a directive for Portal Context.smtp.port=110 mail.session.session.session.pop3.transport.default.Initial Setup 4.default.smtp. 6.store.default.port=25 mail.session.session.protocol=pop3 mail.jndi. navigate to the Liferay Home folder.pop3.default.password= mail.password= mail.jdbc. Click the Deploy button at the top right of the screen. OC4J will then deploy Liferay.auth=false mail. add the database settings: jdbc. The next screen allows you to give the application a name and set its context root.properties in this folder.name=jdbc/LiferayPool Do the same thing for the Mail Session.session.ctx=/portal If you are using Liferay's built-in data source. set the following properties for your system: mail.user= mail. add the JNDI name instead: jdbc.mysql.Driver jdbc. Use Liferay for the name and /portal as the context root.mail. Click the OK button at the top of this page. Click Next. You will be brought back to the previous screen.pop3. 5.smtp. Illustration 11: Setting the deployment options on OC4J Click the Return button at the top of the page.username=root jdbc.smtp.mail.mail.host=localhost mail.session. add the JNDI name instead: Installing Liferay for an Enterprise 45 . If you are using the built-in configuration.mail.smtp.mail. 7.session. Next.session.mail.pop3. Click the Next link at the bottom right of the page.session.default.mail.mail.protocol=smtp If you are using OC4J's mail session.driverClassName=com.

Initial Setup
mail.session.jndi.name=mail/MailSession

Save and close the file. 9. Shut down and restart the server. In your browser, go to http://localhost:8888/portal. You should see Liferay's default home page.

09/04/28 15:06:54 Loading code-source:/F:/Liferay/Tools/Application Servers/ oc4j_extended_101340/j2ee/home/applications/ Liferay/liferay-portal-5.2.2/WEB-INF/lib/portal-impl.jar!/system.properties 09/04/28 15:06:55 Loading code-source:/F:/Liferay/Tools/Application Servers/ oc4j_extended_101340/j2ee/home/applications/ Liferay/liferay-portal-5.2.2/WEB-INF/lib/portal-impl.jar!/portal.properties 09/04/28 15:06:55 Loading file:/F:/Liferay/Tools/Application Servers/oc4j_extended_101340/j2ee/home/applications/Liferay /liferay-portal-5.2.2/WEB-INF/classes/portal-ext.properties 15:07:02,984 INFO 15:07:03,125 INFO lect.MySQLDialect [DialectDetector:64] Determining dialect for MySQL 5 [DialectDetector:97] Using dialect org.hibernate.dia-

09/04/28 15:07:05 Loading code-source:/F:/Liferay/Tools/Application Servers/ oc4j_extended_101340/j2ee/home/applications/ Liferay/liferay-portal-5.2.2/WEB-INF/lib/portal-impl.jar!/captcha.properties 15:07:06,359 INFO [PortalImpl:243] Portal lib directory /F:/Liferay/Tools/Application Servers/oc4j_extended_101340/j2ee /home/applications/Liferay/liferay-portal-5.2.2/WEB-INF/lib/ 15:07:20,531 INFO [ServerDetector:104] Detected server oc4j 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManagerContextListenerImpl contextInitialized INFO: PSC_CSPCS001 : Started initializing ServiceManager 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService INFO: PSC_CSPCS004 : Service added, Name: com.sun.portal.container.service.CoordinationService, Implementation: com.sun. portal.container.service.coordination.impl.CoordinationServiceImpl 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService INFO: PSC_CSPCS004 : Service added, Name: com.sun.portal.container.service.CachingService, Implementation: com.sun.porta l.container.service.caching.impl.CachingServiceImpl 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService INFO: PSC_CSPCS004 : Service added, Name: com.sun.portal.container.service.ClientCachingService, Implementation: com.sun .portal.container.service.caching.impl.ClientCachingServiceImpl 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService INFO: PSC_CSPCS004 : Service added, Name: com.sun.portal.container.service.DeploymentService_Local, Implementation: com. sun.portal.container.service.deployment.impl.DeploymentServiceLocalImpl 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService INFO: PSC_CSPCS004 : Service added, Name: com.sun.portal.container.service.ContainerEventService, Implementation: com.su n.portal.container.service.coordination.impl.ContainerEventServiceImpl

46

Installing Liferay for an Enterprise

Initial Setup
2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService INFO: PSC_CSPCS004 : Service added, Name: com.sun.portal.container.service.PolicyService, Implementation: com.liferay.po rtal.portletcontainer.PolicyServiceImpl 2009-4-28 15:07:23 com.sun.portal.container.service.ServiceManager addService 2009-4-28 15:07:24 com.sun.portal.container.service.ServiceManagerContextListenerImpl contextInitialized INFO: PSC_CSPCS002 : Finished initializing ServiceManager 2009-4-28 15:07:24 com.sun.portal.portletcontainer.impl.PortletContainerContextListenerImpl contextInitialized INFO: PSPL_PCCSPCPCI0003 : Starting PortletContainer 2.1 09/04/28 15:07:24 Starting Liferay Portal Standard Edition 5.2.2 (Augustine / Build 5202 / February 20, 2009) 15:07:53,000 INFO 10845041 [HotDeployUtil:64] Initializing hot deploy manager

15:07:53,359 INFO [AutoDeployDir:108] Auto deploy scanner started for C:\Documents and Settings\Steven\liferay\deploy 09/04/28 15:07:54 Oracle Containers for J2EE 10g (10.1.3.4.0) 15:10:52,875 INFO initialized [PluginPackageUtil:1148] Reloading repositories

RESIN 3.1.X
Liferay Home is one folder above Resin's install location. 1. 2. Download and install Resin into your preferred directory. From now on, the directory where you installed Resin will be referred to as $RESIN_HOME. Edit $RESIN_HOME/conf/resin.conf. Replace lines 60-64 with:
<class-loader> <tree-loader <tree-loader path="${resin.home}/lib"/> path="${server.root}/lib"/>

<compiling-loader path="$ {server.rootDir}/common/classes"/> <library-loader </class-loader> path="${server.rootDir}/common/lib"/>

And add the following:
<database> <jndi-name>jdbc/LiferayPool</jndi-name> <driver type="com.mysql.jdbc.Driver"> <url>jdbc:mysql://localhost/lportal?useUnicode=true&amp;characterEncoding=UTF-8</url> <user></user> <password></password> </driver> <prepared-statement-cache-size>8</prepared-statement-cache-size> <max-connections>20</max-connections> <max-idle-time>30s</max-idle-time>

Installing Liferay for an Enterprise

47

Initial Setup
</database> <resource <init> <mail.store.protocol>imap</mail.store.protocol> <mail.transport.protocol>smtp</mail.transport.protocol> <mail.imap.host>localhost</mail.imap.host> <mail.pop3.host>localhost</mail.pop3.host> <mail.smtp.host>localhost</mail.smtp.host> </init> </resource> <system-property javax.xml.parsers.DocumentBuilderFactory="org.apache.xerces.jaxp.DocumentBuilderFactoryImpl" /> <system-property javax.xml.parsers.SAXParserFactory="org.apache.xerces.jaxp.SAXParserFactoryImpl" /> <system-property javax.xml.transform.TransformerFactory="org.apache.xalan.processor.TransformerFactoryImpl" /> <system-property Parser" /> org.xml.sax.driver="org.apache.xerces.parsers.SAXjndi-name="mail/MailSession" type="javax.mail.Session">

3.

Go to $RESIN_HOME and create new directory called common/lib. Download mysql-connector-java-{$version}-bin .jar and copy to this directory. This is the JDBC connector for MySQL. If you are using another database, substitute this with the appropriate driver. Download the Liferay Portal Dependencies and unzip into $RESIN_HOME/common/lib. Delete contents of $RESIN_HOME/webapps/ROOT. Unzip liferay-portal-x.x.x.war to $RESIN_HOME/webapps/ROOT. If you are using Resin 3.1.9 or higher, remove $RESIN_HOME/lib/portlet-01.jar. This contains the old Portlet 1.0 classes. The Portlet 2.0 classes are backwards compatible, so this should not affect anything. Next, you will need several .jar files which are included as part of the Liferay source distribution. Many application servers ship with these already on the class path, but Resin does not. The best way to get the appropriate versions of these files is to download the Liferay source code and get them from there. Once you have downloaded the Liferay source, unzip it to a temporary folder. 1. Go to $LIFERAY_SOURCE/lib/development/ and copy activation.jar and mail.jar to $RESIN_HOME/common/lib. Copy saxpath.jar and xalan.jar to $RESIN_HOME/lib. Go to $LIFERAY_SOURCE/lib/portal and copy xercesImpl.jar and xml-apis.jar to $RESIN_HOME/lib.

4. 5. 6. 7.

8.

2. 9.

To start the server, open a command prompt, navigate to the $RESIN_HOME and type:
java -jar lib/resin.jar start

48

Installing Liferay for an Enterprise

Initial Setup 10. Open your browser to http://localhost:8080. You should see the default Liferay home page.

RESIN 3.2.X
Liferay Home is one folder up from Resin's install location. 1. Download and install Resin 3.2.1 into your preferred directory. From now on, the directory where you installed Resin will be referred to as $RESIN_HOME. Edit $RESIN_HOME/conf/resin.conf. Replace lines line 9-13 with:
<tree-loader path="${resin.home}/ext-lib"/> <tree-loader path="${resin.root}/ext-lib"/> <tree-loader path="${resin.home}/lib"/> <tree-loader path="${resin.root}/lib"/> <compiling-loader path="${server.rootDir}/common/classes"/> <library-loader path="${server.rootDir}/common/lib"/>

2.

3.

Search <jvm-arg> tag in resin.conf and replace what is there with the following:
<jvm-arg>-Xmx256m</jvm-arg> <jvm-arg>-Xss1m</jvm-arg> <jvm-arg>-Dcom.sun.management.jmxremote</jvm-arg> <jvm-arg>-Xmx1024m</jvm-arg> <jvm-arg>-XX:MaxPermSize=256m</jvm-arg> <jvm-arg>-Dfile.encoding=UTF-8</jvm-arg> <jvm-arg>-Duser.timezone=GMT</jvm-arg>

4.

Go to $RESIN_HOME and create a new directory called common/lib. Download mysqlconnector-java-{$version}-bin .jar and copy to this directory. This is the JDBC connector for MySQL. If you are using another database, substitute this with the appropriate driver. Download the Liferay Portal Dependencies and unzip into $RESIN_HOME/common/lib. Delete the contents of $RESIN_HOME/webapps/ROOT. Unzip liferay-portal-x.x.x.war to $RESIN_HOME/webapps/ROOT. Next, you will need several .jar files which are included as part of the Liferay source distribution. Many application servers ship with these already on the class path, but Resin does not. The best way to get the appropriate versions of these files is to download the Liferay source code and get them from there. Once you have downloaded the Liferay source, unzip it to a temporary folder. ◦ Go to $LIFERAY_SOURCE/lib/development/ Copy saxpath.jar to $RES-

5. 6. 7. 8.

Installing Liferay for an Enterprise

49

Initial Setup IN_HOME/common/lib. 9. To start the server, open a command prompt, navigate to the $RESIN_HOME and type:

10. java -jar lib/resin.jar start Open your browser to http://localhost:8080. You should see the default Liferay home page.

TOMCAT 5.5.X
Liferay Home is one folder above Tomcat's install location. 1. Download and install Tomcat 5.5.X into your preferred directory. From now on, the directory where you installed Tomcat will be referred to as $TOMCAT_HOME. Note: For JDK 5 users: move $TOMCAT_HOME/webapps/ROOT/WEBINF/lib/xercesImpl.jar to $TOMCAT_HOME/common/endorsed. JDK 1.4 is no longer supported in Liferay 5.x and above. 2. Create and edit $TOMCAT_HOME/conf/Catalina/localhost/ROOT.xml to set up the portal web application.
<Context path=""> </Context>

3. 4.

Download liferay-portal-x.x.x.war. Download Liferay's Portal Dependencies. Create a $TOMCAT_HOME/common/lib/ext directory and unzip the dependencies ZIP in there. If the files do not extract to this directory, make sure they are in the correct directory by moving them there. Edit $TOMCAT_HOME/conf/catalina.properties:
common.loader= ${catalina.home}/common/classes,\ ...\ ${catalina.home}/common/lib/ext/*.jar

5.

6.

Make sure your database server is installed and is working. If it's installed in a different machine, make sure that it's accessible from the one where Liferay is being installed. Configure data sources for your database. Make sure the JDBC driver for your database is accessible by Tomcat. Obtain the JDBC driver for your version of the database server. In the case of MySQL use mysql-connector-java{$version}-bin.jar. Next, copy the JAR file to $TOMCAT_HOME/common/lib/ext. Edit $TOMCAT_HOME/conf/Catalina/localhost/ROOT.xml.
<Context...> <Resource name="jdbc/LiferayPool"

7.

8.

50

Installing Liferay for an Enterprise

Initial Setup
auth="Container" type="javax.sql.DataSource" driverClassName="com.mysql.jdbc.Driver" url="jdbc:mysql://localhost/lportal? useUnicode=true&amp;characterEncoding=UTF-8" username="" password="" maxActive="100" maxIdle="30" maxWait="10000" /> </Context>

9.

Be sure to enter the user name and password to your database in the appropriate fields above.

10. Create a mail session bound to mail/MailSession. Edit $TOMCAT_HOME/conf/Catalina/localhost/ROOT.xml and configure a mail session.
<Context...> <Resource name="mail/MailSession" auth="Container" type="javax.mail.Session" mail.transport.protocol="smtp" mail.smtp.host="localhost" mail.store.protocol="imap" mail.imap.host="localhost" /> </Context>

11. Configure JAAS. Edit $TOMCAT_HOME/conf/Catalina/localhost/ROOT.xml and configure a security realm.
<Context...> <Realm className="org.apache.catalina.realm.JAASRealm" appName="PortalRealm" userClassNames="com.liferay.portal.security.jaas.PortalPrincipal" roleClassNames="com.liferay.portal.security.jaas.PortalRole" debug="99" useContextClassLoader="false" /> </Context>

14. Create $TOMCAT_HOME/conf/jaas.config.
PortalRealm { com.liferay.portal.kernel.security.jaas.PortalLoginModule }; required;

15. Edit $TOMCAT_HOME/bin/catalina.bat (on Windows) or $TOMCAT_HOME/bin/catalina.sh (on Linux / Mac / Unix) so that Tomcat can refer-

Installing Liferay for an Enterprise

51

Copy the JDBC driver for your database to this folder as well. Create a folder called endorsed in $WEBLOGIC-HOME/jrockit90_150_04/jre/lib.xml: <!-. This undeploys the default Tomcat home page.war to $TOMCAT_HOME/webapps/ROOT..timezone=GMT -Djava. WEBLOGIC 9 / 10 Liferay Home is one folder above the home folder of the domain in which Liferay is installed. These instructions assume that you have already configured a domain and server.apache. Navigate to the folder which corresponds to the domain to which you will be installing Liferay.jar file into this directory. 3.x. You should see the default Liferay home page.encoding=UTF8 -Duser.1 Connector on port 8080 --> <Connector port="8080" maxHttpHeaderSize="8192" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" redirectPort="8443" loadTimeout="true" /> enableLookups="false" acceptCount="100" connectionTimeout="20000" URIEncoding="UTF-8" disableUp- 19.security.Execute.config 16. DEPENDENCY JARS 1. 52 Installing Liferay for an Enterprise .. Unzip the Liferay dependencies archive to this folder. serializer. Unpack liferay-portal-x. rem ----. edit $TOMCAT_HOME/conf/server.auth. For supporting UTF-8 URI Encoding. 18. then copy rhino. and that you have access to the WebLogic console. set JAVA_OPTS=-Xms128m -Xmx512m -Dfile. point browser to http://localhost:8080. 2. You will also need the xercesImpl. 17.org.Define a non-SSL HTTP/1. You may download this from http://xerces.x. 4.jar or you will get SAX parsing errors after you deploy Liferay.jar to the folder that you just created. Delete contents $TOMCAT_HOME/webapps/ROOT directory. Inside this folder is a lib folder. and xalan.config=%CATALINA_HOME %/conf/jaas.login.jar.jar. Run Tomcat. Copy the xercesImpl.Initial Setup ence the login module.

The next screen allows you to test your database configuration. and no password as the values. and Password. MAIL CONFIGURATION If you want WebLogic to manage your mail sessions. Click the Lock & Edit button above the Domain Structure tree on the left side of the page. Click Next. localhost. use the following procedure. 5. 3. Click the Targets tab. 8. 7. such as LiferayMail. 9. Click Finish. If you have been following the defaults we have been using so far. 6. select Mail Sessions. Then click the New button on the right side of the screen. 6. select Data Sources. 4. 1. you would use lportal.Initial Setup DATABASE CONFIGURATION If you want WebLogic to manage your data source. such as LiferayDataSource. Installing Liferay for an Enterprise 53 . define the JNDI name as mail/MailSession. above the Domain Structure tree. Click the Activate Changes button on the left. Accept the defaults on the next screen by clicking Next. Click the Save button. Database User Name. you can skip this section. In the Domain Structure tree. 2. If the test succeeds. Click the Test Connection button. If you want to use Liferay's built-in mail sessions. Give the Mail Session a name. 2. 5. Select your new LiferayMail session from the list by clicking on it. 4. and then click the Next button. Click the New button which is now enabled on the right side of the screen. you have configured your database correctly. use the following procedure. Select your Database Type and the Driver class. 3. Illustration 12: WebLogic: Data Sources On the next screen. put in your Database Name. From the Domain Structure tree on the left. Give the Data Source a name. On the screen that appears. Define the JNDI name as jdbc/LiferayPool. root. If you want to use Liferay's built-in data source. Host Name. Check off the server you want to deploy this Data Source to (AdminServer is the default). you can skip this section. 1. Then click the Lock & Edit button again to enable modifying these settings. Check off the server you want to deploy this Data Source to (AdminServer is the default). Browse to your WebLogic Console.

war file from the list and click Next. When it is finished. above the Domain Structure tree. Browse to where you have stored the Liferay . add the database settings: jdbc. Give the application a name (the default name is fine).properties file in the Liferay Home folder. 9. If you are using Liferay's built-in data source.war file.username=root jdbc.jdbc. 3. select it. Click the Activate Changes link on the left above the Domain Structure tree. Click the Deployments option in the Domain Structure tree on the left side of the screen.default. 2. Click the Install button on the right side of the screen. 4. Click the Upload your file(s) link. add the JNDI name instead: 54 Installing Liferay for an Enterprise . a summary screen is displayed. Leave the other defaults selected and then click Finish.password=root If you are using WebLogic's data source. Click the Activate Changes button on the left side of the screen. DEPLOY LIFERAY 1. Leave Install this deployment as an application selected and click Next. 10.Driver jdbc. 6.driverClassName=com. Select the Liferay . and then click Next.default. Click the Lock & Edit button above the Domain Structure tree. which is one folder up from your domain's home folder.url=jdbc:mysql://localhost/lportal? useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc. Create a portal-ext. Illustration 13: WebLogic: Mail Sessions 8.default. 5. 7.Initial Setup 7. WebLogic will now deploy Liferay.default.mysql.

session.protocol=smtp If you are using WebLogic's mail session.host=localhost mail. You will be able to get to it by browsing to http://<server name>:7001.smtp.jndi. you will need to remove it first. select the Liferay application and click the Start button. Liferay will start. Copy the dependency .name=jdbc/LiferayPool Illustration 14: Deploying Liferay on WebLogic 9.mail.mail.mail. If you are using the built-in configuration. In the Deployments screen. the URL is http://localhost:7001.session.session.password= mail.host=localhost mail. add the JNDI name instead: mail. Select Servicing All Requests in the pop up.smtp.name=mail/MailSession 11.smtp.protocol=pop3 mail.mail.mail.store.smtp. Start WebLogic.session.session.session.password= mail.default. ORACLE WEBLOGIC 10. set the following properties for your system: mail.session. 12.3 If you still have the mainWebApp module installed.smtp.mail.port=110 mail.jars and the JDBC driver to the domain/lib directory.session.port=25 mail.pop3.mail.mail.session.pop3.session.Initial Setup jdbc.jndi.pop3.auth=false mail. Click Yes to continue on the next screen.user= mail.transport.user= mail.session. If your browser is running on the same machine upon which you have installed Liferay.session.mail.pop3.mail.2 Do the same thing for the Mail Session. Installing Liferay for an Enterprise 55 .mail.

Give your data source a name. the host name. Choose the type of database. Illustration 15: Creating a data source in WebLogic 10. you can skip this section.3 Select JDBC → Data Sources.Initial Setup DATABASE CONFIGURATION If you want WebLogic to manage your data source. The database driver class should be chosen for you automatically. such as Liferay Data Source. If you want to use Liferay's built-in data source. use the following procedure. and the password. the database user name. From the screen shot. The JNDI name should be jdbc/LiferayPool. You should be on the Connection Properties screen. Enter the database name. Click New. 1. WebLogic will use this information to construct the appropriate Installing Liferay for an Enterprise 4. you can see that we have chosen MySQL. 2. the port. 56 . Click Next twice. 3.

Create a portal-ext.session.pop3.properties file in the Liferay Home folder.port=110 mail. which is one folder up from your domain's home folder. Click Test Configuration to make sure WebLogic can connect to your database successfully.session.default.pop3.mail. add the JNDI name instead: jdbc. some additional parameters need to be added to the URL. If you are using the built-in configuration. Notice that your new data source has no value in the Target column.mail.session.session. 2.mail.mail.url=jdbc:mysql://localhost/lportal? useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.password= Installing Liferay for an Enterprise 57 . DEPLOY LIFERAY 1. Modify the JDBC URL so that it has the proper parameters: jdbc:mysql://localhost/lportal? useUnicode=true&characterEncoding=UTF-8& \ useFastDateParsing=false 6. Click the Targets tab and check off the server instance(s) to which you wish to deploy your data source. Give it the name Liferay Mail and give it the JNDI name of mail/MailSession and click Next. If you are using Liferay's built-in data source.smtp. set the following properties for your system: mail.pop3.mail.session. Choose your server and then click Finish.smtp. MAIL CONFIGURATION 1. Then click Save.mail.driverClassName=com.jndi.mysql. WebLogic will now confirm with you the information that it gathered.user= mail.pop3.default.Initial Setup JDBC URL to connect to your database. add the database settings: jdbc.host=localhost mail. 3.auth=false mail.password=root If you are using WebLogic's data source.mail.name=jdbc/LiferayPool Do the same thing for the Mail Session. 8.smtp. For MySQL. Click on your data source to edit it.session.username=root jdbc.session. Select Mail Sessions and create a new mail session which points to your mail server. 7.Driver jdbc.password= mail.default. Click Next. If it does.host=localhost mail. You will be back to the list of data sources. 5.jdbc.default. click Finish.default.

If the default name is appropriate for your installation. 5.store.session.jar from the Liferay Dependen- 58 Installing Liferay for an Enterprise .transport. Click Finish. you may find this folder in [Bea Home]/jrockit_160_05/jre/lib/ext.smtp. extract xalan. If you are using JRockit. Tip: After Liferay completes installing.session. 3.port=25 mail.jar and serializer. 2.protocol=smtp If you are using WebLogic's mail session.name=mail/MailSession Save and close the file. you may see an error initializing the Web Proxy portlet.protocol=pop3 mail. Otherwise.war archive and copy them to your JDK's endorsed folder for libraries. To re-enable this portlet.Initial Setup mail. Because the XSL parser configured by default within WebLogic cannot compile a style sheet in this portlet. WEBSPHERE 6. Liferay Home is in a folder called liferay in the home folder of the user ID that is running WebSphere.jar from the Liferay . Do so intermittently to save your changes. add the JNDI name instead: mail.session.smtp.mail.1 Tip: Throughout this installation and configuration process. Liferay disables it by default. Download and extract these Liferay jars to websphere/appserver/lib/ext.jndi. Download the Liferay Portal WAR file. keep it. Select Deployments and click the Install button.war file from the file system or click the Upload Your File(s) link to upload it. 2. and then click Next.mail.jar Currently you also need to copy portlet.mail. INSTALLATION 1. click Save. 4. ○ ○ ○ Dependency libraries (Liferay Portal Dependencies) Your database JDBC driver .session. WebSphere will prompt you to Click Save to apply changes to Master Configuration.user= mail.mail. After the deployment finishes. Select the Liferay .session. Leave Install this deployment as an application selected and click Next. give it a name of your choosing and click Next.

enter the name of the JDBC provider (e. Illustration 16: WebSphere 6. Installing Liferay for an Enterprise 59 .1 JDBC Providers 4. Click New.MysqlConnectionPoolDataSource 7. For name. 5.jdbc. enter: com.Initial Setup cies archive into WebSphere/AppServer/java/jre/lib/ext. DATABASE CONFIGURATION 1. MySQL JDBC Provider). For Implementation class name.g. 3. enter the implementation class for your database driver's connection pool data source For MySQL.jdbc2.mysql. as WebSphere already contains older versions of the portlet . This issue may be fixed in future releases. Click Resources. Open Administrative Console and log in.jar which must be overridden at the highest level of the class path.optional. Start WebSphere. 6. 2. check the Liferay Wiki for updates to this issue. click JDBC Providers. Click Next.

1 New JDBC Provider Clear any text in class path. 14. 8. 12. 11. Click New. Click Data Sources under Additional Properties. 60 Installing Liferay for an Enterprise . 15. Everything else should stay at the default values. Enter JNDI: jdbc/LiferayPool. You already copied the necessary . Click Next. 13.jars to a location on the server's class path.Initial Setup Illustration 18: Clear out anything in the class path. Illustration 19: JDBC Provider summary screen 10. Click Finish. 9. Enter a name: liferaydatabasesource. Illustration 17: WebSphere 6.

Value and clicking OK for each row in the following table. 17. user 2. serverName 3. click Custom Properties.1 16. Under Additional Properties. Name 1. Click New. 18.Initial Setup Illustration 20: Liferay data source on WebSphere 6. Click Next. Create three custom properties by entering Name. 19. databaseName root localhost lportal Value Installing Liferay for an Enterprise 61 .

Initial Setup 20. Illustration 21: WebSphere 6. custom properties should look like this: 62 Installing Liferay for an Enterprise .1 Custom Properties Entry When done correctly.

MAIL CONFIGURATION 1. 4. 3. Click Mail Sessions. Name: liferaymail JNDI Name: mail/MailSession Installing Liferay for an Enterprise 63 .Initial Setup 21. 1. Click Built-in Mail Provider. 2. Illustration 22: Liferay Custom Properties Click Data Sources -> Test Connection to test. Click New. 2. Click Resources -> Mail Providers.

Initial Setup 5. Click Security. and infrastructure. Select Enable application security. 6. Illustration 23: Creating a Mail Session on WebSphere 6. 9. Click Secure administration. 8. Deselect Use Java 2 security to restrict application access to local resources.1 Click OK. applications. 7. 64 Installing Liferay for an Enterprise .

Initial Setup INSTALL LIFERAY 1. Click Next. For Steps 1 to 3. Browse for liferay-portal-x.war.x. 2.war file on WebSphere 6.x. 3. 4.1 Enter context root /. click Next to apply defaults. Installing Liferay for an Enterprise 65 . Click Applications -> Install new applications. Illustration 24: Installing the Liferay .

Illustration 25: Select the installation options Choose the Mail Session and Data Source. and then click Next Specify the virtual host upon which you want Liferay to run. 6. 66 Installing Liferay for an Enterprise .Initial Setup 5.

If you are using Liferay's built-in data source. this is a folder called liferay in the home folder of the user that is running WebSphere. Wait for the installation process to complete. At the Summary Screen. Save this configuration to master configuration by clicking on System administration and Save Changes to Master Repository. add the database Installing Liferay for an Enterprise 67 . click Finish.Initial Setup Illustration 26: Select the virtual host 7.1 installation process 8. For WebSphere.properties file in the Liferay Home folder. Illustration 27: WebSphere 6. 9. Create a portal-ext. 10.

session.user= mail.smtp.session.mail.host=localhost mail.mail.mail.password=root If you are using WebSphere's data source per the instructions above.default.pop3.store.name=mail/MailSession Save and close the file.mail.pop3.smtp.jdbc.session.jndi.mail.mail.Driver jdbc.session.jndi.user= mail.transport.session. Click Enterprise Applications.default.Initial Setup settings: jdbc.session.mail.session.name=jdbc/LiferayPool Do the same thing for the Mail Session.default.mail. add the JNDI name instead: jdbc.username=root jdbc.session. START LIFERAY PORTAL 1.url=jdbc:mysql://localhost/lportal? useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.pop3.driverClassName=com.default.mysql. If you are using the built-in configuration.smtp.session.password= mail.smtp.session.port=25 mail.protocol=pop3 mail.session.session. Applications.auth=false mail. 2.host=localhost mail.pop3. 68 Installing Liferay for an Enterprise .mail.mail.mail.default. set the following properties for your system: mail.password= mail.smtp.port=110 mail. add the JNDI name instead: mail.protocol=smtp If you are using WebSphere's mail session.

1. 1. 4. WEBSPHERE 7.Initial Setup Illustration 28: Starting Liferay on WebSphere 6. Uninstall DefaultApplication. Installing Liferay for an Enterprise 69 . Open up browser and point to http://localhost:9080.1 3. 1. Select liferay-portal. Dependency libraries (Liferay Portal Dependencies) JDBC Driver for your database DATABASE CONFIGURATION If you want WebSphere to manage the database connections. 2.war. The default Liferay home page will be displayed. click Start. PlantsByWebSphere and SamplesGallery. 2. Download and extract these Liferay jars to websphere/appserver/lib/ext. Start WebSphere. Download the Liferay Portal WAR file. 5. follow the instructions below.0 Liferay Home is in a folder called liferay in the home folder of the user ID that is running WebSphere.

0 JDBC Providers Open Administrative Console and log in. Click New.Initial Setup 2. 70 Installing Liferay for an Enterprise . Click Resources → JDBC Providers. Illustration 29: WebSphere 7. 3. 4.

6.MysqlConnectionPoolDataSource Click Next.g. Click Data Sources under Additional Properties.0: Database Properties Installing Liferay for an Enterprise 71 . Click Next.optional. 7. 9. You already copied the necessary .jars to a location on the server's class path. Illustration 30: WebSphere 7. 10. enter: com. Clear any text in class path. For Implementation class name. 11. 8. Illustration 31: WebSphere 7.0: Select JDBC Provider For name. Click Finish.mysql.Initial Setup 5.jdbc.jdbc2. MySQL JDBC Provider). enter the name of JDBC provider (e.

the MySQL URL would be: jdbc:mysql://localhost/ lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false. 15. Everything else should stay at the default values. Do another filter search for the password property.Initial Setup 12. 21. 14. MAIL CONFIGURATION 1. 16. Give it a value that points to your database. Select the user property and give it the value of the user name to your database. Enter JNDI: jdbc/LiferayPool. 20. Save the data source. When finished. go back into the data source and click Custom Properties. and then click the Show Filter Function button. Click New. 19. 72 Click Resources -> Mail -> Mail Providers. Go back to the data source page by clicking it in the breadcrumb trail. Click OK and save to master configuration. For example. Click the Test Connection button. This is the second from last of the small icons under the New and Delete buttons. Type user into the search terms and click Go. 13. 17. Click the Built-In Mail Provider for your node and server. Illustration 32: Modifying data source properties in WebSphere 7 18. It should connect successfully. 2. Installing Liferay for an Enterprise . Enter a name: liferaydatabasesource. Click OK and save to master configuration. Enter the password for the user ID you added earlier as the value for this property. Do another filter search for the url property. Click OK and save to master configuration.

password=root 2. Click OK and save to master configuration.host=localhost mail. START LIFERAY 1.session.password= mail.mail.protocol=smtp If you are using WebSphere's mail session. Click Applications -> New Application -> New Enterprise Application. INSTALL LIFERAY 1.port=110 mail.session.host=localhost mail.session. and then click the New button. Keep the context root set to / and click Next. 4.user= mail. and then click Next again.pop3. Click Finish. 2.transport.mail.user= mail. 5.Initial Setup 3.smtp.mail. Click Mail Sessions. If you are using Liferay's built-in data source.smtp.mail.Driver jdbc. Give it a name of liferaymail and a JNDI name of mail/MailSession.session.mail.mail. Create a portal-ext.port=25 mail.default.session.session.default.session.session.war file and click Next.mail. set the following properties for your system: mail.name=jdbc/LiferayPool Do the same thing for the Mail Session.password= mail. For WebSphere. 4. If you are using WebSphere's data source per the instructions above. Browse to the Liferay .session.mysql.smtp.smtp.pop3.mail.default.jdbc.default. 3.mail. Click Security → Global Security and deselect Use Java 2 security to restrict application access to local resources if it is selected.smtp. add the JNDI name instead: Installing Liferay for an Enterprise 73 . 6.default.jndi. click Save to Master Configuration.session. Leave Fast Path selected and click Next.properties file in the Liferay Home folder. 5.pop3. this is a folder called liferay in the home folder of the user that is running WebSphere.pop3.mail. If you are using the built-in configuration. add the database settings: jdbc.store.driverClassName=com.auth=false mail.protocol=pop3 mail.url=jdbc:mysql://localhost/lportal? useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc. Make sure your server is selected and click Next. Click Apply.session.mail.username=root jdbc. add the JNDI name instead: jdbc. When Liferay has installed.

war itself.Initial Setup mail. If you change it to something else. and then put it back in the .e.war file. If. You will have to modify the weblogic. and configuring it so that it is the sole consumer of any other . which by definition are application development platforms in and of themselves. Uninstall the default application. you can then deploy Liferay in that context and it will live there instead of at the root context. To change the file. Place the portal..xml file inside the Liferay .properties file appears in Chapter 4. For that reason.ctx=/ This default setting defines Liferay Portal as the application that sits at the root context. Select the Liferay application and click Start. you may not want to make Liferay the default application in the root context of the server. 6. Making Liferay Coexist with Other Java EE Applications Liferay Portal by default is configured to sit at the root (i. Save and close the file.war files that get deployed to the application server helps to make sure that your system performs optimally. modify it. you are going to want to make sure your portal environment has all the resources it needs to do this. /) of your application server. Then deploy the modified Liferay . allowing for separation between your portal environment and your web application environment. There are two steps to modifying this behavior: 1.ctx property at the top of the file: portal.name=mail/MailSession 3.properties file. Extract the file from the . your instance of Liferay is likely to be hosting many applications. open it in a text editor.xml file which is included with Liferay. for example.session. Click Application Types -> WebSphere Enterprise Application. Deploy Liferay in a context other than root (for example /portal). 74 Installing Liferay for an Enterprise . 4. In this file are tags for the context root: <context-root>/</context-root> Change this so that it matches the path you set in your portal-ext. Dedicating your application server to running only Liferay Portal is a good practice.war file. For this reason. say /portal. This is generally a best practice for portals.properties file to tell Liferay the context to which it has been deployed.war file to the server in the proper context. A full discussion of the portal-ext. Note for WebLogic Users: WebLogic also requires that you modify the weblogic. however. there is no reason why you cannot do that.jndi. and even integrating several of them together on a single page. Modify the portal-ext. In this instance. 2. you want Liferay to share space on an application server with other applications. 5.

Initial Setup Summary This chapter is a guide to everything about installing Liferay. and you can feel safe knowing that you have the freedom to use the software that is best for your organization. Whether you choose a Liferay bundle or an existing application server. The choice is yours: Liferay Portal won't get in your way. It is supported on more application servers than any other portal platform. or giving you the freedom to move to a different application server platform. allowing you to preserve your investment in your application server of choice. Liferay Portal integrates seamlessly with your enterprise Java environment. Summary 75 .

.

and readying your portal to have its content and applications loaded by your developers. If an application lives outside of the portal. and the container's job is to aggregate the set of portlets that are to appear on any particular page and display them properly to the user. Liferay Administration: How to administer a Liferay portal. This chapter covers these activities: ● ● ● Liferay's User Interface: How to navigate around Liferay and make use of the Control Panel. CONFIGURATION Once Liferay is successfully installed. Portlets are web applications that run in a portion of a web page. because portlets are where all of the functionality is implemented. In this way. creating users. integration with services such as LDAP. Global Portal Settings: Password policies. You will want to customize your portal by configuring various settings for it. You can perform many of these configuration tasks through Liferay's portlet-driven user interface. Settings. such as email notifications. Liferay's User Interface Liferay is a portal server. user groups. the portal should be able to consume some resource of the application (such as an RSS feed or a subset of functionality in a “dashboard” application) so that the end user can see everything he or she interacts with at a glance. all of the application functionality within Liferay Portal is in fragments of the page called portlets. and these are integrated together in a consistent and systematic way. and the user can (at the administrator's discretion) . organizations. The heart of any portal-based web site is its portlets. you can begin configuring it to fit it to your environment and your particular portal project. and more. This means that it is designed to be a single environment where all of the applications a user needs can run. To achieve this. Liferay's core is a portlet container. and roles. one or many applications can reside on a page. Monitoring.3.

To show these links. you will need to sign in as the default administrative user. and it will expand. Groovy. or Python. We will do that later. To sign in for the first time. create a new account on the portal. which means the account would not have access to the administrative portlets you need in order to set up Liferay for your organization.net/projects/ lportal) or can be checked out from our Subversion repository (https://lportal. To sign into Liferay for the first time. Sample portlets written in these languages are available to download from our Sourceforge site (http://sourceforge. all you need to do is roll your mouse cursor over the Dock. Navigating Liferay When you see Liferay's default interface for the first time. it would be created using Liferay's defaults. you will see what we call the Dock in the upper right hand corner of the screen. it contains Illustration 33: The default Liferay Dock. Ruby. Liferay supports portlets written in other programming languages. only two links: Home and Sign In. such as PHP. Portal applications come generally in two flavors: 1) multiple portlets can be written to provide small amounts of functionality and then are aggregated by the portal server into a larger application. the portal server handles building out the page as it is presented to the user.net/svnroot/lportal). Portlets are not difficult to build. you can click the Sign In link. and Java standard portlets can be written by any Java developer with experience in writing web applications. or 2) whole applications can be written to reside in only one or a few portlet windows.Configuration arrange them in the way that works best for the user. such as logging in and out and switching between various community and organization pages. By default. like servlet applications. please see the Liferay Developer's Guide. The Dock is the key to navigating within the supplied Liferay themes: it provides links to all the global functions a user needs. This portlet allows a user (or a prospective user) to do several things: sign in to Liferay.sourceforge. You will then be presented with the Sign In Portlet. A JSR-168 or JSR-286 standard portlet should be deployable on any portlet container which supports those standards. have become a Java standard which various portal server vendors have implemented. This user's credentials are: 78 Liferay's User Interface . don't create an account for yourself. Portlet applications. Liferay provides a Plugins Software Development Kit that makes creating portlet projects easy. or have a password reminder emailed if the user has forgotten his or her password. For this reason. Developers only have to worry about what happens inside of the portlet itself. For further information about the Plugins SDK. Additionally. The Java standard defines the portlet specification.svn. Portlets are placed on the page in a certain order by the end user and are served up dynamically by the portal server. The choice is up to those designing the application. If you were to create a new account on the portal for yourself now.

Configuration User Name: test@liferay.com Password: test Go ahead and sign into your new portal using these credentials. As you can see, Liferay by default uses one's email address as the user name. This can be changed later if you don't like this functionality, but it is generally a good practice to keep it this way. Users' email addresses are not normally things they will forget, and they are unique to each user, so they make good candidates for user IDs. The first page that will be displayed when a user logs in for the first time is the Terms of Use page. This page is displayed to the user before he or she is allowed to access the portal. By default, your users will have to agree to your terms of service before they will be allowed to used the portal. This page can be customized to contain whatever text you want, or the feature can be disabled altogether. To continue, you will need to agree to the Terms of Service. Once you log in as the administrative user, you will see that little has changed. The Sign In portlet now displays the name of the user (whose rather unimaginative name is Test Test) who is logged in, and the Dock now displays the text “Welcome, Test Test!” If you hover your mouse over the dock now, however, you will see that there are many more links in it: Home: takes you to the home page. Control Panel: takes you to the administrative functions of Liferay. My Account: lets you edit your user information. Sign Out: logs you out of the portal. Add Application: opens the Add Application window which allows you to add portlets to the page. Layout Template: displays the Layout Template window which allows you to choose different layouts for the page. Manage Pages: takes you to the page administration screen, where you can add and delete pages, change the order of the pages, and configure several other things about pages. Toggle Edit Controls: This will let you turn on and off the edit controls in the top of the portlet windows. This is helpful for administrators who want to look at a page they're working on and see it the way a regular user would.

Illustration 34: Administrator's Dock

My Places: shows you the community and organization pages in the portal to

Liferay's User Interface

79

Configuration which you can navigate. If you roll your mouse over My Places, the Dock will expand, showing all of the places in the portal to which you have access. Initially, the place you are on will be highlighted. You will see that you are in the Guest community, on the public pages. Liferay allows for various configurations of pages for end users: you can configure it so that some or all users have their own pages, public and private (or both), upon which they can place the portlets they need to use. The administrator account by default has its own pages. Because you are logged in with an account that has Administrator privileges, you can see everything in the portal. New in Liferay 5.2 is the Control Panel, a new interface which provides a single place to go for all of Liferay's administrative functions. In versions of Liferay prior to 5.2, you needed to add the administrative portlets to a page somewhere, and a good place to do that was on the Administrator's private pages. Now all you need to do is go up to the Dock and select Control Panel. This is a much easier and faster way to access Liferay's administrative functions and will be the user interface going forward. With that said, the administrative portlets are still available, and you can still provide access to them if you wish.

Illustration 35: Liferay's Control Panel

Navigating the Control Panel
The control panel is very easy to navigate. On the left side is a list of headings with functions underneath them. The headings are in alphabetical order, but the functions are in a logical order.

80

Liferay's User Interface

Configuration User Name: The first section is always the logged in user's personal space. Here, you can change your account information and manage your own personal pages. Content: The Content section contains links to all of Liferay's content management functions. You can maintain web content, documents, images, bookmarks, a calendar, administer a message board, configure a wiki, and more. Portal: The Portal section allows portal administrators to set up and maintain the portal. This is where you can add and edit users, organizations, communities, roles, and configure the settings of the portal. Server: The Server section contains administrative functions for configuring portal instances, plugins, and more. All of the functions that you will need to maintain the portal or its content can be found in the control panel. Additionally, developers can write portlets which can also be added to the control panel. For further information about this, you can take Liferay's Portal Developer course or see the Liferay Developer's Guide.

Portal Architecture
Before we dive into the user interface for adding and maintaining various portal resources, it is best to go over the concepts Liferay uses to organize a portal. Portals are accessed by Users. Users can be collected into User Groups. Users can belong to Organizations. Organizations can be grouped into hierarchies, such as Home Office -> Regional Office -> Satellite Office. Users, Groups, and Organizations can belong to Communities that have a common interest. The simplest way to think about this is that you have users and various ways those users can be grouped together. Some of these groupings follow an administratively organized hierarchy, and other groupings may be done by the users themselves (such as different users from multiple organizations starting a community called “Dog Lovers” that has a common interest in dogs). And other groupings may be done administratively via Roles for other functions that may cut across the portal (such as a Message Board Administrators role made up of users from multiple communities and organizations, allowing those users to administer any message board in the portal). This way of organizing portal concepts may be illustrated in the following manner: In the illustration below, each arrow may be read using the words “can be a member of.” So this means that Organizations can be members of Communities, Communities can be members of Roles, Users can be members of anything, and so on. Though this seems very complex, it provides a powerful mechanism for portal administrators to configure portal resources and security in a consistent and robust manner. It is important to note that the diagram illustrates only users and their collec-

Portal Architecture

81

Configuration

Pages

Organizations

Organization Roles

Roles

Users

User Groups

Pages

Communities

Community Roles

Illustration 36: Liferay portal resources tions. Permissions do not flow through all of these collections: permissions can be assigned to roles only.

Users
Users can be collected in multiple ways. They can be members of organization hierarchies, such as Liferay, Inc. → Security → Internet Security. They can be collected into arbitrary user groups, such as Bloggers, which would enable them to create blog entries in their personal space. They can be members of communities which draw together common interests. And they can have roles which describe their functions in the system, and these roles can be scoped by Portal, Organization, or Community.

User Groups
User Groups are simple, arbitrary collections of users, created by administrators. They can be members of communities or roles. Permissions cannot be assigned to User Groups. Though User Groups do not have pages like some of the other collections of users (such as Communities or Organizations), they do have page templates which can be used to customize users' personal sets of pages. This will be fully described below.

Roles
There are three kinds of roles: ● Portal Roles

82

Portal Architecture

Configuration ● ● Organization Roles Community Roles

These are called role scopes. Roles are used to define permissions across their scope: across the portal, across an organization, or across a community. For example, consider a role which grants access to create a Message Board category. A Portal role would grant that access across the portal, wherever there was a Message Board portlet. A Community role would grant that access only within a single community. An Organization role would grant that access only within an Organization. Because Roles are used strictly for portal security, they also do not have pages, like Communities and Organizations. Users, User Groups, Communities, or Organizations can be members of a role.

Organizations
Organizations are hierarchical collections of Users. They are one of the two types of portal resources that can have pages. There is also a special type of Organization called a location, which can define where users are specifically located. Organizations are handy for defining where a user belongs in a particular hierarchy. For example, if you are implementing Liferay for a large organization, it may help to define user Joe Smith via his position in the organization chart. If Joe Smith is a Sales Engineer located in the New Jersey office, working in the North East division of the Sales department, he might be a member of the following organizations: ● ● ● Sales North East Division New Jersey Location

Now say that you have placed an Asset Publisher portlet as a static portlet on every user's home page (via a User Group page template) so that you can inform employees of various announcements via the content management system. If you tagged your content appropriately, you could ensure that Joe Smith gets any announcements that are meant for Sales, the North East Division, or the New Jersey location. Organizations can be members of Communities.

Communities
Communities are collections of Users who have a common interest. Liferay's default pages are in the Guest community, because everyone—whether they are anonymous or members of the portal—has a common interest in the default, public pages of your site. There are three types of Communities: ● ● ● Open Restricted Hidden

Portal Architecture

83

Configuration An Open Community (the default) allows portal users to join and leave the Community whenever they want to, using the Control Panel or a Communities portlet added to a page to which they have access. A Restricted Community requires that users be added to the Community by a community administrator. Users may use the Control Panel or the Communities portlet to request membership. A Hidden community is just like a Restricted community, with the added concept that it does not show up at all in the Communities portlet or the Control Panel.

Using the Control Panel
The Portal section of the Control Panel is used for most administrative tasks. You will find there an interface for the creation and maintenance of ● ● ● ● ● Users Organizations Communities User Groups Roles Password Policies Authentication options, including Single Sign-On and LDAP integration Default User Associations Reserved Screen Names Mail Host Names Email Notifications

Additionally, it allows you to configure many server settings, including: ● ● ● ● ● ●

You will use the Portal section of the Control Panel to create your portal structure, implement security, and administer your users. Note that only users with the Administrator role—a portal scoped role—have permission to view this section of the Control Panel.

Adding Users
Let's begin by adding a user account for yourself. We will then configure this account so that it has the same administrative access as the default administrator account. Go up to the Dock and click the Control Panel link, if you aren't there already. Then under the Portal category, click Users. Click the Add button. You will then be presented with the Add User form. Fill out the form using your name and email address. When you are finished, click Save.

84

Using the Control Panel

and there will now be an expanded form which allows you to fill out a lot more information about the user. The page will then reappear with a message saying that the save was successful. Click the Roles link. By default. By default. You will then be taken to a screen which shows the roles to which your ID is currently assigned. Next.Configuration Illustration 37: The Add User screen. if Liferay has been correctly installed (see Chapter 2). you will want to give your user account the same administrative rights as the default administrator's account. You don't have to fill anything else out right now. all users are also assigned the Power User role. you should have one role: Power User. You can also define the default roles a new user receives. This will allow you to perform administrative tasks with your own ID instead of having to use the default ID. we will go over this later Using the Control Panel 85 . You can give this role certain permissions if you wish or disable it altogether (we will see how to do this later). and clicking Save. entering the new password in the two fields. And this allows you to make your portal more secure by deleting or disabling the default ID. but one thing is important to note: when the user ID was created. a password was automatically generated and. you will need to use this screen to change the default password for the user ID to something you can remember. If you have not yet set up your mail server. This of course requires that Liferay can properly communicate with your SMTP mail server in your organization. an email message with the password in it was sent to the user. You can do this by clicking on the Password link in the box on the right.

where you can modify anything about the user. User Management If you click the Users link on the left of the Control Panel. you will see that there are now two users in the list of users. Edit User: This takes you back to the Edit User page. Select the Administrator role from the list and the window will disappear and you will see that the role has been added to the list of roles to which you are assigned. click the Save button. Log out of the portal and then log back in with your own user ID. you can click the Actions button next to that user. To make yourself an Administrator. Deactivate: Clicking this will deactivate the user's account. this allows you to edit them. Permissions: This allows you to define which Roles have permissions to edit the user. You are now an administrator of the portal. 86 Using the Control Panel . Impersonate User: This opens another browser window which allows you to browse the site as though you were the user. which is at the bottom of the blue bar of links on the right.Configuration Illustration 38: Liferay's User Account editor. Manage Pages: If the user has pages. Next. If you wanted to change something about a particular user. also. click the Select link. A window will pop up with a list of all the roles in the system.

they won't even have access to this section of the Control Panel). By adding the user to the HR organization. One application of this in a corporate setting could be an IT Security group. non-profit organizations. Your portal may have only one organization or several. and so on. thereby giving the members of the IT Security organization administrative access to the portal. This allows members of the organizations (if they are granted the Manage Pages permission) to maintain their own pages. and Users can be members of one or many organizations—inside of a hierarchy or across hierarchies. You may have an organization within your IT organization that handles security for all of the applications companywide. and have users' permissions reflect their positions in the chart. you may be able to model that as an organization. Additionally. since the user would no longer be in an organization that has the Administrator role. churches. Organizations can have a hierarchy to unlimited levels.) and their teams as sub-organizations. Organizations are one of two types of Liferay resources (the other being Communities) that can have its own pages. Of course. this is only one way to design it. Organizations Organizations in Liferay are meant to model organizations in real life. any roles the HR organization has (such as access to a benefits system in the portal) would be transferred to the user. basketball. the simple administrative act of moving the user from the IT Security organization to the HR organization would remove this privilege from the user. Organizations can be associated with Roles. They can be used to represent different companies. For example. Because you have administrative access.Configuration Note that most users will not be able to perform most of the above (in fact. If you have a collection of users that all belong to the same grouping. If you have more complex requirements. you can design your portal to correspond with your existing organization chart. They can have a set of public pages which include information and applications appropriate for guests or logged in users who are not members of the Organization to make use of (such as a help desk ticket entry system for an IT page). with various sports (soccer. schools. and then click the Add button. baseball. Name: The name of the organization. depending on what kind of site you are building. click the Organizations link on the left side of the Control Panel. you could grant the Administrator role you just granted to your own ID to the whole Organization. etc. They have been used to represent a sports league. you can combine Organizations with User Groups and scoped Roles to assemble the sets of permissions you wish to grant to particular users. and they can have a set of private pages with applications for the organization's own use (such as the back-end portlets of the same ticketing system). Using the Control Panel 87 . you can perform all of the above functions. If a user in this organization later was hired by the Human Resources department. If you had users as members of this organization. while a social networking site may have users from many separate organizations who access the site. clubs. In this manner. To add an organization. a corporate site may model its own organization hierarchy in Liferay.

Click the Actions button next to the new organization you have created. View Users: Shows a list of users who are members of this organization. postal addresses. Type: Use this to choose whether this is a regular organization or a location. the form reappears and you can enter more information about the organization. Organizations are created with three roles: Organization Administrator. As before with users. if any. Add User: Adds a new user in the portal who will be a member of this organization. You can assign one or more of these roles to users in the organization. This will take you back to the list of organizations. Fill out the information for your organization and click Save. Parent Organization: Click the Select link to bring up a window which allows you to select the organization in the system that is the direct parent of the organization you are creating. web sites. Assign User Roles: Lets you assign Organization-scoped roles to users. Click the Remove button to remove the currently configured parent. The Services link can be used to indicate the operating hours of the organization. click the View All button. Organization Member. All members of the Organization get the Organization Member role. Assign Members: Takes you to a screen where you can search and select users in the portal to be assigned to this organization as members. For now. Edit: Lets you edit the organization. and Organization Owner. By default. and phone numbers associated with them. 88 Using the Control Panel . Organizations can have multiple email addresses. You will then see the many actions you can take to manipulate this organization.Configuration Illustration 39: Adding an organization. Manage Pages: Lets you create and manage public and private pages for the Organization.

which is a special type of organization that cannot have any children added to it. and allows users to browse the list of communities Using the Control Panel 89 . You will have to ensure that the organization has no users in it first. because you created it. and this is why they have a distinct role within Liferay Portal. therefore. For other kinds of web sites. which can be added to any page in Liferay. Delete: Deletes this organization from the portal. The default home page in Liferay is in a community called Guest. Human Resources. As you can see. the home page for the Intranet is probably best placed in a community that any member of the portal can access. View Suborganizations: Shows a list of all the organizations that are children of this organization. By creating an organization. and may want to join. Add Location: Lets you add a child Location. If you were building a photo sharing web site out of Liferay. But what about the corporate health and fitness center? That's something that everybody in the company—regardless of organization —potentially has an interest in. You can use Communities. So those who enjoy taking pictures of landscapes can join a Landscapes community. The second is through the My Communities portlet. and those who enjoy taking pictures of sunsets can join a Sunsets community. there are several scenarios in which you would want to use something like a community instead of an organization. and so on. you become both a member and have the Organization Owner role.Configuration Add Regular Organization: Lets you add a child organization to this organization. Communities can be created and managed in two ways. For example. which gives you full rights to the organization. Information Technology. you may want to use communities to bring people together who have a common interest. in any situation where you need to cut across the organizational structure of your portal. product groups. you may have communities based on the types of photos people want to share. They are designed instead to be islands to themselves which anyone from any organization (or from no organization at all) can join. a corporate Intranet running Liferay may have sites for all the organizations in the company: Sales. And if they lose interest. they can leave those communities too. Tip: Note that you are already a member of the organization you created. and this is where you would put your public web site. Communities Communities are very much like Organizations except that they are not hierarchical. That's a good candidate for a Community. The first is through the Control Panel. or where you have a site that would apply to almost anybody. Why two ways? Because the My Communities portlet also doubles as a way to navigate from community to community. This is how you create hierarchies of organizations with parent-child relationships. Marketing. like every other user / page collection in Liferay. Using the same scenario.

Description: Enter some descriptive text about the community. click the Communities link on the left side of the Control Panel in the Portal section. This is helpful if the community has a specific. Assign User Roles: Lets you assign community-scoped roles to users. and many organizations have used them for this purpose. Delete: Users with administrative access to the portal or who are owners of the community can delete it. Assign Members: Takes you to a screen where you can search and select users in the portal to be assigned to this community as members. Manage Pages: Lets you create and manage public and private pages for the community. By default. You can assign one or more of these roles to users in the community. communities are created with three roles: Community Administrator. Community Member. This enables you as a portal administrator to provide users with this functionality without giving them access to the Control Panel. To add a community. A community administrator must then explicitly grant or deny users' requests to join.Configuration and select whether or not they want to join one (if it is open or restricted). you will have a Join or Request Membership option. If a community is inactive. and then click the Add button. A private community does not appear in the My Communities portlet and users must be added to it manually by a community administrator. Once you have created a community. A restricted community is the same except users can only request membership. Restricted. Tags: You can use Liferay's tagging mechanism on the community. The operations you can perform on it are very similar to the operations you can perform on organizations. COMMUNITY PROVISIONING Communities are ideal workspaces for teams to collaborate on common projects. Join/Leave: If you are not a member of the community. If you are a member of the community you will see an option to leave the community. topical purpose within the portal. Type: There are three kinds of communities: Open. it will appear in the list of communities in the Control Panel. no data can be added to it. All members of the community get the Community Member role. Active: Communities can be active or inactive. An open community appears in the My Communities portlet and users can join and leave the community whenever they want. They provide an isolated area where a group of people can place all of their data pertaining to a particular topic. and Community Owner. It is a far better way to share data than using email and a shared folder on a net90 Using the Control Panel . and Private. Name: Enter the name of the community you wish to create. Edit: Lets you edit the community.

This indicates that you are working in a staging environment.Configuration work. and private communities. That's all you need to do.2. and to change layouts. Instead. Liferay's Document Library portlet empowers users to access and update documents simultaneously. and can send notifications out to the team. Now go ahead and use the Public Pages or Private Pages tabs to create pages in the template and populate them with portlets. Select Activate Staging. Once the community has been created. to add portlets. For our example. and then use that template to very quickly create multiple communities that are pre-populated with those pages and portlets. click Actions → Manage Pages.3 and above allows portal administrators to create communities based on templates. Click the Add button and create a community called DEFAULT_TEMPLATE. To enable the ad-hoc creation of communities for this purpose. you can create a default template that applies to all kinds of communities. leave it in staging mode. Using the Control Panel 91 . Make it a private community. Liferay 5. Illustration 40: Activating Staging on the community template. restricted. What this means is that you can create a template community that has a pre-defined set of pages and portlets. and then click the Settings tab. Any future communities that you create will have the same layouts and portlets as what you have placed in the DEFAULT_TEMPLATE. You can always use the View Pages button to view the pages you are creating. Additionally. A Message Boards portlet can be used to keep all team discussions in one place. These pages will be surrounded by a red border. and all versions of the documents are preserved. Go to the Control Panel and click Communities. we will work with the default template. A Calendar portlet can be used to keep track of the team's appointments and meetings. A Wiki portlet can be used to document the project as it progresses. Don't publish the changes to the template. You can create templates for open.

There are only two fields to fill out: Name (the name of the User Group) and Description (an optional description of what the group is for). Permissions: This allows you to define which Users. If you want all newly created communities to have a Forums page with a Message Boards portlet on it.Configuration Illustration 41: Populating pages in the community template To further refine this. These groups are created by portal administrators to group users together who don't have an obvious organizational or community-based attribute or aspect which brings them together. Why would you use User Groups. User Groups. you can cre- 92 Using the Control Panel . or Roles have permissions to edit the User Group. you would create that in the DEFAULT_TEMPLATE. Use the name RESTRICTED_TEMPLATE to create a template for restricted communities. but User Groups can be added to Roles. This feature streamlines the community creation process for administrators. use the name OPEN_TEMPLATE to create a template for open communities. Click Save and you will then be back to the list of groups. The DEFAULT_TEMPLATE we have just created applies to all types of communities. Groups cannot have permissions like roles. Edit: Allows you to modify the name or description of the User Group. Creating a User Group is easy. which we will discuss below. Manage Pages: Though User Groups don't have pages of their own. As with the other resources in the portal. you can click the Actions button to perform various operations on User Groups. If community is open. Click the User Groups link and then click the Add button. Use the name PRIVATE_TEMPLATE to create a template for private communities. then? They come into play when you have complex security requirements and for page templates. making it very easy to quickly create communities for teams. User Groups User Groups are arbitrary groupings of users. you can create other kinds of templates for specific types of communities in the same manner.

this page will get copied to their personal pages. This enables administrators to provide the same configuration for the personal pages of all (or just a subset of) users. USER GROUP PAGE TEMPLATES: DEFINING PAGE TEMPLATES FOR A USER GROUP The a User Group's page templates can be administered using the Control Panel.1 introduced the concept of page templates which are tied to User Groups. You can also set it up so that different groups are combined together to create the desired default configuration. using Liferay's GUI instead of the properties file. any users added to the group will have the group's pages copied to their personal pages. When a user is assigned to a user group.Configuration ate page templates for a group. Though this has been a long-time feature of Liferay. When a User Group has page templates. Delete: Deletes the User Group. in a portal for University students. USER GROUPS AND PAGE TEMPLATES Liferay allows users to have a personal set of public and private pages that each user can customize at will. Liferay version 5. Using the Control Panel 93 . This allows you to do things like create a Bloggers user group with a page template that has the Blogs and Recent Bloggers portlets on it. In some cases you may want to provide a different configuration for each user depending on his or her profile.properties file and optionally by providing the configuration in a LAR file. For example. They will then automatically have a blog page that they can use. The default configuration of those pages can be determined by the portal administrator through the portal-ext. the configured page templates are copied directly to the user's personal pages. it was not very flexible or easy to use. staff and undergraduates would get different default pages and portlets in their personal space. Assign Members: Takes you to a screen where you can search for and select users in the portal to be assigned to this User Group. The first time users who are added to this group log in to the portal. The User Groups link lists all the existing user groups and allows you to perform several actions on each of them. By selecting the Manage Pages action the administrator will access the common Liferay UI for creating pages and organizing them in a hierarchy. View Users: Lets you view the users who are in the User Group.

the administrator has created a new private page called 94 Using the Control Panel . Illustration 43: Adding a Page Template In the screen shot above.Configuration Illustration 42: Manage Pages action on a User Group. Each set will be used as templates to be copied to the user's personal public or private page sets respectively when the user becomes a member of the user group. Note that it is possible to create both public and private pages.

When the Update Associations button is clicked. the administrator can now click the View Pages button to open the page and add as many portlets as desired to that page and configure them as needed. APPLYING THE PAGE TEMPLATES BY ASSIGNING MEMBERS TO THE USER GROUP The next step will be to assign an existing user to that group to verify that the page template is copied as a user's private page. From that list. a list of all available users is shown. one or more users can be selected to make them members of the user group. In the previous example.Configuration You are a student within the Students user group. Let's assume for this example that the Loan Calculator and Calendar portlets are selected. a user that already had an existing page called Welcome will now have a new page called You Are A Student the next time she accesses her personal space. That page will contain two portlets: Loan Calculator and Calendar as configured by the User Group administrator: Using the Control Panel 95 . To do this. Illustration 44: Assigning Members to a User Group By clicking the Available tab in the next screen. the users become members of the group and copies of any public or private page templates which are configured for the user group are copied to their page sets. click Actions → Assign Members action in the list of available user groups. Since the page created is a portlet page.

COMPOSING A PAGE OUT OF SEVERAL USER GROUPS Users can belong to many user groups. and the resulting page would contain the portlets configured for both User Groups: 96 Using the Control Panel . those pages are now owned by the user and they can be changed at any time if the portal is set up to allow users to edit their personal pages. If the administrator creates a page template with the same name (You are a Student) in the First Year Students group and puts in it an RSS portlet pointing to information interesting for them. ADDITIONAL DETAILS Because the pages are copied to a user's set of pages. If two or more pages of different user groups have the same name. When a user is removed from a user group the associated pages won't be removed: they have become that user's pages.Configuration Illustration 45: Template copied to a user's page set. those changes will be used when new users are assigned to the user group. Second Year Students. a User was added to a Students group which had a page called You are a Student. however. this may result having many page templates copied to users' pages. If you have templates defined for a number of groups. Third Year Students. Since the pages are templates. Let's expand our previous example by dividing the Students into First Year Students. To prevent this. to detect when a user is added again to a group of which he or she was already a part. however. you can combine pages from different user groups into a single page. International Students. This can be achieved by using a naming convention for the pages. and the pages are not added again. the changes won't be applied to users that were already members of the user group. The system is smart enough. In the example above. and Prospective Students. they will be combined into a single page when they are copied to a user's personal pages set. but depending on which type we also want other different portlets to be on that page too. For each of these types of students we want them to have a page with the Loan Calculator and Calendar. that page would be combined with the You are a Student page that's in the Students group. If an administrator modifies page templates for a User group after users have already been added to the group.

those pages will be combined. it is possible to have a very flexible configuration for the default pages of portal users. ● ● ● ● As you can see. If the existing and the new pages have different layout templates. If the new layout template has portlets in columns that do not exist in the existing page. the system allows for as many user groups as desired. the existing one is preserved. PAGE COMBINATION RULES The following rules are used when composing a page by combining pages from different user groups: ● If a user becomes a member of a User Group that has a page template with the same name in the same set (public or private) as a page that the user already has. Using the Control Panel 97 . those portlets will be automatically copied to the first column of the existing layout template. The portlets on the new page will be copied to the bottom of the equivalent columns of the existing page. While these examples are somewhat simple. If any of the pages has the name translated to several languages. Furthermore. only the default language is considered in the comparison. By using the convention of matching the page names it is possible to build any default page composition that you want for your users. that configuration can be changed at any time using the UI administrators are used to and then assigning users to new user groups.Configuration Illustration 46: Combined portlet pages.

or Community from one interface. or Organization role. These users will inherit any permissions given to the role. Roles can be granted permissions to various functions within portlet applications. 98 Using the Control Panel . Users who are placed in this role then inherit those permissions. So one of the main tasks you will be doing with a role is granting it the permissions that you want members of the role to have. such as Message Board Administrators. A role with that name is likely to have permissions to functions of the Message Board portlet delegated to it. click Save. you can add roles scoped by Portal. Delete: Deletes the Role. Define Permissions: Click this to define what permissions this role has. Permissions: This allows you to define which Users. and then click the Add button. You will be back at the list of roles. Illustration 47: Defining Permissions on a Role. Edit: Click this action to edit the role. according to a particular scope. Type a name for your role and an optional description.Configuration Roles Roles are groupings of users that share a particular function within the portal. Organization. or Community. Assign Members: Takes you to a screen where you can search and select users in the portal to be assigned to this role. View Users: Lets you view the users who are in the Role. From there. click the Roles link. Organization. This is outlined in the next section. To see what functions you can perform on your new role. You can change its name or description. The drop down box at the bottom of the form lets you choose whether this is a Regular. The Control Panel makes it easy for you to assign users to Roles and to assign permissions to Roles. User Groups. To create a Role. DEFINING PERMISSIONS ON A ROLE Roles exist as a bucket for granting permissions to the users who are members of them. or Roles have permissions to edit the Role. Community. click the Actions button. Roles are scoped by Portal. Think of a role as a description of a function. When you have finished. You only have to go to one place: the Roles link.

This would allow you to grant users that particular permission without making them overall portal administrators. for example. you only see the portlet permissions. Portlet permissions cover permissions that are defined within various portlets. can create new Communities in the portal. Portal permissions cover portal-wide activities that are in several categories. This allows you to create a Role that.Configuration When you click the Define Permissions action on a Portal scoped Role. you are given a choice of two kinds of permissions that can be defined for this role: Portal Permissions and Portlet Permissions. Clicking the Portlet Permissions button brings you to a page where you can browse the names of the portlets that are currently installed in your portal. you can then define the actions within this portlet that the role will have permission to perform. Using the Control Panel 99 . Password Policy. such as Community. Once you choose a portlet. etc. For other Roles. Location. Organization.

Configuration If we stick with our example of a Message Boards Admin role. This gives you as much flexibility as possible to build the site you have designed. click Save. 100 Using the Control Panel . You have two choices: Enterprise and Communities. Once you have chosen the permissions granted to this role. This lets you pick and choose specific communities (for a portal scoped role) in which these permissions are valid for users in this role. a button appears next to the permission allowing you to choose one or more communities in which the permission will be valid. Each possible action to which permissions can be granted is listed. you would likely grant Enterprise permissions to every action listed. If you choose Communities. After you click Save. you can add more permissions (by clicking Add Portlet Permissions or Add Portal Permissions). and allow portal administrators to define various permissions in whatever comIllustration 48: Message Boards permissions. binations they like. Roles are very powerful. choose the scope of the permission. in any community or organization where there is a Message Boards portlet. To grant a permission. or go back by clicking a link in the breadcrumb list or the Return to Full Page link. A new page with configurable permissions would then be displayed (see right). we would then find the Message Boards portlet in the list and click on it. you will see a list of all permissions that are currently granted to this role. From here. Granting Enterprise permissions means that permission to the action will be granted across the portal. For a Message Boards Admin role.

Password Expiration: Lets you choose an interval where passwords can be active before they expire. Using password policies. the warning time. Minimum Age: You can choose how long a password must remain in effect before it can be changed. you can apply different rule sets to different sets of portal users. you can perform several other actions. We have focused so far on the maintenance of users and portal security. go up to the Dock and select the Control Panel. You will then see the Password Policy settings form: Changeable: Selects whether a user can change his or her password. Global Server Settings 101 . you can set password rules such as password strength.Configuration SPECIAL NOTE ABOUT THE POWER USERS ROLE By default. Change Required: Selects whether a user must change his or her password upon first log in. Global Server Settings Now that you have navigated in the Control Panel. You can select the age. From the list of password policies. If you are viewing a page other than the Control Panel. and more. Next. but regular users do not. Password Policies Password policies can help to enhance the security of your portal. Password History: Keeps a history (with a defined length) of passwords and won't allow users to change their passwords to one that was previously used. Additionally. To do this. You will see that there is already a default password policy in the system. frequency of password expiration. you will need to modify the permissions on certain portlets. If you decide to remove the Power Users role from the default user associations (see below on page 102). click on the Password Policies link on the left side of the screen in the Portal category. The remaining links in the Portal category focus on various portal settings which cover how the portal operates and integrates with other systems you may have. see the section on Plugins Configuration below (page 114). Syntax Checking: Allows you to choose whether dictionary words can be in passwords as well as the minimum password length. You can edit this in the same manner as you edit other resources in the portal: click Actions and then click Edit. and a grace limit. many portlets within Liferay are configured so that Power Users have access to them. You can choose whether an administrator needs to unlock the account or if it becomes unlocked after a specific duration. you should be pretty familiar with how it works. and hopefully now you are comfortable exploring around the various options on the left. Lockout: Allows you to set the number of failed log in attempts before a user's account becomes locked.

User Groups. We will go over these settings in detail below. such as user registrations. there are settings for each. such as admin or president. and don't have anything to do with any of the integration options on the other tabs. Email Notifications: Liferay sends email notifications for certain events. You might use this to prevent users from registering on the portal with user names that contain profanity or that sound official. Reserved Credentials: Lets you reserve screen names and email addresses so that users cannot register using them. domain. and more. and several other items of miscellaneous information about the organization. or Roles have permissions to edit the Password Policy. This tab allows you to customize Liferay's out-of-box behavior regarding authentication. You cannot delete the default policy. Authentication: Allows you to configure login IDs. such as the company name. You can also set the virtual host. Delete: This shows up for any password policies that you add beyond the default policy. and Single Sign-On. User Groups. password changes. Default User Associations: Lets you configure default membership to Roles. Permissions: This allows you to define which Users. a global portal logo. the General tab allows you to select from several global authentication settings: 102 Global Server Settings . connection to LDAP. Mail Host Names: You can add a list of other mail servers besides your main one here. Settings The Settings link is where most of the global portal settings are: General: This lets you configure global settings. AUTHENTICATION: GENERAL SETTINGS The Authentication link has several tabs under it. the mail domain. GENERAL The General link allows you to set the name of the company / organization / site which is running the portal. Specifically.Configuration Edit: Brings you to the form above and allows you to modify the password policy. Because Liferay supports a number of authentication methods. You can customize those messages here. The general settings affect only Liferay functionality. the virtual host. All of these are used for configuring how users will authenticate to Liferay. The password policy will be enforced for any users who are added here. Assign Members: Takes you to a screen where you can search and select users in the portal to be assigned to this password policy. and Communities for new users. etc.

If enabled.properties file to all of the nodes so that the first time they Global Server Settings 103 . the settings in the database will override the settings in portal-ext. An email address is. One default that is important is that users will authenticate by their email address. People can generally remember their email addresses. Enable / Disable account creation by strangers. The only compelling reason to use the portalext. users will have to log in manually. If a user changes his or her email address. For this reason. 2. it may be easier to copy the portal-ext. however. Liferay defaults to this for several reasons: 1.properties. two places in which you can configure the LDAP settings: the portal-ext. if it is not used to authenticate. all settings except for the last are enabled by default.Configuration ● ● Authenticate via email address (default). Enable / Disable email address verification. There are still. it is more likely that the user will forget to update his or her email address in his or her profile. So it is important to keep the email address at the forefront of a user's mind when he or she logs in to help the user keep it up to date. AUTHENTICATION: LDAP Connecting Liferay to an LDAP directory has become much easier and is now a straightforward process through the Control Panel. unique to the user who owns it. you will probably want to leave this on so that visitors can create accounts on your site. screen name. will send users a verification email with a link back to the portal to verify the email address they entered is a valid one they can access. or user ID (a numerical ID auto-generated in the database—not recommended). For these reasons.properties file is if you have many Liferay nodes which will be configured to run against the same LDAP directory. Liferay. Enable / Disable automatic login. Liferay allows user to check a box which will cause the site to “remember” the user's log in by placing a cookie on his or her browser. If disabled. Note that if you use both. Enable / Disable account creation by those using an email address in the domain of the company running the site (which you just set on the General tab).properties file (which will be covered in the next chapter) and the Control Panel—where the settings will get stored in the database. Enable / Disable Forgot Password functionality. If you have a user who hasn't logged into the portal for a while. by definition. Liferay defaults to using the email address as a user name. 3. If you are running an Internet site. In that case. we recommend for most users that you use the Control Panel to configure the LDAP settings—it's easier and does not require a restart of Liferay. If the user's email address is not updated. If you enable this. it is possible that he or she will forget his or her screen name. all notifications sent by the portal will fail to reach the user. ● ● ● ● By default. especially if the user was not allowed to use his or her screen name of choice (because somebody else already used it). for your initial deployment.

the default attribute mappings are sufficient data to synchronize back to the Liferay database when a user attempts to log in. Principal: By default. If you are running your LDAP directory in SSL mode to prevent credential information from passing through the network unencrypted. select it and the rest of the form will be populated with the proper default values for that directory. Regardless of which method you use. It is usually modeled after your organization. Base DN: This is the Base Distinguished Name for your LDAP directory. For a commercial organization. the settings are correct. CONNECTION These settings cover the basic connection to LDAP. Enabled: Check this box to enable LDAP Authentication. Uncheck this box if you want to allow users that have Liferay accounts but no LDAP accounts to log in to the portal. If you are using one of these.dc=com. so we will look at it in chunks. Liferay will then not allow a user to log in unless he or she can successfully bind to the LDAP directory first. If you have removed the default LDAP administrator. you would take the following steps to share the certi104 Global Server Settings . assuming your LDAP directory happens to be Microsoft Active Directory on Windows Server 2003. For example. The rest of the configuration is optional: generally. This is all you need in order to make a regular connection to an LDAP directory. the administrator ID is populated here. GLOBAL VALUES There are two global LDAP settings. you will need to use the fully qualified name of the administrative credential you do use.Configuration start up. To test the connection to your LDAP server. Make sure that the machine on which Liferay is installed can communicate with the LDAP server. The LDAP settings screen is very detailed. you will have to perform extra steps to share the encryption key and certificate between the two systems. it may look something like: dc=companynamehere. the settings are the same. DEFAULT VALUES Several leading directory servers are listed here. Required: Check this box if LDAP authentication is required. Credentials: This is the password for the administrative user. You need an administrative credential because Liferay will be using this ID to synchronize user accounts to and from LDAP. Base Provider URL: This tells the portal where the LDAP server is located. click the Test LDAP Connection button. If there is a firewall between the two systems. check to make sure that the appropriate ports are opened.

Once this is done.509 . You must define a mapping to the corresponding attributes in LDAP for the following Liferay fields: ● Screen Name Global Server Settings 105 .cer The keytool utility ships as part of the Java SDK. there are different ways to identify the user.Configuration ficate: On the Windows 2003 Domain Controller. Liferay uses the email address as a user login name. Export the Root Certificate Authority certificate by selecting Certificates (Local Computer) mmc snapin -> Trusted Root Certification Authorities -> MyRootCACertificateName. Though your LDAP user attributes may be different from LDAP server to LDAP server. For example. open the Certificates MMC snapin. Authentication Search Filter: The search filter box can be used to determine the search criteria for user logins. you would modify the search filter so that it can match the entered login name: (cn=@screen_name@) Import Search Filter: Depending on the LDAP server. there are five fields that Liferay requires to be mapped in order for the user to be recognized. Modify the LDAP URL in the Base DN field to the secure version by changing the protocol to https and the port to 636 like the following: ldaps://myLdapServerHostname:636 Save the changes. Your Liferay Portal will now use LDAP in secure mode for authentication. if you changed Liferay's authentication method to use the screen name instead of the email address. User Mapping: The next series of fields allows you to define mappings from LDAP attributes to Liferay fields. the default setting (objectClass=inetOrgPerson) is fine. which has by default been configured to use the email address attribute from LDAP as search criteria. go back to the LDAP page in the Control Panel. If you have changed this setting—which can be done on the General tab that's next to the LDAP tab in the Settings->Authentication section of the Control Panel —you will need to modify the search filter here. Copy the exported . USERS This section contains settings for finding users in your LDAP directory.5. The import is handled by a command like the following: keytool -import -trustcacerts -keystore /some/path/jdk1. By default. Generally.cer file to your Liferay Portal server. As with the CAS install (see the below section entitled Single Sign-On). Right click this certificate and select All Tasks -> export -> select DER encoded binary X. you can change this.0_11/jre/lib/security/cacerts -storepass changeit -noprompt -alias MyRootCA -file /some/path/MyRootCA.CER. you will need to import the certificate into the cacerts keystore. but if you want to search for only a subset of users or users that have different object classes.

Test LDAP Users: Once you have your attribute mappings set up (see above). 106 Global Server Settings . Illustration 49: Testing LDAP Users GROUPS This section contains settings for mapping LDAP groups to Liferay. click the Test LDAP Users button. The following attributes can be mapped: ● ● ● Group Name Description User Test LDAP Groups: Click the Test LDAP Groups to display a list of the groups returned by your search filter. and Liferay will attempt to pull LDAP users and match them up with their mappings as a preview. Import Search Filter: This is the filter for finding LDAP groups that you want to map to Liferay. Enter the LDAP group attributes that you want retrieved for this mapping.Configuration ● ● ● ● Password Email Address First Name Last Name The Control Panel provides default mappings for commonly used LDAP attributes. You can also add your own mappings if you wish.

IMPORT/EXPORT Import Enabled: Check this box to cause Liferay to do a mass import from your LDAP directory. This box only appears if you check Import Enabled above. When export is enabled. leave this box unchecked. Otherwise. this has the effect of causing a user export every time the user logs in. fields such as LastLoginDate are updated. Select how often you want the import to run.properties file: users. Import Interval: The import runs on a schedule. Import on Startup Enabled: Check this box to have Liferay run the import when it starts up. To find out what your default object classes are. all of your nodes would try to do a mass import when each of them starts up. When Liferay does an export. Liferay uses a listener to track any changes made to the User object and will push these changes out to the LDAP server whenever the User object is updated. Definitely leave this unchecked if you are working in a clustered environment. If you want Liferay to only synchronize users when they log in. User Default Object Classes: When a user is exported. several other options will become available. Groups DN: Enter the location in your LDAP tree where the groups will be stored.update.Configuration Illustration 50: Mapping LDAP Groups. Global Server Settings 107 . it will export the groups to this location. Note that by default on every login. When Liferay does an export. it will export the users to this location.login=false Users DN: Enter the location in your LDAP tree where the users will be stored.last. Export Enabled: Check this box to enable Liferay to export user accounts from the database to LDAP. use an LDAP browser tool such as JXplorer to locate a user and view the Object Class attributes that are stored in LDAP for that user. the user is created with the listed default object classes. This selection box only appears if you check Import Enabled above. You can disable this by setting the following property in your portal-ext. If you check the box.

Liferay will import all users from the specified portion of the LDAP tree.error.Configuration Use LDAP Password Policy: Liferay uses its own password policy by default. Liferay does this by parsing the messages in the LDAP controls that are returned by your LDAP server.password.types=MD5. You will now have to use your LDAP directory's mechanism for setting password policies.age=age ldap. If you need to change any of these options.password. Note that since you have already configured LDAP from the GUI. If you want to use the password policies defined by your LDAP directory. LDAP OPTIONS NOT AVAILABLE IN THE GUI Though most of the LDAP configuration can be done from the Control Panel. click the Save button. This can be configured on the Password Policies link in the Portal section on the left side of the Control Panel.algorithm.SHA Set the password encryption to used to compare passwords if the property ldap.encryption. the Password Policies tab will display a message stating that you are not using a local password policy.error. ldap.import.properties file.not.method is set to password-compare. any settings from the properties file that match settings already configured in the GUI will be ignored. See below for instructions describing how to do this.password.password.method=bind #ldap.properties.properties file.auth.algorithm= ldap. Liferay will search all the groups and import the users in each group.history=history ldap. there are several configuration parameters that are only available by editing portalext. the messages in the LDAP controls that Liferay is looking for are the messages that are returned by the Fedora Directory Server. ldap.password. Once this is enabled.password. syncing the two. Bind is preferred by most vendors so that you don't have to worry about encryption strategies. ldap.auth. they will not be imported.method=password-compare Set either bind or password-compare for the LDAP authentication method. ldap. always takes precedence over the properties file. but for now they can only be configured by editing the properties file. check this box. decrypts it. which stores the settings in the database. you will need to customize the messages in Liferay's portal-ext.expired=expired ldap.encryption. The GUI. If you set this to group.error. copy the LDAP section from the portal. These options will be available in the GUI in future versions of Liferay Portal.auth.auth.changeable=not allowed to change 108 Global Server Settings . By default. as there is not yet a GUI for setting this. Once you have completed configuring LDAP. and compares it with the user's password in Liferay.error.method=[user. Password compare does exactly what it sounds like: it reads the user's password out of LDAP. If you have users who do not belong to any groups.group] If you set this to user.properties file into your portal-ext. If you are using a different LDAP server.auth.

Configuration ldap. the server can return controls with its response of success or failure. This will enable Liferay to recognize them. SINGLE SIGN-ON Single Sign-On solutions allow you to provide a single log in credential for multiple systems.lockout=retry limit These properties are a list of phrases from error messages which can possibly be returned by the LDAP server.password. you may choose to implement support for it yourself by use of the extension environment—or your organization can choose to sponsor support for it. the messages can be different. you can replace the values of these properties with phrases from your server's error messages. the CAS client will be available to Liferay the next time you start it. This allows you to have people authenticate to the Single Sign-On product and they will be automatically logged in to Liferay and to other products as well. Liferay at the time of this writing supports several single sign-on solutions. The properties described here contain snippets of words from those messages. These controls contain a message describing the error or the information that is coming back with the response. so that users can have a full environment that runs on JDK 1. AUTHENTICATION: CENTRAL AUTHENTICATION SERVICE (CAS) CAS is an authentication system that was originally created at Yale University. the word snippets may not work with your LDAP server.error.4. Tip: If you are using Liferay 5. this is in <Tomcat Home>/webapps/ROOT/WEB-INF/lib. and was the first SSO product to be supported by Liferay.x. Your first step will be to copy the CAS client . Though the controls are the same across LDAP servers.x. Of course if your product is not yet supported. Please follow the documentation for CAS to install it on your application server of choice. Please contact sales@liferay. If you are using Liferay 4. use the older Yale versions of CAS from Liferay's Sourceforge archives. If they don't. We provide the older ones for use with Liferay 4. On Tomcat.jar file to Liferay's library folder.user. The reason for the difference is simply that newer versions require JDK 5 and above only. Global Server Settings 109 . and will work with Red Hat's Fedora Directory Server.error.2 and below. If you are not using that server.syntax=syntax ldap.password.error. It is a widely-used open source single sign-on solution. use the newer versions of CAS from the JASIG web site. You can use the version that Liferay provides on our web site or the official version from the JA-SIG web site.com for more information about this.trivial=trivial ldap. When a user binds to LDAP. Once you've done this.4.

Configuration The CAS Server application requires a properly configured Secure Socket Layer certificate on your server in order to work. to import the key into your Java key store. For First and Last name. use the following command: keytool -export -alias tomcat -keypass changeit -file server. when users click the Sign In link from the Dock. Enabled: Check the box to enable NTLM authentication. click Save. Finally. To generate a key. Internet-based production environments. Import from LDAP: A user may be authenticated from CAS and not yet exist in the portal. If you wish to generate one yourself. you will need to either purchase a signed key from a recognized certificate authority (such as Thawte or Verisign) or have your key signed by a recognized certificate authority. Though Microsoft has adopted Kerberos in modern versions of Windows server. you can configure Liferay to use it. NTLM is still used when authenticating to a workgroup. Of course. use a password that you will be able to remember. Enable CAS authentication. This is a simple matter of navigating to the Settings -> Authentication -> CAS tab in the Control Panel. After this. Select this to automatically import users from LDAP if they do not exist in the portal. they will be directed to the CAS server to sign in to Liferay. This is the 110 Global Server Settings . you should have your IT department pre-configure users' browsers to accept the certificate so that they don't get warning messages about the certificate. Change localhost in the default values to point to your CAS server. you will need to use the keytool utility that comes with the JDK. or the host name of your server.cert Finally. you import the key into your local Java key store. The rest of the settings are various URLs. Your first step is to generate the key. use the following command: keytool -genkey -alias tomcat -keypass changeit -keyalg RSA Instead of the password in the example (changeit). replace $JAVA_HOME above with %JAVA_HOME%. When you are finished. with defaults included. For Intranets. To export the key to a file. For public. all of this needs to be done on the system on which CAS will be running. Once your CAS server is up and running. AUTHENTICATION: NTLM NTLM is a Microsoft protocol that can be used for authentication through Microsoft Internet Explorer. It cannot be an IP address. and then modify the URL properties to point to your CAS server. use the following command: keytool -import -alias tomcat -file %FILE_NAME% -keystore $JAVA_HOME/jre/lib/security/cacerts -keypass changeit If you are on a Windows system. Next. you may want to use a different alias as well. enter localhost. Domain Controller: Enter the IP address of your domain controller. If you are not using Tomcat. you export the key into a file. Enabled: Set this to true to enable CAS single sign-on.

The credential issued by that vendor can be used by all the web sites that support OpenID.openid. allowing you to use OpenSSO to integrate Liferay into an infrastructure that contains a multitude of different authentication schemes against different repositories of identities. You can set up OpenSSO on the same server as Liferay or a different box.net) to install OpenSSO. AUTHENTICATION: OPENSSO OpenSSO is an open source single sign-on solution that comes from the code base of Sun's System Access Manager product. Please see the OpenID site (http://www. The idea is that multiple vendors can implement the standard.google. and then users can register for an ID with the vendor they trust. Because Atlassian Crowd implements an OpenID producer. Once you have it installed.com). Follow the instructions at the OpenSSO site (http://opensso. Some high profile OpenID vendors are AOL (http://openid.dev. the Liferay administrative user Global Server Settings 111 . Liferay works and has been tested with it.com/p/openid4java/) to implement the feature.aol. LiveDoor (http://profile.java.. allowing users to automatically register and sign in with their OpenID accounts. Users are mapped back and forth by screen names. but can be disabled on this tab. and LiveJournal (http://username. ATLASSIAN CROWD Atlassian Crowd is a web-based Single Sign-On product similar to CAS.com/screenname).livedoor. create the Liferay administrative user in it. making it much easier to manage this information and keep it up to date. Crowd can be used to manage authentication to many different web applications and directory servers. Internally. the effort it takes to register for and keep track of many accounts) are removed.Configuration server that contains the user accounts you want to use with Liferay. Liferay Portal can act as an OpenID consumer.livejournal. Supporting OpenID makes it easier for site owners to build their communities because the barriers to participating (i. Users can register on one site (the OpenID provider's site) and then use those credentials to authenticate to many web sites which support OpenID.com/username). OpenID is enabled by default in Liferay. Domain: Enter the domain / workgroup name. Simply use the OpenID authentication feature in Liferay to log in using Crowd. By default. AUTHENTICATION: OPENID OpenID is a new single sign-on standard which is implemented by multiple vendors. Liferay integrates with OpenSSO. the product uses OpenID4Java (http://code.net) for a more complete list. All of the account information is kept with the OpenID provider. Many web site owners often struggle to build communities because end users are reluctant to register for so many different accounts.e. The obvious main benefit of OpenID for the user is that he or she no longer has to register for a new account on every site in which he or she wants to participate.

. You can enter screen names and email addresses here that you don't want others to use. AUTHENTICATION: SITEMINDER SiteMinder is a single sign-on implementation from Computer Associates. click Save. Liferay will then prevent users from 112 Global Server Settings . Liferay's default is to have new users be members of both the Users role and the Power Users role.properties file.e. or you can remove it altogether. roles. Once you have the user set up. To enable SiteMinder authentication in Liferay. user authenticated from SiteMinder that do not exist in the portal will be imported from LDAP. Logout URL. The default value is already populated. This is now provided to all users and can be modified using the portal-ext.Configuration has a screen name of test. click the Enabled check box. you may have defined page templates in certain user groups to pre-populate end users' private pages. The last field defines the header SiteMinder is using to keep track of the user.2 now has built-in integration with SiteMinder. If you have defined other user groups. you would register the user with the ID of test and an email address of test@liferay. check the Enabled box on the SiteMinder tab.com. go to the URL for your server running Liferay and log in as the same user. SiteMinder uses a custom HTTP header to implement its single sign-on solution. using the email address test@liferay. Modify the three URL fields (Login URL. DEFAULT USER ASSOCIATIONS The Default User Associations link has three fields allowing you to list (one per line) communities. If you are also using LDAP with Liferay. and then click Save. communities. so in OpenSSO. and user groups that you want new users to be members of by default. When you are finished. such as blogs. log in to Open SSO using this user. mail. you may want to enter those user groups here. and Service URL) so that they point to your OpenSSO server (i. Go to the Control Panel and click Settings -> Authentication -> OpenSSO. Liferay 5. only modify the host name portion of the URLs). If you have customized the field for your installation. The Power Users role used to allow users to have their own set of pages where they can add their own portlets. You can now use the Power Users role to provide your own differentiation between regular users and users to whom you wish to give more privileges in the portal. or calendar. RESERVED CREDENTIALS The next link is Reserved Credentials.com. Liferay will then redirect users to OpenSSO when they click the Sign In link. If this box is checked. enter them here. For example. In the same browser window. you can check the Import from LDAP box. enter the custom value here. or roles that you want newly created users to be members of by default. If there is a particular configuration that you want everyone to have.

You can also set the portal-wide logo which appears in the top left corner of themes that are configured to display it. if you wanted to limit the use of the Message Boards portlet to just Power Users. EMAIL NOTIFICATIONS There are three tabs under the Email Notifications link. To do this. Plugins Configuration The Plugins Configuration link has tabs for each kind of plugin you can install in Liferay. You can enter (one per line) other mail host names besides the one you configured on the General tab. this is Joe Bloggs and test@liferay. For performance reasons. you could use the Portlets tab here and remove the Users role and leave only the Power Users role in the field. you can see all of the live sessions in the portal. simply click on the portlet you want Global Server Settings 113 . If you pick something that is too big. this setting is generally turned off in production.com. Liferay will fail over to these host names in the event that the connection to the main one fails. Monitoring The next link on the left side of the Control Panel is for monitoring. For example. it will mess up the navigation. and other information you can configure in your portal. but if you have it turned on. Be careful when using this option to choose an image file that fits the space. You can change it to anything you want. This name and address will appear in the From field in all email messages sent by the portal. IDENTIFICATION The identification section has several links for addresses. The Sender tab allows you to set the portal administration name and email address. Using this. You might use this feature to prevent users from creating IDs that look like administrative IDs or that have reserved words in their names.Configuration registering with these screen names and email addresses. This allows you to set up contact information for the organization that is running the portal MISCELLANEOUS: DISPLAY SETTINGS This section allows you to set the default portal language and the time zone. phone numbers. By default. you can view the active sessions here. A list of tokens for inserting certain values (such as the portal URL) is given if you wish to use those. MAIL HOST NAMES The next link is Mail Host Names. The other two tabs (Account Created Notification and Password Changed Notification) allow you to customize the email messages that are sent to users on those two events. You can use these tabs to configure what portal roles have access to the plugins.

the cluster cache. use the Roles section of the Control Panel and the Actions → Define Permissions button to configure more specific permissions. This information can be used for debugging purposes or to check the configuration of the currently running portal. as opposed to administering resources in the portal. this is where you'd do that. If you want to disable or enable access to certain portlets completely. Clicking the link makes this abundantly clear: you're immediately presented with a graph showing the resources available in the JVM. Note that this is for basic configuration and security. For more finegrained permissions. If you are testing something specific. If you have custom code that you have deployed which isn't in the list. SYSTEM PROPERTIES This tab shows an exhaustive list of system properties for the JVM. These are: ● ● ● Garbage collection: You can send in a request to the JVM to begin the garbage collection task. Any roles you enter here will be able to use this portlet. or the database cache. RESOURCES The first tab is called Resources. so try not to do this except at non-peak times. it is much better to be as specific as you can when you change log levels. Reindex: You can send in a request to regenerate all search indexes. This tab contains the aforementioned graph plus several server wide actions that an administrator can execute. If you change the log level near the top of the class hierarchy (such as at com. Clearing caches: You can send in a request to the JVM to clear a single VM cache. as well as many Liferay system properties. you can generate a thread dump which can be examined later to determine if there are any deadlocks and where they might be. you can use the Add Category tab to add it. Server Administration The Server Administration link lets you perform various tasks relating to administration of the overall portal server.liferay). all the classes under that hierarchy will have their log levels changed. Generate Thread Dump: If you are performance testing. as by modifying them too high in the hierarchy you can generate a lot more log messages than you probably need. 114 Global Server Settings . ● LOG LEVELS Here you can dynamically modify the log levels for any class hierarchy in the portal.Configuration and enter the role names in the field provided. this will impact portal performance. If you are not using a Solr search server (see Chapter 6 for further information on that).

you can use the Shutdown tab to inform your logged-in users of the impending shutdown. When run in server mode.org configuration page. Once you have it installed. it can be viewed from this screen without having to shut down the portal or open any properties files. This repository allows users to upload documents in many formats into a folder structure that they define. OPENOFFICE Liferay Portal contains a JSR-170 compliant document repository.urp.org is an open source office suite which is normally run in graphical mode to create documents.org. all portal pages will display a message saying the portal has been shut down. and Liferay will be integrated with OpenOffice. OpenOffice. the server will need to be restarted to restore access. find a port that is open and specify it both in the command above and on the Control Panel's OpenOffice.Configuration PORTAL PROPERTIES This tab shows an exhaustive list of the portal properties." -nofirststartwizard As you can see.org. the command above specifies that OpenOffice. OpenOffice. When you are finished. Liferay's Document Library portlet can make use of this feature to automatically convert documents on the fly. If you can use this port.org can be used to convert documents to and from all of the file types it supports.port=8100. When the time expires. but it can be run in “server” mode. all you need to do is check the Enabled box.org will run on port 8100. Users will see your message at the top of their portal pages for the duration of time you specified. You can define the number of minutes until the shutdown and a custom message that will be displayed.0. All Global Server Settings 115 . which is the default port in the Control Panel. SHUTDOWN If you ever need to shut down your Liferay Portal server while users are logged in.host=127. If you need to check the current value of a particular property. you can start OpenOffice. You would use this tab to tell Liferay how to connect to your running instance of OpenOffice. At this point.org on the same server upon which Liferay is running.0. These properties can be customized as will be seen in the next chapter. Portal Instances Liferay Portal allows you to run more than one portal instance on a single server. If you have something else running on this port.org in server mode with the following command: soffice -headless -accept="socket.1. click Save. Data for each portal instance are kept separate from every other portal instance. You can install OpenOffice.

When you're ready to add an instance. We also learned how to associate users by default with different user groups. we learned how to manage users. and Web plugins. We have also looked at overall portal architecture and how you might go about designing your site using Liferay. where you can browse Liferay's repository of portlets or install your own plugins. layout templates.Configuration portal data. we went in-depth through Liferay's Control Panel. Mail Domain: Enter the domain name for the mail host for this instance. You'll be prompted for three fields: Web ID: A general convention is to use the domain name for this. When users are directed to your Liferay server via this domain name. and by viewing the various properties that are defined in the portal. You will see that you are brought to what looks like a clean install of Liferay. and we saw how to reserve screen names and email addresses so that users cannot register in the portal with them. We also learned how to configure various server settings. If you want to install a new plugin. Virtual Host: Put the domain name you configured in your network here. 116 Summary . Liferay will direct users to the proper portal instance based on this domain name. and single sign-on. Next. The Plugin Installer will be covered in the next chapter. Using the Control Panel. These are divided into tabs for portlets. such as authentication. We have seen how to navigate Liferay's user interface so that you can get anywhere you need to in the portal. LDAP integration. and the clearing of various caches. search engine re-indexing. organizations. When you are finished filling out the form. click the Add button here. click the Install More Portlets button. and roles. It's a user-generated ID for the instance. Summary This chapter has described the resources in Liferay Portal that can be configured to build the site you need to build. communities. We learned how to debug parts of the portal by changing log levels. Liferay will then be able to send them to the proper portal instance. You will then be brought to the Plugin Installer. a thread dump. configure its domain name in your network first. user groups. we saw how to view and configure overall server settings. Hook plugins. themes. Next. Each portal instance requires its own domain name. click Save. Now navigate to the portal using your new domain name. Plugins Installation The Plugins Installation link shows all of the plugins that are currently installed. Liferay will use this to send email notifications from the portal. however. and roles. as well as how to initiate garbage collection. We saw how to view the memory currently being used by the server. This is your new portal instance which can now be configured any way you like. So before you configure an instance. is kept in the same database.

The ability to run multiple portal instances on one installation of Liferay was covered. Summary 117 .Configuration Finally. and we saw how to view the plugins that are currently installed.org integration. All of this information should help to bring you well on your way to becoming a seasoned Liferay Portal Administrator. we learned how to properly notify users that the portal is about to shut down and how to enable the OpenOffice.

.

and architecture. roles can be scoped by the portal. security model. The difference with Liferay's collaboration suite. Scopes New in Liferay 5. LIFERAY COLLABORATION SUITE Liferay Portal ships with a robust suite of collaboration applications which you can use to build communities of users for your site. by a community. You will learn how to set up and administer: • • • • • • Blogs Calendars Chat Mail Message Boards Wikis You will see how all of these features can work together to provide an enhanced experience for your users.4. As we learned earlier. feature-rich web site. is that all of the applications share a common look and feel.2 is the concept of Scopes as it applies to portlets instead of roles. And they inherit all of the strengths of being a part of the Liferay development platform. so you can use them in combination with Liferay's user management and Content Management features to build a well-integrated. . or by an organization. however. This means that the role only takes effect for the scope in which it resides. These applications are best-ofbreed applications with all the features you would expect of standalone versions that are outside a portal. This chapter will focus on the use of Liferay's collaboration suite. as well as giving you the tools to help build a community that keeps coming back.

Unless otherwise noted. they will have different sets of data. provided they all are added to different pages. all of the portlets in this chapter support scopes. each Message Board has its own set of data. Modify the Scope to be the current page. and is set to be by the community or organization. Select the Scope tab. scopes were hard-coded to be limited to organizations and communities. and that data set is limited by a scope that is defined as belonging to a community or organization. 120 Scopes . however. This allows you to add any number of these portlets to a community or organization. that's another way of saying the portlet is scopable. if you place a Message Boards portlet on two different communities. 2. the scope remains the same as it always has. That's all it takes to change the scope for a particular portlet instance. and as long as they appear on different pages. but they are an attempt to communicate the fact that each instance of the portlet has its own data set. First of all. If it's an organization role. members have permission to administer message boards across the portal. This allows you to have more than one message board per community or organization if you wish. In previous versions of Liferay. 3. members have permission to administer message boards only within the organization in which they are members of the role.Liferay Collaboration Suite For example. neither of those are real words. Select Configuration. what do we mean by the word scope? Scopes are another term for a set of data that is isolated from another set of data stored in the portal database. In a similar fashion to this. That is how there can be two. a Message Boards Administrator role with complete access to the Message Boards portlet would have different permissions based on the Role's scope. You can now scope them by page. By setting the scope to page. If you have what we would call a non-instanceable portlet. some Liferay portlets can now have scopes that go beyond just the specific community or organization upon which the portlet has been placed. If it's a community role. If you want to change the scope. twenty. or 20. members have permission to administer message boards only within the community in which they are members of the role. it only takes a few simple steps. you can add as many of these portlets to a particular community or organization as you want. because each has its own scope of data. 4. In Liferay 5. By default. 5. This gives you much more flexibility in how you want to set up your portal. Click Save. Yes.2.000 different message boards in the portal. 1. If it's a regular role. you can now set the scope to be for any page. Click the Menu icon in the portlet window (the one with the three dots). For example.

Permissions 121 . click the Archived tab. Permissions All of Liferay's portlets support Liferay's robust. Create a name for your archive and click Save. This means that once you configure a portlet. If your needs are more basic. This will show you a table of Roles defined in the portal. If someone then goes in and changes the settings of a particular portlet. fine-grained permissions system. change and save the settings until you have the portlet configured the way you want it. Unless otherwise noted. and then click the Archived tab. All Java standard portlets support these permissions. There is only one field to fill out: a name for your archive. To create an archived setup. If the current settings of the portlet you are configuring are the ones you want to archive. the portlets also support the standard JSR-286 permissions which define whether or not a user can see a portlet. If not. all of the portlets in this chapter support this feature. such as the Message Boards portlet. archived configuration. it then becomes easy to revert those changes back to the original. you can save those settings in an “archive” that the portal can keep track of. click the Configuration option from the menu in the portlet's title bar. and then click Submit.Liferay Collaboration Suite Illustration 51: Changing the scope for a portlet. You will now see your archive in the list. This is particularly useful for portlets that have a lot of configuration options. Select which roles are allowed to see the portlet and which roles are allowed to configure the portlet. Archived Setups Another new feature for Liferay 5. To configure these permissions. and you will see a tab called Permissions. go to the Configuration menu. If for whatever reason you need to revert the portlet to these archived settings. you can click Actions → Restore next to the archived setup you want to restore.2 is Archived Setups.

Then click the Sharing tab. Facebook You can add any Liferay portlet as an application on Facebook. Liferay supports using its portlets as widgets. then you have already used a widget. You can embed a particular instance of a portlet running on your site into another site. So what is a widget? A widget is a small piece of code that can be included on any web site that provides a piece of functionality. To share one of your portlets as a widget. Your portlet will now be available on Facebook as a Facebook application. This concept is sometimes referred to as “Web 2. When a user loads the page on the other web site. you can copy and paste their values into the Facebook tab.0” and is very much enabled by widgets. 122 Sharing . widgets have become very popular nowadays. To do this. the code will pull the relevant portlet from your site and display it. You will have to create the application on Facebook and get the key and canvas page URL from Facebook.com. you must first get a developer key. go to the Configuration option in the menu in the portlet's title bar. Once you have done this. such as Facebook. If you have ever embedded a YouTube video on your own web site so that users could watch a video without actually having to visit http://youtube.Liferay Collaboration Suite Sharing As the concept of the web as an application itself rather than a number of islands of applications takes hold in the mindshare of the Internet's users. This opens up a whole new avenue of exposure to your web site that you would not otherwise have had. A link for doing this is provided to you in the Facebook tab. That's all you need to do. but does not necessarily have to be hosted by that web site. Any Web Site Copy and paste the snippet of code into the web site to which you want to add the portlet as a widget. to which you have access to add content. Under this are three tabs.

It gives people an outlet for self-expression which they would not otherwise have. blogspot. WordPress. This could be particularly useful for your blog or your calendar if you wish to share them.org) which have the format of a running list of entries to which users could attach comments. Blogs The word Blog is an apostrophe-less contraction of the two words web log.com. blogging sites and applications began to appear. This tab has a single check box that allows you to give your friends permission to add the application as a widget to another web site. Additionally. and Newsvine adopted the format.com. empowering users to share their opinions and generating lively discussions. and Web Roller. People who run a blog are called bloggers. Over time. such as blogger. del. These applications allow individuals to run their own web sites in the same format: a running list of short articles to which readers who are registered with the site can attach threaded comments. Over the course of time. more and more sites such as Digg. and sometimes they build a whole community of readers who are interested in their blog posts. TypePad.Liferay Collaboration Suite Friends Illustration 52: Liferay's forums in Facebook The final sub-tab in the Sharing tab is called Friends.us.icio. Blogs were first popularized by web sites such as Slashdot (http://slashdot. there are several famous people who run their own blogs. and the ubiquity and wide reach of Blogs 123 .

Before we start adding entries. somebody will read it. Illustration 53: Slashdot. the Blogs portlet works the same.com to provide employees with blogs of their own. the Blogs portlet will display the latest entry in its entirety. Either way. 124 Blogs . This allows you to use the Blogs portlet to create a shared blog to build a site like Slashdot or to create multiple personal blogs to build a site like http://blogger. meaning that it can only be added once to any community or organization. so the portlet will be empty. We will go over how to use both of these portlets to create a blogging site for your users. Illustration 54: Initial view of the Blogs portlet.Liferay Collaboration Suite the Internet ensures that if you have something important and interesting to say.liferay. The Blogs Portlet The Blogs portlet is available from the Collaboration section of the Add Application menu. one of the first blogs on the Internet. we have no entries. In fact. In addition to the Blogs portlet. What's the difference? Adding the Blogs portlet to a Community or Organization page creates a shared blog for members of the Community or Organization. Adding the Blogs portlet to a user's personal space creates a blog for just that user.com. Since we have just added the portlet to a page. You will notice that it is an Instanceable portlet. there is also a Blogs Aggregator portlet which can take entries from multiple users' blogs and put them all in one larger list. By default. Liferay extensively uses the Blogs portlet on http://www. Liferay Portal has a portlet called the Blogs portlet which allows you to provide a blogging service to users of your web site. we'll configure the portlet so that it displays entries the way we want it to.

with a Read More link at the bottom of each to allow users to read the whole entry if they wish. You will see a page allowing you to configure the various options for the Blogs portlet: Illustration 55: Blogs Configuration Maximum Items to Display: This allows you to choose the total number of blog entries to display on the initial page. or just the Title. Blogs 125 . Display Style: Same as the display style for the web. Maximum Items to Display: Lets you configure the number of entries to appear in your RSS feed. but with the RSS feed.Liferay Collaboration Suite CONFIGURING THE BLOGS PORTLET Click the menu button (the one with three dots on it). Enable Comment Ratings: Allows readers to rate the comments which are posted to your blog entries. and then click Configuration. Display Style: Choose between Full Content. the Abstract. You can choose up to 100 to be displayed. Setting this to Abstract causes Liferay to display only the first 30 words of your blog entries. Enable Ratings: Allows you to enable your users to rate your blog entires from one to five stars Enable Comments: Allows readers to comment on your blog entries.

create a role for your bloggers and add them to the role. it is easy to do. By default. and the like. Next. You will now see a list of both portal and Community / Organization roles. click the Permissions button on the Blogs portlet. 126 Blogs . so only the owner of the community to which the portlet has been added will be able to add entries. complete with embedded images. You get a title. Check off any other role that should have the ability to add blog entries. You will see the following data entry screen: Illustration 56: Adding a Blog entry There isn't much difference between this screen and any other data entry screen within Liferay Portal. Now you're ready to begin adding blog entries.0. the permissions are set up for a personal blog. a way of scheduling when the entry is to appear. and then click Save. First. Click the Add Blog Entry button. you may want to modify the permissions on the blog. and currently only the owner is checked. If you want to share a blog with multiple users. or Atom formats for your feed. RSS 2.0. and a rich editor that allows you to format your entry the way you want. Set the settings the way you want them and click Save.Liferay Collaboration Suite Format: Lets you choose between RSS 1. Depending on whether this is a personal blog or a shared blog. videos.

For example. as you won't lose your entry in the event of a browser crash or network interruption. leave the Allow Incoming Trackbacks box checked. This gives you peace of mind in using the portlet from within your browser. Blogs 127 . If you were to click the Read More link. Here is what it looks like when the display style is set to Abstract and the number of entries is set to 10: Illustration 57: First blog entry added. potentially driving further traffic to your site. and every time the link is clicked on. all of the comments in a threaded view.Liferay Collaboration Suite Note also that as you type. This gives your readers an easy way to submit your blog entries to these aggregators.us. You can also tag your entries using the same tagging mechanism found everywhere else in the portal.icio. The Blogs portlet also supports trackbacks. Others who want to link to your entry can use this URL for the link. You'll go back to the list of entries. As you can see. You can see that in the summary view. Additionally. your Liferay-powered site will know about it and will be able to keep track of the clicks. Once you have finished your blog entry. the Blogs portlet is a full-featured blogging application which will give you and your users the ability to enter the blogosphere with an application that supports anything a blogger needs. click Publish. This will generate a URL that is displayed with your blog entry. you might put the URL to the other entry in the Trackbacks to Send field. the full view of a blog contains convenient links to add blog entries to popular aggregating sites such as Digg. you would see the entirety of the article. del. you don't see the trackback link. the entry is automatically saved as a draft at periodic intervals. and you will see your entry. if you want others who link to your blog to let you know about the link via trackbacks. These are special links that let you or another site know if you or if someone else linked to a blog entry. if you wanted to write an entry in your blog and reference someone else's entry. and you only see the number of comments which have been added. and others. and the trackback link which others can use to link back to your blog entry. Similarly.

From here. This portlet is also very easy and straightforward to set up. you will see the Blogs Aggregator's configuration page.Liferay Collaboration Suite Aggregating Blog Entries You can set up a whole web site devoted just to blogging if you wish. If you select Scope. Enable RSS Subscription: The aggregated entries can themselves be an RSS feed. the Blogs Aggregator will contain only entries of users who are in the current scope. You can add it to a page from the Collaboration category in the Add Application menu in the dock. the Blogs Aggregator will aggregate the entries of every blogger on your system. you can select from several different styles for displaying blog entries. If you want to refine the aggregation. Leave this box selected if you want people to be able to subscribe to your aggregated blog entries. The Blogs Aggregator portlet allows you to publish entries from multiple bloggers on one page. 128 Blogs . giving further visibility to blog entries. you can set several configuration options: Illustration 58: Blogs Aggregator Configuration Selection Method: You can select Users or Scope here. If you click Configuration from the menu button in the title bar of the portlet. Maximum Items to Display: Select maximum number of entries the portlet will display. This will. in essence. you can select an Organization by which to filter the users. If you select Users. Display Style: Just like the Blogs portlet. limit the entries to members of the Community or Organization upon which the Blogs Aggregator portlet resides.

Configuring the Calendar Portlet Illustration 59: The Liferay Calendar Portlet Go to the Configuration option from the menu in the portlet's title bar. This can work well in conjunction with mail rules in your email client that can operate on these messages. you can import and export the calendar to the popular iCalendar format for use in other applications. and much more. By default. import and export your calendar. Then click Return to Full Page. the name is set to Joe Bloggs and the email address is set to test@liferay. EVENT REMINDER EMAIL This tab lets you customize the email message that you receive from the portlet when you have an event for which you have configured a reminder. click Save. and display settings for the portlet itself. except that the entries come from more than one author. As you will see. It contains the same rich text editor that you see everywhere else in Liferay. You can schedule any number of events of different types. the template for event reminder emails. and this allows you to format your message so that you will be able to easily recognize it. you can use the Calendar portlet as a shared calendar on a community or organization's web site.com. there Calendar 129 . You have three tabs there which allow you to configure three different categories of options: the “From” field in event reminder emails. or you can use the Calendar portlet as a personal calendar—or both. In a similar way to the Blogs portlet. Additionally. Calendar Liferay's Calendar portlet is a complete calendaring solution. EVENT FROM Setting the Event From name and email address allows you to define the From: field in the email messages that you receive from the Calendar portlet. the Blogs Aggregator looks very much like the Blogs portlet. receive alarms via email or text message. Additionally.Liferay Collaboration Suite When you have finished setting the options in the portlet.

First. create a portal. or select whether it shows today's events. Title: The title of the event. you may want to click the Permissions button. If you are going to be using the Calendar as a shared calendar. It inherits its interface from the rest of Liferay's portlet library. To get started. community. Start Date/Time: The date and time the event starts. Duration: How long the event will last. Out of the box. only the owner has permissions to do these things. Click the Add Event button. For example. All Day Event: Check this box to disassociate time from the event and make it last all day. you might want the event start date and time and the event title included in the email reminder that you receive. or monthly view to be the default. but you may want the daily. Then come back to the Calendar portlet and click the Permissions button. select whether it shows a mini month. you may want to modify some things here. the summary tab is displayed. and these are listed underneath the text editor so that you can use them in the appropriate place in your template. DISPLAY SETTINGS Display Settings for the calendar allow you to define which tab in the calendar is the default when the portlet is first displayed. Here you can find a list of roles with check boxes denoting whether the role has the Add Event or the Export All Events permission. or organization role and add the users to whom you wish to grant access to the calendar to the role. By default. Liferay defaults to putting a Calendar portlet on all users' private pages. Select check the boxes next to the role(s) that should have access to one or both of the functions (Add Event or Export All Events). Using the Calendar Portlet The Calendar portlet generally works the way you would expect a calendar to work. Description: A description of the event. There are additional settings for the summary tab: you can select whether it has a horizontal or vertical layout. 130 Calendar . You will see a form that allows you to fill out all the information for your event. Inserting the variables that correspond with those values into your template will allow you to do that. By default. Now you are ready to begin using your calendar. which means that by default. Time Zone Sensitive: Leave this box checked to make sure that the portal keeps track of the event regardless of time zone. weekly. so you should find common tasks in the same place that you find them in other Liferay portlets. the Calendar portlet is set up to be used in one's personal space. Then click Submit.Liferay Collaboration Suite are several variables which allow you to insert runtime values into the message. so this is expected.

click Save. Chat Liferay's Chat portlet gives you a convenient way of allowing your users to send each other instant messages when they are logged into your web site. or in a simple list. You can have multiple chats open at a time. Illustration 60: Liferay's Chat Portlet The Chat portlet is very simple to use. The portlet shows you the number of your friends who are online. or instant message) to send it. year. Note that this feature is integrated with your profile on the portal. click the Online Friends link and then click the friend's name.properties file. text message. so you will need to fill out your mobile phone number and / or instant messenger IDs in order to use those features. To chat with one of them. showing who is logged on. click Settings. It appears as a bar at the bottom of every page. You can view calendar events by day. Reminders: Select whether to send a reminder. week. their statuses. End Date: If the event repeats on a schedule but there is an end to the set of meetings. You can then begin chatting with him or her. Here you can set your status. and whether to play a sound if someone sends you a message while you have the window or tab in the background. month.Liferay Collaboration Suite Type: Select from a number of pre-configured event types. whether to show if you are online. To change the settings. select the schedule. Repeat: If the event repeats on a schedule. When you have finished adding your event. enter the end date. and through what medium (email. how long before the event to send it. You can change these in the portal-ext. and any chats the logged-in user has had open. and Chat 131 .

Choose the option that you wish. Illustration 61: Liferay Mail Portlet. but is not included as part of the . Mail Liferay's Mail portlet enables your users to interact with their email using an easy to use.war manually on your application server. clicking Plugins Installation. clicking Plugins Installation. you are given a choice between an IMAP account or a Gmail account. you can install the Mail portlet by going to the Control Panel. but is not included as part of the . If you installed the Liferay . The Mail portlet is distributed with the Liferay bundles. For an IMAP account.Liferay Collaboration Suite even have one or more of them minimized. you can use the Mail portlet to integrate your users' mail with the rest of your web site. you can install the Chat portlet by going to the Control Panel. and then click Install. as it is a separate plugin. From there. with messages blurred out to protect the owner of the account. Find the Mail portlet in the list. ubiquitous web interface. click the Add a New Email Account link. click on it. and then clicking the Install More Portlets button. and fill out the form that appears. these fields are necessary: 132 Mail . Find the Chat portlet in the list.war manually on your application server. and then click Install. You can also connect the Mail portlet to a mail account provided by Google. click on it.war distribution.war distribution. To connect the Mail portlet with an email account. as it is a separate plugin. The Chat portlet is distributed with the Liferay bundles. If you installed the Liferay . If your mail system supports the IMAP protocol. and then clicking the Install More Portlets button.

To get started. is that Liferay's message boards can inherit the abilities of the Liferay development platform to provide an integrated experience that others cannot match. Liferay can provide a unique. The Message Boards portlet has a lot of configuration options. click the Compose Email link on the left side of the portlet. Sometimes it is three times: for the site. if your server supports it. Use Secure Outgoing Connection: Check this box to use an encrypted connection to the server. The application is a state of the art forum application similar to many forums in which you may have participated. click on it.Liferay Collaboration Suite Email Address: The email address which receives mail for this account. and the portlet will take care of the rest. click Save. and you can concentrate on building out the site that you want to build. users are even required to register twice: once for the main site and once for the message boards. Incoming IMAP Server: The host name for your IMAP (Internet Mail Access Protocol) server. Use Secure Incoming Connection: Check this box to use an encrypted connection to the server. and for the shopping cart. The difference. To compose a new message. You will be brought to an interface which allows you to read your mail and compose new messages. Outgoing Port: The port upon which the SMTP service is running. When finished. Outgoing SMTP Server: The host name of your SMTP (Simple Mail Transfer Protocol) server. add a Message Boards portlet to your site. In some cases. There are countless web sites out there where it is clearly evident that there is no link whatsoever between the main site and the message boards. To read a message. Password: The password for logging into the account. for the message boards. You will be brought to a form which allows you to compose an email message using the same rich text editor that appears everywhere else in Liferay. integrated approach to building your web site. click Check Your Mail. By providing a message boards portlet along with all of the other applications. of course. Message Boards Liferay's message boards are one of the most widely used collaboration features provided by the product. The Mail portlet is a great way to integrate a familiar service with other collaboration features that Liferay provides. all you need to do is provide your email address and your password. Next. For a Gmail account. Message Boards 133 . User Name: The user name for logging into the account. Incoming Port: The port upon which the IMAP service is running. but they are straightforward to use and are the reason why this portlet is a full-featured forum application for your web site. All of the integration work is done for you. if your server supports it.

Below the fields is a section called Definition of Terms which defines certain variables which you can use in the fields above to customize the email message.com. Subject Prefix: Enter a prefix that will be prepended to the subject line of the email. and more. Signature: Enter anything here that should appear as part of the signature of the email. the name is Joe Bloggs and the email address is test@liferay. Thread Priorities You can define custom priorities for message threads. and a priority number which denotes the order in which that priority should appear. There is also a field on this form that allows you to select a localized language for your priorities. By default. three priorities are defined: Urgent. Message Added Email This tab allows you to customize the email message that users receive when a message is added to a topic to which they are subscribed. To define a thread priority. the community name. If you need to do this. going from zero messages all the way up to 1000. Message Updated Email The Message Updated Email tab is identical to the Message Added Email tab. you can select the language from the selection box. By default. and Announcement. User Ranks Users can be ranked according to the number of messages they have posted. enter its name. Email From The first tab is labeled Email From. Body: Enter anything here that should appear in the body of the email. 134 Message Boards . This tab allows you to configure the email address that messages from the Message Boards portlet come from. These allow administrators to tag certain threads with certain priorities in order to highlight them for users. a URL to the image icon that represents it. Enabled: Uncheck the box to disable the message added email. except it defines the email message that users receive whenever a topic is updated. Some of these variables are for the message board category name. Sticky. You can set up custom ranks here. click the menu icon in the portlet's title bar and click Configuration. This is usually done so that users can set up message filters to filter the notifications to a specific folder in their email clients. Defaults have been provided for you.Liferay Collaboration Suite Once it is added.

all you need to do is set the rank. This allows you to define which roles have the ability to add a category of threads or to ban abusive users from the message boards. Uncheck the box to disable this feature. Permissions The default page that the Message Boards portlet displays has two buttons on it. click Save on the tab you are using and then click Return to Full Page. a regular Role. RSS Message board threads can be published as RSS feeds. Format: Choose the format among RSS 1. This tab allows you to define how the feeds are generated. Display Style: Select the style. an abstract. Uncheck the box if users must register on your site before posting to the message boards. Ratings This tab also contains a single check box. Check the box if you want to allow users to rate the messages that are posted. an Organization Role. You can publish the full content. Message Boards 135 .Liferay Collaboration Suite In addition to ranks. or is in a user group called Message Boards Administrator. Maximum Items to Display: Select the number of items to display in the feed.0. Select the roles and permissions you want to configure and then click Submit. or Atom 1. Click the one labeled Permissions. As with thread priorities.0 formats. anyone who has a Community Role. Anonymous Posting This tab contains a single check box. Check the box if you want to enable anonymous posting to the message boards.0. RSS 2. or just the title of a thread. on this tab you can define whether your ranks are localized in a particular language. and the name of the type. the collection type. Defaults are there for you which show you how to do this: Moderator=community-role:Message Boards Administrator Moderator=organization:Message Boards Administrator Moderator=organization-role:Message Boards Administrator Moderator=regular-role:Message Boards Administrator Moderator=user-group:Message Boards Administrator As you can see. or anyone who is the Organization Owner gets the Moderator rank. In the example above. you can also select who is a “moderator” by what roles are held. When you have finished setting up the message boards.

Server Port: Enter the port on which your mail service is running. Once you click the check box. Email Address: Enter the email address of the account that will receive the messages. a number of other options will appear. a number of other options will appear. User Name: The login name on the mail server. Click the Add Category button. Read Interval (Minutes): Liferay will poll the server at this interval looking for new messages to post. Enabling the mailing list function allows those users to simply reply to the notification messages in their email clients. there are two tabs: Incoming and Outgoing. User Name: Enter the login name on the mail server. he or she will get emails when someone posts messages to that category. The Outgoing tab has the following options: Email Address: Enter the email address that messages from this category should come from. Use Custom Outgoing Server: If you need to use a different mail server than the one that is configured for the portal. These define the mail settings for receiving mail and for sending mail. and those replies will be posted to the thread automatically. 136 Message Boards . Password: Enter the password for the account on the mail server. At the bottom of the form is a check box which allows you to enable the mailing list function. check this box. Use a Secure Network Connection: Check this box to use an encrypted connection if your server supports it. If you check the box. Enter a name for the category and a description of the category. Server Name: Enter the host name of the SMTP mail server you are using. The Incoming tab has the following options: Protocol: Select POP or IMAP. If you want your users to be able to reply to the categories using email. you will need a mail account for the category. this should be the same address configured on the Incoming tab. Password: The password for the account on the server. Server Port: Enter the port on which your mail service is running. If a user subscribes to a message board category.Liferay Collaboration Suite Adding Categories You are now ready to add categories to your message boards. The mailing list function works in concert with the message notification emails. Next. Server Name: Enter the host name of the mail server you are using. To enable this functionality. Use a Secure Network Connection: Check this box to use an encrypted connection if your server supports it.

click Save. which is a standard form of markup used in many message board products. If you lose interest in a particular topic. Before BBCode was invented. to an unlimited level. and the editor that is provided for Liferay's Message Boards portlet makes it very easy to use. Similarly. and other portlets—produces HTML. many message board products would allow users to enter HTML to format their messages. Message boards are nothing new to the Internet. You can always add more categories as your message boards grow. You can add a number of top-level categories and then click on each one and add categories under that. Liferay's message boards will seem very familiar to your users. go to the Categories tab. This is appropriate for those other portlets. many users of message boards are familiar with BBCode and are used to it. you may want to visit this tab and unsubscribe from a thread. so you can keep up on all the most recent discussions in the message boards. as they are only used by privileged users. the Statistics tab shows the number of categories. or your users will have trouble finding them. Recent Posts. You will see a message editing form. and the number of participants in your message boards. The reason for this is to support BBCode. enabled attackers to insert malicious code into the message board. For usability reasons. Besides this. you don't want to nest your categories too deep. the number of posts. The Banned Users tab shows all of the users who have been banned from posting on the message boards. and then click on the Post New Thread button. the Blogs portlet. and many people have been using them for quite a long time. The My Subscriptions tab allows a user to manage thread subscriptions. The body field on this form is different from that of the other portlets in Liferay. Using the Message Boards Upon seeing Liferay's Message Boards portlet.Liferay Collaboration Suite When finished adding your category. however. The My Posts tab shows all of the posts for the user that is currently logged in. Liferay supports BBCode in the message boards portlet because the other editor—which is used for the Content Management System. For that reason. Note that categories can have subcategories. The Recent Posts tab shows all posts from all categories by date. It also has a list of who the top posters to your message boards are. To post a new message thread. BBCode was invented to provide users a way of formatting their messages without allowing them to enter HTML. The Categories tab allows users to browse the categories for an appropriate place to post a thread. Statistics and Banned Users. This. but it is not appropriate for the message boards. For administrators. your users will immediately recognize that the interface is similar to many other implementations they've seen before. This is a convenient way to get back to a conversation you had once in order to retrieve some pertinent information. click on a category. and for administrative users. My Posts. You can also use the editor to quote from messages that you are replying to. At the top of the portlet is a set of tabs: Categories. to Message Boards 137 . Threads can be viewed in many ways. Users who have Moderator access to the board can modify the priority of messages. My Subscriptions. Add as many categories to your message boards as you wish.

as well as the dates that users created an ID on your site. to add preformatted text. in a tree view. The Message Boards portlet is also highly integrated with Liferay's user management features. This makes it easy to follow along with conversations. Messages that are posted to the message boards are shown by default in a threaded view. users can click links allowing them to post a new thread. When viewing a thread. without having to visit your site. A combination view shows the threads at the top as subjects only. When viewing a message board thread. allowing users to view threads in a flat view. A flat view shows all of the messages in the order in which they are posted. so that replies are next to the messages they are replying to. subscribe to the thread they are viewing. with the flat view underneath. A tree view shows all of the messages in a threaded view. users are given several options. insert emoticons. Posts on the message board show users' pictures if they have uploaded one for themselves. or if they have administrative access. 138 Message Boards . or in a combination view. You can see the emoticons that are available in the editor. move a thread to another category.Liferay Collaboration Suite Illustration 62: Editing a message boards post. users can simply reply to these messages in order to post back to the thread. and more. Subscribing to a thread causes Liferay to send the user an email whenever a new message is posted to the thread. If you have enabled the mailing list feature for the category in which the thread resides. so that replies are attached to the proper parent message. At the top right of the thread are three icons.

Illustration 63: Message Boards permissions. Go to the Control Panel and create this role. members of this role will be able to administer any Message Boards portlet in the portal. To do this. Message Boards 139 . You may wish to separate this function out by a role. Grant the permissions you wish message board administrators to have and then click Save. Browse the list until you find the Message Boards portlet and then click on it. You will then see a screen which allows you to configure the various permissions on the portlet. You can then add users to this role and they will inherit the permissions. click Actions → Define Permissions. In addition to these. This role can be scoped by the portal. including creating and deleting categories and posting threads. Click the Portlet Permissions button. a number of other functions are available. an organization. If it is a community or organization scoped role. If you have a portal scoped role. That would free you up to concentrate on other areas of your web site. members of this role will be able to administer a Message Boards portlet in only the community or organization in which they have the role. Message Board administrators can perform all of the functions we have already presented. Once it is created.Liferay Collaboration Suite Message Board Administrative Functions The Message Boards portlet provides for the day to day administration of the message threads. or a community. you can create a role called Message Board Administrator. and then delegate that role to one or more of your users.

sometimes certain users can become abusive. DELETING THREADS Users with administrative access to the message boards can delete threads. This is very easy to do. you can ban the user from posting on the message boards. Next to every thread is an Actions button. you can simply delete the thread from the message boards. In this case. This is easy to do. Click this link. Sometimes users will post links to copyrighted material or unsuitable pictures. This will show a list of all banned users. Find the user in the list and click the Unban this User link. SPLITTING THREADS Sometimes a thread will go on for a while and the discussion completely changes into something else. Underneath the user's name / profile picture is a link called Ban this User. In this case. there is a link at the top of the thread labeled Move Thread. First. but also everyone else's. If you have administrative access. view the list of threads. BANNING USERS Unfortunately. You will be presented with a simple form which allows you to select a category to which to move the thread and a check box which allows you to post a message explaining why the thread was moved. EDITING POSTS Administrative users can edit not only their own posts. click the link. First click on the thread. you can certainly make attempts to warn him or her that the behavior he or she is displaying is unacceptable. To split the thread. To do this. You 140 Message Boards . Administrative users will see a Split Thread link on each post. click the Move Thread button and the thread will be moved. If after taking this action the user apologizes and agrees to stop his or her abusive behavior. so you may need to be vigilant in deleting threads or consider the next option. this is very easy to do. Sometimes users begin discussing topics that are inappropriate or which reveal information which should not be revealed. you can split the thread where the discussion diverges and create a whole new thread for the new topic. Again. This does not prevent users from re-posting the information. you can choose to reinstate the user. Find any post which was written by the abusive user. Administrators may in this case want to move a thread to the proper category. Click this link to ban the user from the message boards. Click Actions → Delete to delete the thread.Liferay Collaboration Suite MOVING THREADS Many times a user will post a thread in the wrong category. You will be brought to a form which allows you to add an explanation post to the split thread. When finished. This message will be posted as a reply to the thread you are moving. If this does not work. click the Banned Users tab at the top of the Message Boards portlet. Click Ok to split the thread. If you wind up with a user like this.

0 in 2007. You should see some options which will now likely be familiar to you. it has the benefit of being able to take advantage of all of the features of the Liferay platform. This function can be used to make it so some privileged users can post on a certain thread. Subscribe. Getting Started with the Liferay Wiki The Wiki portlet works just like the other portlets developed by Liferay. Add the portlet to a page using the Add Application menu and then click Configuration in the portlet menu in the Wiki portlet's title bar. as each new wiki tried to focus on new features that other wikis did not have. Liferay's Wiki portlet supports WikiCreole as its syntax. but others are allowed to view it. and View permissions for the particular role to which you want to grant particular access. Permissions. For that reason. Update. though. like the Message Boards portlet. and security platform. So what is a wiki? Put simply. Wikis 141 . of course. To do this. has many applications—the most famous of which is Wikipedia. which is a full encyclopedia developed collaboratively by users from all over the world. which is used for collaborative documentation for the Standard Edition of the product. a wiki is an application which allows users to collaborate on information. To accomplish this. which allows you to redact information that should not be posted or to censor profanity that is not allowed on your message boards. You can choose to limit a particular conversation or a post to only a select group of people. click the Permissions link on the post and then select among the Delete. Again. Another example would be Liferay's wiki. with a link to the full documentation if you wish to use some of WikiCreole's advanced features. A wiki application allows users to create and edit documents and link them to each other. which is an attempt to define a standard wiki markup that all wikis can support.Liferay Collaboration Suite can edit these posts. but also on individual posts. a project called WikiCreole was started. As such. The portlet provides a handy cheat sheet for the syntax on the page editing form. it is completely integrated with Liferay's user management. PERMISSIONS Permissions can be set not only on threads. This syntax is a best-of-breed wiki syntax and should be familiar for users of other wikis. a special form of markup is used which is sometimes called wikitext. the proliferation of many different wiki applications resulted in slightly different syntax for wikitext in the various products. This project resulted in the release of WikiCreole 1. using a wiki. is a full-featured wiki application which has all of the features you would expect of a state of the art wiki. This. Unfortunately. Rather than define another wikitext syntax. Wikis Liferay's Wiki portlet. tagging. or any combination of the above permissions.

an abstract. import pages to the wiki. Managing Wikis The Wiki portlet can contain many wikis. This is the Manage Wikis button. Clicking this allows you to define what roles have access to create wikis. set permissions on the wiki. a separate forum. you can click the box in the Add Node column and then click Submit. called Main. The Page Added Email tab lets you customize the message that is sent to subscribers when a new Wiki page has been added. or just a title in the feed. Next to each wiki in the list of wiki nodes is an Actions button. At the top left of the portlet window is a small icon of a wrench. You can also set up some default permissions. MediaWiki is the only wiki that is supported. subscribe to the wiki. At the top of this screen is a Permissions button. delete pages. The Email From tab lets you configure a name and an email address which will be populated in the From field of email messages sent by the portlet. By default. click Save and then click Return to Full Page. Click on it. You will see that the Main wiki has already been added for you. and view the wiki. it will appear in a list at the top of the main page of the portlet. You may wish to do this if you are migrating your site from a set of disparate applications (i. a separate wiki. modify. update existing pages. Currently.Liferay Collaboration Suite As with the Message Boards portlet.. You can also enable comments and comment ratings on wiki pages. Clicking the Add Wiki button brings you to a screen which allows you to give the wiki a name and a description. add pages to the wiki. you can configure messages which come from the Wiki portlet. This allows you to migrate off of another wiki which you may be using and use the Liferay wiki instead. which provides all of these features. You can choose which wikis are visible by moving them to a Visible or Hidden list.e. You will then be brought to a screen that allows you to add. Import Pages: You can import your data from other wikis. 142 Wikis . You can set the maximum number of items to display and whether you want to display the full content. If you have created a specific role for creating wikis. Once you have set the options the way you want them. it contains only one. When you create a new wiki. The Display Settings tab lets you configure how wikis and wiki pages are shown to users. a separate content management system) to Liferay. The Page Updated Email tab lets you customize the message that is sent to subscribers when a Wiki page has been edited. This allows users to interact with each other concerning edits to the content. This button contains several options: Edit: Lets you edit the name and description of the wiki. but others are likely to be supported in the future. Permissions: Lets you define what roles can add attachments to wiki pages. The RSS tab allows you to set up the RSS feed for the Wiki. and delete wikis. and that role will have access to create new wikis in this portlet. enabling them to collaborate on changes.

called FrontPage. Feel free to add pages showing people how to do stuff. click on its name in the list of wikis. Adding and Editing Wiki Pages By default. which should allow us to collaborate on documentation. You can use this syntax to format your wiki pages. Consider for example the following wiki document: == Welcome to Our Wiki! == This is our new wiki. To go back to your wiki. Notice that there is a very convenient “cheat sheet” which can help with the wiki syntax. Illustration 64: Editing the default page in the wiki portlet You can now begin to add content to the page. Delete: Deletes the wiki node. there is one page added to your wiki. Below are links to some sections that have already been added. To get started adding data to your wiki.Liferay Collaboration Suite Subscribe: A user can subscribe to a wiki node and any time a page is added or updated. click the Edit link at the top right of the portlet. You will be brought to a blank editing page. [[Introduction ]] [[Getting Started]] [[Configuration]] [[Development]] [[Support]] Wikis 143 . Liferay will send an email to the user informing him or her what happened.

144 Wikis . you can disable the HTML format using the portal-ext. and therefore needs to be created. except this time you will be creating the page behind the link you just clicked. a paragraph of text. This allows you to organize your content in a more formal fashion. Page Details When viewing a page.Liferay Collaboration Suite [[Community]] This would produce the following wiki page: Illustration 65: Wiki text added to front page This adds a simple heading. We generally recommend that you stick with the Creole format. If you click one of those links. As you can see. it is very easy to create wiki pages. All you have to do is create a link from an existing page. Note that at the top of the screen you can select from the Creole wiki format and the HTML editor that comes with Liferay. you can select Categories for the article. and also contains a few actions that you can perform on the page. Title: Displays the title of the page. This allows you to view many properties of the page. You can create categories using the Control Panel. Liferay will display a notice at the top of the page stating that the page does not exist yet. At the bottom of the page editing screen.properties file. There are several tabs which organize all of the details into convenient categories. DETAILS The Details tab shows various statistics about the page. and several links to the page. If you want all of your users to use the Creole format. This indicates that the page behind that link does not yet exist. you will be brought immediately to the editing screen you were on previously when you edited the front page. as it allows for a much cleaner separation of content and code. in the Tags and Categories section. you can view its details by clicking the Details link which appears in the top right of the page. instead of the normal blue color in the default Liferay theme. and that you are creating it right now. Notice that the links are red. See the next chapter for further information on how to configure this. Categories are a hierarchical list of headings under which you can create wiki pages.

RSS Subscription: Displays links which allow you to subscribe to the page as an RSS feed in three formats: RSS 1. Navigating in the Wiki Portlet At the top of the portlet is a list of links which allow you to navigate around the wiki. You can revert a page back to a previous state and you can also compare the differences between versions by selecting the versions and then clicking the Compare Versions button. Simply click on the wiki's name to begin browsing that wiki. or delete the page. These are wiki links to and from the page. After this is a set of navigation links: FrontPage: Takes you to the main page of the main wiki.0. Recent Changes: Takes you to a page which shows all of the recently updated pages. Attachments: Displays the number of attachments to the page. All Pages: Takes you to a flat. Email Subscription: Contains links allowing you to subscribe to the entire wiki or just to this page. Last Changed By: Displays the user who last modified the page. make a copy of the page. This is mostly used to attach images to wiki articles which can then be referenced in the text. You can attach any file to the wiki. alphabetical list of all pages currently stored in the Wikis 145 . Next to the Manage Wikis button is a list of wikis that are currently created in the portlet. RSS 2. which is a nice way to include illustrations in your wiki documents. HISTORY This tab shows a list of all of the versions of the wiki page since it was created. The wiki portlet automatically keeps track of page versions whenever a page has been edited. move (rename) the page.0. You can use this tab to examine how this page links to other pages and how other pages link back to this page.Liferay Collaboration Suite Format: Displays the format for the page—either Creole or HTML. ATTACHMENTS The last tab is for attachments. Advanced Actions: Contains links allowing you to modify the permissions on the page. Referencing them using the proper WikiCreole syntax renders the image inline. and Atom 1. Created By: Displays the user who created the page. Latest Version: Displays the latest version of the page.0. INCOMING / OUTGOING LINKS The next two tabs are for incoming and outgoing links.

After this. The Blogs and Blogs Aggregation portlets can be used to manage shared blogs or blogs belonging to a group of people at once. event notification. This portlet can be used to manage heavily trafficked discussion forums with ease. You can use them to great effect to enhance your web site and to build a vibrant. together with the rest of the things Liferay is aggregating for you. and more. You can use the wiki portlet to manage several wiki nodes. 146 Summary . nested discussion categories. a link will be displayed which allows you to create a new wiki page on the topic for which you searched. Orphan Pages: This link takes you to a list of pages that have no links to them. It inherits all of the security features of the Liferay platform and includes administrative functions for thread priorities. RSS feeds. You can add as many IMAP or Gmail mail accounts as you wish. it inherits the strengths of the Liferay platform in the form of security. moving threads. These portlets have all the features you would want in a blog. tags. Summary We have together explored all of the portlets in Liferay's collaboration suite. This area allows you to review wiki pages that are orphaned in this way so that you can re-link to them or delete them from the wiki if they are no longer relevant. It includes features for events. active community. interface. If the search term is not found. including rich text editing. Integrating mail with your portal is easy with the Mail portlet. Liferay's Wiki portlet is a state of the art wiki application that users can make use of to collaborate on web pages. we went over all of the portlets in succession. The Calendar portlet likewise can be used to manage a shared calendar or a group calendar. and import and export to and from the standard iCalendar format. Liferay's collaboration platform is a full suite of integrated applications that empower users to work together. Again. and search. You have seen how you can configure all of the portlets in a similar fashion using a unified user interface. or use many wiki portlets to manage one node each. repeatable events. links to news aggregators.Liferay Collaboration Suite wiki. and this portlet can keep them all organized in one place. Discussion becomes easy with Liferay's Message Boards portlet. banning users. This can happen if you take a link out of a wiki page in an edit without realizing it's the only link to a certain page. and more. Search: Enter a term here and click the Search button to search for items in the wiki.

Plugin Management: You will learn how to install Plugins (portlets and themes) from Liferay's Official Repository and Liferay's Community Repository. Liferay SOA: Accessing Liferay services remotely. There are also some other settings that you may want to further customize. We will first go over the main configuration file. rather than going in and customizing the default configuration file. and so this chapter will have a wide-ranging set of topics. making it more difficult to customize. and is called portal-ext.5. as well as how to configure the security settings for these services. These files can be modified to change Liferay's behavior in certain ways. which is stored in the Liferay Home directory. from outside the portal. will be discussed. You put just the settings you want to customize in your own configura- . Why is it set up this way? Because Liferay uses the concept of overriding the defaults in a separate file. as well as how to create your own plugin repository. In fact.properties File Liferay's properties files differ from the configuration files of most other products in that changing the default configuration file is discouraged. There are a large number of configuration options that can be set.properties file. security configuration. and accessing Liferay's web services. ● The portal-ext. ADVANCED LIFERAY CONFIGURATION Liferay is configured by a combination of settings which are stored in the database (configured by the use of the Control Panel) and settings which are stored in properties (text) files.properties. adding features to Liferay through plugin management. the file that contains all of the defaults is stored inside of a . We will examine specifically these topics: ● ● Advanced Liferay Configuration: This includes the customization of the portalext.jar file. They include changing certain out-of-box defaults.

What follows is a brief description of the options that can be placed there.properties You can add additional property files that overwrite the default values by using the external-properties system property. not an alphabetical one. The file which is used to override the configuration is portal-ext.properties. then portal-ext.properties include-and-override=${external-properties} LIFERAY HOME Specify the Liferay home directory.properties. resource.properties include-and-override=${liferay. For example.properties. liferay. and then portal-test.repositories. Updates should not be made on the original file (portal. thus overriding the defaults from the portal. the file does not exist at all. A common use case is to keep legacy property values when upgrading to newer versions of Liferay.properties. Examples: include-and-override=portal-ext.1.home=${resource.root=${default. each portal instance can have its own overridden property file following the convention portal-companyid. -Dexternal-properties=portal-legacy-5.jar file is located in Liferay Portal's WEB-INF/lib folder.jar file. Furthermore. These are presented in a logical order. By default. This makes it far easier to determine whether a particular setting has been customized.home} PORTAL CONTEXT This specifies the path of the portal servlet context. as many properties relate to other properties in the system.. it is portal-ext.properties file.liferay. and it resides inside of the portal-impl. and it makes the settings more portable across different installations of Liferay.properties.Advanced Liferay Configuration tion file. This is needed because 148 Advanced Liferay Configuration . unless you are running an older version of Liferay.properties. For example: java . The default configuration file is called portal.repositories.properties.root} This property is available for backwards compatibility. This file can be created in your Liferay Home folder (please see Chapter 2: Initial Setup for the location of this folder for your application server). This .home}/portal-ext. one read order may be: portal. PROPERTIES OVERRIDE This property specifies where to get the overridden properties. By default. and then the configuration file for your portal is uncluttered and contains only the settings you need. Please set the property liferay.properties) but on the overridden version of this file..home instead.

liferay.upgrade. JCR. Set this property if you deploy the portal to another path besides root.portal.url=false SCHEMA Set this to true to automatically create tables and populate with default data if the database is empty.\ Advanced Liferay Configuration 149 .UpgradeProcess_4_3_2.liferay.UpgradeProcess_4_3_5.root=/home/liferay TECHNOLOGY COMPATIBILITY KIT Set the following to true to enable programmatic configuration to let the Portlet TCK obtain a URL for each test.portal. Under this path several directories will be created for the hot deploy feature.portal.servlet.run.repositories.\ com.\ com.portal. schema.enabled=true Set this to to true to populate with the minimal amount of data.upgrade.portal.liferay.UpgradeProcess_4_3_0.upgrade.upgrade. This should never be set to true unless you are running the TCK tests.UpgradeProcess.upgrade.\ com.root=${user.ctx=/ portal. etc.home}/liferay resource.liferay.UpgradeProcess_4_3_4.UpgradeProcess_4_3_3. tck.processes=\ com.liferay. Set this to false to populate with a larger amount of sample data.Advanced Liferay Configuration javax.upgrade.UpgradeProcess_4_3_1.minimal=true UPGRADE Input a list of comma delimited class names that implement com.upgrade. These classes will run on startup to upgrade older data to match with the latest version. Examples: portal.ctx=/portal RESOURCE REPOSITORIES ROOT Specifies the default root path for various repository and resource paths.\ com.ServletContext does not have access to the context path until Java EE 5.liferay.upgrade.liferay.liferay.\ com.repositories.UpgradeProcess_4_4_0.portal.run.\ com. schema. upgrade.portal. Examples: resource.portal.

portal. The application serv150 Advanced Liferay Configuration .portal.portal.verify.\ com. auto.liferay.portal.liferay.portal. public static final int ONCE = 1.\ com.portal.auto.exploded.\ com. Constants in VerifyProcess: public static final int ALWAYS = -1.\ com.liferay.WebAutoDeployListener.UpgradeProcess_5_2_1.upgrade.deploy.processes=com. and themes to auto deploy.liferay.auto.\ com.deploy.portal.kernel.\ com.VerifyProcess.LayoutTemplateExplodedTomcatListener. public static final int NEVER = 0.deploy.\ com.portal. auto. portlets.tomcat.auto.UpgradeProcess_5_1_0.UpgradeProcess_5_2_0.portal.upgrade.auto.AutoDeployListener.exploded.\ com.tomcat.liferay.upgrade.frequency=1 AUTO DEPLOY Input a list of comma delimited class names that implement com.liferay.deploy.portal.liferay.portal.Advanced Liferay Configuration com.deploy.liferay.liferay.deploy. These classes will run on startup to verify and fix any integrity problems found in the database.ThemeAutoDeployListener.deploy.liferay.listeners=\ com.tomcat.ThemeExplodedTomcatListener Set the following to true to enable auto deploy of layout templates.exploded.VerifyProcessSuite Specify the frequency for verifying the integrity of the database.liferay. These classes are used to process the auto deployment of WARs. portlets.\ com.dir=${liferay.\ com.upgrade.liferay.deploy.deploy. and themes.portal.UpgradeProcess_5_2_2 VERIFY Input a list of comma delimited class names that implement com.deploy.auto.UpgradeProcess_5_0_0.liferay.auto.portal.upgrade. verify.LayoutTemplateAutoDeployListener.\ com.portal.deploy.upgrade. verify.HookAutoDeployListener.integrity. auto.PortletAutoDeployListener.UpgradeProcess_5_1_2.home}/deploy Set the directory where auto deployed WARs are copied to.liferay.liferay.portal.portal.deploy.liferay.auto.auto.auto.\ com.enabled=true Set the directory to scan for layout templates.portal.PortletExplodedTomcatListener.deploy.liferay.

0.deploy.7 because WebSphere's portlet container will try to process a portlet at the same time that Liferay is trying to process a portlet.home}/webapps auto. Different containers have different hot deploy paths.base. auto. This will append a 1 in front of your WAR name. you need to add a context parameter to the web.dir=${org.blacklist.deploy. For example. JBoss now knows to load this portlet after the other WARs have loaded.base.war.base}/webapps/autoload auto. it will deploy it to 1test-portlet.portlet.sun.deploy.deploy.dir=${env.dest.xml to portlet-custom.war.base}/webapps auto.apache.instanceRoot}/autodeploy auto.dir=${jonas.deploy.dest.weblogic. This is only needed when deploying the portal on WebSphere 6.resin.jonas-jetty.dir}/deploy auto.glassfish.dest.dest.dir= auto.unpack.deploy.deploy.base}/webapps/autoload auto.dest.sun.dest.server. enabling Liferay to pick it up.deploy.DOMAIN_HOME}/autodeploy Set the interval in milliseconds on how often to scan the directory for changes.dir}/deploy.websphere.dir=${com.dir=${org.jetty. auto. Set a blank directory to automatically use the application server specific directory.dir=${jboss. Set this to false if your application server has concurrency issues with deploying large WARs.deploy. Examples: auto.9.dir}/deploy auto.server. Note that according to IBM.apache. it will remove the 1 from the context path.tomcat.glassfish-tomcat.threshold=10 Set the following to true if deployed WARs are unpacked.dir=${jonas.dest.dest. Advanced Liferay Configuration 151 .dest. This parameter causes WebSphere's built-in portlet container to ignore your portlet application when it is deployed.aas.ibm.instanceRoot}/autodeploy auto.deploy..aas.custom.dest.dir=${com.deploy.dir=${catalina.xml=false Set this to 1 if you are using JBoss' PrefixDeploymentSorter.home.Advanced Liferay Configuration er or servlet container must know to listen on that directory.0.portletcontainer.deploy.home.base}/webapps whereas JBoss listens on ${jboss.geronimo-tomcat.dest. however. if you are deploying a portlet called testportlet.dir}/deploy auto.PortletDeploymentEnabled and set it to false.dir}/deploy auto.interval=10000 Set the number of attempts to deploy a file before blacklisting it.war=true Set the following to true if you want the deployer to rename portlet.1. on versions after 6.apache.geronimo.deploy./webapps auto.jonas-tomcat.x with a version before 6.deploy.xml.dest. auto.geronimo. Tomcat listens on ${catalina.deploy.deploy.deploy.home}/webapps auto.deploy.1.base.default.dir=${jetty.geronimo.geronimo.dest.jboss-tomcat.dir=. auto.dest.geronimo-jetty.dir=${org.dir=${resin.xml descriptor in your portlet application called com.1. For example.

These classes are used to process the deployment and undeployment of WARs at runtime.deploy.deployment.net/viewvc/* checkout*/lportal/portal/trunk/lib/development/quercus.kernel.MessagingHotDeployListener 152 Advanced Liferay Configuration .url.lib.svn.xml.liferay.dm.jee.deploy.liferay. The context XML file must have a docBase attribute that points to a valid WAR directory.deploy.hot.portal. See org.hot. Tomcat context XML files found in the auto deploy directory will be copied to Tomcat's configuration directory.passwd=adminadmin auto.deployment.hot.deploy.jar library.hot..dm.LayoutTemplateHotDeployListener.net/viewvc/*checkout*/lportal/portal/trunk/lib/development/script-10./common/lib/ext Set the URLs of Libraries that might be needed to download during the auto deploy process library./conf/Catalina/localhost Set the path to Tomcat's global class loader.PluginPackageHotDeployListener.\ com.portal.\ com.enabled=false auto.dm.HookHotDeployListener.tomcat.deploy. Note: PluginPackageHotDeployListener must always be first.portal.\ com.glassfish-tomcat.sun.sourceforge.hot.script-10.id=deployer:Sun:AppServer::localhost:4848 auto.liferay.SunDeploymentFactory HOT DEPLOY Input a list of comma delimited class names that implement com.glassfish-tomcat.liferay.deployapi.PrefixDeploymentSorter.svn.url.deploy. This property is only used by Tomcat in a standalone environment.ThemeLoaderHotDeployListener.jar=http://lportal.portal.deploy. auto. auto.liferay.\ com.svn.jee.jar=http://lportal.dir=.jar Set the Glassfish settings to enable JSR 88 application deployment.scanner.download.net/viewvc/*checkout*/lportal/portal /trunk/lib/development/resin-util.glassfish-tomcat.glassfish-tomcat.url.prefix=1 Set the path to Tomcat's configuration directory.jee.jboss.download.glassfish-tomcat.deploy.portal.Advanced Liferay Configuration Modify /server/default/conf/jboss-service. hot.conf.portal.resinutil.jboss.ThemeHotDeployListener.portal.liferay.hot. auto.deploy.df.sourceforge.\ com.deploy.deploy.jee..PortletHotDeployListener.user=admin auto.dir=.deploy.portal.deploy.deploy.\ com.hot.quercus. auto.jar=http:// lportal.hot.download. This property is used to auto deploy exploded WARs.liferay.HotDeployListener.tomcat.liferay.jee.enterprise.sourceforge.classname=com.jar library.deploy.listeners=\ com.deploy.deploy.

plugin. Administrators won't be notified when a new version of these plugins are available.liferay.packages.dtd and the virtual-path element for more information. plugin.theme.untrusted=http://plugins.undeploy. portlet.types=portlet.Advanced Liferay Configuration HOT UNDEPLOY Set the following to true to enable undeploying plugins.impl=sun Set this property to define the default virtual path for all hot deployed portlets. This property will only be used if the property hot.repositories.trusted=http://plugins.layout-template. You can also end the id with an asterisk to match any id that start with the previous character.validate=true Advanced Liferay Configuration 153 . plugin.notifications.enabled=true Input a list of plugin packages ids separated by \n characters. The ids are of the form groupId/artifactId.virtual.impl=internal #portlet.xml against the portlet schema.notifications.ignored=liferay/sample-jsp-portlet PORTLET Set this property for the portlet container implementation to use. hot.interval=0 Set the following to true to undeploy a plugin before deploying a new version.com/community Set this property to false to avoid receiving on screen notifications when there is a new version of an installed plugin.xml.hook.undeploy. portlet.undeploy.enabled is set to true.container. See liferay-portlet-app_5_1_0. portlet.on. hot.web Input a list of Liferay plugin repositories separated by \n characters. plugin. The Sun implementation provides more features and will be the recommended implementation in the future.com/official plugin.container. The default implementation is the internal implementation and provides for the best backwards compatibility.repositories. hot.undeploy.enabled=true Set the undeploy interval in milliseconds on how long to wait for the undeploy process to finish.redeploy=false PLUGIN Input a list of comma delimited supported plugin types.path= Set this property to true to validate portlet.liferay.

icon=liferay.path= Set this with an absolute path to specify where imported theme files from a LAR will be stored.css.xml.images. It is recommended that you 154 Advanced Liferay Configuration .distribution=ALL_PORTLETS_ON_PAGE THEME Set this property to true to load the theme's merged CSS files for faster loading for production. theme.virtual. If the value is ALL_PORTLETS.event. then public render parameters will be distributed to all portlets that are present on a portal page.public.generation=3 Set this property to specify how public render parameters are distributed. this also means that a lot of themes that are no longer used remain in the file system.storage.load=true Set this property to true to load the theme's merged image files for faster loading for production. Set this property to false for easier debugging for development. theme. portlet. You can also disable fast loading by setting the URL parameter images_fast_load to 0.shortcut. If the value is ALL_PORTLETS_ON_PAGE.fast. However. This will ensure that a copy of the old theme is preserved in the theme loader storage path. Set this to true if imported themes should use a new theme id on every import. If the value is ALL_PORTLETS_ON_PAGE. You can also disable fast loading by setting the URL parameter css_fast_load to 0. then events will be distributed to all portlets that are present on a portal page. This path will override the file-storage path specified in liferay-themeloader.path= Themes can be imported via LAR files.distribution=ALL_PORTLETS_ON_PAGE Set this property to specify the maximum number of events that can be generated from portlets to prevent infinite loops. theme. portlet.event.render. then public render parameters will be distributed to all portlets that are the deployed.ico Set this property to set the default virtual path for all hot deployed themes. then events will be distributed to all portlets that are then deployed.parameter. See liferay-look-and-feel_5_1_0.Advanced Liferay Configuration PORTLET COORDINATION Set this property to specify how events are distributed.fast. theme.max.loader. Set this property to false for easier debugging for development.dtd and the virtual-path element for more information.load=true Set the theme's shorcut icon. portlet. theme. If the value is ALL_PORTLETS.

xml. model.read.configs=\ META-INF/portal-model-hints.theme.only.\ get service.portlet. resource.new.persistence.prefixes=\ contains.builder.prefixes=\ get.actions.configs=\ META-INF/base-spring.import=false Set this to true to decorate portlets by default.Advanced Liferay Configuration set this to false.xml.xml SERVICE BUILDER Input a list of common delimited method prefixes designated for read-only transactions.decorate.\ Advanced Liferay Configuration 155 . spring.configs=resource-actions/default.loader.service.portlet.default=true Set this to true to exposing sharing icons for portlets by default.builder.\ find.xml.default=false RESOURCE ACTIONS Input a list of comma delimited resource action configurations that will be read from the class path. Service Builder will use these prefixes to annotate methods that are to run in read-only transactions.\ META-INF/ext-model-hints. theme.\ META-INF/workflow-model-hints.on.read. theme.only.xml.\ META-INF/portlet-model-hints.hints. theme.xml.xml MODEL HINTS Input a list of comma delimited model hints configurations. service.id.sharing. These will be loaded after the bean definitions specified in the contextConfigLocation parameter in web.\ search SPRING Input a list of comma delimited Spring configurations.\ count.

xml.Advanced Liferay Configuration \ META-INF/hibernate-spring.\ META-INF/infrastructure-spring.\ \ META-INF/mirage-spring. #hibernate.xml.xml.\ META-INF/mail-hbm.xml.PortalHibernateConfiguration.\ META-INF/wsrp-spring.xml Set the bean name for the Liferay data source.source=liferayDataSource Set the bean name for the Liferay session factory.hibernate.xml.xml.\ \ META-INF/editor-spring.xml. spring.xml.\ META-INF/lock-spring.\ META-INF/portal-spring.xml. They map to various Hibernate configuration options which themselves have detailed documentation.xml.xml. Input a list of comma delimited Hibernate configurations. Set this property to manually override the automatically detected dialect.\ META-INF/jcr-spring.dialect= 156 Advanced Liferay Configuration .xml.\ \ META-INF/counter-spring.configs=\ META-INF/counter-hbm.xml. Please see http://www.\ \ META-INF/ext-spring.xml. hibernate.xml.xml.\ \ META-INF/util-spring.hibernate.xml. spring.hibernate.\ META-INF/scheduler-spring.org for more information.xml.\ META-INF/document-library-spring.liferay.session.\ META-INF/management-spring.xml.factory=&liferaySessionFactory HIBERNATE Many of the following properties should only be customized if you have advanced knowledge of Hibernate.spring.data.\ META-INF/messaging-spring.\ META-INF/mail-spring.\ META-INF/search-spring.xml.\ META-INF/portlet-container-spring.\ META-INF/ext-hbm.\ META-INF/portal-hbm.xml Liferay will automatically detect the Hibernate dialect in com.portal.

cache.hibernate.cache.configurationResourceName for detailed configuration.NoCacheProvider hibernate.portal.cache.cache.cache.hibernate.ehcache.orm.use_second_level_cache=false Set the JDBC batch size to improve performance.batch_size=0 Advanced Liferay Configuration 157 . net. however.cache. Ehcache is recommended in a clustered environment.cache. This may be a performance hit.xml Use the following ehcache configuration in a clustered environment.ehcache. hibernate.sf.xml Set other Hibernate cache settings.portal.cache.liferay. hibernate.sf.use_query_cache=true hibernate.HashtableCacheProvider hibernate.orm.xml Uncomment the following in a Terracotta environment.release_mode=on_close Set the Hibernate cache provider.provider_class= \ com.configurationResourceName=/ehcache/hibernate.provider_class= \ com. net. The default setting works best for Spring managed transactions.use_minimal_puts=true hibernate.dao.dao.EhCacheProvider hibernate.hibernate3.Advanced Liferay Configuration Set the Hibernate connection release mode.cache.provider_class=org. Examples: hibernate. Examples: hibernate.hibernate.LocalSessionFactoryBean and search for the phrase "on_close" to understand how this works.ehcache.batch_size=20 hibernate.liferay.provider_class= \ net. you may only want to use these properties for diagnostic purposes.cache.orm.sf.portal. See the method buildSessionFactory in class org.sf.provider_class= \ com.ehcache.springframework.cache.hibernate.cache.OSCacheProvider #hibernate.jdbc.connection.TerracottaCacheProvider This property is used if Hibernate is configured to use Ehcache's cache provider.dao.use_structured_entries=false Use these properties to disable Hibernate caching.cache.sf.orm. You should not modify this unless you know what you're doing.hibernate.configurationResourceName=/ehcache/hibernate-clustered. If you're using Oracle 9i. See the property net.configurationResourceName=/ehcache/hibernate-terracotta.liferay.use_second_level_cache=true hibernate. hibernate.use_query_cache=false hibernate. #net.jdbc. See LEP-1234 for more information. you must set the batch size to 0 as a workaround for a hanging bug in the Oracle driver.

See http://www.show_sql=false Use the classic query factory until WebLogic and Hibernate 3 can get along.jcc.html#A23 for more information.name is not set.write. These properties will only be read if the property jdbc.password=lportal DERBY jdbc.jdbc.db2.url=jdbc:derby:lportal jdbc. DB2 jdbc.use_reflection_optimizer=true hibernate.write.Advanced Liferay Configuration Set other miscellaneous Hibernate properties.default. Add dynamic-data-source-spring.jndi.hibernate.default. hibernate.DB2Driver jdbc.default.generate_statistics=false JDBC Set the JNDI name to lookup the JDBC data source.hql.username=db2admin jdbc. These data sources can also be created via JNDI by setting the properties jdbc. If none is set.ClassicQueryTranslatorFactory Set this property to true to enable Hibernate cache monitoring.default.factory_class=org.use_scrollable_resultset=true hibernate.default.name=jdbc/LiferayPool Set the properties used to create the JDBC data source.name.default.classic. #jdbc. to handle write calls.hibernate. to handle read calls and another set of properties prefixed with jdbc.query. hibernate.derby. The default settings are configured for an in-memory database called Hypersonic that is not recommended for production use.org/250.name and jdbc.ibm.jndi.jndi.read.default.username= jdbc. hibernate.default. The convention is to create a set of properties prefixed with jdbc.default.jdbc.bytecode. See LPS-2056 for more information.driverClassName=org.default.EmbeddedDriver jdbc.url=jdbc:db2:lportal jdbc.password= 158 Advanced Liferay Configuration .driverClassName=com. Please change the properties to use another database. then the portal will attempt to create the JDBC data source based on the properties prefixed with jdbc.configs to configure the portal to use one database cluster for read calls and another database cluster for write calls.read.jndi.xml to the property spring.apache.default.

driverClassName=net.spy.default.username=sa jdbc.driverClassName=net.default.default.engine.Driver jdbc.default.driverClassName=org.password= SQL SERVER jdbc.driver.default.url=jdbc:postgresql://localhost:5432/lportal jdbc.username=sa jdbc.url=jdbc:oracle:thin:@localhost:1521:xe jdbc.jtds.default.home}/data/hsql/lportal jdbc.username= jdbc.default.jdbc.url=jdbc:jtds:sqlserver://localhost/lportal jdbc.url=jdbc:hsqldb:${liferay.default.default.p6spy.sourceforge.mysql.username=sa jdbc.hsqldb.default.default.driverClassName=com.url=jdbc:jtds:sybase://localhost:5000/lportal jdbc.password=lportal P6SPY jdbc.Driver jdbc.default.default.jdbc.Advanced Liferay Configuration HYPERSONIC jdbc.username= jdbc.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.jdbcDriver jdbc.default.default.password= ORACLE jdbc.username=lportal jdbc.OracleDriver jdbc.driverClassName=com.default.default.username=sa jdbc.Driver jdbc.default.default.password= POSTGRESQL jdbc.Driver jdbc.default.password= Advanced Liferay Configuration 159 .jdbc.driverClassName=oracle.password= MySQL jdbc.default.jdbc.default.default.postgresql.default.password= SYBASE jdbc.sourceforge.default.P6SpyDriver jdbc.jtds.driverClassName=org.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.default.default.default.

liferay.xml 160 Advanced Liferay Configuration .config. so that you can see how you can override it for a database that PortalHibernateConfiguration does not yet know how to auto configure.function.maxPoolSize=50 jdbc.portal.config.vm. this is more of an option for developers who are customizing Liferay's behavior. Edit the file specified in the property ehcache. Set the custom.location=/ehcache/liferay-multi-vm-clustered.function.isnotnull properties for your specific database. ehcache.com/projects/c3p0/index.vm.xml Some databases do not recognize a NULL IS NULL check.single. See http://www. These properties are available. There is no need to manually set these properties because com.config.xml.xml Use the following in a clustered environment.mchange.sql.sql.location=/ehcache/liferay-single-vm. however.Advanced Liferay Configuration Liferay uses C3PO by default for connection pooling.multi.default.default. The data source factory can be configured to use JNDI or another pooling implementation by modifying infrastructure-spring.isnotnull=CAST(? AS VARCHAR(32672)) IS NOT NULL DATABASE Specify any database vendor specific settings. ehcache.engine=InnoDB EHCACHE Set the classpath to the location of the Ehcache config file for internal caches.sql. jdbc.html configuration for a list of additional fields used by C3PO for configuring the database connection. MYSQL database.multi.multi-vm.minPoolSize=5 CUSTOM SQL Input a list of comma delimited custom SQL configurations.PortalHibernateConfiguration already sets it.isnull=CAST(? AS VARCHAR(32672)) IS NULL custom.location to enable clustered cache.xml ehcache.mysql.spring.vm.location=/ehcache/liferay-multi-vm.configs=custom-sql/default.sql.function.isnull and custom. DB2 custom.function. custom.config. Liferay Administrators should never need to customize this.sql.

js.draggable.js.\ Advanced Liferay Configuration 161 . There are two lists of files specified in the properties javascript. The second grouping denotes utility classes that rely on the first group. The everything list includes everything else not listed in the barebone list. the barebone list is the minimum list of JavaScript files required for most cases.enabled for more information on the logic of when the barebone list is used and when the everything list is used and how to customize that logic.everything. See the property javascript.core.jsp. but does not rely on the second or third group.js.barebone.js.\ jquery/j2browse.\ jquery/livequery. As the name suggests.js.files. The two lists of files exist for performance reasons because unauthenticated users usually do not utilize all the JavaScript that is available. Specifically.load for more details. The Liferay scripts are grouped in such a way that the first grouping denotes utility scripts that are used by the second and third groups.dialog.\ jquery/cookie.barebone.js.Advanced Liferay Configuration JAVASCRIPT Set a list of JavaScript files that will be loaded programmatically in /html/common/themes/top_js.js.js.js.slider.files and javascript.fast.datepicker.5 # \ jquery/ui.js.\ jquery/hover_intent. The ordering of the JavaScript files is important.files=\ \ # # JQuery scripts # \ jquery/jquery. javascript. all JQuery scripts should go first.\ jquery/ui.\ jquery/ui.barebone.\ \ # # jQuery UI 1.\ jquery/ui.\ jquery/ui. Specify the list of barebone files. The list of files are also merged and packed for further performance improvements. See the property javascript. The third grouping denotes modules that rely on the first and second group.

js.js.js.\ liferay/portlet_sharing.js.js.\ liferay/liferay.js.\ liferay/menu.6 # \ jquery/ui.files=\ \ # # JQuery scripts 162 Advanced Liferay Configuration .\ liferay/portlet.\ \ # # Liferay modules # \ liferay/color_picker.js.js.js.js.\ misc/swfobject.color_picker.\ liferay/dock.\ \ # # Miscellaneous scripts # \ misc/class.js Specify the list of everything files (everything else not already in the list of barebone files).\ liferay/popup.Advanced Liferay Configuration \ # # jQuery UI 1. javascript.everything.\ liferay/portlet_url.js.\ \ # # Liferay utility scripts # \ liferay/events.js.\ liferay/util.\ \ # # Liferay base utility scripts # \ liferay/language.js.js.\ liferay/portal.

js.js.\ #jquery/effects.tabs.js.\ \ # # jQuery UI 1.transfer.js.Advanced Liferay Configuration # \ jquery/form.js.\ jquery/position.js.js.\ jquery/media.core.js.5 Effects library # \ #jquery/effects.5 # \ jquery/ui.js.shake.selectable.js.\ \ # # jQuery UI 1.js.js.slide.sortable.js.highlight.js.\ #jquery/effects.js.js.js.\ #jquery/effects.js.fold.js.js.\ jquery/ui.js.\ jquery/ui.js.\ \ # # jQuery UI 1.\ jquery/treeview.js.\ #jquery/effects.\ #jquery/effects.\ \ Advanced Liferay Configuration 163 .\ #jquery/effects.js.accordion.js.autocomplete.\ #jquery/effects.js.js.\ #jquery/effects.explode.\ jquery/ui.\ #jquery/effects.\ #jquery/effects.blind.6 # \ jquery/ui.tree.droppable.\ jquery/jeditable.js.pulsate.\ #jquery/effects.\ jquery/json.\ #jquery/ui.\ #jquery/effects.\ jquery/ui.resizable.\ jquery/livesearch.scale.bounce.\ jquery/ui.js.\ jquery/scrollTo.js.\ jquery/selection.clip.drop.

\ liferay/tags_entries_selector.js.\ \ # # Liferay modules # \ liferay/auto_fields.js.files.\ liferay/dynamic_select.ServicePreAction in such a way that unauthenticated users get the list of barebone JavaScript files whereas authenticated users get both the list of barebone JavaScript files and the list of everything JavaScript files. javascript.js.\ liferay/notice.\ liferay/layout_exporter.liferay.barebone.barebone. Set this to true to sometimes load javascript.events.js. Set this property to false for easier debugging for development.js.files and sometimes load javascript. javascript.files or javascript.js. 164 Advanced Liferay Configuration .\ liferay/upload. You can also disable fast loading by setting the URL parameter js_fast_load to 0.\ liferay/session.js.\ liferay/undo_manager.barebone.\ liferay/observable.\ liferay/panel_floating.everything.files.\ liferay/search_container.js.enabled=false SQL DATA Set the default SQL IDs for common objects.js.js.log.js.js.js. The default logic is coded in com.load=true Set the following to true to enable the display of JavaScript logging.fast.files.enabled=true Set this property to true to load the packed version of files listed in the properties javascript.everything.\ liferay/layout_configuration.portal.\ liferay/panel.js.Advanced Liferay Configuration # # Liferay base utility scripts # \ liferay/layout.js.js Set this property to false to always load JavaScript files listed in the property javascript.\ liferay/navigation.everything. javascript.\ liferay/tags_categories_selector.

account.portal.id=liferay.auth.ListType.com.security.data.email.id=5 sql.address=10004 sql.model.ListType.data.security.security.portal.data. the portal's create account will be used.password=true Set the following to true to allow strangers to create accounts and register themselves on the portal.security. set the property company.auth.portal.contact.portal. Omni admin users must belong to the company with this web id.liferay.type=emailAddress company. #company.region.data.url=/create_account Advanced Liferay Configuration 165 .liferay.auth.security. company.data.auto.com.status=12017 COMPANY This sets the default web id.https=false Set the following to true to allow users to select the remember me feature to automatically login to the portal.com.model.model.address=11003 sql. company.security.requires.country.liferay.security.security.max. A value of -1 signifies a lifespan of a browser session.Country.com.default.home.account. company.liferay. company.data.strangers.email.age=31536000 Set the following to true to allow users to ask the portal to send them their password.portal.id=19 sql.com.send.login to false to disable the remember me feature.address=10000 sql.auto. This allows providing custom portlets to create accounts.com This sets the default home URL of the portal. company.type=screenName company. company.auto.security.organization.ListType.auth.type=userId Set this to true to ensure users login with https.portal.login=true Set the following to the maximum age (in number of seconds) of the browser cookie that enables the remember me feature.model.web. screen name.liferay.Region.Advanced Liferay Configuration sql. A value of 31536000 signifies a lifespan of one year. or user id.url=/web/guest The portal can authenticate users based on their email address.security.default. Rather than setting this to 0.login.ListType.model. By default. company.strangers=true Enter a friendly URL of a page that will be used to create new accounts whenever the user clicks the "create account" link in the login portlet.com.liferay.model. company.

company.portal.name.size 166 Advanced Liferay Configuration .reserved-credentials. This property is not used unless company.liferay.form.authentication. users.portal.name.ScreenNameGenerator.auth.security.form.security.verify=false Set the following to true to allow community administrators to use their own logo instead of the enterprise logo.liferay.screen.delete=true Set the following to true to always autogenerate user screen names even if the user gives a specific user screen name.strangers.always.Advanced Liferay Configuration Set the following to true if strangers can create accounts with email addresses that match the company mail suffix.liferay.form.settings.security.screen.name.generator=com.autogenerate=false Input a class name that extends com. users.max. the maximum file size allowed is set in property com. However.portal.auth.security.additionalemail-addresses. This class will be called to validate user ids.ScreenNameGenerator Input a class name that extends com.phone-numbers.liferay. Examples: users. Note that not requiring an email address disables some features that depend on an email address.screen.required=true Set the maximum file size for user portraits.address. company. This class will be called to generate user screen names.security.identification=addresses.liferay.portal.LiberalScreenNameValidator Set this to false if you want to be able to create users without an email address.validator=com.strangers. users.settings.security.screen.strangers is also set to true.websites company.community. A value of 0 for the maximum file size can be used to indicate unlimited file size.default-user-associations.security.with.mail-host-names.mx=true Set the following to true if strangers who create accounts need to be verified via email.ScreenNameValidator.auth. users.settings.UploadServletRequestImpl.validator=com.email.name.upload.portal.portal.auth.ScreenNameValidator users. company.security.email-notifications company.logo=true Input a list of sections that will be included as part of the company settings form. company.configuration=general.auth.security.liferay.miscellaneous=display-settings USERS Set the following to false if users cannot be deleted.

main=details. users.organizations users.form.form.size=307200 Set this to true to record last login information for a user. and User. users.login=true Input a list of sections that will be included as part of the user form when adding a user.groups= Input a list of comma delimited system role names that will exist in addition to the standard system roles. These roles cannot be removed or renamed.add. users.question.instant-messenger. users. Advanced Liferay Configuration 167 .update. users.form. users.open-id users.additional-emailaddresses.update. Any missing system group will be created by the portal. Any missing system role will be created by the portal.form. The standard system roles are: Administrator.sms.roles.enabled=true users.form.description=Administrators are super users who can do anything.roles= Set the description of the Administrator system role.reminder.display-settings.organizations.enabled=true Input a list of questions used for reminder queries.categorization users. the portal checks to ensure all system groups exist.miscellaneous= Input a list of sections that will be included as part of the user form when updating a user.what-is-your-father's-middle-name GROUPS AND ROLES Input a list of comma delimited system group names that will exist in addition to the standard system groups.max.websites.queries.update.comments.properties.image.identification= users.identification=addresses.questions=what-is-your-primary-frequent-flyernumber.miscellaneous=announcements.what-is-your-library-card-number.add.form.custom.phone-numbers.communities. Guest.last. system.Administrator.what-was-your-first-phonenumber. When the server starts.reminder.main=details.Advanced Liferay Configuration found in system. the portal checks to ensure all system roles exist.role.password.update. system.queries.custom-attributes Set this to true to enable reminder queries that are used to help reset a user's password. When the server starts. Set the description of the Guest system role.queries.add.what-was-your-first-teacher's-name.usergroups. system. Power User.reminder.social-network.

description=Power Users have their own public and private pages. system.Owner.roles= Set the description of the Organization Administrator system organization role. Set the description of the Owner system role.role. system.Organization. the portal checks to ensure all system community roles exist. These roles cannot be removed or renamed.User. When the server starts.roles= Set the description of the Community Administrator system community role.Advanced Liferay Configuration system.role. the portal checks to ensure all system organization roles exist.organization.community. System.description=Community Owners are super users of their community and can assign community roles to users.community. system. Organization Member.Owner.Community. system. system. The standard system organization roles are: Organization Administrator. Input a list of comma delimited system organization role names that will exist in addition to the standard system organization roles. and Organization Owner.Member.description=Unauthenticated users always have this role. When the server starts.role.role.Administrator.role. The standard system community roles are: Community Administrator.User. Set the description of the User system role. Any missing system organization role will be created by the portal.role.description=Community Administrators are super users of their community but cannot make other users into Community Administrators.Guest.Power. These roles cannot be removed or renamed.Community. Any missing system community role will be created by the portal. Input a list of comma delimited system community role names that will exist in addition to the standard system community roles.description=Organization Administrators are super users of their organization but cannot make other users into Organization Administrators.organization.description=This is an implied role with respect to the objects users create. system. system.Community.description=All users who belong to a community have this role within that community. Community Member. and Community Owner.description=Authenticated users should be assigned this role.community. Set the description of the Community Owner system community role.role.Administrator. Set the description of the Power User system role.community. Set the description of the Organization Member system organization role. 168 Advanced Liferay Configuration . system.role. Set the description of the Community Member system community role.

group. Clubs. Input the ids of users who are omniadmin users. Set the description of the Organization Owner system organization role. roles.Organization.article.children.required=true Specify the group id and the article id of the Web Content article that will be displayed as the terms of use.description=All users who belong to a organization have this role within that organization.description=Organization Owners are super users of their organization and can assign organization roles to users.location Specify which organizations can be at the top of the hierarchy. you could use Teams. organizations.Owner. Omni admin users must belong to the default company.of.types=regular-organization.organization.role. omniadmin. system. terms.users= Set the following to true if all users are required to agree to the terms of use. For example.role.organization.use.id= Specify subtypes of roles if you want to be able to search for roles using your custom criteria.journal.id= terms. Parishes. and not all of the administrators should have access to this core functionality.of.organization.use. organizations. shutdown.rootable[regular-organization]=true Specify which organizations can be children. etc.regular. Omni admin users can administer the portal's core functionality: gc.Member.subtypes= roles.community. Multiple portal instances might be deployed on one application server. The default text will be used if no Web Content article is specified.types[regular-organization]=regular-organization. Advanced Liferay Configuration 169 .enabled[regular-organization]=false Set this to true if organizations must have an associated country. Leave this field blank if users who belong to the right company and have the Administrator role are allowed to administer the portal's core functionality.article. organizations.Organization.of.subtypes= roles.journal.location Set this to true if organizations can have an associated country.subtypes= ORGANIZATIONS Specify the names of your organization(s).country. or anything which describes your hierarchical structure. terms.Advanced Liferay Configuration system. organizations.use.

assignment.properties.form.identification= organizations. Locations cannot be at the top of the hierarchy. because they cannot have children.reminder-queries. for example if a user belongs to Liferay Spain he will implicitly be a member of the ancestors Liferay Europe and Liferay Global and will be able to access their private pages.country. All locales must use UTF-8 encoding.strict=true Set this property to true if you want users to only be members of the organizations to which they are assigned explicitly.main=details organizations. Use a comma to separate each entry.additionalemail-addresses.properties.services organizations.main=details organizations.add.Advanced Liferay Configuration organizations. These values can also be overridden in properties files with file names matching that of content/Language-ext_*.miscellaneous=comments.form. organizations.form.miscellaneous= Input a list of sections that will be included as part of the organization form when updating an organization. he will only be able to assign the users of the organizations and suborganizations that he can manage.country. Messages corresponding to a specific language are specified in properties files with file names matching that of content/Language_*.form. You must specify the following properties for each organization type you create.country.form.add. organizations.strict=false LANGUAGES AND TIME ZONES Specify the available locales. Example: organizations.auto=false Set this property to false if you want any administrator of an organization to be able to assign any user to that organization.custom-attributes Set this property to true if you want any administrator that creates an organization to be automatically assigned to that organization. organizations.assignment.rootable[location]=false #organizations.identification=addresses.websites.update.types[location]= organizations.children.required[regular-organization]=false By default.form. organizations. By default. 170 Advanced Liferay Configuration .enabled[location]=true organizations.add. By default they will also become implicit members of the ancestors of those organizations.membership.update.required[location]=true Input a list of sections that will be included as part of the organization form when adding an organization.phone-numbers. organizations.update.

\ America/Noronha.\ Australia/Sydney. Set the following to false if unauthenticated users get their preferred language from their company.\ Pacific/Guadalcanal.\ Asia/Katmandu.\ America/Puerto_Rico.\ America/New_York.\ Asia/Dhaka.\ America/St_Johns.ko_KR.ics.request=false Specify the available time zones.\ Asia/Rangoon.\ Asia/Dubai.txt http://userpage.chemie.html locales=ar_SA.uci.zones=\ Pacific/Midway.\ Advanced Liferay Configuration 171 .\ Asia/Baghdad.ca_ES.cs_CZ.\ Asia/Seoul.it_IT.\ America/Denver.de_DE.el _GR.vi_VN Set the following to true if unauthenticated users get their preferred language from the Accept-Language header.fi_FI.zh_TW.\ UTC.pl_PL. The specified ids must match those from the class java.\ Asia/Tokyo.\ Australia/Darwin.Advanced Liferay Configuration See the following links to specify language and country codes: http://ftp.es_ES.\ America/Los_Angeles.default.pt_BR.\ Pacific/Honolulu.TimeZone.en_US. locale.\ Asia/Kabul.\ Asia/Shanghai.\ Asia/Calcutta.edu/pub/ietf/http/related/iso639.hu_HU.ru_RU.sv_SE.nb_NO.\ America/Anchorage.util.\ Europe/Istanbul.\ America/Chicago.fa_IR.\ Atlantic/Azores.fu-berlin.ja_JP.nl_NL. time.\ Europe/Lisbon.\ Asia/Jerusalem.pt_PT.\ Europe/Paris.\ America/Sao_Paulo.de/diverse/doc/ISO_3166.\ Asia/Karachi.ca_AD.\ Asia/Tehran. tr_TR.zh_CN.\ Asia/Saigon.fr_FR.

id=mobile Set the default color scheme id for wap themes.shared.theme. default.scheme. then all attribute names that start with hello_ or world_ will be shared.and.wap. This property allows you to configure which request attributes will be shared.wap.xml may still want to share some request attributes. if you set the value to hello_. This value is always overridden by the value set in web.group=false REQUEST Portlets that have been configured to use private request attributes in liferayportlet. session.id=classic Set the default color scheme id for regular themes.xml.attributes=LIFERAY_SHARED_ SESSION Specify the number of minutes before a session expires.id=01 Set the default theme id for wap themes.id=01 Set the following to true if you want a change in the theme selection of the public or private group to automatically be applied to the other (i.sync.theme.Advanced Liferay Configuration Pacific/Auckland. if public and private group themes should always be the same).\ Pacific/Kiritimati LOOK AND FEEL Set the following to false if the system does not allow users to modify the look and feel.\ Pacific/Enderbury.id=2_columns_ii Set the default theme id for regular themes. Set a comma delimited list of attribute names that will be shared when the attribute name starts with one of the specified attribute names. look. default.regular.color. For example.feel. default. theme.regular.world_.template.e.layout. default.color.scheme. request. default.on.modifiable=true Set the default layout template id.timeout=30 172 Advanced Liferay Configuration .

Specify 0 to disable any warnings. such as 5 minutes for better performance. session. The drawback to this approach is that you must not rely on the API for sessions provided by the servlet Advanced Liferay Configuration 173 .timeout. Instead it will be automatically extended.persistent. session.on.enable. Doing this will use cookies to remember the user across requests.cookie. if you set the value to hello_.action. It is recommended to use this setting along with a smaller session. Features like automatically logging in will not work. then all attribute names that start with hello_ or world_ will be shared. Set this property to set the domain of those cookies. session.COMPANY_.cookies=true The login process sets several cookies if persistent cookies are enabled.expire=false Portlets that have been configured to use private session attributes in liferayportlet.Advanced Liferay Configuration Specify the number of minutes before a warning is sent to the user informing the user of the session expiration.support=true Set the following to true to disable sessions. Set a comma delimited list of attribute names that will be shared when the attribute name starts with one of the specified attribute names.timeout. This is not used to specify session sharing between portlet WARs or from the portlet to the portal.timeout. For example.cookie.LIF ERAY_SHARED_ Set this to false to disable all persistent cookies.apache.attributes=org. session.world_. This property allows you to configure which session attributes will be shared.domain= Set the following to true to invalidate the session when a user logs into the portal. session.USER_.protection=true Set the following to true to test whether users have cookie support before allowing them to sign in.redirect. session. Set this to false if you need the guest user and the authenticated user to have the same session. session. This is useful if you want to scale very large sites where the user may be sent to a different server for each request.enable. session.auto.extend=false Set this to true if the user is redirected to the default page when the session expires. The purpose of this mode is to keep the session open as long as the user browser is open and with a portal page loaded.url is set to true because that property disables session cookies.phishing. This test will always fail if tck.warning=1 Set the auto-extend mode to true to avoid having to ask the user whether to extend the session or not.timeout.test.xml may still want to share some session attributes.LOCALE. This helps prevents phishing.shared.struts. Note that this property is used to specify the sharing of session attributes from the portal to the portlet.

session. Set a JAAS implementation class to override this behavior. session.events.jaas.enable=false By default.SessionDestroyAction Set the following to true to track user clicks in memory for the duration of a user's session.session.tracker.create.enabled=true Set the following to true to track user clicks in the database after a user's session is invalidated.tracker.support. session.portal.SessionAction.portal.tracker.events=com.\ \ /document_library/get_file JAAS Set the following to false to disable JAAS security checks.Advanced Liferay Configuration and portlet specs.jaas.paths.SessionLessManagerBase. Setting this to true allows you to generate usage reports from the database. portal.liferay. This feature is only available for Tomcat and requires that you set Tomcat's Manager class to com. portal.enabled=false Enter a list of comma delimited paths that should not be tracked.friendly.liferay.PortalLoginModule loads the correct JAAS login module based on what application server or servlet container the portal is deployed on.portal. JAAS must be disabled if administrators are to be able to impersonate other users.disabled=false Input a list of comma delimited class names that extend com. Setting this to true allows you to view all live sessions in the Admin portlet.events.paths=\ /portal/render_portlet.liferay.liferay. session.security.tomcat. Use this cautiously because this will store a lot of usage data.portal.events=com.enabled=false Set the following to true to convert the tracked paths to friendly URLs. # # Servlet session create event # servlet. com.persistence.ignore. Disabling JAAS speeds up login. session.liferay. session.session. These classes will run at the specified event.struts.memory.tracker.impl= 174 Advanced Liferay Configuration .SessionCreateAction # # Servlet session destroy event # servlet.destroy.jaas.

dc=com ldap.encryption.properties.factory.pipeline. Novell eDirectory.auth. Encryption is implemented by com.auth.method is set to password-compare. Microsoft Active Directory Server.algorithm.referral=follow Settings for com.portal.dn=dc=example.Advanced Liferay Configuration The JAAS process may pass in an encrypted password and the authentication will only succeed if there is an exact match.strict.security.pre to be executed.2.ldap. ldap. and OpenLDAP.encryption.initial=com.algorithm= ldap.auth.security.auth.jaas.principal=uid=admin.ou=system ldap.803:=2))) Advanced Liferay Configuration 175 .required=false Set either bind or password-compare for the LDAP authentication method. The default settings are for Apache Directory Server.auth.password.enabled=false ldap. Bind is preferred by most vendors so that you don't have to worry about encryption strategies.LdapCtxFactory ldap.auth.provider.url=ldap://localhost:10389 ldap.auth. Set this property to false to relax that behavior so the user can input an unencrypted password.impersonation.LDAPAuth can be configured from the Admin portlet.types=MD5.security.Encryptor.provider.method=bind ldap. portal.method=password-compare Set the password encryption to used to compare passwords if the property ldap.113556. If you want to prevent disabled accounts from logging into the portal you need to use a search filter similiar to the following: (&(objectclass=person)(userprincipalname=@email_address@)(!(UserAccountControl:1. ldap.credentials=secret ldap. portal.util.base. ldap.enable=true LDAP Set the values used to connect to a LDAP store. It provides out of the box support for Apache Directory Server.4.840. ldap.class in system.SHA Active Directory stores information about the user account as a series of bit fields in the UserAccountControl attribute.password. The LDAPAuth class must be specified in the property auth.password=false Set the following to true to enable administrators to impersonate other users.jndi.liferay.sun.auth.1.base.liferay.

filter=(mail=@email_address@) You can write your own class that extends com. last name.liferay.import. ldap.security.mappings=screenName=cn\npassword=userPassword\nemailAddress=mail\n firstName=givenName\nlastName=sn\njobTitle=title\ngroup=groupMembership When importing groups.method=group Settings for exporting users from the portal to LDAP.mappings=groupName=cn\ndescription=description\nuser=uniqueMember Settings for importing users and groups from LDAP to the portal.Advanced Liferay Configuration See the following links: http://support.inetOrgPerson.com/kb/305144/ http://support. ldap.liferay.classes=top. This value should be set based on how your LDAP server stores group membership information. ldap. ldap.impl=com. This will only be active if the property ldap.user. If set to user.filter=(objectClass=inetOrgPerson) ldap.AttributesTransformer to transform the LDAP attributes before a user or group is imported to the LDAP store.user.import. New users and groups will be created at the specified DN.user.com/?kbid=269181 ldap.object.ldap.import. ldap.liferay. the user will be created with the following default object classes.on.method=user ldap.portal.search. ldap.auth.group. portal will import all users and the groups associated with those users.import.LDAPUser to customize the behavior for exporting portal users to the LDAP store. in the portal and have that change get pushed to the LDAP server. the portal import all groups and the users associated those groups.import.startup=false ldap.search.group.LDAPUser When a user is exported to LDAP and the user does not exist. ldap.organizationalPerson When importing and exporting users.interval=10 ldap.portal.security.import.security.ldap.default.enabled is also set to true.portal. the portal will use this mapping to connect LDAP group attributes and portal user group variables. etc. 176 Advanced Liferay Configuration .search. If set to group.impl=com.microsoft.microsoft. This allows a user to modify his first name. the portal will use this mapping to connect LDAP user attributes and portal user variables.auth.person.attrs.portal.ldap.user.transformer.liferay.security.import.filter=(objectClass=groupOfUniqueNames) Set either user or group for import method.AttributesTransformer You can write your own class that extends com.ldap.enabled=false ldap.

CASFilter must be referenced in web.error.age=age ldap.url=https://localhost:8443/cas-web/login cas.server. ldap.login.url= #cas.filters. cas.url=http://localhost:8080/c/portal/login cas.url. ldap.error.server.history=history ldap.validate.ldap=false Set the default values for the required CAS URLs.export.not. Set either cas.dn=ou=groups.servlet.service.password.Advanced Liferay Configuration ldap.auth.logout.CASAutoLogin and the filter com.dc=example.liferay.password.expired=expired ldap.syntax=syntax ldap.error. NTLM will work only if LDAP authentication is also enabled and the authentication is made by screen name.login. Set this to true to automatically import users from LDAP if they do not exist in the portal.dc=example.trivial=trivial ldap.cas.user.import.name or cas.xml.service. See LEP-4423. cas.error.portal.lockout=retry limit CAS Set this to true to enable CAS single sign on.password.auth.dc=com Set this to true to use the LDAP's password policy instead of the portal password policy.url=https://localhost:8443/cas-web/logout cas.service.groups.policy. The default values will work for Fedora DS.enabled=false Set these values to be a portion of the error message returned by the appropriate directory server to allow the portal to recognize messages from the LDAP server.portal.security. cas.dn=ou=users.from.changeable=not allowed to change ldap.hooks must contain a reference to the class com.users.password.error.service.password.liferay.error.password. If set to true.error.url=http://localhost:8080/c/portal/login cas. Setting cas.url=https://localhost:8443/cas-web/proxyValidate Advanced Liferay Configuration 177 .sso.enabled=true ldap.name=localhost:8080 cas.server.enabled=false A user may be authenticated from CAS and not yet exist in the portal. then the property auto.password.dc=com ldap.name allows deep linking.

auth.name.sso.com:8080/opensso Set the HTTP attribute name for the user's screen name. The first URL is the link to your OpenSSO server (which can be the same server as the one running Liferay).hooks" must contain a reference to the class com.first.OpenIdAutoLogin.example. the second URL is the link to your Liferay Portal.email. ntlm.liferay.hooks must contain a reference to the class com.login. open.auth.url=http://openssohost.example.auth.0.portal.sso.enabled=true OPENSSO These properties control Liferay's integration with OpenSSO.login.name. open.sso.example. open.auth.auth. then the property auto.attr=mail Set the HTTP attribute name for the user's Common Name. open.screen.logout.sso.url=http://openssohost.xml.enabled=false ntlm.NtlmAutoLogin and the filter com.com:8080/opensso/UI/Login? goto=http://portalhost. then the property "auto.auth. Set this to true to enable OpenSSO authentication.enabled=false Set the log in URL and log out URL.last.attr=cn Set the HTTP attribute name for the user's Surname. NTLM will work only if LDAP authentication is also enabled and the authentication is made by screen name.example. open.domain.security.com:8080/web/guest/home Set the URL to the OpenSSO service.liferay.auth.com:8080/c/portal/login open.filters.address.security. If set to true.0.portal.domain=EXAMPLE OPENID Set this to true to enable OpenId authentication.attr=uid Set the HTTP attribute name for the user's email address.Advanced Liferay Configuration NTLM Set this to true to enable NTLM single sign on.1 ntlm.portal.liferay.id.example.service.url=http://openssohost.sso.sso.login.controller=127.servlet. If set to true. open.name.sso. open.attr=sn 178 Advanced Liferay Configuration .NtlmFilter must be referenced in web.sso.sso. open.ntlm.com:8080/opensso/UI/Logout? goto=http://portalhost.

portal.SiteMinderAutoLogin and the logout. siteminder.liferay. public static final int FAILURE = -1.liferay.ldap=false Set this to the name of the user header that SiteMinder passes to the portal. siteminder. return DNE.from.user.portal.events.auth.hooks" must contain a reference to the class com.security. the login fails.pipeline. If one of the authenticators returns FAILURE or DNE. This can easily be achieved by implementing a class via LDAPAuth that updates the information stored in the portal user database whenever a user signs in.post must have a reference to com. siteminder.post= Set this to true to enable password checking by the internal portal authenticaAdvanced Liferay Configuration 179 .enabled=false A user may be authenticated from SiteMinder and not yet exist in the portal. Set this to true to automatically import users from LDAP if they do not exist in the portal. public static final int DNE = 0. Under certain circumstances.LDAPAuth auth.LDAPAuth See the LDAP properties to configure the behavior of the LDAPAuth class.SiteMinderLogoutAction for logout to work. return FAILURE.auth. See the Admin portlet for more information.auth. you might want to keep the information in the portal database in sync with an external database or an LDAP server. Available authenticators are: com.security.security. and if the user does not exist on the system. auth.security.liferay.Advanced Liferay Configuration SITEMINDER Set this to true to enable CA SiteMinder single sign on. Constants in Authenticator: public static final int SUCCESS = 1.liferay.login. if the user exists but the passwords do not match. In case you have several classes in the authentication pipeline.Authenticator.events. If set to true.portal. then the property "auto.auth.import.header=SM_USER AUTHENTICATION PIPELINE Input a list of comma delimited class names that implement com.pre=com.liferay.pipeline. return SUCCESS.auth. These classes will run before or after the portal authentication begins. Each portal instance can be configured at run time to either authenticate based on user ids or email addresses. If# authentication is successful. The Authenticator class defines the constant values that should be used as return codes from the classes implementing the interface. all of them have to return SUCCESS if you want the user to be able to login.portal.portal.

paths=\ /blogs/find_entry. then users will be redirected to the given redirect path upon successful login.max. If the user does not have permission to view that page.last.pipeline. auth. users will be forwarded to their default layout page. then the rule set by the property auth.portlet.url=/login Enter the name of the login portlet used in a page identified by the URL of the previous property (if one has been set).forward.login. You should leave the default value unless you have your own custom login portlet.redirect=true Enter a list of comma delimited paths that can be considered part of the last visited path.auth.liferay. by appending the redirect parameter in a url that looks like this: /c/portal/login?redirect=%2Fgroup%2Femployees%2Fcalendar.portal.path will apply.LoginFailure auth.Advanced Liferay Configuration tion.limit=5 Set the following to true if users are forwarded to the last visited path upon successful login. auth. auth. This will allow the portlet to have access to the redirect parameter and thus forward the user to the page where he was trying to access when necessary. auth.pre and auth.forward.failures=com.check=true Input a list of comma delimited class names that implement com.auth.by.name=58 Enter a list of comma delimited paths that do not require authentication. You can set the redirect manually from another application.url is used. the portal's login page is used.community.url=/web/guest/home Enter a friendly URL of a page that will be used to login portal users whenever the user is navigating a community and authentication is needed.portal.failures.path=true The login page reads a redirect by a parameter named redirect.liferay.last.auth.AuthFailure.max. If set to false. auth.login.security.last. By default.login.by.portal.security.forward. These classes will run when a user has a failed login or when a user has reached the maximum number of failed logins. auth.login. If set to false. the portal's login page or the URL set in the property auth. auth.pipeline.security.liferay.public. If this property is set to true.forward.by.pipeline.post settings.liferay.enable.paths=/document_library/get_file Enter a URL that will be used to login portal users whenever needed.\ 180 Advanced Liferay Configuration . #auth. auth.failure=com. This url will redirect the user to the path /group/employees/calendar upon successful login. By default. you're essentially delegating password checking is delegated to the authenticators configured in auth.LoginMaxFailures auth.

\ \ /message_boards/find_category.\ \ /document_library/get_file.xml.\ /journal/get_articles.Advanced Liferay Configuration /blogs/rss.\ \ /tags/rss.\ /message_boards/find_thread.\ /message_boards/find_message.\ \ /polls/view_chart.\ \ /search/open_search.\ /journal/get_latest_article_content.\ /blogs/trackback.\ \ /layout_management/sitemap.\ /portal/expire_session.\ /portal/extend_session_confirm.\ /portal/open_id_request.\ /portal/status.\ /message_boards/rss.\ /portal/session_click.\ /journal/get_structure.\ /wiki/rss Advanced Liferay Configuration 181 .\ \ /wiki/get_page_attachment.\ /journal_articles/view_article_content.\ /portal/json_service.\ /message_boards/get_message_attachment.\ \ /my_places/view.\ \ /bookmarks/open_entry.\ /portal/logout.\ /journal/get_template.\ /journal/view_article_content.\ /portal/open_id_response.\ \ /portal/emoticons.\ /portal/extend_session.\ /search/open_search_description.\ \ /shopping/notify.\ /portal/session_tree_js_click.\ \ /journal/get_article.

Make sure the MAC gets URL encoded because it might contain characters not allowed in a URL.auth.portal.algorithm=MD5 182 Advanced Liferay Configuration .auth.liferay.liferay.auth.AutoLogin.org/wiki/Message_authentication_code Set the following to true to enable SSO with MAC.liferay.mac. If no valid combination is returned.allow=false Set the algorithm to use for MAC encryption.liferay.liferay. com.security.properties: com.security.CASAutoLogin.security.RememberMeAutoLogin reads from a cookie to automatically log in a user who previously logged in while checking the Remember Me box.RememberMeAutoLogin.com.portal.portal.OpenIdAutoLogin. SSO with MAC also requires that you set the following property in system.liferay.com. If a valid combination is returned.hooks=com. then the portal will automatically login that user with the returned user id and password combination. For example.com.servlet.liferay.liferay.wikipedia.login.security.auth.login.SiteMinderAutoLogin Set the hosts that will be ignored for auto login.portal.auth.ignore.com.auth. auto.OpenSSOAutoLogin.com/browse/LEP-1288 http://en.Advanced Liferay Configuration AUTO LOGIN Input a list of comma delimited class names that implement com. auth.auth.auth.liferay.portal. then the request continues to process normally. See com.ignore.portal. auto.util.liferay.auth.hosts= Set the paths that will be ignored for auto login.CASAutoLogin for an example of how to configure the portal with Yale's SSO server. auth.mac.SessionParameters=false See the following links: http://issues.liferay. auto.portal. These classes will run in consecutive order for all unauthenticated users until one of them return a valid user id and password combination.portal. This interface allows deployers to easily configure the portal to work with other SSO servers.com.portal.security.login.security.NtlmAutoLogin.paths= SSO WITH MAC (MESSAGE AUTHENTICATION CODE) To use SSO with MAC. post to an URL like: http://localhost:8080/c/portal/login?cmd=already-registered&login=<userId|emailAddress>&password=<MAC> Pass the MAC in the password field.security.security.security.

pwd. The first pattern ensures that passwords must have at least 4 valid characters consisting of digits or letters.passwordpolicytoolkit.algorithm=MD5 passwords.encryption.security.shared. you will also have to use the static generator so that you can guarantee that passwords obey its rules.algorithm=CRYPT passwords.PwdGenerator to generate the password.pwd.liferay.key= PASSWORDS Set the following encryption algorithm to encrypt passwords.algorithm=NONE passwords.passwordpolicytoolkit.passwordpolicytoolkit.toolkit=com.RegExpToolkit If you choose to use com.RegExpToolkit as your password toolkit.encryption. Examples: passwords.security.liferay.algorithm=SSHA Digested passwords are encoded via base64 or hex encoding. Advanced Liferay Configuration 183 .security.pwd. The default algorithm is SHA (SHA-1).portal. If set to NONE.security.Advanced Liferay Configuration Set the shared key used to generate the MAC.util.encryption.algorithm=SHA-384 passwords.encryption.algorithm=SHA-256 passwords.encryption.portal. The default is base64.encryption.liferay.encoding=base64 #passwords.BasicToolkit.encryption.portal.pwd.mac. Static is set through the property passwords. auth.pwd.encoding=hex Input a class name that extends com.encryption.digest. Note that \ is replaced with \\ to work in Java. The SHA-512 algorithm is currently unsupported. If you are using LDAP password syntax checking. set the regular expression pattern that will be used to generate and validate passwords.PasswordPolicyToolkit passwords.generator=dynamic passwords.security. Examples: passwords.liferay.algorithm=SHA passwords.passwordpolicytoolkit.liferay. Examples: passwords.static and dynamic uses the class com.liferay.portal.generator=static passwords. you can choose either static or dynamic password generation.digest.static=iheartliferay If you choose to use com.toolkit=com. passwords. passwords are stored in the database as plain text.algorithm=MD2 passwords. This class will be called to generate and validate passwords.PasswordPolicyToolkit as your password toolkit.portal.

permission. countByUserGroupRole. by calling countByGroupsRoles. and countByUsersPermissions in one method.check.policy.regexptoolkit.security.PermissionCheckerImpl.liferay. The first algorithm uses several if statements to query the database for these five things in order. permissions.portal. If it finds any one of them.user.regexptoolkit.length=4 passwords.checker=com.Advanced Liferay Configuration The second pattern ensures that passwords must have at least 8 valid characters consisting of digits or letters.charset=0123456789 passwords.user. Examples: passwords.portal.permission.charset=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz Examples: passwords. The default is method two.{8})(?:[a-zA-Z0-9]*) Set the length and key for generating passwords.check. passwords.pattern=(?=.liferay.liferay. countByUsersRoles.regexptoolkit.default.portal.PermissionLocalServiceImpl. See com.portal.name=Default Password Policy PERMISSIONS Set the default permission checker class used by com.PermissionCheckerFactory to check permissions for actions on objects. This is useful so that you can optimize the search for different databases.PermissionCheckerImpl Set the algorithm used to check permissions for a user.{4})(?:[a-zA-Z0-9]*) passwords.impl.regexptoolkit. countByGroupsPermissions. it returns true: ● ● ● ● ● Is the user connected to one of the permissions via group or organization roles? Is the user associated with groups or organizations that are directly connected to one of the permissions? Is the user connected to one of the permissions via user roles? Is the user connected to one of the permissions via user group roles? Is the user directly connected to one of the permissions? permissions.security. permissions.security.service.length=8 Set the name of the default password policy.regexptoolkit.regexptoolkit.liferay.permission. Examples: passwords.algorithm=2 The third algorithm checks the permissions by checking for three things. This class can be overridden with a custom class that extends com.pattern=(?=. It com184 Advanced Liferay Configuration .algorithm=1 The second algorithm (the default) does a database join and checks the permissions in one step.

portlet.security. global.message_boards.check.struts.events. This is used if you want to filter the list of permissions before it is actually persisted.check.PermissionsListFilterImpl CAPTCHA Set the maximum number of captcha checks per portlet session. If it finds any of the following items.events=com.message_boards.liferay.algorithm=3 The fourth algorithm does a database join and checks the permissions that algorithm three checks in one step.SimpleAction.algorithm=4 Set the default permissions list filter class.kernel.send_password=true captcha.user. permissions. application.portal.create_account=true captcha.portal.filter=com.portlet.check. captcha.edit_message=false STARTUP EVENTS Input a list of comma delimited class names that extend com.liferay.portal.Advanced Liferay Configuration bines the role check into one step. Set this value to 0 to always check. it returns true: ● ● ● Is the user associated with groups or organizations that are directly connected to one of the permissions? Is the user associated with a role that is directly connected to one of the permissions? Is the user directly connected to one of the permissions? permissions. This class must implement com. Unauthenticated users will always be checked on every request if captcha checks is enabled.portal.max.events=com.AppStartupAction Advanced Liferay Configuration 185 .check.PermissionsListFilter. by calling countByGroupsPermissions. then you can filter that list and remove any permissions that have the UPDATE action before it is persisted. These classes will run at the specified event.liferay.portal. Set this value to a number less than 0 to never check. countByRolesPermissions.liferay. if you want to make sure that all users who create objects never have the UPDATE action. and countByUsersPermissions in one method. captcha.list. permissions.challenges=1 Set whether or not to use captcha checks for the following actions. For example.events.GlobalStartupAction The following is an application startup event that runs once for every web site instance of the portal that initializes.security.user.edit_category=false captcha.portal. The following is a global startup event that runs once when the portal initializes.permission.check.startup.portal.permission.check.liferay.startup.

AppShutdownAction Programmatically kill the Java process on shutdown. The pre-service events process before Struts processes the request.ServicePostAction 186 Advanced Liferay Configuration .liferay.events=com.com.events.startup. Examples: servlet.liferay.SampleAppStartupAction SHUTDOWN EVENTS Input a list of comma delimited class names that extend com.service.com.events.portal.service.liferay.portal.portal.liferay.events.pre=com.GlobalShutdownAction Application shutdown event that runs once for every web site instance of the portal that shuts down.LogMemoryUsageAction.events=com.portal.events.page=/common/error.programmatically.struts.Advanced Liferay Configuration #application.events=com. servlet.post=com.portal.portal.events.portal.error.struts.ServicePreAction.portal.shutdown.pre=com.liferay.service. These classes will run before or after the specified event.AppStartupAction.events.li feray.RandomLookAndFeelAction Use the following to define the error page.jsp The post-service events process after Struts processes the request.portal.events.events.LogSessionIdAction.events. global.liferay.events.com.events.portal.SimpleAction. See http://issues.liferay.liferay.RandomLayoutAction servlet.com.events.Action. Servlet service event: the pre-service events have an associated error page and will forward to that page if an exception is thrown during excecution of the events.com/browse/LEP-2048 for more information.liferay.l iferay.liferay.service.ServicePreAction servlet.portal.liferay.ServicePreAction servlet.portal.portal.events.events. This is a workaround for a bug in Tomcat and Linux where the process hangs on forever. liferay. Global shutdown event that runs once when the portal shuts down.service.events.events. application.portal.portal.pre=com.service.com.portal. servlet.pre.events.ServicePreAction servlet.liferay.events.pre=com.LogThreadCountAction.pre=com.co m.events.li feray.portal.service. These classes will run at the specified event.events.shutdown.events.liferay.liferay.exit=false PORTAL EVENTS Input a list of comma delimited class names that extend com.events.ServicePreAction. shutdown.

post=com.liferay.last.liferay.post property above. For example. events can be defined for the log out event. Advanced Liferay Configuration 187 . logout.liferay.portal.portal.public.post=com.portal.liferay.DefaultLandingPageAction LOGOUT EVENT Similarly.portal.by.liferay. set the property default.com. #default. If you need to add more than one page.liferay.events.portal.path to true.logout.lar to specify a LAR file instead.forward. To activate this feature.liferay.GarbageCollectorAction DEFAULT LANDING PAGE Set the default landing page path for logged in users relative to the server path. if you want the default logout page to be http://localhost:8080/web/guest/logout.com.liferay.events.liferay.events.liferay. set auth. To customize the behavior.DefaultLogoutPageAction.Advanced Liferay Configuration LOGIN EVENT Define events that can occur pre-login and post-login.post=com.landing.page.events.post=com.portal.LogoutPreAction Example post events: logout.portal.SiteMinderLogoutAction #logout.LoginPreAction login.portal. set this to /web/guest/logout. see com.events.forward.events.events.LogoutPostAction logout. The settings for the initial public page are specified in the following properties.events. This is the page users are automatically redirected to after logging out. For example. see com.events.events.portal.LogoutPostAction. set this to /web/guest/login.pre=com.com.post property above. set auth. #default.events.path to true.liferay.LogoutPostAction.events.events.events.layout.DefaultLogoutPageAction in the logout.events.path=/web/guest/login DEFAULT LOGOUT PAGE Set the default logout page path for users relative to the server path.events.LoginPostAction. To customize the behavior.portal.events.path=/web/guest/logout DEFAULT GUEST PUBLIC LAYOUTS The Guest group must have at least one public page. if you want the default landing page to be http://localhost:8080/web/guest/login.page.guest.last.by. To activate this feature.portal. login.portal. This is the page users are automatically redirected to after logging in.pre=com.events.com.liferay.DefaultLandingPageAction in the login.events.events.

layout. If this property is set.layout. default.user.layouts.portal. #default.theme.lar=${liferay.layouts.layout.guest.color.layout.private. default.name=Welcome 188 Advanced Liferay Configuration .lar to specify a LAR file instead.private. #default.regular.public.guest.service.guest. #default.id=2_columns_ii Set the portlet ids for the columns specified in the layout template. then users will have private layouts and they will be automatically created.user.id=01 Set the wap theme id for the public layout.layout.guest. #default. override the addDefaultUserPrivateLayouts method in com.id=classic Set the regular color scheme id for the public layout.template.public.guest.liferay. override the addDefaultGuestPublicLayouts method in com.auto.private. The settings below are used for the creation of for the initial private pages.enabled and layout.layout. If you need to add more than one page.wap.layout.guest.column-2=47 default.GroupLocalServiceImpl.scheme.guest.layout.private.layout.public.Advanced Liferay Configuration For even more complex behavior. #default.layout. Set the name of the public layout.guest.column-3= default.column-1=58 default. default.layout.public.id=01 Specify a LAR file that can be used to create the guest public layouts. set the property default.public.guest.wap.column-4= Set the friendly url of the public layout.id=mobile Set the wap color scheme for the public layout.public. the previous layout properties will be ignored.layout.layout.public.scheme.theme.regular.public.lar DEFAULT USER PRIVATE LAYOUTS If the properties layout.friendly.guest.public.layouts.public.create are both set to true.home}/deploy/default_guest_public.color.name=Welcome Set the layout template id of the public layout.impl.portal.guest.public.public. Set the name of the private layout.url=/home Set the regular theme id for the public layout.user. default. default.liferay.events.user. For even more complex behavior.ServicePreAction.guest.

lar= \ ${liferay.scheme.regular.layout.public.lar DEFAULT USER PUBLIC LAYOUTS If the properties layout.29.public.19 default. #default. the previous layout properties will be ignored.friendly.user.id=mobile Set the wap color scheme for the private layout. The settings below are used for the creation of for the initial public pages.create are both set to true.private.23.layout.user.private.public.wap.column-3= default.column-1=71_INSTANCE_OY0d. For even more complex behavior.8.user.layouts. If you need to add more than one page.ServicePreAction.template.user.private.name=Welcome Set the layout template id of the public layout.user.url=/home Set the regular theme id for the private layout.layouts.user.layout.private. #default.user. then users will have public layouts and they will be automatically created.61 default.private.user.enabled and layout.regular. override the addDefaultUserPublicLayouts method in com.home}/deploy/default_user_private.id=classic Set the regular color scheme id for the private layout.private.82.private.Advanced Liferay Configuration Set the layout template id of the private layout. default.layout.layout.id=2_columns_ii Set the portlet ids for the columns specified in the layout template.layout.scheme.column-2=11. default.column-4= Set the friendly url of the private layout.color.lar to specify a LAR file instead.user.theme.private. default.color. default. If this property is set.theme. set the property default.layout. default.user.layouts.portal.liferay.column-1=82.id=01 Set the wap theme id for the private layout.layout. #default.public.user.layout.23 Advanced Liferay Configuration 189 . Set the name of the public layout.user.user.layout.user.layout.user. #default. default.public.wap.public.private.layout.layout.id=01 Specify a LAR file that can be used to create the user private layouts.user.id=2_columns_ii Set the portlet ids for the columns specified in the layout template.auto.private.private.template.events. #default.layout.user.

The display text of each of the layout types is set in content/Language.regular. default.admin.lar=${liferay. default.home}/deploy/default_user_public.column-4= Set the friendly url of the public layout.scheme.wap.user.first.layout.email.user. #default.admin.regular.public. default.admin.properties and prefixed with layout.user.public.layout. #default. #default.layout.user.column-3= default.id=mobile Set the wap color scheme for the public layout.screen.user.public.name=Test Set the default admin middle name.id=01 Set the wap theme id for the public layout.public.19 default.user.Advanced Liferay Configuration default.public.layout.admin. If this property is set.color.last.theme.name=Test LAYOUTS Set the list of layout types. You can create new layout types and specify custom settings for each layout type.lar DEFAULT ADMIN Set the default admin password.password=test Set the default admin screen name prefix.address.id=classic Set the regular color scheme id for the public layout. End users input dynamic val190 Advanced Liferay Configuration .column-2=8.public.wap.user. #default.layouts.prefix=test Set the default admin first name.middle.admin.public.name=test Set the default admin email address prefix. default.color.layout.layout. default. default.url=/home Set the regular theme id for the public layout.user.id=01 Specify a LAR file that can be used to create the user public layouts.types.layout.user.name= Set the default admin last name.friendly.scheme. default.theme.public.admin.public.layout. #default. the previous layout properties will be ignored.

Parentable layouts can contain child layouts.url=${liferay:mainPath}/portal/layout?p_l_id=${liferay:plid} layout.configuration.url.create=true DEFAULT SETTINGS LAYOUTS These settings allow you to define several attributes on layouts.user.url[portlet]=${liferay:mainPath}/portal/layout?p_l_id=${liferay:plid} layout.delete= Settings for portlet layouts are inherited from the default settings.view. You can also specify which JSPs are responsible for editing and viewing layouts.edit.user. layout. The generated URL can reference properties set in the edit page. Set whether or not public layouts should be auto created if a user has no public layouts.public.layouts. the other two properties are assumed to be false.public. End users see the layout as designed in the view page.update= layout.user.layouts.user.jsp layout.enabled=true layout.jsp layout.configuration.pageable=true layout. the other two properties are assumed to be false. You will likely never need to change these settings. Set whether or not public layouts are modifiable. If public layouts are not enabled. layout.sitemapable=true layout.view.page[portlet]=/portal/layout/edit/portlet.jsp layout.private.link_to_layout Set whether or not private layouts are enabled.friendliable=true layout.layouts.page[portlet]=/portal/layout/view/portlet.auto.update[portlet]= layout.private.article. layout. If private layouts are not enabled.action.enabled=true layout. layout. layout.action. Set whether or not private layouts are modifiable.url.page[panel]=/portal/layout/edit/panel.first.user.delete[portlet]= Settings for panel layouts.types=portlet.url.action. Set whether or not private layouts should be auto created if a user has no private layouts.layouts.panel.public.embedded.auto.edit.page=/portal/layout/view/portlet.edit.modifiable=true layout.layouts.Advanced Liferay Configuration ues as designed in the edit page.jsp Advanced Liferay Configuration 191 .layouts.user.parentable[portlet]=true layout.action. layout.modifiable=true layout.page=/portal/layout/edit/portlet.create=true Set whether or not public layouts are enabled. You can also specify a comma delimited list of configuration actions that will be called for your layout when it is updated or deleted.configuration.parentable=true layout.configuration.jsp layout.friendliable[portlet]=true layout.private.

configuration.LayoutTypeArticleConfigurationUpdateAction layout.url[control_panel]=${liferay:mainPath}/portal/layout?p_l_id=$ {liferay:plid} layout.page[embedded]=/portal/layout/edit/embedded.action.friendliable[control_panel]=true layout. layout.parentable[panel]=true layout.page[panel]=/portal/layout/view/panel.update[url]= layout.configuration.liferay.configuration.sitemapable[article]=true layout. layout.view.configuration.first.friendliable[panel]=true layout.edit.action.liferay.action.url.jsp layout.sitemapable[embedded]=true layout.first.url.url.update[embedded]= layout.jsp layout.url.action.configuration.url.view.model.pageable[url]=false layout.view.edit.sitemapable[url]=false layout.first.edit.view.url[panel]=${liferay:mainPath}/portal/layout?p_l_id=${liferay:plid} layout.page[control_panel]=/portal/layout/view/control_panel.update[article]=com.action.parentable[control_panel]=true layout.portal.delete[article]=com.page[article]=/portal/layout/edit/article.LayoutTypeArticleConfigurationDeleteAction Settings for URL layouts.view.portal.Advanced Liferay Configuration layout.pageable[article]=true layout.jsp layout.jsp layout.url[url]=${url} layout.parentable[embedded]=false layout.first.friendliable[article]=true layout.url[embedded]=${liferay:mainPath}/portal/layout?p_l_id=$ {liferay:plid} layout.parentable[article]=false layout.configuration.edit.parentable[url]=false layout.pageable[embedded]=true layout.pageable[control_panel]=true Settings for embedded layouts.delete[embedded]= Settings for article layouts.page[url]= layout.jsp layout.jsp layout.url[article]=${liferay:mainPath}/portal/layout?p_l_id=${liferay:plid} layout. layout.jsp layout.page[article]=/portal/layout/view/article.page[control_panel]=/portal/layout/edit/control_panel. layout.page[url]=/portal/layout/edit/url.pageable[panel]=true Settings for control_panel layouts.model.action.jsp layout.page[embedded]=/portal/layout/view/embedded.friendliable[embedded]=true layout.delete[url]= 192 Advanced Liferay Configuration .friendliable[url]=true layout.first.

start.column-1[user] to 47.portlets.view.portlets.static. If you want the Hello World portlet to always appear at the end of the second column for user layouts.column-1[organization]= layout.70 layout.portlets. where abcd is any random alphanumeric string.end. By default.column-2[user]=34.page[link_to_layout]=/portal/layout/edit/link_to_layout.edit.6 layout.7 layout.portlets.configuration.column-2[community]= layout.start.end. add the suffix _INSTANCE_abcd to the portlet id. and organization.static.static.column-2[community]= layout. layout. set the property layout.static.sitemapable[link_to_layout]=false layout.static.portlets.action.column-2[user] to 47.column-3[community]= Set the static portlets for organization layouts.column-1[community]= layout.static.start.static.static.parentable[link_to_layout]=true layout.start.static.portlets. The static portlets are fetched based on the properties controlled by custom filters using EasyConf.portlets.portlets.action. community.static. You can input a list of comma delimited portlet ids to specify more than one portlet.start.static.url.portlets.start.column-3[user]= layout.column-1[user][/home]=3.column-3[user]= It is also possible to set static portlets based on the layout's friendly URL.end. layout.portlets.column-1[community]= layout. layout.delete[link_to_layout]= Specify static portlets that cannot be moved and will always appear on every layout.start.static.url[link_to_layout]=${liferay:mainPath}/portal/layout?p_l_id=${linkToPlid} layout.column-1[organization]= layout.jsp layout.end.start.column-3[community]= layout. layout.static.start.portlets.column-2[user]=71_INSTANCE_abcd.portlets.portlets. the available filters are user. if you want the Hello World portlet to always appear at the start of the iteration of the first column for user layouts.static.portlets.end.pageable[link_to_layout]=false layout.static.column-1[user]=14 layout.static.end.portlets.portlets.update[link_to_layout]= layout.portlets.friendliable[link_to_layout]=true layout.Advanced Liferay Configuration Settings for page layouts.column-1[user]=3.configuration.page[link_to_layout]= layout.portlets. set the property layout. layout.end.column-2[organization]= Advanced Liferay Configuration 193 .static.static.end.static.start.column-2[community][/home]=14 Set the static portlets for community layouts.first. Static portlets will take precedence over portlets that may have been dynamically configured for the layout.end.6 layout. If the portlet is instanceable. For example.portlets.

For example.friendly.icon=false 194 Advanced Liferay Configuration . Leave it blank to display nothing.friendly. Note: For backward compatibility.mapping=/web Redirect to this resource if the user requested a friendly URL that does not exist.portlets.rss. tags Set the following to true if layouts should remember (across requests) that a window state was set to maximized.min. if the public pages are mapped to /web and the group or user's friendly URL is set to /guest and the layout's friendly URL is set to /company/community. layout. The friendly URLs for users.url.private.column-3[organization]= Set the static portlets that will appear for every layout. this overrides the property layout. then the friendly URL for the page will be http://www.portal. layout.Advanced Liferay Configuration layout.show.servlet.window.start.public.image.liferay.FriendlyURLServlet. if the private group pages are mapped to /group and the group's friendly URL is set to /guest and the layout's friendly URL is set to /company/community.static.servlet.mapping=/user layout.column-3[organization]= layout. Private group pages map to a community's private pages and are only available to authenticated users with the proper permissions.url.status for the 404 status code. See /html/portal/layout/view/portlet.com/group/guest/company/community.guest. For example.friendly.static. layout.wsrp.page.url.private.servlet. This value must match the servlet mapping set in web.portlets. layout.jsp in the Liferay source code for the logic of when these portlets will be shown.state. For example.remember. layout. these portlets will only show for layouts that can contain portlets and are not in a pop up state. and public servlet mapping for com.public.not.url.user.group.liferay.end. and layouts can be set during runtime. Public pages are available to unauthenticated users.static.guest.com/web/guest/company/community.all=1_WAR_chatportlet Set the private group.private.page. then the friendly URL for the page will be http://www.keywords=c.xml.web.servlet.liferay.group.html Set the reserved keywords that cannot be used in a friendly URL.friendly.http.maximized=false Set the following to true if guest users should see the maximize window icon.request.portlets. groups. private user.max.found=/html/portal/404. layout.icon=false Set the following to true if guest users should see the minimize window icon.url. layout.portlets.friendly.end.static.mapping=/group layout.show.show.column-2[organization]= layout.

portlet.util.impl=com.url. layout.parallel.portal.SessionLayoutClone Set the following to true to cache the content of layout templates.com/browse/LEP-426 for more information.show.portal. layout.cache.inactive=true Set the following to true if the portal should show HTTP status codes like 404 if the requested page is not found.FALSE in a pre service event or by setting the URL parameter p_p_parallel to 0.p_l_reset=true PORTLET URL Set the following to true if calling setParameter on a portlet URL appends the parameter value versus replacing it.show.liferay.http. layout.util.url.status=true Set the default layout template id used when creating layouts. The portlet init parameter show-portlet-access-denied will override this setting.liferay.parameters=false Set the following to true to allow portlet URLs to generate with an anchor tag.portlet. but is the one that most end users seem to prefer.default.default.enable=false Advanced Liferay Configuration 195 .clone. Setting it to false is useful during development if you need to make a lot of changes.liferay.anchor. This is recommended because it improves performance for production servers. There is some disagreement in the interpretation of the JSR 168 spec among portlet developers over this specific behavior. then render parameters are cleared when different pages are hit.access. layout.append.Advanced Liferay Configuration Set the following to true if users are shown that they do not have access to a portlet. You can also disable it on a per request basis by setting the attribute key com.PORTLET_PARALLEL_RENDER to the Boolean.render. layout.template. The portlet init parameter show-portlet-inactive will override this setting.denied=true Set the following to true if users are shown that a portlet is inactive. portlet. The default implementation persists the state in the browser session.enabled=true Set the default value for the p_l_reset parameter.id=2_columns_ii Set the following to false to disable parallel rendering.LayoutClone.util.liferay. This is not the behavior promoted by the portlet specification. If set to true. Liferay Portal successfully passes the portlet TCK tests whether this value is set to true or false. See http://issues. layout.show.enable=true Set the name of a class that implements com.portal. layout. layout.template.portlet. This class is used to remember maximized and minimized states on shared pages.WebKeys.

gif Set the location of the default company logo image that is used for missing company logo images.default.logo=com/liferay/portal/dependencies/organization_logo.portal. struts. then modify portlet. preference.female.liferay.PortletRequestProcessor IMAGES Set the location of the default spacer image that is used for missing images.liferay.processor=com. If this is set to true.png Set the locations of the default user portrait images that are used for missing user portrait images.xml=false PREFERENCES Set the following to true to validate portlet preferences on startup. This image must be available in the class path.DatabaseHook 196 Advanced Liferay Configuration .user. Available hooks are: • com. This image must be available in the class path. The portal will use this persist images. portlet.spacer=com/liferay/portal/dependencies/spacer.liferay. The custom class must extend com.image.default.user.escape.PortletRequestProcessor and have the same constructor.struts.png Set the name of a class that implements com. image. image.default.organization. image.escapeXml to false.company. This image must be available in the class path.portal.male.portlet.validate.portrait=com/liferay/portal/dependencies/user_male_p ortrait.png image.portrait=com/liferay/portal/dependencies/user_female_portrait.image.startup=false STRUTS Input the custom Struts request processor that will be used by Struts based portlets.Hook.logo=com/liferay/portal/dependencies/company_logo.Advanced Liferay Configuration JSR 286 specifies that portlet URLs are escaped by default.url.portlet.struts. image.portal.liferay.request. but a specific portlet application requires that its portlet URLs not be escaped by default.default.portal. Set this to false to provide for better backwards compatibility.png Set the location of the default organization logo image that is used for missing organization logo images.default.xml and set the container runtime option javax. This image must be available in the class path.on.

portal.docroot.hook.portlet.portal-web.docroot.mail.wysiwyg.portal.FileSystemHook FILESYSTEMHOOK image.portal-web.impl=com.portal.liferay.enterprise_admin.docroot.liferay.edit_configuration.configuration.portal-web.liferay.jsp=fckeditor editor.portal.portlet.jsp=fckeditor editor.liferay.jsp=fckeditor editor.html.portal.wysiwyg.html.html.edit_html.FileSystemHook image.edit_configuration.portal-web.docroot.portlet.portlet. editor.portlet. field.invitation.jsp=fckeditor editor.wysiwyg.docroot.wysiwyg.jsp=fckeditor editor.journal.wysiwyg.portlet.html.view.journal.portal-web.Organization.DatabaseHook #image.portal.edit_configuration.com.image.portal-web.model.edit_article_content.edit_article_content_xsd_el.mail.model.com.docroot.calendar.edit.portal-web.html.wysiwyg. fckeditor.jsp=fckeditor FIELDS Set the following fields to false so users cannot see them.portal-web.edit_configuration. simple.wysiwyg.model.shopping.Contact. or tinymcesimple.docroot.home}/data/images EDITORS You can configure individual JSP pages to use a specific implementation of the available WYSIWYG editors: liferay.edit_message.jsp=fckeditor editor.portlet.impl=com.file.hook.jsp=fckeditor editor.Advanced Liferay Configuration • • com.html.portal-web.hook.message_boards.liferay.docroot.impl=com.enable.wysiwyg.html.portal-web.jsp=fckeditor editor.portal-web.dir=${liferay.portal-web.com.DLHook #image.blogs.image.docroot.wysiwyg.jsp=fckeditor editor.wysiwyg.docroot.portal-web.docroot.status=false Advanced Liferay Configuration 197 . Some company policies require gender and birthday information to always be hidden.liferay.image.edit_entry.wysiwyg.DLHook com.html.docroot.html.wysiwyg.enable.portal.html.jsp=fckeditor editor.html.enable.html.portlet.portlet.liferay.jsp=fckeditor editor. tinymce.default=fckeditor editor.wysiwyg.portlet.portlet.image.jsp=fckeditor editor.wiki.portal.system.journal.male=true field.Contact.portlet.hook.html.birthday=true field.edit_configuration.wysiwyg.image.root.login.liferay.docroot.portlet.

browser.regular.wmv AMAZON Enter an Amazon access key ID and an Amazon associate tag.layout.types.\ application/vnd.communities=50 Set the maximum number of organizations that will be shown in the navigation 198 Advanced Liferay Configuration . mime.ms-powerpoint ppt.\ application/pdf pdf.content. control.tag= BROWSER LAUNCHER Enter a URL to automatically launch a browser to that URL when the portal has fully initialized.associate.url=/manage Set the theme of the layout. mime. Please see the Amazons license at http://www. This is made available only for personal use.navigation.name=Control Panel Set the friendly URL of the layout. control.access.com for more information.disposition.key.friendly.inline=flv.theme.id=controlpanel Set the maximum number of communities that will be shown in the navigation menus. Enter a blank URL to disable this feature.swf. A large value might cause performance problems if the number of communities that the user can administer is very large.amazon.panel.layout.layout.pdf.MimetypesFileTypeMap.id= #amazon.panel.activation.ms-excel xls.Advanced Liferay Configuration MIME TYPES Input a list of comma delimited mime types that are not available by default from javax.launcher.max.panel. #amazon.\ application/x-ms-wmp wmv.panel. control.types=\ application/msword doc.\ application/vnd. control.url=http://localhost:8080 CONTROL PANEL Set the name of the layout.\ application/x-shockwave-flash swf flv Input a list of comma delimited extensions for which the content disposition header has to be set to inline.

icq. This is useful in some clustering environments where there is a shared index and only one node of the cluster updates it.login= aim. See the following posts: http://sourceforge.0.password= Set the MSN login and password which the system will use to communicate with users.net/forum/message.php?msg_id=1972697 http://sourceforge.panel.3b1.read.on.login= msn. index.login= ym. This property is only valid if index. control.on.startup is set to true. ym.navigation.net/forum/message.php?msg_id=1990487 icq. Advanced Liferay Configuration 199 .max. A large value might cause performance problems if the number of organizations that the user can administer is very large.login= icq.Advanced Liferay Configuration menus. msn. aim.jar=C:/Java/orion-2.organizations=50 INSTANT MESSENGER Set the AIM login and password which the system will use to communicate with users. index.7/lib/icq.password= Due to a bug in JOscarLib 0.password= LUCENE SEARCH Set the following to true if you want to avoid any writes to the index.jar Set the ICQ login and password which the system will use to communicate with users. A delay may be necessary if a lot of plugins need to be loaded and reindexed.password= Set the YM login and password which the system will use to communicate with users.startup=false Set this to true to add a delay before indexing on startup.only=false Set the following to true if you want to index your entire library of files on startup. you must set the full path to the ICQ jar.

This is only referenced if Lucene stores indexes in the file system.DB2Dialect lucene.apache.store.jdbc.dialect. lucene.apache.up=true Set the JDBC dialect that Lucene uses to store indexes in the database.type=ram Lucene's storage of indexes via JDBC has a bug where temp files are not removed.apache.dialect.Advanced Liferay Configuration index.auto.hsqldb=org.derby=org.jdbc.db2=org.apache.dialect.store.apache.OracleDialect lucene.mysql is read for the JDBC connection URL jdbc:mysql://localhost/lportal.jdbc.dialect.apache.lucene. the property lucene.jdbc.dialect. file system.apache.dialect.dialect.dialect.liferay.jdbc.store.dialect.store. Examples: lucene.thread=true Designate whether Lucene stores indexes in a database via JDBC.startup.jdbc.dialect.store. See LEP-2180.SQLServerDialect lucene. lucene.MySQLInnoDBDialect #lucene.dialect.jdbc.jdbc.dialect.jtds=org.jdbc.dir=${liferay. or in RAM.MySQLMyISAMDialect lucene. index. This is only referenced if Lucene stores indexes in the database.jdbc.store.store.dialect.store.jdbc.lucene.LuceneFileExtractor.dialect. This class is called by Lucene to extract text from complex files so that they can be properly indexed.type=file lucene.jdbc.store.store. This can eat up disk space over time. Liferay will attempt to load the proper dialect based on the URL of the JDBC connection.lucene.dialect.store.dialect.store.home}/lucene/ Input a class name that extends com.on.search.lucene.oracle=org.store.store.lucene. Set the following property to true to automatically clean up the temporary files once a day.dialect.PostgreSQLDialect Set the directory where Lucene indexes are stored.portal.delay=60 Set the following to true if you want the indexing on startup to be executed on a separate thread to speed up execution.store. 200 Advanced Liferay Configuration .lucene.DerbyDialect lucene.jdbc.dialect.store.jdbc. For example.with.HSQLDialect lucene.store.apache.dialect.SQLServerDialect lucene.apache.store.dialect.store. lucene.jdbc.type=jdbc lucene.mysql=org.jdbc.store.lucene.clean.store.jdbc.store.jdbc.apache.dialect.postgresql=org.jdbc.store.lucene.jdbc.jdbc.store.MySQLDialect #lucene.lucene.microsoft=org.jdbc.store.mysql=org.lucene.lucene.mysql=org.

analyzer=org.LuceneFileExtractor The file extractor can sometimes return text that is not valid for Lucene.net.strip= lucene.optimize.\ # McLean.lucene.analysis.SnowballAnalyzer lucene.sourceforge. Set this property to an integer greater than 0 to optimize every X writes.lucene. This should never be set to a number lower than 2.lucene.net.CzechAnalyzer lucene.analysis.portal.analyzer=org.lucene.apache.apache.apache.DutchAnalyzer lucene.lucene. Set an empty regular expression to disable this feature.analysis.analyzer=org.apache.lucene.BrazilianAnalyzer lucene.analyzer=org.regexp.PerFieldAnalyzerWrapper lucene.analyzer=org.analysis.dl.dl.analysis.forge.merge.interval=1 SOURCEFORGE source.KeywordAnalyzer lucene.lucene.search.net.analysis.extractor.factor=10 Set how often to run Lucene's optimize method.mirrors=\ http://downloads.analyzer=org.analyzer=org. This property expects a regular expression. Examples: lucene.memory.strip=[\\d\\w] Set the default analyzer used for indexing and retrieval.sourceforge.lucene.analysis.regexp.\ http://internap.net.standard.analysis.lucene. Set this property to 0 to always optimize.liferay.snowball.FrenchAnalyzer lucene.extractor.dl.sourceforge.analyzer=org.sourceforge.apache.net.lucene. UK Advanced Liferay Configuration 201 .dl.analysis.lucene.apache.analysis.analysis.CJKAnalyzer lucene.br.analyzer=org.analysis.Advanced Liferay Configuration lucene.WhitespaceAnalyzer Set Lucene's merge factor.analyzer=org.de.GermanAnalyzer lucene.RussianAnalyzer lucene.\ http://kent. The default value from Lucene is 10.apache.sourceforge.apache. Washington http://easynews.index.cz.analysis.file.StandardAnalyzer lucene.apache.PatternAnalyzer lucene.lucene.nl.\ # Phoenix.cn.apache.dl. Examples: lucene.analysis.sourceforge.lucene.apache.ru.ChineseAnalyzer lucene.apache. Higher numbers mean indexing goes faster but uses more memory. AZ # Kent.analyzer=org. lucene. Optimization speeds up searching but slows down writing.lucene.analyzer=org.analysis.file.cjk.\ # Seattle.apache.analyzer=org.lucene.apache. CA http://superb-east.apache.analyzer=org.apache.fr.SimpleAnalyzer lucene.net.\ # Redirect # San Jose.analyzer=org.extractor=com.analyzer=org.StopAnalyzer lucene. Virginia http://superb-west. Any character that does not match the regular expression will be replaced with a blank space. lucene.file.lucene.lucene.

listener.net.object.finder.\ http://dfn.JournalArticleListener value.sourceforge.object.dl.cache.model. The Netherlands # Ishikawa.liferay.liferay.dl.object.portal.dl.liferay.com. You can disable caching for all objects or per object.net.portal.model.\ http://mesh.model.journal.model.model.model.object.User=com.LayoutSet=com.sourceforge.model.lifera y.net.com.sourceforge.journal.model. The specified multi-cast address should be unique for internal portal messaging only.liferay . Germany # Dublin.portal. Belgium # Lausanne. France # Berlin.portal.journal.model.sourceforge. For mapping tables.net.model.liferay.net # Curitiba.portlet.JournalArticle=com.\ http://ovh.model.object.Layout=true value. This is only needed if the portal is running in a clustered environment.dl.object.LayoutListener value.com.enabled. Japan # Tainan.journal.portlet.model.finder. Ireland # Bologna.model.object.Advanced Liferay Configuration http://ufpr.JournalTemplate=com.sourceforge.liferay.com.portal.l iferay. value.com.\ http://optusnet. Italy # Amsterdam.sourceforge.JournalTemplateListener Value objects are cached by default.net.PortletPreferences=com.com.enabled.cache. You will still need to set the Hibernate and Ehcache settings for database clustering.dl.liferay.Layout=com.listener.model.\ http://heanet.Users_Roles=true COMMUNICATION LINK Set the JGroups properties used by the portal to communicate with other instances of the portal.LayoutSetListener value.dl.liferay.ContactListener value.Contact=com.\ http://surfnet.cache.portal.liferay.com.liferay.listener. These classes are pooled and reused and must be thread safe.net.net http://jaist.\ http://belnet.com.sourceforge.\ http://garr.dl.object.net.UserListener value.object.portal.liferay.dl.object.liferay.model.\ http://nchc.dl. The JGroups settings provide a mechanism for the portal to broadcast messages to the other instances of the portal.cache.liferay.portal.dl.listener.listener. Taiwan # Sydney.finder.portal.portlet.finder.portlet.enabled.com.PortletPreferencesListener value.portal.User=true value. Switzerland # Duesseldorf.net.listener with a list of comma delimited class names that implement com.portal.enabled=true value. Brazil # Brussels. Australia VALUE OBJECT You can add a listener for a specific class by setting the property value. value.\ http://switch.sourceforge.object.dl.net.listener. Germany # Paris.portal.net.liferay.portal.sourceforge.sourceforge.listener.ModelListener.model.object. the key is the mapping table itself.model.dl. liferay.sourceforge.sourceforge. 202 Advanced Liferay Configuration .

12.portlet.model.apache.1.com.time.link.max_xmit_size=8192):UNICAST(timeout= 300. cdn.mcast_recv_buf_size=80000):P ING(timeout=2000.print_local_addr=true) CONTENT DELIVERY NETWORK Set the hostname that will be used to serve static content via a CDN.mcast_addr=231.1200. Set this value to a higher number for better performance. counter.STABLE(desired_avg_gossip=20000):FRAG(frag_size=80 96.time.0.org) by default as its JSRAdvanced Liferay Configuration 203 .Advanced Liferay Configuration comm. This property can be overridden dynamically at runtime by setting the HTTP parameter cdn_host.mcast_ port=45566.heartbeat.wiki.4800.expiration.properties=UDP(bind_addr=127.WikiPage=1200000 JBI Connect to either Mule or ServiceMix as your ESB.increment=100 Set the interval in minutes for the ConnectionHearbeatJob.600.portlet.url=http://localhost:8080/mule-web/workflow jbi. Examples: jbi.join_retr y_timeout=2000.interval=60 LOCK Set the lock expiration time for each class.url=http://localhost:8080/servicemix-web/workflow JCR Liferay includes Jackrabbit (http://jackrabbit.model.workflow.102.NAKACK(gc_lag=50.host= COUNTER Set the number of increments between database updates to the Counter table.GMS(join_timeout=5000. This will determine how often the database is polled for long running connections and will prevent the database from disconnecting the socket prematurely. Example: 1 Day lock.com.2400):pbcast.2400.liferay. counter.documentlibrary.600.1200.shun=false.workflow.expiration.job.num_initial_members=3):MERGE2(min_interval=5000.down_thread=false.0.connection.up_thread=false):pbcast.max_interval=10000):FD_SOCK:VERIFY_SUSPECT(timeout=1500):pbcast.retransmit_timeout=300.21.DLFileEntry=8 6400000 Example: 20 Minutes lock.mcast_send_buf_size=150000.ip_ttl=32.liferay.

name=mail/MailSession Set the properties used to create the Java Mail session.expiration. 1 day: lock.time.host=localhost #mail. mail.jackrabbit.session.wiki.session.imap.mail.documentlibrary.expiration.pop3. These properties will only be read if the property mail.model.repository.com.com.credentials. live.smtp.time.name=liferay jcr. jcr.session.DLFolder=8640 0000 lock.socketFactory. If none is set.jackrabbit.documentlibrary.jackrabbit.session.session.session.repository.root}/repository.mail.startup=false jcr.ssl.mail.root=${liferay.credentials.jackrabbit.root}/home jcr.liferay.socketFactory.smtp.session.liferay.fallback=false #mail.model.workspace. #mail." will be removed before it is used to create the session object.node.name is not set.jackrabbit.class=javax.host=localhost #mail.repository.portlet.liferay.session.portlet.jndi.on.xml jcr.mail.port=465 204 Advanced Liferay Configuration .mail.auth=true mail.session.mail.net.model.smtp.mail.com.smtp.home=${jcr.jackrabbit.SSLSocketFactory #mail.session.portlet. then the portal will attempt to create the Java Mail session based on the properties prefixed with mail.enabled=false LOCK Set the lock expiration time for each class.path=${jcr.username=none jcr.initialize.users.jndi.home}/jackrabbit jcr.file.session. The property prefix "mail.jackrabbit.password=none LIVE USERS Set this to true to enable tracking via Live Users.repository.host=localhost mail.config.time.documentlibrary=documentlibrary jcr.WikiPage=1200000 MAIL Set the JNDI name to lookup the Java Mail session.expiration.Advanced Liferay Configuration 170 Java Content Repository.socketFactory.DLFileEntry=8 6400000 20 minutes: lock.smtp.

You must also update the mail.SendmailHook com.mail.username= mail.com/support/api.hook.liferay.url=https://www.mail. The mail server will use this class to ensure that the mail and portal servers are synchronized on user information.DummyHook com.store.user=cyrus_userdel password %1% mail.password= Advanced Liferay Configuration 205 .fusemail.hook. mail.util.user=cyrusadmin password create %1% #mail.util.session.user= mail.session.hook.protocol=smtp Set this to false if administrator should not be allowed to change the mail domain via the Admin portlet. update.home=/home/cyrus FUSEMAILHOOK See http://www.CyrusHook com.port=465 #mail.mail.liferay.liferay.util.cyrus.com/api/request.util.smtp.session. updating.fusemail.util. Replace the password with the password for the cyrus user.mail.add.finder property.trail= Set the name of a class that implements com. or delete users from the mail server except through this hook.liferay.DummyHook CYRUSHOOK Set the commands for adding.cyrus. mail.transport.mail. Available hooks are: • • • • • com.hook.session.session.password= #mail.hook.enable=true #mail.smtp.fusemail.mail.FuseMailHook com.hook.impl=com.mail.html for more information.mail.session.add.smtp.fusemail.audit. mail.hook.cyrus.util.util. and deleting a user where %1% is the user id.ShellHook mail.html mail.hook.liferay.mail.starttls.smtp.Hook.liferay.update=true Input a list of comma delimited email addresses that will receive a BCC of every email sent through the mail server. The portal will not know how to add. mail.account.delete.mail.user=cyrus_adduser password %1% mail.mail.cyrus.cyrus.protocol=localhost mail.delete.hook.mail.fusemail.Advanced Liferay Configuration #mail.liferay.user=cyrusadmin password delete %1% #mail.mail.mx.

0.server.port=8100 POP Set this to true to enable polling of email notifications from a POP server.user=adduser %1% -s /bin/false mail.sendmail.port=8100.enabled=false Set the interval on which the POPNotificationsJob will run.virtusertable.type=group_subaccount mail.refresh=bash -c "makemap hash /etc/mail/virtusertable < /etc/mail/virtusertable" SHELLHOOK Set the location of the shell script that will interface with any mail server.sendmail.ksh OPENOFFICE Enabling OpenOffice integration allows the Document Library portlet to provide document conversion functionality.sendmail.delete.hook.0. The value is set in one minute increments. events.sendmail.interval=1 Set this property to create a special MX subdomain to receive all portal related email (e.password=autopasswd %1% %2% mail.3.hook.script=/usr/sbin/mailadmin.server. and deleting a user where %1% is the user id and %2% is the password.liferay.notifications.hook.host=127. openoffice.shell.enabled=false openoffice. 206 Advanced Liferay Configuration . Set the home and virtual user table information.user=userdel -r %1% mail.virtusertable=/etc/mail/virtusertable mail. pop.group.sendmail. updating.account.0.hook.1.hook.server.server.urp.host=127. mail.change.Advanced Liferay Configuration mail.fusemail.hook.notifications.hook. The user credentials are the same used for SMTP authentication and is specified in the mail/MailSession configuration for each application server.fusemail.hook.com). This means configuring a default inbox for the domain and receiving all emails into that inbox. To start OpenOffice as a service.hook.0.parent= SENDMAILHOOK Set the commands for adding.home=/home mail.g.server.add.sendmail. mail." -nofirststartwizard This is tested with OpenOffice 2.1 openoffice. run the command: soffice -headless -accept="socket.x. pop.

jobStore.30.quartz.50.scheduler.class=org.quartz. search.values=5.jdbcjobstore.class=com.75 Advanced Liferay Configuration 207 . scheduler.SimpleThreadPool org.instanceName=QuartzSchedulerEngineInstance org.classes= SEARCH CONTAINER Set the available values for the number of entries to display per page.quartz.quartz.Scheduler.quartz.driverDelegateClass=com.impl. If you cannot use the subdomain approach.quartz.delta.tablePrefix=QUARTZ_ org.10.JobStoreTX org.container.portal.threadPool.jobStore.portal. or commenting out the value. Always include 20.dataSource=ds org.connectionProvider.quartz.scheduler. These classes allow jobs to be scheduled on startup.page.quartz.quartz.kernel.server. The absolute maximum allowed delta is 200.isClustered=false org.DynamicDriverDelegate org.threadPool.quartz.quartz.liferay.class=org.liferay.dataSource.xml and in the property scheduler.20.jobStore. scheduler.misfireThreshold=60000 org.instanceId=AUTO org.portal.jobStore.threadCount=5 org.subdomain=events QUARTZ These properties define the connection to the built-in Quartz job scheduling engine.simpl.quartz. These classes are not associated to any one portlet.classes.jobStore. An empty value.quartz.job.threadPool.jobStore.useProperties=true org.quartz.ds.quartz.threadPriority=5 SCHEDULER Set this to false to disable all scheduler classes defined in liferay-portlet. unset this value and Liferay will use the replyTo address specified in the portlet preferences.scheduler. pop.enabled=true Input a list of comma delimited class names that implement com.scheduler. org. since it is the default page size when no delta is specified.quartz.QuartzConnectionProviderImpl org. The default of 20 will apply in all cases.jobStore. will disable delta resizing.quartz.liferay.Advanced Liferay Configuration This approach may not be allowed for some organizations.

icio. to configure more.url[newsvine]=http://www.digg.bookmark. We extend the Velocity's default resource managers for better scalability. social.reddit.DLSharepointStorageImpl SOCIAL BOOKMARKS The Blogs portlet allows for the posting of entries to various popular social bookmarking sites.com/index.bookmark.post.bookmark.com.listeners=com.com.engine.url[reddit]=http://reddit.ServletVelocityResourceListener.portal.post. just add the site in the format below.com/_tools/seed&save? u=${liferay:social-bookmark:url}&h=${liferay:social-bookmark:title} social.url[blinklist]=http://blinklist. These classes will run in sequence to allow you to find the applicable ResourceLoader to load a Velocity template.ClassLoaderVelocityResourceListener Set the Velocity resource managers. sharepoint.newsvine.liferay. velocity.url[delicious]=http://del.bookmark.velocity.liferay.newsvine.liferay. sharepoint.velocity.bookmark.VelocityResourceListener.tokens=document_library Set the class names for supported Sharepoint storage classes. The example ones are the defaults.portal.com/cosmos/search.bookmark.delicious.resource.url[digg]=http://digg.portal.liferay.technorati social.class[document_library]=com.storage.types=blinklist.documentlibrary.net/storeIt.post.LiferayResourceManager 208 Advanced Liferay Configuration .url[technorati]=http://technorati.resource.us/post?url=$ {liferay:social-bookmark:url}&title=${liferay:social-bookmark:title} social.htm l?url=${liferay:social-bookmark:url} VELOCITY ENGINE Input a list of comma delimited class names that extend com. This means you will need to turn off caching if you want to be able to modify VM templates in themes and see the changes right away.util.liferay.velocity.portal.velocity.post.com/submit?url=${liferay:social-bookmark:url}&title=${liferay:social-bookmark:title} social.sharepoint.jsp?u=${liferay:social-bookmark:url}&t=${liferay:social-bookmark:title} social.liferay.portlet.liferay. Note that the modification check interval is not respected because the resource loader implementation does not know the last modified date of a resource.php? Action=Blink/addblink.com.post.velocity.furl.ThemeLoaderVelocityResourceListener.JournalTemplateVelocityResourceListener.bookmark.Advanced Liferay Configuration SHAREPOINT Set the tokens for supported Sharepoint storage paths.manager=com.post.post.com/submit?phase=2&url=$ {liferay:social-bookmark:url} social. velocity.bookmark.storage.php&url=${liferay:social-bookmark:url}&Title=$ {liferay:social-bookmark:title} social.portal.engine.velocity.url[furl]=http://furl.

\ /c/portal/logout.\ /c/portal/session_tree_js_click. velocity.\ /c/portal/upload_progress_poller.cache=com.\ \ /c/layout_configuration/templates.vm.\ /c/portal/update_layout.vm Set the Velocity logging configuration.0.apache.engine.0.\ \ /c/portal/change_password.cache.\ /c/portal/json_service.manager.engine.ignore.hosts=\ 127.\ /c/portal/render_portlet.manager.hosts.engine.Advanced Liferay Configuration velocity.\ /c/portal/login.modification.log.1. Advanced Liferay Configuration 209 .VM_liferay.SimpleLog4JLogSystem velocity.engine. These files must exist in the class path.\ /c/portal/layout.properties for more HTTP settings.check.logger=org.library=VM_global_library.\ /c/portal/update_terms_of_use.\ /c/portal/portlet_url.velocity VIRTUAL HOSTS Set the hosts that will be ignored for virtual hosts.\ /c/layout_management/update_page HTTP See system.portal.engine. velocity.interval=0 Input a list of comma delimited macros that will be loaded.resource.logger.hosts.resource.paths=\ /c.enabled=true #velocity.LiferayResourceCache velocity.velocity.liferay.velocity.category=org.resource.manager.\ /c/portal/extend_session_confirm.apache.runtime.\ /c/portal/extend_session.engine.ignore. virtual.\ /c/portal/status. virtual.\ localhost Set the paths that will be ignored for virtual hosts.velocimacro.\ /c/portal/reverse_ajax.

HttpImpl.connections.servlet.proxy.portal. com.util.portal.HttpImpl.liferay.password= Set additional properties for NTLM authentication.username= #com.util.domain= #com.util.liferay.portal.filters.type=ntlm Set user name and password used for HTTP proxy authentication.HttpImpl.liferay.ntlm.servlet.portal.strip.liferay. Prevention of double clicks is already in place on the client side.proxy.HttpImpl.portal.DoubleClickFilter=false If the user can unzip compressed HTTP content. com.proxy.MinifierFilter=true The strip filter will remove blank lines from the content.util. com.util.util.servlet.host=2 #com.HeaderFilter=true The minifier filter is used to minify CSS and JavaScript. com. the GZip filter will zip up the HTTP content before sending it to the user. #com.total.HttpImpl.liferay.layoutcache.portal. This will speed up page rendering for users that are on dial up.connections=20 Set the proxy authentication type. This is turned off by default since most sites will not need it.HttpImpl.xml to modify the cache expiration time to live.portal.HttpImpl.host= Set the connection timeout when fetching HTTP content.liferay.proxy. com.GZipFilter=true The header filter is used to set request headers.util.liferay.portal. com.CacheFilter=true This double click filter will prevent double clicks at the server side.filters.Advanced Liferay Configuration Set the maximum number of connections.max.header.per.liferay.util.proxy. #com. However. some sites require a more robust solution.liferay. com.liferay. This will speed up page rendering for users that are on dial up.servlet.portal.gzip.liferay.timeout=10000 SERVLET FILTERS The cache filter will cache content.cache. See ehcache. com.liferay.liferay.max.portal.liferay.type=username-password #com.portal.portal.filters.filters.portal.minifier.portal.servlet.filters.servlet.auth.doubleclick. #com.StripFilter=true The layout cache filter will cache pages to speed up page rendering for guest users.HttpImpl.ntlm.liferay.servlet.proxy.xml to modify the cache expiration time to live.auth. #com.HttpImpl.portal.util.filters.filters.liferay.LayoutCacheFilter=true 210 Advanced Liferay Configuration . See ehcache.portal.

liferay.portal.filters.UploadServletRequestImpl.helloworld.https.port=-1 Set the hostname that will be used when the portlet generates URLs.com is mapped to http://localhost:8080/web/helloworld.portal.server.portal.portal.server. Set the values to -1 if the portal is not running behind another web server like Apache.UploadServletRequestImpl.liferay.css as a Velocity template. com.host= Set the preferred protocol. web.protocol=https Set this to true to display the server name at the bottom of every page.size=104857600 Set the temp directory for uploaded files. Default is 1024 * 1024 * 10. http.Advanced Liferay Configuration The session id filter ensure that only one session is created between http and https sessions.server.com and the friendly URL is /helloworld.liferay.size=10485760 WEB SERVER Set the HTTP and HTTPs ports when running the portal in a J2EE server that is sitting behind another web server like Apache.liferay.liferay. com.servlet. com.portal.upload. if the public virtual host is www.LiferayFileItem.liferay.port=-1 web.servlet.max.portal.size=262144 Set the threshold size to prevent out of memory exceptions caused by caching excessively large uploaded data. com. This is useful when testing clustering configurations so that you can know which node you are accessing.sessionid.LiferayInputStream. Leaving this blank will mean the host is derived from the servlet container. com.threshold.VirtualHostFilter=true UPLOAD SERVLET REQUEST Set the maximum file size.filters. #com. Advanced Liferay Configuration 211 . and https work. For example.portal.SessionIdFilter=false The Velocity filter will process */css/main. web.server.VelocityFilter=false The virtual host filter maps hosts to public and private pages.dir=C:/Temp Set the threshold size to prevent extraneous serialization of uploaded data. then http://www. com.http.threshold.helloworld.temp.velocity.servlet. This is disabled by default.upload.upload. Do not enable this unless you thoroughly understand how cookies.liferay.filters. Default is 1024 * 1024 * 100.virtualhost. This is useful if you want users to login via https but have them view the rest of the site via http. web.upload.

Trashes MAIN SERVLET Servlets can be protected by com.ignore=.secure.filters..SecureFilter.servlet.TemporaryItems. axis. Input a blank list to allow any IP to access this servlet.servlet.allowed=127.liferay.0.0. main.hosts.hosts.1.litmus=false Set a list of files for the WebDAV servlet to ignore processing.Sp otlight-V100. tunnel.SERVER_IP tunnel..servlet..node=false WEBDAV Set the following to true to enable programmatic configuration to let the WebDAV be configured for litmus testing.servlet. 212 Advanced Liferay Configuration .SERVER_IP axis.Advanced Liferay Configuration web.https.display.0.servlet.https.https.0. json.1. webdav.allowed=127. This should never be set to true unless you are running the litmus tests.required=false SPRING REMOTING SERVLET See Main Servlet on how to protect this servlet.hosts.metadata_never_index.server..allowed= json.required=false AXIS SERVLET See Main Servlet on how to protect this servlet.required=false JSON TUNNEL SERVLET See Main Servlet on how to protect this servlet.DS_Store. webdav.servlet.servlet.servlet. Input a list of comma delimited IPs that can access this servlet. main.https.hosts..servlet.portal.allowed= Set the following to true if this servlet can only be accessed via https.required=false LIFERAY TUNNEL SERVLET See Main Servlet on how to protect this servlet.metadata_index_homes_only. SERVER_IP will be replaced with the IP of the host server.

email. admin. widget.names= The rest of these properties map to their values in the Admin portlet.role.enabled=true admin.added.tmpl admin.email.hosts.added.names=Power User\nUser Set up default user group names.host.user. admin.allowed=127.screen.default.password.subject=com/liferay/portlet/admin/dependencies/ema il_password_sent_subject.tmpl admin.from.tmpl Advanced Liferay Configuration 213 .https. All values should be separated by \n characters.required=false WIDGET SERVLET Set the servlet mapping for the widget servlet.password.reserved.required=false WEBDAV SERVLET See Main Servlet on how to protect this servlet.subject=com/liferay/portlet/admin/dependencies/email_ user_added_subject. these values will then already be set in the Admin portlet.from.password.address=test@liferay.names= admin.email. admin.name=Joe Bloggs admin.default.addresses= admin.enabled=true admin.sent.https.group.email.user.email.names= Set up default role names.mail.body=com/liferay/portlet/admin/dependencies/email_use r_added_body.tmpl admin.Advanced Liferay Configuration spring.servlet.servlet.email.email.group. webdav. The first time you bring up your portal.hosts.user.remoting.email.1.added.user.allowed= webdav. Set up default group names.sent.email.0.reserved.mapping=/widget ADMIN PORTLET You can set some administrative defaults by using these properties.servlet.remoting. admin.0.SERVER_IP spring.names= admin.servlet.sent.servlet.body=com/liferay/portlet/admin/dependencies/email_ password_sent_body.com admin.default.

comments.tmpl announcements.tmpl blogs. announcements.abstract.added.breakfast.subject=com/liferay/portlet/blogs/dependencies/em ail_comments_added_subject.comments.com announcements.subject=com/liferay/portlet/announcements/dependencies/e mail_subject.dinner.interval=5 CALENDAR PORTLET Set the list of event types.event.email.Advanced Liferay Configuration ANNOUNCEMENTS PORTLET Configure email notification settings.trackback.job.email.publisher.chat.properties.abstracts.email.to.trackback.happy- 214 Advanced Liferay Configuration .test Set the interval on which the CheckEntryJob will run. blogs.added.types=anniversary.added.entry.length=50 Set the interval on which the TrackbackVerifierJob will run.event.abstract.email.address=noreply@liferay.news.to.appointment.call.page.length=400 blogs.verifier. The display text of each of the event types is set in content/Language. The value is set in one minute increments.enabled=true blogs.entry.class.email.address=test@liferay.full-content BLOGS PORTLET The following properties affect the Blogs portlet.com announcements.title-list.check.properties. announcements.styles=table. The value is set in one minute increments.tmpl blogs.length=200 blogs.birthday.from.interval=15 ASSET PUBLISHER PORTLET Input a list of comma separated display styles that will be available in the configuration screen of Asset Publisher portlet.club-event.tmpl Set the list of announcement types.body=com/liferay/portlet/blogs/dependencies/email _comments_added_body. announcements.graduation.comments.name=Joe Bloggs announcements.name= announcements.email.email.types=general.email.body=com/liferay/portlet/announcements/dependencies/emai l_body. blogs.from. asset. calendar.display. The display text of each of the announcement types is set in content/Language.excerpt.email.bill-payment.rss.concert.

membership.press-release.hook.body=com/liferay/portlet/communities/de pendencies/email_membership_request_body.net-event.email.com calendar.email.enabled=true calendar.util.event.body=com/liferay/portlet/communities/dependencies/email_membership_reply_body.JCRHook com.impl=com.tmpl communities.tmpl communities.liferay.from.util.travel.address=test@liferay.liferay.party.documentlibrary. The document library server will use this to persist documents.email.holiday.name=Joe Bloggs communities. calendar.impl=com.documentlibrary.util.from.util. calendar.subject=com/liferay/portlet/communities /dependencies/email_membership_request_subject.email.reminder.other.liferay.S3Hook #dl.hook.documentlibrary.tmpl COMMUNITIES PORTLET Configure email notification settings.util.membership.email.from.AdvancedFileSystemHook dl.documentlibrary.body=com/liferay/portlet/calendar/dependencies/email_event_reminder_body. The value is set in one minute increments.liferay.documentlibrary.liferay.FileSystemHook #dl.S3Hook Advanced Liferay Configuration 215 .tvshow. communities.reply.liferay.interval=15 Configure email notification settings.hook.Advanced Liferay Configuration hour.sports-event.check.membership.email.lunch.reminder.impl=com.tmpl communities.documentlibrary.liferay.reply.address=test@liferay.performance.movie.FileSystemHook com.util.hook.com communities.impl=com.subject=com/liferay/portlet/communities/d ependencies/email_membership_reply_subject.event.JCRHook #dl.documentlibrary.documentlibrary.training.name=Joe Bloggs calendar.email.request.vacation.email.event.subject=com/liferay/portlet/calendar/dependencies/email_event_reminder_subject.liferay.reminder.Hook.interview.reunion. Available hooks are: ■ ■ ■ Examples: com.membership.tmpl calendar.email.util.email.from.tmpl DOCUMENT LIBRARY PORTLET Set the name of a class that implements com.request.meeting.util.event.email.wedding Set the interval on which the CheckEventJob will run.

access.. A value of 0 for the maximum file size can be used to indicate unlimited file size.file. then it is also possible to compare some binary files that are can be converted to text..s3. and ultimately. If OpenOffice integration is enabled.hook.size=3072000 A file extension of * will permit all file extensions.bucket.Public IMAGE GALLERY PORTLET Set the maximum file size and valid file extensions for images.sync..xml Set folder names that will be used to synchronize with a community's set of private and public layouts.jpg... A value of 0 for the maximum file size can be used to indicate unlimited file size.s3.lar.rtf.dot.css.doc..folder=Pages ..system.css. the maximum file size allowed is set in the property com..rtf. dl. However.portal.UploadServletRequestImpl.html. However.xls. via WebDAV.size=307200 #dl....private.doc.file..file.gif..od b...Private dl.js..tar..gz.enabled=false dl.upload.sxi.max.htm.home}/document_library S3HOOK dl..extensions=. For example.txt. This feature is experimental.odf.file.file.. the default image for the DOC extension would be found in: /html/themes/_unstyled/images/document_library/doc.js.swf..odg.. the maximum file size allowed is set in the property com.. The wildcard extension of * will be ignored.sync.sxw.htm.extensions=...size=1024000 dl.odp.file.name= Set the maximum file size and valid file extensions for documents.max.layouts.comparable..upload.comparable.Advanced Liferay Configuration FILESYSTEMHOOK dl.file.odt.key= dl.UploadServletRe- 216 Advanced Liferay Configuration .vsd.gif..max.liferay.portal..txt..ods.odt.zip Set which files extensions are comparable by the diff tool.hook..ppt.html.size.... .dir=${liferay.. You can map a GIF for the extension by adding the image to the theme's image display and document library folder.sxw.s3. Example File Extensions: dl.folder=Pages ..html.hook.tgz..xml #dl.png.....liferay.max.tif f.extensions=.layouts.css.. This will allow users to manage layouts using the Document Library portlet.hook.public.layouts.sync...pdf. dl.secret..htm.txt..sxc. Examples: #dl..key= dl.js.bmp.xml.root.

size=10240000 A file extension of * will permit all file extensions.image.email. journal.max.news.image. The display text of each of the article types is set in content/Language. ig.custom1.token.types=announcements. ig.png.general. journal.article.view.image.image. journal.thumbnail.tiff Set the maximum thumbnail height and width in pixels.recipients=20 invitation.tmpl JOURNAL PORTLET Set this to true if article ids should always be autogenerated. Advanced Liferay Configuration 217 .blogs.test Set the token used when inserting simple page breaks in articles.autogenerate.. journal.jpeg.id=true Set this to true so that only the latest version of an article that is also not approved can be saved without incrementing version.increment.message.press-release.body=com/liferay/portlet/invitation/dependencies/em ail_message_body.page.force.enabled=false Set this to true if feed ids should always be autogenerated. journal.gif.image.feed.force.article.id=false Set this to true if structure ids should always be autogenerated.size..max.max..email..check.dimension=100 #ig.version=false Set the list of article types.force.subject=com/liferay/portlet/invitation/dependencies/email_message_subject.max.jpg.dimension=0 INVITATION PORTLET invitation.extensions=.interval=15 Set this to true to check that a user has the VIEW permission on a Journal article when its content is rendered.max. The value is set in one minute increments.article..autogenerate.article.Advanced Liferay Configuration questImpl.custom2.check. ig.tif. journal.article.permission.tmpl invitation.email.max.properties.break=@page_break@ Set the interval on which the CheckArticleJob will run.. journal.message. Set dimension of the custom images to 0 to disable creating a scaled image of that size.dimension=150 #ig.article.bmp.

journal.1=production.name=Joe Bloggs journal. However.journal.com journal.listener=\ com.\ com.RegexTransformerListener for implementation details. journal.liferay.max.template.RegexTransformerListener.body=com/liferay/portlet/journal/dependencies/email_article_approval_denied_body.upload.email. 1..structure.portal.portlet. journal.portlet.com Set whether to synchronize content searches when server starts.size=51200 A file extension of * will permit all file extensions.variables=serviceLocator Set the maximum file size and valid file extensions for images.UploadServletRequestImpl.jpeg.journal.transformer.content.email.liferay.TransformerListener.sample.liferay.image.portlet.restricted.util.\ com.image. journal. journal.denied.article.portlet.portlet.force.util.email.util.template. etc.replacement.denied.regex.email.pattern.sample.journal.com #journal.liferay.address=test@liferay.ContentTransformerListener.enabled=false journal. These classes will run in sequence to allow you to modify the XML and XSL before it's transformed and allow you to modify the final output.png Input a list of comma delimited class names that extend com.util. journal.regex.\ com.0=production.approval.com #journal.tmpl journal.portlet.util.portlet.ViewCounterTransformerListener Enter a list of regular expression patterns and replacements that will be applied to outputted Journal content.sync. #journal.from.transformer.journal.startup=false Configure mail notification settings.search.replacement.max. A value of 0 for the maximum file size can be used to indicate unlimited file size. the maximum file size allowed is set in the property com.regex.denied.util.sample.com #journal.approval. The list of properties must end with a subsequent integer (0.size. See com.liferay.autogenerate.subject=com/liferay/portlet/journal/de pendencies/email_article_approval_denied_subject.journal.small.util.liferay.id=false Input a comma delimited list of variables which are restricted from the context in Velocity based Journal templates.util.article.\ com.liferay.gif.liferay.journal.article.sample.force.autogenerate.journal.velocity.\ #com.journal.LocaleTransformerListener.extensions=.PropertiesTransformerListener.Advanced Liferay Configuration journal.jpg.approval.1=staging.transformer.transformer.liferay.regex.email..0=beta. journal.from.TokensTransformerListener.tmpl 218 Advanced Liferay Configuration .pattern.) and it is assumed that the list has reached an end when the pattern or replacement is not set.transformer.portlet.id=false Set this to true if template ids should always be autogenerated..on.

email.message.articles.template.template.show.boards.search.email.email.approval.tmpl journal.portlet. message.email.prefix=com/liferay/portlet/messageboards/dependencies/email_message_added_subject_prefix.article. journal.listed=true MESSAGE BOARDS PORTLET Configure mail notification settings.boards.granted.JournalCreationStrategyImpl Specify the path to the template used for providing error messages on Journal templates.article.article.approval.article. journal.boards.tmpl journal.com message.100 JOURNAL CONTENT SEARCH PORTLET Set whether unlisted articles are excluded from search results.signature=com/liferay/portlet/message- Advanced Liferay Configuration 219 .format=true message.boards.email.body=com/liferay/portlet/journal/de pendencies/email_article_approval_requested_body.requested.approval.values=5.granted.enabled=false journal.subject=com/liferay/portlet/journal/d ependencies/email_article_approval_granted_subject.email.review.error.velocity=com/liferay/portlet/journal/dependencies/error.subject=com/liferay/portlet/journal /dependencies/email_article_approval_requested_subject.html.email.requested.tmpl journal.address=test@liferay.enabled=false journal.message.tmpl message.approval. Specify the strategy used when Journal content is imported using the LAR sys- journal.from.boards.lar.creation.tmpl journal.approval.body=com/liferay/portlet/messageboards/de pendencies/email_message_added_body.email.added.xsl JOURNAL ARTICLES PORTLET Set the available values for the number of articles to display per page.tmpl journal.page.content.enabled=false journal.article.liferay.requested.added.review.email.message.article.50.body=com/liferay/portlet/journal/dependencies/email_article_approval_granted_body.name=Joe Bloggs message.email.article.review.email.article.subject.lar.strategy=com.granted.vm journal.10.added.subject=com/liferay/portlet/journal/dependencies/email_article_review_subject.Advanced Liferay Configuration journal.article.delta.xsl=com/liferay/portlet/journal/dependencies/error.message.tmpl tem.approval.email.journal.enabled=true message.25.email.email.body=com/liferay/portlet/journal/dependencies/e mail_article_review_body.tmpl message.added.from.error.boards. journal.email.email.boards.

boards.private.email.enabled=true message.email.job.with.interval=120 Enter time in days to automatically expire bans on users.Advanced Liferay Configuration boards/dependencies/email_message_added_signature.community.abstract. If a user's ban is set to expire at 12:05 PM and the job runs at 2 PM.public.ban. if the maximum is set to 10. my.tmpl message. 220 Advanced Liferay Configuration .prefix=com/liferay/portlet/messageboards/dependencies/email_message_updated_subject_prefix.no. my.tmpl message. This value limits what goes in the RSS feed from the beginning of the message board post.sites.boards.ban.updated.no.public.places. my.updated.interval=10 message. and 10 communities will be shown.organization.tmpl message.updated. at most.tmpl Set this to true to allow anonymous posting.public. my.boards.boards.boards.with.subject. then.sites.boards.places. message.show.updated.signature=com/liferay/portlet/messageboards/dependencies/email_message_updated_signature.show.with.message.layouts=true Set this to true to show organization public sites with no layouts.no.places.boards.email.sites. message.with. Set to 0 to disable auto expire.length=200 MY PLACES PORTLET Set this to true to show user public sites with no layouts.layouts=true Set this to true to show user private sites with no layouts.sites.sites.layouts=true Set this to true to show community public sites with no layouts.expire.with.expire. For example.places.with. my.community.body=com/liferay/portlet/messageboards/ dependencies/email_message_updated_body. the expire will occur during the 2 PM run.show.anonymous. Examples: message.no. my.message.layouts=true Set this to true to show community private sites with no layouts.user.message.ban.message.layouts=true Set the maximum number of elements that will be shown in the My Places navigation menu.no.rss.email. message.show.show.interval=0 Enter rss feed abstract length.no.places.sites.boards.show.layouts=true Set this to true to show organization private sites with no layouts.private. The default is the first 200 characters. 1 personal community.expire.enabled=true Enter time in minutes on how often this job is run.posting.user.places.private. 10 organizations.organization.boards.

Advanced Liferay Configuration my.0.relative.places.true navigation.template. includedLayouts.show.cart.auto.template.0.1. shopping.multiple=true Set the following to true to forward to the cart page when adding an item from the category page.portlets. shopping.display. navigation.display.5.display.layout.unsupported=freeform.category.min.qty.cart=false Set the following to true to show special items when browsing a category.enabled=true SHOPPING PORTLET Set the following to true if cart quantities must be a multiple of the item's minimum quantity.css.true navigation.all.display.2.absolute.show.absolute.style[5]=none.absolute.to.max.portlets. nested.display. rootLayoutLevel.item.3.style.absolute. portlet. Disabling it can speed up performance.true navigation.2.auto. navigation.default=2_columns_i Add a comma separated list of layout template ids that should not be allowed in the Nested Portlets Portlet.display. and nestedChildren.1.style[4]=none.items=false Set the following to true to show availability when viewing an item. All items with dynamic fields will forward to the item's details page regardless of the following setting.1.layout.true NESTED PORTLETS PORTLET nested. shopping.true navigation.true navigation.auto.options=1.style[1]=breadcrumb.elements=10 NAVIGATION PORTLET Specify the options that will be provided to the user in the edit configuration mode of the portlet.auto.category.display.style[2]=root-layout.style[6]=none.absolute.1_column PORTLET CSS PORTLET Set this to true to enable the ability to modify portlet CSS at runtime via the Look and Feel icon.6 Define each mode with 4 comma delimited strings that represent the form: headerType. The item must not have dynamic fields.forward.special.auto.style[3]=root-layout. rootLayoutType.4.availability=true Advanced Liferay Configuration 221 . shopping.

max.. shopping.size=307200 sc.tmpl shopping.confirmation.Advanced Liferay Configuration Set the maximum file size and valid file extensions for images.UploadServletRequestImpl.enabled=true TAGS PORTLET Input a class name that implements com.util.name=Joe Bloggs shopping.UploadServletRequestImpl.image.tags.TagsAssetValidator. A value of 0 for the maximum file size can be used to indicate unlimited file size.png Configure email notification settings.subject=com/liferay/portlet/shopping/dependencies/email_order_shipping_subject. Disabling it can speed up performance. A value of 0 for the maximum file size can be used to indicate unlimited file size.liferay.email.gif.email.size. 222 Advanced Liferay Configuration .large.image. However.from.max.thumbnail.portal.order.extensions=.max.email.order.jpg.shipping.confirmation. shopping.image.confirmation. the maximum file size allowed is set in the property com.max.image.compiler.email.portlet.size.order.upload.small.tmpl shopping.email. However.image.jpeg.upload.com shopping.shipping.size=51200 shopping.email.max. The MinimalTagsAssetValidator requires all assets to have at least one tag entry.liferay.max.body=com/liferay/portlet/shopping/dependencies/email_order_shipping_body.portal.enabled=true shopping.size=153600 shopping.shipping.thumbnail.body=com/liferay/portlet/shopping/dependencies/email_order_confirmation_body. shopping.height=200 sc.max..order.medium.address=test@liferay. This class will be called to validate assets.email.max..order.tmpl SOFTWARE CATALOG PORTLET Set the maximum file size and max file dimensions for thumbnnails. sc.size=307200 A file extension of * will permit all file extensions.liferay.width=160 TAGS COMPILER PORTLET Set this to true to enable the ability to compile tags from the URL.enabled=true shopping. the maximum file size allowed is set in the property com. The DefaultTagsAssetValidator class is just an empty class that doesn't actually do any validation.image.image.from.tmpl shopping.subject=com/liferay/portlet/shopping/dependencies/email_order_confirmation_subject.order.email. tags.

util.stages=2 Specify the default role name for each stage of approval ordered from lowest level of approval to highest.default. Advanced Liferay Configuration 223 .front. wiki.liferay. Uncomment the regular expression below to allow only CamelCase titles.Advanced Liferay Configuration Examples: tags. It will be shown to the user when editing a page.syntax.role.url=http://wiki.initial.DefaultTagsAssetValidator #tags.tags.languages=en_es WIKI PORTLET Set the URL of a page that contains more information about the classic syntax of the wiki.classic.liferay. The name for the default page must be a valid wiki word.validator=com.default= Set the name of the default tag set where new tags are created by default.node.default=Default Tag Set TASKS PORTLET Specify the default number of approval stages.Community Owner TRANSLATOR PORTLET Set the default languages to translate a given text. translator.pl? WhatIsaWiki for more information on wiki naming conventions.usemod.vocabulary.com/index. By default only a few characters are forbidden.name=Main Set the following property to specify the requirments for the names of wiki pages.help.default.portlet.liferay. wiki.default. wiki.asset. Each item of the list should have the following format: 0:key:value tags.asset. tasks. tags. See http://www.validator=com.com/cgi-bin/wiki.tags. A wiki word follows the format of having an upper case letter followed by a series of lower case letters followed by another upper case letter and another series of lower case letters.portlet. These Roles must have the APPROVE_PROPOSAL permission.page.names=Community Administrator.MinimalTagsAssetValidator Input a list of comma delimited default properties for new tag entries. tasks.php/Wiki_Portlet Set the name of the default page for a wiki node.properties.util.name=FrontPage Set the name of the default node that will be automatically created when the Wiki portlet is first used in a community.

jsp wiki.configuration.engines.importers.page[creole]=/html/portlet/wiki/edit/wiki.jsp wiki.page[classic_wiki]=/html/portlet/wiki/edit/wiki.transform wiki.jsp wiki.configuration.HtmlEngine wiki.portlet.formats.url[classic_wiki]=http://wiki.formats.page[classic_wiki]=/html/portlet/wiki/help/classic_wiki. This regexp should remove any characters that are forbidden in the regexp specified in wiki.wikicreole.url[creole]=http://www.wiki.MediaWikiImporter Configure email notification settings.liferay.help.portlet.engine[creole]=com.formats.formats.wiki.formats.page. wiki.help.regexp=(((\\p{Lu}\\p{Ll}+)_?)+) Set the following property to specify the characters that will be automatically removed from the titles when importing wiki pages.regexp.engines.configuration.wiki.help.mediawiki.titles.com/index.wiki.regexp=([/\\[\\]%&?@]+) Set the list of supported wiki formats and the default wiki format.engines.wiki.page[MediaWiki]=/html/portlet/wiki/import/mediawiki.email.edit.page[plain_text]=/html/portlet/wiki/edit/plain_text.importers.engines.name=Joe Bloggs wiki.edit. wiki.main[classic_wiki]=wiki.portlet.page[html]=/html/portlet/wiki/edit/html.formats.engine[plain_text]=com.liferay.class[MediaWiki]=com.importers=MediaWiki Configure settings for each of the wiki importers.titles.page.formats.page[creole]=/html/portlet/wiki/help/creole.from.page. wiki.regexp=([^/\\[\\]%&?@]+) #wiki.portlet.liferay.Advanced Liferay Configuration wiki.formats=creole.engine[html]=com.edit. wiki.importers.titles. wiki.edit.remove.from.formats.0 wiki.formats.org/wiki/Creole1.page.TextEngine wiki.formats.default=creole Configure settings for each of the wiki formats.txt wiki.friki.jsp Set the list of supported wiki importers.help.js p wiki.formats.formats.engine[classic_wiki]=com.interwiki[classic_wiki]=intermap.formats.liferay.formats.address=test@liferay.liferay.com 224 Advanced Liferay Configuration .html wiki.jspwiki.properties wiki.FrikiEngine wiki.formats.liferay.formats.jsp wiki.php/Wiki_P ortlet wiki.jsp wiki.main[creole]=jspwiki.JSPWikiEngine wiki.portlet.titles.email. wiki.

hooks.page.subject.added. have become a Java standard which various portal server vendors have implemented. The heart of any portal implementation is its portlets. Plugins are an umbrella term for installable portlet.updated. theme. Though Liferay comes bundled with a number of functional portlets.page.tmpl wiki.rss. The container's job is to manage the portal's pages and to aggregate the set of portlets that are to appear on any particular page.email.page.email.updated. The choice is up to those designing the application. plugins provide a means of extending Liferay to be able to do almost anything. layout template.body=com/liferay/portlet/wiki/dependencies/email_page_ added_body.enabled=true wiki.war files.email. Portlets Portlets are small web applications that run in a portion of a web page. because all of the functionality of a portal resides in its portlets. A Java standard portlet should be deployable on any portlet container which supports the standard. and web module Java EE . Portal applications come generally in two flavors: 1) portlets can be written to provide small amounts of functionality and then aggregated by the portal server into a larger application.subject.email.updated.tmpl wiki. This means that certain “givens” that apply to servlet-based projects. because the portal server generates these objects dynamically.tmpl wiki.page.page. such as control over URLs or access to the HttpServletRequest object. The JSR-168 standard defines the portlet 1.tmpl wiki.prefix=com/liferay/portlet/wiki/dependencies/e mail_page_added_subject_prefix. This means that the core doesn't contain application code.length=200 Plugin Management One of the primary ways of extending the functionality of Liferay Portal is by the use of plugins. Portlets are placed on the page in a certain order by the end user and are served up dynamically by the portal server. Portlet applications. all of the features and functionality of your portal application must reside in its portlets. The developer only has to worry about what happens inside of the portlet itself.added.signature=com/liferay/portlet/wiki/dependencies/email_ page_added_signature. Instead.email. or 2) whole applications can be written to reside in only one or a few portlet windows.enabled=true wiki. layout templates.signature=com/liferay/portlet/wiki/dependencies/emai l_page_updated_signature.body=com/liferay/portlet/wiki/dependencies/email_pag e_updated_body.0 specification. don’t apply in portlet projects.page.page. Liferay's core is a portlet container. Plugin Management 225 . and web modules. and the JSR-286 standard defines the portlet 2.email.Advanced Liferay Configuration wiki.0 specification. the portal server handles building out the page as it is presented to the user.tmpl wiki. themes. hook.tmpl wiki.email.abstract.page.updated.prefix=com/liferay/portlet/wiki/dependencies/email_page_updated_subject_prefix. like servlet applications.added.email.added.

4. You cannot run Portlet 2.2. We have plenty of examples of this. developers are free to use all of the leading frameworks in the Java EE space. to see them. This allows developers familiar with those frameworks to more easily implement portlets. because those frameworks provide both functionality and structure to a project. You can use the Plugins SDK to deploy your PHP or Ruby application as a portlet. Most organizations have their own look and feel standards which go across all of the web sites and web applications in the infrastructure. but because the Portlet 2. With Liferay.0 standard: JSR-286. instead of using Liferay's built-in Stocks portlet. There are lots of available theme plugins on Liferay's web site.0 portlets in Liferay 4. and it will run seamlessly inside of Liferay. communities. and Java Server Faces. Struts enforces the Model-View-Controller design pattern and provides lots of functionality—such as custom tags and form validation—that make it easier for a developer to implement certain standard features. For example. There is more about theme development in the Liferay Developer's Guide. security. This is much easier than starting a theme from scratch.” so you do not need to be a Java developer in order to take advantage of Liferay's built-in features (such as user management. check out the Plugins SDK from Liferay's public code repository.Advanced Liferay Configuration Tip: Liferay 4.0 standard is backwards-compatible. and then they can take advantage of the layout. Do you subscribe to a stock service? You could pull stock quotes from that service and display them on your page. Liferay allows for the consuming of PHP and Ruby applications as “portlets. Spring. allowing for the complete transformation of the portal to whatever look and feel is needed. Most developers nowadays like to use certain frameworks to develop their applications. portlets written to the 1. Liferay makes it possible for a site designer to create a theme plugin which can then be installed. Additionally. including Struts. page building and content management).0 standard: JSR-168. and administration infrastructure that Liferay provides. 226 Plugin Management . Liferay 5.4. Do you have existing Struts. as you can now choose a theme which most closely resembles what you want to do and then customize it. and more are being added every day.0 standard will run in Liferay 5. Do you have a need to combine the functionality of two or more servlet-based applications on one page? You could make them into portlet plugins and have Liferay display them in whatever layout you want. Themes Themes are hot deployable plugins which can completely transform the look and feel of the portal.x and above. or JSF applications that you want to integrate with your portal? It is a straightforward task to migrate these applications into Liferay.0 and above support the Portlet 2. Spring MVC. This makes it easier for those who wish to develop themes for Liferay.2 and below support the Portlet 1. and also facilitates the quick porting of an application using those frameworks over to a portlet implementation. Does your organization make use of any Enterprise Planning (ERP) software that exposes its data via web services? You could write a portlet plugin for Liferay that can consume that data and display it as part of a dashboard page for your users.

This is covered in the Liferay Developer's Guide. You can hook into the eventing system. Liferay Portal comes with several built-in layout templates. you may wish to create a custom layout template of your own. As the name implies. Hooks are very powerful and have been designed to replace some of the reasons for using the extension environment with something that is easier to use and hot deployable. Web Plugins Web plugins are regular Java EE web modules that are designed to work with Liferay. but if you have a complex page layout (especially for your home page). Layout Templates Layout Templates are ways of choosing how your portlets will be arranged on a page.Advanced Liferay Configuration Illustration 66: Fruitopia theme from Liferay's theme repository. the large area where you drag and drop your portlets to create your pages. workflow engines and so on. Hook Plugins Hook plugins are new to Liferay 5. Liferay supports integration with various Enterprise Service Bus (ESB) implementations.2. These are implemented as web modules that are used by Liferay portlets to provide functionality. Illustration 67: Blue Pigment theme from Liferay's theme repository. they allow “hooking” into Liferay's core functionality. as well as Single Sign-On implementations. Plugin Management 227 . and portal properties. They make up the body of your page. You can also override Liferay's core JSPs with your own. model listeners. This means that they enable developers to override or replace functionality that is in the core of the system.

You should now see the screen which allows you to configure and install portlets. whether it is active. by tag. and you will see it in most of Liferay's portlets. or by 228 Plugin Management . The default look of the Plugin Installer shows which plugins are already installed on the system. Go to the Dock and select Control Panel. Note that the list displayed is a list of all of the plugins that are available across all of the repositories to which the server is subscribed. a new view appears. by whether they are installed. select Plugins Installation. From the initial page you can navigate to the different pages of plugins. you will need to download the plugins from the site and install them manually. If the machine does not have access to the Internet. which is in the Server category. where [Plugin Type] changes based on which tab you are viewing. and by default. Above this is a search mechanism which allows you to search for plugins by their name. as they are all in alphabetical order. you can do so by clicking the Install More [Plugin Type] button. displays the Portlet Plugins tab. You can also change the number of items per page and navigate to a specific page if you know where a particular plugin appears in the list. Illustration 68: Plugins Installation in the Control Panel If you would like to see what plugins are available. After the Install More [Plugin Type] button is clicked.Advanced Liferay Configuration Installing Plugins from Repositories Liferay Portal has a section of the Control Panel which can handle plugin installation: Plugins Installation. In the Server category. Please note that the machine upon which Liferay is running must have access to the Internet in order to be able to read the Official and Community repositories. We will discuss how to do this later in this chapter. and what Portal roles have access to it. This is a standard feature of Liferay. This view has multiple tabs. but also it enables you to run the search indexer on those portlets that support it and install new portlets. This not only allows you to see what plugins are installed in your portal.

Click this button to install your plugin. click on its name. you can view the deployment as it happens. Illustration 70: Adding the Weather Portlet to Liferay The plugin chosen will be automatically downloaded and installed on your instance of Liferay. Below the description is an Install button. choose the plugin by clicking on its name.Advanced Liferay Configuration which repository they are in. you should be able to go back to the Add ApplicaPlugin Management 229 . Once you have found it. For example. If you have the Liferay console open. Find the Weather Portlet in the list by searching for it or browsing to it. Illustration 69: Installing Plugins To install a plugin. you might want to install the Weather portlet. When it is finished. if you want to provide a handy weather forecast to your web site. Another page will be displayed which describes the portlet plugin in more detail. This portlet provides a handy interface to which shows the current weather for a particular zip code which your users can customize.

it will be available on the Look and Feel tab in the page definition.war you have downloaded. you do not want to allow portal administrators to install plugins from the Internet before they are evaluated. This folder generally resides one directory up from where your application server is installed. If your server is firewalled. it will create a folder structure in Liferay Home to house various configuration and administrative data. You are installing portlets which you have either purchased from a vendor. Layout Templates. the default context defined in the plugin (or the . You can still use the Control Panel to install plugins that are not available from the on line repositories. The other field on the page is optional: you can specify your own context for deployment. Installing Plugins Manually Installing plugins manually is almost as easy as installing plugins via the Plugin Installer. For security reasons. downloaded separately. This makes it impossible for your instance of Liferay to connect to the plugin repositories. If it is a portlet. This is by far the easiest way to install plugins. you will not see any plugins displayed in the Portlet Plugins tab or in the Theme Plugins tab. please see the section on your server in Chapter 1. theme. you can also deploy them at the operating system level. the theme becomes available on the Look and Feel tab of any page. There are several scenarios in which you would need to install plugins manually rather than from Liferay's repositories: ● ● ● Your server is firewalled without access to the Internet. you would use the appropriate tab for the type of plugin you wish to install to view the list of plugins of that type. or developed yourself. you will need to click the Upload File tab. Instead of the Portlet Plugins tab. To find out where the Liferay Home folder is for your application server. The same procedure is used for installing new Liferay Themes. If you copy a 230 Plugin Management .Advanced Liferay Configuration tion window and add your new plugin to a page in your portal. hooks.war file containing a plugin to your Liferay Portal. Click the Install button. This gives you a simple interface for uploading a .war file name itself) will be used. After clicking on the Install button for a theme. Click the Browse button and navigate your file system to find the portlet or theme . If it is a theme. or web module. you should see it in the Add Content window. hook. though it sometimes is elsewhere depending on which application server you are running. Instead. That's all the information the Plugin Installer needs in order to deploy your portlet. convenient thumbnails (plus a larger version when you click on the details of a particular theme) are shown in the list. If you do not wish to use the Update Manager or Plugin Installer to deploy plugins. The first time Liferay is launched. layout template. The first time Liferay starts. and your plugin will be uploaded to the server and deployed. If you leave this field blank. For themes. and web modules. it creates a hot deploy folder which is by default created inside the Liferay Home folder. One of the folders it creates is called deploy.

450 INFO 5.1.27/temp/6-webform-portlet/WEB-INF/classes/portlet.5. Please see the above section on the portal-ext. There are different reasons Plugin Management 231 .war Expanding: /opt/liferay/liferay-portal-5.5. In fact.27/webapps/ web-form-portlet Deleting directory /opt/liferay/liferay-portal-5.993 INFO web-form-portlet [PortletHotDeployListener:333] Unregistering portlets for 16:16:28.2.2.startup.Advanced Liferay Configuration portlet or theme plugin into this folder. your plugin was installed correctly.HostConfig checkResources INFO: Undeploying context [/web-form-portlet] 16:16:28.2.2. Liferay will deploy it and make it available for use just as though you'd installed it via the Plugin Installer in the Control Panel.27/temp/20090423161619617 Copying 1 file to /opt/liferay/liferay-portal-5.2.war into /opt/liferay/liferay-portal-5.properties file for more information.2/deploy/web-form-portlet5.2.27/webapps/web-form-portlet Copying 1 file to /opt/liferay/liferay-portal-5.2/tomcat5.5.2/deploy/web-form-portlet-5.2.5.5.2.5.2. this is what the Plugin Installer is doing behind the scenes. copy the plugin into your hot deploy folder.properties 16:16:28.570 INFO [PortletHotDeployListener:298] 1 portlet for web-formportlet is available for use As long as you see the available for use message. You can change the defaults for this directory structure so that it is stored anywhere you like by modifying the appropriate properties in your portal-ext. Plugin Troubleshooting Sometimes for various reasons plugins fail to install.catalina.2.5.1.27/temp/20090423161619617/WEB-INF Copying 1 file to /opt/liferay/liferay-portal-5.2. which by default is in [Liferay Home]/deploy.2.2.27/temp/20090423161619617/META-INF Copying 38 files to /opt/liferay/liferay-portal-5.5.2/tomcat5. you should see messages like the following: 16:16:19.000 INFO [PortletHotDeployListener:362] 1 portlet for web-formportlet was unregistered Apr 23. To have Liferay hot deploy a portlet or theme plugin.1. Deployment will start in a few seconds.2/tomcat5.27/temp/20090423161619617/WEB-INF/classes Copying 1 file to /opt/liferay/liferay-portal-5.2/tomcat-5.2/tomcat5.war [AutoDeployDir:183] Processing web-form-portlet- 16:16:19.2.27/temp/20090423161619617/WEB-INF/classes Copying 1 file to /opt/liferay/liferay-portal-5.2/tomcat5.2/tomcat5.1.war copied successfully.2/deploy/web-form-portlet-5.2.2/tomcat-5..properties file.452 INFO [PortletAutoDeployListener:77] Copying portlets for /opt/ liferay/liferay-portal-5.2. and will be available for use in the portal. If you are watching the Liferay console.5.27/temp/20090423161619617 16:16:20.2.2. 2009 4:16:27 PM org.925 INFO [PortletAutoDeployListener:87] Portlets for /opt/liferay/ liferay-portal-5.apache. 16:16:27.2.408 INFO web-form-portlet [PortletHotDeployListener:219] Registering portlets for Loading file:/opt/liferay/liferay-portal-5.2.2/tomcat5.

but will not work for other containers that define their hot deploy folders in a different place. this is in <Glassfish Home>/domains/domain1/autodeploy. By default. you have an issue with your plugin deployment configuration. You will first need to determine where the hot deploy folder is for the container you are running. For example./webapps.5. and it is likely one of the factors above. this is in <Bea Home>/user_projects/domains/<domain name>/ autodeploy. Glassfish defines the hot deploy folder as a folder called autodeploy inside of the domain folder in which your server is running. Liferay versions above 4.Advanced Liferay Configuration for this based on several factors. Though every effort has been made to make the .war file.war file as generic as possible.. Once you have this value. which makes things a lot easier. JBoss defines the hot deploy folder as a root folder inside of the particular server configuration you are using. sometimes the default settings are inappropriate for the container upon which Liferay is running. Liferay by default comes as a bundle or as a . If this message is not followed up by an available for use message. By default. By default. WebLogic defines this folder inside of the domain directory. Consult your product documentation for this. including ● ● ● ● Liferay configuration The container upon which Liferay is running Changing the configuration options in multiple places How Liferay is being launched You will often be able to tell if you have a plugin deployment problem by looking at the Liferay server console.3.3.dest.5 with the addition of code that allows Liferay to determine which application server it is running on and adjust the way it deploys plugins as a result. there are two places in which you can set it: the portal-ext. If you are running a newer version of Liferay.3. you can skip this section.3. LIFERAY CONFIGURATION ISSUES Tip: This applies to Liferay versions prior to version 4. This default value works for Tomcat containers (if Tomcat has been launched from its bin folder). We will look at each of these factors.dir that defines the folder where plugins are deployed after the hot deploy utilities have finished preparing them. By default. If you see the plugin get recognized by the hot deploy listener. Most of these problems have been resolved in Liferay 4. this property is set to .5.deploy. This folder maps to a folder that the container defines as an auto-deploy or a hot deploy folder. you will see a plugin copied successfully message. this is in <JBoss Home>/server/default/deploy.properties file and in 232 Plugin Management . there is a property called auto.5 are able to auto detect the type of server it is running on. In versions of Liferay prior to 4.

Now plugins should install correctly. and you have the server installed in /java/glassfish. Here you will find the portal-ext. browse to where Liferay was deployed in your application server. your auto.deploy. including the default folders for hot deploy.dest. If you are having hot deploy trouble in Liferay versions 4.dest. Illustration 71: Changing the hot deploy destination directory The setting to change is the field marked Destination Directory.dir=/java/glassfish/domains/domain1/autodeploy Remember. Inside of this folder should be a WEB-INF/classes folder. click the Save button at the bottom of the form.dir to the customized folder location as you would with older versions of Liferay. Liferay is able to pick up the portlet plugins once they get deployed to the container manually. use forward slashes instead of back slashes. such as Oracle Application Server® and WebSphere®. But this does not mean that you cannot install plugins on these containers.3. For example. if you are on a Windows system. THE CONTAINER UPON WHICH LIFERAY IS RUNNING There are some containers. If you would rather change this setting via the Plugin Installer portlet (because you do not wish to restart your container).deploy. especially if you add it to the same Enterprise Plugin Management 233 . if you are using Glassfish.properties file. these containers do not work with Liferay's hot deploy system. Unfortunately.dest. When you are finished.dir.dir=C:/java/glassfish/domains/domain1/autodeploy Save the file and then restart your container.properties file.deploy. you would want to set auto. you can add it. but is blank. it is possible that the administrator of your application server has changed the default folder for auto deploy in your application server. Add the property to your portal-ext.properties file and set its value to the fully qualified path to the auto deploy folder configured in your application server. In Liferay 4. The setting will now take effect without your having to restart your container. this setting still exists. To change this setting in the portal-ext. If it does not appear in the file. The safest way to set this property—as we will see later—is to define the property using an absolute path from the root of your file system to your application server's hot deploy folder.dest. where Liferay should look for plugin repositories.Advanced Liferay Configuration the Plugin Installer portlet. In this case.dir property would look like the following: auto. which do not have a hot deploy feature. and so on. you can do that by clicking on the Configuration tab. Note that the setting in the portlet overrides the setting in the properties file.deploy.3. like so: auto. You can deploy plugins manually using the application server's deployment tools.5 and greater.5 and greater.dest. Change this to the full path to your container's auto deploy folder from the root of your file system.deploy. On this page are a number of settings you can change. Open this file in a text editor and look for the property auto.

PortletDeploymentEnabled</param-name> <param-value>false</param-value> </context-param> Liferay versions 5.deploy. and then copy the result into the destination directory you have configured.war files into your auto deploy directory. Make sure the web. click Save.war files copied after they are processed by Liferay's plugin installer process. Deploy your . we need to separate these two steps. You will use this as a staging directory for your plugins before you install them manually with your server's deployment tools. When you are finished. 4. Create a folder called websphere-deploy inside your $LIFERAY_HOME folder. 5. because Liferay can make the modifications and then copy the resulting . Jackrabbit config.home}/websphere-deploy 2. it sometimes makes modifications to those files right before deployment. Liferay will make its modifications and because we changed the auto. If you don't have one already. and deploy folders are. The WebSphere deploy occurs in two steps.war files.dir in the first step. This is because Liferay makes deployment-time modifications to the plugins right before they are actually deployed to the application server. and then use WebSphere's tools to do the actual deployment. Now you can deploy plugins using the Plugin Installer portlet or by dropping . 3. You will first use Liferay's tools to “pre-deploy” the file.ibm. The second-most field on the form is labeled Destination Directory. click the Configuration tab.war file using Liferay's Plugin Installer or by copying it into $LIFERAY_HOME/deploy. In order to successfully deploy plugins using an application server vendor's tools. EXAMPLE: WEBSPHERE® APPLICATION SERVER 1.xml file on WebSphere containers.xml file inside the plugin you want to install has the following context parameter in it: <context-param> <param-name>com. this can usually be done in one step. it will copy the 234 Plugin Management .dir=${liferay. You may then deploy them from here to your application server. Place the path to which you would like plugin .dest. When Liferay hot deploys portlet and theme . For other application servers.deploy. Because WebSphere does not have an autodeploy feature.2 and higher will automatically inject this into the web. This is the folder where the Lucene index.Advanced Liferay Configuration Application project that was created for Liferay. Add the following directive to it: auto. create a portal-ext.portletcontainer. modify them.websphere.2.properties file in the Liferay Home folder of your Liferay installation. Liferay will pick up the files. you will want to run your plugins through this process before you attempt to deploy them. In the Plugin Installer section of the Control Panel.war file into an autodeploy folder to have it actually deployed.dest.

3. and then the path separator (/)..5.. Liferay versions above 4. the default value of the hot deploy destination directory is a relative path (e. Once the . You will see that your portlet is deployed. Tomcat has the pictured directory structure.g. The portlet will be automatically started and registered upon subsequent restarts of WebSphere. /my-first-portlet).3. the hot deploy destination directory is relative to the folder from which the application server was launched. This folder is on the same level the bin folder is on.. 7. Experienced WebSphere system administrators can further automate this by writing a script which watches the websphere-deploy directory and uses wsadmin commands to then deploy plugins automatically.. plugin deployment will start working again.properties file and in the Control Panel. Start it. Make the context root for the . So in the default configuration. especially during development when several people have administrative access to the server at the same time. Plugin Management 235 . but not yet started. In versions of Liferay prior to 4./server/default/deploy). . For example.e. the value in the Control Panel takes precedence over the value in the properties file. save it to the master configuration. and then the name of the folder (webapps). to get to a file in the hot deploy folder you would reference it by using two dots to go back up one folder. you would normally go into the bin folder to run the startup script which starts Liferay running in Tomcat.war file is deployed. If this happens. 8. 6. HOW LIFERAY IS BEING LAUNCHED Tip: This applies to Liferay versions prior to version 4. Use WebSphere's tools to deploy the .3. If you go into the Control Panel and change the value to the correct setting. Tomcat's hot deploy folder is the webapps folder. This path is relative to the folder from which the application server is normally launched.war file equal to the file name (i. You will see a copied successfully message in the log.war file.5. the auto deploy folder location can get customized in both the portal-ext. So to start Tomcat.Advanced Liferay Configuration resulting . Liferay will immediately recognize that the portlet has been deployed and register it./webapps or .war file into $LIFERAY_HOME/websphere-deploy.5 are able to auto detect the type of server it is running on. and this property is no longer detected via the relative path from the server launch location. If you are at the command prompt inside of the bin folder (where you started Tomcat). CHANGING THE CONFIGURATION OPTIONS IN MULTIPLE PLACES Sometimes. The start up and shut down scripts are in the bin folder. Go back to the Applications -> Enterprise Applications screen in the WebSphere Admin Console.

Instead. you may wish to create a plugin repository for your own products. Creating Your Own Plugin Repository As your enterprise builds its own library of portlets for internal use. If you make this file available on an HTTP server (it can be the same one upon which the plugins are stored. <Tomcat Home>/bin). the path will be relative to the path from which you launched the startup script. Both methods have their benefits. They can then register their plugins with the repository by adding a link to it via the Control Panel's graphical user interface. and the URL to it can be added to the Plugin Installer. 2. The first method allows users to upload their plugins to an HTTP server to which they have access. We will first look at creating a plugin repository using the Software Catalog in the Control Panel. you can create your own plugin repository to make it easy to install and upgrade portlets. but you will never see the registered successfully message. or 2) Change the way you launch Liferay by making sure you go into the folder where the application server's startup scripts are before you launch them. 236 Plugin Management .Advanced Liferay Configuration If you are launching your application server from another script—perhaps as part of a cron job—and your script does not enter the folder the application server's startup scripts are in (in this case. the relative path that is set by default will not work. and then create an XML file called liferay-plugin-repository. This will cause Liferay to create—in the Tomcat example —a webapps folder one folder up from where the startup script was launched. You can create your plugin repository in two ways: 1.xml manually. The second method does not require an instance of Liferay to be running. you can do one of two things: 1) Change the relative path to an absolute path as recommended above. you can connect the repository to a Plugin Installer in the Control Panel running on an instance of Liferay. making the portlets in this repository available to the server running Liferay. or a different one altogether).com/dtd/liferay-plugin-repository_5_2_0. Since this is not the correct hot deploy folder for your application server. This will allow different departments who may be running different instances of Liferay to share portlets and install them as needed. If you are a software development house. you will see the copied successfully message in the server console. Create an XML file using the Liferay Plugin Repository DTD (http://www.liferay. To fix this. You can upload plugins to an HTTP server of your choice. Either one of these methods should fix your hot deploy problem and will result in the successful deployment of portlet and theme plugins. Use the Software Catalog in the Control Panel to create the repository by using its graphical interface and an HTTP server. Liferay makes it easy for you to create your own plugin repository and make it available to others.dtd) and an HTTP server. This XML file can then be placed on an HTTP server. Liferay will then generate the XML necessary to connect the repository to a Control Panel running on another instance of Liferay.

” where [Organization/Community] is the organization or community you were on when you selected the Control Panel from the Dock. The Software Catalog has several tabs. as the portal administrator. If you want to administer the software catalog for a different community or organization. you can select it from the selection box. This can be seen in the version on Liferay's home page. so you can host several software repositories on the same instance of Liferay if you wish—they just have to be in different communities or organizations. To implement this. when populated with software. you have decided to make it available in your own software catalog. displays what plugins are available for install or download. Plugin Management 237 . The default view of the portlet. Each community in your portal can have an instance of the Software Catalog. and if you don't want to worry about creating the liferay-plugin-repository. picture. The Control Panel will keep track of which community or organization you are in and present you with the software catalog for that community or organization. Because this portlet is generic enough that it could be useful to anyone using Liferay. This means that different communities/organizations can have different software repositories. have created a community called Old Computers. You will see at the top of the screen a message that says “Content for [Organization/Community]. and description from his or her user profile. The first tab is labeled Products. Users who participate in the site will eventually get upgraded to a more privileged status and get their own blog page. Assume you.xml file yourself. Illustration 72: Software Catalog with no products Choose the community that will host the plugin repository and go to the Control Panel. This community will be a web site for users to collaborate on setting up and using old computers with obsolete hardware and operating systems. you have created a My Summary portlet which displays the user's name.Advanced Liferay Configuration THE SOFTWARE CATALOG You will want to use the Software Catalog if you will have multiple users submitting portlets into the repository. We will use an example community in order to better illustrate how to use the Software Catalog portlet.

or recommended. In the example above. you can begin adding software products to your software catalog. Once you have at least one license in the system. Fill out the form with information about 238 Plugin Management . click the Products tab. Your license will be saved. the Old Computers site is on the Internet. and then click the Add Product button.war file containing your software on a web server that is accessible without authentication to the users who will be installing your software. a URL pointing to the actual license document. and check boxes denoting whether the license is open source. You will first need to put the . Click the Licenses tab and then click the Add License button that appears. You will then see a form which allows you to enter the title of your license. When you have finished filling out the form. and then click the Add Product button. If you are creating a software catalog for an internal Intranet. This will register the product in the software catalog and allow you to start adding versions of your software for users to download and / or install directly from their instances of Liferay. click the Save button. active. Click the Products tab. you would place the file on a web server that is available to anyone inside of your organization's firewall.com The first step in adding a plugin to your software repository is to add a license for your product.Advanced Liferay Configuration Illustration 73: Populated Software Catalog from liferay. To create the product record in the Software Catalog portlet. Your next step will be to create the product record in the software catalog. so you would place the file on a web server that is accessible to anyone on the Internet. A license communicates to users the terms upon which you are allowing them to download and use your software.

Tags: Enter any tags you would like added to this software. This will be displayed in the summary table of your software catalog. hook. Plugin Management 239 . Author: Enter the name of the author of the software. Licenses: Select the license(s) under which you are releasing this software. or web plugin. Page URL: If the software has a home page. Illustration 74: Adding a product to the Software Catalog (partial view) Name: The name of your software product.Advanced Liferay Configuration your product. theme. Type: Select whether this is a portlet. layout template. enter its url here. Short Description: Enter a short description.

This is because there are not yet any released versions of your product. When you have finished filling out the form. Artifact ID: Enter an Artifact ID. however. Why is this so important? Because as Liferay gains more and more features. You will be brought back to the product summary page. Illustration 75: Product has been added to the Software Catalog Notice that in the version column. which makes use of the many social networking fea- 240 Plugin Management . Screenshot: Click the Add Screenshot button to add a screen shot of your product for users to view. and you will see that your product has been added to the repository. N/A is being displayed. The artifact ID is a unique name within the name space for your product. You cannot add a version of your product without linking it to a version of the framework for which it is designed. Before you do that. For version 5.1. A group ID is a name space which usually identifies the company or organization that made the software. you need to create a version of your product and point it to the file you uploaded to your HTTP server earlier. For our example. however. which does exactly what we have described here. this portlet was replaced by the World of Liferay (WOL) portlet. while still keeping older versions of your product available for those who are using older versions of Liferay. you may wish to take advantage of those features in future versions of your product.Advanced Liferay Configuration Long Description: Enter a longer description. Group ID: Enter a group ID. Permissions: Click the Configure link to set permissions for this software product. This will be displayed on the details page for this software product. we will use old-computers. click the Save button. This is perfectly illustrated in the example My Summary portlet we are using. Liferay had a My Summary portlet of its own. To make your product downloadable. you need to add a Framework Version to your software catalog. A Framework version denotes what version of Liferay your plugin is designed for and works on. For our example. we will use my-summary-portlet.

the ability to become “friends” with other users—thereby granting them access to their profiles—and more. because our portlet should work on that version and higher. For version 5. the WOL portlet adds features such as status updates. you will see the WOL portlet.com for the URL. Illustration 76: Adding a product version to the Software Catalog Plugin Management 241 . Click Save. Now go back to the Products tab and click on your product.1. the WOL portlet itself has been broken down so that the social components can be installed separately from the software management components. make the WOL portlets available to those who are using 5. because the core engine that enables developers to create features like this is not there.2 version.liferay. You will notice that a message is displayed stating that the product does not have any released versions.Advanced Liferay Configuration tures which have been added to Liferay. If you connect to Liferay's software repositories with a Liferay 5.2. If you connect to Liferay's software repositories with a Liferay 5. you would want to keep the older My Summary portlet available for users who have not yet upgraded. For our example. ton. and make the newer social portlets available to those using latest version of Liferay.2. and http://www. and leave the Active check box checked. So in this case. a “wall” for each user in his or her profile that other users can “write” on.2 version. This is what Framework Versions does for you. So rather than just displaying a summary of your information. you will see the social portlets. we have entered 5. Click the Add Product Version button.1 version.x. If you connect to Liferay's software repositories with a Liferay 4.4. So click the Framework Versions tab and then click the Add Framework Version but- Give the framework a name. a URL. None of this would work in older versions of Liferay. you will see the My Summary portlet.2 for the name.

the default community.Advanced Liferay Configuration Version Name: Enter the version of your product. which is called guest. you can use the friendly URL. Obviously. Next. it is much easier if you are using Friendly URLs. If not. the Plugin Installer knows where it can download the plugins from. select yes here. Supported Framework Versions: Select the framework version for which your software product is intended. and all other data about the plugins that have been entered into the Software Catalog portlet. go to your browser and go to the following URL: http://<server name>:<port number>/software_catalog?<Friendly URL name or Group ID> For example. you will first need to know the Group ID of the community in which your Software Catalog portlet resides. and that instance is running on port 8080. Download Page URL: If your product has a descriptive web page. if you are on the same machine as your Liferay instance. Using the data from this XML document. Enter a + at the end of the version number if you want to specify a version plus any future versions. you would use the following URL: 242 Plugin Management . The URL will look something like this: http://localhost:8080/web/10148/1. you will need to access a particular URL. GENERATING THE SOFTWARE CATALOG The Software Catalog works by generating an XML document which the Plugin Installer reads. Your product version will be saved. has a friendly URL of /guest already configured for it). and your group ID from the database is 10148. what version of Liferay the plugins are designed for. In order to get your Software Catalog to generate this XML data. and your product will now be available in the software repository. you would use the following URL: http://localhost:8080/software_catalog?10148 If you have also created a friendly URL called old-computers for this organization or community. Change Log: Enter some comments regarding what changed between this version and any previous versions. Direct Download URL (Recommended): Enter a direct download link to your software product here. enter its URL here. click the Save button. You can do this by accessing the Manage Pages interface and looking at the URLs for any of the pages. When you are finished filling out the form. If you have created a friendly URL for your community (for example. The Plugin Installer portlet will follow this link in order to download your software product. and we highly recommend that you do. Include Artifact in Repository: To enable others to use the Plugin Installer portlet to connect to your repository and download your plugin.

you make available to your users a standard interface for manually downloading your software. the Software Catalog makes it easy for you to create a repository of your software. Another benefit of the Software Catalog is that by using it. 23 Apr 2009 20:40:16 +0000</modified-date> <types> <type>portlet</type> </types> <tags> <tag>social</tag> <tag>profile</tag> </tags> <short-description>My Summary</short-description> <long-description>My Summary</long-description> <change-log>Initial Version</change-log> <download-url>http://www. your Software Catalog gives them an interface to go in.liferay.2. BENEFITS OF THE SOFTWARE CATALOG As you can see. This is by far the easiest way for you to keep track of your software.xml and put this file on your HTTP server where you uploaded your portlet .2.0/war</module-id> <modified-date>Thu.com/portlets/my-summary-portlet5. You can then give out the URL to the directory which holds this file on your web site.0" encoding="UTF-8"?> <plugin-repository> <settings/> <plugin-package> <name>My Summary</name> <module-id>old-computers/my-summary-portlet/1. preview screen Plugin Management 243 .war </download-url> <author>Rich Sezov</author> <screenshots/> <licenses> <license osi-approved="true">MIT License</license> </licenses> <liferay-versions/> </plugin-package> </plugin-repository> Save this document to a file called liferay-plugin-package. and the proper versions of your software will be automatically made available to them by a single click.Advanced Liferay Configuration http://localhost:8080/software_catalog?old-computers If you have configured everything properly. and for your users to obtain your software. find your software either by browsing or by searching. Users of Liferay can configure their Plugin Installers to attach to your repository. For those who prefer to manually download plugins. and anyone with an instance of Liferay will be able to point their Plugin Installer portlets to it. an XML document should be returned: <?xml version="1.war file.

some of them will have to download it manually. Enter the URL to the repository to which you wish to connect in one of the fields and click Save. the only difference between the two is to provide a visual cue for administrators as to which repositories are trusted and untrusted. Note that if you do this. This utility is further explained in the Liferay Developer's Guide. and are generated in the same step. The portlet will connect to the repository. all you need is the URL to the catalog. You can add it to any page on your web site through the Add Application menu. Once you have the URL.dtd. but also for web services and JavaScript. and download your software—and you don't have to build any of those pages yourself. It is a file called liferay-plugin-package_5_2_0. CONNECTING TO A SOFTWARE CATALOG If there is a software catalog of plugins that you would like to point your instance of Liferay to. obtain the DTD for the XML file from Liferay's source code. In this case. You will see that there are two fields in which you can enter URLs to plugin repositories: Trusted Plugin Repositories and Untrusted Plugin Repositories.Advanced Liferay Configuration shots. Because of this. Currently. Liferay Services Oriented Architecture Liferay includes a utility called the Service Builder which is used to generate all of the low level code for accessing resources from the portal database. Keep in mind that many instances of Liferay Portal sit behind a firewall without access to the Internet. To manually create a software catalog. but it is mentioned here because of its feature which generates interfaces not only for Java code. and items from this repository will be shown in the list. free choice is JEdit with all the XML plugins) to create your software catalog manually. How can you do this? The Software Catalog is also available as a portlet. You will find this DTD in the definitions folder in the Liferay source. MANUALLY CREATING A SOFTWARE CATALOG If you do not wish to use the Control Panel to create your software catalog. you can. Use this DTD with a validating XML editor (a good. This means that the method calls for storing and retrieving portal objects are all the same. If you still wish to use a text editor to create your software catalog. you can create it manually by manually typing out the XML file that the Software Catalog section of the Control Panel would normally generate. go to the Plugin Installer in your Control Panel and click the Configuration tab. You will find the portlet in the Tools category. 244 Liferay Services Oriented Architecture . if you are making your software available to Internet users. you will not be able to use the Software Catalog portlet as a graphical user interface to your software that end users can use to download your software manually: you will have to build this yourself. the Software Catalog portlet is the easiest way to provide a user interface for downloading your software. and all of that is done for you. Simply configure your software in the portlet.

100. the Spring Remoting Servlet. you would enter the IP address of the machine on which the batch job is running to the axis.properties file and put the IP address of the machine on which the batch job is running in the list for that particular service.168.168.0. Copy this section and paste it into your custom portalext. there is a section called Main Servlet. you may have a batch job which runs on another machine in your network. The Main Servlet section of the portal-ext. a remote exception will be thrown and access to those services will not be granted. the JSON Tunnel Servlet. SERVER_IP If the machine on which the batch job is running has the IP address 192. but before they can be used there are steps that need to be taken to enable users to access those services remotely. In that section of the properties file. Liferay has two layers of security when it comes to accessing its services remotely. using Liferay's web services.Advanced Liferay Configuration Because the actual method calls for retrieving data are the same regardless of how one gets access to those methods (i. Liferay Services Oriented Architecture 245 . The first layer of security that a user needs to get through in order to call a method from the service layer is servlet security.allowed property.properties file.hosts.100.100. the Liferay Tunnel Servlet.0.servlet. Illustration 77: Liferay SOA's first layer of security.hosts. By default. You can set each service individually with the security settings that you require.. Of course.1.100. For example. For example. there are properties for each of Liferay's remote services. you are not really “remote” unless you are accessing services from a different machine. and the WebDAV servlet. To enable this batch job to get through the first layer of security.properties file is used to enable or disable access to Liferay's remote services. and you can configure security settings for the Axis Servlet.servlet. In the default portal. This section defines the security settings for all of the remote services provided by Liferay. This job looks in a particular shared folder on your network and uploads documents to your community's document library portlet on a regular basis.e.properties file. Liferay provides a consistent interface for accessing portal data that few other products can match. if the batch job uses the Axis web services to upload the documents. The actual interfaces for the various services will be covered in the Liferay Developer's Guide. a user connecting from the same machine Liferay is running on can access remote services so long as that user has the permission to use those services in Liferay's permissions system. Without explicit rights to both layers. 127. A typical entry might look like this: axis.allowed=192. locally or through web services). this configuration will allow that machine to connect to Liferay's web services and pass in user credentials to be used to upload the documents. you would modify the portal-ext.

you would use the following URL syntax: http://" + userIdAsString + ":" + password + "@<server. Otherwise. say that a Document Library folder called Documents has been set up in a community. In the top left corner of the portlet that appears is the user ID. A role has been created called Document Uploaders which has the rights to add documents to this folder. If you are enforcing password policies on your users (requiring them to change their passwords on a periodic basis. In order for this to work. Your batch job will be accessing Liferay's web services in order to upload documents into this folder. you would use the following URL: http://2:test@localhost:8080/tunnel-web/secure/axis/Portal_OrganizationService Tip: In older versions of Liferay (4. To call the web service using creden- Illustration 78: Liferay SOA's second layer of security.com>:<port>/tunnelweb/secure/axis/" + serviceName The user ID is the user's ID from the Liferay database. to get Organization data using a user that has the ID of 2 with a password of test.2. The user ID that accesses the services remotely must have the proper permission to operate on the objects it will be accessing.Advanced Liferay Configuration The second layer of security is Liferay's security model that it uses for every object in the portal. etc. Otherwise.).x and below). this password had to be the encrypted version from Liferay's database. you will have to call the web service using a user ID that is a member of this group (or that has individual rights to add documents to this folder). This may be obtained by logging in as the user and clicking My Account from the Dock. The Portal Administrator will need to make use of Liferay's usual means of granting access to these resources to the user ID that will be operating on them remotely. any administrative ID which accesses Liferay's web services in a batch job will have its password expire too. tials. For example. you will be prevented from using the Web Service. For example. 246 Liferay Services Oriented Architecture . It is important to note here how Password Policies (covered in Chapter 3) can be used in combination with this feature. a remote exception will be thrown.

once you successfully browse to this URL.Advanced Liferay Configuration To prevent this from happening. the Web Service Definition Language document will be displayed. your first step in obtaining access to remote web services is to access the WSDL. you can do this by accessing the following URL: http://localhost:<port number>/tunnel-web/axis If. for example. Then your batch job can run as many times as you need it to. If you are on a browser on the same machine Liferay is running on. and the administrative ID's password will never expire. The user ID being used must have permission to access the resources it is attempting to access. you would specify this URL: http://localhost:8080/tunnel-web/axis If you are on a different machine from the Liferay server.properties file. you can add a new password policy which does not enforce the password expiration and add your administrative user ID to it. one for each of the services available from the Liferay API. 2. WSDL for each service is available by clicking on the WSDL link next to the name of the service. In summary. you are running on Tomcat on port 8080. You can either save the document to your local machine and then generate the client code that way. Once you click on one of the WSDL links. The IP address must be pre-configured in the server's portal-ext. Liferay Services Oriented Architecture 247 . For further information about developing applications that take advantage of Liferay's remote services. please see the Liferay Developer's Guide. or use your tool to trigger Liferay to generate the document dynamically by using one of the URLs above. This document can be used to generate client code in any language that supports it. you will see the list of web services. Accessing Liferay's WSDL After configuring the security settings properly. you will need to pass in your user credentials on the URL to access the WSDL: http://<user ID>:<password>@<server name>:<port number>/tunnel-web/axis In any case. accessing Liferay remotely requires the successful passing of two security checks: 1. There are many services.

.

and so there are some steps that need to be taken in order to configure it this way.6. The product. Please consult the documentation for your particular application server to see how you can configure your application server of choice to work as a cluster. we will cover the configuration of Liferay only. Because Liferay runs on so many different Java EE application servers. it is fully ready to support mission-critical. We will cover how to configure Ehcache to enable various caching functionality in Liferay. For example. does not come configured this way out of the box. cover the configuration of Liferay for a number of advanced scenarios. These products all have their own documentation which should be consulted for a fuller view of what these products can do. As such. but will refer you to that product's documentation for further information about that product. Liferay uses Ehcache for its caching mechanism. enterprise-ready portal solution. we will cover how to configure Liferay to work in a clustered environment. however. we will mention a number of other open source products upon which Liferay relies for much of this functionality. such as ● ● ● ● Clustering and Distributed Caching Liferay Workflow Deploying Customized versions of Liferay Performance Testing and Tuning During this discussion. however. like other products of its kind. enterprise applications in an environment configured for multiple redundancy and 24/7 up times. For this reason. We will. it will be impossible to cover all of the differences between these application servers. ENTERPRISE CONFIGURATION Liferay Portal is a robust. As an example. but we will not cover how to create the cluster in your application server. . This chapter will cover these topics in detail.

com Multiple Domains Load Balancer Multiple Load Balancers Liferay Server 1 Controller 1 Liferay Server 2 Controller 2 Multiple Liferay Servers Database Cluster DB 1 DB 2 DB 3 DB 4 Multiple Databases Illustration 79: "Unbreakable" Liferay architecture Liferay Clustering Once you have Liferay installed in more than one node on your application server. Unbreakable Liferay To infinity and beyond App Server Cluster Load Balancer Virtual Hosting www.com www. Liferay should be configured in the following way for a clustered environment: ● ● All nodes should be pointing to the same Liferay database Jackrabbit.Enterprise Configuration Sometimes Liferay supports multiple products which perform the same function. let's get started configuring Liferay for the enterprise. There are. We will leave it up to you to select which product best fits the needs of your project without recommending one product over another. though). for example.mytte.mypmu. should be: ○ ○ On a shared file system available to all the nodes (not really recommended. multiple implementations of Enterprise Service Buses for use with workflow. With all of that said. and Liferay supports several of them. there are several optimizations that need to be made. or In a database that is shared by all the nodes 250 Liferay Clustering . the JSR-170 content repository.com www.mytcl. At a minimum.

2.hook. and Liferay's document library will prevent users from “colliding” with each other by versioning documents and locking the files before they are modified. of course. and a separate pluggable enterprise search server configured (recommended). It is also best if the database server is a separate physical box from the server which is running Liferay. All Nodes Should Be Pointing to the Same Liferay Database This is pretty self-explanatory. Similarly. It is a best practice to copy the relevant section that you want to modify from portal.properties file.properties file. though).Enterprise Configuration ● ● Alternatively.x now defaults to using the file system for storing documents.jar file in your Liferay installation.properties file. and the files can be stored on a SAN for better performance.root.home}/data/document_library If you wish to cluster your document library configuration in a database. the hot deploy folder should be a separate folder for all the nodes. Many of these configuration changes can be made by adding or modifying properties in your portal-ext. use the following property: dl. you can still do so using the Jackrabbit JSR-170 repository. To configure the location where your documents are stored. and then modify the values there. If you have not configured your application server to use farms for deployment. Remember that this file overrides the defaults that are in the portal. You can use the file system for your clustered configuration. Lucene. you can configure Liferay to store documents there to take advantage of the extra redundancy. which is why this decision was made. Each node should be configured with a data source that points to one Liferay database (or a database cluster) that all of the nodes will share. This has proven to be the highest performing configuration for large document libraries. This ensures that all of the nodes operate from the same basic data set. This can be done via a script. the full text search indexer.file.properties into your portal-ext. or Disabled. the Document Library should be configured to use the File System Hook. and plugins will have to be deployed to all of the nodes individually. This means. Document Library Configuration Liferay 5. If you have a Storage Area Network (SAN). or In a database that is shared by all the nodes. You would also use the Jackrabbit repository if you want to have a JSR-170 compliant repository for your documents. The original version of this file can be found in the Liferay source code or can be extracted from the portal-impl. should be: ○ ○ ○ ○ ● On a shared file system available to all the nodes (not really recommended. Liferay Clustering 251 .dir=${liferay. that Liferay cannot (and should not) use the embedded HSQL database that is shipped with the bundles.system. or On separate file systems for all of the nodes.

252 Liferay Clustering . you can create a Jackrabbit cluster (please see the section below). A new Jackrabbit configuration file will be generated in that location.root=${liferay.properties labeled JCR and copy/paste that section into your portal-ext. Jackrabbit. You can use the Liferay database or another database for this purpose. by default. is the following: jcr. Once that is working. you could encounter data corruption using this method.apache. This will require editing Jackrabbit's configuration file. One of the properties. the default configuration uses Jackrabbit's DbFileSystem class to mimic a file system in the database. called repository. The default Jackrabbit configuration file has sections commented out for moving the Jackrabbit configuration into the database. does not create indexes on these tables. this is not the best way to share Jackrabbit resources. If you have two people logged in at the same time uploading content. For example. you will need to modify this to use OracleFileSystem.repository. modify. we do not recommend it for a production system. and grant the user ID you are specifying in the configuration file access to create. Instead. and because of this.properties file.jackrabbit. and so over time this can be a performance penalty. however.org for further information. To simply move the default repository location to a shared folder. as there are changes to the configuration file that are necessary for specific databases. These by default are configured for a MySQL database. Inside this folder is Jackrabbit's configuration file. To fix this. find the section in portal. For example. Jackrabbit is configured to store the documents on the local file system upon which Liferay is installed. Once you have configured Jackrabbit to store its repository in a database.Enterprise Configuration Jackrabbit Sharing Liferay uses Jackrabbit—which is a project from Apache—as its JSR-170 compliant document repository. If you are using another database. While this works well in MySQL. the necessary database tables will be created automatically. it does not work for all databases. By default. to enable better data protection. simply comment out the sections relating to the file system and comment in the sections relating to the database. You will also likely need to modify the JDBC database URLs so that they point your database. you should redirect Jackrabbit into your database of choice. in the $HOME/liferay/jackrabbit folder. Please see the Jackrabbit documentation at http://jackrabbit. if you are using an Oracle database. To move the Jackrabbit configuration into the database. All of your Liferay nodes should be configured to use the same Jackrabbit repository in the database. This has been done to make it as easy as possible to enable this configuration. the next time you bring up Liferay.home}/data/jackrabbit Change this property to point to a shared folder that all of the nodes can see. and drop tables. Don't forget to create the database first. you do not need to edit Jackrabbit's configuration file. you will need to manually go into your database and index the primary key columns for all of the Jackrabbit tables. Instead. Note that because of file locking issues.xml. you will likely need to modify the configuration.

This allows you to use a completely separate product for search. This environment variable needs to be called $SOLR_HOME. Once you have Solr up and running. you would edit catalina. create an environment variable that points to this folder.1 and higher now supports pluggable search engines. This is configured differently per application server.bat and append the following to the $JAVA_OPTS vari- Liferay Clustering 253 . or in the start up script for your application server.jar files which need to be available on your application server's class path. Liferay 5.org/solr). and these updates are then queued and handled automatically by the search engine. The first implementation of this uses the open source search engine Solr. Each Liferay node will send requests to the search engine to update the search index when needed. we would define: $SOLR_HOME=/solr This environment variable can be defined anywhere you need: in your operating system's start up sequence. If you are going to use Tomcat to host Solr. Assuming you are running a Linux server and you have mounted a file system for the index at /solr. PLUGGABLE ENTERPRISE SEARCH As an alternative to using Lucene.bat and add the environment variable there.sh or catalina.war file with several . CONFIGURING THE SOLR SEARCH SERVER Since Solr is a standalone search engine. which can be installed on another application server in your environment. independently. integrating it with Liferay is easy. Your search engine then operates completely independently of your Liferay Portal nodes in a clustered environment. This solves the problem described below with sharing Lucene indexes. So for our example. but it will require a restart of your application server.Enterprise Configuration Search Configuration You can configure search in one of two ways: use pluggable enterprise search (recommended for a cluster configuration) or configure Lucene in such a way that either the index is stored on each node's file system or is shared in a database. The first thing you will need to define is the location of your search index. acting as a search service for all of the nodes simultaneously. we will cover how to implement this using Solr. you will need to download it and install it first according to the instructions on the Solr web site (http://lucene. Once you have created the environment variable. if you are using Tomcat. Solr is distributed as a .sh or catalina. you then can use it in your application server's start up configuration as a parameter to your JVM. You can now have one search index for all of the nodes of your cluster without having to worry about putting it in a database (if you wish. but in the future there will be many such plugins for your search engine of choice. you can still do this if you configure Solr or another search engine that way) or maintaining separate search indexes on all of your nodes.apache. you would modify catalina. in the environment for the user who is logged in. but again. Since at the time of this writing there is only one implementation of the pluggable enterprise search.

Next. If you have installed Solr on the same system upon which Liferay is running. INSTALLING THE SOLR LIFERAY PLUGIN Next. This file tells Solr how to index the data coming from Liferay.SolrIndexSearcherImpl"> /> </bean> <bean id="indexWriter" class="com. you have a choice. Open this file in a text editor and you will see that there are two entries which define where the Solr server can be found by Liferay: <bean id="indexSearcher" class="com. It is likely. because the goal is to offload search indexing to another box in order to free up processing for your installation of Liferay. In the Server section. shut it down. For this reason. you can simply go to the Control Panel and install the solrweb plugin. Inside the plugin. click Server Administration.apache. extract the file schema. however. you should not run Liferay and your search engine on the same box.home=$SOLR_HOME This takes care of telling Solr where to store its search index.portal.org/solr).xml in the WEB-INF/classes/META-INF folder. Go ahead and install Solr to this box according to the instructions on the Solr web site (http://lucene.Enterprise Configuration able: -Dsolr. Copy this file to $SOLR_HOME/conf (you may have to create the conf directory) on your Solr box. Once the plugin is hot deployed. You can now hot deploy the solr-web plugin to all of your nodes.SolrIndexWriterImpl"> /> </bean> <property name="serverURL" value="http://localhost:8080/solr/update" <property name="serverURL" value="http://localhost:8080/solr/select" Modify these values so that they point to the server upon which you are running Solr. that initial searches will come up with nothing: this is because you will need to reindex everything using Solr. the configuration in the plugin defaults to having Solr and Liferay running on the same box.search. as there is some more configuration to do.solr.com) and download the plugin manually. Once it's installed. you will have to make a change to a configuration file in the plugin before you install it so you can tell Liferay where to send indexing requests. Go to the Control Panel. Then save the file and put it back into the plugin archive in the same place it was before. Unfortunately. Open or extract the plugin. so to run them separately. and can be customized for your installation. Now you can go ahead and start Solr. go to the Liferay web site (http://www. In this case.liferay. however. This.search. See the next section for instructions on hot deploying to a cluster.solr.portal. Click the 254 Liferay Clustering . It should be in the docroot/WEBINF/conf folder. defeats much of the purpose of using Solr.solr. you will find a file called solrspring.xml from the plugin.liferay. your Liferay search is automatically upgraded to use Solr.liferay.

It may take a while. All of Liferay's search boxes will now use Solr as the search index. A better way is to share the index is via a database. Copy that section and then paste it into your portal-ext. Like Jackrabbit. can be in a shared configuration for a clustered environment.properties file. By default.home}/data/lucene/ Change this to the folder of your choice. however. If you wish to store the Lucene search index on a file system that is shared by all of the Liferay nodes.properties file. you should consider using a separate search server (see the section on Solr above). this property points to the lucene folder inside the home folder of the user that is running Liferay: lucene. If all the Liferay nodes point to the same database tables. You can point all of the nodes to this folder.Enterprise Configuration Execute button next to Reindex all search indexes at the bottom of the page. This is very easy to do. and will be running independently of all of your Liferay nodes. or an index can be created on each node of the cluster. There is a single property called lucene. Add the following parameter to your connection string: Liferay Clustering 255 . By default this is set to go to the file system. Open your portal. When the process is complete. and they will use the same index.store. Note: MySQL users need to modify their JDBC connection string for this to work.store. You can change this so that the index is stored in the database by making it the following: lucene. you will need to either share the index on the file system or in the database. Installing the plugin to your nodes has the effect of overriding any calls to Lucene for searching.type.dir=${liferay.dir property. they will be able to share the index.properties file and search for the text Lucene. the search indexer which Liferay uses. as it allows all of your nodes to share one search server and one search index. but Liferay will begin sending indexing requests to Solr for execution. This is ideal for a clustered environment. The Lucene configuration can be changed by modifying values in your portal-ext. where the database can enforce data integrity on the index. We do not recommend this for a production system. and this search server operates independently of all of your nodes. as it could result in file corruption if different nodes try reindexing at the same time. you will need to restart Liferay. new tables will be created in the Liferay database. If you wish to have a shared index. LUCENE CONFIGURATION Lucene.properties file. Performance on this is not always as good as it could be. and the index will be stored there. this is not the best way to share the search index. it is a simple change to your portal-ext. you can modify the location of the search index by changing the lucene. Your DBAs may be able to tweak the database indexes a bit to improve performance. To make the change take effect.type=jdbc The next time Liferay is started. For better performance. Solr will have a complete search index of your site.

Distributed Caching Liferay 4. Some containers contain a facility which allows the end user to deploy an application to one node. If you have configured your application server to support this. for a better configuration. Again. therefore. the second user would need to wait until the cache was invalid256 Distributed Caching . Hot Deploy Plugins which are hot deployed will need to be deployed separately to all of the Liferay nodes. This is to prevent the system from entering an endless loop. For example. Enabling this cache can increase performance dramatically. We will see how to do this next. the configuration can be further optimized. that you use Liferay's hot deploy mechanism to deploy plugins. however. you can then make use of it (by adding the portlet to a page or choosing the theme as the look and feel for a page or page hierarchy).Enterprise Configuration emulateLocators=true Alternatively.war files when hot deploying them. Make sure. With a distributed Ehcache running. This ensures that there are no collisions when multiple nodes update the index. however. you won't need to hot deploy a plugin to all of the nodes—your application server will handle it transparently. This means that the cache can be distributed across multiple Liferay nodes running concurrently. have its own hot deploy folder. Once the plugin has been deployed to all of the nodes. making the new post available immediately from the local cache. after which it will get copied to all of the other nodes. but the power of distributed caching allows for more functionality. Without that. When you want to deploy a plugin. because the presence of a plugin in the folder is what triggers the hot deploy process. which has robust distributed caching support. you should consider using a separate search server (see the section on Solr above). All of the above will get basic Liferay clustering working. Say then that the second user wants to read the same forum thread and clicks on it. Liferay must look up that thread from the database and format it for display in the browser. and so retrieving the data is much faster. This folder needs to be writable by the user under which Liferay is running. The first user clicks on a thread in order to read it.3. copy that plugin to the hot deploy folders of all of the Liferay nodes. you can leave the configuration alone. it may be best to create a script to do this. this thread can be pulled from the database and stored in a cache for quick retrieval. because they all will have separate indexes. This. however. Each node should. and each node will then have its own index. say that two users are browsing the message boards. This time. and the cache will be updated across all of the nodes. as in many cases Liferay slightly modifies plugin .1 and higher uses Ehcache. because the thread is in the local cache. Depending on the number of nodes. The first user can post a message to the thread he or she was reading. no trip to the database is necessary. This could be done by simply having a cache running separately on each node. because plugins are moved from this folder to a temporary folder when they are deployed. creates duplicate indexes and may not be the best use of resources.

uncomment the following line and point it to your custom version of the file: ehcache.properties into your portalext. Configuring distributed caching requires the modification of the portal-ext. if your Liferay project is using the extension environment to make customizations to Liferay. The settings there will override the default settings that ship with Liferay.location=/myehcache/liferay-multi-vm-clustered. The files should be postfixed with -ext.multi.properties file and then modify the net. you can modify the settings in this file to change the cache configuration for Hibernate. Alternatively. Distributed Caching 257 .vm.jar file.xml. This will have to be somewhere on Liferay's class path. For example. you will need to extract them to this area and then tell Liferay (by use of the portal-ext. the custom version of hibernate.xml You can now take a look at the settings in these files and tune them to fit your environment and application. and the custom version of liferay-multi-vm-clustered.location=/myehcache/liferay-multi-vm. say you are running Liferay on Tomcat.xml. Next.ehcache. Copy / paste the Hibernate section of portal.configurationResourceName property to point to the clustered version of the configuration file that is now in your custom folder: net.jar file—into the myehcache folder you just created.vm.ehcache. Copy the files from the /ehcache folder—which is inside the portal-impl. The first thing you will want to do is determine where on your server you will want to store your cache configuration files.properties file.Enterprise Configuration ated on the node he or she connected to before he or she could see the updated forum post. Because the original.xml should be called liferay-multi-vm-clustered-ext. so you will need to find where your application server has stored the deployed version of Liferay.xml.config.properties file) where they are.multi.sf. You can then modify the files and tune them to fit your environment / application. and create a folder in Liferay's WEB-INF/classes folder to store the files. You can create a new folder in here called myehcache to store the custom versions of the cache configuration files. you can create new versions of the files in extimpl/classes/ehcache. For example: ehcache. Tomcat stores the deployed version of Liferay in <Tomcat Home>/webapps/ROOT. copy / paste the Ehcache section from the portal. You then need to modify the properties in portal-ext.xml should be called hibernate-ext.properties file as well as one or more other files depending on what you want to cache.properties file into your portal-ext. default files are stored inside of a . Modify the properties so that they point to the files that are in your custom folder.sf.xml Now that Liferay is pointing to your custom file.properties that point to these files. you can place your cache configuration in the extension environment. For example. and they will be deployed along with the rest of your extension environment.xml If you are going to enable distributed clustering. Inside of this folder is the folder structure WEB-INF/classes. If you wish to do this.configurationResourceName=/myehcache/hibernate-clustered.config.

To enable clustering. his or her User object will go in the cache so that any portal operation that requires access to it (such as permission checking) can retrieve that object very quickly from the cache.MBMessageImpl" maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="600" 258 Distributed Caching .RMICacheReplicatorFactory" properties="replicatePuts=false.UserImpl).model. This is the recommended setting. You will notice that the configuration is already set up to perform distributed caching through a multi-cast connection.properties file. open this file in a text editor.liferay. however. making sure that you change the path so that it points to your custom version of the file: net. To enable a clustered cache. Hibernate (Liferay's database persistence layer) is configured to use Ehcache as its cache provider. add another block to the configuration file with the class you want to cache: <cache name="com.RMIBootstrapCacheLoaderFactory" /> </cache> Your site may use the message boards portlet.portal. such as DLFileEntryImpl in order to improve performance as users access documents.model.replicateUpdatesViaCopy=false" propertySeparator=".impl.messageboards.DLFileEntryImpl" maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="600" overflowToDisk="true" > <cacheEventListenerFactory class="net.distribution. You will notice that by default.sf.portlet. The default configuration. To do that. points to a file that does not have clustering enabled.ehcache. For example. configure a block with the MBMessageImpl class: <cache name="com.sf. comment out the default file (hibernate.sf. and those message boards may get a lot of traffic. This means that when a user logs in.impl. To cache the threads on the message boards. you may want to cache Document Library objects.ehcache.xml) and uncomment the clustered version of the file. You may wish to add other objects to the cache.distribution.impl. that the configuration is not set up optimally for your particular application.documentlibrary.configurationResourceName=/myehcache/hibernate-clustered.liferay.ehcache. a large part of your application may be document management using the Document Library portlet. copy the Hibernate section from portal. however.portlet.model. the only object cached in the Hibernate cache is the User object (com. It is likely.xml Next.Enterprise Configuration HIBERNATE CACHE SETTINGS By default." /> <bootstrapCacheLoaderFactory class="net.properties into your portal-ext.liferay. In this case.

You have already configured basic data sharing among nodes by moving its configuration into a database.Enterprise Configuration overflowToDisk="true" > <cacheEventListenerFactory class="net. The file is called repository. This is all it takes to set up clustering for Jackrabbit. you can uncomment this section and use it as-is. The next thing you need to do is configure clustering for Jackrabbit. The portlet relies on Mule or Apache ServiceMix to function as an Enterprise SerWorkflow 259 . As you can see.replicateUpdatesViaCopy=false" propertySeparator=". you will have to specify the overridden versions rather than the stock ones that come with Liferay Portal.RMIBootstrapCacheLoaderFactory" /> </cache> Note that if your developers have overridden any of these classes.distribution. credentials.sf.ehcache. Be careful. so that each node knows about data being entered into the repository by other nodes. If you are using a MySQL database.ehcache.xml. and roles without writing a single line of code—it only requires the creation of a single XML document. and schema settings. CLUSTERING JACKRABBIT If you are using the Document Library. If you are using another database. it is easy to add specific data to be cached. as too much caching can actually reduce performance if the JVM runs out of memory and starts garbage collecting too frequently. You will likely need to experiment with the memory settings on your JVM as well as the cache settings above. You will need to change the cluster ID for each node so that they don't conflict with one another. deploy them.distribution. and manage them through a portal interface. which is the Apache product Jackrabbit. The power of this portlet is that it allows users to create forms-based data entry applications that are fully integrated with Liferay's permissions system. Modify them according to your database of choice and then save the file.sf.RMICacheReplicatorFactory" properties="replicatePuts=false. You can find the Jackrabbit configuration file in <Liferay User Home>/liferay/jackrabbit. You can find the specifics about these settings in the documentation for Ehcache. however. by default you are using the JSR-170 document repository. groups. You have likely already edited this file when you modified the configuration to move the data into the database. Workflow The workflow portlet allows a user to define any number of simple to complex business processes/workflows. the only changes necessary are the connection. They have knowledge of users. At the bottom of this file is a cluster configuration that is commented out." /> <bootstrapCacheLoaderFactory class="net.

workflow. 12. the portal provides a generic interface through which workflow services are requested via normal HTTP calls.xml into the text area and click the Save New Version button. 10. From the Instances tab. 260 Workflow . Liferay provides an implementation of JBoss’ jBPM workflow engine. From the Instances tab.properties is set to the following: jbi. Once you install the plugins. Fill out the form and click the Save button.com/test. You will need to have jBPM and one of the ESB plugins installed.Enterprise Configuration vice Bus (ESB) that acts as a broker between the portal and a workflow engine. 9. alternatively. you will have to install three plugins: the workflow portlet itself. 3. click on the Manage icon next to Enter data. follow these steps to get everything configured properly: 1. Confirm that the instance is now in the End state. and one of the ESB web plugins. enter correct values and click the Save button. make sure the following property in portal-ext. For Mule. 8. Copy and paste the contents of jbpm-web. 14. The latter two are conveniently located on the web tab of the Plugins Installation section of the Control Panel. the jBPM web plugin. Eventually. Restart your application server if you needed to change the above property. Login to the portal as the portal administrator. Click on the Definitions tab. Confirm that all the data was entered correctly and click the Finished button.workflow. Essentially. By default.properties is set to the following: jbi.url=http://localhost:8080/servicemix-web/workflow 2. you can test the various error checking capabilities by inputting incorrect values and clicking the Save button. The requests are routed through the ESB which in turn calls a workflow engine implementation that the user has defined in the ESB configuration. make sure the following property in portal-ext. 13.url=http://localhost:8080/mule-web/workflow For ServiceMix. click on the Manage icon next to View Data. Installation and Test To enable workflow in the portal. Add the Workflow portlet to a page. 4. 5. Click on the Add button. The default credentials are test@liferay. 7.war/WEBINF/definitions/datatypes_definition. 6. 11. Click on the Add Instance icon.

Swimlanes can be associated with Liferay users.url property in jbpm-web. To use a database other than HSQL.war/ WEB-INF/classes/hibernate. For an in depth understanding of process definitions and JPDL. give an in depth view of jBPM. It does not. There are three sample process definition XMLs that are packaged with the portlet. For that. business processes must be defined.connection. refer to JBoss’ jBPM user guide at the link above. the various states in the process (known as nodes).Enterprise Configuration Using Different Databases The default implementation of jBPM uses an HSQL database found in jbpmweb. communities.war/WEB-INF/sql directory. Business processes in jBPM are defined by XML documents known as process definitions which are written in jBPM Process Definition Language (JPDL). They can be found in jbpm-web. We used one in the quick start section above to create a sample workflow. AND ROLES In JPDL. and many others. <swimlane name="approver"> <assignment class="com. An explanation of each is included below. How the Workflow Portlet Works Since the default implementation of the workflow portlet relies heavily on the capabilities of jBPM.xml. the variables associated with each task’s form. the tasks associated with each node.war/WEB-INF/sql/jbpm. the transitions from one node to the next.war/WEB-INF/classes/hibernate. this section gives a technical overview of jBPM and explains how it integrates into Liferay using jBPM Process Definition Language (JPDL) formatted XML files.jboss.IdentityAssignmentHandler" config-type="field"> <type>user</type> <companyId>10095</companyId> <id>10112</id> </assignment> Workflow 261 .handler.cfg.xml. the external actions executed on entry or exit of a node.liferay. and roles via the IdentityAssignmentHandler class. This XML format specifies entities such as the process roles (known as swimlanes). change the value of the hibernate. To change the location of the HSQL database. PROCESS DEFINITIONS Before the workflow portlet can be used. INTEGRATING WITH USERS.com/jbpm/v3/userguide). first create the database schema using one of the SQL create scripts supplied in the jbpm-web. the roles associated with each task. COMMUNITIES. Then uncomment the corresponding hibernate connection properties block in jbpm-web. please refer to the jBPM user guide (http://docs.cfg.jbpm. there is the notion of process roles called swimlanes.*.war/WEB-INF/definitions. The location is relatively addressed from wherever the startup script for your server is located. however.

he/she would automatically be assigned to all other salesman tasks in the workflow. Since community names must be unique per Company ID.lax. You can also associate a Liferay user with a swimlane by email address as shown in the following XML snippet.IdentityAssignmentHandler" config-type="field"> <type>community</type> <companyId>10095</companyId> <name>Support</name> </assignment> </swimlane> The XML above shows an alternative way to associate the accountant swimlane with the Support community using the actual community’s name. If one of these users were to manage a salesman task.2@liferay.handler.com</name> </assignment> </swimlane> In the XML above.jbpm.com” and belongs to a Company ID of 10095. the approver swimlane is associated with the Liferay user that has a User ID of 10112 and belongs to a Company ID of 10095.jbpm. the shipper swimlane is associated with the Liferay user that has an email address of “test.Enterprise Configuration </swimlane> In the XML above.jbpm. this format accomplishes the same results as the previous XML.handler. <swimlane name="salesman"> <assignment class="com. the salesman swimlane is assigned to the pool of Support users.liferay. <swimlane name="shipper"> <assignment class="com.liferay.IdentityAssignmentHandler" config-type="field"> 262 Workflow . <swimlane name="accountant"> <assignment class="com.2@liferay.IdentityAssignmentHandler" config-type="field"> <type>user</type> <companyId>10095</companyId> <name>test. <swimlane name="user_admin"> <assignment class="com. In other words.lax. the salesman swimlane is associated with any Liferay user that belongs to a Community with the Group ID of 3 (which defaults to the Support community if you are using the embedded HSQL database that comes with the Liferay Portal bundles) and Company ID of 10095.liferay.handler.liferay.IdentityAssignmentHandler" config-type="field"> <type>community</type> <companyId>10095</companyId> <id>3</id> </assignment> </swimlane> In the XML above.jbpm.handler.

IdentityAssignmentHandler" config-type="field"> <type>role</type> <companyId>10095</companyId> <name>User Interviewer</name> </assignment> </swimlane> The two XML snippets above are very similar to the Group XML snippets.Enterprise Configuration <type>role</type> <companyId>10095</companyId> <id>1001</id> </assignment> </swimlane> <swimlane name="user_interviewer"> <assignment class="com. but the first XML does so using the Role ID.liferay. data types have been dealt with in the workflow portlet by incorporating them into the names of the controller variables. jBPM doesn’t have support for variable data types. Both associate their respective swimlanes with a role. However. The table below shows the data types supported by the portlet as well as the syntax for the variable names: Workflow 263 .jbpm.handler. DATA TYPES AND ERROR CHECKING Currently. and the second XML does so using the role’s unique name.

…* : a comma-delimited list of options that represent the different radio button options name: the caption next to the select box option1. all variables are readable and writable by the user.no. the values should be entered in the XML in lower case with hyphens used between words: radio:are-you-hungry:yes. if variables should only be readable or writable. you should register the corresponding display values in the Language.…* : a comma-delimited list of options that represent the different options in the select drop-down name: the caption next to the text input field name: the caption next to the textarea input field select:name:option1.option2.option2.…* text:name textarea:name Note that for all name and option values.properties file: are-you-hungry=Are you hungry? yes=Yes no=No a-little-bit=A little bit This will ensure that the values are displayed correctly in the portlet to the user. By default.a-little-bit In addition. they can be defined as follows: <variable name="textarea:comments" /> However.option2.Enterprise Configuration Data Type Checkbox Date Email Number Password Phone Radio Button Select Box Text Textarea Syntax checkbox:name:checkedValue date:name email:name number:name password:name phone:name radio:name:option1.…* Description name: the caption next to the checkbox checkedValue = the value assigned to the variable if the checkbox is checked name: the caption next to the date selector object name: the caption next to the text input field name: the caption next to the text input field name: the caption next to the text input field name: the caption next to the text input field name: the caption next to the radio buttons option1. or if variables are required.option2. Therefore. these must be specified in the variable definition: 264 Workflow .

JBoss also provides a graphical JPDL editor which is implemented as an Eclipse plugin. and then a manager can either approve.jboss.Enterprise Configuration <variable name="text:name" access="read. This editor allows you to design workflows graphically. but it demonstrates almost all of the BPM features offered by jBPM Notes: Workflow 265 . and Phone are validated in the service call. the user is returned to the original form and error messages are displayed next to the invalid input fields. Email. rather than using an XML editor.xml – a simple workflow that allows an employee to make a holiday request with a start and end date. If invalid values are submitted. required fields are validated to ensure a value of some kind was submitted. or send the request back for review websale_definition. Below is a quick summary of each: datatypes_definition. Number. reject.xml for examples of all data types in use in a single form.required" /> <variable name="date:birthday" access="read" /> Variables of data type Date.war/WEB-INF/definitions/datatypes_definition. Refer to the sample definition jbpm-web. They can be found in jbpm-web.war/WEB-INF/definitions/.write. You can find this tool at http://www. It is the most complicated of the 3 workflows. Illustration 80: The JPDL editor from JBoss SAMPLE PROCESS DEFINITIONS The best way to understand JPDL is to look over the 3 sample XML files included with the workflow portlet.xml – a good guide to follow to understand how to use each of the data types described in the section above holiday_definition.org/tools.xml – a more complex workflow that emulates an online auction site in which control of the workflow passes through various roles. Also.

com/jbpm/v3/gpd for a detailed explanation) and is also beyond the scope of the portal. all of which are discussed in further detail in the jBPM user guide (http://docs. updating legacy systems. The websale workflow demonstrates the following jBPM concepts. The display value is used as the button’s name. Many of the action handler classes found in the com. in your console you 266 Workflow . initiating batch processes. For nodes that have tasks associated with them. these classes could perform operations such as sending out emails.liferay.jbpm.com/jbpm/v3/userguide): ○ ○ ○ ○ Events Beanshell scripting Swimlanes Tasks ■ ■ ■ ■ ○ Assigment(User/Pool) Controllers Variables Timers State Task Fork Join Decision ● ● ● ● Node Types ■ ■ ■ ■ ■ ○ ○ Transitions Actions WARNING MESSAGES If you have warning messages turned on for your server.jboss. For nodes that have tasks associated with them. but that is beyond the scope of this document (see http://docs.Enterprise Configuration ● The JPDL definition XMLs can be created through a graphical design tool offered by JBoss. The transition’s name attribute should always be in lowercase with hyphens between words and registered in Language. each of the transitions out of the node is represented as a button in the task’s form.jboss. each of the variables in the controller will be converted to a form element that the user must update.handler package are just place holders that output relevant text to the console. etc.properties. Conceivably.

Hibernate goes and gets it from the database and replaces the stub with an actual instance.node. This section is meant for end users who will actually be executing predefined process definitions. one of the key contributors to the jBPM project). DEPLOYING WORKFLOWS Once the user logs in to the portal and adds the workflow portlet to her page. this is not an error and is not of significance. Administration Once you have defined your business processes by successfully writing process definitions for them. thereby breaking the == operator.jboss. a collection is returned which holds a collection of stubs of the class. After a query. the next step is to deploy your business processes. click on the Add Definition button.engine.StatefulPersistenceContext] Narrowing proxy to class org.this operation breaks == According to the following post on the JBoss forums (from Koen Aers. When a particular instance is retrieved. he or she will see something similar to the following: Illustration 81: Default view of the Workflow Portlet If she clicks on the “Definitions” tab. Basically.graph.TaskNode . He explains the reason this warning is thrown here: http://www. Once they are deployed.hibernate. The user will see the following screen: Workflow 267 .Enterprise Configuration may see some variant of the following message output several times when jBPM is called: WARN [org. he or she will see the following: Illustration 82: Workflow Definitions The Definitions tab displays all of the workflows that have been deployed in the system. To deploy a workflow. the issue boils down to Hibernate doing lazy loading of the class.com/? module=bb&op=viewtopic&t=73123. users can manage the life of each process instance as control is passed from one role to the next.jbpm.

and a success message will be displayed. The new version number will be incremented by 1 from the previous version. To start a new instance of a workflow definition.Enterprise Configuration Illustration 83: Adding a Workflow Definition At this point. MANAGING INSTANCES After a definition is deployed and an instance of that definition is started. the user will be returned to the Definitions tab. The search form at the top of the screen allows the user to find specific instances to manage. an error message will be displayed. every version of the workflows is maintained. A new instance will appear on the Instances tab. the Hide instances that have already ended check box allows the user to display only active. If the XML is valid. The date ranges also allow the user to search by Start Date and/or End Date (NOTE: Date ranges are inclusive of the day.war/WEB-INF/definitions for examples) and click the Save New Version button. it is up to the user to manage the life cycle of the instance. if the Start Date range was set to January 268 Workflow . the user can paste in the contents of a definition XML (see jbpmweb. the user can also search for a definition by name using the Definition Name input box. Finally. click on the Edit icon next to the definition name. click on the Add Instance icon. and click the Save New Version button. it will be deployed. For example. Because business processes may change over time. Instance management is controlled from the Instances tab. To view all the instances of a particular definition. click on the View Instances icon. They are listed alphabetically by Definition Name followed by Start Date in descending order. running instances. To edit an existing version. Below is an example of what the user might see: The Instances tab displays every instance of every version of every workflow deployed in the system. If the XML is invalid. In particular. Update the XML in the text area.

notice that web sale version 1. the current state and current task have the same name.0 is currently in the “Perform shipping and payment” state. 2008. 2008. Often times. Any subsequent rows in the instance define tasks associated with the current state. 2008. The first row for each instance describes the state of the instance. 12:00am to January 28. and it has two outstanding tasks associated with it – “Wait for shipment to be delivered” and “Wait for money. The table below shows all of the possible actions and what each means: Workflow 269 . 11:59pm would be displayed).Enterprise Configuration Illustration 84: Workflow Instances 23. then only instances that were started between January 28. 2008 – January 23.” The right-most column in the results table displays what actions the current user can perform on the given instance in its current state. In the example screen shot below.

If the user clicks on the “Manage” icon. the main process will continue like normal. the “Signal” icon is available. Below is an example of what the user might see: Illustration 85: Workflow Tasks The Tasks tab displays every task that has either been assigned directly to the 270 Workflow .) and are not manually entered by a user. etc. signals come from eternal processes (e. she will be taken to a form which must be submitted to complete the task. As each of the subprocesses completes. the successful update of a legacy system. In order for the main process to continue. in the case that user intervention is required. they will go into this state. See section 3. all of the subprocesses must complete.3 for more details ) The instance is currently in a wait state and must be “signalled” to continue. However. Manage icon ( Signal icon ( Waiting on sibling This only occurs when the process has forked into multiple subtokens to complete processes. Typically. MANAGING TASKS Task management is controlled from the “Tasks” tab. Once all subprocesses complete.Enterprise Configuration Action Blank Explanation 3 possibilities: ● The user doesn’t have the appropriate role/swimlane to perform an action on the instance in its current state ● The user doesn’t have permissions to perform an action ● The instance has already ended The user directly has the appropriate role/swimlane to perform ) an action or the user belongs to a group which has the appropriate role/swimlane.g.. the arrival of a package.

The user can also choose to only display tasks assigned directly to her. the workflow portlet has no notion of logging other than the ability to review all of the tasks that a user has assigned to them or has completed. she will be returned to the Tasks tab with a success message displayed. They are listed by Create Date in ascending order. and we will review those requirements for possible inclusion in future versions of the Workflow portlet. if a user was using the sample request-holiday definition which has been provided. If all data is valid and the user submits the form. please submit them to the Liferay Forums. tasks assigned to her pool. The date ranges also allow the user to search by task Create Date. For example.Enterprise Configuration user or to the group/role pool that the user belongs to. If you or your organization has logging requirements. CUSTOMIZABLE FRONT-END Though the workflow portlet’s strength is that it can provide a forms-based data Workflow 271 . However. If the user submits the form with invalid data. the Hide tasks that have already ended check box allows the user to display only active tasks. and the tasks assigned directly to the user are listed before the tasks assigned to the user’s pool (if the Assigned To column is blank. Start Date. a form similar to the following will be displayed: Illustration 86: Workflow Form These task forms are generated from the control variables associated with the task and defined in the definition XML. and/or End Date. Future Enhancements LOGGING Currently. The next screen that is shown will be different depending on the type of task that has been defined. The search form at the top of the screen allows the user to find specific tasks to manage. she will be returned to the form with error messages next to each of the invalid fields. that means the task is open to the pool). the corresponding element is created in the form. jBPM provides rather robust logging functionality so administrators/users can monitor every action that has ever been taken in a particular workflow. Depending on the data type. all a user needs to do is click on it. To start a task. or all tasks assigned to either by using the Assigned To drop-down. In particular. The only reason logging functionality has not been built out in the current release is because the Liferay development team is not sure what the most effective logging metrics would be to the end user. Required fields are denoted by a red asterisk.

we cannot rely on the workflow engine to maintain versions of our process definitions. The functionality would be very similar to how XSL style sheets are currently applied to Journal Articles in the Liferay Journal Content Management System. and the definition IDs are maintained in the jBPM database. To address this concern.html. Therefore.jboss.com/jbossjbpm/downloads. it will find a duplicate XML already exists. be warned that this will delete ALL the files that are stored in your Document Library. For an exhaustive explanation of JPDL. if you were to switch databases to a new instance.war/WEB-INF/definitions/) as a starting point. There is also a graphical JPDL designer available at http://labs.Enterprise Configuration entry application virtually on-the-fly. Frequently Asked Questions HOW DO YOU WRITE A NEW PROCESS DEFINITION? The best way to learn how to write a new process definition is to use one of the sample definition XMLs (found in jbpm-web. The only way to ensure that this exception does not occur is by clearing out the <User Home>/liferay/jackrabbit folder before switching databases.) are installed on the server. we maintain the process definition XMLs as system documents in our document library. The XMLs are named based on their definition IDs.com/jbpm/v3/userguide/jpdl. However. It is recommended that once you decide on a jBPM database that suits your needs. and when the system tries to store the process definition XML. FILE UPLOAD DATA TYPE There have already been several requests to add a file data type to provide a means for users to upload files that are associated with workflow tasks.xml demonstrates most of the BPM features offered by jBPM. and the extension Deploying A Customized Liferay 272 . it is obvious that there is not much control over what the forms look like when they are rendered by the portlet. Ant. visit JBoss’ documentation at http://docs. Deploying the extension environment to a server requires one of two scenarios: ● The Liferay development tools (JDK. Liferay allows for complete customization of the portal through the Extension Environment. websale_definition. Deploying A Customized Liferay As described in the Installation chapter of this book. the Liferay Portal source code is available on the server. the Liferay development team plans to create style sheets and templates that can be applied to the vanilla forms. This enhancement would give organizations flexibility in layout and UI design of their forms. the definition IDs would also be reset. Therefore. This will definitely be a future enhancement. In particular.jboss. we are using jBPM). you should only use that database. etc. JBPM? WHY ARE THERE “DUPLICATE FILE” EXCEPTIONS WHEN I CHANGE DATABASES FOR Since we are using ServiceMix as the service broker for our workflow implementation (by default.

In the extension environment. substitute <username> with the user name the server runs under and under whose credentials you will be doing the deployment.server. For example. for example.source.dir lp.server. Once one of these two requirements have been met.type=jboss-tomcat app.server.type=tomcat The path property is similar to the server type.type=glassfish app.properties.server.Enterprise Configuration environment is checked out to a directory on the server.properties.type=jetty app. a drive can be mapped or a folder mounted which points to the installation directory on the server. deploying to the server becomes as easy as deploying locally to the developer's machine.type=geronimo-tomcat app.dir Replace <server name> with the server type above. if you are using Glassfish. It should look like this: app.glassfish. create a file called app.glassfish. ● On a client machine which contains the Liferay development tools.server.<username>. This file will override the default values which are found in app.server.type=jonas-tomcat app.type=resin app.dir Set the value for the lp.<username>properties.source.server. You will need to configure two properties in this file: the server type and the server path. your property would be: app. To do this.server. Next. This file requires two properties: lp. where <username> is the user name of the account under which the server executable runs.dir property to be equal to the fully qualified directory name for where you have installed the Liferay Portal source.properties.server. The server type should be one of the following: app.dir=/home/glassfish/glassfish-v2 The value of the property should be the fully qualified path to the server directory. Deploying Directly on the Server Deploying the extension environment directly on the server is the recommended method.type=jonas-jetty app.server.ext.server. Set the value for the Deploying A Customized Liferay 273 . you have a Glassfish server running under the user name of glassfish. If.server. This file will override the default values found in release. Again. your file would be called app. create another file similar to the first one called release.server.properties. you will have to create two new configuration files which define the settings for the deployment.<server name>.

<username>. Once you have done this. There are three basic JVM command switches that control the amount of memory in the Java heap. version that code.dir=/home/glassfish/lportal/portal lp. you may find a need to tune it for performance. and then pull that version from your source code management software to deploy it to a server. It is better to have developers check in all their code. that will have a serious impact on performance.ext. Memory Memory is one of the first things to look at when you want to optimize performance.dir=/home/glassfish/lportal/ext Once you have set up these two properties files. If you are using a developer's machine to do the deployment. For example: lp. not the user name on the server.ext. If you have any disk swapping. especially if your site winds up generating more traffic than you'd anticipated. Modify the app. Then run the above Ant task to deploy the extension environment. There are some definite steps you can take with regard to improving Liferay's performance.<username>. Performance Tuning Once you have your portal up and running. Deploying from a Client Machine If you will be deploying a customized Liferay from a client machine. Make sure that your server has an optimal amount of memory and that your JVM is tuned to use it. as it enables changes to be made locally on a developer's machine which can then be deployed directly to a server without source code management being done first.properties file to match the application server type and location of the directory in which it is installed from your mapped drive or folder. You will not need to change the release. run the following Ant task: ant deploy Your customized Liferay will be automatically compiled and deployed to your application server. with the exception that the <username> should be the user name of the user logged in to the client. these configuration files will already exist. 274 Performance Tuning . follow the same procedure outlined above.source. only the app.server.<username>.dir property to be equal to the fully qualified directory name for where you have installed the Extension Environment you have checked out from your source code repository. Note that this second method is not a best practice.Enterprise Configuration lp.server.properties file will need to be modified.properties file. you will need to map a drive (on Windows) or a folder on your file system (Mac or Linux) to the server.

and some are not. and the separate area of the heap called Permanent Generation space. Normally. If you see Garbage Collection (GC) running frequently. or the NetBeans profiler) on the server. it can slow down the processing of requests.Enterprise Configuration -Xms -Xmx -XX:MaxPermSize These three settings control the amount of memory available to the JVM initially. the maximum amount of memory into which the JVM can grow. you have Liferay on a server with 4GB of RAM and you are having performance problems. You will be able to tell if memory is a problem by running a profiler (such as Jprobe. various Java objects are created. Setting them to the same value causes the JVM to be created up front with the maximum amount of memory you want to give it. If this happens in a server environment. There are some JVM switches that you can enable which can reduce the amount Performance Tuning 275 . you may want to increase the amount of PermGen space accordingly. when garbage collection (GC) runs. These may be variables that were used for methods which have already returned their values. If you increase the amount of memory available to the JVM. Some of these objects are long-lived. especially with 64 bit systems. For this reason. but the larger the JVM. This prevents the JVM from having to reallocate memory if the application needs more. The first two settings should be set to the same value. run multiple JVMs of Liferay instead. Hibernate. Once it finds them. The ones that are not become de-referenced. Issues with PermGen space can also affect performance. the more time it takes for garbage collection to take place. you will definitely want to increase the amount of memory available to the JVM. in particular— which Liferay uses extensively—has been known to make use of PermGen space. PermGen space contains long-lived classes. If. YourKit. These objects sit in memory and fill up the heap space until the JVM decides it's time to clean them up. objects retrieved from the database for a user that is no longer logged on. -Xms1024m -Xmx1024m -XX:MaxPermSize=128m This is perfectly reasonable for a moderately sized machine or a developer machine. Note that there is a law of diminishing returns on memory. These systems allow you to create very large JVMs. These settings give the JVM 1024MB for its regular heap size and have a PermGen space of 128MB. To take advantage of higher amounts of memory on a single system. however. which means that the JVM no longer has a link to them because they have ceased to be useful. you probably won't want to create JVMs of more than 2 GB in size. it stops all processing in the JVM while it goes through the heap looking for dead objects. as all processing comes to a halt while GC is happening. Garbage Collection As the system runs. it frees up the memory they were taking up. anonymous classes and interned Strings. or a host of other things. and then processing can continue. the first thing you might want to look at is increasing the memory available to the JVM.

and two “survivor spaces. After this. operating system. where long-lived objects reside. surviving objects may be moved to the old generation. and application server. For this reason. and the “From” space is then cleared out altogether. By default. this garbage collector makes one short pause in application execution to mark objects directly reachable from the application code. The young generation is further divided into three sections: Eden. which is where new objects are created. After a predetermined number of “generations” of garbage collection. Generally. Then it allows the application to run while it marks all objects which are reachable from the set it marked.Enterprise Configuration of time processing is halted while garbage collecting happens. Any other objects in that space which still have references to them are moved to the “To” space. Eden is swept for objects which are no longer referenced. Rather than halting application processing altogether. Garbage collection occurs in stages. Similarly. and even less frequently done in the permanent generation.” which we can call the From and To spaces. and the permanent generation. and the “From” space is then swept. less frequently done in the old generation. As always. you will need to use a profiler to monitor garbage collection during a load test to tune the numbers properly for your server hardware. the JDK uses a serial garbage collector to achieve this. you may wish to switch to the Concurrent Mark-Sweep (CMS) collector. This works very well for a short-lived desktop Java application. and processing is freed up again until the next time the JVM determines that garbage collection needs to run. These can improve the performance of your Liferay installation if applied properly. it adds another phase called 276 Performance Tuning . the old generation. Those that are still around are moved to the “To” survivor space. it is more frequently done in the young generation. Finally. When garbage collection runs in the young generation. the “From” and the “To” spaces swap roles. but is not necessarily the best performer for a server-based application like Liferay. surviving objects may be moved to the permanent generation. after a predetermined number of “generations” of garbage collection in the old generation. Illustration 87: Java memory The Java heap is divided into sections for the young generation.

This has the effect of greatly reducing the amount of time that execution needs to be halted in order to clean out dead objects. This decreases garbage collection overhead and increases application throughput.check=false Set this property to true to load the theme's merged CSS files for faster loading for production. ParallelGCThreads: The number of threads to use for parallel garbage collection. +UseConcMarkSweepGC: Use the Concurrent Mark-Sweep Garbage Collector. +CMSParallelRemarkEnabled: For the CMS GC. and is good for applications that have a relatively large set of long-lived data. The default is 25.Enterprise Configuration the remark phase which finalizes marking by revisiting any objects modified while the application was running. MaxNewSize: The initial size and the maximum size of the New or Young Generation. this: A sample configuration using the above parameters might look something like JAVA_OPTS="$JAVA_OPTS -XX:NewSize=700m -XX:MaxNewSize=700m -Xms2048m -Xmx2048m -XX:MaxPermSize=128m -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX: +CMSParallelRemarkEnabled -XX:SurvivorRatio=20 -XX:ParallelGCThreads=8" Properties File Changes There are also some changes you can make to your portal-ext. and that run on machines with two or more processors. This decreases the pauses during this phase. enables the garbage collector to use multiple threads during the CMS remark phase. +UseParNewGC: Causes garbage collection to happen in parallel. It's a ratio between the survivor space size and Eden. Set the following to false to disable checking the last modified date on server side CSS and JavaScript. such as web servers. In your profiling. There's not much bang for the buck here. last. you may want to experiment with some of the following settings to see if any of them can increase your performance.modified. This uses shorter garbage collection pauses. Just about every aspect of the way memory management works in Java can be tuned. ServivorRatio: Controls the size of the two survivor spaces.css.load=true Set this property to true to load the combined JavaScript files from the property Performance Tuning 277 . By default it is set to false for easier debugging for development. You can also disable fast loading by setting the URL parameter css_fast_load to 0. NewSize. using multiple CPUs. but it may need to be adjusted. theme.fast.properties file once you are in a production environment. It then sweeps through and garbage collects. Should be equal to the number of CPU cores in your server.

username= jdbc.load=true Servlet Filters Liferay comes by default with 17 servlet filters enabled and running. comment out the CAS Filter. if you are not using CAS for single sign-on.2.write. one for reading.mysql.properties file.Enterprise Configuration javascript.read. If there is a feature supported by a servlet filter that you know you are not using. Read-Writer Database Configuration Liferay 5.files into one compacted file for faster loading for production. Portlets Liferay comes pre-bundled with many portlets which contain a lot of functionality. but not every web site that is running on Liferay needs to use them all.mysql.read.x allows you to use two different data sources for reading and writing. comment out the ones you are not using.driverClassName=com. For example. While having a loan calculator. To disable a servlet filter.fast.driverClassName=com. By default it is set to false for easier debugging for development. The fewer servlet filters you are running. or game of hangman available for your users to add to pages is nice.password= jdbc. It is likely that for your installation. commenting out some of the unused portlets may give you the performance boost you need.jdbc. the less processing power is needed for each request.xml file. In your portal-ext. This enables you to split your database infrastructure into two sets: one that is optimized for reading and one that is optimized for writing. In portlet. You can also disable fast loading by setting the URL parameter js_fast_load to 0.url=jdbc:mysql://dbread. If you are having performance problems. comment out the Ntlm Filter. javascript. If you are not using the Virtual Hosting for Communities feature.read.xml. those portlets may be taking up resources that are needed by custom portlets you have written for your site.xml and liferay-portlet. you can comment it out as well to achieve some performance gains. you can then use your database vendor's replication mechanism to keep the databases in sync in a much faster manner than if you had a single data source which handled everything.Driver 278 Performance Tuning . configure two different data sources for Liferay to use. Enabling a read-writer database is simple. simply comment it out of your web. If you are not using NTLM for single sign-ons.jdbc.read. you don't need them all. and one for writing: jdbc.Driver jdbc. Since all major databases support replication in one form or another.com/lportal?useUnicode=true& \ characterEncoding=UTF-8&useFastDateParsing=false jdbc. analog clock. comment out the Virtual Host Filter.

password= Of course.\ META-INF/wsrp-spring.xml.\ \ META-INF/counter-spring. enable the read-writer database configuration by uncommenting the Spring configuration file which enables it in your spring.configs=\ META-INF/base-spring.\ META-INF/mail-spring.username= jdbc.\ META-INF/document-library-spring.\ META-INF/portal-spring. In diagrams. a database is normally Performance Tuning 279 .3 supports database sharding for different portal instances.write.xml.xml.\ META-INF/scheduler-spring.xml.xml.\ #META-INF/shard-data-source-spring.xml.xml.\ \ META-INF/hibernate-spring.\ META-INF/jcr-spring.\ META-INF/lock-spring.xml. Sharding is a term used to describe an extremely high scalability configuration for systems with massive amounts of users.xml.\ META-INF/messaging-spring.\ \ META-INF/util-spring.xml.xml The next time you restart Liferay.xml.\ META-INF/search-spring.xml.xml. Be sure to make sure that you have correctly set up your two databases for replication before starting Liferay. it will now use the two data sources you have defined.\ META-INF/portlet-container-spring.Enterprise Configuration jdbc.xml.configs property (line to uncomment is in bold: spring.\ META-INF/infrastructure-spring. specify the user name and password to your database in the above configuration.xml.write.xml.url=jdbc:mysql://dbwrite.\ \ META-INF/mirage-spring.write.\ \ META-INF/editor-spring. Database Sharding Liferay starting with version 5.\ \ META-INF/ext-spring.xml. After this.com/lportal?useUnicode=true& \ characterEncoding=UTF-8&useFastDateParsing=false jdbc.xml.\ META-INF/management-spring.xml.\ \ META-INF/dynamic-data-source-spring.xml.2.

one.driverClassName=com. This is a class which serves as the default algorithm for sharding in Liferay.dao.password= shard.shard.ManualShardSelector #shard. Next. abc1. Of course.Driver jdbc. For example.password= jdbc. automatically. If that bottle were a database.default.selector=com.username= jdbc. By default.two Once you do this. abc3. with a subset of the data in each shard.driverClassName=com. This allows you to split up your database by various types of data that might be in it. Liferay will select from several different portal instances and evenly distribute the data across them.selector=com. processing is split up evenly.two. Set your various database shards in your portal-ext.two.properties file: shard.username= jdbc. you can set up your DNS so that several domain names point to your Liferay installation (e. if you wish to have your developers implement your own sharding algorithm. If you are using the RoundRobinShardSelector class.default. Liferay will automatically enter data into each instance one by one.selector=[your implementation here] Enabling sharding is easy.Enterprise Configuration pictured as a cylinder. Using this algorithm.password= jdbc.Driver jdbc.shard. and the amount of data the application needs to sort through is reduced.. If you are using the Manu280 Performance Tuning . In this manner. When users log in. Instead.Driver jdbc.mysql. each shard now is a database.properties file this way: jdbc. they are directed to the instance of the application that is connected to the database that corresponds to their last names. You will need to make sure you are using Liferay's data source implementation instead of your application server's.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.liferay.mysql.jdbc. There will be shards of glass everywhere. etc.two.url=jdbc:mysql://localhost/lportal1?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc. using the round robin shard selector. picture it as a glass bottle full of data.com).names=default. go to the Control Panel and click Portal Instances in the Server category.driverClassName=com.com. some implementations of sharding a database split up the users: those with last names beginning with A to D go in one database.one.liferay.portal. E to I go in another. Create two to three instances bound to the DNS names you have configured. you can do that.one.jdbc.RoundRobinShardSelector #shard.username= jdbc.url=jdbc:mysql://localhost/lportal2?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false jdbc.available.one. Liferay allows you to support sharding through different portal instances.mysql.one.jdbc.com.portal.default.two. Now take that bottle and smash it onto a concrete sidewalk.g.dao. You can select which algorithm is active via the portal-ext.default. abc2.

\ META-INF/shard-data-source-spring.configs section of your portal-ext.\ META-INF/portal-spring. you will have to specify a shard for each instance using the UI. Your system is now set up for sharding.xml.xml.xml.\ \ META-INF/editor-spring.\ META-INF/scheduler-spring.\ META-INF/wsrp-spring.xml.xml. To do this.\ META-INF/portlet-container-spring.\ \ META-INF/mirage-spring.\ META-INF/messaging-spring.\ \ META-INF/hibernate-spring.Enterprise Configuration alShardSelector class.configs should look like this (modified section is in bold): spring.\ META-INF/search-spring.configs=\ META-INF/base-spring.xml.xml.xml.\ \ That's all there is to it.xml.xml.\ META-INF/document-library-spring.\ META-INF/mail-spring.xml. Performance Tuning 281 .xml.\ META-INF/jcr-spring.xml.xml.\ \ #META-INF/dynamic-data-source-spring.xml.\ \ META-INF/util-spring.\ META-INF/lock-spring.\ \ META-INF/counter-spring.\ META-INF/management-spring. The last thing you will need to do is modify the spring.xml.xml.\ META-INF/infrastructure-spring.properties file to enable the sharding configuration. your spring.xml. which by default is commented out.xml.xml.

.

and Liferay as a Java EE application fits well into these standards. When you sign up for Google Analytics. We will not cover specific backup software or procedures.7. This problem can be solved in Liferay by putting Google's code into a custom theme written especially for the site on which the portal is running. This chapter will cover the following topics: ● ● ● ● Liferay Monitoring using Google Analytics Backing Up a Liferay Installation Changing Logging Levels Upgrading Liferay The discussion on back up will cover what parts of Liferay should be backed up. however. generally. It can be a tedious process to add this code to every page on a site. There are. a snippet of code is provided which needs to be added to your web pages in order to allow Google's system to register the page hit. Liferay Monitoring Using Google Analytics Liferay includes built-in support for Google Analytics. especially if it is a large site and there is a lot of user-generated content. MAINTAINING A LIFERAY PORTAL Maintaining a running implementation of Liferay Portal is not much different from maintaining the application server environment upon which it is running. outlining for system administrators some specifics about keeping a running Liferay instance stable and secure. several factors which administrators should be aware of when they are responsible for a running instance of Liferay. most organizations have standards for doing backups of their systems. Doing this. This chapter will cover these issues. allowing administrators to make use of Google's tool set for analyzing site traffic data. .

Illustration 88: Setting Up Google Analytics Click the Monitoring Tab. go to the Manage Pages screen for the community for which you want to enable support. Backing Up A Liferay Installation Once you have an installation of Liferay Portal running. This allows your developers convenient access to all of the tools they need to build your extension and deploy it to a server. and then clicking Actions → Manage Pages for the community or organization you want to analyze. Click the Settings tab. To enable Google Analytics support. requires that a theme developer make specific changes to the theme. but there are some specific components that need to be backed up in addition to your regular backup procedures for your application server. and can be turned on through a simple user interface. Source Code If you have extended Liferay or have written portlet or theme plugins. CVS. 284 Backing Up A Liferay Installation . and it prevents users from using the many freely available themes that are available for Liferay “out of the box. you will want to make sure that you also store the version of the Liferay source on which your extension environment is based. support for Google Analytics has been built into Liferay. Put your Google Analytics ID (which should have been provided to you when you signed up for the service) in the field and click Save.” Because of this. you will want to have proper backup procedures in place in case of a catastrophic failure of some kind.Maintaining A Liferay Portal however. If you are extending Liferay with the Extension Environment. or Git. All of the pages in the community you selected will now have the Google Analytics code in them and will be tracked. This allows Liferay Administrators to make use of Google Analytics on a community by community basis and turn it on and off when needed. You can do this through the Control Panel by going to either the Organizations or Communities link in the Portal section. This repository should be backed up on a regular basis to preserve your ongoing work. Liferay is not very different from any other application that may be running in your application server. they should be stored in a source code repository such as Subversion.

To view the log levels. such as DEBUG. cache information. go to the Control Panel. it can be used to recreate the state of the database at the time the dump was created. If you need to debug something specific while a system is running. you Liferay's Logging System 285 . Liferay's Logging System Liferay uses Log4j extensively to implement logging for nearly every class in the portal. MySQL ships with a mysqldump utility which allows you to export the entire database and data into a large SQL file. This file can then be backed up. If you have modified the location where the Document Library stores files. this file should be backed up. At a minimum.properties. You will then see a paginated list of logging categories. By default. you can use the Control Panel to set logging levels by class dynamically. This is why you see ERROR displayed in all of the drop down list boxes on the right side of the portlet. You will need to back up this location. In case of a database failure. you will have cache configuration files in the deploy location of Liferay. all categories are set to display messages only if there is an error that occurs in the class. the Jackrabbit database should be backed up also. if you wanted to see logging for a specific class that is registered in Liferay. gets stored in the Liferay Home folder. you would browse to that specific class and change its log level to something that is more descriptive. You can do this by either backing up the database live (if your database allows this) or by exporting the database and then backing up the exported file. If you have followed the procedure in the previous chapter to modify your ehcache configuration. but it is generally best to back up your whole application server. search indexes. For example. which is generally one folder up from where your application server is installed (see Chapter 1 for specific info for your application server). Liferay also stores configuration files. click Server Administration in the Server section. These categories correspond to Liferay classes that have log messages in them. You should generally back up all of the contents of your Liferay Home folder. If you are using Liferay's Document Library with the Jackrabbit JSR-170 repository to store documents in a database.Maintaining A Liferay Portal Liferay's File System Liferay's configuration file. and then click the Log Levels tab. and the default Jackrabbit document repository in a folder called data in Liferay Home. Each category is filtered by its place in the class hierarchy. Once you click the Save button at the bottom of the list. For example. Database Liferay's database is the central repository for all of the Portal's information and is the most important component which needs to be backed up. you should also back up this location. portal-ext.

This could make it difficult to find the one you were looking for.getLog(JCRHook. You will first need to implement Log4J logging in your class. You would then use this _log variable to create log messages in your code for the various logging levels: _log. you may wind up with a lot of messages in your log file. If you do this. To enable your logging messages to appear in your server's log file via the Control Panel. for example). with a statement such as the following (taken from Liferay's JCRHook class): private static Log _log = LogFactory. click the Add Category tab on the same Log Levels page. Illustration 89: Changing Logging Levels Be careful when you do this. Simply put in the fully qualified name of your class or of the package that contains the classes whose log messages you want to view. You will see that you can add a logging category. If you are not sure which class you want to see log messages for. you can register that class (so long as it uses Log4J to do its logging) with Liferay so that you can control the log levels more easily. If you are working in the extension environment or have created a plugin and want to set the log level for one of your own classes. 286 Liferay's Logging System .class). e1). If you set the log level to DEBUG somewhere near the top of the hierarchy (such as com.getName().Maintaining A Liferay Portal will start seeing DEBUG messages from that class in your application server's log file. messages for every class lower in the hierarchy will be displayed in your application server's log file. and causes the server to do more work writing messages to its log file.error("Reindexing " + node.liferay. You will now start to see log messages from your own class or classes in the server's log file. and then click the Save button. you can find a place higher up in the hierarchy and select the package name instead of an individual class name. choose a log level.

5 to Liferay 5.4.x.0 and higher can auto-detect whether the database requires an upgrade the first time the new version is started. and then 5. drop. but not from 4.4. Portlet plugins are generally backwards compatible. This doesn't mean you need to run the procedure for every point release (i.3. Much effort has been made to make upgrades as painless as possible. it will automatically upgrade the database to the format required by the new version. If you need to upgrade over several major releases. you would first run the upgrade procedure for 4. you only need to run the procedure for the major releases.0 (JSR-286) standard has also been designed to be backwards-compatible.6 to 4. This includes Portlet 1.2.4.).2. Liferay must be accessing the database with an ID that can create. you can upgrade from one major release to the next major release.2.4. As a general rule. so it is important to test as much as possible.x to 5. this is not a guarantee that everything will work without modification. etc. as they are written to the Java standard. When Liferay does this.0 to 4. and modify tables..3. then 5. Extension environment changes are the most complicating factor in an upgrade.0 (JSR-168) portlets. Liferay Upgrade Procedure Liferay 4. A consistent set of steps is all you need to follow to upgrade a standard Liferay installation.1.5 to 4. is usually fairly straightforward for your developers to fix. Theme plugins may require some modifications in order to take advantage of new features. however.e.0. Make sure that you have granted these permissions to the ID before you attempt to upgrade Liferay. then 5. This. For example.4.4. It is also a good idea to backup your database before attempting an upgrade in case something goes wrong during the process. So if you wanted to upgrade from Liferay 4. Things do get more complicated if your organization has used the extension environment to customize Liferay. you will need to run the upgrade procedure for each major release until you reach the release you want. you can upgrade directly from Liferay 4.x.3.2.0.3. however. In order to do this.3. as the Portlet 2. as it is possible that API changes in the new version will break your existing code.x to 4. Upgrading Liferay 287 .1. A good practice is to use the latest version of each major release to upgrade your system.1. 4.3.Maintaining A Liferay Portal Illustration 90: Adding a Logging Category Upgrading Liferay Liferay upgrades are fairly straightforward.

3. UPGRADE STEPS It takes only four steps to upgrade a standard Liferay installation: 1. Follow the deployment instructions in Chapter 1 or in Chapter 5 (if you have customized Liferay).properties file to a safe place. Deploy the new Liferay . 3. Note that as stated above. Review the portal.properties changes and re-configure your previous customizations as necessary.4. That's all there is to it. Edited their custom {Model}LocalServiceImpl classes and make them extend from {Model}LocalServiceBaseImpl. If you are using version 4.com.x. 288 Upgrading Liferay .2. Make sure your Liferay . and then undeploy the old version of Liferay and shut down your application server. 4. Watch the console as Liferay starts: it should upgrade the database automatically.jars are all the same version. What follows are instructions for upgrading for specific versions. overwriting the ones you already have for the old version of Liferay.war and dependency . Start (or restart) your application server. Copy your customized portal-ext.Maintaining A Liferay Portal Tip: Liferay versions prior to 4. Copy the new versions of the dependency .liferay. you must start at 4. 2. if you have to upgrade over several Liferay versions. 2.4 PREREQUISITE In order to upgrade to 4. IF YOUR DEVELOPERS HAVE CUSTOMIZED LIFERAY If you are deploying Liferay from an extension environment. If you need to upgrade from Liferay 4.2 or below.3. They will be in the SQL folder of the archive. Run Service Builder for each custom service. you can find these SQL scripts in the source code archive for the version of Liferay you are running.war file to your application server.3 to Liferay 4.2. ensure that your developers have: 1.0 or above. restarting when customizations are complete. Follow the generic upgrade steps above.x to 4.x.1.0 require that you manually run SQL scripts on your database to perform an upgrade. you will need to repeat these steps for each major release.jars to a location on your server's class path. please see the upgrade instructions on Liferay's wiki at http://wiki. Upgrading Liferay 4. Everything else is handled by Liferay's upgrade procedure.

0 includes an automatic translator that will convert all of the pages in the database to Creole.com/dtd/liferay-portlet-app_4_3_0.3. It may also be more familiar to your users if they have experience with other popular wikis like MediaWiki or Confluence.org) syntax because it's more powerful and easier to learn and use. Many of the DTD references in the various -ext.0EN" "http://www.4. IF YOUR DEVELOPERS HAVE CUSTOMIZED LIFERAY If you are deploying Liferay from an extension environment. and custom written finders and LocalServiceImpl methods need to be adopted.x: <!DOCTYPE liferay-portlet-app PUBLIC "-LiferayDTD Portlet Application 4.xml files to the new DTDs.x: <!DOCTYPE liferay-portlet-app PUBLIC "-LiferayDTD Portlet Application 4.VerifyWikiCreole verify. Follow the generic upgrade steps above. To run it.0EN" "http://www.0—and everything is backwards compatible. edit portal-ext. The generated code is slightly different.war and dependency . Run Service Builder again for each of the custom services after the previous change.xml files have changed (liferayportlet-ext. CONVERTING WIKI PAGES (OPTIONAL) If you were using the wiki portlet.0 PREREQUISITE In order to upgrade to 5.0.4. Be sure to compare your <!DOCTYPE references with the main file to insure they reference the same DTD.dtd"> Upgrading Liferay 4. ensure that your developers have upgraded their Service Builder .0 or above.frequency=-1 Start the server and let the process do the whole translation for you automatic- Upgrading Liferay 289 .verify.portal.properties files have moved from ext-impl/classes to ext-impl/src. Liferay 5.properties and portal-ext.com/dtd/liferay-portlet-app_4_4_0.4 to Liferay 5. Make sure your Liferay . EXAMPLE: Liferay 4.properties and set: verify. you must start at 4.Maintaining A Liferay Portal 3.dtd"> Liferay 4.liferay.jars are all the same version. you will be happy to find many new features and improvements in 5.4.wikicreole. To that end.processes=com.liferay.3.x. You may wish to convert your existing pages from the old Classic Wiki syntax to the new Creole (http://www.xml in particular). The system-ext.liferay.

permissions.liferay.check..Maintaining A Liferay Portal ally. In Tomcat.com/browse/LEP-6479.0. Upgrading Liferay 5.user.required: It's no longer required to be Power User to have a personal community. IF YOUR DEVELOPERS HAVE CUSTOMIZED LIFERAY Following is a list of API changes. If the portal is not operating the way you are used to. some files will be missing when deploying. -Dexternal-properties=portal-legacy-5. ● ● layout. Liferay now comes with several configuration files containing the defaults for previous versions. it is likely that this is because a default value has been changed.1 CHANGES IN CONFIGURATION PROPERTIES Because of changes in the default configuration.liferay. You can revert to the previous behavior by following the process below.bat or catalina. UPGRADE TROUBLESHOOTING ● ● ● The parameter p_p_action is now called p_p_lifecycle.com/browse/ LEP-6412 and http://support.properties Each application server has different methods to add this system property. otherwise the process will run every time you start Liferay. HOW TO KEEP THE OLD VALUES The default values of some properties has been changed.0.conf (depending on the exact version you are using). This has to be adapted for example in the FriendlyURLMappers if you want them to trigger a processAction(). WHAT HAS BEEN CHANGED? Here is a description of the most significant changes.user.layouts. Upload in Struts portlets is broken. Check the file portal-legacy5.user.properties for a full list of changed properties. If your developers used the extension environment to develop custom code review the following items and adapt your code accord290 Upgrading Liferay . Remember to change those properties back to their original state before the next startup. otherwise. See http://support.algorithm: the default value is now a new algorithm that is much faster. You need to copy parent-build.0 to Liferay 5. you would modify catalina.power. In order to keep the previous values you have to pass the following system property when running Liferay: java ..xml in ext-impl from our Subversion repository. This new property allows falling back to the old behavior.sh/catalina.private.

findForward(ActionConstants. return null. right after base. } Note that you can also optionally include an HttpServletResponse code in the sendError method.jsp. these changes were predominantly CSS only changes.bridges. UPGRADING THEMES There were a few changes between the Classic theme in 5.liferay.JSPPortlet need to be changed to com. e). response). but there are a couple that could cause confusion.0 and the Classic theme in 5. This file includes all of the styling that is used for application elements. NEW CSS FILE There is a new file which your developers will need to include a file called application.COMMON_ERROR). Error handling has been changed in order to provide a better end-user experience. most changes are minor.util. Upgrading Liferay 291 . tabs. you would add this line: @import url(application. and other elements. The list of these files is located in /css/main. and you edited the files directly. such as dialogs.JSPPortlet ○ Check that the paths to your JSP files in portlet. Overall.setAttribute(PageContext.liferay. However. } ● should be replaced with catch (Exception e) { PortalUtil. Some rules were added (that may need to be overwritten for your theme) and some rules were removed (and may need to be re-added). but if you built your theme from the plugins directory. you won't be affected.jsp.EXCEPTION. inline popups. for the most part. If however. tags. you may need to make a few adjustments to your CSS. If you were using any of those classes you will have to change the import package. For example. return mapping. and used the _diffs directory and placed your CSS changes in custom. In order to adapt to this change do the following: ○ Any references to com.css. The following construct: catch (Exception e) { req.1.sendError(e.portlet.css.xml are absolute paths (from the docroot).css). if your view. The JSPPortlet class has been moved to util-bridges so that it can be used from plugins.Maintaining A Liferay Portal ingly: ● ● Several classes have been moved from portal-impl to portal-kernel to make them available to plugins.css. set your view-jsp to /html/view. request. At the top.css.jsp lives in docroot/html/. These are covered below. your theme is already built.

ui-autocomplete-results . Essentially. one caveat.tabs is now . but older themes may rely on the “buggy” behavior.css.results-row. the default in 5.drag-indicator is now . relative. you absolutely must not have a positioned parent at all. Now.popup is now .portlet-section-alternate is now . However. the script will always overwrite it. The script now looks to see what the theme developer has specified and uses that.alt. however. it now will allow you to define other positioning (absolute.1 has been changed to true. top: 0. THE CLASS NAMES FOR DIFFERENT UI COMPONENTS HAVE CHANGED One of the only changes that will have a real impact is that the style .results-row. since that is what the browser will return if no positioning is applied.hover .portlet-section-body is now . the default setting for theme. The thinking is that because setting top: 0 on a statically positioned item has no effect visually.1. and will apply one whenever the CSS position is set to position: static. However.results-row.results-row .fast. then it will use static positioning. however. Sometimes.results-header . default styling for those class names have been removed from the Classic theme. the changes would take effect immediately on the next page load. In order to account for this.portlet-section-alternate-hover is now . There is.ui-proxy CHANGE IN THEME CSS FAST LOAD In 5.ui-dialog . The script.autocomplete-box is now .tag is now . Of course this means that when developers edit 292 Upgrading Liferay . there are often times when a theme requires that it use a different positioning mechanism. but have been left on the elements for now so that breakages will be kept to a minimum. So the problem in that situation is that if you must have position: static. needs a positioned parent in most cases.popup for the inline popups has been changed to .Maintaining A Liferay Portal THE PARENT ELEMENT OF THE DOCK MAY CHANGE POSITIONING WHEN UPGRADING In 5. or fixed) without worrying about your defined styling being overwritten.portlet-section-body-hover is now .1 a change was made to the Dock JavaScript which is a fix. however. we use it as a trigger to say that you really want to use static positioning.ui-dialog.alt .load was false which means that when developers edited the deployed CSS files.ui-tabs .0. Other class name changes have been made. for the sake of better out of the box performance.portlet-section-header is now . the CSS positioning of the Dock's parent was always set to relative. The class names that have been changed are as follows: ● ● ● ● ● ● ● ● ● ● .hover .ui-tag . checking has been added so that if your CSS selector has these two rules: position: static.

Also.load from false to true. So.showTemplates().fast. Upgrading Liferay 293 . will inject the needed files. This might useful. respectively. and removing the Interface library.Maintaining A Liferay Portal the deployed CSS files directly.add() and Liferay. CHANGE IN JAVASCRIPT FAST LOAD For the same reasons as described above.1).addHTML(). you can also deploy an empty index. developers should make the change in the pre-deployed theme and run the deploy process on the theme for the changes to be bundled and packed into the everything_packed. upgrading jQuery to the latest version (version 1. including everything in the WEB-INF directory. Developers may want to revert it to false for the same reason. should be zipped and re-deployed through the Plug-In Installer. including the addition of new init-param values (see: http://support. they will not see the changes take effect immediately on the next page load. for example if you want to make sure the ID of your portlet does not change (especially if you have many instances scattered throughout your site). To upgrade an old PHP portlet. developers should first make a back-up of the existing portlet.Portlet. CSS. javascript). images. UPGRADING PHP PORTLETS Some changes were made to the handling of PHP portlets.liferay. Instead. major changes to util-java classes (such as the elimination of StringMaker. CHANGED METHODS addPortlet. the solution to get the old behavior is simply to revert theme. Then the PHP portions (including HTML.xml file to keep track of versions and compatibility.css file.php file in a ZIP through the Plug-In Installer and then use the result to do a “DIFF” of your existing portlet with the injected portions of the new portlet.load to false and restart the portal. ShowLayoutTemplates: This is now Liferay. for example) requires that some of the JARs in WEB-INF/lib be updated.fast.6 in Liferay 5.Layout. as usual.2.css. JAVASCRIPT CHANGES The Javascript in Liferay has undergone a refactoring to use the jQuery UI engine. the Quercus libraries. or if you've been using the liferay-plugin-package. and so forth.Portlet. a change was made to javascript. Then the parts that need to be changed can be manually updated in the existing portlet. We've also removed and changed many of our methods that were polluting the global name space and/or were not being used anymore.com/browse/LEP-6465). This of course might make it harder for theme developers to do real-time testing. Liferay. addPortletHTML: These have now been changed to Liferay. If your developers are uneasy about this approach.

NavFlyout. var index = radioGroup. var y = event. AjaxRequest.toJSON(obj) respectively.disable: Please use Liferay. and Liferay.mousemove( function(event){ var x = event. DragLink.ajax or any of the other jQuery AJAX methods.index(radioGroup. respectively.scroll(). } ). and Liferay.parseJSON(str) and jQuery.frame.StarRating(). Element.Util.viewport.Util. If you absolutely must have the actual numerical index of the selected item. as it was being used to select the “checked” item in a group of radio buttons. Coordinate.Util.filter(':checked').1.Util. PortletHeaderBar: No longer needed. Liferay. onMouseover).Portal. and loadPage: Please use jQuery.Maintaining A Liferay Portal StarRating. Tooltip. Element.Portal.Util.pageY.getSelectedIndex: No longer needed. LinkedList. MousePos: No longer needed. like so: jQuery(window). Coordinates. ThumbnailRating. Upgrading From Liferay 5.viewport.2 available as it will have fixed all the potential upgrade issues that may have been found.1 to Liferay 5. you can reliably use the event. 294 Upgrading Liferay . Liferay.2 Always use the latest version of 5. REMOVED JAVASCRIPT METHODS AjaxUtil.viewport.filter(':checked')[0]). Liferay. Liferay. You can use jQuery. or if you're attaching events with jQuery.page: These are now Liferay. Viewport.ThumbnailRating(). Liferay. you could do: var radioGroup = jQuery(Element|Selector).Util. Liferay.remove().page().pageY properties. PREREQUISITE It's recommended to upgrade first at least to 5.Tabs respectively.Tooltip. If you need mouse coordinates during an event (such as onMousemove.Util. Viewport.Portal.toJSONObject: No longer needed.frame().Portal.2SE if you are running any previous version. To do the same thing.pageX and event.disableElements().pageX. you would do something like: jQuery(Element|Selector).toJSONString.remove: Please use jQuery(selector). PhotoSlider. Tabs: These are now Liferay.scroll. Viewport.

The scripts setenv.Maintaining A Liferay Portal CHANGES IN CONFIGURATION PROPERTIES HOW TO KEEP THE OLD VALUES The default values of some properties has been changed.auto=true organizations.repositories.documentlibrary.root}/lucene/ jcr.bat and append that option to the environment variable JAVA_OPTS.repositories. Tomcat will use them in the startup process.membership.strict=false organizations.JCRHook dl.root=${user. It's still possible to use application server specific data sources and pools if desired by using certain configuration properties..sh/setenv.1.properties file to unify the configuration through all application servers.1. In order to keep the previous values you have to run Liferay passing the following system property: java .assignment.assignment. Here are the complete contents of that file (portal-legacy-5.sh or setenv.bat are not delivered with Tomcat but if they exist.required[regular]=true organizations.home}/liferay theme. THEME UPGRADE Instructions for maintaining customized themes built in 5.root=${resource.system.hook.root}/document_library IMPORTANT INTEGRATION CHANGES IN THE CONFIGURATION OF DATABASE ACCESS AND MAIL One very important aspect of the upgrade is that now the configuration of the database parameters and those for mail integration are handled through the portalext.sharing.properties Each application server has different methods to add this system property.dir=${resource.1 without redeploying with the new SDK : • Change the header of /WEB-INF/liferay-plugin-package.impl=com. This is documented in Chapter 1.root}/jackrabbit dl.dir=${resource.country.properties) for reference: resource.util.repositories.repository.strict=true lucene.file.default=true organizations.portlet.jackrabbit.repositories.root.liferay. -Dexternal-properties=portal-legacy-5.hook. In Tomcat modify setenv. so it's a nice way to separate your own settings from tomcat's default shell scripts.xml to: 295 Upgrading Liferay ..

delete the following lines : $theme.dtd">] • Upgrade compatibility version in liferay-look-and-feel.2..png). although the services that store any type of content will require you to specify at least the scopeGroupId.com/dtd/liferay-plugin-package_5_2_0.CompressionFilter into com.vm: #if ($show_control_panel) <li class="control-panel"> <a href="$control_panel_url">$control_panel_text</a> </li> #end • In navigation.servlet.GZipFilter. API CHANGES USAGE OF SERVICECONTEXT IN LIFERAY'S SERVICES LAYER The most significant API change in 5. Here is a simple example of how to create a ServiceContext instance and pass it to a service API: ServiceContext serviceContext = new ServiceContext().portal.com/dtd/liferay-look-and-feel_5_2_0. you will see a blank page and an exception. • In order to display the control panel in the dock.include($session_timeout_include) $theme.servlet.include($bottom_ext_include) $theme.xml: <version>5.portal.filters. from the classic theme In WEB-INF/web.xml./images/dock/control_panel.0//EN" "http://www.liferay.2.vm. The Service Context is an object that contains context information about a given API call.liferay.2 is that most APIs of the service layer have been adapted to use the Service Context Pattern.compression.png (ROOT/html/themes/classic) into your theme.liferay.control-panel a { } • • Then copy /images/dock/control_panel.liferay.filters.Maintaining A Liferay Portal <!DOCTYPE plugin-package PUBLIC "-//Liferay//DTD Plugin Package 5. .lfr-dock li.0//EN" "[http://www. All of the fields in this object are optional.xml to: <!DOCTYPE look-and-feel PUBLIC "-//Liferay//DTD Look and Feel 5.dtd"> • Change the header of /WEB-INF/liferay-look-and-feel.2. add the following lines in dock.include($sound_alerts_include) If you don't remove these.gzip. 296 Upgrading Liferay . change the deprecated declaration com.css: background-image: url(.2+</version> <compatibility> </compatibility> • In portal.

or any other front end class which has access to the portletRequest..addEntry(.getInstance(BlogsEntry.. you can use a utility method that will create the ServiceContext object and fill it with all the necessary values automatically. serviceContext). serviceContext)....setScopeGroupId(myGroupId).. In that case the above example should be rewritten as follows: ServiceContext serviceContext = ServiceContextFactory. Upgrading Liferay 297 . portletRequest). If you are invoking the service from a servlet..getName(). BlogsEntryServiceUtil.Maintaining A Liferay Portal serviceContext. BlogsEntryServiceUtil. a Struts action.addEntry(..class.

.

CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. "Adaptation" means a work based upon the Work.0 Unported license. 1. or upon the Work and other pre-existing works. Creative Commons License CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE. or . such as a translation. THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. and is released under the Creative Commons Attribution-Sharealike 3. derivative work. Definitions a. License THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED. Inc.8. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. APPENDIX: DOCUMENTATION LICENSE The text of this book is copyrighted by Liferay. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. adaptation. AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.. YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT. arrangement of music or other alterations of a literary or artistic work.

phonograms or broadcasts. and. (iii) in the case of broadcasts. f. and in addition (i) in the case of a performance the actors. except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. constitute intellectual creations. including. ShareAlike. in the case of a literary or artistic work. at a minimum. such as encyclopedias and anthologies. pamphlet and other writing. and other persons who act. whatever may be the mode or form of its expression including digital form. "Work" means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary. For the avoidance of doubt. which. interpret or otherwise perform literary or artistic works or expressions of folklore. "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution. or adapted including in any form recognizably derived from the original. individuals. (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds. (ii) explicitly permits the relicensing of adaptations of works made available under that license under this License or a Creative Commons jurisdiction license with the same License Elements as this License. declaim. a dramatic or dramatico-musical work. "Distribute" means to make available to the public the original and copies of the Work or Adaptation. sermon or other work of the same nature. a lecture. entity or entities that offer(s) the Work under the terms of this License. or performances. the publisher. such as a book. 300 . or other works or subject matter other than works listed in Section 1(f) below. the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License. c. A work that constitutes a Collection will not be considered an Adaptation (as defined below) for the purposes of this License. "Collection" means a collection of literary or artistic works. meaning and effect as the License Elements of this License. and. musicians. h. g. "Original Author" means. a cinematographic Creative Commons License b. entity or entities who created the Work or if no individual or entity can be identified. as appropriate.Appendix: Documentation License phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast. d. each constituting separate and independent works in themselves. the individual. play in. "Creative Commons Compatible License" means a license that is listed at http://creativecommons. performance or phonogram. a choreographic work or entertainment in dumb show. a musical composition with or without words. through sale or other transfer of ownership. individuals. e. dancers. in which the Work is included in its entirety in unmodified form along with one or more other contributions. where the Work is a musical work. transformed. sing. "Licensor" means the individual. address.org/compatiblelicenses that has been approved by Creative Commons as being essentially equivalent to this License. the organization that transmits the broadcast. by reason of the selection and arrangement of their contents. deliver. which together are assembled into a collective whole. singers. because that license: (i) contains terms that have the same purpose. scientific and artistic domain.

including any translation in any medium. a performance. royalty-free. e. including by wire or wireless means or public digital performances. Non-waivable Compulsory License Schemes. "Reproduce" means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work. j. or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work.Appendix: Documentation License work to which are assimilated works expressed by a process analogous to cinematography. or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws. d. a work of drawing. plan. to create and Reproduce Adaptations provided that any such Adaptation. Nothing in this License is intended to reduce. to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them. perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below: a. to Reproduce the Work. a translation could be marked "The original work was translated from English to Spanish. takes reasonable steps to clearly label. to Distribute and Publicly Perform the Work including as incorporated in Collections. a broadcast. For the avoidance of doubt: i. sketch or three-dimensional work relative to geography. Subject to the terms and conditions of this License. c. "Publicly Perform" means to perform public recitations of the Work and to communicate to the public those public recitations. to perform the Work to the public by any means or process and the communication to the public of the performances of the Work. and to Reproduce the Work as incorporated in the Collections. limit. k." or a modification could indicate "The original work has been modified. and. b. topography. painting. 3. Licensor hereby grants You a worldwide. For example. demarcate or otherwise identify that changes were made to the original Work. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work. 2. a work of applied art. to Distribute and Publicly Perform Adaptations. by any means or process. In those jurisdic- Creative Commons License 301 . a photographic work to which are assimilated works expressed by a process analogous to photography. i. an illustration. or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.". sculpture. architecture or science. to broadcast and rebroadcast the Work by any means including signs. map. sounds or images. Fair Dealing Rights. to incorporate the Work into one or more Collections. including by public digital performance. engraving or lithography. including storage of a protected performance or phonogram in digital form or other electronic medium. License Grant. a phonogram. non-exclusive. a compilation of data to the extent it is protected as a copyrightable work. architecture.

upon notice from any Licensor You must. If You create a Collection. or the Uniform Resource Identifier (URI) for. This Section 4(a) applies to the Work as incorporated in a Collection. and. to the extent practicable. the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License. You may Distribute or Publicly Perform an Adaptation only under the terms of: (i) this License. You must include a copy of. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. via that society. 4.Appendix: Documentation License tions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived. this License with every copy of the Work You Distribute or Publicly Perform. to the extent practicable. ii. (ii) a later version of this License with the same License Elements as this License. from any exercise by You of the rights granted under this License.0 US)). The license granted in Section 3 above is expressly made subject to and limited by the following restrictions: a. (iv) a Creative Commons Compatible License. upon notice from any Licensor You must. If you license the Adaptation under the terms of any of the licenses 302 Creative Commons License . The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. the Licensor waives the exclusive right to collect such royalties for any exercise by You of the rights granted under this License.g. as requested. You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. iii. remove from the Adaptation any credit as required by Section 4(c). remove from the Collection any credit as required by Section 4(c). In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived. You may not sublicense the Work.. you must comply with the terms of that license. b. all rights not expressly granted by Licensor are hereby reserved. If You create an Adaptation. The above rights may be exercised in all media and formats whether now known or hereafter devised. Voluntary License Schemes. Attribution-ShareAlike 3. as requested. You may Distribute or Publicly Perform the Work only under the terms of this License. in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes. The Licensor waives the right to collect royalties. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. Restrictions. whether individually or. but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. When You Distribute or Publicly Perform the Work. (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e. Waivable Compulsory License Schemes. If you license the Adaptation under one of the licenses mentioned in (iv). Subject to Section 8(f).

keep intact all copyright notices for the Work and provide. d.. express prior written permission of the Original Author.. sponsorship or endorsement by the Original Author.g. (IV) when You Distribute or Publicly Perform the Adaptation. if applicable) if supplied. a sponsor institute. if any. the Applicable License with every copy of each Adaptation You Distribute or Publicly Perform. that in the case of a Adaptation or Collection. Japan). consistent with Ssection 3(b). or Publicly Perform the Work or any Adaptations or Collections. at a minimum such credit will appear. If You Distribute. by exercising Your rights under this License. reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym. c. "French translation of the Work by Original Author. publishing entity. (ii) the title of the Work if supplied. The credit required by this Section 4(c) may be implemented in any reasonable manner. the name of such party or parties.Appendix: Documentation License mentioned in (i). the URI. a credit identifying the use of the Work in the Adaptation (e. unless a request has been made pursuant to Section 4(a). but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License. You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. For the avoidance of doubt. This Section 4(b) applies to the Adaptation as incorporated in a Collection. then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. unless such URI does not refer to the copyright notice or licensing information for the Work. You must. (II) You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License. and/or if the Original Author and/or Licensor designate another party or parties (e. in the case of an Adaptation. (ii) or (iii) (the "Applicable License"). Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law. (III) You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform. Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections. as appropriate. You must not distort. that Licensor specifies to be associated with the Work.g. You may only use the credit required by this Section for the purpose of attribution in the manner set out above and. of You or Your use of the Work. however. Licensor and/or Attribution Parties. mutilate. terms of service or by other reasonable means. provided. without the separate. You may not implicitly or explicitly assert or imply any connection with." or "Screenplay based on original Work by Original Author"). Creative Commons License 303 . (iii) to the extent reasonably practicable. Licensor agrees that in those jurisdictions (e. and (iv) . or the URI for. modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. if You Reproduce. you must comply with the terms of the Applicable License generally and the following provisions: (I) You must include a copy of. if a credit for all contributing authors of the Adaptation or Collection appears. journal) for attribution ("Attribution Parties") in Licensor's copyright notice. Licensor and/or Attribution Parties.g.

to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise. modification or other derogatory action prejudicial to the Original Author's honor and reputation. 5. PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK. 7. WHETHER OR NOT DISCOVERABLE. 6. granted under the terms of this License). Sections 1. 5. Subject to the above terms and conditions. STATUTORY OR OTHERWISE. WITHOUT LIMITATION. 7. however that any such election will not serve to withdraw this License (or any other license that has been. provided. IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL. IMPLIED. it shall not affect the validity or enforceability of the remainder of the 304 Creative Commons License . If any provision of this License is invalid or unenforceable under applicable law. to the fullest extent permitted by the applicable national law. or is required to be. Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License. Termination a. Notwithstanding the above. this Section. will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. ACCURACY. WARRANTIES OF TITLE.Appendix: Documentation License in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion. 8. Representations. 2. OR THE ABSENCE OF LATENT OR OTHER DEFECTS. Each time You Distribute or Publicly Perform an Adaptation. EXPRESS. c. Miscellaneous a. LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK. b. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW. MERCHANTIBILITY. FITNESS FOR A PARTICULAR PURPOSE. as appropriate. NONINFRINGEMENT. SO SUCH EXCLUSION MAY NOT APPLY TO YOU. the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License. Individuals or entities who have received Adaptations or Collections from You under this License. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. the license granted here is perpetual (for the duration of the applicable copyright in the Work). EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. b. CONSEQUENTIAL. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES. 6. Warranties and Disclaimer UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING. and 8 will survive any termination of this License. mutilation. INCLUDING. Each time You Distribute or Publicly Perform the Work or a Collection. however. OR THE PRESENCE OF ABSENCE OF ERRORS. and this License will continue in full force and effect unless terminated as stated above. INCIDENTAL. Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time. Limitation on Liability. the Licensor will waive or not assert.

d. Creative Commons does not authorize the use by either party of the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. this License is not intended to restrict the license of any rights under applicable law. the WIPO Copyright Treaty of 1996. the Rome Convention of 1961. For the avoidance of doubt. if Creative Commons has expressly identified itself as the Licensor hereunder. Creative Commons may be contacted at http://creativecommons. Any permitted use will be in compliance with Creative Commons' thencurrent trademark usage guidelines. Creative Commons Notice Creative Commons is not a party to this License. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License. 1979). in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28. These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL.Appendix: Documentation License terms of this License. Notwithstanding the foregoing two (2) sentences. including without limitation any general. such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24. and without further action by the parties to this agreement. such additional rights are deemed to be included in the License.org/. incidental or consequential damages arising in connection to this license. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent. This License may not be modified without the mutual written agreement of the Licensor and You. special. 1971). The rights granted under. f. it shall have all rights and obligations of Licensor. agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. There are no understandings. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever. this trademark restriction does not form part of the License. This License constitutes the entire agreement between the parties with respect to the Work licensed here. Creative Commons License 305 . and makes no warranty whatsoever in connection with the Work. as may be published on its website or otherwise made available upon request from time to time. e. and the subject matter referenced.

.

Some content written for this book was also exported to the Liferay wiki at http://wiki. The file is one large document.nl/delicious. . The PDF was exported directly from OpenOffice. All of the fonts used in the creation of this book are either open source fonts or freely available fonts.redhat. Screen shots that were taken by the author were taken using Ksnapshot.org 3. It can be found here: http://scripts.0.org/projects/ dia).josbuivenga.2. The font for the titles is called Delicious. It's just easier to manage that way.liferay.html. The body text font is Gentium Book Basic. These are rays of sunlight which appear to spring from a hidden source—usually from behind a cloud. an excellent screen shot program that is part of the KDE desktop. Inc. Some drawings and screen shots were touched up using the GIMP. from the free exljbris font foundry.com/promo/fonts. This change was made from the Second Edition in an attempt to give the book a more “modern” look.org. rather than a multi-linked master document. The picture on the front cover is a picture of Crepuscular Rays. COLOPHON The text and layout were accomplished using OpenOffice.com.9. It is the intent of the author to continue doing this for every edition of this book that is published. The Liberation fonts can be found here: https://www. version 4.demon. Other screen shots were taken by the contributors using unknown software. created by Red Hat.php? site_id=nrsi&item_id=Gentium.sil. The font used for source code is Liberation Mono.gnome. created by SIL International. using some stencils from Dia (http://www.1 running on Mandriva Linux. Drawings inside the book (such as the Unbreakable Liferay diagram) were created in OpenOffice. It can be found here: http://www.org/cms/scripts/page. The cover of the book was done professionally this time by Liferay's graphics design team.org draw.2. The text used in tables is the same. We also expect that some more community documentation will make it into the official documentation.

Colophon but can also appear diffused through trees. This great shot was taken by none other than Liferay's CEO. in Langen. The rays are actually parallel. Bryan Cheung. Rich Sezov. near the offices of Liferay's European headquarters. Germany. crepuscular rays can be spectacular and certainly seemed appropriate for the cover of a book about a product called Liferay Portal. and it is perspective that makes them appear to converge at the Sun. May 2009 308 Colophon . Also known as God's rays.

.

235. 124...... 77.. 278.. 158.. 134.. 103.. 220... 199. 9.. 131. 260...4.... 79-81. 139. 148. 202. 157. 86. 232.... 182. 198. 78-84.... 167. Caching. 194. 223. 12. 254... 185 Cas.. 75.... 181... 11.. 229. 93. 160.....6. 297 245.. 280. 102. 223. 4. 67. 226.... 28.. 230.. 297..... 190.. 108. 165-170. 247... 135. 8...4.... 140... 169. 301.. 233.. 91.. 262. 254.... 7..... 123. 112. 111..... 90-102.. 197. 146. 9. 302 259 Calendar. 270. 70. 89-91. 175.. 179 Clustering.... 284. 105.. 11..... 117. 9. 144. 112-116. 11. 120. 209...properties.. 103. 211. 147. 93... 180... 216.. 266. 46..... 129-131. Company ID. 46.. 292. 50. 233.. 225.. 262.. 244.. 267. 206... 174. 197... 106... 202... 112. 284. 93.... 244. 146. 284 B Community... 202. AJAX... 249. 119..5. 168... 166.. 285. 283-285...4.6.. 246.... 19-25.. 207.. 278. 256... 89-92.server.. ... 17... 42.. 161. 7.. 123.8.. Blogs. 285 100... 119. 294 287..235...5.. 112.. 177. C 310 . 47... 208.. 101. 137..... 120. 233-235 256-259 Auto login. 30..... 113.... 2. 198. 208.. 116.. 18..5. 283. 135.. 119. 64........ 234-237. 100.... 303 App. 179.. 132.. 119.262 251. 217. 89-92.... 23.. 1. 12. 16. 81-84.. 250... 300. 244......INDEX A Admin. 105. 215... 284-286... 126. 146. 264.6... 6... 134....... 271. 20.. 96... 247. 15. 205. 119. 128-130. 8. 77-82. 226... 84-88.. 95. 249..... 237. 5. 150. 152.. 59... 144.. 227.273 Chat.. 15. 256.. 262... 214. 21.. 120..... 290. 215 Captcha.... 119.. 180. 211. Auto deploy.. 213... 194. 293 Control panel... 179. 153... 81.. 132. 160.. 12. 152.. 307 Bundle.. 278. 242. 84. 153. 98Back up.. 237. 87..8. 198. 203. 137140....... 114. 261... 8.. 230... 214 Authentication pipeline. 132. 220.. 246.. 133.6... 147. 98.. 146.. 12...3... 139. 104. 4....... 260. 258..17........ 123-129.. 87. 193.... 214. 236...110.. 12. 99.. 182 Communities. 53.. 223.. 241. 109-111.. 197.. 111...... 228... 27. 180. 237... 254....

119. 216. 136. 102.4. 154. 147. 181...170. 255. 145. 208. 267. 112. 39. 193. 158. 112.. 8.78. 204. 108. 259.. 152. 90........ 273. 285 Journal. 35.172. 91.... 149. 25. 171.. 145. 123. 17.. 128.255.... 285..5.. 224... 249. 103. 287 Email... 187. 20..properties. 286-290 162.. 133..6. 68... 273 Document Library.. 24. 17.7.. 210.... 47. 217220.. 16.7...4.. 244. 176. 69.. 115. 291... 256..8. 210.. 278-280.... 159... 292-294 Jboss... 262. Ehcache. 84..... 297 I Invitation. 8...8.... 257. 196 Html. 24. 142.. 253. 285 138. 17. Hot deploy. 203.. 32. 273 216. 208. 262. 264. 262 Locations. 283. 164... 25... 272. 115-117.. 197. 221. 175 255. 113. 274. 20.. 162.. 12. 206. 52... 295 Jetty. 116. 28.31. 256.. 151. 173... LDAP.. 56-61.....3. 152. 8.... 308 230-236. 258. 34. 183 H Liferay Portal. 144.. 6....... 121. 275.. 267. 303 E Jsp. 215. 272.. 259. 97.. 217... 264-266 L Extension environment... 45. 137.. 124... 27. 178. 179. 74. 148.. 111.. 257. 293. 224.... 234... 258.. 250-253. 260. 249. 200.6.. 278 HSQL.. 79.3.3. 209. 245.. 264.. 203.. 186.. 217.. Logging. 225. 180.. 217-219. 69... 227.. 108.. 214.... 291 259. 16. 172. 124. 151. 77. 93.. 6. 161. 251.. 259. 120. 135.. 17.. 38. 40.... 253.. 208.. 284.. 197... 251... 246... 284.... 203. 182. 89. 78. 17... 47-54. 102-110. 221. 244... 272... 257 D Database. 222.. 151. 183-185... 225. 12. 170. 24.. Jonas... 202.... 31.9.296 Jackrabbit. 149. 287-289... 199-201. 72.. 123-129. 214.. 202.. 258..... 8.. 296 Jar file.. 46... 197.... 174... 147. Css. 137. 277...... 175273. 175. 261. 259. 78. . 24.. 160.24. 281. Hibernate.. 190. 52. 112..9. 271. 230. 15. 164. 67. 232.. 73. 20... 233...... 247.. 267. 217 Look and Feel... 307 286 Logs. 226.. 42-45. 143. 107.. 9. Image Gallery.. 35. 190.. 85... 207. 216 209. 277..... 266 G Language.... 272. 158...... 272.. 115. 146.6. 13. 230...153.3. 191-193.. 47-49. 157..... 250-252.. 261. 103. 296 J Lucene. 40.... 205. 196. 161. 225.109. 77-79. 197... JSR-170.8. 78.... 105. 261.3. 295 Javascript.. 256 Liferay-portlet.. 107. 10. 173. 203. 36-42. 6.. 286. 10. 254.48-50. 205. 160. 173. 19-21. 194... 278. 35. 88..xml. 214. 246.... 262.... 202. 227......17. 281 126. 77. 261.. 279. 202.Language. 244. 129-134.....20... 251. 174.... 275.. 226. 225... 274 177. 36. 200. 84....... 210. 119.3. 75..227. 252. 250-252..6.... 272. 58. 256. 272.. 208. 296.. 213-215. 251. 171.. 37. 9. 104. 134. 20-29... 285. 246.. 165-167. 219.. 8. JSR-286.. 204. 113.. 149.. 232..... 109. 216.8.. 156-158. 26. 266 Glassfish. 287 178... 206. 272........ 161.. 103. 24. 21. 253Jaas.. 261. 285.. 11-13.. 179... 190.. 6. 179. 114... 295 311 . 265-267. 34-36.... 6. 251. 291.. 36-38. 170. 40.. 151-154... 106.. 160. 217.... 197... 186. 224.... 5. 175... 17. 116. 28-33. 119. 211. 51. 279. 17..15.. 227. 285 JSR-168. 223. 283.. 111. . 258.. 273 JCR... 150.. 242. 105.8. 234.. 151. 156. 215. 295 293. 127.. 15-17.....8. 116. 148. 259. 18. 169. 291. 160....

193197. 278 199.. 221. 17. O 135. 113. 42.... Single sign-on.. 32... 40. 55.. 82. 252. 5. 179. 209-211... 148.. 166. 275........ 45. 101. 25-28. 176.. 78. 102. 200. 244 Servlet. 294. 194-196.. 83. 272. 242-244.. 155. 31. 145. 281. 53. 33. 58. 51. 46...... 291. 278. 116.151.4.. 63. 288.. 15-17. 6. 7. 32. 148. 81-84. . 226..5. 24..4.. 195...... 219. 108.. 216.... 38-42. 24... 85113..... 218. 273 Ntlm. 57. 157. 119. 287. 68.... 288. 295 245.. 33. 167-169.. Memory. 67.. 27... 43. 114. 284. 182 OpenSSO. 164.. 101. 267... 116. 73. 237. 106.. 44-46 259. 5-12. 278. 73. 22. 145-147.46.. 174.. 102. 183. 178. 305 296 Resin.. 246. 258..... 274 Session.. 223.. 16. 285 181. 156.... 275. 89-93.. 165.. 280.. Portal-ext. 23.. 222. 92. 162... 184. 130.. 278...9. 153. 48.. 277. 59. 208 312 .... 8. 180. 288 Portlet. 108. 251. 261 Organizations. 287. 121. 285. 27.. 7274. Social Bookmarks. 219... 45...properties.... 260... 182. 55.... 222 259.8.. Oc4j.. 262.. 254. 71-73.... 5. 33... 151. 213-215. 177. 142. 182. 178. 39-41. 133... 77. 181. 4.... 210. 194. 48. 264-266. 13. 156. 257. 220 R Mysql.. 277 Message boards. 145... 153..273 45-51.7.. 255.. 263-265. 142.. 188-191. 289 220. 165. 111. 109-112.properties.. 297. 258. 247... 252.. 296 SMTP. 291. 85.. 74.... 58. 152. 111..... 84..26.. 45...properties.. 9. 251. 185..... 289-295. 84. .. 265.. 185. 6.3.6. 296 139. 47. 178. 220. 68. 303. Release. ....... 24. 74. 47. 159. 41.. 149-156. Request.. 90. 170. 272.M Mail. 296.... 37. 90.. 55. 136.. 201.. 222. 23. 112-116. 113. 165-167. 182. 302. 255.. 278..4. 85.. 283. 110. 279. 245. 186.. 256. 145. 143. 59. 279. 116. 295 Portal.. 66. 284.. 253-256.. 54. 30... 211... 38. 167. 179. Shopping. 164. 207. 23. 278 Roles.... 56.. 103.. 206. 281.9. 112-114. 117. 287... 258 My Places... 6. 133-142. 77-81. 47-50. 185.. 221..... 81.. 291.. 73.. 42. 259.. 57. 63.xml.. 293.. 175. 8. 41.. 142. 255. 84. 225.. 93..26. 39. 48.. 245. 4. 178. N 260.. 25-30. 295... 116. 149. 121...... 19. 32-35... 177. 152. 257. 84. 146... 120.6. 36. 108. 98100. 25-30. 213-246.. 6. 119-122. 178.. 166..8.. 271... 182 S Schema.. 202-209.. 113. 270.. 211. 297 211. 224. 77-79. 182..4. 58. 217-220.3.. 290 Plugin. 228. 4. 88. 160. 225. 272.. 215. 149. 218. 57.... 57. 181.. 92. 46... 100.. 147. 186. 205.. 46. 87... 6.. 221. 116.4.. 194. 285. 206 107...6.... 295 Services Oriented Architecture.. 77.. 130.. 48. 92.. 172-174.. 35.. 225... 252.. 144.. 222. 198... 171-173. 90.. 276 OpenId.. 253-255.... 35. 173.. 231-235. 265. 112.. 15. 114.3. 131. 258-261. 169.. Permissions... 172. 15. 204-206... 204-206. 81-88. 6. 259. 289. 187 265.. 221.. 126... 68. 158.... 129-134.. 208. 261.. 20439.. 35. 66. 103..... 210. 105. 172-175... 9. 297 246 P Performance Tuning.... 126.7.. 271. 24. 185..3.. 91.. 36.... 27.. 210-213.... 54. 197.. Passwords. 20. 112.. 68. 95-101. 151. 137-143.4-6. 37.. 112.... 245. Navigation. 179. 120.. 133.. 225-240.. 284.. 173. 190.. 78. 7. 182. 240. SiteMinder. 153. 216... 117..... 148. 113..6... 33. 102. 186. 256.... 175... 141. 124-135.. 119. 286... 244.8. 79.. 16... 30.. 197. 57.. 38. 55.. 274.. 12. 281. 12. 23. 4... Portlet. 184. 186. 53. 184. 98-102. 260.......8.. 105. 51. 8790. 174.. 170. 132... 146.. 202. 147.... 198. 135. 51. 195. 291 119-121.. 179... 30.. 278. 29.. 251. 226. 80. 227... 58. 6.. 45.. 182. 278-280... 258. 38-42. 185. 112. 87... 138..6. 184. 259. Service Builder. 83. 136.

. 38.8... 150.Software catalog.. 222. 113. 216. 253-256 Spring. 95-113.. 295 U X Xml. 293. 144. 226. 50... 291 Websphere. 77. 172-174. 9. 211-213. 16. 176-181.. 172..31. 252... 8. 48. 186. 227. 178. 172. 296 202. 30. 194. 233..4-7. 181. 183-189. 208.. 266. 221-225. 20. 74. 54... 50-52. 226.6.. 236.. 164.. 156289 158... 235... 300. 253. 243-246.. 160. Velocity. 164-177. 5. 272 152.. 231. 93. 293-296 210. 194... 9-11.13. 262. 29...6.. 232 222. 288. 81. 277. 40. 239. 73.. 278. Swimlane.. 171 Workflow.. 39... 197. 216.. 119.. 68. 59. 59.. 197. 208. 235. 271.... 255.. 17...... 247. 210... 262. 184. 216.. 25. 217-219 262. 256.. 113.35. 56... 152-155. SQL.. 87.. 260. 233-235 147. 241. 259.. 29.. 265-268. 278-280...... 256-258.. 151.. 22. 182... 230. 181.. 278-280.261-263. 236-240.. . WebLogic.. 172.. 30... 236. 257-266. 158... 130-142.. 238. 209. 211.. 194. 40-42... 247 257..xml. 74. 165. 34-41. 23. 271. 270 234.. 20... 155......8... 16.. 225. 266. 293. WSDL. 151. 48. 109... 58.. 203. 52.. 273.. 204. War file. 58.. 278 Solr..3.. 144. 22... 90.. 110... 170.... 252.... 116. 216.. 27. 17. 258. 296 W T WebDAV. 255. 15.. 209. 270.36..... 50-52. 12. 151. 146. 234. 296 307 Time zone.. 19-21. 283. 279. 7... 185.. 295..... 144.. 20. 197. 261.. Theme.. 241..21. 211. 24-27. 155-158... 155. 119. 253...... 200.. 109. 32-35. 272... 141-146.. 250.. Tomcat... 38. 256.. Z 50. 278. 95-98.. 220.3. 229. 44. 242-244. 188-190. 13.. 289-291.... 293. 210. 92. 173. 74. 208... 239. 254.Zip.. 74. 81-84. 268. 149-153... 116 Users.. 9. 79-93. V 215-219. 48-50. 281. 229. 204.6. 63.. 242-244 Virtual Host.. 112. 38...3.. 290. 259. 194.114.7. 261.. 177. 289-291. 287. 165-169. 59.259-263. 24.. 91. 204.. 207... 284.... 199.. 203. 41.. . 40. 160.. 251. 187-190. 265...... 24. 225.. 247.. 8. 223-225. 254..7. 272. 25. 226. 122128. 265. 245 Tags... 261. 281. 149.. 37. 293. 205. 251..7.. 194-196. 200-203. 198.. 174.... 148. 11-13... 223. 150.. 195. 295. 271. 161... 237. 243... 272... 232.. 73... 39-41. 179.6. 51. 252.4. 195.. 257. 249.. 272.. 9. 287-290.. 177... 254... 236...... 232... 236238... 116.. 295. 291-293. 256. 74. . 231... 236... 226.. 234.... 41. 279... 28.. 181. 218. 268... 102.8. 37. WEB-INF.. 78. 74.. 294. 46. 284. 66. 10.3..... 307 54. 115-117. 211-213... 20.. 21. 57. 24.6. 69. 158-160. 77... 181. 33-36. 285 296 SSO with MAC.6. 16. 240. 289... 245... 130.. 178. 233.. 234. 288 43-51.. Wiki. 254.. Upgrade. 32.. 182 Web. 52-58... 161. 308 313 . 150.. 40. 216.... 296 102. 243. 212.. User groups. 164. 267. . 192. 237.. 17. 67-69. 151-158. 273. 229-231. 71-73. 146.

Sign up to vote on this title
UsefulNot useful