Update¶

The update steps divided in the ones for the management server and the ones for the PLOSSYS 5 server.

Hint - no Internet access

If the server on which you want to update the components does not have Internet access, use another server with Internet access for logging on to the SEAL Systems delivery platform and downloading the folder and packages. Then, copy the downloaded files to the server on which you want to update.

Notes Concerning the Update from 5.0.5 to 5.1.0¶

With PLOSSYS 5.1.0, the directory structure of the installation has been changed. Therefore, it is required to execute some manual steps before and after the update, refer to Manual Steps Before Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0 and Manual Steps After Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0.
When updating to PLOSSYS 5.1.0 and using easyPRIMA as of version 1.3.1, the 20181204_perl_soap-lite_1.27_part.zip package has to be installed with easyPRIMA. Otherwise, the export from easyPRIMA to PLOSSYS 5 does not work and the 500 SSL negotiation failed error message is output to the logfile of easyPRIMA (edc.log).

Hint - stop the system

Before installing the 20181204_perl_soap-lite_1.27_part.zip package, stop the system and all Perl processes completely (sysstop -full). Otherwise, the Perl environment will break.
Up to version 5.0.5, an error sheet was output in case of error. As of version 5.1.0, the error sheet is not output by default but can be activated by setting PRINT_ERROR_SHEET to Y. The PRINT_ERROR_SHEET environment variable is available as of version 5.1.0.

Notes Concerning the Update from 5.1.0 to 5.2.1¶

The Consul service has been replaced by a newer incompatible version. Therefore, the system configuration has to be exported before the update and imported again after the update, refer to Manual Steps Before Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1 and Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1.

In MongoDB, a shared replica set has to be configured for the cluster mode and the database has to be initialized for the single server mode. For how to do this, refer to the SEAL-specific MongoDB documentation.

Some services have been replaced by other services or have become obsolete and have to be removed manually after updating, refer to Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1.

Update the Management Server¶

Caution - SEAL Elastic Stack incompatible to seal-elk

SEAL Elastic Stack contains the new version of Elasticsearch and Kibana and replaces seal-elk. Before installing SEAL Elastic Stack, you have to uninstall seal-elk!

In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the SEAL Elastic Stack - 7.16.0.53 - msi folder. It is saved as SEAL Elastic Stack - 7.16.0.53 - msi.zip.
Extract SEAL Elastic Stack - 7.16.0.53 - msi.zip.
Open a Command Prompt (Administrator), change into the SEAL Elastic Stack - 7.16.0.53 - msi\server directory and install the server-related packages contained there:
```
cd "SEAL Elastic Stack - 7.16.0.53 - msi\server"
```
```
install.bat
```
Download seal-bos2gyros-1.0.43.60.msi.
Install seal-bos2gyros-1.0.43.60.msi.
For updating easyPRIMA, refer to the easyPRIMA documentation.

Manual Steps Before Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0¶

With PLOSSYS 5.1.0, the directory structure of the installation has been changed. Therefore, it is required to execute some manual steps before and after the update.

Open a Command Prompt (Administrator) and stop the PLOSSYS 5 system completely:
```
plossys service stop
```
In the Command Prompt (Administrator), copy the following directories to the new locations:
```
robocopy "%ProgramData%\SEAL Systems\plossys\config" "%ProgramData%\SEAL Systems\config" * /e /b /copyall /fp /ns /nc /np /nfl /ndl
```
```
robocopy "%ProgramData%\SEAL Systems\plossys\data" "%ProgramData%\SEAL Systems\data" * /e /b /copyall /fp /ns /nc /np /nfl /ndl
```
Caution - access rights

Do not copy the directories via Windows Explorer. Use the robocopy command in the Command Prompt (Administrator) in order to retain the correct access rights.

In the Command Prompt (Administrator), save the following configuration files:

rename "%ProgramData%\SEAL Systems\config\mongod.conf" mongod.conf.bak 2>NUL

rename "%ProgramData%\SEAL Systems\config\consul.json" consul.json.bak 2>NUL

rename "%ProgramData%\SEAL Systems\config\filebeat.yml" filebeat.yml.bak 2>NUL

When using MongoDB in a cluster, you have to update MongoDB as described in the SEAL-specific MongoDB documentation.

Manual Steps Before Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1¶

