Grooper FAQ

From Grooper Wiki

What is Grooper?

Grooper is a powerful document processing software designed to handle various document-related tasks. It is structured around five main phases: Acquire, Condition, Organize, Collect, and Deliver. These phases guide the process of bringing documents into Grooper, preparing them for processing, classifying them, extracting information, and finally exporting the processed documents and data.

Technically, Grooper functions as a repository of information, consisting of tables in a SQL Server database and associated files in a Windows file share. This setup allows Grooper to efficiently manage and process documents by leveraging its infrastructure.

How do I install Grooper?

To install Grooper, follow these steps:

  1. Download the Installer: Obtain the Grooper installer from the Grooper xChange website. You will have options for the "Grooper Installer" (64bit), and the "Grooper Web Client Installer". These are required for any Grooper installation. You will also have the option for the "Grooper Desktop Installer". This is only required for setting up scanning desktop installations.
  2. Install Prerequisite Applications
    • Windows IIS: This is required when installing the "Grooper Web Client".
    • Microsoft SQL Server (2016 or greater): This is required to configure Grooper repositories.
  3. Extract the Installer Files: The installer files will be downloaded as zipped folders. Extract these files to a location on your computer.
  4. Run the Installer:
    • Open the extracted folder and double-click setup.exe to start the "Grooper Installer".
    • If this is your first time installing Grooper, you may need to install prerequisites like Microsoft Visual C++, Access Database Engine, and the Microsoft .NET Framework.
  5. Follow the Installation Wizard:
    • Click "Install" to begin installing the prerequisite applications.
    • After prerequisites are installed, you may need to restart your server.
    • Once restarted, run setup.exe again to continue with the Grooper installation.
    • Follow the prompts in the InstallShield Wizard, accepting the license agreement and selecting the installation location.
    • Choose the setup type (Complete setup is generally recommended) and click "Next".
    • Click "Install" to begin the installation process.
  6. Complete the Installation: Once the installation is complete, click "Finish" to finalize the process.

For additional components like the "Grooper Web Client" or "Grooper Desktop", follow similar steps with their respective installers.

What are the system requirements for Grooper?

The system requirements for Grooper vary depending on the component and the environment in which it is deployed. Here are the general requirements:

  • Grooper Web Server:
    • Operating System: Windows Server 2016 or later.
    • RAM: 16GB or more.
    • CPU: 4 or more cores.
    • Licensing Port: 13900 by default.
    • Internet Information Services (IIS) must be installed and configured.
  • Grooper SQL Server:
    • Operating System: Windows Server 2016 or later.
    • SQL Server: SQL Server 2016 or later.
    • Database Size: Should allow for a size of 20GB or more.
    • SQL Port: 1433.
  • Grooper Filestore Share:
    • Operating System: Windows Server 2016 or later.
    • File Size: Ideally accommodates roughly 150GB for small to medium installs.
    • Authentication: Requires CIFS or SMB.
  • Grooper Processing Server:
    • Given Grooper's scalability, "processing" can be handled by multiple compute environments.
    • Operating System: Windows Server 2016 or later.
    • RAM: 16GB or more.
    • CPU: 4 or more cores (higher volume scenarios may require more cores).
    • Licensing Port: 13900 by default.
  • Client Computer:
    • Browsers: Google Chrome, Microsoft Edge, or Apple Safari are required. Other browsers may work but are not supported.
    • User Authentication: Uses Windows Account (Domain or Local) on "Grooper Web Server".
    • Windows OS is required when using the "Grooper Desktop" application required for scanner interface.

These requirements ensure that Grooper operates efficiently and can handle the processing tasks as expected.

How do I navigate the Grooper interface?

To navigate the Grooper interface, you can use the "Grooper Web Client".

  • Context Toolbar
    • The "Context Toolbar" at the top provides navigation to different Grooper pages, including "Design", "Batches", "Tasks", "Imports", "Jobs", "Stats", "Search", and "Chat".
  • Home Page:
    • The Navigation Links panel on the left provides quick access to the "Design", "Batches", "Tasks", and other pages.
    • This page also gives information related to the currently selected Grooper repository.
  • Design Page:
    • Access the "Design" page by clicking the hammer and wrench icon in the "Context Toolbar" or on the home screen in the "Navigation Links" panel.
    • The "Node Tree" on the left side of the screen allows you to navigate through different elements in your repository.
    • The panels to the right of the "Node Tree" display information and configuration options for the selected node.
  • UI Panels
    • There are several types of panels from which users can interact with Grooper:
      1. Batch Viewer: Use mouse operations like single-click to select a node, double-click to expand or collapse a node, and drag-and-drop to move nodes.
      2. Document Viewer: Used to display a rendered version of the currently selected document from the Batch Viewer
  • Switching Repositories:
    • Use the "Repository" button on the upper-right corner of the "Context Toolbar" to switch between different Grooper Repositories.
  • Performing Review Tasks: You can start processing review tasks using the "Batches" or "Tasks" pages. These pages display available work in Grooper.

These interfaces are designed to help you efficiently manage and process documents within Grooper.

What are the main features of Grooper?

Grooper offers a range of powerful features designed to handle document processing efficiently. Here are some of the main features:

  • Document Processing Phases: Grooper is structured around five main phases for document processing: Acquire, Condition, Organize, Collect, and Deliver. These phases guide the process from bringing documents into Grooper to exporting the processed documents and data.
  • OCR Capabilities: Grooper includes several OCR engines such as Transym, Tesseract, and Azure OCR, which provide options for machine print and handwriting recognition. These engines are integrated to offer accurate text recognition from scanned documents.
  • Image Processing: Grooper provides extensive image processing capabilities, including contrast adjustment, Barcode Detection, Line Removal, and Shape Detection, among others. These tools help in preparing images for better data extraction.
  • Data Extraction and Classification: Grooper can classify documents and extract data using its robust data extraction tools. This includes the ability to recognize and categorize documents, as well as extract relevant information from them.
  • Integration and Scalability: Grooper supports integration with services like Azure AI Search for Grooper's AI Search extending enhanced search capabilities and can be deployed in scalable environments using platforms like Amazon Web Services (AWS).

