Skip to content
CA Spool - 12.0
Documentation powered by DocOps

TCP/IP PrintDirect

Last update December 14, 2018

This article describes how to customize your application for TCP/IP PrintDirect support.

To fully utilize the PJL4/PJL5 print driver support, see the HP 5021-0380 Printer Job Language - Technical Reference Manual.

To fully utilize the PCL5 print driver support, see the HP LaserJet Printer Commands - PCL in your HP LaserJet user's reference guide; for example, C2010-90901 HP LaserJet 4Si Printer - User's Reference Manual.

Nameserver/Symbolic Name Resolution

In a TCP/IP environment, interacting processes are uniquely identified to each other by a combination of IP address and port number. Port numbers are inherently defined as part of the various protocols, but a system administrator must explicitly assign the IP addresses.

IPv4 addresses are 32-bit addresses represented in dotted-decimal format (for example, 123.456.789.0). IPv6 addresses are 128-bit addresses represented in colon-hexadecimal format (for example 2001:DB8::8:800:200C:4).

Symbolic names can also be defined in a one-to-one relationship with IP addresses, letting users reference destinations with symbolic names such as "First.floor.print.room" or "UTAH.Sales," rather than using raw IP addresses.

TCP/IP name resolution is used as follows:

  • To determine the symbolic name of the local host (that is, the MVS mainframe) so that the request can be identified to the receiving LPD.
  • To find the IP address of the receiving host (that is, the one running LPD) or printer, in the event that users specify a symbolic name for the destination.

CA Spool JCL

Consider activating one or more of the following DD statements to the JCL procedure for CA Spool:

//*-------------------------------------------------------------------*
//*  CA Spool Print formatting resource libraries.                    *
//*-------------------------------------------------------------------*
//*PJLLIB   DD  DISP=SHR,DSN=**YOUR**.PJL.RESOURCE.LIBRARY            
//*PCLLIB   DD  DISP=SHR,DSN=**YOUR**.PCL.RESOURCE.LIBRARY            
//*BINLIB   DD  DISP=SHR,DSN=**YOUR**.BIN.RESOURCE.LIBRARY            
//*OVLYLIB  DD  DISP=SHR,DSN=**YOUR**.OVLY.RESOURCE.LIBRARY           
//*HTMLIB   DD  DISP=SHR,DSN=**YOUR**.HTML.RESOURCE.LIBRARY
//*MAILLIB  DD  DISP=SHR,DSN=**YOUR**.MAILBOOK.RESOURCE.LIBRARY  
Note: The TCPSERV, TCPRESO, and TCPHOST datasets and the ESFLPRP module are no longer being used.

The optional PJLLIB, PCLLIB, BINLIB, OVLYLIB, HTMLIB and MAILLIB resource libraries must be allocated as RECFM=VB partition data sets, with, for example, LRECL=259 and BLKSIZE=2594.

PJLLIB might contain predefined FCB, Form, and Chars PJL commands in EBCDIC, which are automatically included in front of the print data if option F is specified for print driver PJL4 or PJL5.

PCLLIB might contain predefined FCB, Form, and Chars PCL commands, which are automatically included in front of the print data, if option F is specified for print driver PCL5 or option G is specified for print driver PJL, PJL4, PJL5, or PCL5. Also option g (lowercase) activates auto include of existing FCB, Form and Chars PCLLIB resource members for print drivers LPR ,DSO ,PJL, PJL4, PJL5, and PCL5. Commands are entered in EBCDIC. An asterisk or blank in column 1 indicates a comment line. A blank terminates the command string on each line. Data after the first blank is ignored. DEVICE statements are supported. PCL and Non PCL commands can exist in the same PCLLIB member.

BINLIB can contain predefined FCB, Form, and Chars binary printer commands in ASCII, which are automatically included in front of the print data, if print driver option B is specified.

OVLYLIB can contain predefined Form binary PCL commands in ASCII, which are included as an automatic page overlay, if print driver option O is specified.

HTMLIB can contain predefined HTMLFORM or FORM specified HTML skeletons used included by the Email print driver if MSGTYPE=HTML is specified.

MAILLIB can contain predefined MAILBOOK or Writer specified email parameters included by the Email print driver.

TCPIP Data File

The SYSTCPD DD statement lets you pre-allocate your TCPIP.DATA file to eliminate the overhead of performing dynamic allocation of this file for every print request.

You can use the SYSTCPD DD statement to test a new TCPIP.DATA data set before putting it into production. It lets you to replace the installation default TCPIP.DATA file with your version.

Note: The use of DCB=BUFNO=n, where n is any number, is not recommended. This can increase storage use and result in storage abends.

Your TCPIP data file can include the following definitions.

TCPIPJOBNAME                 <tcpip_proc>
HOSTNAME                     <host_name> 
DOMAINORIGIN                 <origin>    
NSINTERADDR                  <IP-address_of_nameserver>
NSPORTADDR  53                           
RESOLVEVIA  UDP                          
RESOLVERTIMEOUT  30                      
RESOLVERUDPRETRIES  1                    
DATASETPREFIX                <dsprefix>

TCP/IP Source Ports

The RFC 1179 Line Printer Daemon Protocol specifies that the target port is 515, and the source port must be in the range 721 to 731, inclusive. Ports cannot be reused until after 1 minute; a printer is limited to receive 11 print files per minute. To work around this problem, most printers and printer servers allow use of other source ports. Ports are selected using the following communication options:

  • A -- Expand the source ports range to 721-1023, instead of the default LPD source ports range of 721-731.
  • E -- Have TCP/IP automatically assign an ephemeral (short-lived) source port.

Installations can have certain port ranges reserved for printing. You can control the port ranges using the LPORT parameter on the printer’s DRIVPRM1-4 parameters, as follows:

DEFNODE LPR,TCP-LPR,DRIVPRM1='LPORT=(1300-1349,1600-1699,721-731)',
   TCPDRIV=LPR,CLASS=ALL,ACQUIRE=WORK,RELEASE=NOWORK
NODE HP6L,LPR,GROUP=3

TCP/IP Print Drivers

The various TCP/IP print features are packed as print drivers, which can be selected at the printer node level. The following TCP/IP print drivers are currently supported:

  • Basic LPR print driver
  • Basic DSO print driver
  • LPR PJL print driver
  • LPR PCL5 print driver
  • LPR PJL4 print driver
  • PJL5 PrintDirect driver
  • LCDS Xerox DocuSP print driver
  • BARR print driver
  • IPDS print driver
  • Data Set print driver
  • Email print driver
  • SAR print driver
  • JES print driver
  • ESF print driver
  • FTP print driver
  • CA XCOM print driver
  • Connect:Direct print driver

Basic LPR Print Driver

The basic TCP/IP LPR print driver supports FCB-controlled formatting of ASA and machine carriage control print files and print data translation. This driver supplies translation tables for many EBCDIC code pages to Microsoft Windows 3.1, and Latin 1. This driver also supports the Advanced Laser Printer Interface, partial print, SCS transparency, data compression, and separator page user exit.

Activate this support by specifying TCPDRIV=LPR in the printer node definition. If TCPDRIV is not defined for a printer that has TCPHOST defined, TCPDRIV=LPR is the default.

To configure the behavior of the LPR print driver, use communications options, protocol options, and the following formatting options:

  • B -- Includes the existing FCB and the Form and Chars BINLIB resource members before the print file. Includes the RESET BINLIB member after the print file.
  • F -- Lets LINECNT or FCB page length specify the number of lines to be printed per page for NOCC files and single page ASA files.
  • 3 -- Uses existing VPS resources to control the formatting of text files.
  • g -- Includes the existing FCB, Form, and Chars PCLLIB resource members before the print file. Includes the RESET member after the print file.
    Commands are entered in EBCDIC.
    An asterisk or blank in column 1 indicates a comment line. A blank terminates the command string on each line. Data after the first blank is ignored. DEVICE statements are supported. PCL and Non PCL commands can exist in the same PCLLIB member.
  • r -- Includes the existing PCLLIB, PJLLIB, or BINLIB members that match a file's Remote Destination, Writer Name, or Form Name before the print file. Includes the RESET member after the print file.
    An asterisk or blank in column 1 indicates a comment line. A blank terminates the command string on each line. Data after the first blank is ignored. DEVICE statements are supported.

    Note: For more information about how this option interacts with other TCPDRIV options, see the description of the 'r' option in the Initialization chapter.

LPR PJL Print Driver

Some HP LaserJet-compatible printers need to be informed about the printer language of the subsequent print data to be able to print it. To do this, send a PJL ENTER LANGUAGE command to the printer.

Activate this support by specifying TCPDRIV=PJL in the printer node definition. This specification does the following:

  • Performs the same functions as the standard LPR printer driver
  • Sends a 'PJL ENTER LANGUAGE = PCL' command, before the ESFU010X start separator page exit call
  • If PRMODE=PS file, sends a 'PJL ENTER LANGUAGE = POSTSCRIPT' command after the ESFU010X start separator page exit call, but before the data file
  • If PRMODE=PS file, sends a 'PJL UEL' command after the data file, but before the ESFU010X end separator page exit call
  • Sends a 'PJL ENTER LANGUAGE = PCL' command before the ESFU010X end separator page exit call
  • Sends a 'PJL UEL' command after the ESFU010X end separator page exit call

Basic DSO Print Driver

Some TCP/IP-attached printers, in addition to the LPR/LPD protocol, also support a simple protocol for receiving one buffer of raw print data at a time over port 9100 or other ports. HP calls this protocol for TCP/IP Direct Mode printing. Other vendors call this protocol Reverse Telnet, Direct Sockets Interface, TCP/IP Stream protocol, or TCP/IP socket gateway.

If your printer supports bi-directional PJL, then use the PJL5 print driver instead of the DSO print driver.

Activate this support by specifying TCPDRIV=DSO in the printer node definition; this performs the same functions as the standard LPR printer driver.

LPR PCL5 Print Driver

Not all HP LaserJet-compatible printers have PJL support. To better utilize these non-PJL printers, specify PCL based automatic print formatting.

Activate this support by specifying TCPDRIV=PCL5 on the printer node definition; this does the following:

  1. Performs the same functions as the standard LPR printer driver
  2. If the F -- auto format print driver option is specified using TCPDRIV, the following happens after the ESFU010X start separator exit call, but before the data file is sent:
    • A PCL RESET command is sent.
    • For both binary and text files, if the FORM PCL resource is found in the PCLLIB library, it is sent before the data file.
      If the FORM resource is not found in PCLLIB, the file class is checked for simplex/duplex specification. If the file class is S, a Simplex print PCL command is added. If the file class is D, a Duplex print PCL command is added.
    • FCB for text files:
      If the FCB PCL resource is found in the PCLLIB library, it is sent. If the FCB resource is not found, formatting PCL commands are automatically built and sent based on the following algorithms:
      • If no Max Print Position (MPP) is specified through the FCB extension and the LRECL of the file is less than 319, this LRECL is used as the MPP.
      • If no Characters Per Inch (CPI) value is specified through the CHARS parameter or the FCB extension, the CPI defaults to 12 if the MPP is less than or equal to 90; if the MPP is greater than 90, the CPI is calculated as MPP/10.0.
      • If MPP/CPI is less than 7.20, a portrait orientation PCL command is sent; otherwise a Landscape Orientation PCL command is sent; otherwise a Landscape Orientation PCL command is sent.
      • For text files, the default maximum number of lines per page (MPL) is the number of lines per page in the FCB. For NOCC files with a LINECOUNT parameter specified, the MPL is the LINECOUNT value.
      • A line spacing PCL command is sent to best match the current MPL.
    • CHARS for text files:
      Only the first CHARS in the CHARS set is used by the TCP/IP PCL5 print driver. If this CHARS PCL resource is found in the PCLLIB library, it is sent. If the CHARS resource is not found in PCLLIB, font selection PCL commands are automatically built and sent based on the following values:
