Viewing and Setting Datapoints

THE DATAPOINTs WIDGET IS AVAILABLE WITH SMARTSERVER 2.5 AND HIGHER. 
For SmartServer 3.3 and prior, see Testing Devices (Release 3.3 and Prior).


This page consists of the following sections:

Viewing Datapoint Values and Priorities

You can view datapoint values and priorities.  To view datapoint values and priorities, follow these steps:

  1. Open the SmartServer IoT CMS.  Log into a CMS user account with read-only or read/write access to the Datapoints widget as described in Defining Users.

  2. Open the Datapoints widget.  



    The Datapoints widget displays the following information for each datapoint:
         Device – the device name
         Block name the block name
         Block index – the block index
         Datapoint name – the datapoint name
         Value – the value of the datapoint
         Timestamp – the timestamp appears if log (not live) is specified for the source (source is specified using Set Filters)
         Preset – represents a specific native for a datapoint
         Actions – allow you to view value, edit value, export datapoint, view overrides, relinquish operations

  3. Set the Datapoints widget update interval in the upper right corner of the Datapoints widget.  



    The Datapoints widget update interval specifies how frequently the SmartServer fetches the current value for each displayed datapoint. The SmartServer has two sources for the current value.  One source is internal to the SmartServer, the other source is the edge device itself.  When the SmartServer fetches an updated value, it verifies the age of its locally stored value is less than the update interval.  If the locally stored value is older than the updated interval, the SmartServer requests a new value from the edge device that contains the datapoint.  These requests are called on-demand requests since they are independently scheduled from any periodic requests that are specified by datapont properties.

    For example, if the update interval is set to 30 seconds, the SmartServer will fetch the current value stored in the SmartServer every 30 seconds.  If the stored value is older than 30 seconds, the SmartServer will request the value from the edge device.

    Each update generates a SmartServer event that is included in the events per second (EPS) value displayed in the CMS dashboard.  For example, if the Datapoints widget is updating 25 datapoints every 30 seconds, the total EPS for the SmartServer will increase by 0.8.  Always keep the total EPS displayed in the CMS dashboard below 40 EPS.


    On-demand requests can add signficant load to slow communication channels such as LON power line channels.  To reduce loading on slow channel set the update interval to 0 or a value greater than 200 seconds.

    To change the update interval, click the update interval value, change the value, and then click anywhere else such as the white space next to the value to save the value.  To disable on-demand polling, set the update interval value to 0.

  4. Click the Expand button (  ) on the top right of the widget to view all the available information.

  5. Click the Sort button in a column heading to enable forward or reverse sorting for the column.

  6. To find a specific datapoint to view, click the Set Filters button () and create a filter to find the datapoint as described in Customize the CMS Widgets using Filters.  By default, the Datapoints widget displays live data for all provisioned devices.

  7. To view a datapoint value and priority with a more detailed view of the value, click the datapoint Action button () for the datapoint and then click View Value.



    The datapoint value and priority is displayed.  The priority may be Normal which indicates a value with no priority overrides.  Or, the priority may be a value from 1 to 16 indicating an override of the normal value and any lower priority overrides.  The highest priority is 1 and the lowest is 16.



  8. Click Cancel to close the dialog.

Setting a Datapoint Value and Priority

You can set the value and priority for a datapoint.  To set the value and priority for a datapoint, follow these steps:

  1. Open the SmartServer IoT CMS.  Log into a CMS user account with read/write access to the Datapoints widget as described in Defining Users.

  2. Open the Datapoints widget and verify the update interval as described in the previous section.



  3. Click the Expand button (  ) on the top right of the widget to view all the available information.

  4. Click the Sort button in a column heading to enable forward or reverse sorting for the column.

  5. To find a specific datapoint to update, click the Set Filters button () and create a filter to find the datapoint as described in Customize the CMS Widgets using Filters.  By default, the Datapoints widget displays live data for all provisioned devices.

  6. To set a datapoint value, click the value in the Datapoints widget and enter a new value.  The SmartServer updates the value at the Normal priority.

  7. To set a datapoint value and priority with a more detailed view of the value, click the datapoint Action button () for the datapoint and then click Edit Value.



    The CMS displays the datapoint value and priority.



  8. Edit the datapoint priority and value.  The priority may be Normal which indicates a value with no priority overrides.  Or, the priority may be a value from 1 to 16 indicating an override of the normal value and any lower priority overrides.  The highest priority is 1 and the lowest is 16.  For BACnet devices, the 16 priorities map to the 16 BACnet overrides for BACnet devices supporting priority overrides.  Many BACnet devices that support priority overrides do not support updates to the Normal value.  For such devices, the SmartServer changes update to the Normal value to a priority 16 update.  If you save a datapoint value with a lower priority than the current priority initially shown in the Edit Value dialog, the new value will get stored in the datapoint priority array (see the Managing Overrides section), but the current value will not change, and the new value will not be sent to the edge device if the edge device does not support datapoint priority overrides.

  9. Click Save to send the updated value to the device and close the dialog.

Managing Overrides

You can view and manage the priority array for a datapoint.  The priority array contains up to 17 values for a datapoint.  The lowest priority value is the Normal value.  There may be up to 16 priority override values with priority 1 being the highest priority override and priority 16 being the lowest priority override.  You can set a priority override value for any of the 16 priorities, and you can relinquish any priority override values that have been set.  The datapoint value is the value of the highest priority override that has not been reliquished.  If there are no priority overrides for a datapoint, the datapoint value is the Normal value.

For example, where a light is normally off (that is, normal value is OFF) is overridden with a priority 8 ON value. During its ON state, its priority 10 value is set to DIM, which has no immediate effect until the priority 8 value is relinquished. Without a priority 8 override, it drops to the priority 10 override and becomes DIM.  Relinquishing the priority 10 value causes the light to go back to its original normal OFF state.

To view and manage a datapoint priority array, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget and verify the update interval as described in the Viewing Datapoint Values and Priorities section.



  3. Click the Expand button (  ) on the top right of the widget to view all the available information.

  4. Click the Sort button in a column heading to enable forward or reverse sorting for the column.

  5. To find a specific datapoint, click the Set Filters button () and create a filter to find the datapoint as described in Customize the CMS Widgets using Filters.  By default, the Datapoints widget displays live data for all provisioned devices.

  6. Click the datapoint Action button () for the desired datapoint and then click View Overrides.



    The View Overrides view for the selected datapoint appears.



  7. To relinquish a priority override, click the X for the priority.

  8. Click Close to return to the Datapoints widget view.

Displaying Live or Logged Data

You can view live or logged data in the Datapoints widget.  Live data represents current values for all displayed datapoints.  Logged data represents logged values for datapoints with logging enabled.  You can enable logging for a datapoint using the Datapoint Properties widget.  By default, the Datapoints widget displays live data for all provisioned devices.  To select live or logged data, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget and verify the update interval as described in the Viewing Datapoint Values and Priorities section.



  3. Click the Expand button (  ) on the top right of the widget to view all the available information.

  4. Click the Sort button in a column heading to enable forward or reverse sorting for the column.

  5. Click the Set Filters button ().  The Source filter is selected by default



  6. Select Live or Log for the Source filter.

Viewing / Hiding Detailed Properties

You can view or hide detailed properties in the Datapoints widget.  By default, the Datapoints widget displays the following information:

  • Device – the device name

  • Block name the block name

  • Block index – the block index
  • Datapoint name – the datapoint name
  • Value – the value of the datapoint

  • Timestamp – the timestamp appears if log (not live) is specified for the source (source is specified using Set Filters)
  • Preset – represents a specific native for a datapoint
  • Actions – allow you to view value, edit value, export datapoint, view overrides, relinquish operations


You can also view detailed properties, which includes the following additional information:

  • Datapoint XIF name

  • Qualified datapoint instance name

To view or hide detailed properties, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget.



  3. Click the widget Action button () and then click Show Detailed Properties



    The detailed datapoint properties appear.



  4. To hide the detailed datapoint properties, click the widget Action button () and then click Hide Detailed Properties



The standard datapoint properties columns appear.

Creating a Favorite Using the Candidate Datapoint List

You can create a named list of your favorite datapoints so that you can easily manage the same set of datapoints over multiple sessions with the CMS.  You can create favorites from the Datapoints widget directly as described in the next section.  For more flexibility, you can create and manage a list of candidate favorites that you can save when you have your initial candidate list complete.  To create a list of favorite datapoints using a candidates list, follow these steps:

This section describes how to use the Datapoint and Candidates views to create a custom datapoint list. To create a custom datapoint list, use the Datapoint view (the default Datapoints widget view) to find and select the datapoints that you want to show up in the Candidate view. Then use filters to find and select desired datapoints. Once you have a custom datapoint list, you can create a favorite for future use.

Favorites can be created from either the Datapoint  or Candidate views. This section describes how to optionally create a favorite from the Candidates view (the custom datapoints list view). For information on how to create a favorite from the Datapoint view (the default Datapoints widget view), see the Creating a Favorite from the Datapoints View section.

The Candidate view is displayed when you click the widget Action button () and select the Show Candidates. This view is a custom list of datapoints that you can create from one or more datapoint filters.

To help with datapoint monitoring if you want to look at a couple of datapoints from different devices, but you cannot find a datapoint filter that only shows the datapoints you want, you can create a custom Candidates datapoints list. The following basic steps are required to create a custom Candidates datapoints list:

  1. Use the Datapoint view to select the datapoints using different datapoint filter options.
  2. View the selected datapoints in the Candidates view.
  3. Use either the Datapoints or Candidates view to save the datapoint list to a Favorite for future use.

To create a custom datapoint list that will appear in the Datapoints widget Candidate view, perform the following steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget.



  3. Use the Datapoints widget Set Filters button () to search for datapoints.



  4. Select datapoints to add to the candidates list.

    1. To add all displayed datapoints to the candidates list, click the widget Action button () and then click Add Search Results to Candidates.



      The following dialog appears:



      Click OK.

    2. To add some of the datapoints, click the checkmark for the desired device datapoints. The checkmark changes from blue to yellow.



      Click the widget Action button () and then click Add Selected to Candidates.




  5. To add more datapoints to the candidates list, repeat steps 3 and 4.

  6. Click the widget Action button () and then click Show Candidates.



    Your candidates list appears.



  7. To close the candidates list, click the widget Action button () and then click Show Search Results



  8. To view the candidates list, click the widget Action button () and then click Show Candidates.



  9. To delete datapoints from the candidates list, click the checkmark for the datapoint to be deleted.  The checkmark changes from blue to yellow.  Then click the widget Action button () and then click Remove Selected from Candidates.



  10. To save your candidate list as a named favorite, click the widget Action button () and then click Create Favorite from Candidates.  



    The Create Favorite From Selected Datapoints view appears.



  11. Enter a name for your favorite.  You can create multiple favorites with the same name. In these cases, a timestamp next to the name is used to differentiate the favorites.



  12. Click Save.

Creating a Favorite from the Datapoint View

You can create a named list of your favorite datapoints so that you can easily manage the same set of datapoints over multiple sessions with the CMS.  You can create favorites from the Datapoints widget directly as described in this section.  For more flexibility, you can create and manage a list of candidate favorites that you can save when you have your initial candidate list complete as described in the previous section.  To create a list of favorite datapoints from the Datapoints widget directly, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget.




  3. Click the checkmark for the device datapoints to save to favorites (the checkmark changes from blue to yellow).



  4. Click the widget Action button () and then click Create Favorite from Selected.



    A dialog box appears prompting you to enter a name for the favorites.



  5. Enter a name for the new favorite. You can create multiple favorites with the same name. In these cases, a timestamp next to the name is used to differentiate the favorites.



  6. Click Save.

Viewing Favorites

You can view a list of favorite datapoints that you created as described in the previous two sections.  To view one of your favorites, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget.




  3. Click the widget Action button () and then click View Favorite.



    Your saved favorites appear.



  4. Click the favorite to view.

    The selected datapoint favorites are displayed as a candidate list.



  5. Verify the update interval as described in the Viewing Datapoint Values and Priorities section.

  6. Click the widget Action button () and then click Show Search Results to return to the Datapoints widget default view.



    The Datapoints widget search results view is displayed.


Removing Favorites

You can remove favorites that you created. To remove a favorite, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget.




  3. Click the widget Action button () and then click Favorites.



    Your saved favorites appear.



  4. Click the datapoint Action button () and then click Remove Favorite.



    Or, to remove selected favorites, click the favorites to remove (a checkmark appears), 
    click the widget Action button (), and then click Remove Selected Favorites.



    Or, to remove all favorites, click the Select All button (), click the widget Action button (), and then click Remove Selected Favorites.



    A  dialog box similar to the one shown below appears confirming the delete operation.



  5. Click OK.

    The selected favorites are removed from the list.



  6. Click Back to return to the Datapoints widget view.

Exporting Datapoints

You can export a list of datapoints and their current values to a CSV file with a .data.csv extension.  You can view the exported list in a text editor or any application that supports CSV files such as Microsoft Excel.  To export a list of datapoints, follow these steps:

  1. Open the SmartServer IoT CMS.

  2. Open the Datapoints widget.



  3. To export a single datapoint, click the datapoint Action button () and then click Export Datapoint.



  4. To export selected datapoints, click the checkmark for the datapoints (the checkmark changes from blue to yellow), click the widget Action button (), and thenb click Export Selected Datapoints.



  5. To export all datapoints, click the widget Action button () and then click Export All Datapoints.