Adding Expandos from a Startup Hook

I've seen a tone of requests lately for how to add Expando Tables and Columns programatically during some startup proceedure.

The biggest problem seems to be with PermissionChecker. The problem stems from the fact that alot of people are trying to use the ExpandoBridge API to create columns (attributes) during the startup process. The issue with that is that the default implementation of ExpandoBirdge has permission checking built in. This leads to exceptions because there is no PermissionChecker yet bound to the thread during startup.

Have no fear. There is a solution! And, it was written by none other than Brian "The Man" Chan himself, so it's gotta be right. He did this in the WOL portlet plugin that you all know from Liferay.com, so it's even in production.

Here it is verbatim from the 5.2.x branch in SVN:

package com.liferay.wol.hook.events;

import com.liferay.portal.kernel.events.ActionException;
import com.liferay.portal.kernel.events.SimpleAction;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.model.User;
import com.liferay.portlet.expando.DuplicateColumnNameException;
import com.liferay.portlet.expando.DuplicateTableNameException;
import com.liferay.portlet.expando.model.ExpandoColumnConstants;
import com.liferay.portlet.expando.model.ExpandoTable;
import com.liferay.portlet.expando.service.ExpandoColumnLocalServiceUtil;
import com.liferay.portlet.expando.service.ExpandoTableLocalServiceUtil;

/**
 * <a href="StartupAction.java.html"><b><i>View Source</i></b></a>
 *
 * @author Brian Wing Shun Chan
 *
 */
public class StartupAction extends SimpleAction {

	public void run(String[] ids) throws ActionException {
		try {
			doRun(GetterUtil.getLong(ids[0]));
		}
		catch (Exception e) {
			throw new ActionException(e);
		}
	}

	protected void doRun(long companyId) throws Exception {
		setupExpando();
	}

	protected void setupExpando() throws Exception {
		ExpandoTable table = null;

		try {
			table = ExpandoTableLocalServiceUtil.addTable(
				User.class.getName(), "WOL");
		}
		catch (DuplicateTableNameException dtne) {
			table = ExpandoTableLocalServiceUtil.getTable(
				User.class.getName(), "WOL");
		}

		try {
			ExpandoColumnLocalServiceUtil.addColumn(
				table.getTableId(), "jiraUserId",
				ExpandoColumnConstants.STRING);
		}
		catch (DuplicateColumnNameException dcne) {
		}

		try {
			ExpandoColumnLocalServiceUtil.addColumn(
				table.getTableId(), "aboutMe", ExpandoColumnConstants.STRING);
		}
		catch (DuplicateColumnNameException dcne) {
		}
	}

}

Now that is some sweet code!

One small note. These columns were added to a table called "WOL". As such these are NOT what we ferrer to as Custom Attributes.

There needs to be one small change made in order for the ExpandoColumns above to be considered Custom Attributes. They must be added to a special table called "DEFAULT_TABLE" (a.k.a. ExpandoTableConstants.DEFAULT_TABLE_NAME).

		try {
			table = ExpandoTableLocalServiceUtil.addTable(
				User.class.getName(), ExpandoTableConstants.DEFAULT_TABLE_NAME);
		}
		catch (DuplicateTableNameException dtne) {
			table = ExpandoTableLocalServiceUtil.getTable(
				User.class.getName(), ExpandoTableConstants.DEFAULT_TABLE_NAME);
		}

Columns in this "DEFAULT_TABLE" are the ones which are retreived and manipulated by the ExpandoBridge API (more on that API in another blog post).

18
Blogs
Indeed Ray, I have often been confrontated with this problem myself and your solution does solve the problem of adding the columns.
But to go one step further, when accessing the custom attributes via the expando bridge API, permissioning is also built in and you usually need to add view permissions for the corresponding roles (user or guest for example).

I recently had to do this on a custom attribute on organizations so that I could display the organization profile on a page accessible for guest users.
Here is the code that I used in my AppStartupAction to ensure that the guest role had the correct permission :

