PARM Parameters

This section describes the PARM parameters.
xdtz12
This topic describes the PARM parameters, which are specified in the PARM field of the EXEC statement.
Specifying an unsupported parameter name or an invalid value for a parameter results in the CA XCOM Data Transport server, admin server, or job terminating. This also applies to the Configuration members. A message indicating which parameter caused termination is displayed in the XCOMINIT log.
ACBNAME
Identifies the VTAM ACBNAME opened by CA XCOM Data Transport.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters that identify the VTAM ACBNAME.
If the ACBNAME is seven or eight characters, CA XCOM Data Transport assumes it is an exact name. If it is six characters or less, CA XCOM Data Transport assumes it is a generic name and appends a two-digit numeric suffix from 00 to 99. This suffix is derived from the number of batch jobs still in the process of being executed. The indicated ACBNAME must be a valid VTAM ACBNAME; otherwise the transfer fails and error messages are written to the job log.
Only one file transfer using the APPLID can be active at a time. All others wait until the APPLID becomes available (no time-out occurs in this case). We recommend indicating a generic APPLID, because it allows up to 1000 concurrent file transfers.
Leaving this parameter unspecified allows the value of the JOBACB parameter in the CA XCOM Data Transport Default Options Table to govern.
CMPRS_PDS_ALLOW
To enable CA XCOM Data Transport to perform programmatic PDS compression for a user, your site administrator must set the CMPRS_PDS_ALLOW parameter to a value other than NO.
The EXEC PARM parameter values take precedence over the corresponding values in the Default Options Table.
  • NO
    Disables the compression function within the servers to which it applies.
  • YES
    Allows users to request PDS compression on a transfer-by-transfer basis, or by using a DEST member.
    Note:
    This setting also implicitly provides automatic compression in response to an out-of-space condition.
  • X37
    Automatically invokes PDS compression if a z/OS system abend B37, D37, or E37 occurs during a transfer into a PDS data set.
Default:
NO
The EXEC PARM parameter values take precedence over the corresponding values in the Default Options Table.
if the retry also results in an out-of-space condition, any retryable transfer that is a result of an automatic compression from an out-of-space condition. Such as #XCOMM0221E DATASET OUT OF SPACE - PDS DATASET WILL BE COMPRESSED is terminated.
CMPRS_SYSOUT_CL
This parameter controls whether and to which SYSOUT class IEBCOPY output is written.
  • NONE
    Prevents the output from the compress operation from being written to a SYSOUT data set.
  • LOG
    Allocates a SYSOUT data set with the same output class as specified for the XCOMLOG SYSOUT data set.
  • <class>
    Allocates a SYSOUT data set to hold the compress utility output with the class on this parameter.
    Range:
    A single character (A to Z or 0 through 9).
Default:
LOG
The EXEC PARM parameter values take precedence over the corresponding values in the Default Options Table.
Important! if the IEBCOPY utility terminates abnormally, particularly during the process of compressing a PDS data set, IBM documentation warns of potential damage to data sets.
COMPNEG
COMPNEG specifies whether the compression negotiation is allowed, and if so, which compression algorithm the negotiation process substitutes.
  • compression-method
    Specifies the data compression method which the negotiation process substitutes. The possible values for this parameter are:
    COMPACT
    COMPACTL
    YES
    RLE
    HUFFMAN
    LZLARGE
    LZMEDIUM
    LZSMALL
    LZRW3
    ZLIB
    ZLIB1 - ZLIB9
  • NO
    Specifies that the data compression method is not negotiated. This causes transfers requesting an unsupported or disallowed compression method to be failed.
Default:
YES
If a transfer’s compression method that the initiator or partner requests by both participants is known and allowed, that method is used to compress the transfer data.
If the suggested compression method is not known or is not permitted by a participant involved in the transfer, the compression method that is specified for the COMPNEG parameter can be used to attempt to negotiate to an alternate compression method which is acceptable to both partners of the transfer.
The compression method that is specified for COMPNEG must be on the list of allowed algorithms for the local server, as an example, the COMPRESS_ALLOWED parameter.
COMPRESS_ALLOWED
Specifies the compression methods allowed for transfers:
  • ALL
  • NONE
  • COMPACT
  • COMPACTL
  • YES
  • RLE
  • HUFFMAN
  • LZALL
  • LZLARGE
  • LZMEDIUM
  • LZSMALL
  • LZRW3
  • ZLIBALL
  • ZLIB
  • ZLIB1 - ZLIB9
Default:
ALL
Specify NONE to allow no compression.
Specify ALL to allow all compression methods.
To allow all methods except the ones that you prohibit individually, specify ALL, followed by the prohibited methods. Add a colon (:) and exclamation point (!) after the ALL and between each prohibited method. See the related example for details.
If you do not specify ALL, then only the methods that you specify individually are allowed.
If you specify multiple methods individually, separate each one with a colon (:), whether you are allowing them or prohibiting them. See the examples for details.
Examples:
  • To turn off compression:
    COMPRESS_ALLOWED=NONE
  • To allow all compression methods:
    COMPRESS_ALLOWED=ALL
  • To allow all methods except the LZ small, medium, and large methods:
    COMPRESS_ALLOWED=ALL:!LZSMALL:!LZMEDIUM:!LZLARGE
  • To allow only HUFFMAN, LZALL, and RLE:
    COMPRESS_ALLOWED=HUFFMAN:LZALL:RLE
