Configuring Request Current Configuration Commands

For each eligible device the Request Current Configuration command resolves to, the service will request the current configuration record from each resolved device.

When device configuration is requested for the first time, the data will be copied back to be effective as of the device install date, as a system generated record.

See FMS Commands and Request Current Configuration 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.

Configuring a Request Current Configuration Command

To Configure a Request Current Configuration Command

1. Open the Command menu in FMS Explorer.
2. 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 Request Current Configuration Command

3. Define the command definition properties.

1. Type a Name for the command into the text box. Maximum character count is 50.
2. Select the Command type from the drop-down menu.
3. Select a processing Priority from the drop-down menu.
4. 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.
5. Click to select/clear the check box to Prompt when command runs.

4. Define the command parameters.

1. Select the Time format from the drop-down menu. Options are Contract or Device time.
2. Set the value for each required and each desired optional parameter, as indicated in its Value field. The parameters for the Request Current Configuration command are described in the Command parameters box, which includes the Description, a Required indicator, and a configurable Value field.

5. 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 Current Configuration 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 Current Configuration 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.
Skip devices with good config after	If used, will not execute poll on devices that have a successful ReqConfig (Request Current Configuration) message after the given timestamp. Click ... to Select Date and Time. See Selecting Date and Time for more information. See Note below this table. This parameter is optional.
Limit to 1 pending poll/device (hours)	If used, enter the number of hours to limit the queue to 1 pending poll/meter. This limits the number of requests in the queue for a specific device. Example The parameter is set to 1 hour and you poll at 8:00 a.m. If you poll again at 8:05 a.m., but the original request in still in the queue, the second message will be discarded since the pending time has not been exceeded. Click OK. This parameter is optional.
Get liquid product data	If used, determines whether or not to request liquid product data for each eligible device See Request Product Data for more information. Options are Yes or No. This parameter is optional. Default value is Yes.
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 Current Configuration Command

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

Running a Request Current Configuration Command

See Running Node Commands for information about running this command.