Scripting > CxFms > FmsStationGroup Object > FmsStationGroup Properties

FmsStationGroup Properties

The FmsStationGroup object contains the following properties.

Property SubType Read Only Description

BeginActiveDate

Date

No

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

CategoryName

String

No

The category name for the group.

Description

String

No

The description of the group.

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

FacilityId

String

No

The facility ID of the group.

Name

String

No

The name of the group.

NodeId

Integer

No

The associated Node ID of the group.

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

SecurityApp

String

No

The security application of the group.

SiteService

String

No

The associated Site.Service of the group.

SortPriority

Integer

No

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

StationBaseFpvMethod

Integer

No

The station base FPV method of the group.

StationBasePressure

Integer

No

The station base pressure f the group.

StationBaseSync

Boolean

No

The station base sync bit of the group.

StationBaseTemp

Integer

No

The station base temperature of the group.

StationContractHour

Integer

No

The contract hour of the group.

StationContribution

Integer

No

The contribution of the group. This property can be one of the following values:

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

StationTimezoneDst

Boolean

No

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

StationTimezoneKey

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 group Node types.

  • Station group (physical)

StationType

Integer

No

The station type of the group. This property can be one of the following values:

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

StationValidationNodeId

Integer

No

The Node ID of the linked station of the group. This ID must match an existing station in the FMS.

StationValidationNodeName String No

The node name of the linked station of the group.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.