Receive File Queue - OMRCVFIL

Receive File Queue (OMRCVFIL)

Required Parameter Group:

Optional Parameter Group:

API Overview:
The Receive File Queue (OMRCVFIL) API receives data from the specified physical file. The file acts as a FIFO queue (mimicking a data queue) which buffers all transactions between QTRACS and an external application.

The physical file whose data is being received must be in a format dictated by QTRACS/400. Therefore, it is recommended that the file be created using the External Application Detail screen. This will create the file with the correct field types and lengths. QTRACS will then feed EAL transactions to the file and the EAL process may use this API to retrieve its data.

Required Parameter Group Details:
(1) File Name
INPUT; CHAR(10)
The name of the file to receive the data from.

(2) Library Name
INPUT; CHAR(10)
The name of the library where the file resides. Valid values are:

(3) Length of Data
OUTPUT; PACKED(5,0)
The number of characters received from the file. If a time out occurs and no data is received from the file, this field is set to zero.

(4) Data
OUTPUT; CHAR(5000)
This field contains the data received from the file.

(5) Wait Time
INPUT; PACKED(5,0)
The amount of time to wait if no entries exist in the file. When no entries are in the file, the wait time parameter (in seconds) specifies the following:

Optional Parameter Group Details:
(6) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:

(7) Reason Code
OUTPUT; CHAR(4)
This parameter contains a reason code. Possible values returned include;