Send Request Parameters

The platform server checkpoint feature uses an interval of time when determining when a checkpoint should be sent. Because the checkpointing is time-based, the checkpoint always occurs at a regular interval.

Checkpoint interval is specified in minutes and has a valid range of 1 - 90 minutes. The default is 5 minutes.

This parameter defines the compression algorithm used for this transfer.

The valid values are as follows:

• NONE: indicates that compression is not used for this transfer. It is good practice to specify COMPRESS=NO on high-speed links because compression actually slows down file transfers.
• RLE: indicates that RLE compression is used for this transfer. RLE compression is more data-dependent. That is, the compression ratio might vary widely based upon the type of data being compressed. If network bandwidth is not a critical bottleneck for your network and you must save CPU cycles, choose RLE.
• LZ: indicates that LZ compression is used for this transfer. LZ compression provides better compression ratios than RLE compression. LZ compression also compresses a variety of data types better. If you need better compression ratios and you can spare CPU cycles, choose LZ.
• ZLIB: indicates that ZLIB compression is used for this transfer. Level 1 provides fast compression but low compression ratio. Levels 7 to 9 produce the best compression quality but are slower. Typically, ZLIB2 offers the best compromise between compression quality and speed.

For more information of data compression of the platform server, see Data Compression.

This parameter defines the name of the local data set for this transaction.

The data set name must be a valid z/OS data set and cannot exceed 255 characters in length. If the data set provided is invalid, the interface prompts you for a valid data set name.

To enter a long file name, a plus sign (+) must be entered as the last character in the dataset name field; an additional panel is displayed in which you can enter a long file name.

By default, the interface displays the last data set entered for any transaction.

The following file types are supported:

• Sequential files
• PDS': transfer of entire PDS, members of a PDS based on wildcards, or individual members.
• GDGs: when specifying Generation Data Groups (GDG), you can specify a generation data set using either its true name (that is, with the GOO-VOO qualifier) or the relative generation number. The alias name is turned into the true name at the time the file transfer is scheduled. For example, if you specify generation number -1, the data set transferred is the one that was -1 at queuing time, not necessarily at transmission time.
• VSAM files (KSDS, RRDS, ESDS): this access is transparent to the end user.

The valid values are as follows:

• NONE: indicates that no CRLF or LF translation should be performed during the transfer.
• CRLF: indicates that Carriage Return/Line Feed translation should be performed during the transfer. This parameter has no effect when sent with DATA_TYPE=B (Binary).
• LF: indicates that only Line Feed translation should be performed during the transfer.

This parameter defines the Julian date and the time of the day the transaction is first eligible for execution.

The format of date is MM/DD/YYYY; for example, 01/10/2008 is January 10, 2008. The format of time is HHMM.

The valid values are as follows:

• NONE: indicates that encryption is not used for this transfer.
• AES: indicates that AES 256-bit encryption is used for this transfer.
• AES128: indicates that AES 128-bit encryption is used for this transfer.
• DES: indicates that DES encryption is used for this transfer.
• 3DES: indicates that triple DES encryption is used for this transfer.
• BF|BLOWFISH: indicates that Blowfish 56-bit encryption is used for this transfer.
• BF|BLOWFISH_LONG: indicates that Blowfish 448-bit encryption is used for this transfer.
• AES: indicates that AES 256-bit encryption is used for this transfer.
• NEVER: indicates that no encryption is used for this node. Even if you override the ENCRYPT option in the batch interface, encryption is still turned off for this node.

The default value is 30 days from now.

When this parameter is specified, you must also specify the Input Volume parameter and TAPE=YES.

When this parameter is used, the catalog is not used to allocate the input data set. The platform server verifies that the data set exists on the Input Volume specified. This parameter is valid only when the platform server for z/OS is sending a file to a remote system, or is receiving a file from a platform server for z/OS.

This field is Windows-specific and is only valid when sending requests to a Windows machine.

Up to 25 member names can be defined by this parameter. This parameter is ignored when the data set names on both ends of the file transfer are not PDS or PDSE files.

When you set this parameter to Y and press Enter, the Member Include/Exclude screen is displayed. See Member Include/Exclude for more details.

This is only used when the NODE definition associated with the request defines the DEFAULT_NODECLASS parameter with a non-zero value. If the transfer request does not use a NODE definition, or if the NODE definition specifies DEFAULT_NODECLASS=0, NODECLASS processing will not be performed. If you define the NODECLASS parameter with a value higher than that of the NODE WINNERS parameter, the request will be flagged as an error and the request will be retried at the next error interval.

If this parameter is used, the catalog is not used to allocate the output data set. The platform server verifies that the data set exists on the Output Volume specified.

Use this parameter with extreme care, because most sites use only cataloged data sets. If you use this parameter with a cataloged data set and specify a different volume than the one the cataloged data set resides on, a duplicate uncataloged data set will be created on the Output Volume volume.