These features make Grooper a comprehensive solution for document processing needs, offering flexibility and scalability to meet various business requirements.

How do I create a new project in Grooper?

To create a new Project in Grooper, follow these steps:

  1. Access the Projects Folder:
    • In the "Node Tree", right-click on the "Projects" folder.
  2. Add a New Project:
    • From the menu that appears, hover over "Add" and then select "Project...".
  3. Name the Project:
    • A window will pop up asking you to enter a name for your new project. Enter the desired name.
  4. Execute the Creation:
    • Click "EXECUTE" in the top right corner of the pop-up window to create the Project.
  5. Project Creation Confirmation:
    • Once executed, you should see the new Project in your Node Tree.

This process will add a new Project to the Projects folder in Grooper, allowing you to organize and manage your document processing tasks efficiently.

What is a Batch in Grooper?

In Grooper, a Batch is a fundamental container for documents that are processed through the system. It serves two primary purposes:

  • Container of Documents: A Batch holds documents in various states of processing. These documents are organized into Batch Folders and Batch Pages.
  • Processing Instructions: A Batch is associated with a Batch Process, which is a step-by-step list of instructions on how to handle the documents. This process includes automated tasks known as "Code Activities" and tasks requiring user intervention called Review.

How do I import documents into Grooper?

To import documents into Grooper, you can follow these steps:

  1. Navigate to the Imports Page:
    • Click on the "Imports" icon in the "Context Toolbar" at the top of the Grooper screen.
  2. Start a New Import Job:
    • Click the "+" icon located on the far right of the "Context Toolbar" to initiate a new import job.
  3. Submit Import Job:
    • In the "Submit Import Job" window, enter a short description for the "Import Job" in the Description property.
    • Click on the hamburger icon next to the Provider property and select the desired "Import Provider" from the drop-down menu.
  4. Configure the Import Provider:
    • Complete the necessary configuration to connect Grooper to the import source
  5. Batch Creation:
    • Scroll down and open the Batch Creation property.
    • Be sure to configure the Starting Step property and select the step from your Batch Process where you want Grooper to start processing the imported documents.
    • Configure remaining batch creation properties as needed.
  6. Start the Import Process:
    • Uncheck the Start Paused property if you want Grooper to begin processing immediately after importing the Batch.
    • Click "SUBMIT" to import the Batch and start the Batch Process.

These steps will help you import documents into Grooper, allowing them to be processed according to your configured Batch Process.

What are the 5 phases of Grooper?

The Five Phases of Grooper are designed to streamline the document processing workflow. They are:

  1. Acquire: This phase involves bringing documents into Grooper from various sources. It includes capturing documents through scanning, importing electronic files, or connecting to external systems to ingest documents.
  2. Condition: In this phase, documents are prepared for processing. This includes tasks like Recognize and Image Processing to ensure that the documents are in the best possible state for data extraction.
  3. Organize: During the organize phase, documents are classified and sorted. Grooper uses its classification tools to recognize document types and organize them accordingly.
  4. Collect: This phase focuses on data extraction. Grooper extracts relevant information from the documents using its data extraction capabilities, which can include OCR and other data recognition technologies.
  5. Deliver: The final phase involves exporting the processed documents and extracted data to the desired destination. This could be a database, a content management system, or any other system where the data is needed.

These phases ensure a comprehensive and efficient document processing workflow within Grooper.

How do I classify documents in Grooper?

To classify documents in Grooper, you can use the following methods:

  1. Automated Classification:
    • Create a Content Model with the appropriate Document Types.
    • Set up a Batch Process and include a "Classify" step. This step will automatically classify documents in a Batch as Document Types in the model.
    • Grooper offers several classification methods, including Lexical, Rules-Based, Visual, and Labelset-Based. Each method uses different criteria to classify documents, such as text content, visual appearance, or label sets.
  2. Manual Classification:
    • Select the desired Batch.
    • Go to the Viewer tab and right-click the document you want to classify.
    • Use the "Assign Document Type" command to manually assign a Document Type.

These methods allow you to effectively organize and process documents by assigning them the correct Document Types, which is crucial for subsequent data extraction and processing tasks.

What is OCR and how does Grooper use it?

OCR, or Optical Character Recognition, is a technology used to convert different types of image-based documents, such as scanned paper documents, TIFs, or images captured by a digital camera, into machine-readable text. Grooper uses OCR to pull text from these documents, enabling further data processing and analysis. OCR is not necessary when documents contain native electronic text.

How Grooper Uses OCR:

  1. OCR Engines: Grooper integrates several OCR engines, including Transym, Tesseract, and Azure OCR. These engines provide options for recognizing machine-printed text and handwriting.
  2. Image Processing: Before applying OCR, Grooper can enhance images to improve OCR accuracy. This includes adjusting contrast, removing noise, and other preprocessing techniques.
  3. Data Extraction: Once OCR is applied, Grooper can extract structured data from the recognized text. This data can then be used for various purposes, such as populating databases or generating reports.
  4. Integration with Other Phases: OCR is typically part of the "Condition" phase in Grooper's document processing workflow, where it plays a crucial role in extracting data from documents.

By using OCR, Grooper enhances its ability to process and analyze documents, making it a powerful tool for handling large volumes of data efficiently.

How do I extract data from documents in Grooper?

