OUTPUT Parameter (Optional) - mfx - 3.1

Syncsort™ MFX Programmers Guide

Product type
Software
Portfolio
Integrate
Product family
Syncsort™ Software
Product
Syncsort™ MFX > MFX
Version
3.1
Language
English
ContentType
Programmer’s Guide
Product name
Syncsort™ MFX
Title
Syncsort™ MFX Programmers Guide
Topic type
How Do I
Copyright
2024
First publish date
2010
ft:lastEdition
2024-08-27
ft:lastPublication
2024-08-27T08:14:56.318001

The OUTPUT parameter specifies that the OUTFIL data set will be written in a PDF, HTML or RTF format. The corresponding OUTFIL DD must define an HFS data set with the PATH, PATHOPTS and PATHMODE parameters. The data sets created can then be downloaded or e-mailed (using the OUTPUT EMAIL subparameter) to a platform that supports the viewing of these formats. If the file is downloaded, it must be downloaded as a binary file.

If the RECFM associated with the data set includes “A” for ANSI control characters, either due to OUTFIL report writing or because it was copied from the input RECFM, the only printer control characters reflected in the output will be blank, 0, - and 1. All other characters will be interpreted as blank, i.e. a new line. For HTML, whenever a ’1’ ANSI control character is encountered, a blank line will be generated before the record is written, except for the very first record.

The following DD statements can be added if you want to receive informational messages from the Java environment which is used to process PDF, RTF and HTML data sets.

//STDOUT DD SYSOUT=*

//STDERR DD SYSOUT=*

An example illustrating the use of the OUTPUT parameter appears in Generating Several Output Files with Different Information.

The format of the OUTPUT subparameters is illustrated on the next page.
Figure 1.  OUTPUT Subparameters Format

PDF

Specifies PDF output format. This format is the default if the OUTPUT parameter is specified. If PDF is specified, the HTML and RTF subparameters may not be specified.

HTML

Specifies HTML output format. If HTML is specified, the PDF and RTF subparameters may not be specified.

RTF

Specifies RTF output format. If RTF is specified, the PDF and HTML subparameters may not be specified.

PORTRAIT

Specifies that the document should be positioned vertically. POR­TRAIT is the default if neither PORTRAIT or LANDSCAPE is specified. The LANDSCAPE option may not be specified if PORTRAIT is specified.

LANDSCAPE

Specifies that the document should be positioned horizontally. The PORTRAIT option may not be specified if LANDSCAPE is specified.

PAGESIZE

Specifies the page size of the output data set. LETTER (8.5” x 11”) is the default. Any of the following common paper sizes can be specified:

_11X17, A0, A1, A10, A2, A3, A4, A5, A6, A7, A8, A9, ARCH_A, ARCH_B, ARCH_C, ARCH_D, ARCH_E, B0, B1, B10, B2, B3, B4, B5, B6, B7, B8, B9, CROWN_OCTAVO, CROWN_QUARTO, DEMY_OCTAVO, DEMY_QUARTO, EXECUTIVE, FLSA, FLSE, HALFLETTER, ID_1, ID_2, ID_3, LARGE_CROWN_OCTAVO, LARGE_CROWN_QUARTO, LEDGER, LEGAL, LETTER, NOTE, PENGUIN_LARGE_PAPERBACK, PENGUIN_SMALL_PAPER­BACK, POSTCARD, ROYAL_OCTAVO,ROYAL_QUARTO, SMALL_PAPERBACK, TABLOID.

MARGINS

Specifies the size of the left, right, top and bottom margins on the page. Each value is in points and 36 is the default number of points for each margin. One inch is equal to 72 points. The number of points can be from 0 through 4000.

TITLE

Specifies a title for the document. It can be any string up to 4095 characters. An apostrophe within the string must be specified with double apostrophes.

AUTHOR

Specifies the author of the document. It can any string up to 4095 characters. An apostrophe within the string must be specified with double apostrophes.

SUBJECT

Specifies the subject of the document. It can be any string up to 4095 characters. An apostrophe within the string must be specified with double apostrophes.

KEYWORDS

Specifies keywords associated with the document. They can be specified as a string of up to 4095 characters. An apostrophe within the string must be specified with double apostrophes.

APPLICATION

Specifies the application name for the document. It can be any string up to 4095 characters. An apostrophe within the string must be specified with double apostrophes. This subparameter is only applicable to PDF files.

OWNERPASSWORD

Specifies the owner password of the document. It can be any string up to 4095 characters. An apostrophe within the string must be specified with double apostrophes. This subparameter is only applicable to PDF files.

USERPASSWORD