Value Font
CB00 to CB29 4099 Courier Bold
CE00 to CE29 4099 Courier
CI00 to CI29 4099 Courier Italic
CR00 to CR29 4099 Courier
GB00 to GB29 4099 Courier Bold
GL00 to GL29 4099 Courier
GT00 to GT29 4099 Courier
OB00 to OB29 4102 Letter Gothic Bold
OR00 to OR29 4102 Letter Gothic
PR00 to PR29 4099 Courier
RT00 to RT29 4099 Courier Bold
SI00 to SI29 4099 Courier Italic
ST00 to ST29 4099 Courier
LP17 0000 Line Printer 16.67/8.5

Other values produce unpredictable results.

The value of the last two numeric characters is used as the CPI (pitch).

  • PCL commands are sent to select the requested primary font family, (pitch, style, and stroke) and to select the symbol set Windows 3.1, Latin 1.

A PCL RESET command is sent after the data file and before the ESFU010X end separator page exit call.

Notes:

  • The PCL resources searched in PCLLIB are the file's FORM, FCB, and CHARS values prefixed with 'FORM', 'FCB2', and 'CHAR' respectively. Therefore, if a file is created with FORM=STD, FCB=8, and CHARS=CR12, the matching resource names in PCLLIB are 'FORMSTD', 'FCB28', and 'CHARCR12' respectively.
  • A PCL resource member must contain valid PCL commands in EBCDIC preceded by an EBCDIC escape character (<esc>=X'27'). For example, when FCB=6 is a file attribute, you can add the PCL resource member FCB26 to the PCLLIB library, as follows:

    <esc>&l0O
    <esc>&l6D
    
  • To support different printer capabilities, a PCL resource member can contain multiple sets of PCL commands selected by the device type of the printer node. These PCL command sets must be separated and identified by special DEVICE=device type statements. For example, enter the default PCL command set first, followed by a special PCL command set for device type 'HPLJ5SI':

    <esc>&l0O
    <esc>&l6D
    DEVICE=HPLJ5SI
    <esc>&l0O
    <esc>&l8D
    

LPR PJL4 Print Driver

Many HP LaserJet-compatible printers support an extended set of PJL, which allow job separation, print job configuration, and printer configuration.

Activate this extended PJL support by specifying TCPDRIV=PJL4 in the printer node definition; this does the following:

  1. Performs the same functions as the LPR PJL printer driver support.
  2. A 'PJL JOB NAME = "File: 999999 Name: <filename> Userid: <userid>" command and a 'PJL RDYMSG DISPLAY ="<filename> 999999"' command are sent after the ESFU010X start separator page exit call.
  3. If the F - auto format print driver option is specified using TCPDRIV, the following happens, after the PJL JOB and RDYMSG commands, but before the data file is sent:
    • For both binary and text files, if the FORM PJL resource is found in the PJLLIB library, it is sent before the data file.
      If the FORM resource is not found in PJLLIB, the file class is checked for simplex/duplex specification. If the file class is S, a Simplex print PJL command is added. If the file class is D, a Duplex print PJL command is added.
    • FCB for text files:
      If the FCB PJL resource is found in the PJLLIB library, it is sent.
      If the FCB resource is not found in PJLLIB, formatting PJL commands are automatically built and sent based on the following algorithms:
      • If no Max Print Position (MPP) is specified using the FCB extension and the LRECL of the file is less than 319, the LRECL is used as the MPP.
      • If no Character Per Inch (CPI) is specified using either the CHARS parameter or the FCB extension, the CPI defaults to 12 if the MPP is less than or equal to 90.
        If the MPP is greater than 90, the CPI is calculated as MPP/10.0.
      • If MPP/CPI is less than 7.2, a 'PJL SET ORIENTATION = PORTRAIT' command is sent; otherwise a 'PJL SET ORIENTATION = LANDSCAPE' command is sent.
      • For text files, the default Max Lines per page (MPL) is the number of lines per page value in the FCB of the file. For NOCC files with a LINECOUNT parameter specified, the LINECOUNT value is the value of the MPL.
      • Send a 'PJL SET FORMLINES = <MPL>' command to set the maximum number of lines per page.
    • CHARS for text files:
      Only the first CHARS in the CHARS set is used by the TCP/IP PJL4 print driver.
      If this CHARS PJL resource is found in the PJLLIB library, it is sent.
      If the CHARS resource is not found in PJLLIB, font selection PJL commands are automatically built and sent based on the following values:
Value Font
CB00 to CB29 4099 Courier Bold
CE00 to CE29 4099 Courier
CI00 to CI29 4099 Courier Italic
CR00 to CR29 4099 Courier
GB00 to GB29 4099 Courier Bold
GL00 to GL29 4099 Courier
GT00 to GT29 4099 Courier
OB00 to OB29 4102 Letter Gothic Bold
OR00 to OR29 4102 Letter Gothic
PR00 to PR29 4099 Courier
RT00 to RT29 4099 Courier Bold
SI00 to SI29 4099 Courier Italic
ST00 to ST29 4099 Courier
LP17 0000 Line Printer 16.67/8.5

Other values produce unpredictable results.

The value of the last two numeric characters is used as the CPI (pitch).

  • The corresponding 'PJL LPARM:PCL FONTNUMBER=<nnn>' command, 'PJL LPARM:PCL PITCH=<CPI>' command, and 'PJL LPARM:PCL SYMSET=WINL1' command are sent.
  • A 'PJL SET FORMLINES = <MPL>' command to set the maximum number of lines per page is sent.

If any of the USERDATA fields in the file starts with '@PJL', they're sent as PJL commands before the data file.

A 'PJL EOJ NAME = "File: 999999 Name: <filename> Userid: <userid>"' command and a 'PJL RDYMSG DISPLAY =" "' command are sent before the ESFU010X end separator page exit call.

Note the following:
  • The PJL resources searched in PJLLIB are the file's FORM, FCB, and CHARS values prefixed with 'FORM', 'FCB2', and 'CHAR' respectively. Therefore, if a file is created with FORM=STD, FCB=8, and CHARS=CR12, the matching resource names are 'FORMSTD', 'FCB28', and 'CHARCR12' respectively.
  • A PJL resource member must contain valid PJL commands in EBCDIC. For example, when FCB=6 is a file attribute, PJL resource member FCB26 is added to the PJLLIB library as follows:

    @PJL SET ORIENTATION = PORTRAIT
    @PJL SET FORMLINES = 51
    
  • To support different printer capabilities, a PJL resource member can contain multiple sets of PJL commands selected by the device type of the printer node. These PJL command sets must be separated and identified by special DEVICE=device type statements.
    For example, first enter the default PJL command set followed by a special PJL command set for device type 'HPLJ5SI', as follows:

    @PJL SET ORIENTATION = PORTRAIT
    @PJL SET FORMLINES = 51
    DEVICE=HPLJ5SI
    @PJL SET ORIENTATION = PORTRAIT
    @PJL SET FORMLINES = 52
    
  • You can modify the default configuration of a printer by sending PJL INITIALIZE, RESET, and DEFAULT PJL commands to the printer. For example, when the form attribute of a file is FORM=DEF0 PJL, you can use resource member FORMDEF0 to reset the PJL default environment variables to their factory default values, as follows:

    @PJL SET ORIENTATION
    

PJL5 PrintDirect Driver

Some HP LaserJet-compatible printers support PJL status read-back from the printer to the host. This support can be used to query the printer configuration and printer status information, and to receive unsolicited printer and print job status information. This bi-directional PJL support is utilized to implement the CA Spool TCP/IP PrintDirect support.

Activate this PJL status read-back support by specifying TCPDRIV=PJL5 on the printer node definition; this does the following:

  1. Performs the same functions as the LPR PJL4 print driver support.
  2. Before the ESFU010X start separator page exit call, 'PJL USTATUS' commands are sent to allow the printer to send unsolicited device, job, and page status messages. The initial status of the printer device is obtained from the printer.
  3. During the sending of the data file, only 5 - 10 pages at a time are sent to the printer to avoid overloading the printer buffer; the following events are also occurring:
    • Each time a physical page is completed, the count of pages printed is updated for display on the Menu system Printer panel.
    • Each time the number of pages specified by the printer node CKPTPGS parameter has been physically printed, the file print status is checkpointed.
    • If a PJL unsolicited printer device attendance message is received from the printer, it is written to the ESFLOG and saved so that it can be displayed on the Menu System Printer panel.
    • If a printer device attendance message indicates operator intervention, the printer status is changed to Intervention Required; printing is halted until the intervention has been cleared or until the printer times out.
    • If a restart, forward-space, or backspace printer command is received, the printing is interrupted and restarted at the requested page in the file.
  4. After the file has been printed and after the ESFU010X end separator page exit call, a 'PJL USTATUSOFF' command is sent to turn off all unsolicited status messages.

Note the following:

  • Printer responses to PJL DINQUIRE, INQUIRE, and INFO commands, can be saved as a TCP/IP trace file, as a PJL trace file, or as a PJL Info file. The PJL Info file is not opened until the first DINQUIRE, INQUIRE, or INFO response is received.
    To obtain information about the type of printer used, the amount of memory available, and the number of pages printed by the print engine, specify printer node TCPDRIV=PJL5I. For example, when FORM=INFO is a file attribute, you can use the PJL resource member FORMINFO to query the printer, as follows:

    @PJL INFO ID
    @PJL INFO MEMORY
    @PJL PAGECOUNT
    
  • The INFTRACE spool file resulting from using the previously mentioned FORMINFO PJL resource with an HP LaserJet 4 printer is as follows:
    Printer: HP69File:1995Name: SUBSPJL4

    @PJL INFO ID
    "LASERJET 4"
    @PJL INFO MEMORY
    TOTAL=1445960
    LARGEST=1418556
    @PJL INFO PAGECOUNT
    "?"
    

LCDS Xerox DocuSP Print Driver

The LCDS print driver routes Line Conditioned Data Stream (LCDS) print files to Xerox DocuSP printers over the TCP/IP network using the LPR/LPD protocol. If the printer definition includes TCPPORT=9000-9999, the Direct Socket (DSO) protocol is used.

To insure accurate transmission and interpretation of the LCDS data, this print driver automatically converts carriage control to machine carriage control, adds carriage control information (if it is missing), includes the FCB, and adds record length information per record.

To Send LCDS Print Files

To send CA Spool print files in LCDS format to a Xerox DocuSP printer, perform the following steps:

  1. Define a new CA Spool printer with TCPDRIV=LCDS.
  2. Add appropriate TCPHOST, TCPPRT, and TCPPORT parameters.
  3. Queue the print files to this new LCDS printer.

If you specify a TCPPORT=value in the range of 9000 to 9999, then the DSO protocol is used. If not, then the LPR/LPD protocol is used.

For more information about defining printers, see the chapter Initialization.

Samples

The following is a sample LCDS LPR printer node definition:

DEFNODE LCDSLPR,DOCU-180,TCPDRIV=LCDS,TCPPORT=515,CLASS=A,
     ACQUIRE=WORK,RELEASE=NOWORK
NODE HP6L,LCDSLPR,TCPHOST=ip-address,TCPPRT=1p,GROUP=2

The following is a sample LCDS DSO printer node definition:

DEFNODE LCDSDSO,DOCU-180,TCPDRIV=LCDS,TCPPORT=9100,
     CLASS=A,ACQUIRE=WORK,RELEASE=NOWORK
NODE HP6L,LCDSDSO,TCPHOST=ip-address,GROUP=2

BARR Print Driver