CONFIG
This parameter indicates the name of the TYPE=CONFIG control library member that is read and CA XCOM Data Transport server uses.
  • XCOMDFLT
    Specifies the TYPE=CONFIG member XCOMDFLT.
  • xxxxxxxx
    Specifies the name of the TYPE=CONFIG member other than XCOMDFLT. This name can be up to eight alphanumeric characters long.
If both the DFLTAB and CONFIG parameters are specified, the CONFIG parameter takes precedence.
Using the CONFIG parameter assumes that the member named is an existing, valid TYPE=CONFIG member.
Default:
XCOMDFLT
CONTINUE
Tells CA XCOM Data Transport how to proceed if a processing error is encountered during multi-transfer processing.
  • YES
    Tells CA XCOM Data Transport to start the next transfer in a multi-transfer request. If this request is resubmitted, CA XCOM Data Transport resumes from the initial transfer in the multi-transfer request.
  • NO
    Tells CA XCOM Data Transport not to start any remaining transfers in the multi-transfer request.
    If this request is resubmitted because of a VTAM error, CA XCOM Data Transport resumes with the failed transfer.
    If a logic error occurred, CA XCOM Data Transport resumes with the next transfer.
This parameter is used in conjunction with the SYSIN01 parameter NEWXFER.
CA XCOM Data Transport can only continue a resumed transfer from the point of failure if the XCOMREST and XCOMGLOB DD statements have been correctly defined. Otherwise, it resumes at the beginning of the transfer.
Default:
YES
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).
DFLTAB
Indicates the name of the default table to be loaded and used by the CA XCOM Data Transport server.
  • XCOMDFLT
    Specifies the default table XCOMDFLT.
  • xxxxxxxx
    Specifies the name of the default table other than XCOMDFLT. This name can be up to eight alphanumeric characters long.
For r11.6 and later releases, the values present in a CA XCOM Data Transport Default Options Table will be automatically converted to a TYPE=CONFIG member and saved in the first data set in the XCOMCNTL DD concatenation during initialization.
If a TYPE=CONFIG member exists in the XCOMCNTL DD concatenation with the same name as specified for the DFLTAB parameter, it will be used INSTEAD OF the Default Options Table.
Default:
XCOMDFLT
DISPALG
Indicates how to dispatch tasks that are ready for execution.
  • ROTATE
    Tells the CA XCOM Data Transport server to proceed to the next NSA and to dispatch it (if it is dispatchable).
  • NORMAL
    Tells the CA XCOM Data Transport server to scan the NSA from the top for the next dispatchable NSA.
This parameter is valid only for the CA XCOM Data Transport server Job.
DISPALG has no effect on the XCOMPLEX Admin Server.
Default:
ROTATE
DOMAIN
Identifies the Windows domain server used to validate the remote user ID and password.
  • Up to 15 alphanumeric characters
    Specifies the domain server used to validate the remote user ID and password.
Default:
None
Valid with TYPE=EXECUTE and with transfers to Windows only.
DUMPCL
Indicates the SYSOUT class for snap dumps, trace data, and other diagnostic information.
  • x
    Specifies one alphanumeric character representing a valid SYSOUT class.
EDESC
Specifies the 16 bits (coded in hexadecimal) of a z/OS message descriptor code.
  • Value (hexadecimal)
    8000
    • Descriptor Code
      1
    • Definition
      System failure
  • Value (hexadecimal)
    4000
    • Descriptor Code
      2
    • Definition
      Immediate action required
  • Value (hexadecimal)
    2000
    • Descriptor Code
      3
    • Definition
      Eventual action required
  • Value (hexadecimal)
    1000
    • Descriptor Code
      4
    • Definition
      System status
  • Value (hexadecimal)
    0800
    • Descriptor Code
      5
    • Definition
      Immediate command response
  • Value (hexadecimal)
    0400
    • Descriptor Code
      6
    • Definition
      Job status
  • Value (hexadecimal)
    0200
    • Descriptor Code
      7
    • Definition
      Application program processor
  • Value (hexadecimal)
    0100
    • Descriptor Code
      8
    • Definition
      Out-of-line message
  • Value (hexadecimal)
    0080
    • Descriptor Code
      9
    • Definition
      Status display
  • Value (hexadecimal)
    0040
    • Descriptor Code
      10
    • Definition
      Dynamic status display
  • Value (hexadecimal)
    0020
    • Descriptor Code
      11
    • Definition
      Critical eventual action required
  • Value (hexadecimal)
    0010
    • Descriptor Code
      12
    • Definition
      Important information message
  • Value (hexadecimal)
  • Descriptor Code
    13
  • Definition
    Reserved for future use
