FmsDevice Properties

The FmsDevice object contains the following properties. Each property is supported for the FMS device type(s) indicated by a Check

in the Device Type column(s).

Property	SubType	Read Only	Description	Device Type
AlternateSourceNodeName	String	No	When UseAlternateSource is set to True, the Node name used as the alternate source of gas quality or gas analysis data for the device. This name must match an existing Node name in FMS.		N/A
BeginActiveDate	Date	No	The date the record starts being active, in Contract time (C). To specify an indefinite date, set this property to zero (0) when creating an FmsDevice.
CollectionMethod	Integer	No	The collection method of the device. This property can be one of the following values. 0 — FMS Polling Engine 1 — Device Import 2 — Other 3 — FMS Legacy Polling Engine 4 — Associated Site/Service* *Note: Although "Associated Site/Service" is not an actual data collection method, it provides a facility association applicable to an Accessory Node (available primarily for scheduling jobs in conjunction with CygNet Dispatch).		*
ContractHour	Integer	No	The contract hour of the device.
DaysOfData	Integer	No	The number of days for which the source device associated with the Node will retain data. Value cannot be 0.
Description	String	No	The description of the device.
DeviceInstallDate	Date	No	The install date of the device, in Device time (D).
EndActiveDate	Date	No	The date the record stops being active, in Contract time (C). To specify an indefinite date, set this property to zero when creating an FmsDevice.
FacilityId	String	No	The facility ID of the device.
GmrUnitSetId	Integer	No	The (optional override) unit set for the system to apply to data exported from GMR. Note: GmrUnitSetId is optional. It provides the ability to override units in cases where GMR data coming into FMS may contain values in units other than the expected GMR units. In such cases, 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.
HasAlarms	Boolean	No	The alarms status of the device. If this property is set to True, the device has alarm history.
HasBatchHistory	Boolean	No	The batch status of the device. If this property is set to True, the device has batch history data.	N/A
HasConfig	Boolean	No	The configuration status of the device. If this property is set to True, the device has a configuration.
HasEvents	Boolean	No	The events status of the device. If this property is set to True, the device has event history.
HasPMHistory	Boolean	No	The periodic metering status of the device. If this property is set to True, the device has periodic metering history.		*
HasPQHistory	Boolean	No	The periodic quality status of the device. If this property is set to True, the device has periodic quality history.		N/A
HasProduct	Boolean	No	The liquid product status of the device. If this property is set to True, the device has liquid product data.	N/A
HasTicketHistory	Boolean	No	The ticket status of the device. If this property is set to True, the device has ticket history data.	N/A
IsActive	Boolean	No	The active status of the device. If this property is set to True, the device is active.
JobScheduleStartDate	Date	No	The first possible date, in Device time (D), that can be used for scheduling job occurrences associated with the Node, when automatically scheduling jobs via the Schedule Jobs command. If no date is provided, default value used is the DeviceInstallDate.
Name	String	No	The name of the device.
NodeId	Integer	No	The associated Node ID of the device. Note: This property is not used with the CreateDevice method.
PMRecordSpan	Integer	No	The periodic metering record span(in minutes). This property can be one of the following values. 60 - Hourly 1440 - Daily Note: For gas devices, PMRecordSpan and PQRecordSpan must be configured to be the same value. If they are not the same value, the PMRecordSpan value is applied to both.		(Applies only to liquid devices with Periodic history)
PollingFacilityId	String	No	The polling facility ID of the device’s data source, if the CollectionMethod is Polling Device (0).
PollingSiteService	String	No	The polling UIS of the device’s data source, if the CollectionMethod is Polling Device (0).
PQRecordSpan	Integer	No	The periodic quality record span (in minutes). This property can be one of the following values. 60 - Hourly 1440 - Daily Note: For gas devices, PMRecordSpan and PQRecordSpan must be configured to be the same value. If they are not the same value, the PMRecordSpan value is applied to both.		N/A
SecurityApp	String	No	The security application of the device.
SiteService	String	No	The associated reporting Site.Service of the device.
SortPriority	Integer	No	The sort priority of the device. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list.
StationContribution	Integer	No	The contribution of the meter (if the meter is a station). This property can be one of the following values. 0 — Receipt (+) 1 — Delivery (-)		N/A
StationType	Integer	No	The station type of the meter (if the meter is a station). This property can be one of the following values. 0 — Custody 1 — Check 2 — Interconnect 3 — Line Pack 4 — Gas Loss 5 — Other		N/A
StationValidationNodeId	Integer	No	The Node ID of the linked station of the meter (if the meter is a station). This ID must match an existing station Node ID in FMS.		N/A
StationValidationNodeName	String	No	The Node name of the linked station of the meter (if the meter is a station). This name must match an existing station Node name in FMS. Note: This property is not used with the CreateDevice method.		N/A
TimezoneDst	Boolean	No	The daylight saving time status of the device. If this property is True, daylight saving time is enabled for the device.
TimezoneKey	Integer	No	The internal CygNet identifier for the time zone. 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. See CygNetTimeZones.xml File for more information. A list of available time zones for FMS is found on the Time page of property sheets for the following device Node types. Gas meter (or Station meter) Chromatograph Liquid device
UseAlternateSource	Boolean	No	Determines if the device uses another Node as the source for its gas quality or gas analysis data. If this property is set to True, the device will use the Node defined by the AlternateSourceNodeName property as its gas quality/analysis data source, instead of what is configured on the corresponding EFM device.		N/A

