Local File
Local File Device Driver provides monitoring for files located on the Iotellect server.
Driver Information
Driver Plugin ID: | com.tibbo.linkserver.plugin.device.file |
Global Settings
None defined.
User Level Settings
None defined.
Device Account Properties
Local file monitoring can be configured using the following properties:
Field Name | Field Description |
Path | Specifies the file location (full path). |
Read Contents | Enables/disables reading of the file contents. |
Incremental Reading | Switches between reading the whole file and incremental reading. Incremental reading is ideal for log file analysis. If it's enabled, the server remembers previous file size and, during the next synchronization cycle, reads data starting from the previous end point to the end of file. If the file size has not grown since the previous cycle, no reading is performed. If file size has decreased, the reading is restarted from file start (this is suitable to handle log file rotation). |
Maximum Read Size | Maximum number of bytes that the server will read if incremental reading is enabled. |
Backlog Read Size | Number of bytes to include from previous steps of incremental reading. |
Allow Editing | Allows or prohibits modification of the file contents. |
Calculate Checksum | Enables/disables file checksum calculation. |
File Encoding | Specifies the encoding of the file content. |
Device Assets
Assets are not supported by the driver.
Device Settings
Local File device driver creates two Device setting variables:
Variable Name | Variable Description | Comments |
attributes | File Attributes | Contains the file attributes:
|
contents | File Contents | Read-only (if Read Contents option is on) or editable (if Allow Editing option is also on) file contents. |
Device Operations
No operations provided by the driver.
Device Events
No events provided by the driver.
Connection Handling
If all I/O operations with the file have finished successfully, the local file Device is deemed "online".
If no file exists at the path specified, or any error was encountered while accessing the file, the local file Device is considered "offline".
Synchronization Details
As Local File is a Device Driver, it performs a "synchronization" with Iotellect Server like any other driver. During synchronization, attributes and contents of the file are obtained. Also, if editing is allowed and a user has edited server copy of file contents, the new contents are written to the file.
Was this page helpful?