The message descriptor codes are selected by the bit configuration, where bit 0 corresponds to descriptor code 1. These codes are assigned to error messages ending with "E". The descriptor code is used by CA XCOM Data Transport when issuing WTO macro instructions. z/OS inserts an indicator at the start of the message. The indicator is a blank space followed by a "+" sign.
Default:
0200
EROUT
Specifies the sixteen bits (coded in hexadecimal) of z/OS console routing codes for messages ending with E. The following are available routing codes:
  • Value (hexadecimal)
    8000
    • Descriptor Code
      1
    • Definition
      Master console action
  • Value (hexadecimal)
    4000
    • Descriptor Code
      2
    • Definition
      Master console information
  • Value (hexadecimal)
    2000
    • Descriptor Code
      3
    • Definition
      Tape pool
  • Value (hexadecimal)
    1000
    • Descriptor Code
      4
    • Definition
      Direct access pool
  • Value (hexadecimal)
    0800
    • Descriptor Code
      5
    • Definition
      Tape library
  • Value (hexadecimal)
    0400
    • Descriptor Code
      6
    • Definition
      Disk library
  • Value (hexadecimal)
    0200
    • Descriptor Code
      7
    • Definition
      Unit record pool
  • Value (hexadecimal)
    0100
    • Descriptor Code
      8
    • Definition
      Teleprocessing control
  • Value (hexadecimal)
    0080
    • Descriptor Code
      9
    • Definition
      System security
  • Value (hexadecimal)
    0040
    • Descriptor Code
      10
    • Definition
      System error/maintenance
  • Value (hexadecimal)
    0020
    • Descriptor Code
      11
    • Definition
      Programmer information
  • Value (hexadecimal)
    0010
    • Descriptor Code
      12
    • Definition
      Emulators
  • Value (hexadecimal)
    0008
    • Descriptor Code
      13
    • Definition
      Installation use
  • Value (hexadecimal)
    0004
    • Descriptor Code
      14
    • Definition
      Installation use
  • Value (hexadecimal)
    0002
    • Descriptor Code
      15
    • Definition
      Installation use
  • Value (hexadecimal)
    0001
    • Descriptor Code
      16
    • Definition
      Installation use
  • Value (hexadecimal)
    0000
    • Descriptor Code
      none
    • Definition
      For CA XCOM Data Transport use only
Codes are selected by bit configuration, where bit 0 corresponds to Routing Code 1, bit 1 corresponds to Routing Code 2; that is, at z/OS system generation, each operator's console is assigned routing codes corresponding to the functions that the installation wants that console to perform.
Specifying EROUT=0000 in the Default Options Table or as part of the PARM field of the EXEC JCL statement causes the suppression of all XCOMM
nnnn
E messages from the SYSLOG, and most error messages generated by XCOMJOB. All messages continue to be a part of the CA XCOM Data Transport log.
Default:
4020
FERL
Specifies the number of times CA XCOM Data Transport is to retry a transfer after certain file errors or file allocation errors have occurred.
  • 0
    Specifies that CA XCOM Data Transport should not attempt to retry a transfer after the first file allocation or other file error.
  • 1 to 254
    Specifies the number of times CA XCOM Data Transport is to retry a transfer after encountering file and file allocation errors.
  • 255
    Specifies that CA XCOM Data Transport should retry the transfer indefinitely.
Default:
255
CA XCOM Data Transport retries a transfer at the interval specified by the ERRINTV parameter. Because the FERL parameter specifies the number of retries, the transfer is attempted FERL+1 times (that is, the first attempt is not included in the count).
GROUP
Tells CA XCOM Data Transport to use the pooled LU feature to allow for multi-threading of transfers to nodes that support multiple logical units but not parallel sessions.
  • xxxxxxxx
    Specifies the name of a group of LUs. The name can be eight characters long. The first character of the name must be alphabetic, while the rest can be any combination of alphanumeric or national characters.
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of these parameters must be coded (either on the EXEC card or in SYSIN01); however, coding more than one causes an error.
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, as soon as CA XCOM Data Transport finds an LU that is available for the partner node, it transfers the data to that LU and stops making 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.
When GROUP= or LIST= is used, the value for IPPORT is determined by either the destination member or the default table.
Session establishment is subject to a time-out limit defined on the TIMEOUT parameter. See the description of this parameter later in this section.
HISTDD
Identifies the DDNAME of the data set to contain the selected history records.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters that identify the history DD name.
Default:
If the HISTDD parameter is not specified, the HISTORY_OUT_DD parameter value defined in the default options table is used.
IDESC
Specifies the 16 bits (coded in hexadecimal) of a z/OS message descriptor code.
  • Value (hexadecimal)
    8000
    • Descriptor Code
      1
    • Definition
      System failure
  • Value (hexadecimal)
    4000
    • Descriptor Code
      2
    • Definition
      Immediate action required
  • Value (hexadecimal)
    2000
    • Descriptor Code
      3
    • Definition
      Eventual action required
  • Value (hexadecimal)
    1000
    • Descriptor Code
      4
    • Definition
      System status
  • Value (hexadecimal)
    0800
    • Descriptor Code
      5
    • Definition
      Immediate command response
  • Value (hexadecimal)
    0400
    • Descriptor Code
      6
    • Definition
      Job status
  • Value (hexadecimal)
    0200
    • Descriptor Code
      7
    • Definition
      Application program processor
  • Value (hexadecimal)
    0100
    • Descriptor Code
      8
    • Definition
      Out-of-line message
  • Value (hexadecimal)
    0080
    • Descriptor Code
      9
    • Definition
      Status display
  • Value (hexadecimal)
    0040
    • Descriptor Code
      10
    • Definition
      Dynamic status display
  • Value (hexadecimal)
    0020
    • Descriptor Code
      11
    • Definition
      Critical eventual action required
  • Value (hexadecimal)
    0010
    • Descriptor Code
      12
    • Definition
      Important information message
