Render

Renders the native file version stored on a Batch Folder to PDF.

Remarks

Rendering allows electronic documents of any type to be displayed in Grooper, and allows their textual content to be accessed by Grooper activities such as Classify and Extract. Conversion to PDF is achieved by automating the native application to print the document to a Grooper-installed printer called the 'Grooper Render Printer', which generates a PDF file from the print stream. This activity can render any electronic document format, as long as the following criteria are met:

Only a single instance of this activity may run on the same machine at the same time. If the folder does not have a native version, this activity does nothing.

For more information on installing and configuring Grooper Render Printer, click here to go to Grooper x Change.

Inherits from: Unattended Activity

Properties

The following 30 properties are defined.

Property Name Description
General
Excluded File Extensions Type: Embedded Lexicon

Specifies file extensions which should be excluded from the rendering process. Each file extension in the lexicon should be in lower case and preceded by a "." character.

File Extension Mappings Type: Embedded Lexicon

Specifies file extension mappings. For example, there are many different file extensions for a text file (.txt, .log, .readme, etc.). While the .log extension may not have a print verb registered, the .txt file extension does. The entries in this lexicon provide such a mapping for the rendering process. Each lexicon entry should contain the original file extension as the value, and the replacement file extension as the replacement value. All file extensions must be in lower case and preceded by a "." character.

Overwrite Existing Type: Boolean, Default: False

If true, any existing PDF versions will be overwritten. If false, folders with existing PDF versions will be skipped.

Page Count Limit Type: Int32, Default: 0

The maximum number of pages in a rendered document. If a print job is detected which includes more than the specified number of pages, the print job will be canceled and the document will be considered a render error.

Render PDFs Type: Boolean, Default: False

If enabled, Native PDF files will be rendered (printed) and saved to the Batch Folder. Otherwise, the Native PDF file will be left as is.

Multipart Rendering Options
Unknown File Type Disposition Type: ProblemDisposition, Default: Flag, Replace

When rendering multipart objects such as emails or ZIP files, indicates what should happen if an unknown file type is encountered. If no disposition options are enabled, the item will complete successfully with no indication that a problem occurred.

Render Error Disposition Type: ProblemDisposition, Default: Flag, Replace

When rendering multipart objects such as emails or ZIP files, indicates what should happen if a rendering error occurs. If no disposition options are enabled, the item will complete successfully with no indication that a problem occurred.

Flag PDF Conversion Issues Type: Boolean, Default: False

If set to true, documents will be flagged in cases where recoverable PDF conversion issues are encountered. During the rendering of certain file types, existing PDF documents with minor corruptions may be encountered. By enabling this property, the document will be flagged when a recoverable corruption is encountered and the repair is successful. If Grooper's attempt to repair is unsuccessful, an exception will occur and the current Error Disposition will be followed.

Render Damaged PDFs As Images Type: Boolean, Default: False

Allows damaged PDFs which cannot be combined using normal methods to be combined as images. In some cases, it may not be possible to open a damaged PDF and extract the pages, but it may be possible to render the document pages to an image. If this option is enabled, when normal PDF merging fails, and attempt will be made to merge the PDF files as images. If this option is disabled, an error will be raised when normal merging fails.

E-Mail Rendering
Body Rendering Preference Type: BodyRenderingMethod, Default: PreferHTML

Indicates how the body of mail messages should be rendered. Can be one of the following values:

  • None - The message body will not be rendered.
  • PreferText - The message body will be rendered as plain text. If the message does not include plain text, it will be rendered as HTML.
  • PreferHTML - The message body will be rendered as HTML. If the message does not include HTML, it will be rendered as plain text.

Render Attachments Type: Boolean, Default: True

If true, then attachments of mail messages will be rendered.

Render Headers Type: Boolean, Default: False

If enabled, appends a page to the end of the document containing the RFC822 headers.

HTML Body Rendering
Download Image Resources Type: Boolean, Default: True

If enabled, external image resources used in HTML message bodies will be downloaded as necessary.

