General Parameters, H-P

The SYSIN01 general parameters that begin with H through P follow. Unless otherwise noted, the parameters that are described in the following list are optional.
xdtz12
The SYSIN01 general parameters that begin with H through P follow. Unless otherwise noted, the parameters that are described in the following list are optional.
3
HOLD
HOLD prevents a TYPE=SCHEDULE transfer from starting until explicitly released.
  • YES
    This transfer is not initiated until it is released in one of the following ways:
    • Through the Menu Interface
    • By an operator with a RELEASE command
    • Through the XTC facility
  • NO
    This transfer is not held.
Default:
NO
ID
Associates a descriptive identifier with this file transfer.
  • xxxxxxxxxx
    Identify the file transfer using one to ten alphanumeric or national characters.
The ID complements the request number that is assigned to every locally initiated file transfer. This ID appears before the message on the CA XCOM Data Transport message log and after the message when it is displayed on a console. The ID is passed to remote systems and is displayed in the remote system CA XCOM Data Transport log.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
The job name of the job that is used to invoke the batch interface
INQWAIT
INQWAIT identifies how long CA XCOM Data Transport must wait in hours, minutes, and seconds (
hhmmss
) before determining and reporting the status of a transfer request. The maximum possible wait is one second less than 100 hours.
  • 000000 to 995959
    This value specifies how long CA XCOM Data Transport must wait after a transfer request before determining and reporting the status of a transfer request.
Only valid for TYPE=INQUIRE transfers.
Default:
The value that is specified in CA XCOM Data Transport Default Options Table
IPNAME
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 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.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters. GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of these parameters is coded (either on the EXEC card or in SYSIN01). Coding more than one causes an error.
IPPORT
IPPORT identifies the IP port of the remote system for a TCP/IP transfer.
  • 1 to 65535
    This value specifies a number indicating the IP port of the remote system.
Default:
If this parameter is not specified, the value of IPPORT parameter that is defined in the CA XCOM Data Transport Default Options Table is used.
When GROUP= or LIST= is used, the destination member or the default table determines the value for IPPORT.
LCLNTFYL
LCLNTFYL specifies the local 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, 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.
LFILE
LFILE identifies the local data set involved in a file transfer.
1 to 54 characters (for a non-USS file)
Specifies the non-USS local data set involved in a file transfer.
This can be the name of a file that is copied to a remote system or the file name of a data set received from a remote system. Alternatively, the local data set name can be specified using the LCLDS01 DD statement. If both are specified, the data set defined by LFILE takes precedence.
Specifies up to 54 characters consisting of:
  • A 1-character to 44-character data set name
  • An optional member name that is enclosed in parentheses, If transferring between IBM mainframe systems, a wildcard character (*) can be used.
Use an asterisk as the member name to show that all members of a partitioned data set are transferred.
For example, the statement LFILE=PAYROLL.PDS(*) indicates that all members of the PAYROLL partitioned data set are to be transferred.
Use the prefix followed by an asterisk if all members beginning with a specific prefix are to be transferred. For example, NAMES.PDS(AL*) requests that members AL, ALEX, and ALICE are all to be transferred. The asterisk must be the last character before the right parenthesis.
The use of wildcards (*) is supported only between IBM mainframe systems and platforms running CA XCOM Data Transport Version 3.1, r11, r11.5 or r11.6.
1 to 255 characters (for a USS file)
Specifies the USS local data set involved in a file transfer. This can be the name of a file that is copied to a remote system or the file name of a data set received from a remote system. Alternatively, the local data set name can be specified using the LCLDS01 DD statement. If both are specified, the data set defined by LFILE takes precedence.
Specifies up to 255 characters consisting of:
  • / (the first character of the data set name)
  • A 1-character to 254-character data set name
