General Parameters, A-G

The SYSIN01 general parameters that begin with A through G follow. Unless otherwise noted, the parameters that are described in the following list are optional.
xdtz12
The SYSIN01 general parameters that begin with A through G follow. Unless otherwise noted, the parameters that are described in the following list are optional.
AGE
AGE overrides the CA XCOM Data Transport default age purging interval.
  • 1 to 999 days
    This value specifies the number of days that a transfer request can remain in the queue before being purged.
Aging is relative to the scheduled start date of the file transfer. The purging interval is the number of days a request can remain on the CA XCOM queue before purging. The CA XCOM Data Transport queue includes file transfer requests with future start dates, transfer requests that have been placed on HOLD status, and transfers that were suspended. CA XCOM performs the queue purging at two times-when the CA XCOM server comes up and daily at midnight. A transfer that displays an AGE value of 000 on an online panel or in the output of a SHOW command will use the AGE value that is active in the CA XCOM server.
Default:
Taken from CA XCOM Data Transport Default Options Table.
CODETABL
CODETABL specifies the one- to three-character prefix to the file names, atoe.tab and etoa.tab, that contain the external ASCII-to-EBCDIC and EBCDIC-to-ASCII custom character conversion tables on the CA XCOM Data Transport for Windows and the CA XCOM Data Transport for UNIX platforms. These custom character conversion tables determine which external translation tables are used when a transfer is sent to these platforms. This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO is set on the receiving platform and the platforms are at r11 or above.
  • 1 to 3 (bytes)
    This value specifies up to three alphanumeric characters, identifying the code table to be used by the remote partner.
Default:
None
CKPT
CKPT specifies the interval for checkpoints that are taken during a file transfer.
  • 0 to 9999 records
    This value specifies the number of records to transfer for a checkpoint interval.
The checkpoint/restart facility resumes interrupted transfers from the point at which the most recent checkpoint was taken.
Each time a checkpoint is taken, the output buffers on the receiving system are written to the disk. A checkpoint interval that is too short slows down file transfers; a checkpoint interval that is too long increases the risk of data loss. We recommend that you set the checkpoint count to at least 1000. On Token Ring, Ethernet, and other high-speed networks, the checkpoint count must be set to the highest allowable value .
If the receiving system is z/OS or VSE, the checkpoint count must be a multiple of the blocking factor. If the DCB attributes are RECFM=FB LRECL=80 BLKSIZE=8000, the checkpoint count must be a multiple of 100.
Default:
Taken from the CA XCOM Data Transport default options table.
CODE
CODE identifies the type of transferred data. The receiving system is responsible for performing any necessary conversion.
  • EBCDIC
    This option indicates that the transferred data are coded in EBCDIC format.
  • ASCII
    This option indicates that the transferred data are coded in ASCII format.
  • BINARY
    This option indicates that the transferred data are coded in binary format.
  • UTF8
    This option indicates that the transferred data are coded in UTF8 format.
  • UTF16
    This option indicates that the transferred data are coded in UTF16 format.
Default:
EBCDIC
EBCDIC packed decimal fields cannot be transferred under EBCDIC. Use BINARY to transfer EBCDIC packed decimal data.
If you specify CODE=ASCII and the receiving system is a mainframe, then this parameter is ignored.
When UTF16 is specified, UTF16BE (Big Endian) or UTF16LE (Little Endian) is negotiated based on the CPU type of the local system.
The LOCAL_CHARSET and REMOTE_CHARSET parameters are used to specify the translation that takes place on the transferred data when UTF8 or UTF16 is specified.
For SEND JOB requests sent to a z/OS partner using Unicode (CODE=UTF8 or UTF16), the remote CCSID is required to be EBCDIC-based as JES is unable to process non-EBCDIC characters.
COMPRESS
This parameter specifies whether CA XCOM Data Transport compresses the data being transferred and decompresses it on the remote system. Compressing the data decreases the transmission time on lower-speed links.
  • YES
    This option provides Run-Length Encoding (RLE) for blanks and binary zeros only.
  • NO
    No data compression
  • RLE
    This option provides complete Run-Length Encoding for all characters.
  • COMPACT
    This option provides full RLE (as in RLE) plus a byte compaction scheme that is suitable for uppercase English text.
  • COMPACTL
    Same as COMPACT, only the compaction scheme is most beneficial for lowercase English text.
  • LZSMALL
    CA XCOM Data Transport compresses the data according to the small memory model of Lempel-Ziv 77 compression.
  • LZMEDIUM
    CA XCOM Data Transport compresses the data according to the medium memory model of Lempel-Ziv 77 compression.
  • LZLARGE
    CA XCOM Data Transport compresses the data according to the large memory model of Lempel-Ziv 77 compression.
  • HUFFMAN
    Greater compression than RLE but not as much as the Lempel-Ziv 77 modes
  • LZRW3
    General-purpose algorithm that runs fast and gives a reasonable compression.
  • ZLIB(
    n
    )
    Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. The n value can be 1 through 9.
