Skip to content

Backup

Because sedex Clients run in many different types of environments with widely varying workloads and can be constantly sending and receiving messages, it is impossible to recommend a single approach for backing up a sedex Client installation that would apply to every situation. What follows are general guidelines.

A few warnings

  • Do not backup the sedex Client installation structure in order to “install” it in or move it to another location. Use the sedex installer/migrator for this (see Migrating/updating existing sedex Clients ). Internally the sedex Client uses paths to certificates, message fragments, etc. which would all be invalid in a new location.
  • A disk accident can result in the loss of messages and receipts. Contact the FSO’s sedex Customer Support before trying to restore a sedex Client installation in such a case.

Static, configurable, and dynamic parts

A sedex Client installation consists of static, configurable, and dynamic parts (the folders referenced below are described in Folders and their permissions.

The static part is generally the same for all installations of a given version. It includes:

  • The software itself (/apps)
  • The JRE (/jre)

The configurable part will be different for each installation but is not changed often once it has been configured. It includes:

  • The scripts (/bin, /service-wrapper)
  • The sedex Client’s run-time configuration, its certificates (which are renewed automatically!), and optionally sedex Web Service Proxy certificates, key stores, and users (/conf and /conf/certificates)

The dynamic part will change constantly whenever a sedex Client is running. It includes:

  • The interface folders (/interface)
  • The current state of the sedex Client (/internal)
  • Logs (/logs)
  • The current state of message processing (/messaging-state)
  • The sedex Client’s currently reported state (/monitoring

Backups and their limitations

A given state of the static and configurable parts can be backed up and restored, but is only useful if the backup was made after the latest installation, migration, configuration change, and certificate renewal. A restoration to a state other than the current would result in an obsolete, invalid sedex Client installation and potentially a loss of messages

A given state of the dynamic part can be backed up, but a restoration is almost always dangerous. As the sedex Client sends and receives messages and receipts and renews certificates, the dynamic state changes and a restoration would revert the installation to a state where messages and receipts have not been or are partially sent or received, and certificates are invalid.

If one knows in advance, that a disk will need to be reformatted or replaced, then a backup and restoration of the whole sedex Client installation could make sense. Proceed as follows:

  • Warning: Giving the disk a different name/letter when reformatting would be the same as trying to move the sedex Client installation to another location which, as stated above, would not work for the stated reasons.
  • The sedex Client and the business application must be stopped.
  • All folders related to the sedex Client must be backed up.
  • Reformat or replace the disk.
  • Restore the installation.
  • The sedex Client and the business application should not be started again before the restoration is completed.