To extract data from documents in Grooper, you will follow these steps:

  1. Create a Data Model:
    • Right-click on the Content Model in the Node Tree and select "Create Data Model". This Data Model will act as a container for all objects that extract data from documents.
  2. Add Data Fields:
    • Right-click on the Data Model and select "Add" > "Data Field". Name the Data Field based on the data you want to extract, such as "Company Name".
  3. Configure Value Extractors:
    • For each Data Field, set up a Value Extractor. For example, use a "List Match" extractor to collect specific data like a company name. Configure the extractor by selecting the appropriate method and entering the necessary patterns or criteria.
  4. Add an Extract Step to the Batch Process:
    • Right-click on the Batch Process, hover over "Add Activity", then hover over "Document Processing", and select "Extract...". This adds an Extract step to your Batch Process.
  5. Perform the Extraction:
    • Use the Activity Tester tab to run the Extract Activity on your Batch. Extract will also be performed as part of an automated Batch Process.
  6. Review Extracted Data:
    • Use the Activity Tester tab of the Review Activity with a Data View on your Batch. Review is performed as a human attended task in the flow of a Batch Process.

These steps will help you configure Grooper to extract data from documents efficiently, using the tools and methods provided by the platform.

How do I export documents from Grooper?

To export documents from Grooper, you need to configure an Export Behavior and use the Export activity within a Batch Process. Here are the steps to do so:

  1. Add an Export Behavior:
    • Select your Content Model from the Node Tree.
    • Click on the ellipsis icon next to the Behaviors property.
    • In the "Behaviors" window, click the "+" icon and select "Export Behavior" from the dropdown menu.
  2. Configure Export Definitions:
    • Click on the ellipsis icon next to the Export Definitions property.
    • In the "Export Definitions" window, click the "+" icon and select an export definition (for example "File Export") from the dropdown menu.
  3. Configure the Export Definition:
    • The configuration of the Export Definition varies depending on the chosen definition. Commonly export location and file format are included in the export definition setup.
  4. Add the Export Step to the Batch Process:
    • Right-click on the Batch Process, hover over "Add Activity", then "Document Processing", and select "Export".
    • Configure the Export activity with the desired settings.
  5. Execute the Export:
    • Once configured, execute the Export activity to export the documents to the specified location.

These steps will guide you through exporting documents from Grooper, allowing you to deliver processed content to an external system or storage location.

What is the Grooper Web Client?

The Grooper Web Client allows users to connect to a Grooper user interface over the internet via a web server. This enables end-users to interact with Grooper using a web browser, without needing to install Grooper on their own machines. The Grooper Web Client is designed to make the review and design experience more modern, secure, and easily distributable. It allows users to process documents using an internet connection alone, accessing the Grooper Repository through a web-based interface.

How do I scan documents into Grooper?

To scan documents into Grooper, you will need to use the Grooper Desktop application along with the Scan Viewer of a Review step. Here's a step-by-step guide:

  1. Install Grooper Desktop: This application must be installed on any desktop computer connected to scanner hardware. It runs as a service in the background and must be active to scan documents.
  2. Set Up the Scan Viewer: Add a Review step to a Batch Process. Once added, add and configure a Scan view on the step.
  3. Create a New Batch: In Grooper, navigate to the "Batches" page and create a new Batch. Select the appropriate Batch Process that includes a Review step with a Scan view.
  4. Configure Scanner Settings: Ensure your scanner is connected and listed as "Ready" in the Scan Viewer. You will need to select and configure a scan device. This can be done with the "Scanner Settings" and "Hardware Settings" buttons. You may also select a Scanner Profile, which stores different scanner settings such as duplex or simplex scanning.
  5. Start Scanning: Place your documents in the scanner and click the "Scan" button in the Scan Viewer. The scanned pages will be loaded into the batch.
  6. Review and Complete: After scanning, review the pages in the batch. You can adjust images if necessary and complete the task to move the batch to the next step in the process.

What are IP Profiles in Grooper?

In Grooper, an IP Profile is a collection of image processing commands applied to clean up a page's image to prepare it for further processing. These profiles are used to address common image issues such as skew, borders, and noise, which can interfere with OCR (Optical Character Recognition) and other data extraction processes. IP Profiles can be applied permanently during the Image Processing activity or temporarily during the Recognize activity to improve OCR results without altering the original document image.

How do I apply image processing in Grooper?

To apply image processing in Grooper, you need to use an IP Profile, which is a collection of image processing commands designed to clean up a page's image for further processing. Here's a general guide on how to apply image processing:

  1. Create or Select an IP Profile: An IP Profile contains a series of IP Commands, each performing a specific image processing operation. You can create a new IP Profile or select an existing one that suits your needs.
  2. Add Image Processing Step to Batch Process: In your Batch Process, add an "Image Processing" step. This is done by right-clicking on the Batch Process, selecting "Add Activity" > "Cleanup & Recognition" > "Image Processing".
  3. Configure the Image Processing Step: Set the scope of the Image Processing step to "Page" since image processing permanently edits an image and must do so at the page level. Configure the properties of the activity by selecting the appropriate IP Profile.
  4. Execute the Image Processing: Once configured, execute the Image Processing step. This will apply the selected IP Profile to the images in your Batch, cleaning them up according to the commands in the profile. Note that image processing can take some time, and changes may not be immediately visible.
  5. Review Changes: After applying the IP Profile, you may use a Review step with a Thumbnail Viewer to view the pages.

How do I use the Grooper Help feature?

To use the "Grooper Help" feature, you can access it directly from the Grooper interface. Here's how you can do it:

  1. Locate the Help Button: In the Grooper interface, you will find a "Help" button in the top-right corner of the Context Toolbar. This button is represented by a question mark icon.
  2. Open Grooper Help: Clicking the "Help" button will open a new tab in your web browser directed to the "Grooper Help" page. The specific destination within the "Grooper Help" page will depend on what object you have selected in the Node Tree at the time.

What is the difference between Code Activities and Review Tasks in Grooper?

