Creating a DLA File Manually
For SmartServer 3.1 or prior, see Defining Datapoint Properties (Release 3.1).
This section describes how to create a DLA file manually and defines the datapoint properties file parameters. After you manually create the DLA file, you can use the Datapoint Properties widget to import it into the SmartServer. See Defining Datapoint Properties with the CMS Datapoint Properties Widget for information on how to use the Datapoint Properties widget.
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:#filetype,dla
This 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.
This section consists of the following:
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 |
Monitoring Method | Event Driven or Polled |
Poll Interval | Polling interval for use by the protocol engine. This parameter is used for all monitored datapoints (not just polled datapoints). |
Publish Interval | Publishing interval for use by the protocol engine. Typically this is a multiple of the polling interval. If not a multiple, then the highest multiple that does not exceed the specified interval is used. |
Expected Update Interval | Expected average number of seconds between updates. If 0, updates are not expected and included in traffic estimation. You can specify as a fractional value such as 0.5 seconds. Set this parameter to the Min Publish Interval value if the Expected Update Interval is blank and the Min Publish Interval is changed. This value is used for traffic estimation only and does not otherwise impact monitoring. |
Publish Min Delta Time | Minimum number of seconds between published values. If 0, then there is no time throttle. |
Publish Min Delta Value | Valid values are: Any – publishes data on any change. |
Initial Value | For inputs only. Specifies the initial value. If blank, then no initial value. |
Provision Initial Value | Yes to write the initial value to the device when the device is provisioned; No to not write the initial value to the device when the device is provisioned. |
Log Interval 1 | Sets the data logging intervals. Typically a multiple of the polling interval. If not a multiple, then the highest multiple that does not exceed the specified interval is used. |
Log 1 Expected Interval | Sets the expected interval between logged values for Log 1/Log 2/Log 3. The expected interval is only used for calculating estimates of log size growth per day or per year, and does not effect whether or not a value is logged. For a datapoint configured for periodic polling, the default value for the log expected interval is the minimum interval for the log. If an expected interval for a datapoint that has been configured for periodic polling is not set, and the minimum interval for the log is changed, then the CMS will update the default value for the log expected interval to the new minimum interval for the log. |
Log Retention 1 | Sets the data retention period (in seconds) for each of the three log intervals. |
Log Min Delta Time | Minimum number of seconds between logged values. If 0, then there is no time throttle. |
Log Min Delta Value | Valid values are: Any – logs data on any change. |
Alarm Enabled | Yes or No |
Alarm Type Name | If defined, then it appears in the Alarm Type list. Note: Alarm Name must be unique across all alarm types and across all device types for handling alarm assignments. |
Alarm Details | Alarm description |
High Warning | Sets high and low warning limits. |
High Error | Sets high and low error limits. |
Visible | Yes to show datapoints (default); No to hide datapoints. |
Presets | Sets the presets name and value. If you are using Presets Presets should be defined in the Datapoint Properties widget or the DLA file file prior to the deployment of connections. If you configure presets in the Datapoint Properties widget or the DLA file after deploying connections, then different connection results will be produced. |
Localization | Sets the localization transformation rules. If you are using Localization Localization should be defined in the Datapoint Properties widget or the DLA file file prior to the deployment of connections. If you configure presets in the Datapoint Properties widget or the DLA file after deploying connections, then different connection results will be produced. |
Logged | Yes for logging; No for no logging. |
Tags | A list of tags as defined in Datapoint Tags, with each tag specified as <tag name>:<tag value, allowing you to add tag datapoint values that are forwarded to a data analytics application. Tags parameter is available with SmartServer 3.6 and higher. |
DLA File Examples
To use the examples below, copy the text from the example to a text only file (e.g., Windows Notepad) and save the file using the .dla extension. To view the contents in Excel, use the .dla.csv extension. (File extensions are not case sensitive.)
Without Presets and Localization
#filetype,dla |
#filetype,dla |
#filetype,dla |
With Presets
Presets column follows Visible:
#filetype,dla |
With Localization
The Localization settings shown in the example below convert a Celsius datapoint value to degrees Fahrenheit with a precision of 1 decimal digit. The Localization column follows the Presets column.
#filetype,dla |
Formula Examples
Presets Formulas
These example formulas can be copied into an Excel cell. For structured datapoints, you need to specify the value for all fields in the datapoint.
Datapoint format | Datapoint type | Formula |
---|---|---|
Scalar | SNVT_count |
|
Scalar | SNVT_count | "[{""name"":""on"",""value"":1},{""name"":""off"",""value"":0}]" |
Structured | SNVT_switch | "[{""name"":""On"",""value"":{""state"":1,""value"":100}},{""name"":""Off"",""value"":{""state"":0,""value"":0}},{""name"":""Mid"",""value"":{""state"":1,""value"":50}}]" |
Localization Formulas
These example formulas can be copied into an Excel cell. In the example below, SNVT_temp_p is a scalar datapoint. SNVT_temp_setpt is a structured datapoint with six temperature fields. You only need to populate localization formulas for as needed (i.e, you do not have populate localization formulas for all fields).
Datapoint format | Datapoint type | Formula |
---|---|---|
Scalar | SNVT_temp_p | "{""value"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1}}" |
Structured (specifies localization for all fields) | SNVT_temp_setpt | "{""value"":{""standby_cool"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1},""standby_heat"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1},""occupied_cool"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1},""occupied_heat"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1},""unoccupied_cool"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1},""unoccupied_heat"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1}}}" |
Structured (specifies localization for some fields) | SNVT_temp_setpt | "{""value"":{""standby_cool"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1},""standby_heat"":{""unit"":""deg F"",""transformA"":1.8,""transformC"":32,""transformP"":1}}}" |
DLA File Validation
The schema.ini file may be used to perform simple data validation when creating a DLA file with Excel. The schema.ini file is available here.