ReceiveFile

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

For MQSeries, this command reads a message from the Src queue and stores its contents in the file Dest. It reads the next message with the correlation ID matching the message ID of the request. For details, see MQSeries protocol in the Kofax Communications Manager Core Developer's Guide.

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 KCM Core side.
• TimeOut: Optional. The maximum amount of time in seconds the command ReceiveFile waits for the download to complete. If this time is exceeded, the download is aborted and an error is reported. If this parameter is omitted, KCM Core uses the default timeout interval as configured in KCM Core Administrator. If this parameter is set to 0, the download does not time out.

Remarks

For TCP/IP, the ReceiveFile command does not perform code page translations. For more information, see ConvertCodepage.

For MQSeries, it depends on the format of the message whether KCM Core Services try to convert data. If the format of the data message is set to MQFMT_STRING, KCM Core tries to convert the data to Unicode before storing it in the indicated file. Otherwise, it requests no conversion. In the latter case, whether 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. For more information, see MQSeries interface in the Kofax Communications Manager Core Developer's Guide.

If the command ReceiveFile is terminated due to a timeout the connection to the KCM Core process is reset to ensure that data in transit is discarded and that 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 fails between the KCM Document Processor and the client. The client will be informed that the KCM Document Processor is disconnected.