Upgrading existing Xuse installs

Please note: the upgrade tool is not guaranteed to function perfectly - please make sure you have backed up your existing work to a secure location before proceeding. The Xuse team does not hold any responsibility or liability for loss of data.

Now that the caveat is out of the way - Xuse does provide an upgrade tool. Currently this tool is suitable for upgrading Xuse 00.01.01 (or 0.1 for short) projects to 00.02.RC3 (or 0.2 for short).

Maven 2.x users

  • To upgrade your project please navigate to the root directory of your project (PROJECT_BASEDIR).
  • Type the following command: 
    	mvn net.sourceforge.xuse:maven-xuse-m2-plugin:upgrade
  • Xuse should upgrade the relevant files leaving copies of the originals in their original folder with an extension of DSTAMP.TSTAMP.old, where DSTAMP and TSTAMP are the date timestamps at the time of the upgrade.
  • You should now be able to run the standard command of 
    	mvn net.sourceforge.xuse:maven-xuse-m2-plugin:xuse

Maven 1.x users

  • To upgrade your project please navigate to the root directory of your project (PROJECT_BASEDIR).
  • Type the following command: 
    	maven xuse:upgrade
  • Xuse should upgrade the relevant files leaving copies of the originals in their original folder with an extension of DSTAMP.TSTAMP.old, where DSTAMP and TSTAMP are the date timestamps at the time of the upgrade.
  • You should now be able to run the standard command of 
    	maven xuse

Command line users

  • To upgrade your project please navigate to the root directory of your project (PROJECT_BASEDIR).
  • Type the following command: 
    	java net.sourceforge.xuse.Xuse xuse:upgrade
  • Xuse should upgrade the relevant files leaving copies of the originals in their original folder with an extension of DSTAMP.TSTAMP.old, where DSTAMP and TSTAMP are the date timestamps at the time of the upgrade.
  • You should now be able to run the standard command of 
    	java net.sourceforge.xuse.Xuse xuse

Trouble shooting

Should the HTML site fail to build following the upgrade read the error message carefully. If you see something along the lines of 

[java] Actor "user" is referenced by "Change Personal Details (UC2)", but does not exist
[java] Actor "user" is referenced by "Logon (UC1)", but does not exist
[java] Validation errors, build cannot continue...
you will need to edit the actors.xml file to include the details of the missing actors.