This parameter is valid only when the platform server for z/OS is receiving a file from a remote system, or is sending a file to a platform server for z/OS.

Based on the remote platform from which you are sending a file to or receiving a file, your file options differ.

If you choose z/OS, the z/OS Options panel is displayed. See z/OS Options for details.

If you choose Windows, the Windows Options panel is displayed. See Windows Options for details.

If you choose UNIX, the UNIX Options panel is displayed. See UNIX Options for details.

The valid values are 0 - 9; wherein, 0 represents the lowest priority.

The valid values are as follows:

• Create: creates a file on the remote system with the attributes and characteristics as specified. If the file already exists on the remote system, the transaction fails.
• Replace: replaces the contents of the destination file with the contents of the source file. The characteristics and attributes of the remote file remain unchanged. If the file does not exist, the transaction fails.
• Append: appends the contents of the source file to the end of the destination file. The characteristics and attributes of the remote file remain unchanged. If the file does not exist, the transaction fails.
• Create/Replace: if the file does not exist on the remote open system, creates the file; if the file does exist, replaces its contents with the contents of the source file. The characteristics and attributes of the remote file remain unchanged.
• Create/Append: if the file does not exist on the remote system, creates the file; if the file does exist, appends the contents of the source file to the end of the destination file. The characteristics and attributes of the remote file remain unchanged.
• Create/Replace New: creates the remote file or replaces it with new attributes. Only specify this option when transferring files with ICL VME mainframes.

The valid values are 0 - 65535.

The file name can include up to 255 characters (including embedded spaces). If the remote file name contains embedded spaces, the file name must be enclosed in double quotation marks. To enter a long file name, a plus sign (+) must be entered as the last character in the file name field; after that, an additional panel is displayed in which you can enter a long file name.

This field holds the password of the remote user ID used to log on to the remote platform server.

The remote password can be up to 20 characters in length.

When the remote system is a platform server for z/OS, you can optionally change the password of the remote user ID by typing the old password followed by a slash and the new password.

For example, Remote Password. . . .oldpass/newpass.

The valid values are as follows:

• Node/LU
• IP address
• IP name
• List

This field is used in conjunction with the Remote system name field.

This parameter defines the user ID for the remote system or the name by which the issuer is known to the remote system. This field is not required by the platform server.

This parameter defaults to the last user ID entered in this field and is restricted to 20 characters in length.

If you specify *PROFILE, the platform server checks the PROFILE data space for a profile for this user ID that matches the NODE/IPNAME/IPADDR/LIST names.

This parameter is only in effect when communicating with platform server for Windows and platform server for UNIX systems. It is ignored when communicating with platform server for z/OS or for binary transfers.

When this field is specified, its value overrides the value of the Expiration date parameter.

The valid values are 0 - 99; wherein, 0 means no limit.

The valid values are as follows:

• Create: creates a file on the remote system with the attributes and characteristics as specified. If the file already exists on the remote system, the transaction fails.
• Replace: replaces the contents of the destination file with the contents of the source file. The characteristics and attributes of the remote file remain unchanged. If the file does not exist, the transaction fails.
• Append: appends the contents of the source file to the end of the destination file. The characteristics and attributes of the remote file remain unchanged. If the file does not exist, the transaction fails.
• Create/Replace: if the file does not exist on the remote open system, creates the file; if the file does exist, replaces its contents with the contents of the source file. The characteristics and attributes of the remote file remain unchanged.
• Create/Append: if the file does not exist on the remote system, creates the file; if the file does exist, appends the contents of the source file to the end of the destination file. The characteristics and attributes of the remote file remain unchanged.
• Create/Replace New: creates the remote file or replaces it with new attributes. Only specify this option when transferring files with ICL VME mainframes.

If you specify YES, the platform server attempts to use SSL to authenticate both ends of the connection. When you specify NO, the platform server does not use SSL authentication. The default value is NO.

By specifying TUNNEL, all transfer data will be sent over an encrypted TLS Tunnel connection.

The default value is NO.

When this parameter is specified, you must also specify the Input Unit and Input Volume parameters.

This is descriptive data that might be supplied with the transaction.

This parameter defines the record format of the data set being created. The default is Variable.

The valid values are as follows:

• Fixed Blocked: all blocks and all logical records are fixed in size and each block includes one or more logical records.
• Vareach blockiable Blocked: blocks and logical record length can be of any size. Each block includes one or more logical records.
• Fixed: each record contains exactly the number of characters defined by the record length.
• Variable: the length of each record is less than or equal to the record length.
• Undefined: blocks are of variable size. The blocks do not include any logical records. The logical record length is displayed as zero. You must also specify the Block size parameter if you specify Undefined.

For FB, the block size must be a multiple of the record length.

