Loading...

File pickup

Table of Contents

    File pickup

    This consumer is used to read files into a flow. Files are read from the input directory. When a backup directory is defined, files can be copied to this location after they have been read. This consumer polls for files itself.

    Through Response Message type, you can determine if files are read as Document, Text, File or Byte Array.

    The consumer's output is a ConnectMessage, where the content of the file is copied into the message part defined at the value of “MessagePart”.

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

    Non-existing directories will automatically be created.

    Attribute

    Description

    Name*

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

    Enable

    Check this box if you want this consumer to be enabled.

    Consumer Autostart

    Consumer will be started at startup of then interface

    Pickup Directory*

    The directory to read (pick up) the files from. When you use a directory which one of your flows is allready using, constuctor will give you an indication of the fact that this could potentioly be a problem.

    File Pattern

    Only files that validate to this pattern will be read (picked up).

    Because the File Pickup checks if the pattern is REGEX or ANT Style, some patterns are difficult to recognize.
    Check the pattern orderinfo*.xml. Internally this will be recognized as an REGEX expression and therefore you will get no result. To resolve this issue add a * before the string like: *orderinfo*.xml.

    Backup Directory

    Path to the directory where the back-ups are archived. If left empty no back-ups will be made. The complete path of the file after the back-up has completed will be stored in a new property: file_backupFile

    Custom Backup Strategy

    Select default strategy for generating backup files. Defaults to [yyyyMMdd-HHmmssSSS]_[filename]. You can create another backup strategy (name format for your files), by creating a Bean or a Script. You can select the script/bean via the selection box.

    If you select NONE, the default strategy will be taken.

    Delete Original File

    Set to TRUE, will delete the files after being handled and backed up. The default value is true.

    Messagepart

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

    Response Message Type

    The type of the MessagePart where the file content is being stored and will be passed to the next service.

    If the user who logged in has a LargeFileSupport license, you will get some extra specific LargeFile fields:

    • Quality of service: The garanteed delivery schem of a LargeFile, this can be BEST_EFFORT (kind of fire and forget) and AT_LEAST_ONCE, which speaks for itself.
    • LargeFileSupport Timeout: Timeout in secons for LargeFile. When no commit or rollback is recieved QoS will be activated after timeout. Default is 1 hour.

    Max Messages Per Poll

    Number of messages being handled per poll. Ie if max-messages-per-poll is set to 5 and the timer to every 10 seconds a maximum of 5 messages every 10 seconds is handled.

    If set to -1 all messages available are handled per timer interval.
    If set to  0 only 1 message is handled per timer interval.

    Quartz Cron Expression

    Definition of the interval this polling consumer will check for messages. Format (sec) (min) (hour) (day) (month) (year)

    Solid File Check Time

    When files in the pick up directory are expected being written to, this attribute can be used to allow only files to be passed that have a solid file size. The value of this attribute (in milliseconds) is the interval wherein the Consumer checks if the file size has increased or not.

    Keep in mind that this will not work when using the Windows OS. Windows creates the file with a 0 byte file length until the file is completely written. Therefore this mechanism will nog work.

    Legacy Poller

    If set to true, the legacy synchronous poller will be used. If set to false, the newer asynchronous mechanism will be used.

    Encoding

    Used to specify desired encoding strategy for inbound files. The default is UTF-8.

    Description

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

     

     


    Copyright © 2018 ConnectPlaza.   For pricing, account management and more go to https://www.connectplaza.com

    About Connectplaza

    Si components version:   

    Lorem ipsum delore set

    Lorem ipsum delore set

    Window size is not optimal. Please enlarge for optimal experience

    No connection

    No response from the server. This window will automaticly disappear by an valid connection