The codes are selected by the bit configuration, where bit 0 corresponds to descriptor code 1, bit 1 to descriptor code 2. These codes are assigned to messages ending with I.
For more information, see the EDESC parameter.
Default:
0200
IPNAME
Identifies the IP address of the remote system for a TCP/IP transfer.
  • 1 to 64 alphanumeric characters
    Specifies the name or address of the remote TCP/IP system involved in a transfer. This name can contain up to 63 alphanumeric characters and it must be one that has been defined to the domain name server. The address can be in IPv4 or IPv6 notation.
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of these parameters must be coded (either on the EXEC card or in SYSIN01). Coding more than one causes an error.
IPPORT
Identifies the IP port of the remote system for a TCP/IP transfer.
  • 1 to 65535
    Specifies a number indicating the TCP/IP port used when IPPORT is omitted.
Default:
8044
This parameter must match the SERVPORT specification of the target server and normally should not be changed.
When GROUP= or LIST= is used, the value for IPPORT is determined by either the destination member or the default table.
IROUT
Specifies the sixteen bits (coded in hexadecimal) of a z/OS console routing code.
Value (hexadecimal)
8000
  • Descriptor Code
    1
  • Definition
    Master console action
Value (hexadecimal)
4000
  • Descriptor Code
    2
  • Definition
    Master console information
Value (hexadecimal)
2000
  • Descriptor Code
    3
  • Definition
    Tape pool
Value (hexadecimal)
1000
  • Descriptor Code
    4
  • Definition
    Direct access pool
Value (hexadecimal)
0800
  • Descriptor Code
    5
  • Definition
    Tape library
Value (hexadecimal)
0400
  • Descriptor Code
    6
  • Definition
    Disk library
Value (hexadecimal)
0200
  • Descriptor Code
    7
  • Definition
    Unit record pool
Value (hexadecimal)
0100
  • Descriptor Code
    8
  • Definition
    Teleprocessing control
Value (hexadecimal)
0080
  • Descriptor Code
    9
  • Definition
    System security
Value (hexadecimal)
0040
  • Descriptor Code
    10
  • Definition
    System error/maintenance
Value (hexadecimal)
0020
  • Descriptor Code
    11
  • Definition
    Programmer information
Value (hexadecimal)
0010
  • Descriptor Code
    12
  • Definition
    Emulators
Value (hexadecimal)
0008
  • Descriptor Code
    13
  • Definition
    Installation use
Value (hexadecimal)
0004
  • Descriptor Code
    14
  • Definition
    Installation use
Value (hexadecimal)
0002
  • Descriptor Code
    15
  • Definition
    Installation use
Value (hexadecimal)
0001
  • Descriptor Code
    16
  • Definition
    Installation use
Value (hexadecimal)
0000
  • Descriptor Code
None
  • Definition
    For CA XCOM Data Transport use only.
The console routing codes are selected by the bit configuration, where bit 0 corresponds to routing code 1, bit 1 to routing code 2, and so on. These codes are assigned to messages ending with I.
Specifying IROUT=0000 in the Default Option Table or as part of the PARM field of the EXEC JCL statement causes the suppression of all XCOMM
nnnn
I messages, with the exception of XCOMM0056I and XCOMM0001I from the SYSLOG, and most informational messages generated by XCOMJOB. All messages continue to be a part of the CA XCOM Data Transport log.
Default:
4020
LIST
Broadcasts the file transfer to all remote destinations designated on a predefined distribution list.
  • xxxxxxxx
    Specifies the name of a list of destinations to which the file is to be transferred. The name can be up to eight alphanumeric characters long.
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of these parameters must be coded (either on the EXEC card or in SYSIN01). Coding more than one causes an error.
When a transfer is performed to a destination defined as a list of LUs or IP addresses, the data is transferred to each LU or IP node in the list.
When GROUP= or LIST= is used, the value for IPPORT is determined by either the destination member or the default table.
The LIST parameter is valid only for TYPE=SCHEDULE transfers.
Because a transfer to a list destination is processed as a queued request, the various file transfers involved might have different start times. Use the CA XCOM Data Transport Operator Control function on the Menu Interface to check the current status of any broadcast distribution.
Using a Superlist
Specifying the name of a superlist for the LIST parameter broadcasts the file transfer to all remote destinations designated on a predefined distribution superlist, or list of lists.
  • Up to 32720 bytes
    XCOM LIST names are names of members in the XCOMCNTL data set and therefore are limited to eight alphanumeric characters.
    XCOM lists are limited to 32720 bytes of storage, consisting of the following:
    • A 32-byte storage descriptor, leaving 32688 bytes for the list.
    • Each list entry occupies 4 to 10 bytes:
      • 1 byte for the TYPE
      • 1 flag byte
      • 1 byte for the LENGTH
      • 1 to 8 bytes for the name of the list
    If each member name specified as a LIST/SUPERLIST is eight characters long, then a SUPERLIST can include 2971 member names.
