2024:Upgrading Grooper to a New Version - Revision history

Dgreenwood: /* Step 4: Upgrade Grooper Repositories */

2025-03-07T22:42:17Z

Step 4: Upgrade Grooper Repositories

← Older revision		Revision as of 17:42, 7 March 2025
Line 116:		Line 116:
	:*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.		:*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.

	~~{{#lst:2024:~~Grooper Command Console (Application)\|~~upgrade_grooper_repo}}~~		Upgrading a Grooper Repository is done using the Grooper Command Console (GCC) application. Full instructions for upgrading a Grooper Repository can be found in the [[Grooper Command Console (Application)#Create and connect to a new Grooper Repository\|GCC article.]]

			[https://app.supademo.com/demo/cm7yvtm2p005dzl0jeh89fvgk Click here for an interactive walkthrough!]

	Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.		Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.
	<section end="Upgrade1" />		<section end="Upgrade1" />

Dgreenwood: /* Step 4: Upgrade Grooper Repositories */

2025-03-07T21:43:44Z

Step 4: Upgrade Grooper Repositories

← Older revision		Revision as of 16:43, 7 March 2025
Line 113:		Line 113:

	After installing a newer major version of Grooper, each Grooper Repository must be upgraded as well. This is done from Grooper Command Console.		After installing a newer major version of Grooper, each Grooper Repository must be upgraded as well. This is done from Grooper Command Console.
	*<li class="fyi-bullet"> Grooper Repositories only need to be upgraded when upgrading to a new major Grooper version (<u>##.##</u>.####). For minor version upgrades (##.##.<u>####</u>) you can skip this step.		:*<li class="fyi-bullet"> Grooper Repositories only need to be upgraded when upgrading to a new major Grooper version (<u>'''##.##'''</u>.####). For minor version upgrades (##.##.<u>'''####'''</u>) you can skip this step.
	*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.		:*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.

	{{#lst:Grooper Command Console (Application)\|upgrade_grooper_repo}}		{{#lst:2024:Grooper Command Console (Application)\|upgrade_grooper_repo}}

	Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.		Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.
	<section end="Upgrade1" />		<section end="Upgrade1" />

Dgreenwood at 15:36, 7 March 2025

2025-03-07T15:36:08Z

← Older revision		Revision as of 10:36, 7 March 2025
Line 24:		Line 24:
	⚠		⚠
	\|		\|
	'''''BE AWARE: This article instructs users on how to perform simple upgrades. The instructions in this article outline the basic steps for all upgrades.'''''		'''''BE AWARE: 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.		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/Object Libraries are not guaranteed to work without changes upon upgrading to a new major version of Grooper.
	** Custom scripts are ~~not guaranteed to work without changes upon upgrading to a new major version of Grooper~~.		** 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. Some code objects may have been altered/obsoleted or their names may have changed.
			** Make sure you re-compile all Object Libraries after the upgrade.
			* If you are using code expressions in your Batch Processes, IP Profiles, Data Models or Import/Export Mappings, please verify all expressions are working as intended. Some as some code objects may have been altered or obsoleted or their names may have changed.
	* 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 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.		* When upgrading across multiple major versions, Grooper has changed more than if upgrading from the most recent version. Especially when upgrading across multiple versions, your solution design may not be taking advantage of features added in newer versions!
	* 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.		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.
	\|}		\|}
	<section end="UpgradeAbout" />		<section end="UpgradeAbout" />

Dgreenwood: Dgreenwood moved page Upgrading Grooper to a New Version to 2024:Upgrading Grooper to a New Version

2025-03-02T13:53:40Z

Dgreenwood moved page Upgrading Grooper to a New Version to 2024:Upgrading Grooper to a New Version

← Older revision	Revision as of 08:53, 2 March 2025
(No difference)

Dgreenwood at 20:15, 29 August 2024

2024-08-29T20:15:25Z

← Older revision		Revision as of 15:15, 29 August 2024
Line 115:		Line 115:
	*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.		*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.

	{{#lst:Grooper Command Console\|upgrade_grooper_repo}}		{{#lst:Grooper Command Console (Application)\|upgrade_grooper_repo}}

	Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.		Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.
	<section end="Upgrade1" />		<section end="Upgrade1" />

Dgreenwood at 20:12, 29 August 2024

2024-08-29T20:12:56Z

← Older revision		Revision as of 15:12, 29 August 2024
Line 50:		Line 50:
	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.		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.

	For more information on validating your Grooper Repository, visit the [[~~beta:~~Validate Branch]] article.		For more information on validating your Grooper Repository, visit the [[Validate Branch]] article.

	===Step 1: Stop services===		===Step 1: Stop services===

Dgreenwood at 19:32, 29 August 2024

2024-08-29T19:32:55Z

← Older revision		Revision as of 14:32, 29 August 2024
Line 1:		Line 1:
	{{~~Migrated~~}}		{{AutoVersion}}
	{{~~2023~~:{{~~PAGENAME~~}}}}		<blockquote>
			Upgrading to the newest version of Grooper ensures you have access to the newest features in our intelligent document processing platform.
			</blockquote>
			== About ==
			<section begin="UpgradeAbout" />
			'''''PLEASE NOTE:''''' There are a few things to be aware of before starting your upgrade.
			* You can upgrade directly from version 2.72 and above to version 2024.
			* When upgrading from versions older than 2.72, you must upgrade to 2.72 before upgrading to 2024.
			* Version 2022 introduced '''Projects''' to Grooper, which are a new way of organizing Grooper resources in the node tree. Upgraded Grooper Repositories ''older'' than 2022 will have many of their nodes reorganized into a '''Project''' called "Project 1".
			** For more information on '''Projects''', visit the [[Project]] article.
			** For specific guidance on how to navigate the new '''Project''' architecture from an upgraded Grooper Repository, visit the [[Project#Upgrade guidance\|upgrade guidance section of the Project article]].


			Upgrading to 2024 is now easier than ever. The upgrade process is essentially four steps:

			# Stop any Grooper services.
			# Uninstall the older version of Grooper.
			# Install the newer version of Grooper.
			# Upgrade Grooper Repositories from the older version to the newer.

			{\|class="attn-box"
			\|
			⚠
			\|
			'''''BE AWARE: 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.
			\|}
			<section end="UpgradeAbout" />

			== How to perform a simple upgrade ==
			<section begin="Upgrade1" />
			=== Best practices before upgrading ===

			==== Back up your Grooper Repository before upgrading ====

			{{BackupRepos}}

			==== Validate your Grooper Repository before upgrading ====

			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.

			For more information on validating your Grooper Repository, visit the [[beta:Validate Branch]] article.

			===Step 1: Stop services===

			Before uninstalling your current version of Grooper, you need to stop all services currently running in the Grooper Repository. This will help avoid potential errors regarding the services connected to your repositories. The easiest way to do this is from the '''Machines''' folder node in the Design Page.

			# Go to the '''Machines''' folder.
			# Select the "Services" tab.
			#*<li class="fyi-bullet"> This will ensure you can select all services installed on ''any'' machine connected to the Grooper Repository.
			# Select all services in the list.
			# Press the "Stop" button.
			#*<li class="fyi-bullet"> Once stopped, you will see each service's "Status" listed as "Stopped".

			[[File:2024_UpgradingGrooperToANewVersion_02_02-StopServices-01.png]]

			{{GhostServices}}

			=== Step 2: 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, most commonly from the Windows Settings menu.
			*<li class="attn-bullet"> '''''BE AWARE:''''' When upgrading to a new '''''major''''' Grooper version (<u>##.##</u>.####), '''''always''''' back up your Grooper Repositories (database and file store) before upgrading.
			*<li class="attn-bullet"> '''''BE AWARE:''''' Even when upgrading to a new minor Grooper version (##.##.<u>####</u>), it is still considered best practice to back up your Grooper Repositories.

			{\|cellpadding=10 cellspacing=5
			\|style="width:40%" valign=top\|

			# On the computer where '''Grooper''' is installed, open Windows Settings and select "Apps".
			\|
			[[File:2023-Install and Setup-Uninstall Grooper 01.png]]
			\|-
			\|valign=top\|
			Scroll down through your list of apps until you find the '''Grooper''' application. Or use the search bar to search for "Grooper".
			#<li value=2> Click on the app.
			#When it expands, select "Uninstall". The uninstallation process may take a few minutes. You may be prompted to restart the computer once finished.


			Repeat this process for the '''Grooper Web Client''' application. It is also considered best practice to ''stop'' the Grooper app pool in IIS ''before'' uninstalling the Grooper Web Client application.

			Repeat this process for the '''Grooper Desktop''' application (where installed).
			\|
			[[File:2023-Install and Setup-Uninstall Grooper 02.png]]
			\|}

			=== Step 3: Install the new Grooper version ===

			{\|cellpadding=10 cellspacing=5
			\|style="width:40%" valign=top\|
			If you have not done so, you will need to download the current installer files from Grooper xChange. ZIP archives containing the installer files can be found in the "Downloads and Resources" section, linked below:
			* https://https://xchange.grooper.com/categories/downloads-and-resources
			* Be sure to download installers for each application required for your install (Grooper, Grooper Web Client, and/or Grooper Desktop).

			Once downloaded, unzip the installers file, open the "Setup" executable files and follow the onscreen instructions to install the current Grooper version. If you need more help, you can find the full Grooper installation instructions following the links below:
			* [[Install and Setup#Installing Grooper\|Installing Grooper]]
			* [[Install and Setup#Installing Grooper Web Client\|Installing Grooper Web Client]]
			* [[Install and Setup#Installing Grooper Desktop\|Installing Grooper Desktop]]
			\|
			[[File:Install-instructions-2021-1.png]]
			\|}

			=== Step 4: Upgrade Grooper Repositories ===

			After installing a newer major version of Grooper, each Grooper Repository must be upgraded as well. This is done from Grooper Command Console.
			*<li class="fyi-bullet"> Grooper Repositories only need to be upgraded when upgrading to a new major Grooper version (<u>##.##</u>.####). For minor version upgrades (##.##.<u>####</u>) you can skip this step.
			*<li class="attn-bullet"> '''''BE AWARE:''''' Grooper Repositories can be upgraded to a newer major version but cannot be ''downgraded''. Please be sure you want to upgrade a Grooper Repository before doing so.

			{{#lst:Grooper Command Console\|upgrade_grooper_repo}}

			Congratulations! You've upgraded Grooper! Once a Grooper Repository is upgraded, it is effectively up to date with the installed Grooper version.
			<section end="Upgrade1" />

Randallkinard at 17:09, 28 August 2024

2024-08-28T17:09:25Z

← Older revision		Revision as of 12:09, 28 August 2024
Line 1:		Line 1:
	{{~~Migrated2023~~}}		{{Migrated}}
	{{2023:{{PAGENAME}}}}		{{2023:{{PAGENAME}}}}

Randallkinard: Randallkinard moved page Upgrading Grooper to a New Version (Concept) to Upgrading Grooper to a New Version over a redirect without leaving a redirect: undo naming

2024-04-18T19:25:22Z

Randallkinard moved page Upgrading Grooper to a New Version (Concept) to Upgrading Grooper to a New Version over a redirect without leaving a redirect: undo naming

← Older revision	Revision as of 14:25, 18 April 2024
(No difference)

Randallkinard: Randallkinard moved page Upgrading Grooper to a New Version to Upgrading Grooper to a New Version (Concept): new naming convention

2024-04-18T17:54:54Z

Randallkinard moved page Upgrading Grooper to a New Version to Upgrading Grooper to a New Version (Concept): new naming convention

← Older revision	Revision as of 12:54, 18 April 2024
(No difference)