Upgrading Grooper to a New Version - Revision history

Dgreenwood: /* Residual files */

2026-03-10T14:48:23Z

Residual files

← Older revision		Revision as of 09:48, 10 March 2026
Line 175:		Line 175:
	* These leftover files can cause issues after installing a newer Grooper build.		* These leftover files can cause issues after installing a newer Grooper build.
	* In some cases, the older files interfere with Grooper’s operation, making the application appear unstable or, in extreme cases, unusable.		* In some cases, the older files interfere with Grooper’s operation, making the application appear unstable or, in extreme cases, unusable.


	To ensure no residual files remain after uninstalling a Grooper application:		To ensure no residual files remain after uninstalling a Grooper application:

Dgreenwood: /* How to perform a simple upgrade */

2026-03-10T14:46:07Z

How to perform a simple upgrade

← Older revision		Revision as of 09:46, 10 March 2026
Line 165:		Line 165:
	</div>		</div>
	<section end="Upgrade1" />		<section end="Upgrade1" />

			== Troubleshooting ==

			=== Residual files ===

			The most common issue encountered during an upgrade is caused by '''residual files'''.

			* Occasionally, Windows does not completely remove older Grooper files during the uninstall process.
			* These leftover files can cause issues after installing a newer Grooper build.
			* In some cases, the older files interfere with Grooper’s operation, making the application appear unstable or, in extreme cases, unusable.

			To ensure no residual files remain after uninstalling a Grooper application:

			# Verify that no files remain in the installation directory.
			#* For Grooper, confirm the following directory is empty or does not exist:
			#** <code>C:\Program Files\BIS\Grooper</code>
			#* For Grooper Web Client, confirm the following directories are empty or do not exist:
			#** <code>C:\inetpub\wwwroot\Grooper</code>
			#** <code>C:\inetpub\wwwroot\GWS</code>
			# If any files or folders remain, delete them.
			# Install the newer Grooper application.

Randallkinard: /* How to perform a simple upgrade */

2026-01-22T19:32:15Z

How to perform a simple upgrade

← Older revision		Revision as of 14:32, 22 January 2026
Line 88:		Line 88:
	== How to perform a simple upgrade ==		== How to perform a simple upgrade ==
	<section begin="Upgrade1" />		<section begin="Upgrade1" />
			<div style="padding-left: 1.5em;">
	====Step 1: Stop services====		====Step 1: Stop services====

Line 162:		Line 163:
	**<li class="attn-bullet"> Custom scripts are not guaranteed to work after upgrading to a new version of Grooper without making changes to the script. Some objects in Grooper's core code may have been altered, obsoleted or their names may have changed.		**<li class="attn-bullet"> Custom scripts are not guaranteed to work after upgrading to a new version of Grooper without making changes to the script. Some objects in Grooper's core code may have been altered, obsoleted or their names may have changed.
	* If you are running custom reports outside of Grooper that query the Grooper database, you may need to update the report query. Grooper's database tables can and do change between major versions.		* If you are running custom reports outside of Grooper that query the Grooper database, you may need to update the report query. Grooper's database tables can and do change between major versions.
			</div>
	<section end="Upgrade1" />		<section end="Upgrade1" />

Randallkinard: /* Best practices before upgrading */

2026-01-22T19:31:34Z

Best practices before upgrading

← Older revision		Revision as of 14:31, 22 January 2026
Line 64:		Line 64:
	* {{IconName\|Object Library}} Object Libraries		* {{IconName\|Object Library}} Object Libraries
	**<li class="fyi-bullet"> Of the scriptable nodes, the Object Library is most common. It allows users the most flexibility in developing new object types (typically inheriting from existing object types in Grooper).		**<li class="fyi-bullet"> Of the scriptable nodes, the Object Library is most common. It allows users the most flexibility in developing new object types (typically inheriting from existing object types in Grooper).
			<div style="padding-left: 1.5em;">
	<big>Scripts should be '''disabled''' before upgrading.</big>		<big>Scripts should be '''disabled''' before upgrading.</big>
	* If the script contains methods or classes no longer used in the Grooper version you're upgrading to, this may cause stability issues in your Grooper Repository.		* If the script contains methods or classes no longer used in the Grooper version you're upgrading to, this may cause stability issues in your Grooper Repository.
Line 82:		Line 82:
	** (Windows client) Press the "Actions" button. Press the "Disable" button from the dropdown.		** (Windows client) Press the "Actions" button. Press the "Disable" button from the dropdown.
	** (Web client) Press the "Disable" ({{IconName\|do_not_disturb_off}}) button.		** (Web client) Press the "Disable" ({{IconName\|do_not_disturb_off}}) button.
			</div>
	</div>		</div>
	<section end="BeforeUpgrade" />		<section end="BeforeUpgrade" />

Randallkinard: /* Best practices before upgrading */

2026-01-22T19:30:58Z

Best practices before upgrading

