{"id":3368,"date":"2013-12-06T12:49:00","date_gmt":"2013-12-06T11:49:00","guid":{"rendered":"https:\/\/www.dbi-services.com\/blog\/developing-an-archive-action-for-alfresco-share-2-of-2\/"},"modified":"2013-12-06T12:49:00","modified_gmt":"2013-12-06T11:49:00","slug":"developing-an-archive-action-for-alfresco-share-2-of-2","status":"publish","type":"post","link":"https:\/\/www.dbi-services.com\/blog\/developing-an-archive-action-for-alfresco-share-2-of-2\/","title":{"rendered":"Developing an archive action for Alfresco Share (2 of 2)"},"content":{"rendered":"

\"\"<\/p>\n

In my last article, I presented the first part of setting up a new action for Alfresco Share, which is an archive action. I advise you to read the first part if you have not read it yet since it is a prerequisite for the proper functioning of the action:\u00a0Developping an archive action for Alfresco Share (1 of 2)<\/a>. The purpose of this part is to extend the user interface with the creation of an AMP for Alfresco Share. I remind you that ALF_AMP_HOME and SHARE_AMP_HOME references the location of the projects (e.g. C:\/AlfrescoEclipseProjects\/AlfrescoShareAMP<\/em>).<\/p>\n

1. Extension of Alfresco Share<\/h3>\n

So let’s create a properties file that contains the display name of the action and messages that will be sent to the user at the end of the action:
\nSHARE_AMP_HOME\/config\/alfresco\/messages\/custom.properties<\/em><\/p>\n

\"custom.properties.png\"<\/a>
\nIn cases where Alfresco is used with multiple languages, you can manage this file with i18n. So you can add several files for different languages: custom_en.properties, custom_fr.properties, aso…<\/p>\n

As we did for the Java code, we have to tell to Alfresco Share that a new property file was added. For that purpose, create the following file:
\nSHARE_AMP_HOME\/config\/alfresco\/web-extension\/custom-slingshot-application-context.xml<\/em><\/p>\n

\"custom-slingshot-application-context.xml.png\"<\/a><\/p>\n

The next step is to add a line in the list of actions on Alfresco Share interface. To do this, you will need to extend the file you certainly know:
\nSHARE_AMP_HOME\/config\/alfresco\/web-extension\/share-config-custom.xml<\/em><\/p>\n

\"share-config-custom.xml.png\"<\/a><\/p>\n

Each action on Alfresco has a small image (16×16) that can be seen next to the name. Alfresco Share can automatically handles the dependency between the image and the action. For that purpose, you must add the following image:
\nSHARE_AMP_HOME\/source\/web\/components\/documentlibrary\/actions\/document-archive-16.png<\/em><\/p>\n

The name of this image must be the id of the action that you define in the file share-config-custom.xml followed by the size of the image (16px): document-archive-16.png<\/p>\n

The last thing to do is to create the JavaScript file that will be executed with a click on the action. This JavaScript file must be minified because Alfresco use by default the minify version of a JavaScript file when DEBUG mode is turned off. The build.xml file can do it for you if you have put the two jar files ‘yui-compressor-ant-task-0.5.jar’ and ‘yuicompressor-2.4.2.jar’ in \/lib. This JavaScript file manage interaction with the user by offering messages of failure and success. It also allows you to pass parameters to the Web Script which is very useful:
\nSHARE_AMP_HOME\/source\/web\/components\/documentlibrary\/archive.js<\/em><\/p>\n

\"archive.js.png\"<\/a><\/p>\n

2. Deploying AMPs<\/h3>\n

You now have all that is necessary to add an action in Alfresco Share v4.2. You can easily add other actions by taking the code and customizing it.<\/p>\n

Once you have build your two projects, you should normally have two AMP files. Before deploying them the first time, I strongly advise you to make a backup of the original WAR files. You could create a script to deploy AMP files automatically with some of the following command lines:<\/p>\n

# cd\u00a0 ALFRESCO_HOME\/tomcat\/webapps\n# rm\u00a0 -rf\u00a0 alfresco\n# rm\u00a0 -rf\u00a0 share\n# cd\u00a0 ALFRESCO_HOME\n#\u00a0java\u00a0 -jar\u00a0 ALFRESCO_HOME\/bin\/alfresco-mmt.jar\u00a0 install\u00a0 ALF_AMP_HOME\/dist\/ALF_AMP_NAME.amp\u00a0 ALFRESCO_HOME\/tomcat\/webapps\/alfresco.war\u00a0 -force\n#\u00a0java\u00a0 -jar\u00a0 ALFRESCO_HOME\/bin\/alfresco-mmt.jar\u00a0 install SHARE_AMP_HOME\/dist\/SHARE_AMP_NAME.amp\u00a0 ALFRESCO_HOME\/tomcat\/webapps\/share.war\u00a0 -force\n# ALFRESCO_HOME\/bin\/clean_tomcat.sh<\/pre>\n
ALFRESCO_HOME obviously represents the Alfresco installation folder, something that should look like C:\/Alfresco or \/opt\/Alfresco-4.2.c. ALF_AMP_NAME and SHARE_AMP_NAME represents the name of the two AMPs that was created in your Eclipse Project.<\/p>\n
Please also note that I join to this blog the zip file containing the archive action AND the file permissionDefinitions.xml which is used to create all groups. Feel free to modify all files:<\/p>\n