With PLOSSYS 5.1.0, the Consul service has been replaced by a newer incompatible version. Therefore, the system configuration has to be exported before the update and imported again after the update.

Save the system configuration:

plossys config export <config_save_filename>

Remove the Consul data directory:

C:\ProgramData\SEAL Systems\data\seal-consul

Manual Steps Before Updating the PLOSSYS 5 Server to 5.3.2¶

With PLOSSYS 5.3.2, the MongoDB service has been replaced by a newer incompatible version. Therefore, the data stored in MongoDB has to be exported before the update and imported again after the update. For how to do this, refer to the SEAL-specific MongoDB documentation.

Update the PLOSSYS 5 Server¶

In the cluster mode, each PLOSSYS 5 server has to be shutdowned gracefully before being updated.
In a browser, log on to the SEAL Systems delivery platform with your logon data:

https://delivery.sealsystems.de

Hint - logon data

You receive the logon data from your Technical Project Manager at SEAL Systems.
Download the PLOSSYS 5 - 5.3.3.539 - msi folder. It is saved as PLOSSYS 5 - 5.3.3.539 - msi.zip.
Extract the PLOSSYS 5 - 5.3.3.539 - msi.zip file.
Open a PowerShell (Administrator), change to the PLOSSYS 5 - 5.3.3.539 - msi directory and start the installation of the packages:
```
cd "PLOSSYS 5 - 5.3.3.539 - msi"
```
```
install.ps1
```
Hint - specifying privileges explicitly

Unless you have specified the privileges for executing PowerShell scripts globally as described in the requirements for the PLOSSYS 5 server, execute the installation script with the following command:
```
Set-ExecutionPolicy Bypass -Scope Process -Force; .\install.ps1
```
Download the SEAL Elastic Stack - 7.16.0.53 - msi folder. It is saved as SEAL Elastic Stack - 7.16.0.53 - msi.zip.
Extract SEAL Elastic Stack - 7.16.0.53 - msi.zip.
In the Command Prompt (Administrator), change to the SEAL Elastic Stack - 7.16.0.53 - msi\client directory and start the installation of the client-related packages:
```
cd "SEAL Elastic Stack - 7.16.0.53 - msi\client"
```
```
install.bat
```

Manual Steps After Updating the PLOSSYS 5 Server from 5.0.5 to 5.1.0¶

With PLOSSYS 5.1.0, the directory structure of the installation has been changed. Therefore, it is required to execute some manual steps before and after the update.

Open a Command Prompt (Administrator) and stop the PLOSSYS 5 system completely:
```
plossys service stop
```
In the Command Prompt (Administrator), adjust the following new configuration files according to the settings in the configuration files saved with the .bak extension before the update:
- %ProgramData%\SEAL Systems\config\mongod.conf
- %ProgramData%\SEAL Systems\config\consul.json
- %ProgramData%\SEAL Systems\config\filebeat.yml
When running PLOSSYS 5 in a cluster, edit %ProgramData%\SEAL Systems\config\mongod.conf and insert the following line into the net section:
```
bindIp: 0.0.0.0
```

In the Command Prompt (Administrator), remove the configuration files saved with the .bak extension before the update and the previous installation directory:

del /S /Q "%ProgramData%\SEAL Systems\config\mongod.conf.bak"

del /S /Q  "%ProgramData%\SEAL Systems\config\consul.json.bak"

del /S /Q  "%ProgramData%\SEAL Systems\config\filebeat.yml.bak"

rmdir "%ProgramData%\SEAL Systems\PLOSSYS"

In the Command Prompt (Administrator), start the PLOSSYS 5 system:
```
plossys service start
```

Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1¶

With PLOSSYS 5.2.1, the Consul service has been replaced by a newer incompatible version. The system configuration exported before updating has to be re-imported.

Import the exported system configuration:

plossys config import <config_save_filename>

With PLOSSYS 5.2.1, the following services have been replaced by other services or have become obsolete and have to be removed manually after updating:

seal-pdf2ps
seal-pdfstamp
seal-ps2pdf
seal-router
seal-sapgof

Open the Apps & Features system dialog and uninstall the services listed above one by one by selecting the service and clicking Uninstall:

Uninstall Service

Manual Steps After Updating the PLOSSYS 5 Server from 5.2.1 to 5.3.0¶

