The first upgrade step is to backup the ScrumWorks Pro server you intend to upgrade. Although the upgrade process should not affect your existing data, it is always a good idea to back up data before upgrading.

Please refer to the backup documentation.

Existing customers can obtain the latest stable version of ScrumWorks Pro Windows distribution from the ScrumWorks Pro download web site. Note, the same binaries are used for both upgrades and fresh installations.

1. Open the ScrumWorks Pro download web site in a web browser.
2. Enter your Case ID number and the maximum users in your license. These two values can be found by opening the license file in a text editor. Alternatively, existing customers will find the values for the "Case ID" and "Licensed Users" in the "Help > About" menu in the Desktop Client.
3. Select the latest Windows platform Hypersonic distribution and download. The distribution file is an archive named:
   scrumworks-pro-[version]-win-[arch].zip
4. Extract the ZIP file into a temporary directory.

The ScrumWorks Pro service must be shutdown prior to running the setup program in the next step. This is done one of two ways:

• from the Windows Start Menu, locate the ScrumWorks Pro Server folder and select the Shutdown option; or
• locate "Services" from the Control Panel and shutdown ScrumWorks Pro server.

1. Run Setup. Extract the zip archive and run the ScrumWorks Server Setup.exe file. Review and accept the License, or click "Cancel" to exit at any time. An administrator user account is required to upgrade ScrumWorks Pro server on all Windows platforms.
2. Choose Install Location. Choose whether to upgrade an existing installation in place, or install ScrumWorks Pro parallel to an existing installation. If installed in a parallel location, the installer will still provide an option to migrate data from existing installation without over-writing that installation.

   Upgrade Existing Installation (Over-write)

   1. To upgrade an existing installation, input the location of the installation to upgrade in the Destination Folder field on the "Choose Install Location" screen. Click "Next".
   2. If a valid installation of ScrumWorks is detected, the next screen will summarize steps taken by the upgrade process. Click "Next to continue".
   3. Note, custom JVM options (such as memory tweaks) will remain intact via this upgrade process.

   Parallel Installation (Preserve Original Installation)

   1. Input a Destination Folder other than the path to an existing ScrumWorks installation on the "Choose Install Location" screen. Click "Next" to continue.
   2. Choose between two options: Start with new data, or Migrate existing ScrumWorks data from another installation of ScrumWorks.
   If starting with new data
   • This option will include the sample database.
   If migrating existing ScrumWorks data
   • If an existing local installation is detected, the installer will pre-populate the "Choose folder" field of the Migrate option.
   • If you want to migrate data from another computer, use the backup process on the source computer and copy the resulting directory and database files (scrumworks.properties and scrumworks.script) to the destination computer. In the installer, set the "Choose Folder" location to the directory of the ScrumWorks files obtained from the source computer.
   • Be sure that the existing ScrumWorks server to be migrated is shut down. Migrating data from an existing ScrumWorks server will not affect the existing installation.
   3. Be sure that the existing ScrumWorks server to be migrated is shut down. Only one ScrumWorks server can be run at any one time.
   Note: if your previous installation had non-default JVM options (such as memory settings), these options will not port to your parallel installation.
3. Choose Start Menu Folder. Click Install to finish the installation.
4. Confirm your installation. ScrumWorks Pro takes a few moments to start, and once started the login screen shall be visible locally on the server via a web browser at http://localhost:8080/scrumworks/.

• To shutdown the ScrumWorks Pro Server, open your "Start Menu", and navigate to the ScrumWorks Pro Server folder. Click the "Stop ScrumWorks Pro Service" menu item.

  You can also stop the ScrumWorks Pro Server via the Services dialog in the Windows Control Panel Administrative Tools.

• By default, the ScrumWorks Pro Server will be started automatically the next time you reboot. Locate the ScrumWorks Pro Service in "Administrative Tools" > "Services" to modify start up options.

By default, ScrumWorks Pro is permitted to use up to 768MB of memory. If you would like to modify the amount of memory used by the ScrumWorks Pro Server, run the memory.exe tool located under the utils folder inside ScrumWorks Pro Server folder and select the desired amount of Allocated Memory.

You must run the memory.exe tool as Administrator. Right click on the file and click "Run as Administrator".

You will need to restart the server for the changes to take effect.

Note that if the allocated memory is too large, the service will fail to start. In this case, the amount of allocated memory needs to be lowered. Please check with your Windows administrator for advice on adjusting ScrumWorks Pro server's memory allocation.

The MySQL distribution of ScrumWorks Pro allows use of the MySQL database. MySQL is recommended for production ScrumWorks Pro use. Before installing the MySQL distribution of ScrumWorks Pro, please read the MySQL requirements and configuration guide.

If you wish to transfer from a Hypersonic to a MySQL database, please read the Hypersonic-to-MySQL transfer documentation.

Caution: once transferred to MySQL, ScrumWorks Pro data cannot be transferred back to Hypersonic.