The BARR print driver routes print files in the 'Mainframe IP Record Format' to BARR printers over the TCP/IP network using the LPR/LPD protocol. To insure accurate transmission and interpretation of the print data, this print driver automatically converts carriage control to machine carriage control, adds carriage control information if missing and adds record length information per record.

To send print files to a BARR printer

Define a new CA Spool printer with TCPDRIV=BARR.

Add appropriate TCPHOST, TCPPRT, and TCPPORT parameters.

Queue the print files to this new BARR printer.

For more information about defining printers, see the Initialization chapter.

Samples

The following is a sample BARR printer node definition:

DEFNODE BARRLPR,BARR-01,TCPDRIV=BARR,CLASS=A,
      ACQUIRE=WORK,RELEASE=NOWORK
NODE HP6B,BARRLPR,TCPHOST=ip-address,TCPPRT=1p,GROUP=2

IPDS Print Driver

The IPDS print driver prints IPDS files with PRMODE=PAGE and FCB=ASIS using the TCP/IP direct sockets carrying protocol.

Non-IPDS files are printed using the DSO print driver.

To send CA Spool IPDS print files to a TCP/IP attached IPDS printer

Define a new CA Spool printer TCPDRIV=IPDS.

Add appropriate TCPHOST and TCPPORT parameters.

Queue the IPDS print files to this new IPDS printer.

For more information about defining printers, see the Initialization chapter.

Samples

The following is a sample IPDS printer node definition:

DEFNODE IPDSDSO,IPDS-DSO,TCPDRIV=IPDS,TCPPORT=9100,SEP=0,CLASS=A,
      ACQUIRE=WORK,RELEASE=NOWORK
NODE HP6I,IPDSDSO,TCPHOST=ip-address,GROUP=2

Data Set Print Driver

Use this print driver to automatically copy CA Spool print files, including PDF, HTML, and RTF wrapped text files, into MVS data sets or USS HFS files for further processing. The stored print files are, by default, exact copies of the CA Spool print files. It stores text reports in EBCDIC without translation and with preservation of carriage control information.

You can use print driver option D together with one of the existing print drivers to have the complete output data-stream written to an MVS data set or a USS HFS file. By default, data is formatted and translated to ASCII and PCL/PJL or you can include the binary printer commands on the stored output file to print as a binary file.

You can have the output written to an existing sequential/partitioned MVS data set or USS HFS file, automatically allocated to a new data set or HFS file, or appended to an existing data set or file. GDG data sets are supported. The MEMBER parameter specifies the relative GDG number to use. SMS support is included.

You can specify data set and file disposition, and JCL allocation attributes:

  • On the printer level using the 64-byte TCPHOST parameter.
  • On the printer level using the 4*60=240 bytes DRIVPRM1-4 parameters.
  • On the print file level using the 4*60=240 byte OUTPUT ADDRESS parameter.

You can specify the above using JCL or have it be automatically assigned using CA Spool DESTID definitions.

Note: TCPHOST parameter is processed first, DRIVPRM1-4 parameters second and OUTPUT ADDRESS parameter is processed third.

If you specify the data set parameter more than once, then the last specification is used.

If the TCPHOST parameter is not used to specify data set parameters, then you must specify a dummy TCPHOST parameter to use the data set print driver.

You can automatically generate unique identifying names; that is, you can specify that output data set names, member names, and HFS file names be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

To Copy Print Files Unmodified

To copy print files unmodified to MVS data sets or HFS files, you define a new CA Spool printer driver with TCPDRIV=DISK and queue the print files to the new DISK printer.

To Copy Print Files as Complete Output Data-Streams

To copy print files to MVS data sets or to copy them to HFS files as complete output data streams, define a new CA Spool printer that specifies driver option D in the TCPDRIV parameter. For example, define TCPDRIV=PCL5FD and Queue the print files to the new printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the printer node TCPHOST parameter and using the OUTPUT ADDRESS parameters of the file:

DSNAME=data-set-name [.PDF/.PDFL/.HTML/.RTF],
MEMBER={member-name / 0 / +1 / -1},
DISP=NEW|MOD|OLD|SHR,
UNIT=device-type,
VOLSER=volume-serial-number,
RECFM=F|V,
LRECL=99999,
DATACLAS=SMS-data-class-name,
MGMTCLAS=SMS-management-class-name,
STORCLAS=SMS-storage-class-name,
PATH=HFS-file-name [.PDF/.PDFL/.HTML/.RTF],
PATHMODE=SIRUSR/,SIWUSR/,SIXUSR/,SIRWXU/,SIRGRP/,SIWGRP/,SIXGRP/
         ,SIRWXG/,SIROTH/,SIWOTH/,SIXOTH/,SIRWXO/,SISUID/,SISGID

PATH includes the complete remote target directory and file name. The maximum value is 118 characters.

Note: DISP=MOD is not supported for PDS members.

Text PDF/PDFL/HTML/RTF Wrapping

If an input text file with a DSNAME or PATH filename extension equal to PDF, PDFL, HTML, or RTF is selected, the file is automatically formatted and converted into the specified data-stream as it is being written to disk. PDFL specifies that linearized PDF must be generated.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and maximum record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported.

If the RTF wrapper is used and the input file's form attribute matches FORM=A4*, the output is formatted to A4 paper size.

If the input file's form attribute matches FORM=LET*, the output is formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Replacement Variables

To dynamically generate the corresponding unique names, specify the following replacement variables anywhere in the DSNAME, MEMBER, and PATH parameters:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

you have specified that only characters 2 through 5 of the file creator's name are to be used.

If you do not specify JCL parameters, the following default JCL parameters are used:

DSNAME=&UID.&NOD.&FNM.&FNO,DISP=NEW

Samples

A sample data set printer node definition follows:

DEFNODE DISK1,DISK-01,TCPDRIV=DISK,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6D,DISK1,
     TCPHOST=DISK,
     DRIVPRM1='DSNAME=PUBLIC.&FNM.&FNO,DISP=NEW',
     GROUP=2

A sample data set DESTID definition follows:

DESTID QDEST=HP6D,QFNAME=SV11*,
     FADDRES1='DSNAME=UCHPD.DISPATCH.&JUL.&TIM',
     FADDRES2='UNIT=SYSALLDA,VOLSER=WORK01,DISP=NEW'

Email Print Driver

Use this print driver to automatically distribute CA Spool print files, including PDF, HTML, and RTF wrapped text files, by email directly to users' mailboxes for viewing and printing.

The Email print driver provides support for:

  • Attaching print files as text, PDF, PCL, Word, Excel, and other file formats
  • Automatic conversion of text files into PDF, HTML, or RTF files when they are sent through email
  • HTML-based email message body formatting including multiple fonts, colors and image support
  • Web Link support
    Consequently, the email message includes a link to the CA Spool file, rather than the CA Spool file as an attachment. When the user clicks the Web Link, the CA Spool file automatically appears, through the CA Spool Web Interface.
  • Control over recipients (including cc and bcc) subject line, and attachment file name
  • Automatic creation of unique identifying names for recipient, subject, and attachment
  • The OUTPUT statement email parameters MAILTO, MAILCC, MAILBCC, MAILFROM, MAILFILE and REPLYTO are supported

The email print driver can connect:

  • Directly to a LAN-based email server such as Microsoft Exchange Server, Lotus Notes, or Novell GroupWise
  • Indirectly through a z/OS-based IBM TCP/IP or TCPaccess SMTP server

You can specify the email subject, message body, recipients, copy recipients, blind copy recipients, and email attachment file name using the standard OUTPUT statement email parameters MAILTO, MAILCC, MAILBCC, MAILFROM, MAILFILE and REPLYTO. The SUBSYS, NJE and XFER interfaces convert these parameters to the corresponding CA Spool email parameters and store them as OUTPUT USERDATA parameters.

Or you can specify the email subject, message body, recipients, copy recipients, blind copy recipients, and email attachment file name at the printer level using the 4*60=240 bytes DRIVPRM1-4 parameters and at the print file level using the 4*60=240 bytes OUTPUT ADDRESS parameter and the 16*60=960 bytes OUTPUT USERDATA parameter, and through a predefined MAILBOOK or Writer specified MAILLIB email parameter members and inline first in the print file before the print data.

You can use CA Spool DESTID definitions to automatically assign OUTPUT ADDRESS parameters.

Inline email parameters are accepted on the first 16 records of the print file. A completely blank line terminates the search for inline email parameters previous to the 16th record. When passing email parameters inline, the carriage control attribute determines the column where the parameters must begin. Email parameters within files whose carriage control attribute is A or M must begin in column 2. Email parameters within files without a carriage control attribute, NOCC files, must begin in column 1. Inline email parameters are limited to 60 characters per line.

The inline email parameters MSGSTART=>> and <<MSGEND= support longer messages, message lines up to 252 bytes and blank lines. MSGSTART=>> and <<MSGEND= must be coded on separate lines above and below the inline message they delimit.

Note: The printer node DRIVPRM1-4 parameters are processed first, OUTPUT ADDRESS parameters are processed second, OUTPUT USERDATA parameters are processed third, MAILLIB email parameter members are processed forth, and inline email parameters are processed last. If you specify email parameters more than once, then the last specification is used with the exception of TO=, CC= and BCC=. Values for TO=, CC= and BCC= are combined from all of the possible sources. If MSG= is passed as an inline email parameter, it must be the last parameter specified.

MAILLIB PDS members can be used to supply addressing information for the SMTP driver. The MAILLIB PDS is searched for a member equal to the MAILBOOK=mail-book-member value. The first 64 records of up to 60 bytes may contain any email parameters except for MSGSTART=>> and <<MSGEND=. If MAILBOOK= is not specified, the Remote Dest or Writer file attribute, if specified, is used for searching the MAILLIB PDS for a match.

You can have unique identifying names automatically by specifying that email subject, recipient, and attachment file names be synthesized from userid, destination, file name, file number, print-mode, origin host name, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

Formatting messages with HTML

Formatting of email HTML messages can be controlled as follows:

  • Imbed a completely formatted HTML message first in the CA Spool file enclosed within MSGSTART=>> and <<MSGEND= email parameters. The message between MSGSTART=>> and <<MSGEND= is assumed to be completely formatted if it starts with <HTML>.
    Symbolic variables &DAT and &LNK can be used to have the date and Web Link name included in the message.
  • If the CA Spool file does not contain a completely formatted inline HTML message, the specified HTMLFORM or the file's form code is looked up in the HTMLIB library. If found, and starting with <HTML>, it is assumed to contain a completely formatted HTML message.
    HTMLIB HTML skeleton members can be used to give CA Spool files sent through email a common look and feel.
    Symbolic variables &DAT, &LNK and &MSG are replaced with the date, Web Link name as specified by the WEBLINK parameter and message text specified inline or using the OUTPUT statement ADDRESS or USERDATA parameters, respectively.
  • If HTMLFORM is not specified and there is no HTML member matching the form attribute of the file, a hard coded HTML skeleton containing &DAT and &MSG is used. The date and message text specified inline or by OUTPUT statement ADDRESS or USERDATA parameters are included. If the WEBLINK email parameter is specified, &LNK symbolic parameter is added to the skeleton to have an Attachment Web Link to the report data automatically added.
  • CBQ4OPTN member IQHTSAMP provides instructions for a demonstration of HTML message formatting and Web Link support.
  • All messages are translated according to the TRANS printer node parameter setting, if any is specified.
    Default: The standard IBM C EBCDIC-to-ASCII translate table is used.

Web Link Support

Reports do not have to be physically shipped to email inboxes. Instead, a Web link URL to a report can be included in an email message. When the link is clicked the report will automatically be viewed through the CA Spool Web Interface. The user has to provide a valid userid and password if the report is being viewed for the first time.