LOG
Specifies whether a log of CA XCOM Data Transport activity is written to SYSOUT.
  • YES
    Write a log of CA XCOM Data Transport activity to SYSOUT.
  • NO
    Do not write a log of activity.
Unless LOG=NO is coded, the CA XCOM Data Transport activity log includes a list of the SYSIN01 parameters used for the file transfer, except for the PASSWORD parameter value, which is omitted for security reasons.
Default:
YES
LOGCLASS
Indicates the desired SYSOUT class to which the CA XCOM Data Transport log is written.
  • X
    Specifies the SYSOUT class X.
  • x
    Specifies a SYSOUT class other than X. This class can be represented with any alphabetic character.
    You can also specify an asterisk (*), which writes the CA XCOM Data Transport log to the same class as this job's JCL MSGCLASS.
Default:
X
LOGDEST
Indicates the SYSOUT destination to which the CA XCOM Data Transport log is sent.
  • xxxxxxxx
    Specifies the name of the SYSOUT destination to which the CA XCOM Data Transport log is sent. The name can be eight alphanumeric characters long.
For more information on LOGDEST, see the description of this parameter in the CA XCOM Data Transport Default Options Table in the  Administrating section.
LOGMODE
Overrides the mode name set in the CA XCOM Data Transport Default Options Table if the DLOGMOD parameter is set to the value of XCOM.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters representing the mode name.
If DLOGMOD=VTAM, this parameter is ignored.
For more information on LOGMODE, see the description of this parameter in the CA XCOM Data Transport Default Options Table in the Administrating section.
LU
Defines the remote system's LU name and associated VTAM logical unit name.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters indicating the remote and associated VTAM LU name.
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of these parameters must be coded (either on the EXEC card or in SYSIN01). Coding more than one causes an error.
MAXPACK
This parameter specifies the maximum packing length in bytes when PACK=LENGTH parameter is specified.
  • 2048 to 1023000 (bytes)
    Specifies the maximum packing length (record packing buffer size) when the PACK=LENGTH parameter is specified.
Default:
2048 (bytes)
  • The use of PACK=LENGTH and the target buffer size is recommended to improve file transfer performance.
  • In order to use zIIP processors for data compression, we recommend specifying a packing length of at least 4096.
  • The MAXPACK value or equivalent on the partner side must match that on the local side. Otherwise, the value is negotiated downwards.
  • For maximum record packing, set MAXPACK to 1023000 and set the PACK transfer parameter value to LENGTH.
NETNAME
Specifies the name passed by CA XCOM Data Transport to remote systems in CINIT or BIND vectors to override the PLU name in the user portion of the BIND. This is required for some systems, such as AS/400. For detailed information, see specific system components.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters indicating a name to override the PLU name for remote systems in CINIT and BIND vectors.
Do not confuse this parameter with the VTAM parameter NETID.
Default:
XCOMAPPL
PSOPREF
Specifies the high level qualifier to use to create a temporary data set.
QSTART
This parameter specifies the handling of the XCOMRRDS transfer queue during initialization of the CA XCOM Data Transport server.
  • WARM
    This option performs a WARM start of the server in normal mode, as for previous releases. The XCOMRRDS transfer queue is read and requests are queued for pending work in the XCOMRRDS data set.
  • COLD
    This option performs a COLD start of the server. It removes all pending work from the RRDS. (This is roughly the equivalent of deleting and defining the XCOMRRDS data set, with the exception that the next transfer request number is not reset to 1000.)
  • HOLD
    This option performs a HOLD start of the server. It reads the XCOMRRDS transfer queue data set and builds requests for all pending work. The difference between HOLD and WARM is that all LOCALLY initiated transfer requests are placed in a HOLD status.
