Creating Liquid Device Nodes
Use the Create Liquid Device button to create new FMS Liquid Device Node configurations. Liquid device Nodes can be configured to support periodic, batch, and/or ticket history data.
CygNet Measurement also provides a system command that can automatically create FMS device Nodes in your system. See the following topic for more information about this option.
See Viewing and Editing Liquid Device Node Properties for more information about accessing properties for meters that have already been created.
Creating a New Liquid Device Node
To create a new Liquid Device Node, open the Nodes menu in FMS Explorer, and then click Create Liquid Device. A series of dialog boxes will appear.
Note: These dialog boxes are the same as dialog boxes that open when you click New FMS Node on the FMS page of a remote device in the Device Definition Service (DDS), and the same dialog boxes that open when you View Node properties from many context menus in FMS Explorer and the FMS in CygNet Explorer.
The following tables list and describe property fields found on the Create Liquid Device dialog boxes.
Device Definition
To create a new Liquid Device Node, first define it in the Device Definition Service (DDS).
|
Liquid Device Node |
Enter the following device properties to define the new liquid device.
| Property | Description |
|---|---|
|
Node ID |
The system-assigned Node ID for the liquid device. When creating new Liquid Device Nodes this will indicate NEW. |
|
Enabled |
The Enabled check box indicates whether the liquid device is enabled or not. An unchecked box does not mean the Node is deleted; all Node settings are saved until you choose to enable the Node. Default value is Enabled. |
|
Device name |
Type in the name for the Liquid Device Node. Valid characters (maximum of 20) are as follows. A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing. This parameter is required. |
|
Description |
Type in a free-form Description for the liquid device. This parameter is optional. |
|
Security application |
Enter the security application used to validate users of the Node. Use this setting to control user access, for example, to only give certain users access to particular Liquid Device Nodes. See FMS Security for more information. This parameter is optional. |
|
Sort priority |
Type in the Sort priority number to assign to the Liquid Device Node. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list. Default value is 0. This parameter is optional. |
| Data source options | |
|
Data source |
Select the applicable Data source for the device. Currently, only one data source may be selected per Node. Options are as follows.
*Note: Only devices with periodic history are supported for FMS Legacy polling engines. |
|
Polling UIS |
If Polling Engine is your selected Data Source, click … to select the polling UIS for the liquid device. |
|
Polling facility |
If Polling Engine is your selected Data Source, click … to access the Select Facility dialog box and select the polling facility for the liquid device. Note: The Select Facility list provided contains all linked facilities that belong to the FMS Configuration data group corresponding to your data source selection. |
|
Note: The Unit set override parameter is optional. It is provided to give you the ability to override units in cases where GMR data coming into FMS (via the FMS Toolbox) may contain values in units other than the assumed GMR units. In such a case, use this parameter to define the unit set to use instead, and the FMS system will apply the specified unit set to the incoming GMR data. See GMR Data Items Units for more information. If used, select a unit set for the system to apply to GMR data, from the options in the drop-down menu. Options in the drop-down menu are populated by the enabled, read-only unit sets configured in your system. You may have to create the applicable unit set first. See Configuring Unit Set Definitions for more information about creating FMS unit sets. |
|
|
Source data retention |
For periodic liquid devices, enter the maximum time, in number of days, that source data is retained on your flow computer. Retention on most flow computers is 35 days. Default value is 35 days. |
| Normalization options | |
|
Contribution |
Select the applicable contribution from the drop-down menu to indicate how the selected device contributes to the system. Options are as follows.
Note: Edits to this property can only be applied for the entire span of the Node. An error message will appear if you try to edit this value for a partial span. |
|
Reporting CVS |
Click … to access the Select CVS dialog box and select the CVS reporting data for the liquid device. Note: This CVS does not need to contain the raw data collected by the Data Source. |
|
Reporting facility |
Click … to access the Select a Facility dialog box and select the facility reporting data for the liquid device. To filter facilities by up to six attributes, click Advanced Filter. Note: This facility does not have to be a device facility. It can be used to hold data pushed back from FMS to CygNet SCADA. |
When you are done, click Next > to access the Device Properties dialog box.
Device Properties
When the Device Definition is complete, configure the Device Properties.
|
Device Properties |
Enter the following liquid device properties and supported data types to describe the new device.
| Property | Description |
|---|---|
| Properties | |
|
Device install date (Device time) |
Select the date and time of the installation of the liquid device using the date and time selectors. When no user-entered value is provided, the default install date value is 36 days prior to Node creation, at 12:00:00 AM. Notes: The Request Missing Data or Request New Data commands will not request data prior to the device install date. Edits to this property can only be applied for the entire span of the Node. An error message will appear if you try to edit this value for a partial span. |
|
Use job schedule start date |
Note: This parameter defines a date used by the Schedule Jobs command for CygNet Dispatch. For more information about the CygNet Dispatch product, contact your Account Manager or CygNet Sales. When using CygNet Dispatch, optionally set this value to define the first possible start date that can be used for job occurrences associated with this Node, when automatically scheduling jobs via the Schedule Jobs command. If used, click the check box to access the date selector, and specify the earliest date from which CygNet Dispatch jobs for this Node can be scheduled. When no user-entered value is provided, the default value is the Device install date. See Schedule Jobs for more information. |
| Supported data
Note: Each of the following properties is read-only once the corresponding data type has been collected for the Node. The properties can only be edited if the device has not yet received the corresponding data, since Node properties must be consistent across their time continuum. Trying to edit a Supported data property, for a device which has already received that type of data, will produce a service error. |
|
|
Periodic history |
If the device supports Periodic history data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy History or FMS History (liquid metering). If the Data source is an FMS polling engine, this property is optional. If the Data source is an FMS Legacy polling engine, this property is required. |
|
Record span |
Record span is enabled for devices with periodic history. Click to select the record span for the device from the options in the drop-down menu. Options are as follows.
This property is required for devices with periodic history. |
|
Batch history |
This property only applies for FMS devices. If the device supports Batch history data, click to select the check box. If the Data source is an FMS polling engine, this requires a properly configured device in the DDS with at least one FMS Batch data group. This property is optional. |
|
Ticket history |
This property only applies for FMS devices. If the device supports Ticket history data, click to select the check box. If the Data source is an FMS polling engine, this requires a properly configured device in the DDS with at least one FMS Ticket data group. This property is optional. |
|
Product |
This property only applies for FMS devices. If the device supports liquid product data, click to select the check box. If the Data source is an FMS polling engine, this requires a properly configured device in the DDS with at least one FMS Product data group. This property is optional. |
|
Configuration |
If the device supports configuration data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy Configuration or FMS Configuration. Note: Be careful to select the Configuration check box only if the Node supports history data types that utilize configuration data. If selected for a Node where the supported history types do not utilize configuration data (for example, the Node supports Batch history, but not periodic history) any commands that try to retrieve configuration data will fail since it does not exist. This property is optional. |
|
Events |
If the device supports event data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy Events or FMS Events. This property is optional. |
|
Alarms |
If the device supports alarm data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy Configuration (alarms) or FMS Alarms. This property is optional. |
When you are done, click Next > to access the Time dialog box.
Time
When the Device Properties are complete, configure the Time properties.
|
Time Properties |
Enter or verify the following time fields for the new Liquid Device Node.
| Property | Description |
|---|---|
|
Contract offset |
Type the number (in hours) of the contract hour offset. This number is synonymous with the Contract time. It is an offset (in hours) from the Device time, describing the hour at which the contract day begins. |
|
Time zone |
Click to select the desired time zone from the drop-down menu. Note: Edits to this property can only be applied for the entire span of the Node. An error message will appear if you try to edit this value for a partial span. |
|
Enable daylight saving |
Click to enable an adjustment for daylight saving time. Notes:
|
| Internal time configuration | |
|
CygNet Key |
An internal CygNet identifier Each time zone is assigned a unique numerical key in the CygNetTimeZones.xml file, located in the CygNet\Services\ARS folder on your host server. This property is read-only. Note: This value requires a properly installed CygNetTimeZones.xml file. See CygNetTimeZones.xml File for more information. |
|
Base bias from UTC |
The offset in hours between the device's expected time and Coordinated Universal Time (UTC) (also known as Greenwich Mean Time or GMT) This property is read-only. |
|
Standard time bias |
The offset in hours from the base bias to account for standard time in the selected time zone This property is read-only. |
|
Standard time name |
The complete standard time zone name, for example Eastern Standard Time This property is read-only. |
|
Standard time begins |
The date that standard time begins, for example 1st Sun in Nov. This property is read-only. |
|
Daylight saving bias |
The offset in hours between standard time and daylight saving time This property is read-only. |
|
Daylight saving name |
The complete daylight saving time zone name. For example, Pacific Daylight Time This property is read-only. |
|
Daylight time begins |
The date that daylight saving time begins, for example 2nd Sunday in March This property is read-only. |
| Time comparison | |
|
Local computer current time |
The time of the client computer Do not alter the client computer's time; it may cause undesirable changes in your CygNet system. This property is read-only. |
|
Device expected time |
The time expected for the remote device This property is read-only. |
When you are done, click Finish to access the Save FMS Record dialog box.
Save FMS Record
Once the new Liquid Device Node properties are configured, you'll be asked to save your changes via the Save FMS Record dialog box. Configure the date and audit information requested to historize the changes in your system.
Specify the following parameters to describe the saved record.
|
Save FMS Record — Indefinite end |
| Property | Description |
|---|---|
|
Change begin |
Set the effective date and time for the record change to begin. Options are as follows.
|
|
Change end |
Note: Upon Node creation, this date selection is automatically set to Indefinite. Options become available for edits made to Node properties. |
|
Audit category |
Select an appropriate Audit category from the drop-down menu. The audit category type for Node creation is Configuration Change. Audit categories are configured on the Admin menu. See Configuring Audit Categories for more information. |
|
Comments |
Type Comments regarding creation of the Node in the text box. Although comments are optional, they become part of the record and can be helpful when auditing or reviewing records. |
When all parameters are configured, click Save to save the new Liquid Device Node settings.
