ReceiveFile

The ReceiveFile command is used to download binary data from the client to the ITP/Server. This feature requires a synchronous TCP/IP connection or an MQSeries interface.

For MQSeries, this command will read a message from the Src queue and store its contents in the file Dest. It will read the next message whose correlation id matches the message id of the request. For a detailed explanation see the description of the MQSeries protocol in the ITP/Server Manual.

Syntax

ReceiveFile
   Src(<text>)
   Dest(<text>)
   TimeOut(<number>);

Parameters

Src: Required.
For TCP/IP, a client side file identification. For MQSeries, the name of a queue.

Dest: Required.
The file name on the ITP/Server side.

TimeOut: Optional.
The maximum amount of time in seconds the command ReceiveFile will wait for the download to complete. If this time is exceeded the download is aborted and an error is reported.
If this parameter is omitted ITP/Server will use the default time out interval as configured in the ITP/Server Administrator. If this parameter is set to 0 the download will not time out.

Remarks

For TCP/IP the ReceiveFile command will not perform codepage translations; See the ConvertCodepage command for more information.

For MQSeries, it depends on the format of the message whether or not ITP/Server services will try to convert data, If the format of the data message is set to MQFMT_STRING, ITP/Server will try to convert the data to Unicode before storing it in the indicated file. Otherwise it will request no conversion. In the latter case, whether indeed no conversion takes place depends on the configuration of the MQSeries queues, the format of the message, and on whether the client demands a conversion when putting the data on the queue. Refer to the ITP/Server Manual chapter QSeries interface for more information.

If the command ReceiveFile is terminated due to a time out the connection to the ITP/Server process will be reset to ensure that data in transit is discarded and processes resynchronize correctly. This forced reset can result in additional network-related errors in the log for this job. Any further communication from this job between the ITP/Document Processor and the client will fail. The client will be informed that the ITP/Document Processor disconnected.