For the complete documentation index, see llms.txt. This page is also available as Markdown.

Upgrade

Learn how to upgrade ZigiOps to a newer release: backup steps, release-specific actions, and the backout plan for SOA versions.

How to move your ZigiOps instance to a newer release while keeping your existing configuration intact.

ZigiOps upgrade path

ZigiOps supports upgrading from previous versions while retaining your existing configuration. To upgrade successfully, first identify your current ZigiOps release, then follow the standard upgrade instructions together with any release-specific steps that apply between your current version and the version you want to reach.

Example: If you are currently running ZigiOps 2021.01.x and want to upgrade to ZigiOps 2024.04.x, you must apply the release-specific instructions for every version between your current release and the target release, in order.

ZigiOps upgrade path: apply release-specific steps in sequence between your current and target versions.

Upgrade instructions

1

Stop ZigiOps

2

Back up the existing installation

Back up the existing ZigiOps installation folder to another location.

  • Linux only, if ZigiOps was installed as a service: back up the ZigiOps service file (/etc/systemd/system/zigiwave.service).

3

Install the new release

Start the installation of the new ZigiOps release in your existing ZigiOps installation folder.

You must follow the corresponding release-specific instructions for every release between your current and desired version. If none of the versions in between require release-specific steps, you can skip that section and continue with the rest of the upgrade.

Release-specific instructions

Some ZigiOps releases require extra steps during the upgrade. The table below summarizes them; expand each entry for the full instructions.

ZigiOps release
Required action

2021.07.648

Delete the /conf/settings/accounts, /conf/settings/credentials, and /conf/settings/users folders.

2021.10.145

Remove the key-password and key-manager-pass lines from /conf/config.properties and save the file.

2023.01.191

Delete the contents of the /conf/settings/queries folder.

2023.08.2.18

Replace Java 8 (64-bit) with Oracle Java 17 (64-bit) or Open Java 17 (64-bit), update JAVA_HOME, and redeploy the ZigiOps service with the OS Service option.

2024.05.1.303

Redeploy the ZigiOps service with the OS Service option to pick up the new startup parameters introduced in this release.

ZigiOps 2021.07.648 (release-specific steps)

Delete the following folders:

  • /conf/settings/accounts

  • /conf/settings/credentials

  • /conf/settings/users

ZigiOps 2021.10.145 (release-specific steps)

Remove the following lines from the /conf/config.properties file and save the changes afterward:

  • key-password

  • key-manager-pass

ZigiOps 2023.01.191 (release-specific steps)

Delete the contents of the /conf/settings/queries folder.

ZigiOps 2023.08.2.18 (release-specific steps)
1

Uninstall Java 8

Uninstall the old Java 8 (64-bit) from the ZigiOps host and restart it.

2

Install Java 17

Install Oracle Java 17 (64-bit) or Open Java 17 (64-bit).

  • Ensure the JAVA_HOME variable is set to the Java 17 deployment.

3

Redeploy the ZigiOps service

Redeploy the ZigiOps service so the platform picks up the new Java 17 deployment required by this release.

  • Select the OS Service option during the installation.

ZigiOps 2024.05.1.303 (release-specific steps)

Redeploy the ZigiOps service, since this release introduces new startup parameters.

  • Select the OS Service option during the installation.

After completing the applicable release-specific steps:

  • Wait for the installation to finish, then start the ZigiOps service or process.

  • Go to the Connected Systems page and confirm that the test connection is successful.

  • Go to the Configurator page, then select and enable the integration template you need.

  • Confirm that the integration works as expected.

Backout plan

If you need to revert to the previous version after an upgrade, follow these steps.

1

Stop ZigiOps

2

Restore the previous backup

Restore the previous version's backup to the application's installation folder, replacing all files.

3

Start ZigiOps

Backout plan: from ZigiOps 2024.11.3.173 (or newer) to an earlier release

Windows

1

Stop ZigiOps

2

Uninstall the ZigiOps SOA release and its services

  • Run C:\ZigiWave\ZigiOps\webapp\service\uninstall_service.bat to uninstall the ZigiOps Web App service.

  • Run C:\ZigiWave\ZigiOps\platform\service\uninstall_service.bat to uninstall the ZigiOps Platform service.

  • Manually delete the ZigiOps installation folder, typically C:\ZigiWave\ZigiOps, unless a different location was specified during installation.

3

Restore the ZigiOps installation

Restore the ZigiOps installation from your backup.

4

Reinstall the old ZigiOps service

Run C:\ZigiWave\ZigiOps\service\install_service.bat to reinstall the old (non-SOA) ZigiOps service.

5

Start ZigiOps

Linux

1

Stop ZigiOps

2

Uninstall the ZigiOps SOA release and its services

  • Delete the /etc/systemd/system/zigiwave_webapp.service ZigiOps Web App service file (skip this step if you did not install the ZigiOps services).

  • Delete the /etc/systemd/system/zigiwave_platform.service ZigiOps Platform service file (skip this step if you did not install the ZigiOps services).

  • Manually delete the ZigiOps installation folder, typically /opt/zigiwave/zigiops, unless a different location was specified during installation.

3

Restore the ZigiOps installation

Restore the ZigiOps installation from your backup.

  • Linux only, if ZigiOps was installed as a service: restore the old (non-SOA) zigiwave.service file from your backup to the /etc/systemd/system/ folder.

4

Start ZigiOps

Frequently asked questions

Can I upgrade ZigiOps directly to the latest version?

Only if no release-specific instructions apply between your current release and the target release. If any release in between has release-specific instructions, apply them in order before moving on.

Does upgrading ZigiOps affect my existing configuration?

No. The new release is installed directly into your existing ZigiOps installation folder, so your configuration is retained.

What changed with the ZigiOps 2024.11.3.173 release?

This release introduced a service-oriented architecture (SOA) that splits the platform into separate Web App and Platform services. Reverting from this release or a newer one to an earlier version requires the additional backout steps described above.

Related: System Requirements · Scaling and Sizing · Install on Linux · Install on Windows

Last updated

Was this helpful?