In Grooper, the primary difference between "Code Activities" and "Review Tasks" lies in their automation and the need for human interaction:

  1. Code Activities: These are automated tasks performed by the Activity Processing service. They do not require human interaction and are executed automatically as part of a Batch Process. Examples of "Code Activities" include tasks like Classify, Recognize, Extract, and Export.
  2. Review Tasks: Formerly known as "Attended Activities", these require human intervention. They are steps in a Batch Process where a user reviews Grooper's automated results, such as verifying document classification or data extraction. "Review Tasks" are assigned via Review Queues and are performed by human operators.

How do I perform data review in Grooper?

To perform data review in Grooper, follow these steps:

  1. Select a Batch: Start by selecting a Batch from the list on the Batches page that is ready for review. The "Progress" tab will show the current progress of the selected batch.
  2. Open the Data Viewer: Double-click the batch to open the Data Viewer module. This module is designed to provide information about the data collected for each document.
  3. Navigate Through Documents: Use the Folder Navigator at the top of the Data Viewer to move through the documents in the Batch. You can use arrow buttons or type the document number to select a specific document.
  4. Review Extracted Data: Verify that the data Grooper extracted from each document is correct. If the extracted data does not match the document, you can edit the result using the text box editor.
  5. Resolve Data Errors: Grooper will highlight any fields in an error state in red. For example, Grooper will highlight any "required" fields that are empty. Enter the missing values manually to resolve these errors.
  6. Complete the Review: Once you have reviewed all the documents and resolved any errors, press the "Complete Task" button to finish the review.

How do I set up user accounts in Grooper?

To set up user accounts, known as Permission Sets in Grooper, follow these steps:

  1. Access the Permission Sets: Navigate to the root node of the Grooper Repository in Grooper Design Studio. Select the "Permission Sets" property and click the ellipsis button at the end.
  2. Add a Permission Set: In the "Permission Sets" window, click the add button represented by a "+" icon.
  3. Configure the Permission Set:
    1. Supply a name to the Name property.
    2. Configure "Applies To" property:
      1. Select the Applies To property and click the ellipsis button.
      2. In the "Applies To" window click the "toggle" button represented by two overlapping busts of people to switch between Active Directory Groups or Users.
      3. Use the search box to filter for a specific item.
      4. Double click an item to add it to the entries list on the left side of the "Applies To" window.
      5. Click the "OK" button to close the "Applies To" window.
    3. Configure the "Page Access" property:
      1. Click the drop-down arrow to the left of the Page Access property to expose toggle properties representing each page Grooper.
      2. Check all pages the user should have access to.

With these "Permission Set" settings you can control how Active Directory Groups or Users can access Grooper pages.

What are the different types of extractors in Grooper?

In Grooper, there are several types of extractors, each designed for specific data extraction tasks. These include:

  1. Text Parsing Extractors: These primarily rely on regular expressions, lists of values, or other forms of text parsing to return values. Examples include:
    • Pattern Match
    • List Match
    • Label Match
    • Word Match
    • Labeled Value
    • Field Match.
  2. OMR Extractors: These use optical mark recognition to extract values from documents that use checkboxes. Examples include:
    • Labeled OMR
    • Ordered OMR
    • Zonal OMR.
  3. Barcode Extractors: These extract values stored in barcodes. Examples include:
    • Find Barcode
    • Read Barcode.
  4. Zonal Extractors: These extract text by drawing a logical rectangle on a document, useful for structured documents where field values are consistently located in the same position. Examples include:
    • Read Zone
    • Highlight Zone.
  5. Reference Extractor: This allows you to return the results of another data extractor object, such as a Value Reader, Data Type, or Field Class.

How do I use the Grooper University courses?

To use the Grooper University courses, you can access them through the "Learn" icon in the Grooper interface. This icon will take you to the home page of Grooper University courses at learn.grooper.com. These courses are an external resource for Grooper designers who have an active training subscription.

What are the different pages of the Grooper for?

Grooper consists of several pages, each serving a specific purpose:

  1. Design Page: This page is used to access and edit the repository. Designers can add, delete, or change any part of the repository. It is where Grooper is configured for processing documents.
  2. Batches Page: This page provides access to a list of all current Batches in production. Users can see and select Batches in process, filter them by various criteria, and process user-attended review activities.
  3. Tasks Page: This page lists review tasks ready for users. It allows end-users to select and start review-based work via the Web Client. Users can filter review tasks by Batch, Batch Process, Batch Process Step, or Review Queue.
  4. Imports Page: This page shows a list of recent import jobs, providing details about the import job, provider, priority levels, and submission date. Users can also submit on-demand import jobs.
  5. Jobs Page: This page displays a list of recent processing jobs submitted by Batch Processes, showing what jobs have been submitted, worked on, and completed, along with detailed information such as job ID and batch process.
  6. Stats Page: This page provides access to various statistics on Grooper's workflow, allowing users to perform queries and retrieve statistical information.
  7. Search Page: This page provides a user interface to search the document index created by Azure AI Search.
  8. Chat Page: This page provides a user interface to continue existing document chat sessions powered by Grooper AI Analysts.

How do I create a Batch Process in Grooper?

To create a Batch Process in Grooper, follow these steps:

  1. Add a Batch Process:
    • Right-click on your Project on the Design page of Grooper.
    • Hover over "Add" and then click on "Batch Process...".
  2. Name the Batch Process:
    • When the "Add" window pops up, type in a name for your Batch Process.
    • Click "EXECUTE" in the top right-hand corner of the pop-up window.
  3. Add Batch Process Steps:
    • Right-click on your Batch Process object.
    • Hover over "Add Activity" and select the type of activity you want to add, such as Split Pages.
  4. Configure Each Step:
    • For each Batch Process Step, configure the properties as needed. This might include setting the scope, folder level, and any specific settings related to the activity.
  5. Test the Configuration:
    • Use the "Activity Tester" tab to test the configuration of each step to ensure it performs as expected.
  6. Publish the Batch Process:
    • Once all steps are configured and tested, publish the Batch Process to make it available for production use.

How do I use Grooper Design Studio?

