Local Folder

Local Folder Device Driver provides monitoring for folders located on the Iotellect server.

Driver Information

Driver Plugin ID:

com.tibbo.linkserver.plugin.device.folder

Global Settings

None defined.

User Level Settings

None defined.

Device Account Properties

Local Folder driver checks the existence of the folder, acquires folder attributes, loads and inspects 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.

Follow Symbolic Links

If enabled, the driver will resolve and follow symlinks when scanning folder contents.

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 Assets

Assets are not supported by the driver.

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

Read Files

This operation reads file content.

Input:

  • File Mask. String. A list of file masks separated by spaces. Returns all files if no masks are specified.

Each mask may include any number of '?' characters to indicate a single wildcard character, and any number of '*' characters to represent multiple wildcard characters. For example:

File Name

Example Mask

Match

c.txt

*.txt

True

c.txt

*.jpg

False

a/b/c.txt

a/b/*

True

c.txt

*.???

True

c.txt

*.????

False

Result:

  • File Name. String. Name of the file.

  • Read Contents. Data Block. Contents of the file.

Upload

This operation uploads a file.

Input:

Result:

  • Result. String. Status of the file upload operation.

Download

This operation downloads a file and provides its checksum.

Input:

Result:

Delete

This operation deletes a file.

Input:

Result:

  • Result. String. Status of the file deletion operation.

Rename

This operation renames a file.

Input:

  • File. String. File name.

  • New File Name. String. New name for the file.

Result:

  • Result. String. Status of the file renaming operation.

Device Events

No events provided by the driver.

Connection Handling

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

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

Synchronization Details

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

Was this page helpful?