PDF - Update Hyperlinks

** AVAILABLE NOVEMBER / DECEMBER 2024 **

Overview

The 'PDF - Update Hyperlinks' action provides the capability to search for and update hyperlinks within a PDF document. The action allows the hyperlink text and URL values to be independently updated.

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Default Options

The default 'PDF - Update Hyperlinks' flow action parameters are detailed below:

• File Content: A Base64 encoded representation of the PDF file to be processed
• Hyperlinks: An array of hyperlinks (See below for further details)

Hyperlinks

Processing a hyperlink is executed in two parts:

1. Find hyperlinks within the PDF
2. Update each hyperlink which has been found

The following three properties are used to find hyperlinks within the PDF document:

• Search On: Set whether the search should be performed on the hyperlink text or URL value
• Search Value: The hyperlink text or URL value to locate
• Is Expression: Set whether the 'Search Value' value should be evaluated as a regular expression, the default value is 'false'.

The following four properties are used to update the collection of hyperlinks which have been found:

• Text Current Value: The text value to replace, leave blank to replace the entire value
• Text New Value: The new text value to set
• URL Current Value: The URL value to replace, leave blank to replace the entire value
• URL New Value: The new URL value to set

Multiple hyperlinks can be included within a single operation. To add more than one phrase click the 'Add new item' button:

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 'PDF - Update Hyperlinks' flow action parameters are detailed below:

• Culture Name: This setting is used to set the culture for processing the request. Please refer to the Culture Names article for a list of supported cultures

Return Parameters

The 'PDF - Update Hyperlinks' flow action returns the following data. 

Action Specific Return Values

• File Content - The modified PDF document (Base64)

Standard Return Values

• 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 been completed, has been queued or has failed.