If you are using CA Spool's AFP-to-PDF transformer and you have specified that AFP files must be viewed as PDF files, when you click the link the file will be automatically converted to PDF and Acrobat Reader will be launched in a new Web Browser Window.

To specify that AFP files must be viewed as PDF documents, update $esfweb.ini parameter ESF_A2PD to 1, 2 or 3. The $esfweb.ini file can be found in the USS directory specified in your SMP/E proc and must be accessible by the Web Server.

Customization of the A2PDPARM dataset is also necessary. You must update the FdOutput parameter to contain the name of the swap directory used by the CA Spool Web Interface:

FdOutput='/cai/caspool/swap'

An email containing a Web Link to a CA Spool file automatically expires when the file retention expires in CA Spool.

To Email Print Files

To email CA Spool print files

  1. Define a new CA Spool printer with TCPDRIV=SMTP.
  2. Point TCPHOST and TCPPORT to the SMTP mail server.
  3. Queue the print files to the new SMTP printer.

You can specify the default email domain name using the TCPPRT parameter. The default email domain name is automatically appended to email addresses without domain names (no@domain).

For more information about defining printers, see the chapter Initialization.

Email Parameters

You can specify the following email parameters, separated by commas, using the printer's DRIVPRM1+4 parameters, the MAILBOOK or Writer specified MAILLIB email parameter members, the file's OUTPUT ADDRESS and OUTPUT USERDATA parameters or inline first in the print file before the print data:

FROM=from-address,
REPLYTO=reply-to-address,
TO=to-address,to-address1,to-address2, ... ,to-addressn,
CC=cc-address,cc-address1,cc-address2, ... ,cc-addressn,
BCC=bcc-address,bcc-address1,bcc-address2, ... ,bcc-addressn,
SUBJECT=subject,
FILENAME=attachment-file-name[.PDF/.PDFL/.HTML/.RTF/.MSG],
MSGTYPE=[TEXT | HTML],
WEBLINK=Web-link-name,
WEBHOST=Web-Interface- Host-Name,
WEBPORT=Web-Interface-Port,
HTMLFORM=HTML-skeleton-form,
MAILSTAT=[YES | NO | DELAY | FAILURE | SUCCESS],
MAILBOOK= mail-book-member,
MAILCOMB=[FILENAME | GROUPID | USERID],
DEFTOUSR=YES|NO,
MSGSTART=>> - start of inline message
<<MSGEND=    - end of inline message
MSG=message-body-text-lines  --  must be the last parameter coded
  • MSGTYPE=[TEXT | HTML] -- specifies if the message body must be Plain Text or HTML. The default is TEXT.
  • WEBLINK=link-name -- specifies the displayed name of the URL Link as shown in the HTML message body.
  • WEBHOST=HostName -- specifies the host name where the CA Spool Web Interface is active. The default is the local host name.
  • WEBPORT=Port -- specifies the port used by the CA Spool Web Interface. The default is 80.
  • HTMLFORM=Form -- specifies the name of the HTML skeleton to be included from HTMLIB. The default is the file's form code.
  • MAILSTAT=YES/NO/DELAY/FAILURE/SUCCESS -- Email Delivery Status Notifications.
  • MAILCOMB=FILENAME/GROUPID/USERID -- Sends an email with all queued files as attachments that have same the FILENAME, GROUPID or file creator’s USERID and have same TO=, CC= and BCC= email parameters. If XEQGRPID=JOBID and MAILCOMB=GROUPID are specified, all files created by a batch job with the same TO=, CC= and BCC= email parameters, are sent as one email with multiple file attachments.
  • DEFTOUSR=YES|NO Specifies the action to perform when an email has no TO= value defined:
    • YES - Sends the email to the userid that created the email.
    • NO - Holds the email.
    Default: YES
    The CA Spool transformers support most email parameters as inline data in the print file before the data is transformed. However, the following exceptions exist:
    • The CA Spool Java Transformers do not support the MAILCOMB and DEFTOUSR parameter as inline data.
    • The CA Spool C Transformers do not support the MAILCOMB, DEFTOUSR, MAILSTAT and MAILBOOK parameters as inline data.
  • MSG=message-body-text-lines -- If this parameter is passed as an inline email parameter, it must be the last parameter coded.
    The email is formatted as follows, for both MSGTYPE=HTML and MSGTYPE=TEXT (the default):
    • The first non-blank character on each line generates a new line.
    • If any line of the MSG parameter extends to column 60, no new lines are generated. Data from the next line continues immediately after the character in column 60 from the previous line.
  • The maximum length of FROM, REPLYTO, SUBJECT, FILENAME, WEBLINK and WEBHOST is 60 characters. The full 60 character length can be achieved through continuation on a second line.
  • If MSG= is specified with MSGSTART=>> and <<MSGEND=, the message body contains the MSG= data followed by the data between MSGSTART=>> and <<MSGEND=.
  • If MSG= is specified with a FILENAME that uses a .MSG extension, such as FILENAME=&FNM.MSG, the message body contains the MSG= data followed by the data in the CA Spool file.
  • If MSGSTART=>> and <<MSGEND= are specified with a FILENAME that uses a .MSG file extension, such as FILENAME=&FNM.MSG, the message body contains the data between MSGSTART=>> and <<MSGEND= and the file is attached as a .TXT attachment.

Replacement Variables

You can use the following replacement variables anywhere in the FROM, TO, CC, BCC, SUBJECT, and FILENAME parameters and anywhere in a HTML skeleton to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAT
    Include the current date in 'mm dd, yy' format. E.g. March 7, 2006
  • &DAW
    Include the current weekday in 'aaa, dd mmm, yyyy' format. E.g. Mon, 28 Mar 2006
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &HST
    Origin host name
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &LNK 
    Include Web Link name and URL to the report data
  • &MSG
    Include message text specified inline or by using the OUTPUT statement ADDRESS or USERDATA parameters.
    If first message line starts with a '<' the message is assumed to be in HTML format. If not, a simple line by line HTML formatting is performed.
    If message starts with '<HTML>' it is assumed to be a completely formatted HTML message and no HTMLIB FORM search will be performed.
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TOD
    Current time inThhmmssformat
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can select to include only part of the replacement variables by specifying offset and length in brackets after the replacement variable. For example:

&UID(1,4)

specifies that only characters 2 through 5 of the file creator's userid are to be used.

If you do not specify email parameters, the file is sent by email to the file creator's mailbox by default. The default values are:

FROM=&UID@&TCPPRT
TO=&UID@&TCPPRT
SUBJECT=File:99999 name: ccccccc - programmer's name field
FILENAME=&FNM.&PRM

Text PDF/PDFL/HTML/RTF Wrapping

If an input text file with a FILENAME extension equal to PDF, PDFL, HTML or RTF is selected, the file is automatically formatted and converted into the specified data-stream when the file is sent as an email attachment. PDFL generates a Linearized PDF

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and max record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported.

If the RTF wrapper is used and the input file's form attribute matches FORM=A4*, the output is formatted to A4 paper size.

If the input file's form attribute matches FORM=LET*, the output is formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Samples

The following is a sample email printer node definition:

DEFNODE EMAIL1,EMAIL-01,
TCPDRIV=SMTP,CLASS=ALL,ACQUIRE=WORK,RELEASE=NOWORK
NODE HP6M,EMAIL1,TCPHOST=USILDAMY,TCPPORT=25,TCPPRT=CA.COM,GROUP=2,
     DRIVPRM1='MAILSTAT=YES'

The following is a sample email DESTID definition, which automatically converts text files to PDF attachments:

DESTID QDEST=Hp6M, QFNAME=SV20*,
     FADDRES1='TO=USER01, USER02',
     FADDRES2='SUBJECT=FILE &FNO - &FNM',
     FADDRES3='FILENAME=&FNM.PDF'

The following is a sample print file with inline email parameters:

Spool    (ABCNI20 )           Browse File               Lin       1 of       9 
Sub ESF1 Nje          RN          RG       RU           Col       1 of      80 
                                                        Pag       1 of       1 
File   4565 Dest HP6M     Name SVINLINE                                        
-------------------------------------------------------------------------------
TO=ABCNI20@CA.COM                                                              
SUBJECT=test af . Ø Å og ..å                                                   
MSG=Hi Niels                                                                   
dette er en inline test af . Ø Å og ..å                                        
/Mvh Niels                                                                     
                                                                               
//OUT1  OUTPUT CLASS=W,DEST=HPA9,PRMODE=PAGE                           00035037
//OUT2  OUTPUT CLASS=A,DEST=DNCHGNPE,PRMODE=PAGE                       00036037
//OUT3  OUTPUT CLASS=W,DEST=HP60,PRMODE=PAGE,FORMDEF=P610              00037037
-------------------------------------------------------------------------------
Command ===>                                                                   
F1=Help F3=End F4=Return F5=Rfind F7=Up F8=Down F10=Left F11=Right 

Sending Email Using CA TCPaccess

To send CA Spool emails using CA TCPaccess SMTP Service, configure CA TCPaccess SMTP so that the CA TCPaccess SMTP mail server creates output using the same destination as the CA TCPaccess SPOOL#4 mail spooler. Incoming emails are then automatically queued for the CA TCPaccess USMTP - SMTP mail sender.

The following is an extract of a CA TCPaccess SMTP configuration file:

SMTP CYCLE(3 10 96)
  DIVERT(X 9999999)
  MX
  PATH(SNSTCP.V2.EMAIL1U)
  REMOTE(SM1U)
  ROUTE(A SM1U)
  RETURN(Y LOCAL)

SAR Print Driver

Use this print driver to automatically write all types of CA Spool print files, including PDF/HTML/RTF wrapped text files, directly into a CA View report database for archiving and viewing using the CA View 3270 online interface or using CA Output Management Web Viewer. Users can also view these files through Acrobat Reader, a web browser, or Microsoft Word.

The SAR print driver provides support for:

  • Text reports stored in EBCDIC without translation and with preservation of carriage control information
  • Automatic conversion of text files into PDF, HTML or RTF files while being written to a CA View report database

You can specify CA View report attributes and processing options:

  • On the printer level using the 64-byte TCPHOST parameter
  • On the printer level using the 4*60=240 bytes DRIVPRM1-4 parameters
  • On the print file level using the 4*60=240-byte OUTPUT ADDRESS parameter

You can specify this using JCL or have it be automatically assigned using CA Spool DESTID definitions.

Note: The TCPHOST parameter is processed first, DRIVPRM1-4 parameters second and the OUTPUT ADDRESS parameter is processed last.

If you specify a CA View parameter more than once, then the last specification is used.

If the TCPHOST parameter is not used to specify CA View parameters, then you must specify a dummy TCPHOST parameter to use the SAR print driver.

You can automatically generate unique identifying names; that is, you can specify that the CA View report name must be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

To Copy Print Files Unmodified

To copy CA Spool print files unmodified to CA View, define a new CA Spool printer driver with TCPDRIV=SAR and without any TRANS= parameter, and queue the print files to the new SAR printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the printer node TCPHOST parameter and using the file's OUTPUT ADDRESS parameters:

FILENAME=file-name[.PDF/.PDFL/.HTML/.RTF],
AM=SAR, (or TCPDRIV=SAR)
SAR=CA View-database-name

Replacement Variables

You can specify the following replacement variables anywhere in the FILENAME parameter to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

you have specified that only characters 2 through 5 of the file creator's name are to be used.

Text PDF/PDFL/HTML/RTF Wrapping

If an input text file with a FILENAME extension of PDF, PDFL, HTML or RTF is selected, the file is automatically formatted and converted into the specified data-stream as it is being written to CA View. PDFL generates a linearized PDF.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and max record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported. If the RTF wrapper is used and the input file's FORM=A4*, the output will be formatted to A4 paper size, and if the input file's FORM=LET*, the output will be formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Samples

