ReceiveFile

The ReceiveFile command action allows one TIBCO MFT Platform Server to receive a file from another TIBCO MFT Platform Server.

Parameter Description Default Required
CRCChecking Specifies the credentials and security properties.
The valid values are as follows:
  • Y: yes
  • N: no
None No
CkPtInterval Specifies the checkpoint interval.

The Platform Server checkpoint uses a time interval to determine when to send a checkpoint.

Because checkpoint is time-based, checkpoint always occurs at a regular interval. The checkpoint interval is specified in minutes, and the valid range is 1 to 90 minutes.

None No
CommandType Specifies the type of command.
The valid values are as follows:
  • Command
  • CALLPGM
  • CALLJCL
  • Submit
  • None
None No
CompressionFlag Specifies the compression algorithm.
TIBCO MFT Platform Server provides two different compression algorithms:
  • Limpel-Zev (LZ)
  • Run Length Encoding (RLE)

You can select the algorithm which best suits your network.

The valid values are as follows:
  • L: LZ
  • N: none
  • R: RLE
  • U: undefined
None No
DataConversionType Specifies the type of data conversion to convert data between ASCII and EBCDIC.

This parameter is used when communicating with systems has defined data structures. This parameter would not be necessary if you are communicating from PC to z/OS.

If you use TIBCO MFT Platform Server, when you change the combtlg.dat file, you have to stop and start the Platform Server service for the new conversion table to take effect.

The valid values are as follows:
  • B: binary
  • E: EBCDIC
  • A: ASCII
None No
Delimiter Specifies the carriage return line feed control for transferring files.
The valid values are as follows:
  • C or CRLF: records are delimited by carriage return line feed
  • L or LF: records are delimited by line feed

    This is typically used when transmitting text data to z/OS.

    Note: The line conversion is done on the z/OS platform.
  • N: no record delimiters exist in the file

    This is typically done for a binary transfer.

None No
Department (dpt) Specifies the department associated with the Platform transfer. None No
Description (d) Specifies the 1 to 256 character descriptions of the Platform transfer bank file definition.

