Mainframe Parameter Reference

This is a list of all of the parameters that can be supplied to an XCOM transmission in the SYSIN01 dataset.

AGE
0 - 999 Specifies the number of days that a transfer request can remain in the queue before being purged.
CKPT
0 - 9999 Specifies the number of records to transfer for a checkpoint interval.
CODE
  • EBCDIC Indicates that the transferred data are coded in EBCDIC format
  • ASCII Indicates that the transferred data are coded in ASCII format
  • BINARY Indicates that the transferred data are coded in binary format
COMPRESS
  • YES Provides Run-Length Encoding (RLE) for blanks and binary zeros only. YES is the default.
  • NO No data compression.
  • RLE Provides complete Run-Length Encoding for all characters.
  • COMPACT Provides full RLE (as in RLE above) plus a byte compaction scheme which is suitable for uppercase English text.
  • COMPACTL Same as COMPACT above, only the compaction scheme is most beneficial for lowercase English text.
  • LZSMALL CA-XCOM compresses the data according to the small memory model of Lempel-Ziv 77 compression.
  • LZMEDIUM CA-XCOM compresses the data according to the medium memory model of Lempel-Ziv 77 compression.
  • LZLARGE CA-XCOM compresses the data according to the large memory model of Lempel-Ziv 77 compression.
DROPSESS
  • YES Drop the LU-LU session after a file transfer completes.
  • NO Retain the LU-LU session after a file transfer completes.
  • QEMPTY After a file transfer completes, first check the queue and then drop the session if there are no requests on the queue for this session
EPRTY
1 - 255 Specifies an execution priority from 1 to 255, where 1 is the lowest priority.
FILETYPE
  • FILE Indicates that 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.
  • JOBIndicates that the transferred information is a batch job submitted for execution on the remote computer. This parameter value can be used only with TYPE=SEND requests.
  • REPORT Indicates that the transferred information is a report to be printed on the remote computer. This parameter value can be used only with TYPE=SEND requests.
GROUP
xxxxxxxx Specifies the name of a group of LUs defined in the CA-XCOM control library (CAI.CIN30CTL). 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.
HOLD
  • YES This transfer will not be initiated until it is released in one of the following ways:
    • Through the Menu Interface
    • By an operator for a RELEASE command
    • Through the XTC facility
  • NO This transfer is not held.
ID
xxxxxxxxxx Identify the file transfer using one to ten alphanumeric or national characters.
INQWAIT
000000-995959 Specifies how long CA-XCOM should wait after a transfer request before determining and reporting the status of a transfer request.
IPNAME
1-63 alphanumeric characters Specifies the address of the remote IP node with a name (which must be defined/known to the domain name server) or
nnn.nnn.nnn.nnn Specifies the address of the remote IP node with a number in dotted decimal notation.
IPPORT
nnnnSpecifies a number indicating the IP port of the remote system.
LFILE
1 - 256 charactersSpecifies the local dataset involved in a file transfer. This can be the name of a file copied to a remote system or the filename of a dataset received from a remote system. Alternatively, the local dataset name can be specified using the LCLDS01 DD statement. If both are specified, the dataset defined by LFILE will take precedence.
A wildcard character (*) can be used if transferring between IBM mainframe systems.
LIST
xxxxxxxxSpecifies the name of a distribution list designating where this file should be broadcast.
LPASS
xxxxxxxx Specifies a password of up to eight alphanumeric characters that is associated with LUSER.
LU
xxxxxxxx Specifies the name of the remote LU. The name may contain up to eight alphanumeric characters
LUSER
xxxxxxxx Specifies up to eight alphanumeric characters representing a user ID whose access privileges on the source computer are used for the file transfer.
NEWXFER
Indicates the beginning of a new file transfer definition. Unlike all other SYSIN01 parameters, no value is assigned to this parameter.
NOTIFY
  • LOG Requests that the main console operator on this computer be notified.
  • Tso_user_id Identifies the TSO user who is sent a broadcast message when the file transfer completes. Any value except LOG is interpreted by CA-XCOM 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.
    Note: Do not use NOTIFYNAME or RNOTIFYNAME operands for TSO users.
  • CICS Causes CA-XCOM to begin an LU 6.2 process to CICS when the file transfer concludes. See NOTIFYNAME.
  • ROSCOE Sends notification messages to users of Computer Associates' ROSCOE timesharing product when a file transfer begins, ends, or fails. See NOTIFYNAME
  • ALL If the remote computer is a VAX, CA-XCOM can send notification to the electronic mailboxes of DEC ALL-in-1 users. See NOTIFYNAME.
If either NOTIFY=CICS, NOTIFY=ROSCOE or NOTIFY=ALL is selected, then also NOTIFYNAME (below) must be specified.
NOTIFYNAME
xxxxxxxx Indicates the TP name under CICS, or the ROSCOE key or 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.
PASSWORD
Specifies up to 31 characters representing the user password that is to be used for CA-XCOM execution on the remote system.
RESTART
  • YES Start from the nearest checkpoint; do not start from the beginning of the transfer.
  • NO Signals that the file transfer should be restarted from the beginning, even if a checkpoint restart is feasible. NO is the default.
RNOTIFY
  • LOG Requests that the main operator on the remote computer 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 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.
  • CICS Causes CA-XCOM to begin an LU 6.2 process to CICS when the file transfer concludes. This is only used when the remote computer is MVS.
  • ROSCOE Sends notification messages to users of Computer Associates' ROSCOE timesharing product when a file begins, ends, or fails. See RNOTIFYNAME.
  • ALL Sends notification to the electronic mailboxes of DEC ALL-in-1 users (if the remote system is a VAX). See RNOTIFYNAME.
RNOTIFYNAME
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.
SPRTY
1-255 Specifies a scheduling priority for this file transfer request. The default is 16.
STARTDATE
The transfer start date can be provided in one of three formats:
  1. yyyymmdd
  2. yyddd (Julian date)
  3. +nnn (nnn days from today)
STARTTIME
0000-2400 Specifies the time (hhmm) this transfer becomes eligible for execution.
TRUNCATE
Tells CA-XCOM how to respond to records in the source file which exceed the maximum record length permitted on the target computer.
  • YES Truncate any excess characters.
  • NO Abort the transfer. Once the problem has been resolved, the transfer must be rerun.
TDUDATA
1-10 (bytes) Specifies up to 10 bytes of data available to user exits during a file transfer.
TYPE
  • SEND Indicates that the file transfer is outbound from this system.
  • RECEIVE Indicates that the file transfer is inbound to this system.
USER
xxxxxxxx Specifies one to eight alphanumeric characters representing a user whose CA-XCOM session is to be used for a file transfer.
USERID
xxxxxxxxxx Specifies a user ID (up to 12 alphanumeric characters) whose access privileges on the remote computer are used for this file transfer.

 

This article written by Stephen Chapman, Felgall Pty Ltd.

go to top

FaceBook Follow
Twitter Follow
Donate