Device Total QTR Report Templates

Device Total QTR (Quantity Transaction Record) report templates contain a ReportDefinition page and a ReportSheet page, that together describe the reports you can produce. CygNet provides a sample report template file DeviceTotalQtrTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.

The ReportDefinition sheet includes the following parameters to describe the type of report to build.

ReportParameters
Worksheet

The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.

Header
Data Table Header
Data Table
Report Totals Footer
Report Footer

Displaying Additional (Non-Token) Values

You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.

Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.

Example

[Volume] is a valid token. If you use [Vol] (not a valid token) instead of [Volume], the value will be displayed as "[Vol]" instead of displaying the volume value desired, since [Vol] is not a valid token.

[Vol]

Displaying Beginning or Ending Values for a Record

Data item tokens have variants you can use to display the beginning or ending values for a record. Append _Begin to the token text to show the beginning value for the record period. Append _End to the token text to show the ending value for the record period. You can then view data values or configuration settings in effect at either the beginning or end of each record span (e.g. hourly, daily) as desired. If neither _Begin nor _End is appended, the default is the ending value for the record.

Displaying Flow-Weighted Average Values for a Record

Some tokens for gas metering process variable values have a variant you can use to display the flow-weighted average value for a record in your report. Tokens utilizing this version are valid for [Energy_Average_FW], [Mass_Average_FW], [Volume_Average_FW], and are listed in the Data Table Tokens table, below.

Configuring the ReportDefinition

The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.

Device Total QTR Report: ReportParameters

Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportName	The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.	Enter a value to be used for the report name. Example Device Total QTR
CommandName	The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information.	Enter a value to specify the report command name. Example DTQTR Note: Maximum of 7 characters; letters or numbers only, no spaces.

Parameter

Description

Value

ReportName

The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer.

See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.

Enter a value to be used for the report name.

Example

Device Total QTR

CommandName

The value defined in this cell will be used by the service to determine which specific report command type to execute.

See FMSClient Methods in the Scripting section for more information.

Enter a value to specify the report command name.

Example

DTQTR

Note: Maximum of 7 characters; letters or numbers only, no spaces.

Device Total QTR Report: Worksheet Parameters

Device Total QTR report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportType	The value defined in this cell will be used to represent the standard FMS report type you are configuring.	Enter a value to be used to indicate the type of the report. Example Device Total QTR
NullToken	The value defined in this cell will be used to represent null values in your report.	Enter a value to be used to indicate a "null value" cell in the report. Example [-]
MixedValueToken	The value defined in this cell will be used to represent mixed values in your report.	Enter a value to be used to indicate a "mixed value" cell in the report. Example [Mixed]
NoCmdGroupToken	The value defined in this cell will be used in your report to represent the value for the Group name or Group description fields when either of the following is true. command is not run against a group Node command is run against multiple group Nodes	Enter a value to be used to indicate the Group name or Group description when the command was not run against a single group Node. Example [Invalid Group]
NodeSortOrder	The value defined in this cell will be used to specify the order in which to display Node results in the report.	Enter one of the following options. Name ascending Description ascending Name descending Description descending Default value is Name ascending. This parameter is optional.
RptStDate	Note: If you use this parameter in your report template, the RptStDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Device Total QTR Report Definitions (FMS Explorer) or Reports: Device Total QTR (CygNet Explorer) for more information.	If used, enter a valid start date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional.
RptEndDate	Note: If you use this parameter in your report template, the RptEndDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Device Total QTR Report Definitions (FMS Explorer) or Reports: Device Total QTR (CygNet Explorer) for more information.	If used, enter a valid end date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional.
RptUnitSet	Note: If you use this parameter in your report template, the RptUnitSet parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Device Total QTR Report Definitions (FMS Explorer) or Reports: Device Total QTR (CygNet Explorer) for more information.	If used, enter a valid unit set value for the report. Valid unit set values defined in the service can be viewed through the Admin menu in FMS Explorer. See Configuring Unit Set Definitions for more information. This parameter is optional.

Configuring the ReportSheet

The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.

Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.

Device Total QTR Report: Header Tokens

Device Total QTR report headers, which appear above #EndReportHdr#, can be described by the following tokens.