The entire description must be enclosed in double quotation marks (“").

None No
EncryptionFlag Specifies the type of encryption to be used with this transfer.
The valid values are as follows:
  • 3D|3DES: 3DES encryption
  • BF: blowfish
  • BFL: blowfish long
  • D|DES: DES encryption
  • N: no encryption
  • R|RJ|AES: Rijndael
  • U: undefined
U No
ExpirationDays Specifies the number of days after which the transfer should no longer be attempted.

If this transfer was scheduled, that will take precedence over expiration.

If expiration and retention are used, whichever value occurs first will take precedence.

The valid value range is 0 to 999999.

0 No
FileWriteMode Specifies the create option for the side writing the file.
The valid values are as follows:
  • A: append
  • C: create
  • CA: create/append
  • CR: create/replace
  • CRN: create/replace/new
  • R: replace
C No
InitiatorFileName Specifies the name of the file on the platform that is initiating the transfer.

On a send request, it is the file to be sent. On a receive request, it is where the file will be placed.

None Yes
LocalTransTable Specifies the location of the local translation table used with this transfer.

If the path contains embedded spaces, the entire path must be enclosed in double quotation marks (").

None No
LoginPWD Specifies the initiating user password.

The password might be up to 64 characters in length and is case sensitive.

None No
LoginUID Specifies the initiator user ID used to log in to TIBCO MFT Platform Server defined by the Platform Server pull-down box.

If this parameter is defined, TIBCO MFT Command Center will use the user ID and password when connecting to MFT Platform Server. If this parameter is not defined, TIBCO MFT Command Center will search for a server credential that matches the user ID and server definition.

None No
PPA1 - PPA4 Specifies the post processing action.

The post processing action allows you to perform up to four actions to be completed by the server when a file transfer request has been completed.

The format of the command indicates whether a post processing action should be performed upon success or failure.

The valid values are as follows:
  • S|F: success or failure
  • L|R: local or remote
  • CALLPGM: calls a z/OS program with program to program parameter linkage

    This parameter allows the user to call a user program defined on the remote z/OS system.

  • CALLJCL: calls a z/OS program with JCL to program parameter linkage

    This parameter allows the user to call a user program defined on the remote z/OS system.

  • COMMAND: issues a command at the node specified in node name

    This is the command that you would like to execute on the remote system.

  • SUBMIT: submits a job at the node specified in the NodeName parameter

    This parameter allows the user to submit a job on the remote system. This differs from file to job transfer requests because the JCL to run actually sits on the remote system.

  • ActionData: specifies the data passed to the post action type when the conditions specified have been met
None No
PServerName Specifies the server name that identifies the initiating TIBCO MFT Platform Server. None Yes
PermittedActions Specifies the Windows-specific file attributes.

These attributes are only valid when sending files to a Windows machine.

The valid values are as follows:
  • A: archive
  • C: NTFS compress
  • E: EOF
  • H: hidden file
  • R: read-only
  • S: system file
  • Z: control Z EOF
None No
PortNum Specifies the IP port on which the remote Platform Server system should be listening on.

The valid value range is 1025 to 65535.

None No
ProcessName Specifies the 8 character field to describe the application which is initiating the transfer. None No
RIPName Specifies the responder IP or host name. Mutually exclusive with RListName. None Yes
RListName Specifies the responder list name. Mutually exclusive with RIPName. None Yes
RNodeName

Specifies the responder node name.

If the remote server is defined in TIBCO MFT Command Center and you know the server name being used for it, you can define it here in place of defining the RIPName parameter.

None Yes

Or the RIPName parameter can be used.

RemoteTransTable Specifies the location of the remote translation table used with this transfer.

If the path contains embedded spaces, the entire path must be enclosed in double quotation marks (").

None No
RemoveTrail (rmtrail) Specifies whether to remove trailing spaces from the file.
The valid values are as follows:
  • Y: yes
  • N: no
N No
ResponderFileName Specifies the name of the file on the platform that is responding to the transfer.

On a send request, it is where the file will be placed. On a receive request, it is the file that will be transferred.

None Yes
ResponderPWD Specifies the remote password.

The password might be up to 64 characters in length and is case sensitive.

None No
ResponderUID Specifies the user ID that the initiator sends to the responder to gain access to the system.

If this parameter is defined, the Platform Server initiator uses the user ID and password when connecting to the Platform Server responder. If this parameter is not defined, the Platform Server initiator will search for a user profile that matches the user ID and responder node definition. If no user profile is found, the Platform Server initiator sends a trusted user that the Platform Server responder can be configured to accept or reject.

None No
RetryInterval Specifies the retry interval. Valid Values between 1-60 (in minutes) (For Unix Only) 1 Yes
SSLFlag Specifies whether to use secure sockets layer (SSL).
The valid values are as follows:
  • Y: yes
  • N: no
  • TLS: TLS tunnel
  • D: default
None No
ScanSubDirectory Specifies the scan of sub-directories.
The valid values are as follows:
  • Y: yes
  • N: no
None No
SecurityAttribute Specifies the file name that the receiving partner uses as a template for its access control list (ACL).

The ACL is a list that specifies users and groups, and their access permissions on a file.

The ACL of this file is copied to the ACL of the destination file. For this feature to function properly on Windows, the file specified must be readable by the partner which is receiving the file to file transfer and the file being created must reside on an NTFS drive.

None No
StopOnFailure Specifies whether to stop on failure of a transaction.
The valid values are as follows:
  • Y: yes
  • N: no
None no
ToEmailAddrF Specifies the email address for failed transactions. None No
ToEmailAddrS Specifies the email address for successful transactions. None No
TrScheduleDate Specifies the transfer schedule date.

The valid values are as follows:

  • YYYY-MM-DD
  • YYYY-MM-DD HH:MM
  • YYYY/MM/DD HH:MM
None No
TransferDirection Specifies the transfer direction.

The valid values are as follows:

  • S: sends file
  • R: receives file
  • C: sends command
None Yes
TruncateFlag Specifies whether to truncate information.

The valid values are as follows:

  • None
  • Truncate
  • Wrap
None Yes
TryMaxCount Specifies the maximum number of transfer retries allowed. None No
UnixPermissions Specifies the UNIX permissions.

When a file is created on a UNIX system, TIBCO MFT Platform Server has the ability to set the UNIX permissions on the file.

The UNIX permissions are defined by a three digit number, such as 777, which is the same as for the chmod command.

None No
UserData Specifies the user data, with any alpha, numeric, or national characters.

This parameter can contain up to 25 characters that will be logged into the history files that contain information that describe the transfer on the local and remote systems.

None No
WaitFlag Specifies whether to wait for completion.

This parameter will show the status of the transfer after execution.

The valid values are as follows:
  • Y: waits for completion.
  • N: does not wait.
None No
zOSAllocDir Specifies the number of directory blocks to allocate.

This parameter is only used when the initiator is z/OS.

None No
zOSAllocPri Specifies the primary allocation value in units of zOSAllocType.

This parameter is only used for transferring files to a z/OS system.

The valid values are any numeric.

None No
zOSAllocSec Specifies the secondary allocation value in units of OS390AllocType.

This parameter is only used for transferring files to a z/OS system.

The valid values are any numeric.

None No
zOSAllocType Specifies the allocation type to be used when transferring files to a z/OS system.
The valid values are as follows:
  • T: tracks
  • B: tlocks
  • C: cylinders
  • K: kilobytes
  • M: megabytes
None No
zOSBlockSize Specifies the block size to be used for file being transferred to a z/OS system.

The valid values are any numeric.

None No
zOSDataClass Specifies the valid data class used when transferring files to a z/OS system.

The values are 1 to 8 character data class names defined by your storage administrator.

None No
zOSLRECL Specifies the logical record length for files being transferred to a z/OS system.

The valid values are any numeric.

None No
zOSMgtClass Specifies the valid management class used when transferring files to a z/OS system.

The valid values are 1 to 8 character management class names defined by your storage administrator.

None No
zOSRECFM Specifies the record format to be used when transferring to a z/OS system.
The valid values are as follows:
  • F: fixed
  • FB: fixed block
  • V: variable
  • VB: variable blocked
  • U: undefined
None No
zOSStorClass Specifies the valid storage class used when transferring files to a z/OS system.

The valid values are 1 to 8 character storage class names defined by your storage administrator.

None No
zOSUnit Specifies the device type for a file being transferred to a z/OS system.

The valid values are any device types defined to your z/OS system.

None No
zOSVolume Specifies the volume serial number for transferring files to a z/OS system.

The valid values are any 1 to 6 character volume serial numbers on your z/OS system.

None No

Sample ReceiveFile Command

This command receives a file to one Platform Server remote platform from another.

java cfcc.CFPlatform a:ReceiveFile PServerName:zOS6 LoginUID:cfuser1 LoginPWD:pswdu1 RNodeName:Win27 PortNum:46464 InitiatorFileName:cfuser1.file ResponderFileName:"c:\cfcc files\zos\file.txt"