 | Note As of now AWPr only works with JBoss Portal 2.6.x and higher as well as Liferay Portal 5.2.x and 5.1.x. If you would like us to release a version that works with earlier versions of JBoss Portal or Liferay Portal please let us know by filing a new feature request on our jira. |
AWPr / JBoss Portal / Liferay Portal / Alfresco Compatibility Matrix
Installation
Downloading and Installing AWPr
Liferay Portal
- Download the current AWPr version here and unpack it
- The downloads page includes an AMP which contains example Web scripts that we are providing to showcase AWPr
- If you choose to use the AMP, install it into Alfresco (see Alfresco wiki for instructions). You can find more detailed instructions on how to use the bundled Web script examples here.
- Download the STAr AMP from here and install it by following the instructions found here.
- Install a Liferay Portal 5.1.1+ or 5.2.2+ bundle from http://www.liferay.com/web/guest/downloads/portal(we will assume the Tomcat bundle is used).
- Copy awpr.war into your Liferay auto-deploy folder (default is USER_HOME/liferay/deploy)
- If you're running both Liferay Portal and Alfresco containers on the same machine, make sure they are not listening on the same port (both have the port 8080 as a default, so you'll need to change one of them)
- See 'Configuration' below to create a portlet instance of AWPr and configure it to expose a remote Alfresco Web script
JBoss Portal
- Download the current AWPr version here and unpack it
- The bundle includes an AMP which contains example Web scripts that we are providing to showcase AWPr
- If you choose to use the AMP, install it into Alfresco (see Alfresco wiki for instructions). You can find more detailed instructions on how to use the bundled Web script examples here.
- Download the STAr AMP from here and install it by following the instructions found here.
- Install a JBoss Portal 2.6.x or 2.7.x bundle from http://www.jboss.org/jbossportal/download/index.html
- Copy awpr.war into JBOSS_HOME/server/default/deploy (JBOSS_HOME is your JBoss AS root folder)
- If you're running both JBoss and Alfresco containers on the same machine, make sure they are not listening on the same port (both have the port 8080 as a default, so you'll need to change one of them)
- See 'Configuration' below to create a portlet instance of AWPr and configure it to expose a remote Alfresco Web script
Building and Running AWPr
Liferay Portal
- Install a Liferay Portal 5..1.1 or 5.2.2 or higher bundle to a local folder (we'll call it LPORTAL_HOME in this document).
- Install a Liferay 5.2.x plugin SDK to a local folder (we'll call it PLUGIN_SDK in this document)
- Checkout or copy the AWPr project to PLUGIN_SDK/portlets
- Run ant
- Start Liferay Portal and access http://localhost:8080
- Add an AWPr instance on a portal page
- Edit the portlet instance's preferences and save them
- You should see the Web script in the portlet
JBoss Portal
- Install a JBoss Portal 2.7.x bundle to a local folder (we'll call it JBOSS_HOME in this document).
- Create a file called deploy.<user>.properties in the AWPr source root folder, where <user> stands for the OS user name you are currently logged in as.
- Add the following line to the properties file:
target_folder=JBOSS_HOME/server/default/deploy
and replace JBOSS_HOME appropriately (look at step 1). - In the AWPr project root run deploy.sh
- Start JBoss by running JBOSS_HOME/bin/run.sh
- Access http://localhost:8080/portal
- Create a portlet instance for the AWPr portlet
- Configure the preferences as shown in the Configuration section
- Add the portlet instance to a page
Alfresco AMP Installation
Download the AMPs here and inject them into Alfresco following the instructions here.
Configuration
When you create a portlet instance you will need to configure its preferences to point to an Alfresco Web script. For example, if you have a "What's New" Web script with the following definition:
<webscript>
<shortname>What's New</shortname>
<description>Documents modified during the last 14 days</description>
<url format="html" template="/whatsnew"/>
<authentication>user</authentication>
<transaction>required</transaction>
</webscript>
and alfresco is running on http://localhost:8081/alfresco then the preferences for the portlet instance would be:
alfrescoHost = http://localhost:8081
alfrescoContextPath= /alfresco
httpMethod = GET
webscriptParams =
webscriptUrl = /whatsnew
STAr AMP
Click here for instructions on how to install and configure STAr (Secure Token Authentication rivet).
Example Web scripts
To read more about how to use the bundled example Web scripts click here.
Known Issues
Check here for known issues.
