Local Folder

Top  Previous  Next

Local Folder driver provides monitoring for folders located on the AggreGate server.

Driver Information

Driver Plugin ID:

com.tibbo.linkserver.plugin.device.folder

Global Settings

None defined.

User Level Settings

None defined.

Device Properties

Local Folder driver checks the existence of the folder, acquire folder attributes, load and inspect folder contents (files and subfolders). Contents of a folder can be analyzed recursively (including subfolders) or non-recursively. Besides that, the items to be processed can be filtered using wildcard or regular expression. This can be configured using the following properties:

Field Name

Field Description

Path

Specifies folder location, i.e. full path.

Read Contents

Enables/disables reading of folder contents.

Recursive

If disabled, only contents of the specified folder will be analyzed. Otherwise, all its subfolders will be processed recursively.

Files To Include

Specifies filter for folder items. The options are to process all files and folders, or to select only those satisfying specified regular or wildcard expression.

Device Settings

Local Folder device driver creates two Device setting variables:

Variable Name

Variable Description

Comments

Folder Attributes

attributes

Contains the following attributes:

Last Modification Time (modificationTime)
Size, i.e. total size of all files selected according to Recursive and Files To Include options (size)
File count, i.e. total number of files selected according to Recursive and Files To Include options (fileCount)

Folder Contents

contents

List of folder items (files and subfolders) with the following fields:

Type
Relative Path
Size

Device Operations

No operations provided by the driver.

Device Events

No events provided by the driver.

Connection Handling

A folder device is deemed Online if the selected folder exists.

Synchronization Details

Local Folder Devices are synchronized with AggreGate Server like any other Device. During synchronization, the attributes and contents of the folder are obtained.

Local Folder Status

If all I/O operations with the folder are successfully finished, the local folder Device is deemed "online".

If no folder exists at the path specified, or any error was encountered while accessing the folder, Local Folder Device is considered "offline".

note_warning-wt

If Local Folder is "offline", folder attributes and contents can still be read and analyzed by system facilities. They will, however, have values obtained when the folder was accessed successfully for the last time.