Token	Description
[BeginDateTime]	Start date, in Contract day (C), of the requested time range for the report
[EndDateTime]	End date, in Contract day (C), of the requested time range for the report
[CmdGroupName]	Name of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter.
[CmdGroupDesc]	Description of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter.
[GeneratedDateTime]	Time the report was generated, in Local time (L)
[TotalDeviceCount]	Total number of devices in the report

Device Total QTR Report: Data Table Header Tokens

Device Total QTR report data table headers, which appear between #SubSection# DataTableHeader and #End#, can be described by the following tokens.

Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
[RowNumber]	Current row number
Units Tokens
[AtmosphericPressure_Units]	Units used for atmospheric pressure data
[BasePressure_Units]	Units used for base pressure data
[BaseTemperature_Units]	Units used for base temperature data
[ConeCoefficientThermalExpansion_Units]	Units used for the cone thermal expansion coefficient
[ConeDiameter_Units]	Units used for cone diameter data
[ConeRefTemp_Units]	Units used for cone reference temperature data
[CoriolisCalibrationPressure_Units]	Units used for coriolis calibration pressure
[CoriolisPressureEffect_Units]	Units used for coriolis pressure effect
[Dp_Units]	Units used for differential pressure data
[DpAlarmHigh_Units]	Units used for DP high alarm data
[DpAlarmLow_Units]	Units used for DP low alarm data
[DpBackflowAlarm_Units]	Units used for DP backflow alarm data
[DpCalibrateHigh_Units]	Units used for DP high calibrate data
[DpCalibrateLow_Units]	Units used for DP low calibrate data
[DpTransducerRangeHigh_Units]	Units used for DP high transducer range data
[DpTransducerRangeLow_Units]	Units used for DP low transducer range data
[Elevation_Units]	Units used for elevation data
[Energy_Units]	Units used for energy data
[FixedTemp_Units]	Units used for fixed temperature data
[FlowRate_Units]	Units used for flow rate data
[FlowRateAlarmHigh_Units]	Units used for flow rate high alarm data
[FlowRateAlarmLow_Units]	Units used for flow rate low alarm data
[FlowTime_Units]	Units used for flow time data
[HeatingValueBasis_Units]	Units used for heating value basis data
[HeatingValueMass_Units]	Units used for heating value mass data
[HeatingValueVolume_Units]	Units used for heating value volume data
[KFactorMass_Units]	Units used for K factor mass
[KFactorVolume_Units]	Units used for K factor volume
[LowFlowCutoffDp_Units]	Units used for low flow cutoff differential pressure data
[LowFlowCutoffFlowRate_Units]	Units used for low flow cutoff volume flow rate data
[LowFlowCutoffMass_Units]	Units used for low flow cutoff mass flow rate data
[LowFlowCutoffPulseInterval_Units]	Units used for low flow cutoff pulse interval data
[Mass_Units]	Units used for mass data
[MeterTubeInsideDiameter_Units]	Units used for meter tube inside diameter data
[MeterTubeRefTemp_Units]	Units used for meter tube reference temperature data
[OrificeCoefficientThermalExpansion_Units]	Units used for the orifice thermal expansion coefficient
[OrificePlateBoreSize_Units]	Units used for orifice plate bore size data
[OrificePlateRefTemp_Units]	Units used for orifice plate reference temperature data
[PipeCoefficientThermalExpansion_Units]	Units used for the pipe thermal expansion coefficient
[Sp_Units]	Units used for static pressure data
[SpAlarmHigh_Units]	Units used for SP high alarm data
[SpAlarmLow_Units]	Units used for SP low alarm data
[SpCalibrateHigh_Units]	Units used for SP high calibrate data
[SpCalibrateLow_Units]	Units used for SP low calibrate data
[SpTransducerRangeHigh_Units]	Units used for SP high transducer range data
[SpTransducerRangeLow_Units]	Units used for SP low transducer range data
[Temp_Units]	Units used for temperature data
[TempAlarmHigh_Units]	Units used for high temperature alarm data
[TempAlarmLow_Units]	Units used for low temperature alarm data
[TempCalibrateHigh_Units]	Units used for high temperature calibration data
[TempCalibrateLow_Units]	Units used for low temperature calibration data
[TempCalibrateZero_Units]	Units used for zero temperature calibration data
[TempTransducerRangeHigh_Units]	Units used for high temperature transducer range data
[TempTransducerRangeLow_Units]	Units used for low temperature transducer range data
[UncorrectedVolume_Units]	Units used for uncorrected volume data
[Viscosity_Units]	Units used for viscosity data
[Volume_Units]	Units used for volume data
[Methane_Units]	Units used for Methane (C1) data
[Ethane_Units]	Units used for Ethane (C2) data
[Propane_Units]	Units used for Propane (C3) data
[n-Butane_Units]	Units used for n-Butane (C4) data
[Isobutane_Units]	Units used for Isobutane (isoC4) data
[n-Pentane_Units]	Units used for n-Pentane (C5) data
[Isopentane_Units]	Units used for Isopentane (isoC5) data
[Neopentane_Units]	Units used for Neopentane (neoC5) data
[n-Hexane_Units]	Units used for n-Hexane (C6) data
[n-Heptane_Units]	Units used for n-Heptane (C7) data
[n-Octane_Units]	Units used for n-Octane (C8) data
[n-Nonane_Units]	Units used for n-Nonane (C9) data
[n-Decane_Units]	Units used for n-Decane (C10) data
[Nitrogen_Units]	Units used for Nitrogen (N2) data
[CarbonDioxide_Units]	Units used for Carbon dioxide (CO2) data
[Water_Units]	Units used for Water (H2O) data
[HydrogenSulfide_Units]	Units used for Hydrogen sulfide (H2S) data
[Hydrogen_Units]	Units used for Hydrogen (H2) data
[CarbonMonoxide_Units]	Units used for Carbon monoxide (CO) data
[Oxygen_Units]	Units used for Oxygen (O2) data
[Helium_Units]	Units used for Helium (He) data
[Argon_Units]	Units used for Argon (Ar) data