Transfers that use the ZLIB(n) compression algorithm are eligible to use the zEDC Hardware Accelerator feature. The zEDC Hardware Accelerator feature must be available and configured on the system where the transfer runs. The transfer’s data buffers must meet the minimum buffer size threshold(s) configured in the z/OS IQPPRMxx member in SYS1.PARMLIB. If these thresholds are not met, or if zEDC is not configured on the local system, CA XCOM will attempt to process the compression or decompression on a zIIP processor.
For requirements and configuration instructions to support zEDC, see Utilizing zEDC Hardware Accelerator.
Specifying a value other than NO enables use of zIIP to perform the compression function. zIIP processing is used for compression only if the buffer size to compress is >= 4096 bytes. Specifying PACK=LENGTH and use a high MAXPACK value (>= 4096) for TCP/IP transfers or RUSIZE (>=4096) for SNA transfers to make efficient use of zIIP.
Default:
Destination member value, if a destination member is used for the transfer, or NO if a destination member is not used for the transfer.
CREATEDELETE
This parameter specifies whether an existing data set is deleted and a new data set allocated at the start of a FILEOPT=CREATE transfer.
  • NO
    If FILEOPT=CREATE and the data set exists, then the transfer fail with a catalog/file error.
  • YES
    If FILEOPT=CREATE and the data set exists, then it is deleted and a new data set is allocated at the start of the transfer.
Default:
NO
For the Default Options Table (XCOMDFLT)
Specifying CREATEDELETE=YES causes the attributes of the existing data set to be lost. The new data set is allocated with the attributes specified in the transfer.
CREATEDELETE applies only if the target data set is a sequential data set or an entire PDS/PDSE. CREATEDELETE is ignored for other types of data sets (such as PDS members, PDSE members, VSAM, and USS files).
If the data set is specified using the fully qualified GxxxxVxx name, CREATEDELETE does not apply to relative GDGs.
The site administrator must allow the use of CREATEDELETE=YES through the default table (XCOMDFLT), CONFIG member (XCOMCFG), or destination member (XCOMCNTL).
DATACLAS
DATACLAS specifies the one to eight character name of the data class to use when allocating a SMS-managed data set.
This parameter applies only to mainframe SMS data sets.
Default:
None
DEFAULT_CONVERROR
This parameter identifies the action when the input file contains characters that cannot be converted. The characters are not included within the output character sets character repertoire.
  • REPLACE
    Replace each unconvertible character with the default substitution characters defined for the Unicode character set.
  • REPLACE#nnnnnnn
    Replace each unconvertible character with the Unicode character that the decimal value nnnnnnn identifies. If the specified replacement character cannot be represented in the output character set, then the transfer is failed. This option is not supported for z/OS systems, where the replacement character is defined in the conversion table that is defined to IBM Unicode Services. This option is treated as REPLACE. The replacement character has a valid range of 1 - 1114111.
  • SKIP
    The erroneous data is disregarded, but a warning message is issued at the end of the transfer. The message identifies that this condition occurred and provides a total count of the number of skipped characters. This option is not supported for z/OS systems and is treated as REPLACE.
  • FAIL
    The transfer terminates with an error condition.
Default:
The DEFAULT_CONVERROR parameter in the destination member or CA XCOM Data Transport Default Options Table specifies the default.
DEFAULT_INPUTERROR
This parameter identifies the appropriate action when the input file contains data that is not consistent with the specified input character set.
  • REPLACE
    Replace each piece of erroneous data with the default substitution characters defined for the Unicode character set.
  • REPLACE#nnnnnnn
    Replace each piece of erroneous data with the Unicode character that the decimal value nnnnnnn identifies. This option is not supported for z/OS systems, where the replacement character is defined in the conversion table that is defined to IBM Unicode Services. This option is treated as REPLACE. The replacement character has a valid range of 1 - 1114111.
  • SKIP
    The erroneous data is disregarded, but a warning message is issued at the end of the transfer. The message identifies that this condition occurred and provides a total count of the number of ignored bytes. This option is not supported for z/OS systems and is treated as REPLACE.
  • FAIL
    The transfer terminates with an error condition.
Default:
The DEFAULT_INPUTERROR parameter in the destination member or CA XCOM Data Transport Default Options Table specifies the default.
DOMAIN
DOMAIN identifies the Windows domain server that is used to validate the remote user ID and password.
  • Up to 15 alphanumeric characters
    This value specifies the domain server that is used to validate the remote user ID and password.
Default:
None
DOMAIN can only be used for transfers running under Windows.
DROPSESS
DROPSESS indicates whether CA XCOM Data Transport drops an LU-to-LU session at the conclusion of a scheduled file transfer.
  • YES
    This option indicates that CA XCOM Data Transport drops the session.
  • NO
    This option indicates that CA XCOM Data Transport does not drop the session.
  • QEMPTY
    This option indicates that CA XCOM Data Transport is to process all the transfers to a particular LU in the request queue before dropping the session.