Specifies the user password of the document. It can be any string up to 4095 characters. An apostrophe within the string must be specified with double apostrophes. This subparameter is only applicable to PDF files.

COPYALLOWED

Specifies whether permission is granted to copy the document. This subparameter is only applicable to PDF files.

PRINTINGALLOWED

Specifies whether permission is granted to print the document. This subparameter is only applicable to PDF files.

BACKGROUNDCOLOR

Specifies the background color for the document. Any one of the following colors may be specified: BLACK, BLUE, CYAN, DARKGRAY, GRAY, GREEN, LIGHTGRAY, MAGENTA, ORANGE, PINK, RED, WHITE, YELLOW, RGB=(int_red,int_green,int_blue). The RGB subparameters create a color with the specified red, green, and blue values in the range 0 to 255 or X’00’ to X’FF’. WHITE is the default.

FONT

FONTHn

FONTTn

Specifies the characteristics of the font using the subparameters in the figure FONT Subparameters Format. FONT applies to detail records. FONTHn

is used for headers and FONTTn is used for trailers, where n is a number from 1 through 3. For example, FONTH1 applies to HEADER1.

Figure 2. FONT Subparameters Format

FONTNAME

Specifies the name of the font. When creating a PDF format file, only COURIER, HELVETICA and TIMES_ROMAN are allowed. If you specify a font other than one of these three for a PDF format, COURIER will be used. For an HTML or RTF format file, you can choose any font as your fontname. If the name of the font is not a real font, the system default will be used.

nPT

Specifies the size of the font, where n can be a number from 1 through 72.

BOLD

Specifies whether to use bold and/or italics. The default is none of these.

ITALIC

BOLDITALIC

 

color parameters

Specifies the choice of color from the following list: BLACK, BLUE, CYAN, DARKGRAY, GRAY, GREEN, LIGHTGRAY, MAGENTA, ORANGE, PINK, RED, WHITE, YELLOW, RGB=(int_red,int_green, int_blue). The RGB subparameters create a color with the specified red, green, and blue values in the range 0 to 255 or X’00 to X’FF’. BLACK is the default.

SHADING

Specifies the shading color. Choose one of the color parameters listed above. The default is no shading.

UNDERLINE

Specifies that underlining should be used. The default is no underlining.

EMAIL

Specifies that the output data set(s) defined by the OUTFIL statement be e-mailed as an attachment (or attachments) to one or more recipients. The file name of the attachment will be the file name specified in the PATH parameter of the OUTFIL DD statement.

The figure EMAIL Subparameters Format displays the format of the EMAIL subparameters.
Figure 3. EMAIL Subparameters Format

FROM

Specifies the e-mail address of the sender as ‘name@domain’.

TO

Specifies one or more recipient e-mail addresses. The addresses should be separated by commas or semi colons.

TODD

Specifies a ddname defining one or more z/OS data sets or an HFS file containing a list of e-mail addresses. Each line of a file can contain one or more complete e-mail addresses - i.e., an address cannot span multiple lines in a file. Each address (including the last one) must be followed by a semicolon or a comma. Characters after the last semicolon or comma in a line will be ignored. All lines of a file will be concatenated to form the address list. The address list for TO and TODD will be combined.

CC

Specifies one or more recipient e-mail addresses. The addresses should be separated by commas or semi colons.

CCDD

Specifies a ddname defining one or more z/OS data sets or an HFS file containing a list of e-mail addresses. Each line of a file can contain one or more complete e-mail addresses - i.e., an address cannot span multiple lines in a file. Each address (including the last one) must be followed by a semicolon or a comma. Characters after the last semicolon or comma in a line will be ignored. All lines of a file will be concatenated to form the address list. The address lists for CC and CCDD will be combined.

BCC

Specifies one or more recipient e-mail addresses. The addresses should be separated by commas or semi-colons.

BCCDD

Specifies a ddname defining one or more z/OS data sets or an HFS file containing a list of e-mail addresses. Each line of a file can contain one or more complete e-mail addresses - i.e., an address cannot span multiple lines in a file. Each address (including the last one) must be followed by a semicolon or a comma. Characters after the last semicolon or comma in a line will be ignored. All lines of a file will be concatenated to form the address list. The address lists for BCC and BCCDD will be combined.

SUBJECT

Specifies the text of the subject line of the e-mail.

BODY

Specifies the text of the body of the e-mail.

REPLYTO

Specifies one or more recipient e-mail addresses. The addresses should be separated by commas or semi-colons.

HOSTNAME

Specifies the name or IP address of the SMTP server that will be used to send the e-mail. This can used to override the system default.

PORT

Specifies the TCP port number that will be used to relay the e-mail. The default is 25.