A sample SAR printer node definition follows:

DEFNODE VIEW1,VIEW-01,TCPDRIV=SAR,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6DSAR,VIEW1,
     TCPHOST=VIEW,
	  DRIVPRM1='SAR=CAVIEW.DATABASE',
     GROUP=2

The following sample DESTID definition automatically converts text files to PDF and writes the PDF files to the CA View report database:

DESTID QDEST=HP6DSAR,QFNAME=SV11*,
     FADDRES1='FILENAME=&FNM.PDF'

JES Print Driver

Use this print driver to automatically write all types of CA Spool print files, including PDF/HTML/RTF wrapped text files, directly into CA Dispatch, CA Deliver, CA Bundl, or JES. These text files can then be converted to PDF/HTML/RTF reports before they are stored in CA Dispatch, CA View, and CA Bundl. From here they can be viewed using CA OM Web Viewer using Acrobat Reader, the native web browser, or Microsoft Word.

The JES print driver provides support for:

Text reports stored in EBCDIC without translation and with preservation of carriage control information

  • Automatic conversion of text files into PDF, HTML or RTF files while being written to CA Dispatch, CA Deliver, CA Bundl, or JES

You can specify JES report attributes and processing options:

  • On the printer level using the 64-byte TCPHOST parameter
  • On the printer level using the 4*60=240 bytes DRIVPRM1-4 parameters
  • On the print file level using the 4*60=240 byte OUTPUT ADDRESS parameter

You can specify this using JCL or have it be automatically assigned using CA Spool DESTID definitions.

Note: The TCPHOST parameter is processed first, DRIVPRM1-4 parameters second and the OUTPUT ADDRESS parameter is processed last.

If you specify a JES parameter more than once, then the last specification is used.

If the TCPHOST parameter is not used to specify JES parameters, then you must specify a dummy TCPHOST parameter to use the JES print driver.

You can automatically generate unique identifying names; that is, you can specify that the JES job name must be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

To Copy Print Files Unmodified

To copy CA Spool print files unmodified to JES, define a new CA Spool printer driver with TCPDRIV=JES and without any TRANS= parameter, and queue the print files to the new JES printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the printer node TCPHOST parameter and using the file's OUTPUT ADDRESS parameters:

FILENAME=file-name[.PDF/.PDFL/.HTML/.RTF],
AM=JES  		(or TCPDRIV=JES)

Replacement Variables

You can specify the following replacement variables anywhere in the FILENAME parameter to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

You have specified that only characters 2 through 5 of the file creator's name are to be used.

Text PDF/PDFL/HTML/RTF Wrapping

If an input text file with a FILENAME extension equal to PDF, PDFL, HTML or RTF is selected, the file is automatically formatted and converted into the specified data-stream as it is being written. PDFL specifies that Linearized PDF must be generated.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and max record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported. If the RTF wrapper is used and the input file's FORM=A4*, the output will be formatted to A4 paper size, and if the input file's FORM=LET*, the output will be formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Samples

A sample JES printer node definition follows:

DEFNODE JES1,JES-01,TCPDRIV=JES,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6DJES,JES1,
     TCPHOST='DUMMY',
     GROUP=2

The following sample DESTID definition automatically converts text files to HTML and writes the HTML files to JES:

DESTID QDEST=HP6DJES,QFNAME=SV11*,
     FADDRES1='FILENAME=&FNM.HTML'

ESF Print Driver

Use this print driver to automatically write all types of CA Spool print files, including PDF/HTML/RTF wrapped text files, directly into the same or another CA Spool system.

The ESF print driver provides support for:

  • Text reports stored in EBCDIC without translation and with preservation of carriage control information
  • Automatic conversion of text files into PDF, HTML or RTF files while being written to a CA Spool system

You can specify ESF report attributes and processing options:

  • On the printer level using the 64-byte TCPHOST parameter
  • On the printer level using the 4*60=240 bytes DRIVPRM1-4 parameters
  • On the print file level using the 4*60=240 byte OUTPUT ADDRESS parameter

You can specify this using JCL or have it be automatically assigned using CA Spool DESTID definitions.

Note: The TCPHOST parameter is processed first, DRIVPRM1-4 parameters second and the OUTPUT ADDRESS parameter is processed last.

If you specify an ESF print driver parameter more than once, then the last specification is used. If the TCPHOST parameter is not used to specify ESF parameters, then you must specify a dummy TCPHOST parameter to use the ESF print driver.

You can automatically generate unique identifying names; that is, you can specify that the ESF file name must be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

To Copy Print Files Unmodified

To copy CA Spool print files unmodified to a CA Spool system, define a new CA Spool printer driver with TCPDRIV=ESF and without any TRANS= parameter, and queue the print files to the new ESF printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the printer node TCPHOST parameter and using the file's OUTPUT ADDRESS parameters:

FILENAME=file-name[.PDF/.PDFL/.HTML/.RTF],
AM=ESF,  		(or TCPDRIV=ESF)
ESF=CA Spool-Subsystem-name

Replacement Variables

You can specify the following replacement variables anywhere in the FILENAME parameter to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

you have specified that only characters 2 through 5 of the file creator's name are to be used.

Text PDF/PDFL/HTML/RTF Wrapping

If an input text file with a FILENAME extension equal to PDF, PDFL, HTML or RTF is selected, the file is automatically formatted and converted into the specified data-stream as it is being written to CA Spool. PDFL generates linearized PDF.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and max record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported. If the RTF wrapper is used and the input file's FORM=A4*, the output will be formatted to A4 paper size, and if the input file's FORM=LET*, the output will be formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Samples

A sample ESF printer node definition follows:

DEFNODE ESF1,ESF-01,TCPDRIV=ESF,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6DESF,ESF1,
     TCPHOST=ESF1,
     DRIVPRM1='ESF=ESF1',
     GROUP=2

The following sample DESTID definition automatically converts text files to RTF and writes the RTF files to CA Spool:

DESTID QDEST=HP6DESF,QFNAME=SV11*,
     FADDRES1='FILENAME=&FNM.RTF'

FTP Print Driver

Use this print driver to automatically FTP transfer all types of CA Spool print files, including PDF/HTML/RTF wrapped text files, directly to a remote FTP server for further processing.

The FTP print driver provides support for:

  • Text reports stored in EBCDIC without translation and with preservation of carriage control information
  • Automatic conversion of text files into PDF, HTML or RTF files while being transferred to a remote FTP server.

You can specify FTP report attributes and processing options:

  • On the printer level using the using the 4*60=240 bytes DRIVPRM1-4 parameters.
  • On the print file level using the 4*60=240 byte OUTPUT ADDRESS parameters.

You can specify this using JCL or have it be automatically assigned using CA Spool DESTID definitions.

If you specify an FTP print driver parameter more than once, then the last specification is used.

You can automatically generate unique identifying names; that is, you can specify that the FILENAME= remote-file-name must be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

NETRC Data Set

The NETRC data set provides you with an alternative to specifying your userid and password as FTP parameters when you want to FTP to a remote host.

To use the NETRC data set you need to activate the following DD statement in the JCL procedure for CA Spool:

//*-------------------------------------------------------------------*
//*  Common FTP, CA XCOM and Connect:Direct userid/password file      *
//*-------------------------------------------------------------------*
//NETRC    DD  DISP=SHR,DSN=&PARMLIB(IQNETRC)                          

The supplied CBQ4PARM(IQNETRC) sample contains the following sample definitions:

*                                                            
*  Common FTP, CA XCOM and Connect:Direct userid/password file
*                                                            
machine ftp.com                          login userid1 password pass1
machine 111.222.33.44                    login uesrid2 password pass2
machine XCOM.IPNAME.com                  login uesrid3 password pass3
machine XCOMLUx                          login uesrid4 password pass4
machine XCOMGROUPx                       login uesrid5 password pass5
machine ConnectDirect                    login uesrid6 password pass6

If no FTPUSER and FTPPASS parameters are specified on a FTP request, the remote FTP machine is looked up in the NETRC data set. If the machine is found, its password is used.

If the FTPUSER is specified without FTPPASS, the FTP machine and the FTPUSER is looked up in the NETRC data set. If the machine is found, its password is used.

If the NETRC data set is used, it must be secured against unauthorized read and write access.

Transfer Print Files to a Remote FTP Server

To transfer CA Spool print files to a remote FTP server

  1. Define a new CA Spool printer with TCPDRIV=FTP.
  2. Point TCPHOST and TCPPORT to the remote FTP server.
  3. Create new CA Spool print files with FILENAME, FTPUSER and FTPPASS parameters specified via OUTPUT ADDRESS parameters to the new FTP printer.

Transfer Files to a Remote FTPS Server

Use the CA Spool FTP print driver to transfer files to a remote FTP server that requires SSL/TLS for file transfers.

Follow these steps:

  1. Securely export the certificate for the remote server to a system running CA Spool.
    Note: For instructions to export the certificate, see the documentation for the security software for the server.
  2. Add the server certificate to a keyring of the userid that is assigned to the CA Spool task.
    Note: For instructions to create a keyring for a user and to add a certificate stored in a dataset, see the documentation for the security software for your environment. If the server certificate is not self-signed, add a signer’s Certification Authority (CA) certificate to the keyring.
  3. Copy the sample FTP.DATA file from TCPIP.SEZAINST(FTCDATA) to a data set of your choice. To specify the location of FTP.DATA, use the DRIVPRMx=’FTPDATA=data.set.name’ option of the NODE statement. An example follows:

    NODE FTPS,TCPIP,TCPDRIV=FTP,TCPPORT=21,TCPHOST=ftps.domain.com
         DRIVPRM1='FTPDATA=FTP.DATA'
    
  4. Open the FTP.DATA file for editing and add or modify the following statements.

    SECURE_MECHANISM  TLS                 ; Sends AUTH TLS command 
    KEYRING           esfuid/keyring name ; Specifies keyring name 
    SECURE_DATACONN   PRIVATE             ; Client requires data to be transferred enciphered
    

    If the CA Spool NODE parameter specifies either the TCPDRIV=FTPT or TCPDRIV=FTPe option, the following line is written to FTP client log:

    ESF Using 'FTP.DATA' for local site configuration parameters
    

    Note: For more information about FTP.DATA file statements, see the z/OS Communications Server: IP Configuration Reference. For more information about how to use AT-TLS and how to implement FTP client authentication using certificates, see the z/OS Communications Server: IP Configuration Guide: see the section for customizing the FTP server for Transport Layer Security (TLS). For information to diagnose Secure Socket Layer (SSL) function return codes, see the z/OS Cryptographic Services System SSL Programming Guide.

    Important! We strongly recommend securing connections with TLS instead of SSL.

CA Top Secret Example

