Archive

Posts Tagged ‘roles’

Adding Permissions using Alfresco Javascript API

August 4, 2011 5 comments

ADDING PERMISSIONS…

On my last post, I have discussed how permissions can be applied in a folder using the Alfresco web client. This is very helpful for first time users of Alfresco. Permission plays an important part in Alfresco Administration as this can be used to control access of users to folders or documents. However, for advanced users some might require adding them automatically or even might have a requirement where you add permissions without going through to many clicks in the Alfresco web client. Applying permissions is also possible using JAVA APIs exposed by Alfresco. But, there is also another way for non-Java guys by using Alfresco JavaScript API.

In this post, I will show you how you can add a permission using JavaScript API. I will be using a simple web script to add permissions to a given folder name.

CREATING THE PERMISSION  WEB SCRIPT

1. Log in as  admin in Alfresco and go to Company Home/Data Dictionary/Web Scripts Extensions

Figure 1: Web Scripts Extensions Page

2. Create a folder/space that  will contain our web script files e.g. setPermission folder

3. In the created folder, create 3 files that will complete our web script.

a. setPermission.get.desc.xml – the descriptor file that will register our web script, example:

<webscript>
    <shortname>Set Permission</shortname>
    <description>Set Permission using javascript API</description>
    <url>/set/folder/permission/?folderName={folderName}</url>
    <format default=”html”/>
    <authentication>admin</authentication>
</webscript>

b.  setPermission.get.html.ftl –  the file that will display the response from Alfresco, example:

<html>
<body>
<p>${myStatus}</p>
</body>
</html>

c. setPermission.get.js – java-script that will contain the logic of our code. Here, we will use Alfresco java-script API for  setting the permission of  a folder, example:

/*Set permission to a folder using Alfresco javascript API*/

//search for the folder node using lucene search
var folderNode =  search.luceneSearch(“TYPE:\”{http://www.alfresco.org/model/content/1.0}folder\” AND @cm\\:name:”+args.folderName);

//make sure we only get one node

if(folderNode.length == 1){
//set permission “Contributor” to user with username “anythingalfresco” and group “ANYTHINGALFRESCOGROUP”
folderNode[0].setPermission(“Contributor”, “anythingalfresco”);
folderNode[0].setPermission(“Contributor”, “GROUP_ANYTHINGALFRESCOGROUP”);
model.myStatus = “Permission was set successfully!”;
}else  if (folderNode.length == 0){
//no node was found
model.myStatus = “Folder not found”;
}else{
//either greater than two  was found
model.myStatus = “Duplicate folder found”;
}

Below is the API for  applying permissions:

void setPermission(string permission, string authority) 
Parameters:
string permission – a string representation of  the permission or role you want to assign to a user or a group. Note that this permission should exist in Alfresco otherwise you will get an error like the one below:

Figure 2: Permission Error

string authority – string representation of the username or a group name you want to have permissions. For groups, append “GROUP_” before the group name. Alfresco will not produce error if a username or group does  not exist (at least in my test!).

4. Go to web scripts home (http://localhost:8080/alfresco/service/index) and click Refresh Web Scripts button
5. On a new tab, invoke your web script:
          http://localhost:8080/alfresco/set/folder/permission/?folderName=Folder A
If all goes well, you should be able to  see a response “Permission was set successfully!”

Figure 3: Permission Applied

Now we are done! Note that this is just a simple code. You are free to experiment with the code at your own risk 🙂
I  hope this helps!

3 Easy Steps: Applying Permissions Using Alfresco Web Client

July 28, 2011 1 comment

HOW PERMISSIONS ARE APPLIED?

In Alfresco, you apply permissions to certain space/folder or documents to restrict  a user to certain actions that he/she can perform on a folder or document. For example, you don’t want everyone to to have a capability to create documents or folders in Folder A. What you can do is to apply a READ ONLY permission to a user to  Folder A. In this way, a user can only VIEW the contents of Folder A.

For beginners, below  are the steps  to apply permission using Alfresco  web client:

1. Log in to Alfresco and proceed to the space/folder you want permissions to be applied. Click More Actions –> Manage Space Users.

Figure 1: Manage Space Users Link

2. Click  Invite. You’ll proceed to Invite Users Wizard page. In this page, you can invite a user or a group by selecting from the drop down list of Specify Users/Groups. Enter a group name or username and then click the search button. Select a user or group from the search result and then select a Role you want a user to have as seen below:

Figure 2: Invite User

Note: To further understand what Roles are, you can visit this link.

3. Click Add to List button. Click Next. You will be directed to a page which will ask you if you want to send an email to the invited user, for  now select No and click Finish button and you’re done! You should be able to see that the user has now a Role in the specified folder.

Figure 3: User with Role

Now we are done! Please note that applied permissions will only affect the space to which it is applied. You can also apply permission using java-script API’s provided by Alfresco. On my next post, I will concentrate on using java-script to apply permissions. =P