← Older revision		Revision as of 14:30, 22 January 2026
Line 42:		Line 42:
	== Best practices before upgrading ==		== Best practices before upgrading ==
	<section begin="BeforeUpgrade" />		<section begin="BeforeUpgrade" />
			<div style="padding-left: 1.5em;">
	==== Back up your Grooper Repository before upgrading ====		==== Back up your Grooper Repository before upgrading ====

Line 81:		Line 82:
	** (Windows client) Press the "Actions" button. Press the "Disable" button from the dropdown.		** (Windows client) Press the "Actions" button. Press the "Disable" button from the dropdown.
	** (Web client) Press the "Disable" ({{IconName\|do_not_disturb_off}}) button.		** (Web client) Press the "Disable" ({{IconName\|do_not_disturb_off}}) button.
			</div>
	<section end="BeforeUpgrade" />		<section end="BeforeUpgrade" />

Dgreenwood: /* After upgrading */

2025-11-05T18:01:03Z

After upgrading

← Older revision		Revision as of 13:01, 5 November 2025
Line 144:		Line 144:

	After upgrading, you should verify your Grooper Repository is in good working order.		After upgrading, you should verify your Grooper Repository is in good working order.
	* Test Batch Processes to ensure they work as expected.		* Test Batch Processes and other configuration nodes to ensure they work as expected.
	* If you are using code expressions (particularly more complicated lambda expressions) take care to verify these expressions work as expected. Grooper methods and classes you're using/inheriting may have been altered, obsoleted or their names may have changed.		* If you are using code expressions (particularly more complicated lambda expressions) take care to verify these expressions work as expected. Grooper methods and classes you're using/inheriting may have been altered, obsoleted or their names may have changed.
	**<li class="fyi-bullet"> Code expressions may be used on:		**<li class="fyi-bullet"> Code expressions may be used on:

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

2025-11-05T18:00:34Z

Step 4: Upgrade Grooper Repositories

← Older revision		Revision as of 13:00, 5 November 2025
Line 140:		Line 140:

	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.

			==== After upgrading ====

			After upgrading, you should verify your Grooper Repository is in good working order.
			* Test Batch Processes to ensure they work as expected.
			* If you are using code expressions (particularly more complicated lambda expressions) take care to verify these expressions work as expected. Grooper methods and classes you're using/inheriting may have been altered, obsoleted or their names may have changed.
			**<li class="fyi-bullet"> Code expressions may be used on:
			*** Data Fields (Default Value, Calculated Value, Is Valid, Is Required)
			*** Data Columns (Default Value, Calculated Value, Is Valid, Is Required)
			*** Batch Process Steps (Next Step Expression, Should Submit Expression)
			*** Various Export Providers via their mapping expressions
			*** CMIS Import and Import Behaviors and their mapping expressions
			*** Variable Definitions
			*** Various features that use "path expressions (File Export, FTP/SFTP Export, CMIS Export, Merge, various Export Formats)
			*** Various features that use "triggers" (Data Rules, Data Actions, Fill Methods)
			* Object Libraries and other node scripts must be re-compiled before they can be used in the new version of Grooper.
			* Test Object Libraries and other node scripts to ensure they work as expected.
			**<li class="attn-bullet"> Custom scripts are not guaranteed to work after upgrading to a new version of Grooper without making changes to the script. Some objects in Grooper's core code may have been altered, obsoleted or their names may have changed.
			* If you are running custom reports outside of Grooper that query the Grooper database, you may need to update the report query. Grooper's database tables can and do change between major versions.
	<section end="Upgrade1" />		<section end="Upgrade1" />

Dgreenwood: /* How to perform a simple upgrade */

2025-11-05T15:26:36Z

How to perform a simple upgrade

← Older revision		Revision as of 10:26, 5 November 2025
Line 85:		Line 85:
	== How to perform a simple upgrade ==		== How to perform a simple upgrade ==
	<section begin="Upgrade1" />		<section begin="Upgrade1" />
	===Step 1: Stop services===		====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.		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.
Line 100:		Line 100:
	{{GhostServices}}		{{GhostServices}}

	=== Step 2: Uninstall the current version of Grooper ===		==== 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.		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.
Line 115:		Line 115:
	# If uninstalling Grooper Desktop, repeat this process for the Grooper Desktop application on each workstation where Grooper Desktop is installed.		# If uninstalling Grooper Desktop, repeat this process for the Grooper Desktop application on each workstation where Grooper Desktop is installed.

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

	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:		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:
Line 126:		Line 126:
	* [[Install and Setup#Installing Grooper Desktop\|Installing Grooper Desktop]]		* [[Install and Setup#Installing Grooper Desktop\|Installing Grooper Desktop]]

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

	:*<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.

Dgreenwood: /* Best practices before upgrading */

2025-11-05T15:26:11Z

Best practices before upgrading

Dgreenwood at 15:22, 5 November 2025

2025-11-05T15:22:52Z

@@ Line 40: / Line 40: @@
 <section end="UpgradeAbout" />
 == How to perform a simple upgrade ==
 <section begin="Upgrade1" />