Technical Guide Reference Guide Frequently Asked Questions Tutorials
Show menu

Async File consumer service

Async file consumer service

Service to wait asynchronously for a file and read it into a ConnectMessagePart. With other words, this service can wait for a file to occur on the specified location for a specific time period (timeout). If the file does not occur, you will get an error. If the file occurs within the time period, the file will be read and the next step in your interface will be carried out. 

This differs from a normal read. If you use the normal read, the file MUST exist, otherwise you will get an error. 

In the table below, you will find an explanation of these properties. All attributes with a ‘*’ are mandatory.

Attribute

Description

Name*

By default, we fill this out with the technical ‘tag’, followed by a serial number. Changing the name is optional.

Enabled

Set this value to true, if you want this service to be enabled.

File Location*

Location of the local source file. It must be a URI format starting with 'file:' or 'classpath:'.

Examples:

For Windows

file://localhost/c$/WINDOWS/clock.avi
file:///c:/WINDOWS/clock.avi

For Linux:

file://localhost/etc/fstab
file:///etc/fstab

 

Return Type*

TEXT for String, XML for Document and BYTES for Bytes Message Part. The default is 'TEXT'.

MessagePart-Out

Name of the MessagePart in a ConnectMessage where the content of the file is being stored.

Delete After Reading

This will enable or disable deletion of the file after it has been read.
Timeout

 

Sets the timeout to wait for file to appear. Defaults to 10 seconds.

Description

Description of the specific service. This is for documentation purposes.