SpoolFileToPDF

Use the SpoolFileToPDF activity to uniquely identify a spool file and get a PDF image of that file.

General

The General tab contains the following fields:

Field Process Property? Module Property? Description
Name No No The name to be displayed as the label for the activity in the process.
IBM i Connection No Yes Select the IBM i connection to be used by the SpoolFileToPDF activity.
Units of Measure No No Select either metric or standard units of measure for the paper measurements.
Orientation No No Select either portrait or landscape orientation for the printed output.
Media Size No No Select the paper size to use when formatting the document.
Margin Top No No Select the amount of space in units to be left at the top of the document.
Margin Bottom No No Select the amount of space in units to be left at the bottom of the document.
Margin Left No No Select the amount of space in units to be left on the left of the document.
Margin Right No No Select the amount of space in units to be left on the right of the document.

Description

A short description of the SpoolFileToPDF activity.

Input

In most cases, the outputs of the SpoolFileList activity will be used to map the inputs of the SpoolFileToPDF activity. Therefore, the applicable fields are named identically. The following elements are listed in the Input tab.
Input Item Description
FileName The name of the spool file.
FileNumber The number of the spool file.
JobInfo The JobName, JobNumber, and JobUser of the file.
FromPage The page from which to start printing. It is ones based.
PagesRequested The number of pages to print.

Output

The following elements are listed in the Output tab.
Output Item Description
FromPage A copy of the input parameter FromPage.
PagesReturned Indicates the actual number of pages printed in the event that the number PagesRequested exceeded the number of pages available.
TotalPages The total pages in the document.
PDFStream A base64 encoded binary array of the generated PDF document. You can use this as input to a file write, email, or any other operation capable of accepting binary input.
The Fault tab lists exceptions that are thrown by the SpoolFileList activity:
Fault Thrown When...
IBMiPluginException The plug-in fails to get a status response due to a plug-in error.
ActivityTimedOutException The plug-in fails to get a status response due to a timeout error.
IBMiParameterConvertException The plug-in fails to convert the schema parameters.
IBMiRemoteException The plug-in fails to communicate with an IBM i system.