Default:
WARM
REPCR
Specifies whether CA XCOM Data Transport is to attempt to do a CREATE when receiving a transfer with FILEOPT=ADD|REPLACE and the data set does not exist.
  • YES
    Specifies that CA XCOM Data Transport will attempt to do a CREATE when receiving a transfer with FILEOPT=ADD|REPLACE and the data set does not exist.
  • NO
    Specifies that CA XCOM Data Transport will fail the transfer when receiving a transfer with FILEOPT=ADD|REPLACE and the data set does not exist.
Default:
NO
The REPCR default parameter can be specified in the default table or overridden by the XCOMJOB/XCOMXFER EXEC parameter.
The value of REPCR can also be modified using the operator DFLT command.
SECURE_SCHEDULE
Indicates to XCOMJOB whether a secure (SSL/TLS) TCP/IP connection is used against the target server.
  • YES
XCOMJOB uses a secure (SSL/TLS) TCP/IP connection to connect to the target server referenced in the STCIP parameter.
  • NO
    A regular TCP/IP connection is used.
  • This parameter applies only to XCOMJOBs using TCP/IP. It has no meaning for SNA-based operations.
  • When SECURE_SCHEDULE=YES, a secure connection is made in the server using the INITIATE_SIDE and RECEIVE_SIDE values of the parameters defined in the XCOM_CONFIG_SSL file. If the INITIATE_SIDE and RECEIVE_SIDE values for a parameter are in conflict, then the schedule of the transfer will fail. For example, if the SSL_METHOD parameter is defined with INITIATE_SIDE=TLS and RECEIVE_SIDE=V3, then this will cause the schedule of the transfer to fail because the SSL/TLS method does not support the V3 SSL method.
Default:
The SSL and SECURE_SOCKET parameter combinations in the Default Options Table determines the default value.
SERL
Specifies the number of times CA XCOM Data Transport tries to establish a session with the partner LU after the first attempt at session establishment has failed. Used for SNA transfers only.
  • 0
    Specifies that CA XCOM Data Transport does not attempt session establishment after the first session establishment error.
  • 1 to 254
    Specifies the number of retries.
  • 255
    Specifies that CA XCOM Data Transport retries session establishment indefinitely.
Default:
255
CA XCOM Data Transport retries a transfer at the interval specified by the ERRINTV parameter. Because SERL specifies the number of retries, the transfer is attempted SERL+1 times (that is, the initial attempt to establish a session is not included in the count).
For group transfers, a session establishment error is considered to have occurred only after attempts at session establishment with
all
LUs in the group have failed.
For example, if a group contains three LUs and SERL=2 is specified, CA XCOM Data Transport must try session establishment with each LU in the group before the session establishment error count is incremented. If all three attempts fail, the error count is set to 1 and CA XCOM Data Transport retries session establishment with each LU (this is the first retry). If the three session establishment attempts fail again, the error count is set to 2 and all three LUs are retried (this is the second retry). If all three fail this time, too, CA XCOM Data Transport stops making further session establishment attempts because the session establishment retry limit (SERL) has been reached.
STCAPPL
Indicates to XCOMJOB the APPLID of the CA XCOM Data Transport server to which this request is to be queued.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters indicating the CA XCOM Data Transport server where this request is to be queued.
STCAPPL is necessary when there are several CA XCOM Data Transport servers running on your system and during third-party transfers when you want to send a file from a server other than your own to a third remote system.
Only TYPE=SCHEDULE transfers are valid for third-party initiates.
STCIP
Indicates to XCOMJOB the IP address of the CA XCOM Data Transport server to which this request is to be queued.
  • 1 to 63 alphanumeric characters
    Specifies the name or address of the remote TCP/IP system that is involved in a transfer. This name can contain up to 63 alphanumeric characters and it must be one that has been defined to the domain name server. The address can be in IPv4 or IPv6 notation.
STCPLEXQ
Indicates to XCOMJOB the name of the PLEXQ group that is the target to which this request is to be queued. 1 to 8 alphanumeric characters.
1 to 8 alphanumeric characters
Specifies the name of the PLEXQ group which is the target of a meta-transfer request. This name can contain up to 8 alphanumeric or the following characters: @, #, $ and _ (underscore). To connect to a PLEXQ group from XCOMJOB, at least one CA XCOM Data Transport server must already be active.
STCPORT
If the STCIP parameter is also specified, STCPORT indicates to XCOMJOB the IP PORT of the CA XCOM Data Transport server to which this request is to be queued.
  • 1 to 65535
    Specifies a number that indicates the IP port of the started task.
Default:
If the STCPORT parameter is not specified, the IPPORT parameter value that is defined in the CA XCOM Data Transport Default Options Table is used.
STCPROTOCOL
STCPROTOCOL specifies the started task communication protocol XCOM jobs uses when scheduling requests.
  • SNA
    Specifies that an XCOMJOB schedules the request with the started task using SNA communications.
  • TCP
    Specifies that the XCOMJOB schedules the request with the started task using TCP/IP communications (non-SSL/TLS).
  • SSL
    Specifies that the XCOMJOB schedules the request with the started task using Secure Socket Layer (SSL/TLS) communications.
  • PLQ
    Specifies that the XCOMJOB schedules the request with the started task using IBM Parallel Sysplex Signaling Services. This is referred to as the PLEXQ by CA XCOM Data Transport.
