General Parameters, R-Z

The SYSIN01 general parameters that begin with R through Z follow. Unless otherwise noted, the parameters that are described in the following list are optional.
xdtz12
The SYSIN01 general parameters that begin with R through Z follow. Unless otherwise noted, the parameters that are described in the following list are optional.
REMOTE_CHARSET
This parameter specifies the remote character set CA XCOM Data Transport uses for Unicode transfers (CODE=UTF8 or CODE=UTF16).
When the remote system is CA XCOM Data Transport for z/OS:
  • CCSID#nnnnn/tttttttt
    nnnnnn - specifies the CCSID number that corresponds to the character set of the local file. Valid values are 1 - 65535.
    tttttttt (optional) - specifies the technique search order IBM Unicode Services uses when performing conversion. 1 to 8 characters are specified. Valid values to use are:
    R - Roundtrip conversion
    E - Enforced Subset conversion
    C - Customized conversion
    L - Language Environment Behavior conversion
    M - Modified for special use conversion
    B - Bidi transformation (Bi-directional) conversion
    0-9 - User-defined conversions
If the technique search order is not specified, Unicode Services defaults to ‘RECLM’.
When the remote system is CA XCOM Data Transport for Windows or CA XCOM Data Transport for Linux/Unix:
  • CCSID#nnnnn
    nnnnnn - specifies the CCSID number that corresponds to the character set. Valid values are 1 - 65535.
    Alternatively, can be specified as an IANA character set name, or (ICU) acceptable alias name.
Range:
0 to 60 characters
Default:
The DEFAULT_CHARSET parameter in the destination member or CA XCOM Data Transport Default Options Table/Global Parameters on the remote system specifies the default.
REMOTE_DELIM
This parameter specifies an optional encoding for which the specified REMOTE_CHARSET is based. If specified, the encoding must be the first option in the list.
Used only for UNICODE transfers (CODE=UTF8 or CODE=UTF16).
When the remote system is CA XCOM Data Transport for z/OS, the encoding can only be specified as EBCDIC. When the remote system is CA XCOM Data Transport for Windows or CA XCOM Data Transport for Linux/Unix, the encoding can be either ASCII or EBCDIC.
This parameter specifies a colon separated list of record delimiters that are used to mark and detect the end of a record for USS-based files when FILEDATA=TEXT.
Valid options:
EBCDIC - The specified character set is EBCDIC encoded.
ASCII - The specified character set is ASCII encoded (Linux/Unix/Windows only).
NA - Not applicable, the system default delimiter is used.
NL - New line
CR - Carriage return
LF - Line feed
CRLF - Carriage return/Line feed
LFCR - Line feed/Carriage return
CRNL - Carriage return/New line
VT - Vertical tabulation (ASCII only)
FF - Form Feed (For EBCDIC on Linux/Unix/Windows platforms)
The tables list the valid delimiters for the various encodings, with delimiters that are mutually exclusive with each one. CA XCOM Data Transport validates the delimiters that are specified and terminates a transfer where mutually exclusive delimiters are specified.
For EBCDIC rules, the ‘FF’ delimiter is only valid for Linux/Unix/Windows platforms.
If a delimiter is specified that is not valid for the encoding, it is ignored.
EBCDIC Rules
Record Delimiter
Mutually exclusive with
CR
CRLF, CRNL
LF
LFCR
NL
CRLF
CR
LFCR
LF
CRNL
CR
FF
ASCII Rules
Record Delimiter
Mutually exclusive with
CR
CRLF, CRNL
LF
LFCR
NL
CRLF
CR
LFCR
LF
CRNL
CR
VT
FF
UTF Rules
Record Delimiter
Mutually exclusive with
CR
CRLF, CRNL
LF
LFCR
NL
CRLF
CR
LFCR
LF
CRNL
CR
VT
FF
LS
PS
Range:
0 to 60 characters
Default:
The REMOTE_DELIM parameter in the destination member or CA XCOM Data Transport Default Options Table/Global Parameters on the remote system specifies the default.
RESTART
RESTART identifies whether a stopped transfer must be restarted from the nearest checkpoint or from the beginning. This option is only valid for TYPE=EXECUTE transfers, and it is used only if a problem occurred earlier on the restart checkpoint and the transfer request is being resubmitted.
  • YES
    Start from the nearest checkpoint; do not start from the beginning of the transfer.
  • NO
    Signals that the file transfer must be restarted from the beginning, even if a checkpoint restart is feasible. NO is the default.
Default:
NO
RMTNTFYL
RMTNTFYL specifies the remote notification level for transfers that are initiated from the CA XCOM Data Transport for z/OS server.
  • A (All)
    Notify on transfer completion.
  • W (Warn)
    Notify only if the transfer received a warning or error.
  • E (Error)
    Notify only if the transfer received an error.