Role guest = RoleLocalServiceUtil.getRole(companyId, RoleConstants.GUEST);
PermissionLocalServiceUtil.setRolePermission(guest.getRoleId(), companyId, ExpandoColumn.class.getName(), ResourceConstants.SCOPE_COMPANY, String.valueOf(companyId), ActionKeys.VIEW);
Artical is wonderful. Helped me to write the Startup quickly. But I am facing one problem. When I start teh liferay on empty database schema, at the first run,start-up fails stating thet NoSuchCompany exception. But Again stop and start tomcat server will create custom attribute. This issue happend when database tables required for the liferay is not available and are created during the firts run. How to resolv ethis isuue?. Kindly support me
I try to run this code in LR6, but it seems that addTable and getTable are deprecated. If I'm not wrong, what is the right way to add expandos in LR6? Thanks.
I didn't look so well, I haven't tested it already but ExpandoTableLocalServiceUtil.addTable and getTable are not deprecated. The new version of this method in LR6 asks for a companyId parameter.
Don't understand this article, what is WOL, what this code line " doRun(GetterUtil.getLong(ids[0]));" is supposed to do. What is DEFAULT_TABLE_NAME. Seriously guys, that's ununderstoodable, I just want to add custom field in a hook at startup, falling in this article is very frightening
1 - WOL is "World of Liferay" and it is a portlet that exists for older versions of Liferay. It was created specifically for Liferay.com, but also was placed in the public plugin repository so others could see the code and use/modify it.

2 - " doRun(GetterUtil.getLong(ids[0]));"
Basically the SimpleAction events are passed an array of Strings containing the list of existing companyIds of all the instances in the portal. "ids[0]" is the first (liferay.com only has one, so Brian chan just hard coded it). "GetterUtil.getLong(ids[0])" is a utility that (tries) converts strings to primitives. Finally "doRun(...)" is just a indirection method that delegates the API call to an implementation method (keeping some of the housekeeping code out of the actual business logic of the method, it's a common Liferay pattern.)

3 - ExpandoTableConstants.DEFAULT_TABLE_NAME is a public final static String containing the name of the "custom fields" expando table. Expando design can have as many tables as you need. In order to keep custom fields consistent we basically made a "system" level table that all entities can have. This constant just holds the name for this table.

Anything else?
Sorry for my message, in fact I just didn't see the scrollbar of the code snippet, so that was mysterious to me and I understand now, your explanation confims my understanding : use of Expando is a general possibility in liferay, but DEFAULT_TABLE_NAME is what we put in code, to add "custom field" that we'll see on the different liferay user interface on the different entities that support "custom fied" on them.
No problem! Glad we could clear it up!
What API do I need to call if I want the custom field to be searchable? Thanks.
In the 6.0 API you would have to set the property "indexable" on the ExpandoColumn with a value of: "true" OR "false" (null or blank is equal to false).

In the 6.1 API set "index-type" with a value of:
ExpandoColumnConstants.INDEX_TYPE_NONE (0)
ExpandoColumnConstants.INDEX_TYPE_TEXT (1)
ExpandoColumnConstants.INDEX_TYPE_KEYWORD (2)
Nice article.
Is there also a way to read the field values if PermissionChecker is not bound?

I like to see that there is no possibility, on the other hand then I would have to know how to fulfill the needs of PermissionChecker...
I imagine that you are either trying to access during Login Pre or Post Action.

Try moving your logic to an event on "servlet.service.events.pre=" after the default "com.liferay.portal.events.ServicePreAction" because then the PermissionChecker should be initialized.

Otherwise a permissionChecker can be initialized by doing

PermissionChecker permissionChecker =
PermissionCheckerFactoryUtil.create(user, true);

PermissionThreadLocal.setPermissionChecker(permissionChecker);
[...] Super ! Merci beaucoup pour ces précisions qui me seront très utiles ! Je vais partir sur les Expandos donc, d'autant plus que le nombre de documents dans le système ne sera pas très élevé (pas plus... [...] Read More
Thanks Ray, this post made my life a whole lot easier.
I changed the addTable and getTable methods to their non-deprecated versions for Liferay 6.1 and wrapped the logic up into a couple helper methods to make things a little cleaner. if anyone finds it helpful here is the link:
http://pastebin.com/1nri436J
Hi ,

i have a problem in adding new column in table "expandocloumn" using java code , liferay 7 .and a hook module .

if any one have solution please tell me and thanks.