Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added basic instructions for trying the portlet

...

  • In-Memory account store (useful only for demonstration purposes)
  • uPortal database account store (useful for using this portlet to add self-service account creation and management features to uPortal, e.g. for small uPortal projects not making use of an external store of user accounts)
  • Hibernate/RDBMS account store for storing accounts into a database

Source control

TODO: note location in source control

This portlet is in Jasig source control here: https://source.jasig.org/sandbox/self-service-accounts-portlet/

So you can check it out locally via

Code Block

svn co https://source.jasig.org/sandbox/self-service-accounts-portlet/trunk ./trunk

Installing and testing

TODO: Document how to install and test

Get the source code

Code Block

svn co https://source.jasig.org/sandbox/self-service-accounts-portlet/trunk ./trunk

Manually install FreeTTS dependency into your local Maven repository

Note
titleAlternatively, point at MVN repo for this project

Instead of you having to manually install this .jar, it should be installed into a Jasig maven repository. That hasn't been done yet.

TODO: install this dependency into a Jasig maven repository

Download FreeTTS from http://sourceforge.net/projects/freetts/files/FreeTTS/FreeTTS%201.2.1/freetts-1.2.1-bin.zip/download

Extract the archive.
Locate freetts.jar

Install it with this command:

Code Block
 
$ mvn install:install-file -DgroupId=com.sun.speech.freetts -DartifactId=freetts -Dversion=1.2.1 -Dpackaging=jar -Dfile=/path/to/file 

where "/path/to/file is the path to the freetts.jar

This will install the jar file into your environment's Maven repository, which by default is in a ".m2" directory in your home directory.

Build the source code to produce a war file

In the /trunk directory you checked out, run

Code Block
 
$ mvn install 

This will create a "target" directory and inside of that directory will be an AccountRegistrationPortlet.war

Install uPortal

The instructions in Cris Holdorph's blog post, e.g., walk you through this.

Deploy the portlet into uPortal

In the uPortal source directory, with build.properties properly configured, run

Code Block
 
ant deployPortletApp -DportletApp=/path/to/AccountRegistrationPortlet.war

where /path/to/AccountRegistrationPortlet.war addresses the AccountRegistrationPortlet.war you built into that target directory.

Publish the portlet

Log in to uPortal as an administrator (default: admin/admin)
Use the Portlet Manager (default: link at right) and step through the portlet publication workflow to publish a new Portlet. Select the AccountRegistrationPortlet application's account creation portlet as the portlet you'd like to publish.

Add the portlet to a layout

If you were doing this for real, you'd want to add it to the "guest" layout such that not-logged-in users can use it. Since it's just in demo mode at this point and not integrated with uPortal's account management or LDAP, you can subscribe this portlet anywhere you like.

What you have to do for this portlet to be at all useful to you

...