Grooper Design studio is a deprecated application represented by the Design page of Grooper. In the Design page you will primarily be working with the following components:

  1. Node Tree: This is where you navigate through different elements in your Grooper Repository. It is located on the left side of the screen and allows you to select and manage various Grooper objects.
  2. Configuration Panels: To the right of the Node Tree, you will find panels that provide information and configuration options for the selected node. These panels vary depending on the type of object you have selected.
  3. Root Node: The top node in the Node Tree, where you can find information about your repository, including licensing information.
  4. Tabs: For each node selected in the Node Tree, there are multiple tabs at the top of the configuration panels that provide different information and options.
  5. In-App Help: At the bottom of each property grid within the configuration panel, there is a panel that displays definitions, tips, and explanations for the selected object or property.

The Design page of Grooper is used for creating and configuring objects that control how documents are processed, such as Batch Processes, Content Models, and Data Types.

What is a Control Sheet in Grooper?

A Control Sheet in Grooper is a special page used to control various aspects of the document scanning process. These sheets can be used to separate and classify documents or to dynamically change image processing settings or color format settings during the scan process. Control Sheets are printed and placed at the beginning of a new batch or document in a stack of loose pages before they are scanned into Grooper.

Control Sheets can perform several actions, such as:

How do I use the Grooper Task Page?

To use the Grooper Task page, follow these steps:

  1. Access the Tasks Page: Click the "Tasks" icon on the Grooper homepage. This will bring up the Tasks interface, which presents a list of batches with review steps ready for processing.
  2. Filter Tasks: You can filter the list of batches by clicking the "Filter" icon. This allows you to filter tasks based on criteria such as Review Queue, Batch Process, Batch Process Step, or Batch name. Select the specific value you want to filter by and click "Save" to execute the filter.
  3. Start Reviewing Tasks: You have two options to start reviewing:
    • Double-click a single Batch from the list to start reviewing it.
    • Click the "Play" icon to start reviewing all Batches in the list that match your filter. This will automatically open the next review task in the list once one is completed.
  4. Perform Review Activities: The Tasks page allows you to perform various review activities, such as classification review, data review, or image processing review. The review activity module will open for the selected batch.

How do I configure a scanner for use with Grooper?

To configure a scanner for use with Grooper, follow these steps:

  1. Install Grooper Desktop: Ensure that Grooper Desktop is installed on your workstation. This application runs as a service and integrates your scanner with the Grooper platform.
  2. Ensure Grooper Desktop is Running: Check the Windows system tray to verify that Grooper Desktop is running.
  3. Create a New Batch: From the Batches page, add a new Batch. For this Batch, select a Batch Process whose first step is Review with a Scan viewer.
  4. Select Capture Device: In the Scan View, press the Scanner Settings button. Use the Device property to select the type of scanner you are using. Grooper supports ISIS and TWAIN scanners, as well as ColorTrac large format scanners.
  5. Adjust Device Settings: If needed, configure additional settings such as color mode, resolution, and duplex scanning using the "Device Settings" button. This step is optional but recommended for optimal scanning performance.
  6. Use the Scan Viewer: With Grooper Desktop running, you can use the Scan Viewer to scan documents into a batch. Ensure your scanner is ready and listed in the Scan Viewer before starting the scan.

How do I create custom extractors in Grooper?

To create custom extractors in Grooper, you can follow these general steps:

  1. Access the Content Model: Navigate to the Content Model where you want to create the custom extractor.
  2. Add a Data Type: Within the Local Resources folder of a Content Model, add a new Data Type. This will serve as the container for your custom extractor.
  3. Choose Value Extractor: You can create various types of extractors depending on your needs:
    • Pattern Match: Use regular expressions to match specific text patterns.
    • OMR Extractors: For optical mark recognition, useful for extracting values from checkboxes.
    • Barcode Extractors: To extract values stored in barcodes.
    • Zonal Extractors: Define a specific area on the document to extract text from.
    • Referenced Extractors: Data Types can reference multiple other extractors. The results of these referenced extractors are "funneled" into one Data Type.
  4. Configure the Extractor: Set up the extractor by defining its properties, such as the pattern to match or the zone to extract from. This configuration can be done directly on the Data Type or by creating child objects like Value Readers.
  5. Child Extractors: Data Types can have many extractor objects as child objects. The results returned by these child extractors are inherited into the parent Data Type.
  6. Collate the Extractor: Optionally, a different Collation option can be chosen to format the returned results.
  7. Test the Extractor: Use sample documents to test the extractor and ensure it is capturing the desired data accurately by using the Tester tab.
  8. Deploy the Extractor: Once tested, the custom extractor can be used to extract data from documents as needed.

How do I use regular expressions in Grooper?

To use regular expressions in Grooper, you can utilize the Pattern Match extractor, which relies on regex pattern matching to extract values. Here's how you can work with regular expressions in Grooper:

  1. Pattern Match Extractor: This extractor uses regular expressions to find and return values from text data. You can enter a regex pattern in the "Value Pattern" field, which will be applied to the document's text data.
  2. Prefix and Suffix Patterns: You can specify additional regex patterns as "Prefix" and "Suffix" patterns to ensure that the extracted value is anchored by specific text before or after it.
  3. Output Format: The "Output Format" option allows you to alter the extracted result for data cleansing or other purposes.
  4. Fuzzy Matching: Grooper supports FuzzyRegEx, which allows for "near matches" by measuring the similarity between the regex pattern and the text. This is useful for handling OCR errors where the text might not exactly match the pattern.
  5. Named Groups: You can use named groups in your regex to assign names to specific parts of the matched text. This is useful for extracting structured data, such as dates or addresses, where each part of the data can be named and accessed separately.

How do I set up a CMIS Lookup in Grooper?

