2.90:Upgrading Grooper to a New Version

From Grooper Wiki


This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

202520242023202220212.90

So you're ready to upgrade?

About

The basics of upgrading Grooper can be broken down into three steps.

  1. Uninstall the old version of Grooper.
  2. Install the new version of Grooper.
  3. Upgrade your existing Grooper Repositories in Grooper Config.

Depending on your Grooper install, your upgrade process may be slightly more involved (For example, if you are running scripts in your environment to customize Grooper's functionality, you may need to update the associated Object Libraries). However, these three basic steps will apply to all upgrades.

How To

Perform a Simple Upgrade

Starting Point

In this tutorial, we will upgrade a version 2.80 Grooper install to version 2.90. In Grooper Config you will see we have two repository connections: one named "Grooper290" and the other "Grooper280".

  1. Currently, Grooper version 2.80 is installed on this machine. Note the "Grooper280" repository is listed as "Ok" in the Status column.
  2. The "Grooper290" repository's Status is listed as "Newer Version".
    • This is because this environment was actually built in version 2.90, which is the version we're upgrading to on this machine. By the end of this tutorial, the Grooper install will be upgraded to version 2.90, and both repositories will be listed as "Ok", indicating they have both are using version 2.90.

IMPORTANT - Make sure you perform a complete backup of your filestore and Grooper database before upgrading to 2.9.

For information how to backup and restore your Grooper database and filestore, please visit this article.

IMPORTANT - The devs strongly recommend that you perform validation on your repository before upgrading, as improperly configured nodes can cause unexpected issues during upgrade.

You can validate your entire Grooper Repository in Grooper Design Studio by selecting the Root Node and choosing "Validate Branch" from "Tools" in the top menu bar.

FYI If you are upgrading from version 2.72 to 2.90, you may upgrade directly to version 2.90. However, if you are upgrading from version 2.60 to 2.90, you must first upgrade to version 2.72, and then upgrade to version 2.90.

If you are upgrading from version 2.60 to 2.72, you may upgrade directly to 2.72. You do not need to install version 2.70 before installing 2.72.

Uninstall the Current Version

The first thing you need to do is uninstall the current version of Grooper before installing the new version. This can be done in a number of ways, such as uninstalling from the Windows Control Panel.

  1. Access a list of your currently installed programs by traversing the following path in Control Panel
    • Control Panel > Programs > Programs and Features
  2. Select Grooper from the program list.
  3. Press the "Uninstall" button. If it appears, confirm you want to uninstall on the subsequent dialog box.
  4. Reboot your computer after the program finishes uninstalling.
    • You should get a notification a reboot is required to complete the setup like the one seen here.

Install the New Version

If you have not done so, you will need to download the current installer file from Grooper xChange. Zip archives containing the installer files can be found in the "Downloads and Resources" section, linked bellow

https://https://xchange.grooper.com/categories/downloads-and-resources

Once downloaded, unzip the zip archive. For this tutorial, we downloaded and unzipped the installer files for version 2.90.0036.

  1. Navigate through the extracted folder to find the "setup" executable.
  2. Run the "setup" executable to open the installer.

You should see the Grooper Installer window pop up next. Step through the installer's prompts to install the new version of Grooper.

  • Since you're upgrading, all pre-requisite installations (such as the Microsoft .Net Framework) should already be installed. However, should you need to install any prereqs, the installer will prompt you to do so.

Upgrade Grooper Repositories from Grooper Config

After the installer has finished running, open Grooper Config to upgrade the older versioned Grooper Repositories to the newly installed version.

FYI

Major versions of Grooper change the Grooper Database in meaningful ways. These changes to the database must be reflected by upgrading the Grooper Repository. For major version upgrades (For example, 2.80 to 2.90), all repositories configured on an older version must be upgraded.

For minor version upgrades (For example, 2.90.0001 to 2.90.0002) you do not need to upgrade each Grooper Repository. No major changes are made to the Grooper Database, and you can skip this step.

However, you should still always uninstall the old version of Grooper before installing the new version, even when upgrading to a new minor version.

Notice two things about our Grooper Repositories here:

  1. The repository named "Grooper290" now matches the current version (2.90). It's Status is listed as "Ok".
    • Any Grooper Repository whose version matches the currently installed version of Grooper will have a Status of "Ok".
  2. The repository named "Grooper280" is still on the older version (2.80) and needs to be upgraded. Its Status is listed as "Needs Upgrade"
    • Any Grooper Repository whose version is older than the currently installed version of Grooper will have a Status of "Needs Upgrade".

  1. To upgrade a Grooper Repository, select the repository that needs upgrading.
  2. Press the "Upgrade..." button in the upper toolbar.
  3. Press the "Execute" button on the following pop up window to confirm the upgrade.

After the upgrade is complete, you will see the upgraded Grooper Repository's Status change from "Needs Upgrade" to "Ok".

Congratulations! You've upgraded Grooper.

IMPORTANT - If present, make sure you compile all Object Libraries after the upgrade.

IMPORTANT - The devs also strongly recommend that you perform validation on your repository after upgrading. Object Libraries should be compiled before validating your repository to ensure best results.

You can validate your entire Grooper Repository in Grooper Design Studio by selecting the Root Node and choosing "Validate Branch" from "Tools" in the top menu bar.