v2.2.0 Upgrade Notes

Configuration changes

Replace docker-compose.yml with new version from release folder.

Update container versions in .env to v2.2.0.

Keycloak running behind Traefik

Keycloak is now running behind the Traefik reverse proxy. Keycloak should now be accessed at https://<baseUrl>/auth instead of machine name and port. E.g. https://demo42.mops4.mopssys.com/auth

conf/keycloak/keycloak.conf

Add this on a new line http-enabled=true.

Change the hostname to be the complete URL. E.g. hostname=https://demo42.mops4.mopssys.com/auth

conf/general/general-config.json

token_uri should be the complete URL ending in /auth.

conf/mops-dir/mops-dir.config

Modify any issuer which points to Keycloak using machine name and port to use the complete URL ending in /auth.

Identity Issuers (Settings -> Security -> Identity Issuers)

Modify any issuer which points to Keycloak using machine name and port to use the complete URL ending in /auth.

Directory Database

You should run the update script for the directory database. This will add the changes from MD-1290 and ensure that inherited permissions gets applied correctly.

See Upgrade Directory Database - Step 3.

[MD-1889] Reference state attribute missing from DISPLAYREF Entity type

The “ReferenceState” attribute is now associated with parent entity type “REF” so that “DISPLAYREF”, “TRENDREF” and “DASHBOARDREF” inherits it correctly. If a display referenced previously needed to maintain a State, the “REF” entity types may have had makeshift attributes created for them. If a display fails after this upgrade it might be due to changes in this attribute.

[MD-1888] Excel-Add in Configs are not added in the setup

Excel Add-in is a Beta release. Automated configuration is minimal and installation requires manual intervention.

Installing MOPS 4.0 Excel Add-In

MOPS 4.0 Excel Add-In is a separate service and needs to be configured to be available. Office 365 Excel also needs to be configured to make the add-in appear in Microsoft Excel.

1. Setup the configuration file

Configuration reference will show details on how the configuration file should be updated.

2. Install the Add-In in Microsoft Office 365

Instructions on how to configure Microsoft Office 365 can be found at MOPS 4.0 Excel Add-In Installation.

3. Setup Security for Excel in MOPS 4.0

Create new application

Create a client

Create new client

When you login to excel you will see your client appearing in the task pane

Note that the new docker-compose.yml that is delivered with the v2.2.0 version container an additional service named excel-addin that must be running when using MOPS 4.0 Excel Add-In.