Device Total QTR Report: Data Table Tokens

Device Total QTR report data tables, which appear between #SubSection# DataTable (1 or 2) and #End#, can be described by the following tokens.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	Row number of the first row in the data table
[RowNumber]	Current row number
[Acceptability]	Numerical percentage value indicating the relative validity of the data
[AlarmCollectionStatus]	Data state of alarm records
[CurrentDeviceCount]	Index of the device being displayed
[DataQualityDesc]	Description of the data quality setting
[DataQualityName]	Name of the data quality setting
[DataSource]	Source of data for the record, e.g. polling engine, device import, other
[Dp]	Differential pressure
[EditState]	Edit state of the record. Possible values are as follows. Open Closed PPA Mixed
[Energy]	Energy value
[Energy_Average_FW]	Energy value: flow-weighted average See Displaying Flow-Weighted Average Values for a Record for more information.
[ExceptionCount]	Total number of exceptions for the record
[GasQualitySource]	Source of gas quality data for the record
[GMCollectionStatus]	Data state of gas metering records
[GQCollectionStatus]	Data state of gas quality records
[EventCollectionStatus]	Data state of event records
[FlowRate]	Flow rate
[FlowTime]	Flow time
[FlowTimePercent]	Flow time percentage
[LinearCurveType]	Linear curve type
[IMV]	Integral Multiplier Value
[IV]	Integral Value Definition Defines the calculation variables used, where applicable
[IsEdited]	User-edited status of the data. Possible values are as follows. Yes (all data user-edited) No (all data not user-edited) Mixed (a combination of "user-edited" and/or "not user-edited" and/or "not requested" data) Note: Time spans with partial data (for example the current day) will be Mixed status, even if all available values have been edited. This occurs because the status for any data that has not yet been returned is "not requested" and that status is included in the evaluation of the resultant token value. The result therefore is a value of Mixed. A specific time span will only report Yes if all records, available or not, are "user-edited" status.
[LinkExceptionCount]	Number of linked exceptions for the record
[Mass]	Mass value
[Mass_Average_FW]	Mass value: flow-weighted average See Displaying Flow-Weighted Average Values for a Record for more information.
[NodeContractHour]	Contract hour of the Node
[NodeDaysOfData]	Number of days for which the data source of the Node will retain data
[NodeDesc]	Node description
[NodeId]	Node ID
[NodeInstallDateTime]	Install date/time for the Node, in Device time (D)
[NodeName]	Node name
[NodePollingFacilityId]	Polling facility ID of the Node
[NodePollingFacilityTag]	Polling facility tag of the Node
[NodePollingSiteService]	Polling Site.Service of the Node
[NodeReportingFacilityId]	Reporting facility ID of the Node
[NodeReportingSiteService]	Reporting Site.Service of the Node
[NodeSecurityApp]	Security application of the Node
[NodeSortPriority]	Sort priority of the Node
[NodeTimezone]	Time zone configured for the Node
[NodeTimezoneUsingDst]	Daylight saving time status of the Node
[NodeType]	Node type
[OpenExceptionCount]	Number of open exceptions for the record
[PollingFac_Attr0] - [PollingFac_Attr39]	Polling facility indexed text attributes 0 through 39 (each a separate token)
[PollingFac_Category]	Polling facility category
[PollingFac_Comment]	Polling facility comment attribute
[PollingFac_Desc]	Polling facility description
[PollingFac_Info0]	Polling facility info attribute 0 Default attribute name is Facility Location
[PollingFac_Info1]	Polling facility info attribute 1 Default attribute name is Facility Contact
[PollingFac_IsActive]	Polling facility active flag
[PollingFac_Table0] - [PollingFac_Table59]	Polling facility indexed table-driven attributes 0 through 59 (each a separate token)
[PollingFac_Type]	Polling facility type
[PollingFac_YesNo0] - [PollingFac_YesNo19]	Polling facility indexed Yes/No attributes 0 through 19 (each a separate token)
[PulseCount]	Pulse count
[RecordsInSpan]	Number of gas device summary records for the time span
[RecordSpan]	Time span of the record, in number of minutes
[Sp]	Static pressure
[Temp]	Temperature
[UncorrectedVolume]	Uncorrected volume
[VCF]	Volume Correction Factor See Data Aggregation for more information about how this factor is averaged.
[Volume]	Volume value
[Volume_Average_FW]	Volume value: flow-weighted average See Displaying Flow-Weighted Average Values for a Record for more information.
[CustomGM1]	Custom-defined GM process variables See Remote Devices for your device type and EFM Data Items for more information.
[CustomGM2]
[CustomGM3]
[CustomGM4]
[CustomGM5]
Configuration Item Tokens Note: You can append _Begin or _End to any of the following configuration item tokens, in order to display the first or last value for the record. See Displaying Beginning or Ending Values for a Record for more information.
[ConfigExceptionCnt]	Number of configuration exceptions for the record
[ConfigLogDateTime]	Date/time of the configuration log
[ConfigLogSource]	Source of the configuration log See Configuration Source for more information.
[AGA3ExpandedRange]	See FMS Configuration Data Items for descriptions of these items.
[AGA8ExpandedRange] See AGA 8 Data Ranges for more information.
[AtmosphericPressure]
[BaseCompressibilityOfAir]
[BasePressure]
[BaseTemperature]
[CalibrationFactor]
[ConeCoefficientThermalExpansion]
[ConeDiameter]
[ConeMaterial]
[ConeRefTemp]
[ContractHour]
[CoriolisCalibrationPressure]
[CoriolisPressureEffect]
[DeviceDesc]
[DeviceName]
[DeviceType] [DeviceType_Begin] [DeviceType_End] Note: This token can be inserted in an Excel formula that uses the device type value returned to determine whether pressure or pulse data will be shown in the data table, and displays the corresponding label in the column header.
[DischargeCoefficient]
[DischargeCoefficientCalc]
[DpAlarmHigh]
[DpAlarmLow]
[DpBackflowAlarm]
[DpCalibrateHigh]
[DpCalibrateLow]
[DpTapsType]
[DpTransducerRangeHigh]
[DpTransducerRangeLow]
[Elevation]
[FixedTemp]
[FlowRateAlarmHigh]
[FlowRateAlarmLow]
[FluidType]
[FpvCalc]
[GasExpansionFactorCalc]
[HvCalc]
[IntegralValueVariables]
[IsentropicExponent]
[KFactorMass]
[KFactorVolume]
[LowFlowCutoffDp]
[LowFlowCutoffFlowRate]
[LowFlowCutoffMass]
[LowFlowCutoffPulseInterval]
[MeterFactor]
[MeterTubeInsideDiameter]
[MeterTubeMaterial]
[MeterTubeRefTemp]
[OrificeCoefficientThermalExpansion]
[OrificePlateBoreSize]
[OrificePlateMaterial]
[OrificePlateRefTemp]
[PipeCoefficientThermalExpansion]
[PrimaryCalc]
[SpAlarmHigh]
[SpAlarmLow]
[SpCalibrateHigh]
[SpCalibrateLow]
[SpTapLocation]
[SpTransducerRangeHigh]
[SpTransducerRangeLow]
[SpType]
[TempAlarmHigh]
[TempAlarmLow]
[TempCalibrateHigh]
[TempCalibrateLow]
[TempCalibrateZero]
[TempTransducerRangeHigh]
[TempTransducerRangeLow]
[UseCoriolisPressureEffect]
[UseLiveTemp]
[WaterVaporCorrectionFactor]
[WellStreamFactor]
[CustomConfig1] [CustomConfig1_Begin] [CustomConfig1_End]	Custom-defined FMS Configuration Data Items See Displaying Beginning or Ending Values for a Record for more information about value variants. See Remote Devices for your device type and FMS Configuration Data Items for more information.
[CustomConfig2] [CustomConfig2_Begin] [CustomConfig2_End]
[CustomConfig3] [CustomConfig3_Begin] [CustomConfig3_End]
[CustomConfig4] [CustomConfig4_Begin] [CustomConfig4_End]
[CustomConfig5] [CustomConfig5_Begin] [CustomConfig5_End]
[CustomConfig6] [CustomConfig6_Begin] [CustomConfig6_End]
[CustomConfig7] [CustomConfig7_Begin] [CustomConfig7_End]
[CustomConfig8] [CustomConfig8_Begin] [CustomConfig8_End]
[CustomConfig9] [CustomConfig9_Begin] [CustomConfig9_End]
[CustomConfig10] [CustomConfig10_Begin] [CustomConfig10_End]
Gas Quality Item Tokens Note: You can append _Begin or _End to any of the following gas quality item tokens, in order to display the first or last value for the record. See Displaying Beginning or Ending Values for a Record for more information.
[Methane]	Methane (C1)
[Ethane]	Ethane (C2)
[Propane]	Propane (C3)
[n-Butane]	n-Butane (C4)
[Isobutane]	Isobutane (isoC4)
[n-Pentane]	n-Pentane (C5)
[Isopentane]	Isopentane (isoC5)
[Neopentane]	Neopentane (neoC5)
[n-Hexane]	n-Hexane (C6)
[n-Heptane]	n-Heptane (C7)
[n-Octane]	n-Octane (C8)
[n-Nonane]	n-Nonane (C9)
[n-Decane]	n-Decane (C10)
[Nitrogen]	Nitrogen (N2)
[CarbonDioxide]	Carbon dioxide (CO2)
[Water]	Water (H2O)
[HydrogenSulfide]	Hydrogen sulfide (H2S)
[Hydrogen]	Hydrogen (H2)
[CarbonMonoxide]	Carbon monoxide (CO)
[Oxygen]	Oxygen (O2)
[Helium]	Helium (He)
[Argon]	Argon (Ar)
[HeatingValueVolume]	Heating value volume
[HeatingValueMass]	Heating value mass
[HeatingValueBasis]	Heating value basis to use
[RelativeDensity]	Relative density
[Compressibility]	Compressibility
[DewPoint]	Dew point
[Viscosity]	Viscosity
[CustomGQ1] [CustomGQ1_Begin] [CustomGQ1_End]	Custom-defined GQ process variables See Displaying Beginning or Ending Values for a Record for more information about value variants. See Remote Devices for your device type and EFM Data Items for more information.
[CustomGQ2] [CustomGQ2_Begin] [CustomGQ2_End]
[CustomGQ3] [CustomGQ3_Begin] [CustomGQ3_End]
[CustomGQ4] [CustomGQ4_Begin] [CustomGQ4_End]
[CustomGQ5] [CustomGQ5_Begin] [CustomGQ5_End]

Device Total QTR Report: Report Totals Footer Tokens

Device Total QTR report totals footers, which appear between #SubSection# ReportTotalsFooter and #End#, can be described by the following tokens.

Token	Description
[FirstRow]	Row number of the first row in the data table
[LastRow]	Row number of the last row in the data table

Device Total QTR Report: Report Footer

Device Total QTR report footers, which appear between #SubSection# ReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.