Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This section applies to SmartServer release 3.1 or prior.

...

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.  

...

Go to the following sections to edit datapoint properties: INFO, MONITORING AND LOGGING CONFIGURATION, ALARM TYPE CONFIGURATIONPRESET DEFINITIONS, or LOCALIZATION.

Note

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. 

...

  1. 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.

  2. Click UPDATE.

Editing Monitoring and Logging Configuration

...

  1. 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.

      Note

      Note: Alarm Name must be unique across all alarm types and across all device types for handling alarm assignments.


    • 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).

  2. Click UPDATE to return to the Datapoint Properties widget.

...

From the PRESET DEFINITION tab, you can create, edit, and remove preset definitions.

Creating a Preset Definition

  1. From the PRESET DEFINITION tab, click the add () icon.



  2. Enter the preset name, value, and state. (Presets are based on the local values.)

  3. Click SAVE.

    The preset definition appears on the Edit Datapoint Properties view.



  4. Click UPDATE to return to the Datapoint Properties widget.

  5. Refresh your browser window (F5 in many browsers) to display the updated preset definition.

...

A DLA file contains the following columns (headings are not case sensitive):

Parameter                              Description
ProtocolValid values are: LON, IAP, ModBus, and BACnet
Device TypeDevice 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.
For example: LightSensor/0/nvoLightLevel or TempSensor/0/nvoTemperature

MonitoredYes or No
PolledYes if polled; No if event-driven.
Poll IntervalPolling interval for use by the protocol engine.
Publish IntervalPublishing 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

(this parameter uses underscores)

Minimum number of seconds between published values. If 0, then there is no time throttle.

Publish Min Delta Value

(this parameter does not use underscores)

Valid values are:

Any – publishes data on any change.
Always – publishes data on every update.
A scalar value – specifies a minimum change from the last published value.

Initial ValueFor inputs only. Specifies the initial value. If blank, then no initial value.

Log Interval 1
Log Interval 2
Log Interval 3

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 Retention 1
Log Retention 2
Log Retention 3

Sets the data retention period (in seconds) for each of the three log intervals.
Log Min Delta TimeMinimum 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.
Always – logs data on every update.
A scalar value – specifies a minimum change from the last logged value.

Alarm Name

If defined, then it appears in the Alarm Type list. 

Note

Note: Alarm Name must be unique across all alarm types and across all device types for handling alarm assignments.


High Warning
Low Warning

Sets high and low warning limits.

High Error
Low Error

Sets high and low error limits.
VisibleYes to show datapoints (default); No to hide datapoints. 
PresetsSets the presets name and value.
LocalizationSets the localization transformation rules.
LoggedYes for logging; No for no logging.

...