File Source

The File Source object class works in conjunction with the File Sink to allow the user to transfer files from different components (on the same or different hosts) to either a disk locations or the Mongo Repository via the Custom File Data Store when selected as the File Storage Type.

Multiple File Source objects can be associated with a single File Sink.

Use Cases

Transfer of files from different components to a disk on Core host or other component host.
Transfer of files from different components to MongoDB for long term storage.

Quick Configuration

Please visit the How to use File Transfer Objects (File Source and File Sink) section of the documentation for information on how to configure the File Source in conjunction with the other File Transfer objects.

Object Properties

Common

Object Name: The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description: This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

File Sink: The target object to which the files are transferred.

Attachments: File attachments stored in MongoDB file store.

File Source Parameters

A property compound to configure file source parameters.

Disk Folder: The disk folder to be used for the file transfer or file storage.

Save in Processed Folder: If switched on, files which are successfully transferred are moved from the work folder to the 'processed' folder. Regularly such files are completetly removed.

Polling Interval: The time period after which the disk folder is polled for new files.

File Callback: The lua callback that is invoked for each file before it is transferred.

Status

The property indicates the current file transfer status.

File Name: Name of the file that is being transferred.

File Progress: The progress of the current file data transfer.

Pending File Size: The pending file data to be transferred.

Total Pending Files: The number of files in the configured disk folder that are still to be transferred.

Total Pending File Size: The total size of the pending files.

Last Error: The last encountered error during file transfer.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String: A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name: A custom property name which can be used programmatically.

Property Value: The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name: A custom table name which can be used programmatically.

Table Data: Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.