Defining Datapoint Properties (Release 3.1)
This section applies to SmartServer release 3.1 or prior.
For SmartServer 3.2 and higher, see Defining Datapoint Properties.
You can create, view, and edit monitoring, logging, and alarming properties for datapoints. You can use the Datapoint Properties widget to define the datapoint properties, you can export the datapoint property definitions to a datapoint logging and alarming (DLA) file with a .dla extension, and you can import the DLA file to other SmartServers. You can also manually create a DLA file.
Users with Administrator, Owner, Controller, or Tenant roles can use the Datapoint Properties widget to create and modify datapoint properties where they have the Administrator, Owner, Controller, or Tenant roles.
This section consists of the following:
- 1 Displaying Datapoint Properties
- 2 Editing Datapoint Properties
- 3 Copying Datapoint Properties
- 4 Clearing Datapoint Properties
- 5 Exporting Datapoint Properties
- 6 Importing Datapoint Properties
- 7 Enabling/Disabling Use of Localization
- 8 Creating a DLA File
- 8.1 DLA File Parameters
- 8.2 DLA File Examples
- 8.2.1 Without Presets and Localization
- 8.2.2 With Presets
- 8.2.3 With Localization
- 8.3 DLA File Validation
Note: Click the fullscreen icon ( ) for a better view of this widget.
Displaying Datapoint Properties
Viewing Unconfigured Datapoints
To show the unconfigured datapoints, click the action icon () on the Device Properties widget and select Show Unconfigured Datapoints.
The unconfigured datapoints appear on the Datapoint Properties widget displaying the following:
Device type – the device type name
Block name – the block name
Block index – blocks with the same type are sequentially numbered, starting at 0 for the first block
Datapoint – the datapoint name
Datapoint type – the datapoint type name
Monitored – indicates that monitoring is configured for the datapoint
Logged – indicates that logging is configured for at least one log for the datapoint
Alarmed – indicates that at least one alarm or warning is configured for the datapoint
Each heading has a forward/reverse sort icon. When clicked, the datapoint list is sorted in forward or reverse order by the selected heading.
Total Monitoring Traffic Indicator – displays the calculated packets per second for monitoring traffic; keep this number below 40 for optimal performance.
Total Logged Bytes – displays the estimated logged bytes per day
Data Annual Log Size – displays the estimated log size after 1 year in Megabytes (MB)
Hiding Unconfigured Datapoints
To hide the unconfigured datapoints, click the action icon () on the Device Properties widget and select Hide Unconfigured Datapoints.
The unconfigured datapoints no longer appear.
Setting Filters
You can set filters on the Device Properties widget to refine information that is displayed.
To set a filter, click the Set Filter button () on the Datapoint Properties widget.
The Set Filters view appears.Enter the search criteria.
Click the plus sign () to add filters.
Click APPLY FILTERS.
The results below show the block name filter results for "joystick".
The remove filters () icon clears the filter settings.
Editing Datapoint Properties
To edit datapoint properties, click the action button (
) and then select Edit.
The Edit Datapoint Properties view appears.
Go to the following sections to edit datapoint properties: INFO, MONITORING AND LOGGING CONFIGURATION, ALARM TYPE CONFIGURATION, PRESET DEFINITIONS, or LOCALIZATION.
Note: Using presets and localization in datapoints is optional. A datapoint can have presets only, localization only, both presets and localization, or neither. When both presets and localization are used, the presets map are typically configured based on the localization value. Therefore, when an update is received, the value needs to be localized first before mapping to a preset string. And, when a preset string is entered, the map value needs to be transformed using the revert transformation rule to get the native value.
Editing Datapoint Properties Information
From the INFO tab, edit datapoint properties as needed including the following:
Protocol – read-only field with LON, Modbus, BACnet, and IAP values
Device Type – read-only field with device type name
Datapoint Name – read-only field with fully qualified name with block name, block index, and datapoint name
Initial Value – initial value for inputs only. If localization is defined, the value should be a local value.
Click UPDATE.
Editing Monitoring and Logging Configuration
Editing Datapoint Value Alarm Conditions
From the ALARM TYPE CONFIGURATION tab, edit the parameters as needed including the following:
Alarm Name – a text field where you can enter a name for the alarm type definition. If defined, this name appears in the Alarm Type list.
Alarmed Yes/No – enables or disables alarm monitoring for the datapoint (this feature is available with SmartServer release 2.7 or higher).
High Warning and Low Warning – datapoint limits for triggering warnings, one for a high value warning and one for a low value warning.
High Alarm and Low Alarm – datapoint limits for triggering alarms, one for a high value alarm and one for a low value alarm.
High Warning Preset and Low Warning Preset – datapoint presets for triggering warning alarms, one for a high-value warning alarm and one for a low-value warning alarm. (This setting requires Alarmed to be Yes; this feature is available with SmartServer release 2.8 or higher).
High Alarm Preset and Low Alarm Preset – datapoint presets for triggering error alarms, one for a high-value error alarm and one for a low-value error alarm. (This setting requires Alarmed to be Yes; this feature is available with SmartServer release 2.8 or higher).
Click UPDATE to return to the Datapoint Properties widget.
Using Preset Definitions
From the PRESET DEFINITION tab, you can create, edit, and remove preset definitions.
Creating a Preset Definition
From the PRESET DEFINITION tab, click the add (
) icon.
Enter the preset name, value, and state. (Presets are based on the local values.)
Click SAVE.
The preset definition appears on the Edit Datapoint Properties view.Click UPDATE to return to the Datapoint Properties widget.
Refresh your browser window (F5 in many browsers) to display the updated preset definition.
Editing a Preset Definition
To edit an existing preset definition, click the action icon (
) for the desired preset definition and select the Edit preset menu option.
The Edit preset view appears.Edit the preset definition as needed.
Click SAVE.
Click UPDATE to return to the Datapoint Properties widget.
Refresh your browser window (F5 in many browsers) to display the updated preset definition.
Copying a Preset Definition
To copy an existing preset definition, click the action icon (
) for the desired preset definition and select the Copy preset menu option.
The Copy preset view appears.Edit the preset definition as needed.
Click SAVE.
Click UPDATE to return to the Datapoint Properties widget.
Refresh your browser window (F5 in many browsers) to display the updated preset definition.
Removing a Preset Definition
From the PRESET DEFINITION tab, click the action icon () for the desired preset definition and select Remove preset.
The preset definition is automatically removed.
To remove multiple preset definitions, follow these steps:
Click the checkmark for preset definitions to be removed (the checkmarks change from blue to yellow).
Click the delete (
) button.
Click UPDATE to return to the Datapoint Properties widget.
Refresh your browser window (F5 in many browsers) to display the updated preset definition.
Using Localization Settings
You can set the localization transformation rules to be used by a datapoint through the Edit Datapoint Properties view, setting the multiplier, exponent, offset, and units fields to get the native value. Any simple data type, as well as any field in a structure or union, can be transformed. After adding of changing any rules, click Update and then refresh your browser window (F5 in many browsers) to display the updated localization rules.
The transformation value = ( input value [raw value] * multiplier * 10^exponent ) + offset
Exponent has two purposes:
Controls 10^exponent
Defines the number of decimal places that transformed value will show
Consider, for example, a device reports temperature as 22 degrees Celsius and you want to show the temperature as Fahrenheit. The number of decimal places you want to see in the Datapoint Browser widget determines the values used for the localization transform.
For whole numbers:
Multiplier = 1.8, Exponent = 0, Offset = 32: transformed value = 72
For one decimal place:
Multiplier = 18, Exponent = -1, Offset = 32: transformed value = 71.6
To clear any localization transformation rules, click the delete () button, click UPDATE, and then refresh your browser window (F5 in many browsers) to display the updated rules.
Copying Datapoint Properties
To copy a datapoint property, click the action icon (
) on the Datapoint Properties widget and select Copy.
Select the datapoint you wish to copy.
Click COPY.
Clearing Datapoint Properties
Clearing a Selected Datapoint Property
To clear the monitoring, logging, and alarming properties of a selected datapoint property, click the action icon (
) on the Datapoint Properties widget and select Clear.
Confirm the clear operation by clicking OK on the Confirmation box.
Clearing Selected Datapoint Properties
To clear the monitoring, logging, and alarming properties of selected datapoint properties, click the checkmark for the datapoint properties to clear.
The checkmark changes from blue to yellow.Click the action icon (
) on the Datapoint Properties widget and select Clear Selected Datapoint Properties.
Confirm the clear operation by clicking OK on the Confirmation box.
Clearing All Datapoint Properties
To clear the monitoring, logging, and alarming properties of all datapoint properties, click the action icon (
) on the Datapoint Properties widget and select Clear All Datapoint Properties.
Confirm the clear operation by clicking OK on the Confirmation box.
Exporting Datapoint Properties
Exporting a Selected Datapoint Property
To export datapoint properties for a single datapoint, click the action icon () on the Datapoint Properties widget for the datapoint and select Export.
The CMS exports the datapoint properties to a DLA file.
Exporting Selected Datapoint Properties
To export multiple datapoint properties, click the checkmark for the datapoints to be exported.
The checkmark changes from blue to yellow.Click the action icon (
) on the Device Properties widget and select Export Selected Datapoint Properties.
The CMS exports the selected datapoint properties to a DLA file.
Exporting All Datapoint Properties
To export all datapoint properties, click the action icon () on the Datapoint Properties widget and select Export All Datapoint Properties.
The CMS exports all of the datapoint properties to a DLA file.
Importing Datapoint Properties
To import datapoint properties, click the action icon (
) on the Datapoint Properties widget and select Import Datapoint Properties.
Select the DLA file to be imported from your computer by clicking on the DROP FILE HERE area or by placing the file in that area.
Click IMPORT FILE.
A message appears indicating that the file was loaded.
Enabling/Disabling Use of Localization
The Use Localization option is not available with SmartServer 2.8 and higher.
By default, the SmartServer IoT is configured to use localization.
To disable this option, go to the Global Settings button () on the main page.
Click the Global Settings button () and select the Use Localization action (which appears in yellow when enabled) from the dropdown list.
To re-enable localization, click the Global Settings button () and select the Use Localization action (which appears in blue when disabled) from the dropdown list.
Creating a DLA File
You can create a DLA requirements file as a CSV file that lists initial value, logging, and alarming requirements for datapoints.
A DLA file contains the following embedded metadata tags, anywhere in the file, but typically in the first line:{noformat}#filetype,dla{noformat}
A DLA file is categorized by its extension .DLA or .CSV (not case sensitive), and the #filetype tag equal to dla (not case sensitive) and is identified by its filename. Compound extensions such as DLA.CSV can also be used.
DLA File Parameters
A DLA file contains the following columns (headings are not case sensitive):
Parameter | Description |
|---|---|
Protocol | Valid values are: LON, IAP, ModBus, and BACnet |
Device Type | Device type from XIF file (not required for IAP). The device type is defined by a DTD record. Keyed to the PID in the XIF files that are packaged in the DTD. |
Datapoint | Fully qualified name as derived from the XIF file including block name, index and datapoint name. |
Monitored | Yes or No |
Polled | Yes if polled; No if event-driven. |
Poll Interval |