To set up a CMIS Lookup in Grooper, follow these steps:

  1. Create a CMIS Connection:
    • Right-click on a project or folder in your Grooper environment.
    • Select "Add" and then "CMIS Connection..." to create a new CMIS Connection object.
  2. Configure the CMIS Connection:
    • Select the CMIS Connection object in the Node Tree.
    • Click on the Connection Settings property and configure it according to the storage platform you are connecting to (e.g., NTFS, SharePoint, Box, etc.).
  3. Import the Repository:
    • Once the connection settings are configured, click the "List Repositories" button to list available repositories.
    • Select the repository you wish to import and click "Import Repository" to create a CMIS Repository object.
  4. Configure the CMIS Lookup:
    • In the Data Model where you want to perform the lookup, select the Lookups property and click the ellipsis button.
    • In the Lookup Specification Collection Editor, click "Add" and select "CMIS Lookup".
  5. Set Up the CMIS Query:
    • Select the CMIS Lookup object and configure the Repository property by selecting the CMIS Repository you imported.
    • Click the ellipsis button on the CMIS Query property to open the query editor.
    • Write your CMISQL query using the editor, leveraging Grooper's intellisense for assistance. The query should include SELECT and WHERE clauses to specify the data you want to retrieve.
  6. Complete the Setup:
    • Ensure that the lookup fields and target fields are correctly mapped based on your query.
    • Save your changes and test the lookup to ensure it retrieves the correct data.

How do I configure separation profiles in Grooper?

To configure Separation Profiles in Grooper, follow these steps:

  1. Add a Separation Profile:
    • Right-click on the Project or folder within the Project where you want to add the Separation Profile.
    • Hover over "Add" and click on "Separation Profile...".
    • Name your Separation Profile and click "EXECUTE" to create it.
  2. Set the Separation Provider:
    • Select the Separation Profile in the Node Tree.
    • Click on the hamburger icon next to the Provider property to access the drop-down menu.
    • Choose the Separation Provider you want to configure for this Separation Profile.
  3. Configure the Separation Provider:
    • Configure the selected Separation Provider as needed. Each provider has its own settings that determine how pages are separated into documents.
  4. (Option 1) Use the Separation Profile in a Batch Process:
    • Select the Separate step of a Batch Process.
    • You have the option to set a Provider or reference a Separation Profile. Click the hamburger icon next to the Separation Profile property, navigate through the folders, and select the Separation Profile.
  5. (Option 2) Apply the Separation Profile during Scanning:
    • You can also set a pre-configured Separation Profile to perform separation during the Review step of your Batch Process. Select the Review step of your Batch Process. Click the ellipsis button next to the "Views" property. Add or select a Scan view. In the Scan view settings select the desired Separation profile.

How do I manage Batch Folders in Grooper?

To manage Batch Folders in Grooper, you can perform various actions to organize and manipulate the structure of your Batches. Here are some key points on managing Batch Folders:

  1. Batch Structure: A Batch in Grooper is structured as a hierarchy of Batch Folders and Batch Pages. This structure allows you to organize documents within a Batch.
  2. Folder Levels: Batch Folders can be organized into different levels. The topmost Batch Folder is at the "Batch" scope, and subsequent folders are organized into levels (e.g., Level 1, Level 2, etc.). This hierarchy helps in managing documents and their processing.
  3. Creating and Organizing Folders: You can create subfolders within a Batch to organize documents. This is useful for grouping related documents together.
  4. Separation and Classification: During the separation process, Batch Pages are organized into Batch Folders. You can use Separation Profiles to automate this process. Classification can be applied to Batch Folders to assign a Document Type, which helps in identifying and processing documents.
  5. Manual Adjustments: You can manually adjust the structure of Batch Folders using the Folder Viewer. This allows you to fix any separation issues or reorganize documents as needed.

How do I use the Grooper Node Tree?

To use the Grooper Node Tree, follow these guidelines:

  1. Navigation: The Node Tree is located on the left side of the Grooper Design page. It allows you to navigate through different elements in your repository. Each item in the Node Tree is a "node," and nodes are organized hierarchically.
  2. Node Hierarchy: Nodes are organized in a branching structure, where each new node added under another creates a new branch. The hierarchy is determined by the parent node, which dictates what types of child nodes can be created.
  3. Node Operations: You can perform various operations on nodes, such as adding, deleting, or moving them. Right-click on a node to see available options like "Add," "Delete," or "Rename".
  4. Node Types: There are different types of nodes, such as Batches, Projects, Batch Processes, Queues, File Stores, and Machines. Each serves a specific purpose in organizing Grooper objects.
  5. Inheritance: Parent and child nodes pass information to and from each other through inheritance. The parent node's object type controls the types of child nodes that can be created and what information is shared.
  6. Root Node: The top level of the Node Tree is the Grooper Root, which contains all other nodes as its children. It also stores settings that apply to the connected Grooper Repository.

How do I apply OCR Profiles in Grooper?

To apply OCR profiles in Grooper, you need to follow these steps:

  1. Create an OCR Profile:
    • Navigate to a Project in the Node Tree.
    • Right-click on the Project, or a folder in the Project, hover over "Add," and click "OCR Profile."
    • Name your OCR Profile and click "EXECUTE" to create it.
  2. Configure the OCR Profile:
    • Select the OCR Profile in the Node Tree.
    • Choose an OCR engine by selecting the OCR Engine property and picking from the dropdown menu.
    • Configure additional properties as needed, such as temporary image processing settings using an IP Profile, synthesis settings, and result filtering.
  3. Execute the OCR Profile:
    • OCR results are obtained through the Recognize activity, which can be executed manually or as part of a Batch Process.
    • For manual execution, navigate to a page in a Batch, right-click, select "Run Activity" then "Cleanup & Recognition," and click "Recognize."
    • In the "Recognize" window that appears, configure properties as needed, and click "EXECUTE".
  4. Use in Batch Process:
    • For automated processing, add a Recognize step to your Batch Process.
    • Configure it to use the OCR Profile by selecting it from the OCR Profile property.