Default:
A
You can specify this parameter in the XCOMDFLT table, in the destination member, or in the SYSIN01. Its presence is checked for first in the SYSIN01, then in the destination member, and lastly in the XCOMDFLT default table.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
RNOTIFY
RNOTIFY tells CA XCOM Data Transport who to notify on the remote system when the file transfer is complete. This parameter is used with RNOTIFYNAME. See NOTIFY.
  • LOG
    Requests that the main operator on the remote system be notified.
  • tso_user_id
    Identifies the TSO user who is sent a message when the file transfer completes. Any value except LOG is interpreted by CA XCOM Data Transport as a TSO user ID on this system. If this user ID is not logged on when the transfer is completed, the message is displayed the next time the user logs on. Due to the variety of ID types the remote systems allow, an incorrect ID is not detected until the actual notify is attempted.
  • CICS
    Causes CA XCOM Data Transport to begin an LU 6.2 process to CICS when the file transfer concludes. This is used only if the remote system is z/OS.
  • ROSCOE
    Sends notification messages to users of the CA Roscoe timesharing product when a file begins, ends, or fails. NOTIFYNAME is the name of the CA Roscoe user to notify on the initiating system. RNOTIFYNAME is the name of the CA Roscoe user on the remote system. To notify a CA Roscoe user on a remote system, specify RNOTIFY=ROSCOE and RNOTIFYNAME=
    roscoe_key
    .
  • ALL
    If the remote system is an OpenVMS, CA XCOM Data Transport can send notification to the electronic mailboxes of DEC ALL-in-1 users. To notify a DEC ALL-in-1 user, specify RNOTIFY=ALL and RNOTIFYNAME=
    mailbox_name
    .
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
LOG
RNOTIFYNAME
RNOTIFYNAME identifies the entity on the remote system that is to receive a notification of transfer completion.
  • xxxxxxxx
    Specifies the name (up to eight alphanumeric characters) of the remote system entity to be notified by the target system when a transfer completes.
This parameter must be used when RNOTIFY=CICS, RNOTIFY=ROSCOE, or RNOTIFY=ALL has been selected.
    • If you specify RNOTIFY=ROSCOE, also specify RNOTIFYNAME=
      roscoe_key
      .
    • If you specify RNOTIFY=ALL, also specify RNOTIFYNAME=
      mailbox_name
      .
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
SECURE_SOCKET
SECURE_SOCKET specifies whether to use an SSL/TLS socket or non-SSL/TLS socket for transfers.
  • YES
    Performs a secure transfer.
    The transfer uses an SSL/TLS socket and must to connect to an SSL/TLS listener on the remote partner.
  • NO
    Performs a non-secure transfer.
    The transfer uses a non-SSL/TLS socket.
Default:
NO
SPRTY
SPRTY indicates the scheduling priority of this file transfer request. When multiple file transfer requests are eligible for initiation (that is, they are past their start date/time) to the same LU or GROUP, those with higher SPRTY values are scheduled first. One is the lowest priority.
  • 1 to 255
    Specifies a scheduling priority for this file transfer request.
This feature has no effect once the transfer begins executing. Do not confuse it with EPRTY, the execution priority.
Default:
16
STARTDATE
STARTDATE specifies the date when the transfer is to begin.
The transfer start date can be provided in one of three formats:
  • yyyymmdd
    where
    • yyyy
      Is a four-digit designation for a year (for example, 2021).
    • mm
      Is a two-digit designation for one of the 12 months of the year as shown in the following chart:
      1 = January 2 = February 3 = March 4 = April 5 = May 6 = June 7 = July 8 = August 9 = September 10 = October 11 = November 12 = December
    • dd
      Is a two-digit number in the range 01 through 31 designating a day of the month.
Example
STARTDATE=20210201 schedules a transfer to begin on February 1, 2021.
  • yyddd
    (Julian date)
    • yy
Is a two-digit designation for a year (for example, 21).
    • ddd
      Is a three-digit number in the range 001 through 366 designating a day of the year.
Example
STARTDATE=21032 schedules a transfer to start on the 32nd day of 2021, which is the same as February 1, 2021.
  • +
    nnn
    (
    nnn
    days from today)
nnn
    • Is a number in the range 1 through 999.
Example
Specifying STARTDATE=+31 on January 1, 2021 schedules a transfer to begin on February 1, 2021.
Default:
Current date
STARTTIME
STARTTIME specifies the time (
hhmm
) this transfer becomes eligible for execution.
  • 0000 to 2400
    Specifies the time (
    hhmm
    ) this transfer becomes eligible for execution.
You can also set the time for the future in terms of its separation in hours and minutes (+
hhmm
) from the current time.
For example, if a transmission is to start no earlier than 2 p.m.:
STARTTIME=1400
Or if the start time is two hours from now:
STARTTIME=+0200.
Default:
Current time
STORCLAS
STORCLAS specifies the one- to eight-character name of the storage class for a new SMS-managed data set.
This parameter applies only to mainframe SMS data sets.
Default:
None
SYSUDATA
SYSUDATA allows the specification of transfer-dependent user data. This data is available to user exits in the RRDSUSER field of the RRDS data area (mapped by the RRDDSECT macro) while the transfer is pending or active. The RRDSUSER field is defined by HDRDSECT within RRDDSECT.
  • 1 to 10 (bytes)
    This value specifies up to 10 bytes of data available to user exits during a file transfer.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
