2.90:Upgrading Grooper to a New Version: Difference between revisions

From Grooper Wiki
← Older edit
No edit summary
Tag: Reverted
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<blockquote>
__NOINDEX__
{{AutoVersion}}
<blockquote style="font-size:14pt">
So you're ready to upgrade?
So you're ready to upgrade?
</blockquote>
</blockquote>
{| class="wikitable" style="margin:left"
! Previous Versions
|-
|
[[Upgrading Grooper to a New Version - 2022|Grooper 2022]]<br>
[[Upgrading Grooper to a New Version - 2021|Grooper 2021]]<br>
[[Upgrading Grooper to a New Version - 2.90|Grooper 2.90]]
<br>
|}


== About ==
== About ==
<section begin="Upgrade1" />
{|cellpadding="10" cellspacing="5" style="margin:12px; width: 100%"
|-
|style="font-size:250%; background-color:#662d91; color:white; width:28px; text-align:center"|'''&#8252;'''
|style="border: 4px solid #662d91"|
'''IMPORTANT!!! NEW GROOPER ARCITECTURE DETECTED - PROJECTS'''
'''Projects''' are a new way of organizing Grooper resources in the node tree.  After upgrading, all your resources will work as they did before, but their organization will shift from certain parts of the node tree to a '''Project''' named "Project 1".  You may choose to move resources out of this '''Project''' and into new '''Projects''' or you can choose to keep everything in "Project 1".  For more information and guidance, refer to the links below:
* [[Project]] - This is the full '''Projects''' article.  It has general information about what '''Projects''' are and how to use them.
* [[Project - 2023#Projects and Upgrading to 2023|Projects and Upgrading to 2023]] - This contains specific guidance around upgrading from an older version of Grooper to version 2023, how to navigate the new '''Project''' architecture, and how to move from "Project 1" to new '''Projects'''.
|}
Upgrading to 2023 is now easier than ever.  You can upgrade directly from version 2.72, 2.80, 2.90, 2021, or 2022 to version 2023 (For upgrading from versions older than 2.72, you must upgrade to 2.72 before upgrading to 2023).
The upgrade process is essentially three steps:
# Uninstall the older version of Grooper.
# Install Grooper 2023.
# Upgrade Grooper Repositories from the older version to 2023.
{|cellpadding="10" cellspacing="5" style="margin:12px; width: 100%"
|-
|style="font-size:250%; background-color:#f89420; color:white; width:28px; text-align:center"|&#9888;
|style="border: 4px solid #f89420"|
This article instructs users on how to perform simple upgrades.  The instructions in this article outline the basic steps for all upgrades.
However, depending on your Grooper install, your upgrade process may be more involved. 
* If you are running scripts in your environment to customize Grooper's functionality, you may need to update the associated scripting code and '''Object Libraries''', as some code objects may have been altered or obsoleted or their names may have changed.
** If present, make sure you re-compile all '''Object Libraries''' after the upgrade.
** Custom scripts are not guaranteed to work without changes upon upgrading to a new major version of Grooper.
* If you are running custom reports polling the Grooper database, you may need to update the report query, as Grooper's database tables may have changed.
* If you are using expressions in your '''Batch Processes''', '''IP Profiles''', '''Data Models''' or '''Import/Export Mappings''', please verify all expressions are working as intended as some as some code objects may have been altered or obsoleted or their names may have changed.
* If you are moving across multiple major versions, it's likely Grooper's architecture has changed more than if upgrading from one major version to the next.  Your solution design may not be taking advantage of newly added features in  newer versions.
** In all cases, you should take some time to test your Grooper system after an upgrade to ensure everything is working as expected.  When upgrading across multiple major versions, please take extra care to do so.
|}
=== How To Perform a Simple Upgrade ===


{|cellpadding="10" cellspacing="5" style="margin:12px; width: 100%"
The basics of upgrading Grooper can be broken down into three steps.
|-
|style="font-size:125%; background-color:#36b0a7; color:white; width:28px; text-align:center"|'''FYI'''
|style="border: 4px solid #36b0a7"|
If you are upgrading from version 2.72, 2.80 or 2.90, 2021, or 2022 to 2023, you may upgrade directly to version 2023.  However, if you are upgrading from version 2.70 (or older) to 2023, you must first upgrade to version 2.72, and then upgrade to version 2023.
|}


{|cellpadding="10" cellspacing="5" style="margin:12px; width: 100%"
# Uninstall the old version of Grooper.
|-
# Install the new version of Grooper.
|style="font-size:250%; background-color:#662d91; color:white; width:28px; text-align:center"|'''&#8252;'''
# Upgrade your existing Grooper Repositories in Grooper Config.
|style="border: 4px solid #662d91"|
'''IMPORTANT!!! DON'T FORGET TO BACKUP YOUR REPOS'''


You should always perform a complete backup of your Grooper Repository's file store and database before upgrading to any newer Grooper version.
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.
*If, for whatever reason, something goes wrong during the upgrade process and your file store and/or database is corrupted, you could loose critical components, such as your '''Batch Processes''', '''Content Models''', or document files for any '''Test''' or '''Production Batches'''.
*Performing a backup will ensure you have something to revert to in the rare cases where the upgrade does improperly overwrite existing database values or files in your file store.


== How To ==


For information how to backup and restore your Grooper database and file store, please visit the article below:
=== Perform a Simple Upgrade ===
* [[Backup and Restore Grooper Repository]]
|}


<tabs style="margin:20px">
<tabs style="margin:20px">
<tab name="Before You Begin" style="margin:20px">
<tab name="Starting Point" style="margin:20px">
 
=== Starting Point ===
=== Backup and Validate Your Grooper Repository ===
 
You should always perform a complete backup of your Grooper Repository's file store and database before upgrading to any newer Grooper version. If, for whatever reason, something goes wrong during the upgrade process and your file store and/or database is corrupted, you could loose critical components, such as your '''Batch Processes''', '''Content Models''', or document files for any '''Test''' or '''Production Batches'''. Performing a backup will ensure you have something to revert to in the rare cases where the upgrade does improperly overwrite existing database values or files in your file store.
 
For information how to backup and restore your Grooper database and file store, please visit the article below:
* [[Backup and Restore Grooper Repository]]
 
 
While not ''strictly'' necessary, the Grooper developers '''''strongly''''' encourage you perform validation on your Grooper Repository before upgrading from and older version to a newer version of Grooper.  Improperly configured nodes can cause unexpected issues during upgrade.  Validating your repository helps catch these configuration issues to avoid configuration related problems when upgrading the objects in your existing repository to the newer versions of those objects.


{|cellpadding=10 cellspacing=5
{|cellpadding=10 cellspacing=5
|valign=top style="width:40%"|
|style="width:40%" valign=top|
For example, a '''Data Type''' with its '''''Local Extractor''''' set to ''Pattern Match'' but with no pattern set is an issue.  If this is left unconfigured, validation will catch the configuration error.
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".


# You can see that we do not have this ''Pattern Match'' fully configured.
# Currently, Grooper version 2.80 is installed on this machine.  Note the "Grooper280" repository is listed as "Ok" in the Status column.
# On this '''Data Type''' we see we have an error.
# 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.
{|cellpadding="10" cellspacing="5"
|-style="background-color:#f89420; color:white"
|style="font-size:14pt"|'''&#9888;'''
|
|
[[File:2023 Upgrading Grooper to a New Version - 2023 01 How To 01.png]]
'''IMPORTANT''' - Make sure you perform a complete backup of your filestore and Grooper database before upgrading to 2.9.
|-
 
|valign=top style="width:40%"|
For information how to backup and restore your Grooper database and filestore, [[Backup and Restore Grooper Repository|please visit this article]].
# If we right-click on the '''Project''' object...
# ... and click on "Validate Branch"...
# ... a window will pop up showing us the validation error. We will need to correct this before upgrading.  
|
[[File:2023 Upgrading Grooper to a New Version - 2023 01 How To 02.png]]
|-
|valign=top style="width:40%"|


{|cellpadding=10 cellspacing=5 style="margin:12px"
'''IMPORTANT''' - The devs strongly recommend that you perform validation on your repository before upgrading, as improperly configured nodes can cause unexpected issues during upgrade.
|-
|style="font-size:200%; background-color:#662d91; color:white; width:28px; text-align:center"|'''&#8252;'''
|style="border: 4px solid #662d91"|
It is recommended that you validate your ENTIRE repository before upgrading to a new version of Grooper. However, validation CANNOT be performed at the Root Node in the web client. You MUST open the thick client in order to fully validate your repository.  
|}


To validate your Grooper Repository and catch configuration errors like the one described above perform the following steps:
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.


# In Grooper Design Studio, select the root of the repository's Node Tree in the Tree View window.
[[File:Validate-branch.png|center]]
|valign=top|
[[File:2021-upgrading-grooper-validate-branch-2.png]]
|-
|valign=top style="width:40%"|
#<li value=2> Select "Tools" from the toolbar.
# Select "Validate Branch..."
# This will bring up the "Validate Branch" window.
# Click the "Validate" button.
# Grooper will check every object in your repository for any property configuration errors.  Any object with configuration errors will be listed here.
#* By choosing the validate the root, you validate all descendent branches.  In other words, the whole repo.
# You may select any object in the list and click the "Go To Item" button to go to that object and resolve the configuration error, if you so choose.
|valign=top|
[[File:2021-upgrading-grooper-validate-branch-3.png]]
|}
|}
</tab>
<tab name="Stop Services" style="margin:20px">
====Stop Services====
Before uninstalling your current version of Grooper, you will need to stop all services currently running in Grooper Config. This will help avoid potential errors regarding the services connected to your repositories.
{|cellpadding=10 cellspacing=5
|style="width:40%" valign=top|
#Open Grooper Config and click "Edit Services".
|
|
[[File:2023-Install and Setup-Stop Services 01.png]]
[[File:Upgrading-grooper-1.png]]
|-
|valign=top|
#<li value=2>If you have any services running they will be listed with a green dot to the left side.
#You can select each individual service and click "stop" or you can just click "Stop All".
|
[[File:2023-Install and Setup-Stop Services 02.png]]
|-
|valign=top|
#<li value=4>Once a service is stopped, the dot to the left of the service name should turn red.
|
[[File:2023-Install and Setup-Stop Services 03.png]]
|}
|}


