Install and Setup - 2021
Welcome to Grooper!
This guide will instruct you how to get up and running in Grooper. There are three parts of installing and setting up Grooper:
This article also provides guidance for upgrading an older version of Grooper to version 2021.
Installing the Grooper Product Suite
Download the Installer
If you have not registered at Grooper xChange, do so by clicking the link below. Once you've registered, you will have access to the user forum, including the "Downloads and Resources" section. Follow the link below to the "Download and Resources" section. The top level topic will have download links to the most recent version of Grooper. Links to older versions are available lower in the list of topics. You will also need to choose between the 64-bit installer and the 32-bit installer. The 64-bit installer is appropriate for most environments. However, if you are using ISIS or TWAIN drivers to operate a scanner, you will need to install the 32-bit version. |
|
The installer files will download as a zipped folder. Right-click the folder and select "Extract All..." |
|
|
Run the Setup Application
Open the extracted folder to reveal the installation files. Open the "setup" application. |
Install Prerequisite Components
There are a few components required to be installed prior to installing the Grooper Product Suite. Most notably, this includes the Microsoft .NET Framework. The setup application will prompt you to install any necessary components if they are not already installed on the server or workstation.
|
|
|
|
The installer will install each component one by one. Each item will be listed as "Succeeded" for successfully installed programs, "Installing" for the program currently installing, "Pending" for items waiting to be installed, or "Failed" if the installation was unsuccessful. |
|
Certain components may prompt you through an Installation Wizard to complete their installation. Follow the steps on these dialog boxes to complete their installation until you can press a "Finish" button. You may need to accept license agreements to finish these components' installations. |
|
Note: The installer may prompt you to restart your computer. If so, click "Yes" to reboot. After rebooting, navigate to the installer folder and open the "setup" application again to finish installing Grooper. |
Run the Grooper Installer
When finished installing the prerequisite items, the setup application will automatically start the Grooper installer program. Click "Next" to begin.
|
|
|
Verify the Installation
If you installed Grooper on a machine using the Windows 10, Windows Server 2016, or Windows Server 2019 operating systems, you can find all installed Grooper applications in the Start Menu in a folder named "Grooper". |
|
If installed on Windows Server 2012, you can search for "Grooper" and find all applications in the Grooper Product Suite listed. |
|
Regardless, Grooper will install to the "Program Files" folder of your hard drive (unless you choose a different location during installation). You can use Windows File Explorer to locate all Grooper files using the path |
Connecting to a Grooper Repository
A Grooper Repository is the environment used to create, configure and execute objects in Grooper. It provides the framework to "do work" in Grooper.
This environment consists of two things:
- A database connection
- A file store connection
The database stores Grooper nodes and their property settings (such as a Content Model or a Data Type or any other Grooper object). The file store location houses content associated with these nodes (such as the image file for a Batch Page object). Grooper is the application layer that sits on top of this two parts of the environment. It allows readable and writable access and the UI to create, configure, test and process the information stored there.
Connecting to a Grooper Repository is one of the first things you will do after installing Grooper to start designing (or implementing already architected) document processing solutions. This is done with the Grooper Config application.
⚠ | Grooper Config must be run as an administrator to perform most of its functionality. It performs functions that require elevated access in Windows. |
Creating a New Grooper Repository
Initialize Grooper Config
If this is your first time opening Grooper Config after installation, you will need to initialize the System Configuration. You will see the following dialog box appear.
|
|
Upon initializing the system for the first time, you will see this screen. This is a totally unconfigured Grooper Config! From here, we can create new Grooper Repositories and connect to existing Grooper Repositories accessible on your network. If starting totally from scratch, you will need to create at least one Grooper Repository. |
Establish the File Store Location
Remember, a Grooper Repository is two things:
The file store simply needs to be a Windows folder you have readable and writable access to. In this case, it is a folder named "2021FileStore" in a parent folder named "GrooperFileStores" in the "Documents" folder of this server.
|
|||
The file store can be any folder you have writeable access to. However, using a fully qualified UNC path is always regarded as best practice. UNC paths can be established using the "Sharing" properties of a folder.
|
|||
|
Install SQL Express
⚠ | This step is only applicable to stand-alone Grooper installations on a local machine. If you are using the full version of Microsoft SQL Server and it is already installed and running, you can skip this step and continue to the next tab. |
Remember, a Grooper Repository is two things:
For Grooper Repositories, nodes and their property values are stored in tables in a SQL database. Node objects created in Grooper Design Studio are stored as rows in a table, with their property values in the row's columns. This can be anything from a Batch of documents, to a Batch Process used to process that Batch, to a Content Model referenced by the Batch Process to classify the documents in the Batch or any object used to execute document processing in Grooper. If you do not have a SQL environment already available, you can download and install Microsoft SQL Express directly from Grooper Config.
|
|
Next, you can install SQL Express directly from Grooper Config.
|
|
|
|
You will then be prompted through the SQL Express installation process. |
|
|
Create a New Grooper Repository
Now that Grooper is initialized, we have a file store location, and we have an available SQL environment (either a full install of SQL Server or SQL Express) we can create a new Grooper Repository. Connecting to a Grooper Repository is the first thing you will do in Grooper Config. If you're not connecting to an existing Grooper Repository set up on someone else's Grooper installation, you'll need to create one.
|
|||||
This will open up a new window to add Grooper Repository connections.
|
|||||
Remember, a Grooper Repository is two things:
The first part of creating a new Grooper Repository is establishing the database connection.
|
|||||
|
|||||
|
|||||
Remember, a Grooper Repository is two things:
Initializing the Grooper Repository connects the repository to the file store location and establishes the folder structure Grooper uses to store files.
|
|||||
|
|||||
This will return you to the main Grooper Config window.
|
|||||
After licensing your Grooper installation, you will be able to access the Grooper Repository in Grooper Design Studio. The Grooper Repository forms the root node of the Node Tree when the repository is selected in Grooper Design Studio. |
Connecting to an Existing Grooper Repository
Add the Repository Connection
Connecting to an existing Grooper Repository is very similar to creating a new one. If anything it's the exact same process, just with less steps. For this tutorial, we have a second machine that will connect to the Grooper Repository created in the Creating a New Grooper Repository tutorial. This machine has Grooper installed, but does not have a local SQL environment. However, it doesn't need one. As long as it has networked access to the SQL server where the Grooper Repository's database is created, as well as networked access to the Grooper Repository's file store location, it can connect to the Grooper Repository. The first steps of connecting to an existing Grooper Repository is the same as creating a new one.
|
|
This will open up a new window to add Grooper Repository connections.
|
Configure the Connection
|
|||
|
|||
|
|||
This will return you to the main Grooper Config window.
|
|||
After licensing your Grooper installation, you will have full access to the Grooper Repository in Grooper Design Studio. The Grooper Repository forms the root node of the Node Tree when the repository is selected in Grooper Design Studio. Any machine connecting to this Grooper Repository will have access to the objects in the repository. Each machine can create new and configure existing objects. Essentially, you have now networked access to the Grooper environment. |
License Activation
The last step in the process is licensing your Grooper installation. Grooper can be licensed as "stand-alone" installations, where a single license is activated and registered to a local machine. Or, you can use a licensed installation as a server to hand out licenses to client machines. In this case, the licensed machine will run a Grooper service, called Grooper Licensing. The client Grooper installations will then call to the service to receive their licensing. This way, a single product license can be used to register multiple Grooper installations.
Regardless, at some point you will need to activate a license on a single machine, whether that machine is a stand-alone install or hosting the Grooper Licensing service. We will start with licensing Grooper to an individual machine.
Licensing Grooper to an Individual Machine
Obtain a Grooper License
First, you will need to obtain a Grooper license in order to register and activate your installation. You may receive your license in one of two ways.
- As a license key.
- This is by far the most common method. You will receive a serial number key you can use to activate the product online (something like "a1bc2de3-12a3-a123-a1b2345c6de7")
- As a license package.
- This is much less common. A license package is a ".lic" file you can use to activate the product. This is typically used for "locked down" environments where activating online is not an option.
⚠ | If you are planning on installing a Grooper Licensing service to hand out licenses to other workstations, the machine activating the license must be the one to install the service. If you try to install the Grooper Licensing service on a product that has not activated a license as described in the next steps, it will fail to distribute licensing to other machines. |
Open Grooper Config
License activation and management is performed in the Grooper Config application. Open Grooper Config and you will immediately see two things relating to licensing.
|
Activate the License: Online Activation
This is the most common license activation method, activating online with a serial number key.
|
|
|
Offline License Activation
Offline activation allows you to license your machine using a .lic licensing file. This is a less common activation method. This is more appropriate for scenarios where your machine cannot access the internet due to security restrictions.
|
|
|
|
|
|
|
Verify Your License
After activating your license, you will see the License property change from being blank to Licensed to... followed by your company's name (or who the license is registered to). |
|
You can also view more specific information about your license from Grooper Config.
You can expand the Licenses property to view even more specific information about your license. |
|
|
Installing a Grooper Licensing Service
Open Grooper Config
Grooper Services are various executable applications that run as a Windows Service to aid Grooper. The Grooper Licensing service will allow one licensed machine to hand out licensing information to other workstations. To do this, the machine installing the service must have an installed version of Grooper that has been activated with a product key or licensing package. Refer to the previous Licensing Grooper to an Individual Machine tutorial for more information on how to activate your license. Services are installed and configured in the Grooper Config application.
|
Add a New Service
|
|||
This will bring up a Service Manager window to install, configure and otherwise manage Grooper services.
|
|||
|
|||
|
Start the Service
|
|
We need to start the service in order for this machine to start hosting license distribution.
|
|
Now, this machine can use this Grooper Licensing service to hand out licensing information to workstations. We will discuss how to configure workstations to do this in the next tutorial. |
Licensing Grooper from an Active Grooper Licensing Service
Imagine you have a second workstation from the machine you've already licensed. Opening Grooper Design Studio for the first time on the second workstation, you will see this error message. It's letting you know the product is not yet licensed. No big deal. That's what the Grooper Licensing service is for! The first machine already running a licensed version of Grooper can create a Grooper Licensing service to hand out licenses to the second workstation (or multiple workstations).
|
Copy the Connection URL
The first thing you will need is the Connection URL from the Grooper Licensing service. From the machine running the Grooper Licensing service, open Grooper Config.
|
|
This will bring up the "Service Manager" window.
|
|
In this window, copy the Connection URL listed here. You can close out of this window and Grooper Config at this point. |
Open Grooper Design Studio on the Unlicensed Machine
Open Grooper Design Studio on the Unlicensed Machine. This machine will also either need to connect to existing Grooper Repository or have a new one created from Grooper Config at this point.
|
|
|
Point to the License Sever
|
|
That's it! This machine is licensed now, using the product license distributed by the Grooper License service. You can verify the product is licensed by navigating to the "Licensing" tab. You can also view specifics about the product license here, as well. |
Upgrading an Older Version of Grooper
Upgrading to 2021 is now easier than ever. You can upgrade directly from version 2.72, 2.80 or 2.90 to version 2021 (For upgrading from versions older than 2.72, you must upgrade to 2.72 before upgrading to 2021).
The upgrade process is essentially three steps:
- Uninstall the older version of Grooper.
- Install Grooper 2021.
- Upgrade Grooper Repositories from the older version to 2021.
Depending on your Grooper install, your upgrade process may be slightly more involved. If you are running scripts in your environment to customize Grooper's functionality, you may need to update the associated Object Libraries code. However, these three basic steps will apply to all upgrades.
How To
Perform a Simple Upgrade
⚠ | 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. |
FYI | If you are upgrading from version 2.72, 2.80 or 2.90 to 2021, you may upgrade directly to version 2021. However, if you are upgrading from version 2.70 (or older) to 2021, you must first upgrade to version 2.72, and then upgrade to version 2021. |
Starting Point
In this tutorial, we will upgrade a version 2.80 Grooper installation to version 2021.
Currently, Grooper version 2.80 is installed on this machine. As seen here, in Grooper Config, we have two Grooper Repository connections: one named "Grooper" and the other "Grooper280".
|
⚠ | 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. |
Validate Your 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.
For example, a Data Type extractor object whose Collation property is set to Key-Value Pair must have a Layout specification as part of its configuration. If this is left unconfigured, validation will catch the configuration error.
|
|
To validate your Grooper Repository and catch configuration errors like the one described above perform the following steps:
|
|
|
Step 0: Back up your Database and File Store
⚠ | 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. |
Step 1: 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 the Windows Control Panel.
|
Step 2: Install the New Grooper 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 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: |
Step 3: 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 2021), all Grooper Repositories configured on an older version must be upgraded in order to connect to them in Grooper Design Studio or Grooper Dashboard. 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. |
Upon upgrading from a version older than 2021 to version 2021, the first thing you'll probably notice is the Grooper Config application's UI has changed. Previously, Grooper Repository connections were listed in a grid upon opening the Grooper Config application. Now, Grooper Repository connections are accessed using the Repositories property. We will need to get into the Repositories configuration window to upgrade the older versioned Grooper Repository to the newly installed version.
|
|||
Notice two things about our Grooper Repositories here:
|
|||
|
|||
|
|||
|
|||
Congratulations! You've upgraded Grooper.
|