File Sink

The File Sink object class works in conjunction with the File Source 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.

Attachments

File attachments stored in MongoDB file store.

Storage Configuration

The property compound for storage configuration.

Type

The storage type selector for file sink.

Local Storage

The compound for the local storage of files.

Disk Folder

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

Database Storage

The compound for the database storage of files.

Custom File Data Store

Select the custom file store where the received file will be saved.

Status

The property indicates the current status of file reception.

Source

The file source from which file is currently received.

File Name

Name of the file that is being received.

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.