How do I use the Grooper Image Diagnostics panel?

To use the Grooper Image Diagnostics panel, follow these steps:

  1. Access the Diagnostics Panel: The Image Diagnostics panel is available when you are configuring an IP Profile. It provides diagnostic images for each IP Step, showing how the IP Command is altering the image.
  2. View Diagnostic Images: The panel contains images such as "Input Image" and "Output Image" for each step. These images help you see the before and after effects of the IP Command on the document.
  3. Use the Execution Log: The Diagnostics panel also includes an "Execution Log" that provides detailed information about the processing steps and any issues encountered.
  4. Adjust IP Command Properties: Use the diagnostics images to test and verify the results of manipulating individual properties of the IP Commands. This helps ensure that each step is processing the document as intended.
  5. Iterate and Test: You can make adjustments to the IP Command properties and use the Diagnostics panel to test these changes iteratively until you achieve the desired results.

How do I configure a Grooper Repository?

To configure a Grooper Repository, you need to follow these steps:

  1. Initialize Grooper Command Console (GCC):
    • Open Grooper Command Console as an administrator which will initialize the System Configuration if it's your first time using it.
  2. Establish the Database:
    • If a Grooper database has not been created, you will first need to do so.
    • Use the following GCC command to create the database: databases create <serverName> <databseName>
  3. Add a Repository Connection:
    • Add a Repository connection with the following GCC command: connections add <serverName> <databaseName>
  4. Initialize the Repository:
    • If the Repository has not been initialized, you will need to do so.
    • Use the following GCC command to initialize the Repository: connections init <connectionNo> <repositoryName> <storagePath>

How do I use the Grooper Event Log?

To use the Grooper Event Log, you can follow these steps:

  1. Access the Event Log: The Grooper Event Log can be accessed by selecting the Root node on the design page and then selecting the "Events" tab. This will display the event log, which records various types of events that occur within Grooper.
  2. View Recent Events: The Recent Events window in Grooper's interface displays information about different processing events. This includes audit trails of processing events such as Batch creation, task steps in a Batch Process submitted for processing, and Batch completion. It also includes warnings and error messages.
  3. Use the Event Log for Troubleshooting: The event log is useful for tracking down information or a sequence of events if you're troubleshooting a problem. It provides detailed information about errors and processing steps.
  4. Search and Filter Events: You can search and filter the events in the log to find specific entries. This can be done using the filter properties available in the event log interface.

How do I create and use IP Commands in Grooper?

To create and use IP Commands in Grooper, you need to follow these steps:

  1. Create an IP Profile:
    • Navigate to a Project, or a folder in a Project.
    • Right-click on the Project, or folder, hover over "Add," and select "IP Profile."
    • Name your IP Profile and click "OK" to create it.
  2. Add IP Steps:
    • IP Profiles are comprised of a series of IP Steps. Each IP Step uses an IP Command to perform a specific image processing function.
    • Right-click the IP Profile. Choose "Add Command" and pick an IP Command from one of the categories of commands. For example, you might choose "Negative Region Removal" from the "Feature Removal" category.
  3. Configure IP Command Properties:
    • Each IP Command has a set of configurable properties. Adjust these properties as needed to fit the demands of your document set.
    • Use the Diagnostics Panel to test and verify the results of manipulating individual properties.
  4. Test the IP Profile:
    • You can test the full IP Profile from either the IP Profile itself or on the IP Step.
    • Click on the "Tester" tab and make edits to the IP Step properties to test the IP Profile.
  5. Apply the IP Profile:
    • IP Profiles can be applied permanently during the Image Processing activity or temporarily during the Recognize activity.

By following these steps, you can effectively create and use IP Commands in Grooper to perform various image processing tasks.

How do I use the Grooper Context Toolbar?

The Grooper "Context Toolbar" is a navigation bar in the Grooper Web Client that provides various utilities. Here's how you can use it:

  1. Navigation: The "Context Toolbar" allows you to navigate between different pages in the Grooper Web Client. Depending on the page you are currently on, the menu may change slightly. However, clicking the Grooper logo will always take you back to the home screen.
  2. Accessing Different Pages: You can use the "Context Toolbar" to navigate to several key pages, including:
    • Design: Access and edit the repository.
    • Batches: View and manage batches currently in production.
    • Tasks: View tasks ready for review.
    • Imports: View recent import jobs.
    • Jobs: See submitted jobs and their stages.
    • Stats: Access various statistics on Grooper's workflow.
    • Search: Use the Grooper document search and retrieval interface.
    • Chat: Continue existing document chat sessions with an established AI Analyst.
  3. Switching Repositories: If you are working with multiple Grooper Repositories, you can switch between them using the Repository button on the Context Toolbar. This allows you to access documents and processing assets in different repositories.
  4. Page Specific Commands: Depending on which page of Grooper you are on, you will have access to different commands. For example, on the Design page, there are buttons for navigating back and forward between objects, as well as Download and Upload buttons for objects in the node tree.

How do I manage Grooper Projects?

To manage Grooper Projects, you can follow these steps:

  1. Add a New Project:
    • Right-click the "Projects" folder in the node tree.
    • Select "Add" and then "Project..." to create a new project.
    • Name your project and configure it as needed.
  2. Organize Resources:
    • Projects allow you to organize Grooper resources such as Batch Processes, Content Models, and other objects in a logical manner.
    • You can organize objects by use case, resource type, or for modular use.
  3. Manage Shared Resources:
    • If you have resources that are used by multiple projects, you can manage them through project references.
    • Use the "Usage" tab to analyze references and decide how to handle shared resources.
  4. Publish Projects:
    • You can publish projects to a connected repository, allowing you to copy projects and their contents from one Grooper Repository to another.
    • This is useful for environments with multiple repositories.

By following these steps, you can effectively manage projects within Grooper, ensuring that resources are organized and accessible as needed.

