CygNet Measurement > FMS Explorer > Commands Menu > Managing Node Commands > Request Product Data

Configuring Request Product Data Commands

For each eligible device the Request Product Data command resolves to, the service will request the product data from each resolved device.

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

Configuring a Request Product Data Command

To Configure a Request Product Data 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

  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.
  5. Click to select/clear the check box to Prompt when command runs.
  1. Define the command parameters. The parameters for the Request Product 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.
  1. 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 Product 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 status

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.

Back to top

Command Parameters

The following command parameters apply to Request Product 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.

Skip if product record exists after

If used, will not execute a poll for devices that have a successful ReqProduct message after the given timestamp

Click ... to Select Date and Time.

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.

This parameter is optional.

Editing or Deleting a Request Product Data Command

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

Running a Request Product Data Command

See Running Node Commands for information about running this command.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.