Send Gas Quality Commands

Device Communication: Send Gas Quality

Send Gas Quality (SENDGQ via script) is a command that triggers the service to send gas quality or gas analysis information to the specified device. If the device is configured to use an alternate Node as its gas quality/analysis source, then the gas quality from the source will be sent. The service sends gas quality data as of the timestamp specified in the command parameters.

Devices are eligible if the following apply.

Their device record is set to "active"
The associated device record in the DDS is enabled
The user executing the command has the appropriate security access
It passes the requirements of the "Last Success" parameter
It passes the requirements of the "Last Failure" parameter

You must have proper security authorization to execute this command. See FMS Security (and CMDDEV security event) for information about configuring security access for FMS commands.

See Configuring Send Gas Quality Commands and Running Node Commands for more information about using this command via FMS Explorer.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Definition Properties

The following command definition properties apply to Send Gas Quality commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Time format	Select the desired Time format for the command from the drop-down menu. Options are as follows. Contract Device Default value is Device time. Notes: This parameter determines how the time window is selected in the database; not how the data is exported. For daily devices only, specifying start and end times of midnight (00:00:00), will always be interpreted as Contract time format, regardless of this selected parameter value.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low — displays errors Medium — displays errors and warnings High — displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer.

Send Gas Quality Process

The gas quality or gas analysis (GQ/GA) data to send to a device as a result of the Send Gas Quality command is determined by the following process.

In all situations, the most recent GQ/GA record available for the Node is used, based on the value of the gas quality timestamp configured in the command parameters, in Device time (D).
When the command is initiated, the FMS checks to see what type of data the Node supports, in order to send the appropriate values from the available gas quality/analysis records to the device. See Creating Gas Meter Nodes for more information about supported Node data.
Note: Support for gas quality (GQ) history and use of an alternate gas quality/analysis source Node are mutually exclusive. A Node can support one or the other, or neither, but not both.
- If the selected device Node supports live GQ history, then those values are available, so no send action is required.
- If the selected device Node uses an alternate gas quality/analysis source Node, then the values used are determined as follows.
  Note: Only Nodes using their own GQ/GA records can be used as a source Node. A Node configured to use an alternate Node as its gas quality/analysis source is not then eligible itself to be used as a source Node.
  - If the specified alternate source Node supports live GQ history, then those values are available, so no send action is required.
  - If the specified alternate source Node does not support live GQ history, then the database is searched for available GA values to use.
  - If GA is not present, either the GQ values are used or the Node is skipped, as defined by the Data type to send for each Node parameter.
- If the selected device Node does not support live GQ history and does not use an alternate gas quality/analysis source Node, or if no GA record is found for the source Node, then the database is searched for available GQ/GA in the selected device Node's most recent configuration record, and those values are used.
  - If both GA and GQ are present for that time, then the GA values are used.
  - If GA is not present, either the GQ values are used or the Node is skipped, as defined by the Data type to send for each Node parameter.

Command Parameters

The following command parameters apply to Send Gas Quality commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
ConfigDt	Gas quality timestamp	DateTime	Double-click to access the Select Gas Quality Timestamp dialog box. Select date/time settings. See Note below this table. See Selecting Date and Time for more information. This parameter is optional. Default value is <current time>.
SuccessDt	Skip if succeeded after	DateTime	If used, double-click to access the Select Skip If Succeeded After dialog box. Click ... to Select Date and Time. See Note below this table. See Selecting Date and Time for more information. If used, will not execute on devices that have a successful ReqConfig (Request Current Configuration) message after the given timestamp. This parameter is optional.
FailedDt	Skip if no failure after	DateTime	If used, double-click to access the Select Skip If No Failure After dialog box. Click ... to Select Date and Time. See Note below this table. See Selecting Date and Time for more information. If used, will not execute on devices unless they have a failure on or after the given timestamp. This parameter is optional.
StatPtUdc	Status point UDC	String	If used, double-click to access the Enter Status Point UDC dialog box. Type the status point UDC into the text box. If used, the UDC will be combined with the field device facility and the resolved point's status will be updated. This parameter is optional.
Timeout	Previous request timeout (hours)	Integer	If used, double-click to access the Enter Previous Request Timeout (Hours) dialog box. Type the number of hours before which the request will timeout if it hasn't been completed by the UIS. Each device is only allowed a single outstanding poll (per type) at a time. This parameter is optional.
SkipSent	Skip gas analysis if already sent	String Enum	If used, double-click to access the Skip Gas Analysis If Already Sent dialog box. Select one of the following options. Yes (YES via script) No (NO via script) If set to Yes records with a "sent" status will not be resent. If set to No the status will not be considered when sending records. This parameter is optional. Default value is No.
SkipExcpt	Skip gas analysis with open exceptions	String Enum	If used, double-click to access the Skip Gas Analysis With Open Exceptions dialog box. Select one of the following options. Yes (YES via script) No (NO via script) If set to Yes records with any "open" exceptions will not be sent. If set to No the exceptions status will not be considered when sending records. This parameter is optional. Default value is No.
TypeToSend	Data type to send for each Node	String Enum	If used, double-click to access the Data Type to Send for Each Node dialog box. Select one of the following options. Gas analysis (if present), otherwise config GQ (BOTH via script) Gas analysis (if present), otherwise skip Node (GA via script) The database is first searched for a gas analysis (GA) record. If no GA record is found, the parameter value selected determines whether to use the GQ data record instead, or to skip the Node. This parameter is optional. Default is Gas Analysis (if present), otherwise config GQ. See Send Gas Quality Process for more information.
GetCfgPri	Get current configuration prior to send	String Enum	If used, double-click to access the Get Current Configuration Prior to Send dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is No.

Note: Date/time — When using relative (rather than absolute) date/time, if both the start and end date/time have hour, minute, and second values of 00 (or if both are set to midnight), an additional day will be added to the date at the end of the range. This occurs because the service assumes the start of the day for the starting date/time and the end of the day for the ending date/time in these circumstances. Therefore requesting a time range from T to T will yield one day of data, and from T-1 to T will yield two days of data. If only one day of data is desired when using relative date/time, the start and end date/times must therefore be the same. If any of the start or end date/time hour, minute, or second values are specified as a value other than zero (or midnight) however, the range will be used as specified.