Replace Text with Image

Overview

Available August 2019

The 'Replace Text with Image' flow action locates instances of the specified text in the PDF document provided and replaces with the image provided.

A common use case scenario is to replace placeholder text with an image of a signature. 

Parameters

The default 'Replace Text with Image' flow action parameters are detailed below:

  • Filename: The PDF filename (including the file extension)
  • File Content: A Base64 encoded representation of the PDF file to be converted.
  • Search Text: The text to locate and replace with the specified image
  • Image Filename: The filename for the image file (including the file extension)
  • Image File Content: A Base64 encoded representation of the image.
  • Skip First Page: Set whether to ignore the first page when searching for the text fragment.

mceclip0.png

File Content

Please refer to the Obtaining the 'File Contents' Parameter article for guidance on how to obtain the 'File Content' parameter ready to provide to an Encodian flow action. 

Advanced Parameters

The advanced 'Replace Text with Image' flow action parameters are detailed below:

mceclip1.png

  • Apply To: Set which pages within the PDF document to search for the text fragment
  • Page Numbers:Specify the page numbers to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'.
  • Ignore Page Numbers: Specify the page numbers not to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'.
  • Operation ID: (Advanced) The ID of a parent operation, please refer to: Flow Action Return Options: File Content vs. Operation ID
  • Final Operation: (Advanced) Sets whether the this is last Encodian flow action, please refer to: Flow Action Return Options: File Content vs. Operation ID

Return Parameters

The 'Replace Text with Image' flow action returns the following data. 

Standard Return Values

  • Filename - The filename of the updated PDF document..
  • FileContent - The processed document content (Base 64).
  • OperationId - The unique ID assigned to this operation.
  • HttpStatusCode - The HTTP Status code for the response.
  • HttpStatusMessage - The HTTP Status message for the response.
  • Errors - An array of error messages should an error occur.
  • Operation Status - Indicates whether the operation has completed, has been queued or has failed.
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk