Generate PDF

Generates a PDF document from one or more image-based pages, with optional text-behind and/or annotations.

Remarks

This activity operates on a Batch Folder containing one or more descendant Batch Page objects. It generates a PDF document from the page images, and saves the resulting PDF file on the folder object. OCR data may optionally be merged into the output to create a searchable PDF document. Various PDF annotations may also be applied to highlight extracted data elements, place signature widgets, generate form fields, and etc.

Inherits from: Unattended Activity

Properties

The following 9 properties are defined.

Property Name Description
General
Annotations Type: List of Field Annotation

Defines one or more annotations to be added to the PDF.

JPEG Compression Quality Type: Double, Default: 75%

The JPEG compression quality to use for color and grayscale pages.

Embed All Fonts Type: Boolean, Default: False

If enabled, all fonts necessary to render the pdf will be embedded into the PDF. Pages must contain OCR data in order for this option to have any effect.

Make Searchable Type: Boolean, Default: False

Specifies whether the output PDF file should be searchable. This option adds searchable text-behind content to each page using OCR data produced in Grooper. If enabled, it is important that each page has been previously processed through the Recognize activity.

Linearized Type: Boolean, Default: False

Specifies whether the output PDF file should be linearized for fast web viewing.

Delete Source Pages Type: Boolean, Default: False

If set to True, the folder contents will be deleted after successful creation of the PDF document. Use this option to delete the pages from which the PDF document was created.

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

Checkbox Widget, Highlight Annotation, Radio Group Widget, Signature Widget, Textbox Widget

Used By

Batch Folder - Apply Activity, Batch Process Step