Export: Flow-Cal Transaction Queue
Note: This command is provided as an optional feature, for gas devices. For this command to function, several requirements must be met.
If installed, Export: Flow-Cal Transaction Queue (EXPFDB via script) is the command that triggers the FMS to export raw periodic records from FMS to a Flow-Cal database transaction queue. The periodic data is resolved for each eligible device via the customizable CDF, and the FMS Service exports the raw data records, created within the specified time range, to the specified Flow-Cal database. Data that is not from a raw data source, e.g. has been imported into FMS via .csv files (categorized as a "User file" source), is not included in the export.
Note: It is strongly recommended that the specified time range for the command include only record spans with fully collected data.
Command Requirements
To enable the command to export raw data to a Flow-Cal database transaction queue, and see the command listed in command management options, the following elements must be present.
- Flow-Cal Database connection — A Flow-Cal database (for example, Oracle) must be installed, with database connectivity available to the FMS. The database connection is defined in the FMS service configuration file (CygNet\Services\FMS\fms.cfg) via Database Info keywords. See FMS Configuration File Keywords for more information about configuring the Database Info Keywords to support the Flow-Cal database connection.
- Flow-Cal Database client — A Flow-Cal database client (for example, Oracle client) must be installed on the computer hosting your FMS (your client computer) and available to the FMS. See Installing CygNet Measurement for more information about installation of the Oracle Database client.
- Flow-Cal Export DLL — CygNet Measurement provides an optional DLL file that must be installed on your system to support data exports from FMS to Flow-Cal. The file (CxFmsFlowCalExport.dll) must be installed and registered in the CygNet\Support folder on the computer hosting your FMS. See Installing CygNet Measurement for more information about installation and registration of the export DLL file.
- Flow-Cal Export CDF — CygNet Measurement provides a command definition file (CDF) that must be installed on your system to define how raw periodic data is exported from FMS to a Flow-Cal database transaction queue. The CDF contains the data item mappings and actions necessary to execute the export command and send data to the corresponding Flow-Cal database version and type, and the file can be customized to define how the data items are handled. The specific CDF file (ExportFlowCalDb.cdf) must be included in the CygNet\Services\FMS\CommandDefs folder on your host server. See Installing CygNet Measurement for more information about installation and registration of the export CDF file. See Editing or Customizing the Command Definition File for more information about using and modifying the CDF file.
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 Configuring Export: Flow-Cal Transaction Queue Commands and Running Node Commands for more information about using this command via FMS Explorer.
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.
Note: Refer to Flow-Cal documentation and/or contact your Flow-Cal representative for the most current information about differences between versions, and specific Flow-Cal configuration details.
Command Definition Properties
The following command definition properties apply to Export: Flow-Cal Transaction Queue 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.
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.
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.
Default value is Low level logging when scheduling a command via the MSS in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer. |
Command Parameters
The following command parameters apply to Export: Flow-Cal Transaction Queue commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.
| Parameter | Description | Type | Usage Notes |
|---|---|---|---|
|
ExStDate |
Start date/time |
DateTime |
Double-click to access the Select Start Date/Time dialog box. Select the starting date and time of the range for which to export records. Note: It is strongly recommended that the specified time span for the command include only record spans with fully collected data. See Selecting Date and Time for more information. See Note below this table. This parameter is required. |
|
ExEndDate |
End date/time |
DateTime |
Double-click to access the Select End Date/Time dialog box. Select the ending date and time of the range for which to export records. Note: It is strongly recommended that the specified time span for the command include only record spans with fully collected data. See Selecting Date and Time for more information. See Note below this table. This parameter is required. |
|
ExPmReq |
PM data requirement |
String Enum |
For periodic data, double-click to access the PM Data Requirement dialog box. Select whether to export gas metering data, from the options in the drop-down menu. Options are as follows.
This parameter is required. |
|
ExPqReq |
PQ data requirement |
String Enum |
For periodic data, double-click to access the PQ Data Requirement dialog box. Select whether to export gas quality data. Options are as follows.
This parameter is required. |
|
ExEvtReq |
Event data requirement |
String Enum |
For periodic data, double-click to access the Event Data Requirement dialog box. Select whether to export event data. Options are as follows.
This parameter is required. |
|
ExAlmReq |
Alarm data requirement |
String Enum |
For periodic data, double-click to access the Alarm Data Requirement dialog box. Select whether to export alarm data. Options are as follows.
This parameter is required. |
|
ExExpCfg |
Config data requirement |
String Enum |
For periodic data, double-click to access the Config Data Requirement dialog box. Select whether to export configuration data. Options are as follows.
Note: Be careful to require Configuration data only if the Node supports history data types that utilize configuration data. This parameter is required. |
|
ExFileVer |
File format version |
String Enum |
Double-click to access the File Format Version dialog box. Select the version of the Flow-Cal database used for the export. Options are as follows.
Note: Alternatively, file format version can be configured in the .cdf (command definition file) if desired. This parameter is required. |
|
ExDtExFlg |
Data exported flag |
String Enum |
Double-click to access the Data Exported Flag dialog box. Select whether or not to use the flag to mark exported device records in the database. Note: When a "Use flag" option is selected, the Data Exported flag is applied to the entire record, regardless of how many data type(s) are selected for export. Options are as follows.
Note: When this option is selected, the Data Exported flag is set only for records that contain data, and for which data collection (all supported types) is complete. When exporting partial records (e.g. you are only exporting PM data at this time), it is recommended to use the "Ignore flag" option, preserving the option to flag the record at a later time, when the remaining record data types are exported. This parameter is required. |
Note: 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.
*Note: If this option is selected and no associated history data is available (Collection Details value does not equal [blank]), the command will fail. See Collection Details in the CygNet Measurement Concepts topic for more information.
