Request Missing Data Commands

Device Communication: Request Missing Data

Request Missing Data (REQMISSING via script) is a Node-level command that triggers the service to retrieve missing device data for the selected Node.

The type(s) of data requested is configurable via the command parameters. Available data is dependent on the configured device properties, which in turn is related to the types of data available in the associated field device. The types of data that can potentially come back are PM history, PQ history, Events history, or Alarms history. You can also optionally configure the command to timeout if the request is not completed in a specified period of time.

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

There are no outstanding data polls of the same type

There is some data missing in the specified time range

The time range requested is after the device installation date

The time range requested is within the retention period of the device

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 Special FMS Command Notes for more information about requesting alarm and event data.

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 Request Missing Data 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 service in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in 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 service in CygNet Explorer.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Command Parameters

The following command parameters apply to Request Missing Data commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
SDateTime	Start date/time	DateTime	Double-click to access the Select Start Date/Time dialog box. Select the starting date of the time range to retrieve missing data. See Note below this table. See Selecting Date and Time for more information. This parameter is required.
EDateTime	End date/time	DateTime	Double-click to access the Select End Date/Time dialog box. Select the ending date of the time range to retrieve missing data. See Note below this table. See Selecting Date and Time for more information. This parameter is required.
GetGMHist	Get periodic metering history	String Enum	If used, double-click to access the Get Periodic Metering History dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is Yes.
GetGQHist	Get periodic quality history	String Enum	If used, double-click to access the Get Periodic Quality History dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is Yes.
GetEvents	Get events history	String Enum	If used, double-click to access the Get Events History dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is Yes. See Special FMS Command Notes for more information about requesting alarm and event data.
GetAlarms	Get alarms history	String Enum	If used, double-click to access the Get Alarms History dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is Yes. See Special FMS Command Notes for more information about requesting alarm and event data.
MaxHistCnt	Maximum history record count	Integer	If used, double-click to access the Enter Maximum History Record Count dialog box. Type the maximum number of missing history records to return into the text box. The number "x" entered will set the maximum number of missing historical records that will be returned for each history type: "x" GMHist, "x" GQHist, "x" Events, and "x" Alarms records. This parameter is optional.
RequestUA	Poll data flagged as unavailable	String Enum	If used, double-click to access the Poll Data Flagged as Unavailable dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is No.
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.

Parameter

Description

Type

Usage Notes

SDateTime

Start date/time

DateTime

Double-click to access the Select Start Date/Time dialog box.

Select the starting date of the time range to retrieve missing data. See Note below this table.

See Selecting Date and Time for more information.

This parameter is required.

EDateTime

End date/time

DateTime

Double-click to access the Select End Date/Time dialog box.

Select the ending date of the time range to retrieve missing data. See Note below this table.

See Selecting Date and Time for more information.

This parameter is required.

GetGMHist

Get periodic metering history

String Enum

If used, double-click to access the Get Periodic Metering History dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

This parameter is optional. Default value is Yes.

GetGQHist

Get periodic quality history

String Enum

If used, double-click to access the Get Periodic Quality History dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

This parameter is optional. Default value is Yes.

GetEvents

Get events history

String Enum

If used, double-click to access the Get Events History dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

This parameter is optional. Default value is Yes.

See Special FMS Command Notes for more information about requesting alarm and event data.

GetAlarms

Get alarms history

String Enum

If used, double-click to access the Get Alarms History dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

This parameter is optional. Default value is Yes.

See Special FMS Command Notes for more information about requesting alarm and event data.

MaxHistCnt

Maximum history record count

Integer

If used, double-click to access the Enter Maximum History Record Count dialog box.

Type the maximum number of missing history records to return into the text box.

The number "x" entered will set the maximum number of missing historical records that will be returned for each history type: "x" GMHist, "x" GQHist, "x" Events, and "x" Alarms records.

This parameter is optional.

RequestUA

Poll data flagged as unavailable

String Enum

If used, double-click to access the Poll Data Flagged as Unavailable dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

This parameter is optional. Default value is No.

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.

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.