Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Redact

Code Activity Grooper.Activities

Redacts information from the image associated with a Batch Page.

Remarks

Redaction is an unattended activity that permanently removes (or highlights) sensitive or specified data from document images in a batch process.


Overview

Redaction locates data to be removed using configured extractors or fields, then draws opaque or semi-transparent rectangles over the corresponding image regions. This ensures that redacted information cannot be recovered from the output image.


Key Features

  • Flexible Targeting:
    Redact data based on the results of one or more extractors ('Redaction Extractors') or specific fields ('Fields').

  • Customizable Appearance:
    Control the color and transparency of redaction marks using the 'Redaction Color' and 'Transparency' properties.

  • Output Format Awareness:
    The 'Minimum Output Format' property ensures the output image format supports the chosen redaction style (e.g., color, grayscale, transparency).

  • Undo Support:
    Optionally save a copy of the original image before redaction with 'Create Undo Image', allowing for reversal or audit of redactions.


Usage Example

To redact all Social Security Numbers and specific fields:

  • Add a PatternMatch extractor for SSNs to 'RedactionExtractors'.
  • Add the "Account Number" field to 'Fields'.
  • Set 'RedactionColor' to black and 'Transparency' to 0 for solid redactions.
  • Enable 'CreateUndoImage' if you need to retain the original image for audit or rollback.

Notes

  • Redaction is permanent and cannot be reversed unless 'CreateUndoImage' is enabled.
  • The output image format may be upgraded to support color or transparency as needed.
  • Use multiple extractors and fields to target all sensitive data in a single pass.

Properties

NameTypeDescription
General
Redaction Extractors
Processing Options

See Also

Used By

Notification