Contents x
Turning RichText/HTML into PDF
  • 27 Jul 2021
  • 2 Minutes to read
  • Print
  • Dark
    Light
Contents
  This documentation version is deprecated, please click here for the latest version.

Turning RichText/HTML into PDF

  • Updated on 27 Jul 2021
  • 2 Minutes to read
  • Print
  • Dark
    Light
Article summary

Overview

The Html to PDF step in a Flow can convert text to PDF format. When used in a flow, this step reads an HTML or text file, then converts it to PDF. This step does not actually create the file but rather works in conjunction with the Create File step; the Html to PDF step outputs a FileData type, which will be read by the Create File step, which creates the file itself.

The following document demonstrates how to use a Custom Merge [NVelocity] step to define an HTML value that will be converted via the Html to PDF and then sent to a Form for download. 

Example

  1. Begin in a Designer Folder, select CREATE FLOW from the Global Action Bar. 
  2. In the resulting Create Flow dialog window, select the default Flow, name it Text to PDF, and click CREATE to enter the Flow Designer.
  3. In the Flow Designer, from the Steps > Data > Text, attach a Custom Merge [NVelocity] step to the Start step. 
  4. From the Properties panel of the newly added step, define the desired HTML value for the document under Merge Setup > Template. 
    About Custom Merge
    The Custom Merge step is used to define the HTML for the Html to PDF step. Since the step utilizes .NET scripting, it is important to declare the document as HTML via the <!DOCTYPE HTML> opening tag.

    For more information on HTML <!DOCTYPE> declaration, see W3 Schools HTML <!DOCTYPE> Declaration.

  5. From the Steps tab, under Data > PDF, attach an Html to PDF step to the Done path of the Custom Merge step. 

  6. In the Properties panel for the newly added step, Select Flow Map MergedString to Inputs > HTML. 
    Note on Alternate Mapping 
    To map an Html File directly, from the Properties tab check the Configuration > Get HTML From File boolean. Then map the desired file via the HTML File Input.

  7. In the Inputs > Include Page Numbers value field, change the input mapping to Constant and set the Boolean to True.  Then In the Inputs > Page Number Alignment value field, change the Input Mapping to Constant, and choose the placement of the Page Numbers from the Page Number Alignment dropdown list. 

  8. In the Inputs > PDF File Name value field, change the input mapping to Constant and input the desired name of the HTML File.
  9. From the Steps > Integration > File section, drag a Create File to the workspace and connect it to the Done outcome of the Html to PDF step. Then, connect the Failed path to the End step.
  10. From the Properties tab of the Create File step, Select From Flow map PDF File.Contents to Inputs > Data. Then map PDF File.FileName to File Name.
  11. From Steps > Favorite Steps, attach a Show Form step to the Done path of the Create File step. From the Show Form step's Properties tab, select Pick or Create Form, then CREATE a new Form. 
  12. From the Form Designer, design a Form that contains a Button component (labeled "Close") and a File Download component. From the Properties for the File Download component, select Button from the Select Button Type drop-down and provide a Data Name. 
  13. Save the Form, Close the Form Designer. 
  14. Back in the Flow Designer, map PDF File to its respective Input. Then, connect the Close path to the End step. 
  15. Save the Flow, then if desired, close the Flow Designer via X. 

Debug

  1. Select Debug from the Top Action Panel.
  2. Click FULL.
  3. When the Flow reaches the Form step, click Download File Button. Then click Close. 
  4. After the File downloads, open it to verify its contents/that it is configured as expected. 
Was this article helpful?
What's Next
Decisions
Resources
Organization
Connect