Overview
The 'Convert - HTML to PDF (V2)' flow action converts either HTML files (.html), HTML data or HTML data retrieved from a URL to a PDF document.
Example Flow
Please refer to the following articles showcasing the 'Convert - HTML to PDF (V2)' flow action:
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 Parameters
The default 'Convert - HTML to PDF (V2)' flow action parameters are detailed below:
- File Content: (Optional) A Base64 encoded representation of the HTML (.html) file to be processed.
- HTML Data: (Optional) Enter the HTML data to convert to a PDF document.
- HTML URL: (Optional) The web address to the web page which will be converted to a PDF document.
- Page Orientation: Set the orientation of the pages within the resultant PDF document.
- Page Size: Set the page size of the pages within the resultant PDF document
Either 'HTML Data' or 'HTML URL' or 'Filename' and 'File Content' parameters are required to create a PDF document.
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.
Page Sizes
The 'Page Size' parameter allows you to choose from the following predefined page sizes.
- A3 - 297 x 420 mm
- A4 - 210 x 297 mm
- A5 - 148 X 210 mm
- B4 - 250 x 353 mm
- B5 - 176 x 250 mm
- Envelope DL - 110 x 220 mm
- Executive - 7.25 x 10.5 inches
- Folio - 8 x 13 inches
- Ledger - 11 x 17 inches
- Legal - 8.5 x 14 inches
- Letter - 8.5 x 11 inches
- Quarto - 8 x 10 inches
- Statement - 8.5 x 5.5 inches
- Tabloid - 11 x 17 inches
Additional Guidance
-
Encoding: To ensure the correct rendering of all characters contained within the HTML document, consider adding a <meta> charset attribute to the <head> tag to explicitly set the character encoding of the document prior to conversion to PDF. Further guidance can be found here
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
- The 'HTML Url' must be anonymously accessible; sites which require authentication are not currently supported.
- To pass images that are not anonymously accessible the base64 of the image will need to be passed instead of the URL.
Instead of using<img src="https://upload.wikimedia.org/wikipedia/commons/8/8e/Red-dot.svg" />
You will need to as following:<img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==" />
Advanced Parameters
The advanced 'Convert - HTML to PDF (V2)' flow action parameters are detailed below:
- Create Bookmarks: Automatically create bookmarks based on the headings contained within the HTML
- Create Table of Contents: Automatically create a Table of Contents based on the headings contained within the HTML
- CSS Type: Set whether the standard or print style sheets should be used for HTML conversion
- Decode HTML Data: Set whether the data provided in the 'HTML Data' field should be decoded
- Delay: Set the delay in milliseconds between the HTML being received and the conversion to allow time for JavaScript to load.
- Enable Hyperlinks: Enable or disable hyperlinks.
- Enable Javascript: Enable or disable javascript.
- Top Margin: Set the top margin value (pixels) The default value is set to 0.
- Bottom Margin: Set the bottom margin value (pixels) The default value is set to 0.
- Right Margin: Set the right margin value (pixels) The default value is set to 0.
- Left Margin: Set the left margin value (pixels) The default value is set to 0.
- Page Rotation: Set number of degrees to rotate the pages of the PDF document
- Scale: Set a scae value between 0.1 and 2.0
- ViewPort: Set the viewport used to render the HTML.
Decoding HTML Data
The 'Decode HTML Data' parameter allows you to control whether the HTML provided either via a URL, a file or direct HTML should be decoded before creating the PDF document.
HTML encoding is used to convert form data and other client request data from potentially unsafe characters to their HTML-encoded equivalent.
Encoded HTML Example
<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>
Decoded HTML Example
<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>
Return Parameters
The 'Convert - HTML to PDF (V2)' flow action returns the following data.
Action Specific Return Values
- File Content - The converted file (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.
0 Comments