FILETYPE=FILE Parameters

You can use the following additional SYSIN01 parameters when FILETYPE=FILE is coded in the SYSIN01 DD statement of the XCOMJOB JCL:
xdtz12
You can use the following additional SYSIN01 parameters when FILETYPE=FILE is coded in the SYSIN01 DD statement of the XCOMJOB JCL:
AVGREC
This parameter specifies the multiplier for Primary and Secondary allocation units when allocating a data set based on the number of records. The record size is based on the value of the LRECL parameter.
  • U
    Indicates that the PRI and SEC parameters specify the number of records to allocate for.
  • K
    Indicates that PRI and SEC parameters specify the number of records in thousands (so it would be the number specified multiplied by 1024).
    For example, specifying 3 would be stating 3 K or 3072 records.
  • M
    Indicates that PRI and SEC parameters specify the number of records in millions (so it would be the number specified multiplied by 1048576).
    For example, specifying 2 would be stating 2M or 2097152 records.
Default:
Taken from the CA XCOM Data Transport Default Options table.
This parameter applies only when the SPACE parameter specifies a value of REC for the ALLOC value. Indicating that a file is being allocated based on a specific number of records. For example, SPACE=(alloc, pri, sec, dir).
COMPRESS_PDS
COMPRESS_PDS is the parameter that causes the actual PDS compression to happen. If your CA XCOM Data Transport administrator has enabled the programmatic PDS compression feature in a CA XCOM Data Transport region, you can use the COMPRESS_PDS option to control if and when output PDS data sets get compressed as part of the transfer.
  • NONE
    Suppresses the compression of an output PDS data set as part of a CA XCOM Data Transport transfer.
  • BEFORE
    Compresses an output PDS data set before the transfer of user data begins.
  • AFTER
    Compresses an output PDS data set after the transfer of user data has completed.
  • BOTH
    Compresses an output PDS data set both before and after the transfer of user data.
Default:
NONE
COMPRESS_PDS applies only to PDS data sets that is, or have been, opened for output as the target of a CA XCOM Data Transport transfer.
If the COMPRESS_PDS option is present in the DEST member for a particular transfer partner, and that DEST member is made available to the XCOMJOB utility that is used to schedule a transfer to that partner, it becomes the default value for all transfers initiated with that partner CA XCOM Data Transport in that invocation of XCOMJOB.
If your CA XCOM Data Transport administrator configures CMPRS_PDS_ALLOW=YES or CMPRS_PDS_ALLOW=X37, the COMPRESS_PDS=NONE option cannot suppress the compression of an output PDS data set if a z/OS system abend B37, D37, or E37 occurs.
Output
Output from the compression utility is handled in accordance with the setting of the CMPRS_SYSOUT_CL server-level parameter. The spool data sets (if they are allocated) has the following prefixes:
  • XB for compressions that are performed before a transfer, as in the case with COMPRESS_PDS=BEFORE or on a restarted transfer request
  • XA for transfers that are performed after a transfer
The decimal transfer request number is appended to the prefix to provide a unique spool entry for each compression operation. This naming convention allows for the correlation of compression utility output with a specific file transfer if there is a need for problem determination research after the transfer.
Example:
For a request number 034271, the following spool entry names would apply:
  • The output from the utility used to compress the PDS data set before the transfer would be named XB034271.
  • For a compression performed after the data transfer, the SYSOUT data set would be named XA034271.
EATTR
This parameter identifies if the data set can have extended attributes when the data set is allocated on an Extended Address Volume.
  • OPT
    Specifies that a data set can optionally have extended attributes.
  • NO
    Specifies that a data set cannot have extended attributes.
Default:
None
This parameter is applicable only for data set creation on an IBM mainframe.
FILE
This parameter provides file information for a transfer. This information depends on the type of transfer and the systems being used.
  • Up to 256 alphanumeric characters
    If TYPE=SEND, specify the remote file to which data is transferred.
    If TYPE=RECEIVE, specify the remote file being transferred.
    If the remote system is a z/OS system, specify the data set name.
    If the remote system is a z/OS system with CA XCOM Data Transport, specify the data set name or the fully qualified USS file name.
    If the remote system is a Windows system, specify the full path name.
    If the remote system is an IBM iSeries system, specify the qualified file name.
    If the remote system is an HP OpenVMS system, specify the VMS file name.
    If the remote system is a UNIX or Linux system, specify the fully qualified file name including path information.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
 
If the remote file name includes embedded spaces in the file name, enclose the FILE parameter value in either single or double quotes. For example, to send to the directory
c:\My Documents
on a Windows partner, use the following format:
FILE='c:\My Documents\test.txt'
 
FILEOPT
This parameter indicates how the transferred file is managed by the receiving system.
  • REPLACE
    Replaces the file on the receiving system. What is replaced depends on the type of VSAM file, as follows:
    • KSDS cluster
      Records with matching and non matching keys are replaced.
    • ESDS cluster
      Nothing is replaced. All records are added to the end of the data set, because a non reusable ESDS can only be replaced by deleting and redefining the cluster. Use CREATE to replace reusable VSAM clusters.
    • RRDS cluster
      Nothing is replaced. This is an invalid choice.
      Note:
      If sending a new member to a pre-existing PDS, specify REPLACE.
  • ADD
    Adds the records of the transferred file to the end of an existing sequential file or inserts them into an indexed file if they do not already exist there. If the records already exist there, CA XCOM Data Transport aborts the transfer.
    Note:
    You cannot add to an existing PDS member.
  • CREATE
    Creates the transferred file on the destination system as a sequential file. This option should also be used when VSAM clusters with the REUSE option are to be reused. If the transfer involves a PDS member, specify CREATE only if the PDS itself is being created; otherwise, an error results.