TDUDATA
TDUDATA allows the specification of transfer-dependent user data. This data is available to user exits in the RRDXUSER field of the RRDS data area (mapped by the RRDDSECT macro) while the transfer is pending or active. The RRDXUSER field is defined by HDRDSECT within RRDDSECT.
  • 1 to 10 (bytes)
    Specifies up to 10 bytes of data available to user exits during a file transfer.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
TRUNCATE
TRUNCATE tells CA XCOM Data Transport how to respond to records in the source file that exceed the maximum record length that is permitted on the target system.
  • YES
    Truncate any excess characters.
  • NO
    Abort the transfer. Once the problem has been resolved, the transfer must be rerun.
The CA XCOM Data Transport mainframe products support these fields: CA XCOM Data Transport for z/OS, CA XCOM Data Transport for VSE, and CA XCOM Data Transport for VM.
When a record is truncated, the data not within the LRECL limit is lost.
The use of truncation is not supported for Unicode transfers. This is due to the possibility of data loss or corruption should truncation occur in the middle of a multi byte character in the file.
Default:
NO
Trusted (Y/N/X)
This parameter specifies whether a user requests a trusted transfer.
  • Y
    Yes, a trusted transfer is requested and the partner's trusted file processes the local userid.
  • N
    No, a trusted transfer is not requested and the partner's trusted file will not process the local userid.
  • X
    XCOM, the local userid is propagated and processed on the partner as it was in prior XCOM releases to provide backwards compatibility.
Default:
X
The values for USERPRO and USEROVR in the default table or TYPE=CONFIG control member affect this functionality. For more information, see the Administrating section for details.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see the Symbolic Parameters.
TYPE
This parameter indicates whether the file transfer is inbound or outbound. Required.
  • SEND
    Indicates that the file transfer is outbound from this system.
  • RECEIVE
    Indicates that the file transfer is inbound to this system.
If TYPE=RECEIVE, then FILETYPE=FILE must be specified.
If TYPE=SEND, one of the three, FILETYPE=FILE, FILETYPE=REPORT, or FILETYPE=JOB, must also be specified.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
UMASK
The file permissions that are removed from the XCOM default file or directory permissions for USS files or directories. UMASK is used only when a file or directory is being created.
Range:
000 to 777
Default:
022
On z/OS systems, the XCOM default file permission is 666, which means:
  • Allow the owner of the file to read and write the file.
  • Allow members of the owners group to read and write the file.
  • Allow all other users read and write the file.
File permissions on USS files are implemented the same way as file permissions are on UNIX systems. The three basic permissions for each of the categories are read, write, and execute, commonly seen as rwx rwx rwx.
If each of these characters (r, w, x) is considered as a bit, then the possible value ranges are as follows:
  • 000 to 111 in binary
  • 0 to 7 in hex
So the default permissions of 666 (110 110 110) mean allow read and write to everyone, but not execute.
The UMASK value identifies the permissions that you want to remove from the default (666). If you remove 022 (000 010 010) from 666, what remains is 644. 644 means:
  • Allow the owner of the file to read and write the file.
  • Allow members of the owners group and all other users to read, but not write.
For directories -- CA XCOM Data Transport sets permissions for a created directory to 7
xx
, no matter what owner UMASK value was specified. Group and other permissions, of
xx
, represent the permissions with the specified UMASK removed.
For files - While the file is being transferred, CA XCOM Data Transport sets permissions for a created file to 6
xx.
Where
xx
represents the permissions with the specified UMASK removed. After the transfer has been completed, CA XCOM Data Transport sets the owner permission with the specified UMASK removed.
USERID
This parameter identifies the user ID that CA XCOM Data Transport is to use on the remote system. The user ID must be known to the remote system's security.
  • xxxxxxxxxx
    Specifies a user ID (up to 12 alphanumeric characters) whose access privileges on the remote system are to be used for this file transfer.
For IBM iSeries or OpenVMS, specify the user's signon. If this parameter is omitted, CA XCOM Data Transport defaults to the ID associated with the address space that submitted the file transfer request.
For example, if there is a JCL USERID parameter coded in the JOB statement of the job invoking XCOMJOB, then that JCL USERID is used. If a blank USERID parameter value is to be sent to the remote system, USERID=“ ” must be entered, with at least one space between the quotes. Do this if the remote system is to supply its own default for the user ID under whose access privileges this transfer is to execute.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
XCOM_CONFIG_SSL
This parameter specifies the ZFS SSL/TLS configuration file path and file name.
  • 1 to 256 characters
    Specifies the ZFS path and file name of the SSL/TLS configuration file used by CA XCOM Data Transport for secure transfers.
Sample SSL/TLS configuration files are provided with the installation. The configssl.cnf file is provided for OpenSSL transfers and the SYSconfigSSL.cnf file is provided for System SSL transfers.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
None