Default:
Determined dynamically if STCAPPL, STCIP, STCPLEXQ, or SECURE_SCHEDULE are specified as the EXEC parameters. If more than one of these parameters is specified, the value is decided based on the following order:
SNA if STCAPPL is specified
  • TCP if STCIP is specified and SECURE_SCHEDULE is not specified or set to NO
  • SSL if STCIP is specified and SECURE_SCHEDULE=YES is specified
  • PLQ if STCPLEXQ is specified.
SUPPLIST
Specifies whether CA XCOM Data Transport is to suppress XCOMM0397I and XCOMM0398I messages when processing transfers of PDS or PDSE (source) members.
  • YES
    Specifies that CA XCOM Data Transport will suppress the XCOMM0397I and XCOMM0398I messages.
  • NO
    Specifies that CA XCOM Data Transport will allow the following messages to be issued to the console when processing transfers of PDS or PDSE (source) members:
    • XCOMM0397I
      membname
      BEING TRANSMITTED
    • XCOMM0398I
      membname
      BEING RECEIVED
Default:
NO
The SUPPLIST default parameter can be specified in the default table or overridden by the XCOMJOB/XCOMXFER EXEC parameter.
The value of SUPPLIST can also be modified using the operator DFLT command.
SWAIT
Specifies the number of seconds that CA XCOM Data Transport waits for a session to be established after the request for session establishment has been queued.
  • 1 to 32767
    Specifies the time limit in seconds within which a queued session establishment request must result in the establishment of a session.
Default:
30
If CA XCOM Data Transport's first attempt at session establishment fails, a request for session establishment is placed in a request queue. A session must be established within the time specified by the SWAIT parameter. If no session is established within the specified time, a session establishment error is considered to have occurred, which results in incrementing the value of the SERL parameter. For a description of the SERL parameter, see the Administrating section.
SSL_VERSION
For the SSL/TLS transfers, SSL_VERSION specifies the version of SSL/TLS to invoke.
  • OPEN
    Specifies that OpenSSL is used to satisfy calls for the secure socket communication.
  • SYSTEM
    Specifies that IBM System SSL is used to satisfy calls for the secure socket communication.
Default:
OPEN
CA XCOM Data Transport support for IBM System SSL requires z/OS 1.13 or above.
TCPSTACK
Job name or started task name of the TCP/IP stack that the CA XCOM Data Transport TCP/IP interface uses. To specify the desired stack, if multiple stacks are running at your site, use this parameter. The TCP/IP stack that is specified is used for both initiating and receiving transfers.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters indicating the job name or started task of the TCP/IP stack that the CA XCOM Data Transport TCP/IP interface uses.
Default:
None
An empty value causes the CA XCOM Data Transport TCP/IP interface to use all IP stacks.
TERL
Specifies the number of file allocation errors, VTAM errors, and retries during TCP/IP session establishment that CA XCOM Data Transport will allow before terminating the transfer.
  • 0
    Specifies that no errors are retried (regardless of the settings of FERL, SERL, or VERL).
  • 1 to 32766
    Specifies the total number of times that CA XCOM Data Transport attempts to correct errors.
  • 32767
    Specifies that errors are retried indefinitely.
Default:
32767
If the number of errors for a particular category of retriable errors (FERL, SERL, VERL) or any combination of such categories is equal to the value of TERL, CA XCOM Data Transport stops further retry attempts and fails the transfer. For example, suppose that TERL=10, FERL=6, SERL=6, and VERL=4. If CA XCOM Data Transport has retried file allocation 5 times and session establishment 5 times, the total error retry limit (TERL) has been reached. Therefore, CA XCOM Data Transport makes no further error retry attempts, although the individual error retry limits have not been reached.
TERL=32767 (that is, indefinite number of error retries) does not override a value of FERL, SERL, or VERL that indicates a finite number of retries (such as any value greater than 0 but smaller than 255). For example, if TERL=32767 and SERL=5, CA XCOM Data Transport stops retrying session establishment errors after the fifth error has occurred, instead of continuing indefinitely.
TIMEOUT
Indicates the maximum duration that CA XCOM Data Transport is to wait for any VTAM or TCP/IP command to complete before terminating the program with an abnormal return code. This ensures that the CA XCOM Data Transport Batch Interface does not hold up an initiator or socket indefinitely. For example, if a target system is unavailable, VTAM cannot initiate a session; therefore, the procedure terminates at the specified time-out value. Similarly, a SEND or RECEIVE command times out if a transmission gets hung up.
  • 0 to 99999 seconds
    Specifies how long CA XCOM Data Transport should wait for a VTAM or TCP/IP command before terminating the program.
