Add HTML Header or Footer

Overview

The 'Add HTML Header or Footer' flow action inserts the HTML fragment provided into the provided PDF document's header and footer section as per the configuration supplied. 

Default Parameters

The default 'Add HTML Header or Footer' flow action parameters are detailed below:

  • Filename: The PDF filename to be processed (including file extension).
  • File Content: (Optional) A Base64 encoded representation of the PDF document (.pdf) file to be processed.
  • Operation ID: (Optional) The ID of a parent operation, please refer to: Flow Action Return Options: File Content vs. Operation ID
  • HTML Header / Footer: The HTML fragment to embed within the location specified.
  • Location: Set whether the HTML fragment should be added to the header, footer or both locations.

1.jpg

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. 

Additional Guidance

Please adhere to the following guidance for constructing the HTML Header / Footer fragment:

  • Do not include <html>, <head> or <body> tags, simply include the HTML layout and content which you'd normally embed within a <body> tag.
  • Utilise inline style tags as opposed to externally referenced style sheets.
  • Remove all external or inline script. 

Advanced Parameters

The advanced 'Add HTML Header or Footer' flow action parameters are detailed below:

  • Apply To: Set which pages in the document the header, footer or both should be added to
  • Page Numbers: Sets the page numbers the header, footer or both should be added to. This setting only applies when the the 'Apply To' parameter is set to 'Specific'.
  • Ignore Page Numbers: Sets the page numbers the header, footer or both should not be added to. This setting only applies when the the 'Apply To' parameter is set to 'Specific'.
  • Page Margin - Bottom: Set the height (pt) of the bottom page margin. The default value is -1 meaning the existing bottom page margin height will be used. 
  • Final Operation: Sets whether the this is last Encodian flow action.

2.jpg

Please refer to the Flow Action Return Options: File Content vs. Operation ID article for further details on the 'Final Operation' parameter.

Example 

The following HTML fragment will generate this example header: 

<div style="padding: 20px 20px 20px 20px;">
<div style="float:left; width:50%; font-family:Helvetica Neue,Helvetica,Arial,sans-serif;">
<p style="margin: 5px; font-size: 10px">Encodian</p>
<p style="margin: 5px;font-size: 10px">Blythe Valley IC, Central Boulevard, Blythe Valley Business Park, Solihull, B90 8AJ</p>
<p style="margin: 5px; padding-bottom: 3px; font-size: 8px"><a href="https://www.encodian.com" target="_blank" style="color:#9F0DA3;">www.encodian.com</a></p>
<p style="margin: 5px; font-size: 8px; color:#999;">Commercial in Confidence</p>
<p style="margin: 5px; font-size: 8px; color:#999;">Encodian Solutions Ltd is registered in England and Wales No 10200243</p>
</div>
<div style="float:left; width:50%;">
<img style="float:right; max-width:100px; height:auto;" src="https://prod-cdn-general.azureedge.net/logos/icons/32x32t.png" />
</div>
</div>

3.jpg

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk