Parameters are managed by and contained within Data Sources. Parameters store the individual timeseries acquired by its Data Source. There are a few different types of parameters but essentially they support Monitoring or Controlling of values.
Configure properties via the Workspaces Tree context menu or List View properties icon. Requires configure permission.
Available options will vary based on Parameter type.
The general section allows you to specifiy display settings for Number and Time Parameters.
Select how this parameter should be displayed by default:
Value is the default display type for analog data.
State can be used for digital or discrete data and displays the state associated with the value (rather than the value).
Optionally apply a Multiplier/Offset or Equation to the stored historic data for display, notifications and alarms.
Multiplier is applied to raw data for state evaluation and display.
Offset is a value applied to raw data for state evaluation and display. Note: Multiplier is always applied before offset.
Equation can be used to apply an advanced mathematical transformation of the value.
Specify how the value should be formatted for display.
Number Parameters use this setting to set how many decimal places should be shown (leave empty to display the value with all included decimal places). 0 will always display a digit. # will only display a digit if it exists.
Time Parameters use this setting to determine the formatting of the timestamp (leave empty to display timestamps in your default user time format). Select a preset format from the drop down list or specify a custom format using time format tokens.
States allow you to define unlimited numbers of Ranges or Discrete thresholds that uniquely describe the current value of the parameter. Each state can optionally be configured to raise an alarm and/or send notifications.
Number Parameters can use either Range or Discrete states. Text Parameters are limited to Discrete states only.
Click the Edit button to show and modify the configuration for each state. Use the Add state button to create a new state. States can be removed via the dropdown menu (accessible by clicking the menu button on the top-right corner of the state item).
Drag and drop the NORMAL state in the list to change its order. The NORMAL state must always exist and can not be removed. Position states above or below the NORMAL state to capture higher or lower than normal values respectively.
Drag and drop states in the list to change their display/evaluation order.
Select the type of States most suitable for your data.
Range is the default option for most analog data and allows you to define a State that covers a range of values. eg. 1-10 = LOW
Discrete is most commonly used with digital data where a State represents a specific (or matching) value. eg. 0 = OFF, 1 = ON
States positioned above NORMAL will be active when the parameter value increases to this threshold. States positioned below NORMAL will be active when the parameter value decreases to this threshold. Optionally use the dropdown menu to specify the minimum number of repeat values at or beyond threshold required to trigger this state. Default 1x.
Applies to Range States only.
Optionally use the dropdown menu to specify the minimum number of matching repeat values required to trigger this state. Default 1x.
Applies to Discrete States only.
Select when notifications should be sent.
Active or Inactive will send notifications when the state becomes active or inactive.
Active will only send notifications when the state becomes active.
Inactive will only send notifications when the state becomes inactive.
Never will not send notifications.
Charts section allows you to configure the display style and formatting of the parameter when displayed in the Charts View or shown on the adhoc Historic Chart.
Select the chart type and display preferences.
Select the data and processing to be used.
Automatic is the recommended option for fast loading charts and uses Interpolated (or Start where Display type is State) aggregate and automatic period selection based on zoom level.
Custom allows you to specify exactly how data should be aggregated for display on the charts.
- Aggregates provide a method to resample raw data over a specified period. See the list of available aggregates for full details. Select RAW to display the original raw data with no aggregation applied (Interval and Base time options will be hidden).
- Aggregate display
- Determines if aggregated data will be show only after intervals are complete, or be shown during an aggregation interval when only partial data is available.
- Automatic will change the period of the aggregate calculation based on the zoom level of the chart. Fixed Period lets you define a fixed Interval and Base time that will be applied regardless of the zoom level.
- Specify the data range that is included for each calculated value. Example 30M will calculate a value for each 30 minute window of data.
- Base time
- Base time is used to determine the start of the aggregate calculations. Example D+9H will start the calculations at 9am (start of current day + 9 hours). See working with relative time for full details.
Raw does not perform any aggregation of data. This option should ONLY be used where you know the period to be displayed does not contain more than a thousand data points. Displaying high resolution raw data can impact on chart performance and in some cases may cause the chart to fail loading or have adverse affects on your web browser.
Data point values are not modified.
The first data point value in the requested time range is subtracted from all subsequent data point values.
Select customization options for chart appearance.
Settings of Interest
Select which State thresholds should be displayed on the chart:
Rating parameters use an Input parameter and one or more ratings to caculate its data.
Rating tables should have multiple rows specifying an input lookup value and corresponding result value. Values that fall between each input lookup will be derived by linear interpolation.
Rating equations allow multiple coefficients to be defined which are used to calculate a value using a polynomial equation.
Multiple ratings can be added, with the start time used to determine the data range each rating will apply.
Ratings can be imported and exported using the fixed ratings CSV format.
Only Number parameters within the same Workspace (or Template) can be used as the Input parameter.
Click the Delete buttons and save to permanently remove all historic data or events for this Parameter.
The control section allows you to configure control options for Control Parameters.
Select what values are acceptable for control operations:
None does not restrict the control value. User can enter any value of the same type as the parameter. eg. Number, Text, Time.
Range restricts Number Parameter control values with a minimum and maximum value.
States restricts control values to the configured state threshold/match values. eg. ON / OFF.
The Security section displays a list of all users and groups that have access to the Node. Users with security permission can restrict user and group access to the node and its descendants by assign the No Access role.
New users and groups must be added via the Workspace Security section.
The Account Owner, Administrators or Workspace users/groups that have been assigned a Workspace role with the configure permission can not be assigned the No Access role.
Enabling public access allows anyone to view the node (attachment, chart, dash, report or historic data) using the generated URL.
You can also embed charts and dashboards into your own website with basic HTML. Select Copy embed HTML from the URL dropdown menu for a generic code snippet (you will need to paste this in to your website). You can also revoke and replace the automatically assigned URL by selecting the Generate new URL option in the menu.
Use the available options to customize the URL based on your display preferences. These options are transient and you can use multiple variations of the URL at the same time.
This feature is not included in Starter accounts.