Resource Download Timeout Type: Int32, Default: 5

The timeout, in seconds, for downloading external resources.

Text Rendering
Page Size Type: Logical Size, Default: 8.5in, 11in

The size, in inches, of each PDF page.

Page Margins Type: Border, Default: 0.5

The size, in inches, of margins around the edge of each page.

Font Name Type: String, Default: Courier

Specifies the font that will be used. Can be one of the following values:

  • Courier (PDF)
  • Courier-Bold (PDF)
  • Courier-Oblique (PDF)
  • Courier-BoldItalic (PDF)
  • Helvetica (PDF)
  • Helvetica-Bold (PDF)
  • Helvetica-Oblique (PDF)
  • Helvetica-BoldOblique (PDF)
  • Times-Roman (PDF)
  • Times-Bold (PDF)
  • Times-Oblique (PDF)
  • Times-BoldOblique (PDF)
  • Plus Locally-Installed Windows Fonts

Font Size Type: Single, Default: 10, Range: 8 - 26

Specifies the font size that will be used.

Dialog Box Handling
Dialog Response Data Type Type: Data Type

A Data Type used for generating responses to application-raised dialog boxes. When an application displays a dialog box during rendering, a text representation of the dialog box is generated, including the title of the dialog box, the text from each control, and the text from each button. To generate an automated response to a dialog box, the Data Type specified here must define a Data Format which matches text on the dialog box, and returns the name of the button to be clicked as a literal value in the Output Format.

For example, consider a scenario where the following dialog box is showing up in the Grooper log as unresolved:


Microsoft Office Excel
This workbook contains one or more links that cannot be updated.

• To change the source of links, or attempt to update values again, click Edit Links.
• To leave the links as is, click Continue.

{Continue} {Edit Links...}


To handle this dialog, a Data Format could be create with a Pattern of 'links that cannot be updated' and a literal value of 'Continue' in the Output Format. When this application dialog box is encountered, the Data Type will match the text on the dialog, and the button named 'Continue' will be automatically clicked.

Default Button Names Type: String []

A list of button names which will be automatically clicked in cases where none of the formats defined in the Dialog Response Data Type produce a match. Supports regular expression syntax. Matching is not case-sensitive.

Timeout Settings
Print Job Start Timeout Type: Int32, Default: 10

The timeout period, in seconds, for a print job to start after the printing application is launched.

Output File Polling Timeout Type: Int32, Default: 5

The timeout period, in seconds, for the output file to be generated after the print job has completed printing.

Print Spooler Recycle Delay Type: Int32, Default: 5

The amount of time, in seconds, for the thread to sleep after recycling the print spooler service.

Process Close Timeout Type: Int32, Default: 2

The amount of time, in seconds, for the thread to sleep after recycling the print spooler service.

Render Printer Info
Render Printer Path Type: String

The path to which the Grooper Printer Driver is configured to output PDF files.

Default Print Queue Type: String

Displays the print queue for the default printer.

Registered File Types Type: List of Shell Execute Info

Displays a list of file types on the local machine for which a shell print verb is registered. This property is for informational purposes only. At runtime, rendering will rely on Windows file type registrations, therefore it is not necessary to configure any file type registrations here.

Processing Options
Error Disposition Type: IssueDisposition, Default: Flag, Log

Determines what happens when an error occurs processing an activity.

Maximum Consecutive Errors Type: Int32, Default: 0

The maximum number of consecutive errors, after which a critical stop will be raised. A critical stop will cause services to stop running.

Concurrency Mode Type: ConcurrencyMode, Default: Multiple

Specifies the parallel processing mode for this activity. Can be one of the following values:

  • Multiple - Multiple instances can run concurrently.
  • PerMachine - Only a single instance can run per machine.
  • Single - Only a single instance can run per Grooper repository.
This value determines the type of Thread Pool on which the activity can be executed.

See Also

Border, Data Type, Embedded Lexicon, Logical Size, Shell Execute Info

Used By

Batch Folder - Apply Activity, Batch Process Step