Property

SubType

Read Only

Description

Device Type

Gas

Liquid

AlternateSourceNodeName

String

When UseAlternateSource is set to True, the Node name used as the alternate source of gas quality or gas analysis data for the device. This name must match an existing Node name in FMS.

N/A

BeginActiveDate

Date

The date the record starts being active, in Contract time (C). To specify an indefinite date, set this property to zero (0) when creating an FmsDevice.

CollectionMethod

Integer

The collection method of the device. This property can be one of the following values.

0 — FMS Polling Engine
1 — Device Import
2 — Other
3 — FMS Legacy Polling Engine
4 — Associated Site/Service*

*Note: Although "Associated Site/Service" is not an actual data collection method, it provides a facility association applicable to an Accessory Node (available primarily for scheduling jobs in conjunction with CygNet Dispatch).

ContractHour

Integer

The contract hour of the device.

DaysOfData

Integer

The number of days for which the source device associated with the Node will retain data. Value cannot be 0.

Description

String

The description of the device.

DeviceInstallDate

Date

The install date of the device, in Device time (D).

EndActiveDate

Date

The date the record stops being active, in Contract time (C). To specify an indefinite date, set this property to zero when creating an FmsDevice.

FacilityId

String

The facility ID of the device.

GmrUnitSetId

Integer

The (optional override) unit set for the system to apply to data exported from GMR.

Note: GmrUnitSetId is optional. It provides the ability to override units in cases where GMR data coming into FMS may contain values in units other than the expected GMR units. In such cases, 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.

HasAlarms

Boolean

The alarms status of the device. If this property is set to True, the device has alarm history.

HasBatchHistory

Boolean

The batch status of the device. If this property is set to True, the device has batch history data.

N/A

HasConfig

Boolean

The configuration status of the device. If this property is set to True, the device has a configuration.

HasEvents

Boolean

The events status of the device. If this property is set to True, the device has event history.

HasPMHistory

Boolean

The periodic metering status of the device. If this property is set to True, the device has periodic metering history.

HasPQHistory

Boolean

The periodic quality status of the device. If this property is set to True, the device has periodic quality history.

N/A

HasProduct

Boolean

The liquid product status of the device. If this property is set to True, the device has liquid product data.

N/A

HasTicketHistory

Boolean

The ticket status of the device. If this property is set to True, the device has ticket history data.

N/A

IsActive

Boolean

The active status of the device. If this property is set to True, the device is active.

JobScheduleStartDate

Date

The first possible date, in Device time (D), that can be used for scheduling job occurrences associated with the Node, when automatically scheduling jobs via the Schedule Jobs command.

If no date is provided, default value used is the DeviceInstallDate.

Name

String

The name of the device.

NodeId

Integer

The associated Node ID of the device.

Note: This property is not used with the CreateDevice method.

PMRecordSpan

Integer

The periodic metering record span(in minutes). This property can be one of the following values.

60 - Hourly
1440 - Daily

Note: For gas devices, PMRecordSpan and PQRecordSpan must be configured to be the same value. If they are not the same value, the PMRecordSpan value is applied to both.

(Applies only to liquid devices with
Periodic history)

PollingFacilityId

String

The polling facility ID of the device’s data source, if the CollectionMethod is Polling Device (0).

PollingSiteService

String

The polling UIS of the device’s data source, if the CollectionMethod is Polling Device (0).

PQRecordSpan

Integer

The periodic quality record span (in minutes). This property can be one of the following values.

60 - Hourly
1440 - Daily

Note: For gas devices, PMRecordSpan and PQRecordSpan must be configured to be the same value. If they are not the same value, the PMRecordSpan value is applied to both.

N/A

SecurityApp

String

The security application of the device.

SiteService

String

The associated reporting Site.Service of the device.

SortPriority

Integer

The sort priority of the device. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list.

StationContribution

Integer

The contribution of the meter (if the meter is a station). This property can be one of the following values.

0 — Receipt (+)
1 — Delivery (-)

N/A

StationType

Integer

The station type of the meter (if the meter is a station). This property can be one of the following values.

0 — Custody
1 — Check
2 — Interconnect
3 — Line Pack
4 — Gas Loss
5 — Other

N/A

StationValidationNodeId

Integer

The Node ID of the linked station of the meter (if the meter is a station). This ID must match an existing station Node ID in FMS.

N/A

StationValidationNodeName

String

The Node name of the linked station of the meter (if the meter is a station). This name must match an existing station Node name in FMS.

Note: This property is not used with the CreateDevice method.

N/A

TimezoneDst

Boolean

The daylight saving time status of the device. If this property is True, daylight saving time is enabled for the device.

TimezoneKey

Integer

The internal CygNet identifier for the time zone. 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.

See CygNetTimeZones.xml File for more information.

A list of available time zones for FMS is found on the Time page of property sheets for the following device Node types.

Gas meter (or Station meter)
Chromatograph
Liquid device

UseAlternateSource

Boolean

Determines if the device uses another Node as the source for its gas quality or gas analysis data. If this property is set to True, the device will use the Node defined by the AlternateSourceNodeName property as its gas quality/analysis data source, instead of what is configured on the corresponding EFM device.

N/A