How do I use the Grooper Recent Events panel?

To use the Grooper Recent Events Panel, follow these steps:

  1. Access the Recent Events Panel: The Recent Events panel is part of Grooper's event log and can be accessed from the Grooper Web Client's homepage. It is one of the main sections displayed on the homepage.
  2. View Processing Events: The panel displays information about different processing events, including audit trails of processing events such as Batch creation, task steps in a Batch Process submitted for processing, and Batch completion. It also includes warnings and error messages.
  3. Troubleshoot Issues: Use the Recent Events panel to track down information or a sequence of events if you're troubleshooting a problem. It provides detailed information about errors and processing steps.
  4. Familiarity with Grooper Design page: If you're familiar with the Grooper Design page, the Recent Events panel on the Home page is essentially the same event log you see when selecting the root node of your Grooper Repository.

How do I perform document classification using machine learning in Grooper?

To perform Document Classification using machine learning in Grooper, you can use the Lexical Classification method, which relies on text-based features. Here's a step-by-step guide:

  1. Create a Content Model:
    • Add a Content Model to your project. This model will house the Document Types you want to classify.
  2. Add Document Types:
    • Within the Content Model, add Document Types for each kind of document you want to classify. This helps Grooper understand what types of documents it will encounter.
  3. Set Classification Method:
    • Choose the Lexical Classification method in the Content Model. This method uses text features to classify documents.
  4. Configure Text Feature Extractor:
    • Set up a Text Feature Extractor to identify features such as words or phrases that are indicative of each Document Type. This extractor will be used during training.
  5. Configure Batch Process:
    • Add a Batch Process to your Project and ensure it has a Batch Process Step set to Classify.
  6. Train the Model:
    • Use the Classification Tester tab of the Classify step to train the model. Right-click on a document, select "Classify," and then "Train As..." to associate the document with a specific Document Type.
  7. Test and Validate:
    • After training, test the classification using the Activity Tester tab to ensure documents are being classified correctly.
  8. Automate Classification:
    • Ensure an Activity Processing service is running and submit a Batch using the Batch Process with the configured Classify step.

By following these steps, you can effectively use machine learning for document classification in Grooper.

How do I use the Grooper Web Client for document review?

To use the Grooper Web Client for Document Review, follow these steps:

  1. Access the Web Client: Enter the URL provided by your Grooper administrator in a supported web browser (Microsoft Edge, Google Chrome, or Apple Safari). You may need to enter your user credentials unless your Windows credentials are automatically passed through.
  2. Navigate to the Batches or Tasks Page: Click the "Batches" or "Tasks" icon on the Grooper homepage. The "Batches" page lists all Batches in production. The "Tasks" page lists batches with review steps ready for processing.
  3. Select a Batch for Review: You can either double-click a single batch from the list to start reviewing it or use the "Play" icon in the "Tasks" page to start reviewing all batches in the list that match your filter. This will automatically open the next review task once one is completed.
  4. Perform Review Tasks: The Review activity module will open, allowing you to perform various review tasks such as classification review, data review, or image processing review. You will use different "Review Views" depending on the type of review you are performing.
  5. Use Review Views: There are several Review Views available:
    • Classification Viewer: Verify document classification.
    • Data Viewer: Verify data extraction results.
    • Thumbnail Viewer: Review individual page images.
    • Folder Viewer: Navigate using the standard folder/page hierarchy.
    • Scan Viewer: Use for scanning paper documents.

By following these steps, you can effectively use the Grooper Web Client for document review.

How do I use the Grooper Stats page?

To use the Grooper Stats Page, follow these steps:

  1. Access the Stats Page: The Stats page can be accessed via the navigation links on the homepage. It provides a user interface for managing and viewing saved Stats Queries.
  2. Manage Stats Queries: On the Stats Page, you can view a list of Stats Queries. These queries allow you to retrieve statistical information about Grooper's workflow, providing insights into current work efficiency.
  3. Execute Queries: Select a Stats Query from the list and use the "Run" button to execute it. This will display the results of the query, showing various statistics based on the parameters set in the query.
  4. View Query Results: The results of a Stats Query are displayed in the Stats Viewer. This includes a report and a list of Session Stats for the query, providing detailed insights into the data.
  5. Manage Queries: You can add new queries, delete existing ones, or modify the order of queries using the buttons provided on the Stats Page. This allows you to customize the statistical analysis according to your needs.

By following these steps, you can effectively use the Grooper Stats Page to monitor and analyze workflow statistics.

How do I create and manage Grooper Jobs?

To create and manage Grooper Processing Jobs, you can follow these steps:

  1. Creating Jobs:
    • Processing Jobs in Grooper can be created in two primary ways:
      • Ad-hoc Jobs: These are manually created using the "Process All" button in the Batch Process Step - Activity Tester tab on the Design Page.
      • Production Batches: When a production batch is active, the Activity Processing service will create Processing jobs as each Batch Process Step becomes active.
  2. Managing Jobs:
    • Use the Jobs Page to view, cancel, and delete Ad Hoc Processing Jobs associated with the active Grooper repository.
    • Jobs are displayed in the Object List on the left side of the page, while properties related to a selected job are shown in the "Job Info" Property Grid on the right.
    • Use the properties of the "Filter" panel in the top-right of the Jobs page to filter displayed Jobs.
  3. Job Status:
    • A job can have several statuses, including Ready, Working, Paused, and Completed. All jobs, including completed ones, will remain in the Object List of the Jobs page until manually deleted by a user or the System Maintenance service.
  4. About Tasks within Jobs:
    • A single job may have multiple tasks associated with it, depending on how the Batch Process step was configured. For example, a Review job could have multiple tasks if the Review Batch Process Step is set to a specific scope and folder level.

By following these steps, you can effectively create and manage jobs within Grooper.

Retrieved from "https://wiki.grooper.com/index.php?title=Grooper_FAQ&oldid=27205"