If transferring to IBM mainframe systems, Windows systems, or UNIX systems, one or more wildcard characters (*) can be used.
The transfer of USS files is supported only between systems running CA XCOM Data Transport r11.5 and above.
USS Examples
  • LFILE=/u/users/xcom/*
    Transfer ALL files.
  • LFILE=/u/users/xcom/m*
    Transfer ALL files starting with an m.
  • LFILE=/u/users/xcom/*m
    Transfer ALL files ending with an m.
  • LFILE=/u/users/xcom/m*m
    Transfer ALL files starting with an m and ending with an m.
  • LFILE=/u/users/xcom/m*y*m
    Transfer ALL files starting with an m, ending with an m
    and
    containing a y.
  • LFILE=/u/users/xcom/m*you*
    Transfer ALL files starting with an m
    and
    containing the characters you in succession.
  • LFILE=/u/users/xcom/m*y*o*u*
    Transfer ALL files starting with an m
    and
    containing the characters y and o and u.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
LFILEDATA
This parameter indicates how the local USS file is allocated.
  • B
    Binary
  • T
    Text
  • R
    Record
If the value is not specified for LFILEDATA, then the allocation is determined based on the CODE= specification, the value of the Data Encoding (CODE) and the 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 LFILEDATA, as follows:
    • If you
      do not
      specify LFILEDATA=B, the file is allocated as a text file. The file is also processed as an EBCDIC text file.
    • If you
      do
      specify LFILEDATA=B, then the file is allocated as a binary file. The file is also processed as an EBCDIC file.
    • If you
      do
      specify LFILEDATA=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 LFILEDATA=B, then specify a value for USSLRECL. The value tells CA XCOM Data Transport how many bytes there are in each logical record.
LIST
Broadcasts this file transfer to all remote destinations designated on a predefined distribution list.
  • xxxxxxxx
    Specifies the name of a distribution list designating where this file must be broadcast. The name can be up to eight alphanumeric characters long. The list name can be the name of a superlist.
GROUP, LIST, and LU 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 GROUP= or LIST= is used, the destination member or the default table determines the value for IPPORT.
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.
The LU and IPNAME parameters can be coded within the same list member. This results in the file being transferred to SNA and IP nodes.
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 files transfers involved can have different start times. Use the CA XCOM Data Transport Operator Control function on the Menu Interface to see the current status of any broadcast distribution.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Using a Superlist
Using a Superlist specifies 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:
    • A 32-byte storage descriptor, leaving 32688 bytes for the list
    • Each list entry occupies 4 bytes to 10 bytes:
      • 1 byte for the TYPE
      • 1 flag byte
      • 1 byte for the LENGTH
      • 1 byte 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.
LOCAL_CHARSET
This parameter specifies the local character set CA XCOM Data Transport uses for Unicode transfers (CODE=UTF8 or CODE=UTF16).
  • 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 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’.
Default:
The DEFAULT_CHARSET parameter in the destination member or CA XCOM Data Transport Default Options Table specifies the default.
LOCAL_DELIM
This parameter specifies an optional encoding for which the specified LOCAL_CHARSET is based. The encoding must be the first option in the list and the only valid value is 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 output files when FILEDATA=TEXT.
Used only for UNICODE transfers (CODE=UTF8 or CODE=UTF16).
Valid options are:
  • EBCDIC
    -- The specified character-set is EBCDIC encoded.
  • 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
Default:
The DEFAULT_DELIM parameter in the destination member or CA XCOM Data Transport Default Options Table specifies the default.
For EBCDIC rules, the ‘FF’ delimiter is only valid for Linux/Unix/Windows platforms.
If EBCDIC is specified, it must be the first option in the list.
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
LPASS
LPASS indicates a password or passphrase associated with LUSER. Use LPASS for third-party-initiated file transfer requests.
  • 1 to 100 alphanumeric characters
    Specifies up to 100 alphanumeric characters for a password or passphrase associated with LUSER.
The LPASS parameter should not be confused with the PASSWORD parameter.
For more information on CA XCOM for z/OS passphrase support, see Security Planning.
LU
LU defines the VTAM LU name of the remote system.
  • xxxxxxxx
    Specifies the name of the remote LU. The name can contain up to eight alphanumeric characters.
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of these parameters is coded (either on the EXEC card or in SYSIN01). Coding more than one causes an error.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
LUSER
LUSER specifies a user ID on the source system whose access privileges are used to execute the file transfer.
  • xxxxxxxx
    Specifies up to eight alphanumeric characters representing a user ID whose access privileges on the source system are used for the file transfer.
LUSER is used for a third-party transfer: a user on system A requests that system B (source) execute a file transfer to system C (target). While system A initiated the transfer request, the file transmission is entirely between system B and system C.
The only prerequisites for third-party transfers are:
  • All systems must be identified to VTAM and must be running CA XCOM Data Transport Version 2 or higher.
  • The ID entered for LUSER must satisfy the requirements of the security software in effect on the source system.
If the source system has a default user ID for third-party file transfers, and you want to use this default, then a null value must be specified for this parameter as LUSER=“ ” with at least one space between the quotes.
Not all CA XCOM Data Transport platforms support third-party transfers.
For conventional file transfers, LUSER can be used to identify the user initiating the transfer. This is useful in performing operator tracking and control functions through the menu interface.
Do not confuse LUSER with the USERID parameter. USERID refers to the authorization access ID on the target system, both for ordinary file transfers and third-party initiated transfers.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
The ID associated with the address space created when the file transfer request is made.
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.
MGMTCLAS
MGMTCLAS specifies the one- to eight-character name of the management class to use when allocating a new SMS-managed data set.
This parameter applies only to mainframe SMS data sets.
Default:
None
NEWXFER
NEWXFER indicates the beginning of a new file transfer definition. Unlike all other SYSIN01 parameters, no value is assigned to this parameter. The parameter NEWXFER is entered in SYSIN01 at a point where a new transfer request is defined. The text following the parameter name NEWXFER up to the next occurrence of NEWXFER (if any) forms the definition of a transfer request.
At least one parameter must be specified between succeeding NEWXFER parameters.
To negate a previously specified parameter, specify the parameter again with no value.
It is not necessary to respecify all parameters for an additional file transfer, only those that are different. All parameters other than XTC parameters are propagated. For example, if two TYPE=SEND transfers are requested, then the FILE=
remote_ file_name
parameter is usually specified twice, but the FILETYPE=FILE and TYPE=SEND parameters have to be specified only for the first request.
Multiple SNA and TCP/IP transfers can be intermixed within the same SYSIN01 stream.
For information about TYPE=EXECUTE transfers, see the CONTINUE parameter for XCOMJOB PARM.
NOTIFY
NOTIFY tells CA XCOM Data Transport who to notify on the local system when the file transfer is complete. This parameter is used with NOTIFYNAME. See also RNOTIFY.
  • LOG
    Requests that the main console operator on this system be notified.
  • tso_user_id
    This option identifies the TSO user who is sent a broadcast 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.
    When this option is specified, you cannot use NOTIFYNAME or RNOTIFYNAME parameters.
  • CICS
    Causes CA XCOM Data Transport to begin an LU 6.2 process to CICS when the file transfer concludes. See NOTIFYNAME.
    Note:
    For this result, in addition to NOTIFY=CICS, NOTIFYNAME=cics.
    acbname
    needs to be specified.
  • ROSCOE
    Sends notification messages to users of the CA Roscoe timesharing product when a file transfer begins, ends, or fails. See NOTIFYNAME.
    When you specify NOTIFY=ROSCOE, you must set NOTIFYNAME to the name of the CA Roscoe user to notify on the initiating system and RNOTIFYNAME to the name of the CA Roscoe user on the remote system. To keep a CA Roscoe user informed on a local system, you need to specify NOTIFY=ROSCOE and NOTIFYNAME=
    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.
    When NOTIFY=ALL is selected, then NOTIFYNAME must also be specified.
Default:
LOG
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
NOTIFYNAME
NOTIFYNAME identifies the entity on the local system that is to receive a notification of the completion of the transfer.
  • xxxxxxxx
    Indicates the TP name under CICS, or the CA Roscoe key, or the DEC ALL-in-1 user to be notified at the conclusion of a file transfer by the initiator of the request. The notification receiver name can be up to eight alphanumeric characters long.
This parameter must be used when NOTIFY=CICS, NOTIFY=ROSCOE, or NOTIFY=ALL has been selected.
If you specify NOTIFY=CICS, also specify NOTIFYNAME=cics.
acbname
.
If you specify NOTIFY=ROSCOE, also specify NOTIFYNAME=roscoe
key
.
If you specify NOTIFY=ALL, also specify NOTIFYNAME=
mailbox name
.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
PASSWORD
PASSWORD identifies a password or passphrase for a user ID. CA XCOM Data Transport executes on a remote system with the set of resource access privileges for the user ID. You must use a password that is known to the remote security system.
  • 1 to 100 alphanumeric characters
    Specifies up to 100 alphanumeric characters for a password or passphrase associated with a User ID.
The PASSWORD value is overwritten with a string of asterisks or
xxx...
in any CA XCOM Data Transport log.
  • Using the
    oldpassword/newpassword
    parameter to change a password is no longer supported when the remote system is running IBM RACF, CA ACF2, or CA Top Secret.
  • The PASSWORD parameter should not be confused with the LPASS parameter.
  • For more information on CA XCOM for z/OS passphrase support, see Security Planning.
PROGLIB
PROGLIB specifies whether the transfer is of a PDSE program library or not.
  • YES
    Indicates the transfer of a PDSE program library.
  • NO
    Indicates that the transfer is not of a PDSE program library.
CA XCOM Data Transport uses the values from PSOPREF and PSOVOL to create the temporary data sets used in transferring PDSE program libraries.
Only whole PDSE program libraries can be transferred. The transferring of an individual member or the use of wild cards (for example, ABC*) to transfer multiple members is not supported.
PROGLIB=YES requires the use of an XCOMPRNT DD statement. Ensure any CA XCOM Data Transport for z/OS servers that are used to send or receive PDSE program library transfers have been modified to include the XCOMPRNT DD. See sample member XCOM in Sample Files.
If PROGLIB=YES is used in TYPE=EXECUTE transfers, then XCOMPRNT DD is included in the batch XCOMJOB JCL.
Default:
None