2.80:Render (Activity)

WIP	This article is a work-in-progress and may abruptly stop in the middle of a section.

The Render activity's property panel

The Render activity normalizes electronic document content from file formats Grooper cannot read innately (such as .docx Word documents and .xlsx Excel documents) to a PDF format. This allows Grooper to extract the text via the Recognize activity.

About

Render effectively "prints" the document as a PDF file, outputting a PDF document containing a scanned image of that document and any native text data. This is done using the Grooper Render Printer. In order to do this, four conditions must be met:

1. The Grooper Render Printer must be installed on the machine running the Render activity. For information on how to install the Grooper Render Printer visit the How To section of this article.
2. The Grooper Render Printer must be set as the default printer under for the user account running the Render activity.
3. The native application for the file type must be installed on the machine running the Render activity. For example, Word must be installed in order for Render to render .docx files as PDFs.
4. The native application must provide a shell print verb. In other words, when you right click the file in Windows File Explorer, a "Print" option is present.

Once the document is processed with the Render activity, you will be able to manipulate the document as if it is a PDF document in Grooper. You will be able to use other PDF related activities, such as Content Action to split out individual pages of multi-page PDFs and the native PDF text extraction functionality of the Recognize activity.

Before rendering to PDF using Render	After rendering to PDF using Render

Render and Batch Processing

For Batch Processing, the Render activity can only run on one individual machine at a time, using a single thread of processing resources. This means a Grooper Activity Processing service must be created using a Thread Pool with its Concurrency Mode set to PerMachine.

Thread Pools control how much of your system's resources are allocated to processing Activities. Most activities can take full advantage of your system's parallel processing resources and grab multiple threads at a time. Furthermore, multiple instances of an activity can generally run on multiple machines. For example, four workstations working in the same Grooper Repository could each run two instances of the Recognize activity as long as there are the threads available to process each task.

However, the Render activity is different. It can only run on one machine at a time, using a single thread. That means only one Render task can perform at a time on a single machine at a time. Each document rendered by the Render activity must be converted to a PDF one at a time, and if multiple machines are attempting to execute the Render activity, they have to wait their turn until the machine ahead of them is finished.

For more information on how to set this up, visit the How To section of this article.

How To

Install the Grooper Render Printer

Step 1Step 2Step 3Step 4

Download the Grooper Render Printer Installer

First, download the Grooper Render Printer Installer from Grooper xChange. Click on the link below to download the installer files.

https://xchange.grooper.com/discussion/118/grooper-render-printer-installation

Extract the Installer Files and Run the Installer

Locate the downloaded zip file in Windows File Explorer. Right click the zip file and select "Extract All..." In the next window, choose the location to extract the installer files and press the "Extract" button.
Navigate through the extracted folders until you locate the "Setup.exe" file, seen below. Right click the "Setup.exe" file and select "Run as administrator"

Step Through the Installer Prompts

Upon opening the "Setup.exe" file, the Grooper Render Printer Installer will run. Click the "Next" button to continue through the installer's prompts.
Press the "Finish" button to finish installing the Grooper Render Printer.

Set the Grooper Render Printer as the Default Printer

Open the Devices panel in your machine's Windows Settings. You will see the Grooper Render Printer listed in the "Printers & scanners" tab.
To make the Grooper Render Printer your default printer, select the Grooper Render Printer from the list of printers and scanners and press the "Manage" button.
On the following screen, press the "Set as default" button. Ensure that the "Printer status:" is listed as "Default"

Set up Activity Processing for Render

Step 1Step 2Step 3

Add a New Thread Pool

By default there is only a single Thread Pool in your Grooper Repository, aptly named "Default". In order to use the Render activity in a Batch Process, you will need to create a new Thread Pool.

Thread Pools are created in the Thread Pools folder of the Infrastructure folder. Navigate to the Thread Pools folder traversing the following path in the Node Tree. Root Node > Infrastructure > Thread Pools Right click the Thread Pools folder and select "Add" then "Thread Pool..." Name the Thread Pool whatever you'd like. Press "OK" to finish naming the Thread Pool and create it. Since we are configuring an Activity Processing Service to run the Render activity, it makes sense to name this Thread Pool "Render".

This creates a new Thread Pool object with the given name in the Node Tree. Change the Concurrency Mode property from Multiple to PerMachine You may see a popup window saying "You must run Grooper as an Administrator to modify services. This is letting you know you will need to run Grooper Config as an administrator to create and edit the Activity Processing Service that will use this Thread Pool. However, you may still create the Thread Pool in Grooper Design Studio. Just press the "OK" button to get rid of this window. Press the "Save" button when finished. ! Render must run using a PerMachine Concurrency Mode

Set up the Activity Processing Service

Next, you must Install an Activity Processing Service using the Tread Pool created in the previous step. Grooper Services are installed through the Grooper Config application. You must run Grooper Config as an administrator to install and edit services.

Locate the Grooper Config application (seen here using the Windows Start menu). Right click Grooper Config and select "Run as administrator" to run the program with the administrator's rights. ! You must run Grooper Config as an administrator to install or edit a Service.
In Grooper Config, select the "Services" tab.
Press the "Install..." button to add a new service. In the "Install New Service" window, select "Activity Processing" Press the "OK" button. This will take you to the configuration screen for this service.

Configure the Activity Processing Service

Next, you just need to configure the service's settings. In this case, we will just set the Thread Pool property to the Thread Pool created in Step 1.

Select the Thread Pool property. Using the dropdown menu, select the Thread Pool created in Step 1 (Here, named "Render").
Ensure the Number of Threads property remains at 1. The Render activity must run single-threaded. Enter the User Name and Password credentials for the administrator's account if not already present. Press the "OK" button when finished.
On the following screen, press the "Start" button to run the Activity Processing Service.

<tab name="Step 4">

Set the Thread Pool in your Batch Process Step

Last, the Render step of your Batch Process must be told which Thread Pool to use.

Select the Render step of your Batch Process (Here there is only one step in the Batch Process. Yours will likely have many.) In the "Properties of Render Step" panel, select the Thread Pool property. Using the dropdown menu, change this from "Default" to the Thread Pool created in Step 1 (Here, named "Render").