With PLOSSYS 5.3.0, the seal-controller service has been introduced which will replace the seal-dispatcher service in the next version. By default, the seal-dispatcher service is still used but you can already activate the seal-controller service by setting JOB_DISPATCHING to next.

When using the seal-controller service and if you have customized the service keys for seal-dispatcher in your PLOSSYS 5 installation before, you have to repeat the customization for seal-controller after the update:

If you have customized JOB_MAX_POSTPONED_COUNT for seal-dispatcher, set the same value with JOB_MAX_POSTPONED_COUNT for seal-controller.
If you have customized LOUNGE_TTL for seal-dispatcher, set the same value with JOB_RETRY_DELAY for seal-controller.

Caution - known bug

With version 5.3.0, PRINT_ERROR_SHEET does not work.

Manual Steps After Updating the PLOSSYS 5 Server from Prior than 5.3.0 to 5.3.2¶

With PLOSSYS 5.3.2, the service evaluating PRINT_ERROR_SHEET changed from the seal-dispatcher to the seal-convert-dispatcher service.

If you have customized PRINT_ERROR_SHEET for the seal-dispatcher service, customize it for the seal-convert-dispatcher service (or for any service).

Manual Steps After Updating the PLOSSYS 5 Server from 5.3.0 to 5.3.2¶

In PLOSSYS 5.3.0 and with using the seal-dispatcher service, CONVERT_ON_PRINTER_START was evaluated by the seal-rest service, with the version 5.3.2, it is evaluated by the seal-controller service.

If you have customized CONVERT_ON_PRINTER_START for the seal-rest service, customize it for the seal-controller service.

Manual Steps After Updating the PLOSSYS 5 Server to 5.3.2¶

Obsolete Services¶

With PLOSSYS 5.3.2, the seal-dispatcher service has been replaced by other services and has to be removed manually after updating:

Open the Apps & Features system dialog and uninstall the seal-dispatcher service by selecting the service and clicking Uninstall as described in Manual Steps After Updating the PLOSSYS 5 Server from 5.1.0 to 5.2.1.

New Version of MongoDB¶

With PLOSSYS 5.3.2, the MongoDB service has been replaced by a newer incompatible version. Therefore, the MongoDB data exported before updating has to be re-imported. For how to do this, refer to the SEAL-specific MongoDB documentation.

Ensure that all keys required for the cooperation with MongoDB have been specified correctly. For more information, refer to Configure the MongoDB Keys in PLOSSYS 5

PLOSSYS Administrator¶

With PLOSSYS 5.3.2, the dashboard of PLOSSYS Administrator has been secured. In order that the user can see the dashboard, the dashbord area has to be specified in the ALLOWED_OIDC_CLIENTS key. For more information, refer to ALLOWED_OIDC_CLIENTS.

Example - configuration with all views and all permissions

{
  "seal-plossysadmin": {
    "roles": {
      "superadmin": {
        "areas": {
            "jobs": {},
            "printers": {},
            "dashboard": {}
        },
        "set-all": {
            "views": ["ALL"],
            "permissions": ["ALL"]
        }
      }
    }
  }

Manual Steps After Updating the PLOSSYS 5 Server to 5.3.3¶

With PLOSSYS 5.3.3, audit messages have been introduced. For this, the filebeat.yml configuration file has been changed. When updating to PLOSSYS 5.3.3, these changes have to be done manually.

Open the Filebeat configuration file on the PLOSSYS 5 server:
```
C:\ProgramData\SEAL Systems\config\filebeat.yml
```

Add the following entry below the processors section:

- add_fields:
    when:
      has_fields:
        - metadata.audit
    target: ""
    fields:
      indextype: audit
- rename:
    when:
      has_fields:
        - metadata.audit
    fields:
      - from: metadata.audit
        to: audit
      - from: application
        to: audit.application
    ignore_missing: true
- copy_fields:
    when:
      has_fields:
        - audit
    fields:
      - from: timestamp
        to: audit.timestamp
    ignore_missing: true
- drop_fields:
    when:
      has_fields:
        - audit
    fields: ["sourcefile", "hostname", "message", "application", "module", "level", "metadata", "agent", "host", "ecs", "processId"]
    ignore_missing: true