If CREATEDELETE=YES and the data set exists, then the data set is deleted and a new data set is allocated at the start of the transfer.
If CREATEDELETE=NO and the data set exists, then the transfer fails with a catalog/file error.
This parameter is ignored for TYPE=EXECUTE transfers that specify TYPE=RECEIVE in SYSIN01 if the local file is identified through the LCLDS01 DD statement, because in this case the disposition of the file is determined by the DISP parameter on the DD statement.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
REPLACE
LUNIT
This parameter specifies the unit for the local file that is involved in this file transfer.
  • Up to eight characters
    Specifies the unit for the local file that is involved in this unit transfer.
LUNIT is used with the LFILE parameter.
If LCLDS01 is used, the unit can be specified through the JCL parameter UNIT.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
Catalog information or default that is specified in CA XCOM Data Transport Default Options Table.
LVOL
This parameter specifies the volume of the local file that is involved in a file transfer. This is used with the LFILE parameter.
  • Up to six characters
    Specifies the volume of the local file that is involved in a file transfer.
If LCLDS01 is used, the volume can be specified through the VOL JCL parameter.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
Catalog information
PACK
This parameter indicates whether record packing is used. It can substantially improve performance.
  • CRLF
    Inserts a carriage return (CR) and line feed (LF) characters at the end of each record. This is the packing type that is used for most CA XCOM Data Transport platforms.
  • LENGTH
    Specifies that the records are to be packed into fixed-size data transfer blocks. Each record begins with a 2-byte long prefix that indicates the length of the record and determines how many records can be packed into a block. The default block size is 2K but it can be increased to 31K by using the MAXPACK parameter in the CA XCOM Data Transport Default Options Table or in the CA XCOM Data Transport control library member.
    When transferring a text file to a partner that supports record separators (for example, CRLF (0D0A) on Windows and LF (0A) on UNIX), record separators are inserted. No separators are inserted in binary files that are transferred with PACK=LENGTH.
  • NO
    No record packing is used.
PACK=LENGTH with MAXPACK=31744 must be selected when using CA XCOM Data Transport over TCP/IP. If PACK=LENGTH is coded, then you must also code RECSEP=NO.
You can implement record packing on all platforms that CA XCOM supports.
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. It is recommended to specify PACK=LENGTH and use a high MAXPACK value (>= 4096) for TCP/IP transfers or RUSIZE (>=4096) for SNA transfers to make the most efficient use of zIIP.
Default:
NO
RECSEP
This parameter indicates whether record separators (such as carriage returns) are added to the data delimiting records when they are written.
This parameter is ignored if both the sending and receiving systems are EBCDIC.
  • YES
    Add separators to the data delimiting records.
  • NO
    Do not add separators.
If PACK=LENGTH is coded, then you must also code RECSEP=NO.
When transferring a text file to a partner that supports record separators (for example, CRLF (0D0A) on Windows and LF (0A) on UNIX), record separators are inserted. No separators are inserted in binary files transferred with PACK=LENGTH.
Default:
YES
RELEASE
This parameter specifies whether the remote partner is to release unused DASD space when creating a file.
  • YES
    The remote partner is to release unused DASD space.
    The unused DASD space that is specified for the transfer is released when the file is closed at the end of the transfer.
  • NO
    The remote partner is not to release unused DASD space.
Default:
No
SPACE
This parameter specifies the space to be allocated for a z/OS file.
  • Value:
    CYL, TRK, BLK, or REC (for alloc)
    0 to 16777215 (for pri, sec, and dir)
  • Definition:
    This value is specified in the following format:
    SPACE=(alloc,(pri,sec,dir))
    alloc - Specifies cylinders (CYL), tracks (TRK), blocks (BLK) or records (REC) for storage.
    pri - Specifies the primary space allocation.
    sec - Specifies the secondary space allocation.
    dir - Specifies the number of directory blocks for partitioned data sets.
This parameter is used only when creating a file under a system such as z/OS that pre-allocates space.
For more information, see documentation on the z/OS JCL SPACE parameter in the DD statement.
Default:
CA XCOM Data Transport Default Options Table defaults
UNIT
This parameter indicates the unit type where the data set is to be created.
  • xxxxxxxxxx
    Specifies up to ten alphanumeric characters indicating the unit type where the data set is to be created (or where it resides, for existing non-cataloged data sets).
Default:
CA XCOM Data Transport Default Options Table defaults
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
VLR
This parameter indicates whether the transfer is for extended Variable Length Record (VLR) support.
  • YES
    Extended VLR support is requested.
  • NO
    Extended VLR support is not requested.
Default:
NO
VLR=YES is only valid for FILETYPE=FILE and CODE=BINARY.
To use extended VLR support,
both
systems must have extended VLR support. For example, if the CA XCOM Data Transport for Windows system does not have extended VLR support, then you cannot get the desired results by initiating an extended VLR transfer from z/OS to Windows.
VOL
This parameter indicates the volume name where the data set is to be created.
  • xxxxxxxxxx
    Specifies up to ten alphanumeric characters indicating the volume where the data set is to be created (or where it resides, for existing non-cataloged data sets).
Default:
CA XCOM Data Transport Default Options Table defaults
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.