Installation Instructions

Requirements

To install Move2Alf you need to have the following software available on your system:

  • MySQL >=5
  • A Java application server. Move2Alf is tested on Tomcat >=6 and Jetty.

Create a Database

Create a new MySQL database. The supplied file "setup.sql" will create a new MySQL database called "move2alf". It will also add a user with username "move2alf" and password "move2alf".
You can execute this with the following command:

mysql -u root -p < setup.sql

Install Move2Alf

Now you are ready to deploy the application itself. You can do this by moving "move2alf.war" to the "webapps" folder of your Tomcat installation. In the default configuration of Tomcat any .war moved here will be deployed automatically. Refer to the documentation of your application server if you don't use Tomcat.

License

The license file (move2alf.lic) must be placed in the class path under move2alf/move2alf.lic.

When using Tomcat you have two options to add the license to the class path:

  1. Let Tomcat deploy the .war and place the license in ${catalina.home}/webapps/move2alf/WEB-INF/classes/move2alf/move2alf.lic
  2. Add ${catalina.home}/shared/classes to the shared.loader property in catalina.properties (if it is not present already) and place the license in ${catalina.home}/shared/classes/move2alf/move2alf.lic

The second option is preferred since it will persist after a redeploy of the .war.

Without the license file it will not be possible to start any jobs.

Configuration

After deploying Move2Alf you should configure it for your environment. The main configuration file is "move2alf.properties". You can find it in "move2alf/WEB-INF/classes/move2alf.properties".

You can customise the configuration by creating a copy of move2alf.properties in <class_path>/move2alf/move2alf-custom.properties and overriding the properties here. See the License section above to learn where to locate the class path.

Here is a list of all available configuration parameters:

Parameter

Description

db.url

The URL used to connect to the database server. This contains the hostname and the name of the database. Only MySQL is supported.

db.user

The username used to connect to the database server.

db.pass

The password used to connect to the database server.

mail.from

The email address to send email reports from.

mail.smtp

The SMTP server for sending email reports.

url

The URL where you can access Move2Alf. This is used to create links in the email reports.

base.package

If you create custom actions you should set this to the package where your action classes can be found. By default only actions in the "eu.xenit" package are loaded.
default.batch.size Number of documents uploaded per transaction.

The location of the log file can be changed in "log4j.properties".

Restart Move2Alf after making changes to the configuration files to apply them.

Optional: Install Move2Alf AMP

If you want to use Move2Alf to set auditable properties (defined as part of the cm:auditable aspect) you need to install the Move2Alf AMP (move2alf_optional.amp) on the destination Alfresco server. The list of auditable properties is:

  • Created (cm:created)
  • Creator (cm:creator)
  • Modified (cm:modified)
  • Modifier (cm:modifier)
  • Accessed (cm:accessed)

For information on how to install the AMP please consult the Alfresco documentation:
http://docs.alfresco.com/4.1/index.jsp?topic=%2Fcom.alfresco.enterprise.doc%2Ftasks%2Famp-install.html