For VB, the record length can be any size up to the block size minus four. The maximum value is 32760. If you set this parameter to the default value, 0, the operating system determines the optimum block size.

This parameter can contain 1 - 8 characters, including numeric, alphabetic, or national characters ($, #, or @). The first character must be an alphabetic or national character.

This parameter can contain 1 - 8 characters, including numeric, alphabetic, or national characters ($, #, or @). The first character must be an alphabetic or national character.

This parameter can contain 1 - 8 characters, including numeric, alphabetic, or national characters ($, #, or @). The first character must be an alphabetic or national character.

The valid values are as follows:

• Tracks: if data set size is expressed in tracks.
• Cylinders: if data set size is expressed in cylinders.
• Megabytes: if data set size is expressed in megabytes.
• Kilobytes: if data set size is expressed in kilobytes.

It can contain 1 - 6 characters.

It can contain 1 - 8 characters.

The valid values are as follows:

• I (Immediate): immediate availability.
• D (Deferred): deferred availability.

This parameter defines the type of file to be created. By default, the file type of the remote file is used.

The valid values are as follows:

• Seq: sequential data set.
• VSAM: VSAM data set.
• PDS/E: partitioned data set extended.
• PDS: partitioned data set.
• DA: direct access.

The valid values are as follows:

• KSDS: key sequenced data set.
• ESDS: entry sequenced data set.
• RRDS: relative record data set.

When sending a record, it defines the platform server to insert the RRDS slot number in the first 4 bytes of the record read.

When receiving a record, it informs the platform server that the RRDS slot number is in the first 4 bytes of the record to be written. This enables a RRDS to RRDS file transfer to maintain the RRDS slot numbers.

This parameter defines whether the file should be opened with the REUSE option. The REUSE option overrides the file when it is used. It can be done under the following two circumstances:

• When the IDCAMS REUSE parameter is defined.
• When the file is being loaded for the first time.

If VSAM_REUSE is specified under any other circumstances, VSAM returns an OPEN error, and the transfer is terminated.

The receiving partner uses this file name as a template for its Access Control List (ACL). The ACL is a list that specifies users and groups and their access permissions to a file.

The ACL of this file is copied to the ACL of the destination file. On Windows, the file specified must be readable by the partner that is receiving the file to file transfer.

You can define the following file attributes:

• System: indicates that the file is a system file that only the operating system, not the user, can view it.
• Hidden: indicates that the user cannot view this file.
• Read Only: indicates that the user can view this file but cannot modify it.
• Archive: select this attribute if you want to mark a file that has changed since it was last backed up.
• NTFS Compressed: when this attribute is selected from the panel, batch interface, JCL, or TSO, the file is created and compressed on the remote system. This attribute is available on NTFS partitions. If the receiving file system is not NTFS, this parameter is ignored.
• EOF: appends an end of file marker to the end of the file.
• CRLF/EOF: appends a CR/LF (0x0d, 0x0a) to the end of the file, followed by the DOS End of File character, Control Z (0x1a). If a trailing Control Z or CR/LF is already present, it will not be added again. This attribute is available only when Carriage Return/Line Feed processing is enabled.

This parameter can be any valid value of 000 - 777.

If you have specified that a mainframe printer is the file destination, you can specify the SYSOUT parameters. These parameters are Windows-specific and are only valid when sending a file to a Windows machine.

• Class: this parameter defines the class to which the JES output will be routed. This is a mandatory parameter. On mainframes, the printer queues are organized around a printer class rather than around a specific printer. The class has a one-character name (alphabetic or numeric character). Ask the mainframe staff for the class name.
• FCB: this parameter defines the form control block for the JES output. This is a symbolic name on the mainframe that is essentially a "font profile". The FCB name is defined by an administrator (or systems programmer) on a mainframe and indicates character size and so on.
  Note: Do not specify a value for this unless necessary.
• Form: this parameter defines the form name upon which this output should be printed. The host operator will receive a message to load the correct type of paper into the printer to print this report. For example, if you are printing shipping labels, the operator will be prompted to load labels into the printer before the printing starts. If you need to use this parameter, tell the operator at the mainframe printer site what paper form to load when he or she sees this name.
• Copies: this parameter defines the number of times that the JES report will be printed on the host printer. The default value is 1.
• Writer: this parameter defines the external writer name that will be used to process this printer file on the mainframe. Essentially, this is the name of a "service" program on the mainframe, which will be given control when it is time to process this file from the printer queue. The "service" program, which is written by the customer, decides how it wants to process this print file.
  Note: Do not specify a value for this parameter unless you are directed to by the systems analyst on the mainframe.
• Destination: this parameter defines the JES print destination name which can be a 1 - 8 character symbolic name that identifies routing information for this print file on the mainframe. This "destination" might indicate the name of a branch office, geographic location, or specific printer to which the report will be sent. If this value is not supplied, most mainframe systems applies a default value of LOCAL.