SPLF_TO_PDF
This activity converts the spooled file identified by the job and spool file input parameters into a PDF document. The PDF document is written to the file name and path specified by the DOCPATH parameter.
Additional input parameters allow basic formatting and layout of the PDF document to be specified. The MOREATTRIBUTES parameter is provided for advanced use to specify additional PDF document attributes.
INPUT Parameters:
DOCPATH : Required
This parameter specifies the path and file name for the PDF document that will be generated by this activity. If the specified file already exists, by default it's contents will be replaced, but this behavior can be altered by the APPEND parameter.
APPEND : Optional
This optional parameter only applies if the specified PDF document path and file name already exists. It takes a value of Y (yes) or N (no). If Y (yes) is specified, the converted spool file pages will be appended to the existing PDF document. If N (no) is specified or assumed, the existing PDF document will be replaced. If this parameter is not specified, a default of N (no) is assumed.
JOBNAME : Required
This parameter specifies the name of the job that created the spool file from which the PDF document is to be created.
JOBUSER : Required
This parameter specifies the user profile name of the job that created the spool file from which the PDF document is to be created.
JOBNUMBER : Required
This parameter specifies the job number of the job that created the spool file from which the PDF document is to be created.
SPLFNAME : Required
This parameter specifies the name of the spool file from which the PDF document is to be created.
SPLFNUMBER : Optional
This parameter specifies the number of the spool file from which the PDF document is to be created. If not specified, a default value of 1 is used. Otherwise specify the number of the job's spooled file from which the PDF document is to be created.
PAGES : Required
This parameter can specify a comma-separated list of page numbers and/or page ranges that are to be included in the conversion to PDF. For example the value '2,5,10-15' will select single pages 2 and 5 and pages 10 to 15. If this parameter is not specified, all pages in the spool file will be converted to PDF.
PAGETYPE : Required
According to the value of this parameter, the converted PDF document may consists of PDF text pages or PDF TIFF G4 image pages. The value *TEXT may be used for SCS type spooled files and *IMAGE may be used for both SCS and AFPDS type spooled files. *TEXT is faster but can only convert SCS spool files. *IMAGE is slower but can be used for both SCS and AFPDS file types. If this parameter is not specified, *TEXT is assumed.
PAGESIZE : Optional
Specifies the page size for the generated PDF document. The default value is *A4. Other valid values include:
- *A0 to *A10
- *B0 to *B5
- *LETTER
- *HALFLETTER
- *LEDGER
- *LEGAL
- *NOTE
ORIENTATION : Optional
Specifies the page orientation as *PORTRAIT or *LANDSCAPE. The default value is *LANDSCAPE.
BACKIMAGEPATH : Optional
This parameter may specify the path and file name of an image file (such as a corporate logo or letterhead) to be included in the background of the generated PDF file. If specified, the image is included and positioned according to the values of the BACKIMAGEPAGES and BACKIMAGEPOS parameters.
When this feature is used, the image is placed on the PDF page and the spool file text is placed over it. The position or layout of the spool file text is not altered to accommodate the image. Therefore, you should choose an image file and/or position or size the image to avoid obscuring the spooled file text. For example, choose an image file that uses mainly light colours.
BACKIMAGEPAGES : Optional
This parameter applies only when a background image file is specified using the BACKIMAGEPATH parameter. It specifies the pages of the PDF file that are to include the image. You can use the value *ALL to include the image on every page of the generated PDF file, or you can use the value *FIRST to include the image only on the first page of the PDF file. The default value is *ALL.
BACKIMAGEPOS : Optional
This parameter applies only when a background image file is specified using the BACKIMAGEPATH parameter. It specifies the size and position of the image on each affected page of the PDF file. It must be specified as four numeric values separated by commas. The four values specify respectively the (left) and (top) coordinates and the width and height of the image. All values are specified in – each is 1/72 inches. If not specified, the default values 1, 1, 80, 80 are used.
MOREATTRIBUTES : Optional
This parameter is provided for advanced use. It allows additional PDF document attributes to be specified using the syntax:
keyword(value) {keyword(value) ...}Refer to LANSA Integrator documentation for the CREATE service command of the PDFSpoolFileService for details of the keywords and values that may be specified.
OUTPUT Parameters:
There are no output parameters.