Generic Device Properties

Some settings are common to devices of different types. They can be accessed by the Edit Device Properties action of any Device context.

Dependency Expression Resolution Environment:
Field Description		Field Name
Device Name. Name of the device context, required to refer to this device from other parts of the system. It should satisfy the context naming conventions.		name
Device Description. Textual description of the device. It may indicate device type, location, purpose or other important characteristics.		description
Show Full Device Description. Enabling this option provides full device description view.		showFullDeviceDescription
Device Type. This is a deprecated field that should be no longer user in your apps and services. Some older device drivers are still using this field to indicate one of the detected pre-defined device types used by standard products based on Iotellect. Use Models to amend devices with your own custom properties indicating device type/subtype/version/etc.		type
Synchronization Period. This setting defines how often full Device synchronization with the server is performed. However, individual device settings may have a custom synchronization period defined by Device Settings Synchronization Options.		syncPeriod
Start Synchronization on Setting Change. This setting defines whether or not synchronization is performed when a device property changes.		startSyncOnSettingChange
Interrupt Synchronization And Reconnect On Error. Causes the synchronization process to stop if an error occurs during the synchronization of any setting. This also forces Iotellect Server to disconnect from the device and reconnect before the next synchronization. Enabling this option may be very useful when I/O or device errors during synchronization of one setting will most likely repeat during synchronization of the remaining settings.		interruptOnError
Suspend Device. Suspended devices are never synchronized with the server.		suspend
Disable Synchronous Setting Value Reading/Writing. During the synchronization process, the synchronization (reading/writing) of device settings will not be made. Typically used if the settings are updated asynchronously.		disableSynchronousSettingValueRW
Enable Extended Status. Enables/disables extended device synchronization status. Enabling extended status will force the device context to change status on every major stage of synchronization cycle. It will also enable additional Status Changed events, as well as some other advanced diagnostical events (such as Function Called event that is fired on every device operation).		extendedStatus
Time Zone. Time zone the device is located in. May be used by a device driver for timestamp conversions, e.g. when synchronizing the device's internal clock with the server.		timeZone
Metadata Reading Mode. Defines when the server should read definitions of device settings, operations, events, and assets. There are three modes: Do not read. All definitions are read just once, after the connection of the device. This mode is suitable for improving performance if the definitions of already-connected devices never change. Read definitions of settings, operations and events. This is a default mode that is suitable for most cases. The server re-reads all metadata except for assets on every synchronization cycle, reflecting changes found in the device. Asset definitions are not read. Read all. In this mode, the server will read full device metadata, including assets, on every synchronization cycle. This mode is suitable if the assets of the connected device may change at any time. This may slow down the performance if the device has a large number of assets. If the Read All mode is selected, asset definitions on the server will only include definitions returned during the most recent synchronization. If an asset definition is returned by a device during initial synchronizations, but subsequent synchronizations do not include the asset definition, the asset definition will be removed from the server. This can result in variable definitions being “lost” during failed readings of asset definitions.		metadata
Active Entities. Defines what device variables, functions, and events will be available for this device: All Entities. All variables/functions/events discovered by the driver will be available within the device account context. Selected Entities. Only entities checked in the Variables / Functions / Events lists will be added to the device account context. Some device drivers don't support such fine-grained control over selected entities. Device accounts using those drivers will report empty Variables / Functions / Events tables even if Selected Entities mode is enabled. All entities will still be exposed by the device account context in this case. Changing Active Entities to Selected helps in various scenarios: When a device generates many events (even within a certain selected asset ) and server should only subscribe to the selected event type. When a certain device asset contains many variables and polling them even in rare cases will impact the device's or Iotellect Server performance. When some non-used device variables contain large blocks of data that consume excessive server RAM and/or database storage space.		activeEntities
Default Cache Mode. Defines the location of the settings cache: Database (Persistent Cache): settings cache is stored in the Database (default mode, settings will be available immediately after server restart) Memory (Permanent Cache): settings cache is stored in memory until removed explicitly or the application is stopped. (settings will not be available after server restart until the end of first device synchronization) Memory (Clearable Cache): settings cache is stored in memory until removed explicitly, the application is stopped, or cleared by the Memory Usage Optimization. Note: in Database mode each device setting update causes an update of the underlying configuration storage, provoking performance problems on highly loaded systems.		cache
Settings Default Quality. Defines what quality device setting variable values will have in the case when the driver does not provide value quality.		settingsDefaultQuality
Device Event Storage Period. Defines how long device events are stored in the server database by default. Zero value disables persistent event storage for this device. Per-event storage settings can be defined in the global Event Processing Rules.		eventStoragePeriod
Device Dependency Expression. This expression is evaluated before every synchronization. If the evaluation result is false, synchronization is not performed.		dependency
Default Context	Context of current device.
Default Data Table	None.
Default Row	0
Environment Variables	Standard variables only.
It's a common practice to make device dependency expression referring to the online status of some other device. For example, in a network management system it may be useful to disable synchronization for a group of devices that are connected to Iotellect Server through a router if the router itself is offline (i.e. not accessible). In this case, the following dependency expression may be used for each of these devices: `{users.admin.device.router:status$connectionStatus} == 0` It's possible to find out the numeric value of the Offline connection status (zero above) by browsing the selection values in the variable information for the status variable of a device context.
Status Expression. The expression is recalculated in the end of every synchronization cycle. It should return a textual description of the current device status. This status can be displayed on device maps, dashboards, etc. To see the resulting status, check the Status variable of Device context.		status
Status Expression Resolution Environment:
Default Context	Context of current device.
Default Data Table	None.
Default Row	0
Environment Variables	Standard variables only.
Color Expression. The expression is recalculated in the end of every synchronization cycle. It should return a result of the Color type. This color will be used to color-code the device on device maps, dashboards, etc. To see the resulting color, check Status variable of Device context. Device color evaluated using this parameter don’t affect the color of device status icons in the System Tree.		color
Color Expression Resolution Environment:
Default Context	Context of current device.
Default Data Table	None.
Default Row	0
Environment Variables	Standard variables only.
Latitude Expression. See Device Location Tracking for details.		latitude
Latitude Expression Resolution Environment:
Default Context	Context of current device.
Default Data Table	None.
Default Row	0
Environment Variables	Standard variables only.
Longitude Expression. See Device Location Tracking for details.		longitude
Longitude Expression Resolution Environment:
Default Context	Context of current device.
Default Data Table	None.
Default Row	0
Environment Variables	Standard variables only.
Location History Storage Period. Defines how long to keep the history of latitude/longitude changes.		locationStoragePeriod
Enable Offline Alert. A flag that controls whether or not a Device Offline alert will be generated if the device stays in a disconnected state for some time.		offlineAlert
Maximum Recent Synchronization Log Entries. Parameter sets the maximum number of entries in the Recent Synchronizations Log under the Device Status Information Page.		maxSyncLogEntries
Virtual Device Network. Sets up a virtual device network the device belongs to.		virtualNetwork

These may be accessed via the genericProperties variable.

DPF_EXPORT_V5.8.8 / TIME_1743710554 / 2025-04-03 20:02:34 / STRLEN_18604 / STRLEN_HTML_17232

{VERSION}

Was this page helpful?