Flow-X Commands

Common Commands

See Device Object Common Commands for commands that are common to all device types.

Commands

Command	Description	Parameters
Abort Current Task	Aborts the current task.	None
Demand Poll	Requests a poll of the device.	None
Dump Item List	Logs all advised items to the logger.	None
Test Communication	Sends a short read message to the device to confirm connection to the device.	None
Time Sync	Synchronize the device's date and time with the host system, including time zone and daylight saving options.	None
Retrieve History	Collects alarms, events, and EFM records from all archives configured in ACM.	None
Retrieve meter config during next history poll	Enter the meter run number to retrieve only the configuration for that meter or leave blank to retrieve for all configured meters.	Meter Number
Read Tag Configuration	Reads the complete list of available tags in the device. This populates the OPC tag list, and gives ACM a reference for tag data types, etc. This command only needs to be run once, unless the device load changes. *Note: This command retrieves a large amount of data.*	None
Copy Tag Configuration	Copies the tag file and tag reference files from a configured Spirit Flow-X object which has already run the 'Read Tag Configuration' command. The 'Copy Tag Configuration' command should only be used if the configured devices share the same device load.	Device ID
Read Device Settings	Reads global device settings tags needed to interpret data from the device. For example, reading the device’s global date format allows ACM to interpret dates in EFM records. The first time history is collected, the command will be run automatically. However, if device global settings change, the command may need to be re-run. Currently, the only global setting read is the date format.	None
Reset History Pointer	Resets the retrieval pointer to the beginning of the requested archive.	Archive Name
Reset Event Pointer	Resets the retrieval pointer to the beginning of the event list.	None
Reset Alarm Pointer	Resets the retrieval pointer to the beginning of the alarm list.	None
Retrieve Report	Report Name – Enter the report name prepended by the module id and a colon, i.e. 1:Run_Daily-1.20100623.fxr. To see a list of module numbers and reports, use a browser to open http://DeviceIpAddress/reports (replace “DeviceIpAddress” with the actual IP). The data returned by that URL is an XML listing of the reports currently available in the device. The “file” attribute is the report name, and the “mod” attribute is the module id. The report must be on that list for ACM to retrieve it. Report Type – Enter the report format desired. Note: This will be respected regardless of whether the report name contains an “fxr” suffix.	Report Name Report Type
Retrieve Scheduled Report	Report Name – Enter the name of the Scheduled Report as entered in the field "Report Name in Device" in the Scheduled Reports records. Executing this command will retrieve all reports that match the scheduled report record indicated by Report Name that have not previously been retrieved.	Report Name
Reset Scheduled Report	Report Name – Enter the name of the Scheduled Report as entered in the field "Report Name in Device" in the Scheduled Reports records. Executing this command will reset the retrieval pointer for the scheduled report indicated by Report Name.	Report Name