This example explains how to export the certificate of an FTP server and add it to CA Spool started task userid. This example applies if CA Top Secret is the security software for your environment.

  1. Enter the following command to export the certificate to a dataset to transfer to the client:

    TSS EXPORT(FTPD) DIGICERT(FTPDCERT) DCDSN('FTPS.SERVER.CERT')
    
  2. Enter the following commands to add the server certificate to the userid for the CA Spool task:

    TSS ADDTO(CASPOOL) DIGICERT(FTPDCERT) DCDSN('FTPS.SERVER.CERT')
    TSS REPLACE(CASPOOL) DIGICERT(FTPDCERT) TRUST
    
  3. Enter the following command to create the keyring for the CA Spool task userid:

    TSS ADD(CASPOOL) KEYRING(ESFRING) LABLRING(ESFRING)
    
  4. Add the FTP server certificate to the keyring for the CA Spool task userid:

    TSS ADDTO(CASPOOL) KEYRING(ESFRING) RINGDATA(CASPOOL,FTPDCERT) DEFAULT - USAGE(PERSONAL)  
    
  5. If the server certificate is not self-signed, export the Certification Authority (CA) certificate of the signer and add it to the keyring, as follows:
    Enter the following command at the server:

    TSS EXPORT(CERTAUTH) DIGICERT(CACERT) DCDSN('FTPS.SERVER.CACERT')
    

    Enter the following commands at the client:

    TSS ADDTO(CERTAUTH) DIGICERT(CACERT) DCDSN('FTPS.SERVER.CACERT')
    TSS ADDTO(CASPOOL) KEYRING(ESFRING) RINGDATA(CERTAUTH,CACERT) - USAGE(CERTAUTH)
    
  6. Enter the following commands to permit CA Spool to work with digital certificates:

    TSS ADDTO(deptacid) IBMFAC(IRR.)
    TSS PER(CASPOOL) IBMFAC(IRR.DIGTCERT.GENCERT) ACC(UPDATE)
    TSS PER(CASPOOL) IBMFAC(IRR.DIGTCERT.LISTRING) ACC(UPDATE)
    TSS PER(CASPOOL) IBMFAC(IRR.DIGTCERT.LIST) ACC(UPDATE)
    

Note: For more information about CA Top Secret commands and keywords, see the CA Top Secret for z/OS documentation.

CA ACF2 Example

This example explains how to export the certificate of an FTP server and add it to CA Spool started task userid. This example applies if CA ACF2 is the security software for your environment.

  1. Enter the following command to export the certificate to a dataset to transfer to the client:

    ACF
    EXPORT FTPD DSNAME('FTPS.SERVER.CERT') LABEL(FTPDCERT)
    
  2. Enter the following commands to add the server certificate to the CA Spool task userid:

    ACF 
    SET PROFILE(USER) DIV(CERTDATA)       
    INSERT CASPOOL.suffix DSNAME('FTPS.SERVER.CERT') LABEL(FTPDCERT) TRUST
    
  3. Enter the following command to create the keyring for the CA Spool task userid:

    ACF 
    SET PROFILE(USER) DIV(KEYRING)  
    INSERT CASPOOL.suffix RINGNAME(ESFRING)
    
  4. Add the FTP server certificate to the keyring for the CA Spool task userid:

    ACF 
    CONNECT CERTDATA(CASPOOL.suffix) LABEL(FTPDCERT) KEYRING(CASPOOL.suffix) + RINGNAME(ESFRING) USAGE(PERSONAL) DEFAULT  
    
  5. If the server certificate is not self-signed, export the Certification Authority (CA) certificate of the signer and add it to the keyring, as follows:
    Enter the following command at the server:

    ACF 
    EXPORT CERTAUTH DSNAME('CHQA.SERVER.CACERT') LABEL(CACERT)
    

    Enter the following commands at the client:

    ACF 
    SET PROFILE(USER) DIV(CERTDATA)
    INSERT CERTAUTH.suffix DSNAME('FTPS.SERVER.CACERT') LABEL(CACERT) TRUST
    CONNECT CERTDATA(CERTAUTH.suffix) LABEL(CACERT) KEYRING(CASPOOL.suffix) + RINGNAME(ESFRING) USAGE(CERTAUTH) 
    
  6. Enter the following commands to permit CA Spool to work with digital certificates:

    ACF
    SET RESOURCE(FAC)                                                    
     COMPILE * STORE                                                     
      $KEY(IRR) TYPE(FAC)                                                
      DIGTCERT.GENCERT  UID(*************CASPOOL) SERVICE(READ,UPDATE) ALLOW
      DIGTCERT.LIST     UID(*************CASPOOL) SERVICE(READ,UPDATE) ALLOW
      DIGTCERT.LISTRING UID(*************CASPOOL) SERVICE(READ,UPDATE) ALLOW
      END                                                                
      STORE                                                              
    F ACF2,REBUILD(FAC)                                                  
    

Note: For more information about CA ACF2 commands and keywords, see the CA ACF2 for z/OS documentation.

RACF Example

This example explains how to export the certificate of an FTP server and add it to CA Spool started task userid. This example applies if RACF is the security software for your environment.

  1. Enter the following command to export the certificate to a dataset to transfer to the client:

    RACDCERT EXPORT(LABEL('FTPDCERT'))  ID(FTPD) DSN('FTPS.SERVER.CERT')
    
  2. Enter the following commands to add the server certificate to the CA Spool task userid:

    RACDCERT ID(CASPOOL) ADD('FTPS.SERVER.CERT') WITHLABEL('FTPDCERT') TRUST
    
  3. Enter the following command to create the keyring for the CA Spool task userid:

    RACDCERT ID(CASPOOL) ADDRING(ESFRING)
    
  4. Add the FTP server certificate to the keyring for the CA Spool task userid:

    RACDCERT ID(CASPOOL) CONNECT(ID(CASPOOL) LABEL('FTPDCERT') RING(ESFRING) + USAGE(PERSONAL))  
    
  5. If the server certificate is not self-signed, export the signer's Certification Authority (CA) certificate and add it to the keyring, as follows:
    Enter the following command at the server:

    RACDCERT EXPORT(LABEL('CACERT')) CERTAUTH DSN('FTPS.SERVER.CACERT')
    

    Enter the following commands at the client:

    RACDCERT CERTAUTH ADD('FTPS.SERVER.CACERT') WITHLABEL('CACERT') TRUST
    RACDCERT ID(CASPOOL) CONNECT(CERTAUTH LABEL('CACERT') RING(ESFRING) + USAGE(CERTAUTH))
    
  6. Enter the following commands to permit CA Spool to work with digital certificates:

    RDEFINE FACILITY IRR.DIGTCERT.LISTRING UACC(NONE)
    RDEFINE FACILITY IRR.DIGTCERT.LIST UACC(NONE)
    RDEFINE FACILITY IRR.DIGTCERT.GENCERT UACC(NONE)
    PERMIT IRR.DIGTCERT.LISTRING CL(FACILITY) ID(CASPOOL)  ACCESS(UPDATE)
    PERMIT IRR.DIGTCERT.LIST CL(FACILITY) ID(CASPOOL)  ACCESS(UPDATE)
    PERMIT IRR.DIGTCERT.GENCERT CL(FACILITY) ID(CASPOOL)  ACCESS(UPDATE)
    SETROPTS RACLIST(FACILITY) REFRESH
    

Note: For more information about RACF commands and keywords, see the IBM z/OS Security Server RACF Command Language Reference.

FTP Print Files Unmodified

To transfer CA Spool print files unmodified to a remote FTP server, define a new CA Spool printer driver with TCPDRIV=FTP and without any TRANS=parameter, and queue the print files to the new FTP printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the file's OUTPUT ADDRESS parameters:

PATH=remote-directory, 
FILENAME=remote-file-name[.PDF/.PDFL/.HTML/.RTF],
FTPUSER= remote-userid,
FTPPASS= remote-password, 
FTPACCT= remote-account-info,   
FTPAUTH= NEVER|GSSAPI|TLS
FTPDATA= FTP.DATA file
DSNAME=temp-data-set-name,
DISP=NEW|MOD|OLD|SHR,
UNIT=device-type,
VOLSER=volume-serial-number,
RECFM=F|V,
LRECL=99999,
DATACLAS=temp-data-set-SMS-data-class-name,
MGMTCLAS=temp-data-set-SMS-management-class-name,
STORCLAS=temp-data-set-SMS-storage-class-name,
AM=FTP, (or TCPDRIV=FTP)

PATH and FILENAME are combined to form the complete remote target directory and file name. This extends the value used to a maximum of 106 characters.

Replacement Variables

You can specify the following replacement variables anywhere in the FILENAME, FTPUSER, FTPPASS, FTPACCT and DSNAME parameters to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

you have specified that only characters 2 through 5 of the file creator's name are to be used.

If you do not specify JCL parameters, the following default JCL parameter are used:

FTPUSER=&UID
FILENAME=&UID.&NOD.&FNM.&FNO
DSNAME=&UID.&NOD.&FNM.&FNO,DISP=NEW

Wrapping for Text, PDF, PDFL, HTML, and RTF

If the FILENAME extension of an input text file equals PDF, PDFL, HTML or RTF, the file is automatically formatted and converted into the specified data-stream before it is transferred. PDFL generates Linearized PDF.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the Form, Chars, channel skips, and max record length of the file. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both of the following are supported: TCPDRIV option H - page length auto formatting (the default) and TCPDRIV option F - FCB-length based auto formatting.

If the RTF wrapper is used and FORM=A4* in the input file, the output is formatted to A4 paper size. If FORM=LET* in the input file, the output is formatted to letter paper size.

Note: Separator pages are not supported for files that you create using CA Spool Text Wrapping support. ESFU010X is not called for files of this type.

Samples

A sample FTP printer node definition follows:

DEFNODE FTP1,FTP-01,TCPDRIV=FTP,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6DFTP,FTP1,
     TCPHOST=ftp.com,
     TCPPORT=21, 
     DRIVPRM1='DSNAME=PUBLIC.&UID.&NOD.&FNO',
     GROUP=2

The following sample DESTID definition automatically converts text files to PDF and transfers the PDF files to the remote FTP host:

DESTID QDEST=HP6DFTP,QFNAME=SV11*,
     DADDRES1='FTPUSER=anonymous,FTPPASS=guest',    
     FADDRES2='FILENAME=/tmp/&UID/&FNM.PDFL'

XCOM Print Driver

Use this print driver to automatically transfer all types of CA Spool print files, including PDF/HTML/RTF wrapped text files, using CA XCOM Data Transport directly to remote XCOM servers running on various platforms for further processing.

The XCOM print driver provides support for:

  • Text reports stored in EBCDIC without translation and with preservation of carriage control information
  • Automatic conversion of text files into PDF, HTML or RTF files while being transferred to a remote XCOM server.

You can specify XCOM report attributes and processing options:

  • On the printer level using the 64-byte TCPHOST parameter.
  • On the printer level using the using the 4*60=240 bytes DRIVPRM1-4 parameters.
  • On the print file level using the 4*60=240 byte OUTPUT ADDRESS parameter

You can specify this using JCL or have it be automatically assigned using CA Spool DESTID definitions.

Note: TCPHOST parameter is processed first, DRIVPRM1-4 parameters second and OUTPUT ADDRESS parameter is processed third.

If you specify an XCOM print driver parameter more than once, then the last specification is used. If the TCPHOST parameter is not used to specify XCOM parameters, then you must specify a dummy TCPHOST parameter to use the XCOM print driver.

You can automatically generate unique identifying names; that is, you can specify that the FILENAME= remote-file-name must be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

XCOM CA Spool JCL

To use the XCOM print driver you need to add the following DD statements to the JCL procedure for CA Spool:

//STEPLIB  DD
//         DD  DISP=SHR,DSN=CAI.XCOM.CBGXLOAD 
. . .
//*-------------------------------------------------------------------*
//*  Common FTP, CA XCOM and Connect:Direct userid/password file      *
//*-------------------------------------------------------------------*
//NETRC    DD  DISP=SHR,DSN=&PARMLIB(IQNETRC)                          
//*-------------------------------------------------------------------*
//*  CA XCOM libraries.                                               *
//*-------------------------------------------------------------------*
//XCOMCNTL DD  DISP=SHR,DSN=CAI.XCOM.CBXGPARM              
//XCOMSYSI DD  DISP=SHR,DSN=&PARMLIB(IQXCOMPR)              
//SYSIN01  DD  DSN=&SYSIN01,UNIT=SYSDA,SPACE=(TRK,(1,1))   
//LCLDS01  DD  DSN=&LCLDS01,UNIT=SYSDA,SPACE=(CYL,(10,10)) 