Default:
NO
CA XCOM for OpenVMS and some CA XCOM for UNIX products do not support z/OS-initiated session establishment. Therefore, DROPSESS has no effect when the target of the transfer request is one of these platforms.
DSNTYPE
DSNTYPE specifies the data set definition.
This parameter applies only to mainframe SMS data sets.
  • LIBRARY
    This option defines a PDSE.
  • PDS
    This option defines a partitioned data set.
  • BASIC
    This option defines a legacy sequential data set.
  • LARGE
    This option defines a large format sequential data set.
  • EXTREQ
    This option defines an extended format data set.
  • EXTPREF
    This option specifies an extended format is preferred. If the extended format is not possible, a basic format is used.
  • <blank>
    This option defines a partitioned or sequential data set based on the data set characteristics that are entered.
These values are IBM standards for SMS processing.
Default:
None
EPRTY
EPRTY indicates the execution priority for the request. The lowest priority is 1.
  • 1 to 255
    This value specifies an execution priority from 1 to 255, where 1 is the lowest priority.
In an environment with multiple concurrent CA XCOM Data Transport transmissions, transfers with higher priorities receive preferential servicing.
All other things being equal, give short file transfers a higher EPRTY than long running transmissions.
Default:
16
FILEDATA
This parameter indicates how a remote USS file is allocated.
  • B
    Binary
  • T
    Text
  • R
    Record
If you do not specify a value for FILEDATA, then the allocation is determined based on the CODE= specification and by the value of the Data Encoding (CODE) and Extended Variable Length Record (VLR) fields:
  • If CODE=BINARY, then the file is allocated and processed as binary data.
  • If CODE=UTF8 or CODE=UTF16, then the file is allocated and processed as record data.
  • If CODE=EBCDIC, the type of allocation and processing depends on the value of FILEDATA, as follows:
    • If you
      do not
      specify FILEDATA=B, the file is allocated as a text file. The file is also processed as an EBCDIC text file.
    • If you
      do
      specify FILEDATA=B, then the file is allocated as a binary file. The file is also processed as an EBCDIC file.
    • If you
      do
      specify FILEDATA=R, then the file is allocated as a text file with record format. The file is also processed as an EBCDIC text file.
If you
do
specify FILEDATA=B, then specify a value for LRECL. The value tells CA XCOM Data Transport how many bytes there are in each logical record.
FILETYPE
FILETYPE indicates the output type of the transfer on the target system. Required.
  • FILE
    This option indicates the transferred information is a file to be stored on the external media of the receiving system.
    This parameter value can be used with TYPE=SEND and TYPE=RECEIVE requests.
  • JOB
    This option indicates that the transferred information is a batch job that is submitted for execution on the remote system.
    This parameter value can be used only with TYPE=SEND requests.
    For JOB requests sent to a z/OS partner using Unicode (CODE=UTF8 or UTF16), the remote CCSID is required to be EBCDIC-based as JES is unable to process non-EBCDIC characters.
  • REPORT
    This option indicates that the transferred information is a report to be printed on the remote system.
    This parameter value can be used only with TYPE=SEND requests.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
GATEWAYGUID
This parameter identifies the remote file as a CA XCOM Gateway file and specifies the CA XCOM Gateway GUID. The CA XCOM Gateway GUID is a unique value that identifies each CA XCOM Gateway file. The keyword ANY can be used to identify the remote file as a CA XCOM Gateway file when the CA XCOM Gateway GUID is not known.
Range:
0 to 36 characters
Default:
None (the remote file is not a CA XCOM Gateway file).
GATEWAYDPATH
GATEWAYDPATH specifies the destination path that CA XCOM Gateway uses when the remote file is a CA XCOM Gateway file. CA XCOM Gateway makes the destination path available as symbolic parameter &GWDPATH for onward delivery.
Range:
0 to 254 characters
Default:
None
You can specify this parameter in the destination member or in the SYSIN01. Its presence is checked for first in the SYSIN01 and then in the destination member.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters in the Using section.
GROUP
GROUP tells CA XCOM Data Transport to use the “pooled” LU feature to allow for multithreading of transfers to nodes that support multiple logical units but not parallel sessions. For TCP/IP transfers, use GROUP to specify an alias.
  • xxxxxxxx
    Specifies the name of a group of LUs defined in the CA XCOM Data Transport control library (CAI.CBXGPARM). The name can contain up to eight characters. The first character must be alphabetic, while the rest can be any combination of alphanumeric or national characters.
GROUP, LIST, USER, and LU are mutually exclusive parameters. Only one of them can be coded.
When GROUP= or LIST= is used, the destination member or the default table determines the value for IPPORT. 
The group must be predefined in the CA XCOM Data Transport control library (CAI.CBXGPARM). When the transfer process begins, CA XCOM Data Transport tries transferring to the first LU in the group. If that attempt fails, the second LU is tried. If that transfer attempt fails, the third LU is tried, and so on. However, when CA XCOM Data Transport finds an LU that is available for the partner node, it transfers the data to that LU and stops any further transfer attempts.
Group processing is supported for TCP/IP transfers but only for a single IP address. In this way, an alias can be defined within CA XCOM Data Transport for an IP address.
Session establishment is subject to a time-out limit defined on the TIMEOUT parameter. See the description of TIMEOUT later in this section.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.