Posts Tagged ‘alfresco’

5 Easy Steps To Get All Root Groups in Alfresco Using Web Scripts

July 25, 2011 1 comment

Get All Root Groups in Alfresco

I was too curious and wonder how I can get or visibly see all the groups in Alfresco aside from using the Admin Console functionality.  I found out that it is possible using web scripts.

The Problem

I want to display in a web browser the list of all groups in Alfresco using a simple java-script web script.

The Solution

NOTE: I will assume you know how to create a web script, or at least have an idea. =P

1. Log in to your Alfresco as admin.

2. Locate ‘Web Scripts Extensions‘ folder (Company Home > Data Dictionary > Web Scripts Extensions)

Figure 1: Web Scripts Extensions Page

This folder is where we usually put our custom web scripts. By default, custom web scripts should be pit in this folder.

3. Create a folder (any name will do, e.g. getAllGroups) inside the Web Scripts Extensions folder.

4. Under the folder created in step 3, we create the 3 files below:

a. getAllGroups.get.desc.xml – the descriptor file that is responsible for registering our web script in Alfresco. This file will containt the following code

    <shortname>Gets All the Groups  in Alfresco</shortname>
    <description>This  is a sample web script</description>
    <format default=”html”/>

The explanation for each tags can be found here.

b. getAllGroups.get.html.ftl – free-marker template, used to represent the response data from Alfresco. Below is an example with formatting.

               <th>Short Name</th>
               <th>Full Name</th>
               <th>Display Name</th>
       <#list alfrescoGroups as g>

c. getAllGroups.get.js – this is where the logic of the code is located. Alfresco exposed some javascript  API’s which developers can use to access Alfresco repository. For groups and authority related API, we will use the Groups (Authority Service). Below is a sample code using groups API:

/*@author – anythingalfresco: Gets all the root groups in Alfresco*/

//javascript API that gets all the root groups in Alfresco
var myGroups = groups.getAllRootGroups();

model.alfrescoGroups = myGroups;

5. After creating these 3 files, go to the web scripts index page at http://localhost:8080/alfresco/service/index and click Refresh Web Scripts button. Invoke the web script uri (http://localhost:8080/alfresco/service/get/all/groups) and the result should be like the one below:

Figure 2: Sample Result

Now we are done! It’s quite easy? You can try the code in your Alfresco installation and see if it works. BTW, I’ve used Alfresco Enterprise 3.2r in this example. But, it should work in higher versions too. If you want to know more about about Alfresco web scripts, you can visit the Alfresco wiki. =P

Alfresco Multi-Tenancy Feature

February 27, 2010 1 comment

This post will provide information about the Multi-tenancy functionality of Alfresco Enterprise 3.0. I have decided to make this article because currently, I have been researching for this feature for a project requirement. I decided to divide this in several parts like enabling, creating, exporting and importing a tenant. Now, let’s get started!

The Multi-Tenancy Feature enables Alfresco to run in a single-instance (meaning using only one Alfresco WAR, DB and same port) multi-tenant environment. So how is it enabled, below are the steps:

1. If it is your first time to run Alfresco(clean DB and alf_data), I suggest you run it first. (Because for some reason, I can not access the tenant admin console if I enable it here).

2. Stop Alfresco.

3. Locate the three files below located at tomcat/shared/classes/alfresco/extension/mt directory :

  • mt-context.xml.sample
  • mt-admin-context.xml.sample
  • mt-contentstore-context.xml.sample

4. Rename the files:

  • mt-context.xml.sample -> mt-context.xml
  • mt-admin-context.xml.sample ->mt-admin-context.xml
  • mt-contentstore-context.xml.sample -> mt-contentstore-context.xml

5. Restart Alfresco.

6. Open tenant admin console (http://localhost:8080/alfresco/faces/jsp/admin/tenantadmin-console.jsp). If you are able to access this page, multi-tenancy is enabled.

Now that multi-tenancy is enabled, you are now ready to create your first tenant. Below are the steps:

1. Log in as super admin

2. Open tenant admin console

3.  Enter command to create tenant:

create <tenant domain> <tenant admin password> <root contentstore dir>

Ex: create tenanta admina C:\Alfresco\alf_data\tenantstore\a

The above command will create a tenant tenanta with an administrator password admina

4. When creation is successful, you can login as tenant by accessing the login page of Alfresco and typing:

Username : admin@tenanta

Password:   admin

You can now create spaces, content and users inside your tenant. Enjoy!=)

Alfresco: Adding Permissions through Webcripts

February 5, 2010 9 comments

This is my first blog and my first post about Alfresco. Haha, dont know where to start. But anyway, I choose the title “Alfresco: Adding Permissions through Webcripts” because I’ve recently figured out that you can assign permissions for a user to a space/folder or node in Alfresco using web scripts. Well, this is because I am currently involved in a project requiring this functionality and it took me a while to figure it out. In this post, I will share how I was able to do it using java-backed web scripts in Alfresco. I’ll also be including some links to Alfresco forum for guides and for understanding. If you are reading this, I assume that you are a beginner like me or an expert (probably an Alfresco expert). But, for those who are beginners, this post might help you (I hope :)).

First, the question is: What are permissions in Alfresco? Permissions define what actions a user can and can not do in a space or folder inside Alfresco. It defines whether you ca ADD contents, DELETE contents, ADD CHILDREN, CHECK-IN or CHECK-OUT a file, etc So if you want to restrict a user to just viewing contents, you may do so by setting permissions. Now, Alfresco by default has out-of-the-box way of setting permissions through ROLES.

Now, what are ROLES in Alfresco? Roles are permission group in Alfresco. For example, the lowest Role in Alfresco is the Consumer Role which can only have the reading permissions of folders,spaces and children nodes. By default, Alfresco has 5 Roles (from

Coordinator: This role has all privileges including the possibility of taking ownership of nodes, and changing its owner.

Collaborator: This role has the same capabilities as Contributor and Editor.

Contributor: Adds to consumer privileges the possibility of adding children and execute CheckOuts in nodes with aspect lockable.

Editor: Adds to consumer privileges the ability to write nodes (properties, content, and children) and execute CheckOuts in nodes with aspect lockable.

Consumer: Allows read properties, content, and children of a node.

For complete User Role and Permissions Guide, see this link:

Now, let us get on track. The following procedures is how to come up for setting permissions for a node. For this example, I’ve used a java-backed web script since there is already a pattern that has been set for this in our project. But you can also use just web scripts.

1. First, search for a space or node that you want to apply permissions using lucene query.

2. If the node has been found, set the permissions, from my code:

PermissionService permissionService;

//Get all the AccessPermissions that are set for anyone for the given node


//Output the permissions to console


permissionService.setPermission(NodeRef nodeRef, Authority auth, PermissionService.<type of permission>, boolean allow);

//nodeRef – the node reference of the space or content

//auth – Authority can be a username of the user or group name (if using //group, add a prefix “GROUP_” ex. “GROUP_”+grouName)

//type of permission – can be ALL_PERMISSIONS, ADD_CHILDREN, etc.

//allow – true/false, usually set to true

Now you have set a permission to a node, you can also clear or delete a permission of the node by using the following methods:

clearPermission(NodeRef nodeRef,java.lang.String authority)

The method above will delete all permission assigned to the specific authority while the method below will delete a specific permission for an auhority

deletePermission(NodeRef nodeRef, java.lang.String authority, java.lang.String permission)

Now, that should do it. I hope it helps in some way. For complete information about Permission Service API, you can visit this link. Til next time… 🙂

Get all the AccessPermissions that are set for anyone for the given node