Previous topic |
Next topic |
Contents |
Index |
Contact z/OS |
Library |
PDF
Attributes for the printway-options object class z/OS Infoprint Server Operation and Administration SA38-0693-00 |
|||||||||||||||||||||||||||||||||||||
Attributes for the printway-options object classThis section lists attributes that are valid when you create IP PrintWay™ Options components, which are in object class printway-options. These attributes are also valid for the printer object class. Required attributesAll attributes are optional. automatic-dataset-groupingThis single-valued attribute indicates whether IP PrintWay extended mode automatically groups data sets that are in the same JES output group. Automatic grouping means that IP PrintWay sends all the data sets to a printer in the same transmission, and sends all the data sets in the same email. ISPF field nameAutomatic dataset grouping Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay groups data sets according to the value selected in the dataset-grouping attribute. Usage guidelines
begin-dataset-exitThis single-valued attribute specifies the name of an IP PrintWay Begin Data Set exit routine. IP PrintWay calls this exit before processing any records in a data set. In this exit you can add one or more records to the beginning of the data set and you can change IP PrintWay options. ISPF field nameBegin dataset exit Allowed valuesThe name of your exit routine. You can enter a valid combination of 1-8 letters (a-z, A-Z), numbers (0-9), and national characters (# $ @). The first character cannot be numeric. Blanks and other special characters are not allowed. If a value contains national characters, enclose the value in quotation marks. Lowercase letters are converted to uppercase. For example:
Default valueIP PrintWay does not call an exit routine before each data set. Usage guidelinesThe exit routine must be in an APF-authorized library identified either in the STEPLIB statement in the IP PrintWay startup procedure (IP PrintWay basic mode), in the STEPLIB environment variable (IP PrintWay extended mode), or in a library concatenated to LNKLST. carriage-control-typeThis single-valued attribute indicates the type of carriage control characters in the data sets. Specify this attribute only if you want IP PrintWay to do special processing of carriage control characters. ISPF field nameCarriage control type Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay automatically determines the type of carriage controls in each data set. Usage guidelines
connection-timeoutThis single-valued attribute specifies the maximum number of seconds that IP PrintWay waits for TCP/IP or SNA to return an error if it cannot connect to the printer. If the connection timeout value expires before the connection can be established, IP PrintWay attempts to connect to the printer again if retries are requested. ISPF field nameConnection timeout Allowed valuesAn integer from 5-180. Default valueIP PrintWay waits 30 seconds. Usage guidelines
dataset-groupingThis single-valued attribute indicates how IP PrintWay groups data sets that are in the same JES output group (job) when it sends them to a printer or email destination. ISPF field nameDataset grouping Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay sends data sets to a printer at the same time but not in the same transmission, and sends data sets in separate emails (job option). Usage guidelines
delete-form-feedThis single-valued attribute indicates the type of form-feed controls that IP PrintWay is to delete from data sets. ISPF field nameDelete form feed Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay does not delete form feeds. Usage guidelines
descriptionThis single-valued attribute specifies a description for the component. The description can help you select the correct component from a list. ISPF field nameDescription Allowed valuesAny combination of 1-256 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as # $ @ ! = / -). If the value contains blanks or special characters, enclose it in single or double quotation marks. Default valueNone. document-headerThis single-valued attribute specifies printer-specific data that IP PrintWay includes at the beginning of the document and sends to the remote printer or print server. For example, you might specify printer commands to change the printer default font. ISPF field nameDocument header Allowed valuesA combination of 1-292 letters, numbers, blanks, and special characters. You can also specify these special values, which IP PrintWay converts to EBCDIC hex values:
If you specify these special values, use EBCDIC representation for the rest of the value and specify translate-document-header=yes (default) if the printer accepts ASCII data. If the value contains blanks or special characters, enclose it in single or double quotation marks. For example:
To enter a value in hexadecimal format, prefix the value with the letter x and enclose the value in single quotation marks. For example, this example specifies the same value in ASCII representation, in hexadecimal format. Because the value is in ASCII, also specify translate-document-header=no if the printer accepts ASCII data. For example:
Default valueIP PrintWay does not include any data at the beginning of a document. document-trailerThis single-valued attribute specifies printer-specific data that IP PrintWay includes at the end of the document and sends to the remote printer or print server. For example, if the document-header attribute modifies the printer configuration, you might specify this attribute to restore the default printer configuration. ISPF field nameDocument trailer Allowed valuesA combination of 1-292 letters, numbers, blanks, and special characters. You can also specify these special values, which IP PrintWay converts to EBCDIC hex values:
If you specify these special values, use EBCDIC representation for the rest of the value and specify translate-document-trailer=yes (default) if the printer accepts ASCII data. If the value contains blanks or special characters, enclose it in single or double quotation marks. For example:
To enter a value in hexadecimal format, prefix the value with the letter x and enclose the value in single quotation marks. This example specifies the same value in ASCII representation, in hexadecimal format. Because the value is in ASCII, also specify translate-document-trailer=no if the printer accepts ASCII data. For example:
Default valueIP PrintWay does not include any data at the end of a document. end-dataset-exitThis single-valued attribute specifies the name of an IP PrintWay End Data Set exit routine. IP PrintWay calls the exit you specify after processing all records in a data set. In this exit you can add one or more records to the end of the data set. You can also inspect IP PrintWay options, but you cannot change them. ISPF field nameEnd dataset exit Allowed valuesThe name of your exit routine. You can enter a valid combination of 1-8 letters (a-z, A-Z), numbers (0-9), and national characters (# $ @). The first character cannot be numeric. Blanks and other special characters are not allowed. If a value contains national characters, enclose the value in quotation marks. Lowercase letters are converted to uppercase. For example:
Default valueIP PrintWay does not call an exit routine after each data set. Usage guidelinesThe exit routine must be in an APF-authorized library identified either in the STEPLIB statement in the IP PrintWay startup procedure (IP PrintWay basic mode), in the STEPLIB environment variable (IP PrintWay extended mode), or in a library concatenated to LNKLST. failure-retention-periodThis single-valued attribute specifies the amount of time IP PrintWay retains data sets on the JES spool after all retry transmission attempts to the remote printer or print server have failed. ISPF field nameRetention period: Failure Allowed valuesYou can specify the fixed value FOREVER, or a time value in this format: hhhh:mm:ss: hhhh indicates the hours (0000-9999)
mm indicates the minutes (00-59) ss indicates the seconds (00-59) FOREVER means retain data sets forever on the JES spool. For example:
Default valueIP PrintWay does not retain data sets on the JES spool. Usage guidelines
form-feedThis single-valued attribute specifies the form-feed controls that the printer or print server requires. When it converts line data to text format, IP PrintWay extended mode adds the form-feed controls to the data stream to indicate the start of a new page. ISPF field nameForm feed Allowed valuesA 1-4 character string (2-8 characters if specified in hexadecimal format) that is the EBCDIC representation of the controls. To enter a hexadecimal value, begin the value with the letter x and enclose the value in single quotation marks. If you also specify the delete-form-feed attribute, specify only these hexadecimal values:
If you specify a different value, IP PrintWay might not delete all leading or trailing form-feed controls. This example specifies the form-feed control:
Default valueX'0D0C' (carriage-return and form-feed controls) Usage guidelines
line-terminationThis single-valued attribute specifies the end-of-line controls required by the printer. IP PrintWay translates the controls to ASCII, if necessary, and adds them to the end of each line. ISPF field nameLine termination Allowed valuesA 1-4 character string (2-8 characters if specified in hexadecimal format) that is the EBCDIC representation of the end-of-line control that IP PrintWay adds at the end of a line. To enter a hexadecimal value, begin the value with the letter x and enclose the value in single quotation marks. This example specifies the carriage-return (CR) and line-feed controls:
This example specifies a PIDU create command containing the line-termination attribute:
Default valueIP PrintWay basic mode:
IP PrintWay extended mode:
Usage guidelines
nameThis single-valued attribute specifies the name of the component. Note:
This is a non-settable attribute.
Do not specify the name attribute on the PIDU create, force-create, or modify command. Instead, specify the name as an
operand on the command. However, you can specify the name attribute
when you construct a condition for the where predicate
on the list and export commands. ISPF field nameComponent Name Allowed valuesAny combination of 1-17 letters (a-z, A-Z), numbers (0-9), and special characters (such as $ # @ . - = /). Blank characters are not allowed. Default valueNone. omit-line-termination-at-eofThis single-valued attribute indicates whether IP PrintWay is to omit the LF (line feed) control (or other control specified in the line-termination attribute) at the end of each document. ISPF field nameOmit line termination at EOF Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay includes the line termination control at the end of each document. Usage guidelines
printway-formattingThis single-valued attribute specifies the type of translation and formatting that IP PrintWay basic mode does before transmitting data sets to the remote system. ISPF field nameFormatting Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay does standard processing except under the conditions described in Usage guidelines. Usage guidelines
printway-postscriptThis single-valued attribute specifies the type of PostScript header that IP PrintWay basic mode adds to the beginning of each data set. ISPF field nameFormatting Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay does not add PostScript headers. However, IP PrintWay processes data sets that already contain a PostScript header (%!) as PostScript data sets. Usage guidelines
record-exitThis single-valued attribute specifies the name of the IP PrintWay Record exit routine. IP PrintWay calls this exit for each record in a data set. In a Record exit you can add one or more records, replace a record, or delete a record. You can also inspect IP PrintWay options, but you cannot change them. ISPF field nameRecord exit Allowed valuesThe name of your exit routine. You can enter a valid combination of 1-8 letters (a-z, A-Z), numbers (0-9), and national characters (# $ @). The first character cannot be numeric. Blanks and other special characters are not allowed. If a value contains national characters, enclose the value in quotation marks. Lowercase letters are converted to uppercase. For example:
Default valueIP PrintWay does not call an exit routine for each record in a data set. Usage guidelinesThe exit routine must be in an APF-authorized library identified either in the STEPLIB statement in the IP PrintWay startup procedure (IP PrintWay basic mode), in the STEPLIB environment variable (IP PrintWay extended mode), or in a library concatenated to LNKLST. response-timeoutThis single-valued attribute specifies the number of seconds that IP PrintWay waits for a response from the remote printer or print server before reporting an error. After an error occurs, IP PrintWay attempts to send the data again if retries are requested. ISPF field nameResponse timeout Allowed valuesAn integer from 0-2678400. Default valueIP PrintWay waits 600 seconds (10 minutes) for a response. Usage guidelines
retry-limitThis single-valued attribute specifies the number of times that IP PrintWay retries an unsuccessful transmission. ISPF field nameRetry limit Allowed valuesAn integer from 0-32767. Default valueIP PrintWay does not retry the transmission. Usage guidelines
retry-timeThis single-valued attribute specifies the amount of time IP PrintWay waits between retries of a transmission. For example, when the retry time is 1 minute, IP PrintWay retries every minute, up to the number of retries in the retry-limit attribute. ISPF field nameRetry time Allowed valuesA value in this time format: hhhh:mm:ss: hhhh indicates hours (0000-9999)
mm indicates minutes (00-59) ss indicates seconds (00-59) For example:
Default valueIP PrintWay does not wait between retries. Usage guidelines
successful-retention-periodThis single-valued attribute specifies the amount of time IP PrintWay retains data sets on the JES spool after successful transmission. ISPF field nameRetention period: Successful Allowed valuesYou can specify the fixed value FOREVER, or a time value in this format: hhhh:mm:ss: hhhh indicates the hours (0000-9999)
mm indicates the minutes (00-59) ss indicates the seconds (00-59) FOREVER means retain data sets forever on the JES spool. For example:
Default valueIP PrintWay does not retain data sets on the JES spool. Usage guidelines
translate-document-headerThis single-valued attribute indicates whether IP PrintWay must translate the string in the document-header attribute to the code page required by the printer before sending it to the remote printer or print server. ISPF field nameTranslate document header Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay translates the string to the code page required by the printer. translate-document-trailerThis single-valued attribute indicates whether IP PrintWay must translate the string in the document-trailer attribute to the code page required by the printer before sending it to the remote printer or print server. ISPF field nameTranslate document trailer Allowed valuesYou can enter one of these fixed values:
Default valueIP PrintWay translates the string to the code page required by the printer. transparent-data-characterThis single-valued attribute specifies the character that designates transparent data in the input or output data stream. ISPF field nameTransparent data char Allowed valuesA 1-character string (1-2 characters if specified in hexadecimal format). To enter a hexadecimal value, begin the value with the letter x and enclose the value in single quotation marks. This example specifies the transparent data character:
This example specifies a PIDU create command containing the transparent-data-character attribute:
Default valueIP PrintWay uses X'35' as the transparent data character. Usage guidelines
|
Copyright IBM Corporation 1990, 2014
|