Configuring Request New Data Commands

For each eligible device the Request New Data command resolves to, the service will ask the device to send back all new data that has come in since the last request of this type.

Prior to the initial poll using this command, it is important that you first have current configuration data for the Node. Optionally, the Configuration Request Frequency parameter can be used to request concurrent configuration/product (for liquid metering) data when you run the command. Such requests can be the initial configuration/product data requests made for the Node.

See FMS Commands and Request New Data for more information about this command.

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.

See Special FMS Command Notes for more information about retrieving event and alarm data with this command.

Configuring a Request New Data Command

To Configure a Request New Data Command

Open the Command menu in FMS Explorer.
Click Manage to access the FMS Command Definitions dialog box and then click Add to access the Create New FMS Command Definition dialog box.

Create New FMS Command Definition

Create New FMS Command Definition
Request New Device Data Command

Define the command definition properties.

Type a Name for the command into the text box. Maximum character count is 50.
Select the Command type from the drop-down menu.
Select a processing Priority from the drop-down menu.
Select a Logging level from the drop-down menu, to determine the level of logging details reported when viewing command logs. Options include Low, Medium, and High. See Viewing Command Logs for more information.
Click to select/clear the check box to Prompt when command runs.

Define the command parameters. The parameters for the Request New Device Data command are described in the Command parameters box, which includes the Description, a Required indicator, and a configurable Value field. Set the value for each required and each desired optional parameter, as indicated in its Value field.

Click Create New. The new command will appear in the list of FMS Command Definitions.

Command Definition Properties

The following command definition properties apply to Request New Data commands.

Property	Description
Name	Type in a Name for the new command.
Command type	Select the desired Command type from the drop-down menu. See FMS Commands for more information about available command types.
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 additional information applicable to the command Default value is Low level logging when scheduling a command in the MSS. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.
Prompt when command runs	Click to select/clear the check box to Prompt when command runs. Selecting this option means you will receive a prompt asking if you want to modify the parameters before the command is executed.

Command Parameters

The following command parameters apply to Request New Data commands when creating or editing commands via FMS Explorer.

Description	Value
Date format	Select the desired date format from the drop-down menu. Options are as follows. Device Contract Local Default value is Device time.
Override data tokens with date/time	If used, specifies the date/time to use to override the data tokens, in order to allow retrieval of data from a specific time. This may be necessary if the device loses power or is reset, resulting in the data tokens becoming invalid. Click ... to Select Date and Time. See Selecting Date and Time for more information. This parameter is optional.
Configuration request frequency (days)	If used, specifies the frequency at which the command will request configuration, and product if supported for the Node, records in addition to the other data Type the number of days into the value field. When the request is made, this value will be checked to determine behavior as follows. If no previous request has been made, the data will be requested, irrespective of this value. If this value (in number of days) has passed since the previous request, the data will be requested. If this value is zero (0), the data will be requested. This parameter is optional.
Previous request timeout (hours)	If used, specifies the time interval before which the request will timeout if it hasn't been completed by the UIS Type the number of hours into the value field. Each device is only allowed a single outstanding poll (per type) at a time. This parameter is optional.
Get periodic metering history	If set and configured in the device properties, will request the periodic metering history records within the time range Options are Yes or No. This parameter is optional. Default value is Yes.
Get periodic quality history	If set and configured in the device properties, will request the periodic quality history records within the time range Options are Yes or No. This parameter is optional. Default value is Yes.
Get events history	If set and configured in the device properties, will request the event records within the time range Options are Yes or No. This parameter is optional. Default value is Yes.
Get alarms history	If set and configured in the device properties, will request the alarm records within the time range Options are Yes or No. This parameter is optional. Default value is Yes.
Get batch data	If set and configured in the device properties, will request liquid batch data records Options are Yes or No. This parameter is optional. Default value is Yes.
Get ticket data	If set and configured in the device properties, will request liquid ticket data records Options are Yes or No. This parameter is optional. Default value is Yes.
Request missing/unavailable data	If set and configured in the device properties, will request missing or unavailable data records Options are as follows. Missing and unavailable data Missing data only None This parameter is optional. Default value is Missing and unavailable data.
Add Node to group if unsuccessful	If used, enter the name of a valid general group Node to which to add a device Node if its data poll does not succeed. This facilitates future polling by providing a group containing the device Nodes for which the data request was unsuccessful. See Creating General Group Nodes for more information. Notes: Create the targeted general group Node in advance, naming the group descriptively to clearly identify its data request type. It is recommended to NOT enforce uniqueness when configuring a group Node for this purpose. Review command logs for details of Node additions and/or errors. Manually remove each Node from the polling group once its corresponding data request has succeeded. This parameter is optional.

Editing or Deleting a Request New Data Command

See Managing Node Commands for information about editing or deleting this command.

Running a Request New Data Command

Note: Requests can only be processed for dates occurring after the device installation date(s). Compare the device installation date(s) to the command Start and End dates before running a Request New Data command.

See Running Node Commands for information about running this command.