Redaction

Redacts images.

When the input is in one of the following formats, the redacted output is in the same format:

  • PNG
  • TIFF
  • BMP
  • GIF (the processor can process only the first frame of an animated GIF)
  • JPEG
  • PBM, PGM, PPM
  • WebP
  • PDF

    IMPORTANT: To perform redaction on a PDF file, the processor converts the PDF into images. This means that although the output is in PDF format, any content besides text and images (for example comments or form entries) is lost, and everything is rendered as pixels (text can no longer be searched or highlighted).

For other formats, the redacted output is produced in either PNG or TIFF format (TIFF is used when the input contains multiple pages).

In the FlowFile, the redacted image replaces the original.

Properties

Name Default Value Description
IDOL License Service   An IdolLicenseServiceImpl that provides a way to communicate with an IDOL License Server.
Media Service   A MediaServiceImpl that manages media analysis resources.
Regions  

A comma-separated list of regions to redact.

Each region should consist of either four values (left, top, width, height) or five values (left, top, width, height, page):

  • left is the number of pixels between the left side of the image and the left side of the region.
  • top is the number of pixels between the top of the image and the top of the region.
  • width and height provide the width and height of the region.
  • page is a page number.

The following example shows how to redact two different regions on the first page of a document:

10 10 200 50 1, 10 100 200 50 1
Color Black The color to use for redaction. You can specify: Black, Blue, Cyan, Gray, Green, Lime, Magenta, Maroon, Navy, Olive, Orange, Purple, Red, Silver, Teal, White, or Yellow.

Relationships

Name Description
success Processing was successful.
failure Processing failed.