Versions Compared

Old Version 16

changes.mady.by.user Shaun Forbes

Saved on

compared with

New Version Current

changes.mady.by.user Shaun Forbes

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Backing up client settings

Info

There is currently an update being tested that stores this information in a database, generally negating the need to perform this operation, but this update is not yet generally available.

...

Warning

Weave 2.4.16 changes the way user settings are stored and removes the need to backup and restore the user settings when performing an upgrade.
The information below about 'Backing up user settings' using ustorage save and ustorage load is now obsolete if you are running version 2.4.16 or greater.
The user settings will be maintained between updates automatically, and will not be effected by cleaning out the configuration directory.

Backing up user settings

Anything the user can save (bookmarks, redlines, etc) will be stored under the Weave installation directory, so they should be exported before the current Weave instance is decommissioned or upgraded.

...

You should specify a fully qualified file name as the last parameter in both commands to make it easy for you to locate the exported file, otherwise the file will be exported somewhere under the Weave directory (and if you don't specify a file name it will be named as ustorage.txt) but don't worry, the command will print out the name of the file that it is using.

This allows you to backup the current user settings and migrate them to the new Weave instance.

Note

There is a similar storage command that does the same thing for system settings, to ensure a complete migration you should also use the storage save and load commands with another file.

...

This allows you to backup the current user settings and migrate them to the new Weave instance.

Note

There is a similar storage command that does the same thing for system settings, to ensure a complete migration you should also use the storage save and load commands with another file.


Info

Note that you need to be using version 1.1.0 of the com.cohga.server.user.storage.osgi bundle for the ustorage command, and version 1.1.2 of the com.cohga.server.storage.osgi bundle for the storage command.
These are the versions included with Weave 2.4.0, so if you're running 2.4.0 or later then you already have the storage and ustorage commands available. They can be manually added to earlier 2.3.x versions of Weave, please contact Cohga for updated bundles if you're running a version earlier than 2.4.0.


Warning

To execute these commands the server needs to either be started using startup.cmd (on Windows) or debug.sh (on Linux) which provides access to the osgi prompt directly. Or, for situations where Weave is started as a background service, telnet access must be enabled, allowing the osgi console to be remotely connected to using a suitable telnet client. Information on the enabling telnet access to the Weave console is available here.

Updating to the new Database user storage option

The method used to store bookmarks and redlines in earlier versions was not robust enough under load, so it has been replaced by one that stores this information in a database.

If you are running version 2.4.16 you are already using this update. If you are running an earlier version you can follow these instructions to update without having to upgrade to 2.4.16.

The updated bundle is available at:
com.cohga.server.user.storage.db_1.4.2.jar

To use this you must:

  • export the existing settings using ustorage save at the osgi prompt
  • stop the server
  • remove the older com.cohga.server.user.storage.osgi bundle

...

  • from platform\plugins
  • install the newer com.cohga.server.

...

  • user.storage.db bundle to platform\plugins
  • replace com.cohga.server.user.storage.osgi with com.cohga.server.user.storage.db in platform\configuration\config.ini
  • clean out the platform\configuration directory (except config.ini)
  • start the server
  • import the existing settings using ustorage load at the osgi prompt.

Upgrading from 2.3 to 2.4

Upgrading Weave from 2.3 to 2.4 currently requires a fresh installation of the new version and the migration of an existing configuration.

...

Info

As an alternative to installing to a new directory you can rename an existing Weave installation, to get it out of the way, and install to the same location, just make sure you remove any existing Windows service (using the remove-service.cmd batch file) before renaming the directory.

Warning: Once you have settled on an installation directory, choose which packages to install. Do not just install all of the packages, especially the Additional Components. It may be tempting to just click all of the check boxes but this is almost certainly not what you want. This will install components that you will never need and don't use. It will add additional memory and performance overheads that you do not want and it will install multiple versions of bundles where there should only be one of that type.

...