XCOM SYSIN01 Parameters

Sample XCOM SYSIN01 parameters are supplied in member IQXCOMPR in CBQ4PARM. During XCOM file transfer these parameters are merged with the CA Spool specified XCOM parameters and written to DD SYSIN01 for processing by CA XCOM.

NETRC Data Set

The NETRC data set provides you with an alternative to specifying your userid and password as XCOM parameters when you want to use CA XCOM to transfer a file to a remote CA XCOM server.

The supplied CBQ4PARM(IQNETRC) sample contains the following sample definitions:

*                                                            
*  Common FTP, CA XCOM and Connect:Direct userid/password file
*                                                            
machine ftp.com			login userid1 password pass1 
machine 111.222.33.44		login uesrid2 password pass2 
machine XCOM.IPNAME.com		login uesrid3 password pass3 
machine XCOMLUx			login uesrid4 password pass4 
machine XCOMGROUPx			login uesrid5 password pass5 
machine ConnectDirect		login uesrid6 password pass6 

If no USERID or PASSWORD parameters are specified on a XCOM request, the remote XCOM IPNAME.LU or GROUP parameter is looked up in the NETRC data set. If it is found, the corresponding login userid and password are used.

If the USERID is specified without a PASSSWORD the remote XCOM IPNAME. LU or GROUP parameter and the USERID is looked up in the NETRC data set and if found the corresponding password will be used.

If the NETRC data set is used it must be secured against unauthorized read and write access.

To Transfer Print Files

To transfer CA Spool print files to a remote XCOM server

  1. Define a new CA Spool printer with TCPDRIV=XCOM.
  2. Define TCPHOST=DUMMY.
  3. Create new CA Spool print files with FILENAME, USERID and PASSWORD parameters specified via OUTPUT ADDRESS parameters to the new XCOM printer.

To Transfer Print Files Unmodified

To transfer CA Spool print files unmodified to a remote XCOM server, define a new CA Spool printer driver with TCPDRIV=XCOM and without any TRANS=parameter, and queue the print files to the new XCOM printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the file's OUTPUT ADDRESS parameters:

PATH=remote-directory, 
FILENAME= remote-file-name[.PDF/.PDFL/.HTML/.RTF],
USERID= remote-userid,
PASSWORD= remote-password, 
ACBNAME= local-ACBNAME,
DOMAIN= remote-domain,
GROUP= remote-GROUP, 
IPNAME= remote-IP-host,
IPPORT= remote-IP-port,
LU= remote-LU,     
DISP=NEW|OLD,
AM=XCOM (or TCPDRIV=XCOM)

PATH and FILENAME are combined to form the complete remote target directory and file name. This extends the value used to a maximum of 106 characters.

Replacement Variables

You can specify the following replacement variables anywhere in the FILENAME, USERID, and PASSWORD parameters to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

you have specified that only characters 2 through 5 of the file creator's name are to be used.

If you do not specify JCL parameters, the following default JCL parameter are used:

USERID=&UID
FILENAME=&UID.&NOD.&FNM.&FNO

Text PDF/PDFL/HTML/RTF Wrapping

If an input text file with a FILENAME extension equal to PDF, PDFL, HTML or RTF is selected, the file is automatically formatted and converted into the specified data-stream as it is being written to disk. PDFL specifies that Linearized PDF must be generated.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and max record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported. If the RTF wrapper is used and the input file's FORM=A4*, the output will be formatted to A4 paper size, and if the input file's FORM=LET*, the output will be formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Samples

The following is a sample XCOM printer node definition:

DEFNODE XCOM1,XCOM-01,TCPDRIV=XCOM,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6DXCOM,XCOM1,
     TCPHOST='ACBNAME=XCOM',
     DRIVPRM1='IPNAME=111.222.333.44',    
     GROUP=2

The following sample DESTID definition automatically converts text files to PDF and transfers the PDF files to a remote XCOM host:

DESTID QDEST=HP6DXCOM,QFNAME=SV11*,
     DADDRES1='USERID=RUSERID,PASSWORD=RPASSWORD',    
     FADDRES2='FILENAME=PUBLIC.&UID.&FNM.&FNO.PDF'

Connect Direct Print Driver

Use this print driver to automatically transfer all types of CA Spool print files, including PDF/HTML/RTF wrapped text files, using Sterling Commerce's Connect:Direct file transfer product to remote Connect:Direct servers running on various platforms for further processing.

The Connect:Direct print driver provides support for:

  • Text reports stored in EBCDIC without translation and with preservation of carriage control information
  • Automatic conversion of text files into PDF, HTML or RTF files while being transferred to a remote Connect:Direct server.

You can specify Connect:Direct report attributes and processing options:

  • On the printer level using the 64-byte TCPHOST parameter.
  • On the printer level using the using the 4*60=240 bytes DRIVPRM1-4 parameters.
  • On the print file level using the 4*60=240 byte OUTPUT ADDRESS parameter

You can specify this using JCL or have it be automatically assigned using CA Spool DESTID definitions.

Note: TCPHOST parameter is processed first, DRIVPRM1-4 parameters second and OUTPUT ADDRESS parameter is processed third.

If you specify an Connect:Direct print driver parameter more than once, then the last specification is used. If the TCPHOST parameter is not used to specify Connect:Direct parameters, then you must specify a dummy TCPHOST parameter to use the Connect:Direct print driver.

You can automatically generate unique identifying names; that is, you can specify that the FILENAME= remote-file-name must be synthesized from userid, destination, file name, file number, date, time, job number, job name, job class, job step, proc step, DD name, and fixed text.

Connect Direct CA Spool JCL

To use the Connect:Direct print driver you need to add the following DD statements to the JCL procedure for CA Spool:

//STEPLIB  DD
//         DD  DISP=SHR,DSN=$CD.LINKLIB       * Connect:Direct Load Lib
. . .
//*-------------------------------------------------------------------*
//*  Common FTP, CA XCOM and Connect:Direct userid/password file      *
//*-------------------------------------------------------------------*
//NETRC    DD  DISP=SHR,DSN=&PARMLIB(IQNETRC)                          
. . .
//*-------------------------------------------------------------------*
//*  Connect:Direct libraries.                                        *
//*-------------------------------------------------------------------*
//DMNETMAP  DD  DISP=SHR,DSN=$CD.NETMAP                               
//DMPUBLIB  DD  DISP=SHR,DSN=$CD.PROCESS                              
//DMMSGFIL  DD  DISP=SHR,DSN=$CD.MSG                                  
//DMPRINT   DD  SYSOUT=*                                              

NETRC Data Set

The NETRC data set provides you with an alternative to specifying your user_id and password as Connect:Direct parameters when you want to use Connect:Direct to transfer a file to a remote Connect:Direct server.

The supplied CBQ4PARM(IQNETRC) sample contains the following sample definitions:

*                                                            
*  Common FTP, CA XCOM and Connect:Direct userid/password file
*                                                            
machine ftp.com			login userid1 password pass1 
machine 111.222.33.44		login uesrid2 password pass2 
machine XCOM.IPNAME.com		login uesrid3 password pass3 
machine XCOMLUx			login uesrid4 password pass4 
machine XCOMGROUPx			login uesrid5 password pass5 
machine ConnectDirect		login uesrid6 password pass6 

If no USERID or PASSWORD parameters are specified on a Connect:Direct request, the PNODE - local node parameter is looked up in the NETRC data set. If it is found, the corresponding login userid and password are used.

If the USERID is specified without a PASSWORD, the PNODE - local node parameter and the USERID are looked up in the NETRC data set. If they are found, the corresponding password is used.

If you use the NETRC data set, secure it against unauthorized read and write access.

To Transfer Print Files

To transfer CA Spool print files to a remote Connect:Direct server

  1. Define a new CA Spool printer with TCPDRIV=C:D.
  2. Define TCPHOST=DUMMY.
  3. Create new CA Spool print files with FILENAME, USERID and PASSWORD parameters specified via OUTPUT ADDRESS parameters to the new Connect:Direct printer.

Default Proc for Connect Direct transfers

The default proc for Connect:Direct file transfers is COPY. The default proc for binary transfers of files such as those created by CA Spool's wrapper support or those specifying FCB=ASIS is COPYCF.

Binary Transfers

If the target destination of a binary transfer is not a mainframe, specify TOENVIR=NT|WS.

If the target destination of a binary transfer is a mainframe, do not specify TOENVIR=NT|WS.

Important! Enclose the parameter= value statements in single quotation marks, as shown in the example.

If the target operating system uses forward slashes (/) to delimit path names, use the TOENVIR=NT parameter.

If the target operating system uses backslashes (\) to delimit path names, use the TOENVIR=WS parameter.

For example, the following DRIVPRMn node parameters enable a transfer to a Windows directory using the Connect:Driver print driver:

DRIVPRM1='TOENVIR=WS'
DRIVPRM2='PATH=C:\CDALTDIR\,FILENAME=NEWFILE.&FNO.&TIM.PDF',
DRIVPRM3='DSNAME=HLQ.&FNO.&TIM',
DRIVPRM4='STORCLAS=TSO'

To Transfer Print Files Unmodified

To transfer CA Spool print files unmodified to a remote Connect:Direct server, define a new CA Spool printer driver with TCPDRIV=C:D and without any TRANS= parameter, and queue the print files to the new Connect:Direct printer.

JCL Parameters

You can specify the following JCL parameters, separated by commas, using the file's OUTPUT ADDRESS parameters:

PATH=remote-directory,
FILENAME= remote-file-name[.PDF/.PDFL/.HTML/.RTF],
USERID= local-userid,
PASSWORD= local-password,
PROC= procedure-name,
PNODE= local-node,
SNODE= target-node,
SNODEID= target-node-userid,
SNODEPW= target-node-password,
TOENVIR=NT|WS,
LU= remote-LU,
DSNAME=temp-data-set-name,
DISP=NEW|MOD|OLD|SHR,
UNIT=device-type,
VOLSER=volume-serial-number,
RECFM=F|V,
LRECL=99999,
DATACLAS=temp-data-set-SMS-data-class-name,
MGMTCLAS=temp-data-set-SMS-management-class-name,
STORCLAS=temp-data-set-SMS-storage-class-name,
AM=C:D (or TCPDRIV=C:D)
CDSYSOPT= p1/p2/p3
CDMDELAY = UNLIMITED|SUPPRESS

PATH and FILENAME will be combined to form the complete remote target directory and file name. This extends the value used to a maximum of 106 characters.

For binary transfers, if the COPYCF proc is not specified or taken as a default, the &DSN1 and &DSN2 variables will be passed to the custom proc for optional use. They will have the same values as what would have been passed to a non-binary transfer. This may also help in the formation of a long directory structure and file name combination.

CDSYSOPT 

Up to 50 characters of data can be passed using the CDSYSOPT parameter.

For example,

DRIVPRM1='CDSYSOPT=DATATYPE=text/XLATE=yes/STRIP.BLANKS=yes'

or

DESTID QDEST=CDDEST1,FLRECL=133,
FADDRES1='USERID=USER0001,PASSWORD=ABCD',
FADDRES2='FILENAME=TARGET.FILE',
FADDRES3='DSNAME=TEMP.FILE',
FADDRES4='CDSYSOPT=XLATE.TBL(TABLE02.CDX)'

Separate multiple SYSOPTS values with a '/'. Embedded blanks are not supported. Free form parameters containing '/' are not supported. Both instances will yield unexpected results and are unlikely to send the file.

CDSYSOPT= is not supported and is ignored for binary file transfers.

In most cases, it is required to use a unique process to take advantage of the CDSYSOPT parameter. The data in the CDSYSOPT parameter is passed as &SYSOPTS to Connect:Direct and the '/' delimiters are changed to blanks. The default COPY process does not expect to have an &SYSOPTS variable passed to it and ignores it. A new process must be built similar to this COPY process to facilitate passing the required data:

PROCXLT PROCESS SNODE=BSBABC1234 -
        CLASS=4 &DISP=RPL
STEP01 COPY FROM (DSN=&DSN1 DISP=SHR -
                 PNODE) -
            TO   (DSN=&DSN2 -
                 DISP=&DISP -
                 SNODE -
                 SYSOPTS=&SYSOPTS) -
                 COMPRESS EXT

This example is for illustration only. See Connect:Direct support for questions regarding the specific syntax.

Add the new process name to the PROC=parameter, to pass the name to the C:D print driver.

CDMDELAY

CDMDELAY=UNLIMITED is the default. This setting enables CA Spool to report the final status of the file transfer correctly to Connect:Direct.

Use CDMDELAY=SUPRRESS in debugging situations only. When SUPPRESS is specified and MAXDELAY=UNLIMITED is not set in the C:D process, CA Spool is notified that the process has been queued. However, the final status of the session is not known. The C:D driver ends the session (using SIGNOFF) and attempts to delete the temporary file that was created and passed to the Connect:Direct API.

When you use CDMDELAY=SUPRRESS, the delete might fail because Connect:Direct is still using that temporary file. In that case, the CA Spool file is held, regardless of whether Connect:Direct eventually finishes the transfer successfully. Consequently, you must manually clean up the temporary dataset and the CA Spool file.

Replacement Variables

You can specify the following replacement variables anywhere in the FILENAME, USERID and PASSWORD parameters to have appropriate unique names dynamically generated:

  • &CLS
    Print file class
  • &DAY
    Current date in Dyymmdd format
  • &DDN
    DD name of the print file creator
  • &FNM
    Print file name
  • &FNO
    Print file number
  • &FRM
    Print file form number
  • &JID
    Job, STC or TSU id of the print file creator
  • &JOB
    Jobname of the print file creator
  • &JST
    Job step name of the print file creator
  • &JUL
    Current date in Julian Dyyddd format
  • &NOD
    Print file destination name
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information
  • &PRM
    Print file print-mode
  • &PST
    Proc step name of the print file creator
  • &TIM
    Current time in Thhmmss format
  • &TTL
    File Output Title
  • &UID
    Userid of the print file creator
  • &WTR
    Print file Remote Destination or Remote Writer

You can specify that only part of the replacement variable be used by specifying offset and length in brackets after the variable. For example, if you enter:

&UID(1,4)

you have specified that only characters 2 through 5 of the file creator's name are to be used.

If you do not specify JCL parameters, the following default JCL parameter are used:

USERID=&UID
FILENAME=&UID.&NOD.&FNM.&FNO

Wrapping for Text, PDF, PDFL, HTML, and RTF Files

If an input text file with a FILENAME extension of PDF, PDFL, HTML or RTF is selected, the file is automatically formatted and converted into the specified data-stream as it is being transferred to a remote Connect:Direct server.

PDFL generates linearized PDF.

The formatting and paper size, orientation, and font style (family, pitch, style, and stroke weight) are controlled by the file's Form, Chars, channel skips, and max record length. The default line spacing is 6 LPI, allowing 43 lines per page in landscape and 60 lines per page in portrait. If the lines per page in the data file is higher, LPI and lines per page are automatically adjusted.

Both TCPDRIV option H - page length auto formatting, which is the default, and TCPDRIV option F - FCB-length based auto formatting, are supported. If the RTF wrapper is used and the input file's FORM=A4*, the output will be formatted to A4 paper size, and if the input file's FORM=LET*, the output will be formatted to letter paper size.

Note: Separator pages are not supported for files created using CA Spool's Text Wrapping support. ESFU010X is not called for files of this type.

Samples

The following is a sample Connect:Direct printer node definition:

DEFNODE CD,CD-01,TCPDRIV=C:D,
     CLASS=ALL,
     ACQUIRE=WORK,
     RELEASE=NOWORK
NODE HP6DCD,CD,
     TCPHOST='PNODE=CD450DE1,SNODE=CD450DE1',
     DRIVPRM1='DSNAME=PUBLIC.&UID.&NOD.&FNO',
     GROUP=2

The following is a sample DESTID definition, which causes matching text files automatically converted to PDF before being transferred to a remote Connect:Direct server:

DESTID QDEST=HP6DCD,QFNAME=SV11*,
     DADDRES1='USERID=LUSERID,PASSWORD=LPASSWORD',    
     FADDRES2='FILENAME=PUBLIC.&UID.&FNM.&FNO.PDF'

Print Data Encryption

Advanced Encryption Standard (AES) Rijndael print data encryption is supported. It lets you send print data securely encrypted over the public TCP/IP network. This encryption prevents unauthorized reading or use of the data.

Each piece of data of a print file is encrypted by the IBM Integrated Cryptographic Service Facility (ICSF) before it is sent over TCP/IP. ICSF is part of the z/OS base product.

Add the ICSF load library CSF.SCSFMOD0 to the LNKLST or to the CA Spool STEPLIB concatenation.

To activate print data encryption, specify the 16/24/32 bytes hexadecimal encryption key using the printer node KEY parameter, and specify printer TCPDRIV option '4'.

Capella's SecureDIMM card

Capella's SecureDIMM II (Dual Inline Memory Module) card supports (AES) Rijndael decryption on selected Hewlett-Packard (HP) printer models. This means that CA Spool can send print data securely over the public TCP/IP network to remote HP printers. SecureDIMM uses 16 bytes persistent encryption keys.

The SecureDIMM package includes a Printed SecureDIMM User Guide and a SecureDIMM CD which contains:

  • The CryptTst.prn test file, which prints a picture of a Volkswagen if the encryption card functions.
  • The aesCrypt Utility to encrypt a file and to change the printer encryption key.
  • Windows SecureDIMM Print Driver Extension used to specify the encryption key and enable encryption.

The following is a sample print data encryption HP printer node definition:

DEFNODE PJL5,HP-PJL5                                                 
NODE    HP65,PJL5,TCPPORT=9100,TCPHOST=731.225.65.331,TCPDRIV=PJL5F4,  
        KEY=010102030405060708090a0b0c0d0e0f,                      
        GROUP=1

To change or reset a Capella SecureDIMM card decryption key, create and print a CA Spool file named AESCRYPT as follows:

//*
//O1  OUTPUT CLASS=A,DEST=HP6,                     
//    USERDATA=(-C,                        -C / -R 
//      000102030405060708090A0B0C0D0E0F,  OLD-KEY 
//      010102030405060708090A0B0C0D0E0F)  NEW-KEY 
//STEP1  EXEC PGM=IEBGENER                         
//SYSPRINT DD SYSOUT=*                             
//SYSUT2   DD SUBSYS=(ESF,A,AESCRYPT),OUTPUT=*.O1 
//SYSIN    DD DUMMY                                
//SYSUT1   DD *                                    
====> Encryption Key changed. Call 99 999 999 <=== 
/*                                                 

CA LPD Support

The CA Spool LPD Interface supports decryption of (AES) Rijndael encrypted print data, so that you can send print files securely over the public TCP/IP network to remote CA Spool systems. The CA Spool LPD Interface supports 16/24/32 bytes persistent encryption keys.

A sample print data encryption CA LPD printer node definition follows:

DEFNODE LPR,HP-LPR
NODE    HP6X,LPR,TCPPRT=JESX,TCPHOST=MVSHOST2,TCPDRIV=LPR4,         
        GROUP=1,ACQUIRE=WORK,TCPPORT=515,RELEASE=NOWORK,
  KEY=F0F1F2F3F4F5F6F7F0F1F2F3F4F5F6F7F0F1F2F3F4F5F6F7F0F1F2F3F4F5F6F7

The corresponding CA LPD LPDDEST definition follows:

LPDDEST QDEST=JESX,FAM=JES,FOPTS=DGU4                 
        FDEST=LOCAL,                         
  FKEY=F0F1F2F3F4F5F6F7F0F1F2F3F4F5F6F7 F0F1F2F3F4F5F6F7F0F1F2F3F4F5F6F7

IPSec Support

Data sent from CA Spool to printers and print servers can be encrypted by Internet Protocol Security (IPSec) if the target node supports it. IPSec is a standard suite of protocols by Internet Engineering Task Force (IETF) that provides data authentication, integrity, and confidentiality as data is transferred between communication points across IP networks. No changes are required to CA Spool to enable IPSec. The IPSec function in z/OS is provided by z/OS Communication Server since z/OS V1R7.

For more information, see these guides:

  • z/OS Communications Server: IP Configuration Guide
  • IBM RedBook: IBM z/OS V2R1 Communications Server TCP/IP Implementation Volume 4: Security and Policy-Based Networking
  • The printer documentation provided by the manufacturer

TCP/IP Printer Node Parameters

The following parameters are supported for TCP/IP-attached printers:

NODE nodename,
device-type,
GROUP=nnnn,
ACQUIRE=NO |WORK |TIME |SNET,
ALIAS=cccccccc,
AUTO=YES | NO,
CKPTPGS=nnnn,
CLASS=c1....cn,
COMP=YES | NO,
DRIVPRM1=cccccccccccccccc,
DRIVPRM2=cccccccccccccccc,
DRIVPRM3=cccccccccccccccc,
DRIVPRM4=cccccccccccccccc,
ENDFF=NO | YES,
FCB=cccc,
FILTER=c,
FORM=cccc,
INITFF=NO | FILE,
LINECNT=nnn,
LOCATION=cccccccccccccccc,
NJEDEST=cccccccc,
OUTLIM=nnnnnnn,
PURGE=YES | NO,
RELEASE=NO | NOWORK,
REST=YES | NO | PRINTER,
RETAIN=nnnnn,
SEP= 0 - 9,
SEPOPT=nn,
SHARED=NO | YES | MASTER,
TCPDRIV=cccccccccc,   
TCPHOST=cccccccccccccccc,
TCPPORT=nnnn,
TCPPRT=cccccccccccccccc,
TIMEOUT=nnnnn,
TRANS=cccccccc,
TRANSFRM=cccccccccc,
USEFCB=FILE | PRINTER,
USEREXIT= BSESSION | ASESSION,
USEREXNO=n,
USERPARM=cccccccccccccccc,
VPS=cccccccc,
VPSCAPPL=cccccccc,
VPSERROR=ERROR | BLANK | IGNORE | NULL | PASS,
VPSFILE= CHAIN | BRACKET | nnnnnn,
VPSFNFF=YES | NO,
VPSMPP=NEW | OLD,
VPSOPT=nn,
VPSPMPP=nnn,
VPSTRACE= *ALL | cccccccc,
WS=CLASS|FORM|FCB|PRIO|AGE|GROUP


  • &FRM
    Print file form number
  • $PGN
    Print file Programamers Name. This is limited to the first 16 characters of the Programmers Name Information


&HST
Origin host name

Was this helpful?

Please log in to post comments.

  1. Chris Salmon
    2018-01-29 09:16

    Regarding Connect Direct Print Driver : This section says : If the target operating system uses backslashes () to delimit path names, use the TOENVIR=NT parameter. If the target operating system uses forward slashes (/) to delimit path names, use the TOENVIR=WS parameter. But then the Example shows DRIVPRM1='TOENVIR=WS' DRIVPRM2='PATH=C:\CDALTDIR\,FILENAME=NEWFILE.&FNO.&TIM.PDF' That is, showing WS with \ (backslashes).

    Please could you clarify and confirm which is correct. Many thanks.

    1. James Craig
      2018-12-14 04:05

      Hi Chris,

      Thanks for your comment. I made the necessary corrections to match the example.

      Regards,

      Jim Craig, Technical Writer 3, Broadcom