{|cellpadding="12" cellspacing="4" style="margin:12px"
{|cellpadding="10" cellspacing="5"
|-
|-style="background-color:#36b0a7; color:white"
|style="font-size:250%; background-color:#f89420; color:white; width:28px; text-align:center"|&#9888;
|style="font-size:14pt"|'''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.
|style="border: 4px solid #f89420"|
Very rarely, a Grooper service will not uninstall properly when you uninstall the service from Grooper Config. This can make it appear as though a duplicate or "ghost" Windows service is installed without being listed in Grooper Config.


If this does occur, you will need to manually delete the service from the Windows Registry Editor, using the following steps:
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.
# Open the Registry Editor (regedit.exe)
# Navigate to the <code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services</code> key.
# Select the key of the service you want to delete.
# From the "Edit" menu select "Delete.
# You will be prompted "Are you sure you want to delete this Key?". Click Yes.
# Exit the Registry Editor.
|}
|}


</tab>
</tab>
<tab name="Uninstall Grooper" style="margin:20px">
<tab name="1. Uninstall Current Version" style="margin:20px">
==== Back up your Database and File Store ====
=== Uninstall the Current Version ===
 
{|cellpadding="10" cellspacing="5" style="margin:12px"
|-
|style="font-size:250%; background-color:#f89420; color:white; width:28px; text-align:center"|&#9888;
|style="border: 4px solid #f89420"|
You should always perform a complete backup of your Grooper Repository's file store and database before upgrading to any newer Grooper version.
 
If, for whatever reason, something goes wrong during the upgrade process and your file store and/or database is corrupted, you could lose critical components, such as your '''Batch Processes''', '''Content Models''', or document files for any '''Test''' or '''Production Batches'''.
 
Performing a backup will ensure you have something to revert to in the rare cases where the upgrade does improperly overwrite existing database values or files in your file store.
 
For information how to backup and restore your Grooper database and filestore, [[Backup and Restore Grooper Repository|please visit this article]].
|}
 
==== Uninstall the Current Version of Grooper ====
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 your settings menu.


{|cellpadding=10 cellspacing=5
{|cellpadding=10 cellspacing=5
|style="width:40%" valign=top|
|style="width:40%" valign=top|
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.


#Open your Windows Settings and click on "Apps".
# Access a list of your currently installed programs by traversing the following path in Control Panel
|
#* <code>Control Panel > Programs > Programs and Features</code>
[[File:2023-Install and Setup-Uninstall Grooper 01.png]]
# Select Grooper from the program list.
|-
# Press the "Uninstall" button.  If it appears, confirm you want to uninstall on the subsequent dialog box.
|valign=top|
# Reboot your computer after the program finishes uninstalling.
#<li value=2>Scroll down through your list of apps until you find the Grooper application. Click on the app.  
#* You should get a notification a reboot is required to complete the setup like the one seen here.
#When it expands, click on "Uninstall".  
|
|
[[File:2023-Install and Setup-Uninstall Grooper 02.png]]
[[File:Upgrading-grooper-2.png]]
|-
|valign=top|
#<li value=4>A small window may pop up to confirm you wish to uninstall the app. Click "Uninstall".
|
[[File:2023-Install and Setup-Uninstall Grooper 03.png]]
|-
|valign=top|
#<li value=5>Wait for the application to be uninstalled.
|
[[File:2023-Install and Setup-Uninstall Grooper 04.png]]
|}
|}
</tab>
</tab>
<tab name="Install the New Grooper Version" style="margin:20px">
<tab name="2. Install New Version" style="margin:20px">
=== Install the New Grooper Version ===
 
=== Install the New Version ===


{|cellpadding=10 cellspacing=5
{|cellpadding=10 cellspacing=5
Line 223: Line 82:
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
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
https://https://xchange.grooper.com/categories/downloads-and-resources


Once downloaded, unzip the installer file, open the "Setup" executable file and follow the onscreen instructions to install the current Grooper version. If you need more help, you can find the full Grooper installation instructions by following the link below:
Once downloaded, unzip the zip archive.  For this tutorial, we downloaded and unzipped the installer files for version 2.90.0036.


* [[#Installing the Grooper Product Suite|Installing the Grooper Product Suite]]
# Navigate through the extracted folder to find the "setup" executable.
# Run the "setup" executable to open the installer.
|
|
[[File:Install-instructions-2021-1.png]]
[[File:Upgrading-grooper-3.png]]
|-
|style="width:40%" valign=top|
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.
|
[[File:Upgrading-grooper-4.png]]
|}
|}


=== Additional Guidance for Web Client Deployments ===
* If you are upgrading the Grooper web client, you must also uninstall the Grooper Web Client application on your web server and install the newer version.
** '''IMPORTANT''' It is best practice to ''stop'' the Grooper app pool in IIS ''before'' uninstalling the Grooper Web Client application.
* After upgrading the Grooper web server, if you have remote scan workstations with Grooper Desktop installed, you will also need to uninstall Grooper Desktop and install the newer version on each workstation.
|}
</tab>
</tab>
<tab name="Upgrade Grooper Repositories" style="margin:20px">
<tab name="3. Upgrade Grooper Repositories" style="margin:20px">
=== Upgrade Grooper Repositories from Grooper Config ===
=== Upgrade Grooper Repositories from Grooper Config ===


After installing Grooper 2023, open Grooper Config to upgrade the previous versions of Grooper Repositories to 2023.
After the installer has finished running, open Grooper Config to upgrade the older versioned Grooper Repositories to the newly installed version.


{|cellpadding="10" cellspacing="5" style="margin:12px"
{|cellpadding="10" cellspacing="5"
|-
|-style="background-color:#36b0a7; color:white"
|style="font-size:125%; background-color:#36b0a7; color:white; width:28px; text-align:center"|'''FYI'''
|style="font-size:14pt"|'''FYI'''
|style="border: 4px solid #36b0a7"|
|
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 2021 or 2021 to 2023), ''all'' Grooper Repositories configured on an older version ''must'' be upgraded in order to connect to them to Grooper.
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.
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.
Line 254: Line 114:
''However'', you should still always uninstall the old version of Grooper before installing the new version, even when upgrading to a new minor version.
''However'', you should still always uninstall the old version of Grooper before installing the new version, even when upgrading to a new minor version.
|}
|}
When upgrading from a version older than 2021 to version 2021 or later, you'll notice the Grooper Config application's UI has changed. Previously, Grooper Repository connections were listed in a grid. Now, we will need to get into the '''''Repositories''''' configuration window to upgrade the previous versions of the Grooper Repositories to the new versions.
 
{|cellpadding=10 cellspacing=5
{|cellpadding=10 cellspacing=5
|style="width:40%" valign=top|
|style="width:40%" valign=top|
Notice two things about our Grooper Repositories here:


 
# The repository named "Grooper290" now matches the current version (2.90). It's Status is listed as "Ok".
# Select the '''''Repositories''''' property.
#* Any Grooper Repository whose version matches the currently installed version of Grooper will have a Status of "Ok".
# Click the ellipsis button at the end of the property.
# The repository named "Grooper280" is still on the older version (2.80) and needs to be upgraded. Its Status is listed as "Needs Upgrade"
|valign=top|
#* Any Grooper Repository whose version is older than the currently installed version of Grooper will have a Status of "Needs Upgrade".
[[File:2023-Install and Setup-Upgrading 01.png]]
|
|-
[[File:Upgrading-grooper-5.png]]
|valign=top|
 
Currently, Grooper version 2023 is installed on this machine.  As seen here, in Grooper Config, we have two Grooper Repository connections: one named "okcstrpa01_001" and the other "okcstrpa01_002".
 
* The Grooper Repository named "okcstrpa01_001" is a networked repository. Its status is listed as "Ok" because it has already been updated to Grooper 2023. This repository's version matches the version of Grooper installed on this machine.
* The Grooper Repository named "okcstrpa01_002" is another networked repository. Its status is listed as "Needs Upgrade" because it has not been updated to Grooper 2023 yet. 
After upgrading to Grooper 2023 you will need to upgrade all previous repositories to 2023.  
|valign=top|
[[File:2023-Install and Setup-Upgrading 02.png]]
|-
|-
|style="width:40%" valign=top|
|style="width:40%" valign=top|
#<li value=3> To upgrade a Grooper Repository, select the repository that needs upgrading.
# To upgrade a Grooper Repository, select the repository that needs upgrading.
# Click the "Upgrade..." button in the upper toolbar.
# Press the "Upgrade..." button in the upper toolbar.
|
# Press the "Execute" button on the following pop up window to confirm the upgrade.
[[File:2023-Install and Setup-Upgrading 03.png]]
|-
|valign=top|
#<li value=5> An "Upgrade" window will appear. Click the "Execute" button to confirm the upgrade.
|valign=top|
[[File:2023-Install and Setup-Upgrading 04.png]]
|-
|valign=top|
#<li value=6> You will be prompted to execute a Version Upgrader. Click "Execute" to start the upgrader.  
|
|
[[File:2023-Install and Setup-Upgrading 05.png]]
[[File:Upgrading-grooper-6.png]]
|-
|valign=top|
#<li value=7>  When the upgrader is finished, click "Ok".
#* In instances where you are upgrading multiple versions of Grooper (i.e. 2.80 to 2021) you must run each Version Upgrader sequentially. For example, in our case, we had to execute the Version 2021 to 2022 Upgrader first, followed by the Version 2022 to 2023 Upgrader. Repeat steps 6. and 7. for each version of Grooper you are needing to upgrade.
|valign=top|
[[File:2023-Install and Setup-Upgrading 06.png]]
|-
|-
|style="width:40%" valign=top|
|style="width:40%" valign=top|
#<li value=8> After the upgrade is complete, click the "Test Connection.." button to ensure you're now property connected to the upgraded database.
After the upgrade is complete, you will see the upgraded Grooper Repository's Status change from "Needs Upgrade" to "Ok".
# If successful, a message box will pop up confirming your connection. Click Ok.
 
Congratulations!  You've upgraded Grooper.
|
|
[[File:2023-Install and Setup-Upgrading 07.png]]
[[File:Upgrading-grooper-7.png]]
|-
|}
|valign=top|
 
#<li value=10> You will see the upgraded Grooper Repository's '''''Status''''' change from "''NeedsUpgrade''" to "''Ok''".
{|cellpadding="10" cellspacing="5"
# Click the "Ok" button to exit the '''''Repositories''''' window.
|-style="background-color:#f89420; color:white"
|valign=top|
|style="font-size:14pt"|'''&#9888;'''
[[File:2023-Install and Setup-Upgrading 08.png]]
|-
|valign=top|
#<li value=12> Click the "Save" button in the main screen of Grooper Config to complete the upgrade.
|
|
[[File:2023-Install and Setup-Upgrading 09.png]]
'''IMPORTANT''' - If present, make sure you compile all Object Libraries after the upgrade.
|-
 
|valign=top|
'''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.
Congratulations! You've upgraded Grooper.
|}


{|cellpadding="10" cellspacing="5" style="margin:12px"
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.
|-
|style="font-size:250%; background-color:#f89420; color:white; width:28px; text-align:center"|&#9888;
|style="border: 4px solid #f89420"|
'''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. 
[[File:Validate-branch.png|center]]
* '''Object Libraries''' should be compiled ''before'' validating your repository to ensure best results.
|}
|}
</tab>
</tab>
:[[#Upgrading an Older Version of Grooper|Click here to return to the top of the section]]
</tabs>
</tabs>
<section end="Upgrade1" />
[[Category:Articles]]
[[Category:Version 2023]]

Latest revision as of 11:08, 5 August 2025


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.

Retrieved from "https://wiki.grooper.com/index.php?title=2.90:Upgrading_Grooper_to_a_New_Version&oldid=29920"