The Add PDF Header and Footer step inserts a header and/or a footer into a PDF file. When set to Constant, the Footer Alignment designates where the footer is located, while the Page Footer Input specifies the data within the footer. The Page Header Input specifies the data within the header. Finally, you may rename the PDF output according to the PDF File Name Input. If the step errors out, it instead outputs a string error message.
Properties
Configuration
Property
Description
Data Type
Set Page Dimensions
When set to true this setting reveals Page height and width inputs as well as margin inputs.
Boolean
Inputs
Property
Description
Data Type
Font Name (v9.15+)
Allows for the font of the Header or Footer to be changed. The only fonts that will be available in this list are those that are installed on the server or are available in the container.
String
Footer Alignment
Determines whether the Footer will be Left, Right, or Center.
HorizontalPlacement
Footer Page Numbers (v9.15+)
Entering a number here will add a page number to the Footer of the document.
List of Int32
Header Page Numbers (v9.15+)
Entering a number here will add a page number to the Header of the document.
List of Int32
Page Footer
By default, the Page Footer is set up to display the Page number and the total number of Pages.
String
Page Header
Chose Merge Plain or HTML Text to select SHOW EDITOR to open a Merge Text Editor to utilize Flow Data within the Header or Footer.
String
Page Height
Set Page Height in inches.
String
Page Margin Bottom
Set the bottom margin in inches.
String
Page Margin Left
Set the left margin in inches.
String
Page Margin Right
Set the right margin in inches.
String
Page Margin Top
Set the top margin in inches.
String
Page Width
Set the Page Width in inches.
String
PDF File
File to add the Headers and/or Footers to.
List of Byte
PDF File Name
Include ".pdf" at the end of the mapped File Name to ensure that file will save and output properly as a PDF file.
String
Outputs
Property
Description
Data Type
PDF File
Updated PDF File with the Header and Footer added.
FileData
Error Message
This outcome path will be hit if the step encounters an error.