CA XCOM Data Transport always queues to VTAM the request to establish the session with the remote system. If TYPE=EXECUTE or TYPE=INQUIRE, CA XCOM Data Transport attempts to establish the session within the time specified in the TIMEOUT parameter. If it cannot, then the job aborts. An error message is written to the CA XCOM Data Transport log and is also sent to the operator console. A return code of 9 or 10 is also issued.
For a TCP/IP transfer, the TIMEOUT parameter determines how long to wait for a connection to a remote IP node
TIMEOUT should not be less than 60 seconds, to allow sufficient time for a normal transfer or inquiry request to complete.
Default:
600
TRACE
Activates the internal CA XCOM Data Transport trace function as an alternative to the VTAM trace. The trace data, often useful in debugging problems, is sent to the SYSOUT class defined by the DUMPCL parameter.
  • level
    A value from 0 through 9 which enables and specifies the level of the CA XCOM Data Transport trace function instead of the VTAM trace. Level 0 provides the minimal trace data while level 9 provides maximum trace data. Levels in between build incrementally on level 0.
  • YES
    Use the CA XCOM Data Transport trace function instead of the VTAM trace. It will also force level 9 trace data.
  • NO
    Do not use the CA XCOM Data Transport trace function.
Default:
NO
TRANSFERS_ALLOWED
Specifies which types of transfers the CA XCOM Data Transport server is allowed to process.
  • ALL
    All transfer types are allowed to be processed.
  • LOCAL
    The server only processes locally initiated transfer requests.
  • REMOTE
    The server only processes remotely initiated transfer requests.
  • NONE
    The server will not process any transfer requests.
Default:
ALL
All meta transfers, commands, inquiries, and history requests are processed by the server, regardless of the value selected.
Transfers that are not processed remain on the queue in an inactive or remote suspended state. The transfers are subject to retries based on the server configuration.
If the server participates in a PLEXQ or XCOMPLEX environment, a high ranking is applied to the server when locally initiated transfers are disabled. This prevents transfers that are submitted to the PLEXQ or XCOMPLEX from being rejected in the event the server is selected to process the request.
TYPE
Specifies how CA XCOM Data Transport is to process the transfer request. Required
.
  • SCHEDULE
    Queues the file transfer request and ends the job step when the transfer request is queued. The request runs in the address space of the CA XCOM Data Transport server. The file transfer is single-threaded in first-in-first-out queuing order (unless overridden by priority considerations) and is implemented when the resource becomes available.
    If the target system is unavailable during the execution of a job, the transfer occurs as soon as it becomes available. If the target system is available and the CA XCOM Data Transport server is active, the transfer can be executed immediately.
    TYPE=SCHEDULE is recommended for production jobs.
  • EXECUTE
    Indicates that the file transfer is to be processed during the execution of the current job. If the file transfer cannot be executed before the specified job time-out interval, CA XCOM Data Transport generates condition codes and messages. This transfer type is supported by most CA XCOM Data Transport platforms. For a list of restrictions, contactBroadcom Support.
    If TYPE=EXECUTE and another user has established a session with the same target system, your job aborts if the other user's session does not end before the time-out interval has expired.
  • INQUIRE
    Indicates whether all transfers specified in a job request have completed successfully, and whether any transfers were incomplete or unsuccessful.
  • HISTORY
    Retrieves history records based on specified criteria, such as user ID, transfer ID, TCP/IP address, dates and times, file size or type, and send or receive.
For more information about return codes, see XCOMJOB Return Codes in this section.
VERL
Used by VTAM and TCP/IP to determine the number of times CA XCOM Data Transport attempts to retry a file transfer that has received a network error.
  • 0
    Specifies that the transfer is not retried.
  • 1 to 254
    Specifies the number of retry attempts.
  • 255
    Specifies that the transfer is retried indefinitely.
Default:
255
CA XCOM Data Transport retries a transfer at the interval specified by the ERRINTV parameter. Because this parameter specifies the number of retries, the transfer will be attempted VERL+1 times (that is, the initial attempt to establish a session is not included in the count).
VTAMGNAM
Specifies the VTAM Generic Resource Name that the server attempts to open at initialization time.
This parameter is valid only for the CA XCOM Data Transport server job.
  • xxxxxxxx
    Specify the one- to eight-character alphanumeric Generic Resource Name.
Default:
None
XCOMPLEX
Specifies the name of the XCOMPLEX facility that the CA XCOM Data Transport Administrator administers.
Specify the same XCOMPLEX name for each CA XCOM Data Transport server that is a member of the XCOMPLEX facility. The name for the XCOMPLEX must be unique and cannot be the same as the acbname for any server in the XCOMPLEX.
This parameter is valid for the CA XCOM Data Transport server job and the CA XCOM Data Transport administrator job.
  • xxxxxxxxxxxxxxxx
    Specify the 1- to 16-character alphanumeric name of the XCOMPLEX to join
Default:
None
ZIIP
Specifies whether CA XCOM Data Transport should utilize zIIP processors to reduce CPU utilization costs.
Specify Yes or No to indicate if a zIIP can be utilized to offload some processing from the main CPUs.
Default:
YES