Update instructions

Purpose: The purpose of this document is to provide an overview of how to manage the update of the Jems service. 

Introduction

The Jems service should be kept updated in order to have the most recent service features and enhancements available. Programmes will receive notifications about the Jems system updates.

Target group

This document addresses in particular the following target groups:

·         IT administrators and operators

·         IT system architects

Prerequisites

Components requirements

Programmes should have the Jems service installed in their environment.
Programmes should have access to the installed instance. The installed instance should be stopped if it was configured as a system service. 

Deliverable

 Interact delivers a ZIP file which contains:

1. A precompiled Java application in Jar format.

2. A Docker Compose script which optionally allows to manage an automatic installation

3. An Addons folder containing standard Addons implementations

Structure:

ReleasXXXXX.zip
│   docker-compose.yml
│   jems-server.jar
│
└───addons
        jems-standard-plugin-X.X.X-SNAPSHOT.jar

Update instructions

Update plan

It is recommended to ensure that the current instance of the Jems service is not being used by any of the users in order to avoid collisions and data losses.  

Please follow the steps listed below to update the Jems service 

Note: If you have already made an installation and used docker script to install service dependencies, do not run it again!

Otherwise there is a risk of data loss.

Step	Description
Get the latest update package	Download package from resource provided by Interact
Unzip package	Unzip package to your local environment
Inform users	Inform users about the system maintenance
Stop Jems service	Stop the Jems service so that no one can use it
Backup Jems service	Create backup folder and copy existent instance of service into it, including addons
Update Jems service	Override service files with Zip content
Replace custom implemented addons	This step is optional for the programmes who created a custom implementations of addons Remove standard implementations of addons Replace addons in Addons folder with custom implementations
Backup database	It is recommended to perform a database backup according to your internal instructions Due to specific features of the data storage of Jems you should rely on the tool below to keep the backup data consistent. Jems uses 'system-versioned' tables in MariaDB, therefore mysqldump will not work as desired, i.e. no historical data will be exported. See MariaDB database backup for further details.
Start Jems service	Start service to make it available
Log in to Jems service	Log in to the Jems service to ensure that the update has been successful

Post update steps

Please follow the instructions to update the Service translations Update translation files

Jems service operation system permissions

Ensure that the user under which the Jems service is running in the OS, has valid permissions and write permissions for the folder where the Jems service is located.

Recovery plan

If you have difficulties with the system maintenance, please follow the recovery instructions to restore the system to its state before the update of the Jems service