Batch Report Templates
Batch report templates contain a ReportDefinition page and a ReportSheet page, to access the worksheets that together describe the reports you can produce. CygNet provides a sample report template file BatchTemplate.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.
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.
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
[BatchType] is a valid token. If you use [Type] (not a valid token) instead of [BatchType], the value will be displayed as "[Type]" instead of displaying the batch type value desired, since [Type] is not a valid token.
|
[Type] |
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.
Batch 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 Batch |
|
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 BR Note: Maximum of 7 characters; letters or numbers only, no spaces. |
Batch Report: Worksheet Parameters
Batch 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 Batch |
|
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 - |
|
PageBreakAfterRecord |
The value defined in this cell will be used to specify whether or not to use page breaks in your report. If used, will force a page break after each record. |
Enter a value to indicate whether or not to insert page breaks after each record. Options are Yes or No. Default value is Yes. |
|
PageBreakAfterNode |
The value defined in this cell will be used to specify whether or not to use page breaks in your report. If used, will force a page break after each Node. |
Enter a value to indicate whether or not to insert page breaks after each Node. Options are Yes or No. Default value is Yes. |
|
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.
|
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.
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 Batch Report Definitions (FMS Explorer) or Reports: Batch (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 Batch Report Definitions (FMS Explorer) or Reports: Batch (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 Batch Report Definitions (FMS Explorer) or Reports: Batch (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.
Batch Report: Header Tokens
Batch 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 |
Batch Report: SubReport Header Tokens
Batch report subreport headers, which appear between #SubSection# SubReportHeader and #End#, can be described by the following tokens.
| Token | Description |
|---|---|
| [=] | When used as the first three characters, turns the cell into a formula |
| [RowNumber] | Current row number |
| [CurrentDeviceCount] | Index of the device being displayed |
| [TotalDeviceCount] | Total number of devices in the report |
| [NodeContractHour] | Contract hour of the Node |
| [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 |
| [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 |
| [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) |
Batch Report: Data Table Tokens
Batch report data table parameters, which appear between #SubSection# DataTable 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 |
| [NodeContractHour] | Contract hour of the Node |
| [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 |
| [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 |
| [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) |
| [BatchBeginDateTime] | Beginning date/time of the batch |
| [BatchEndDateTime] | Ending date/time of the batch |
| [BatchName] | Name of the batch |
| [BatchNumber] | Number of the batch |
| [BatchType] | Type of the batch |
| [DataSource] | Source of the data |
| [IsClosed] | Indicates if the batch is closed or not |
| [ProductNumber] | Product number for the batch |
| [ProductName] | Product name for the batch |
| [ReportNumber] | Report number for the batch |
| [SchedulingBatchId] | Scheduled batch ID |
| [SchedulingBatchSize] | Scheduled batch size |
| [SchedulingProductId] | Scheduled product ID |
| [SchedulingShipperId] | Scheduled shipper ID |
| Factor Tokens | |
| [K_Factor] | K factor |
| [MeterFactor] | Meter factor |
| [MFInGSV] | Indicates if the meter factor is included in the batch gross standard volume |
| [SWCorrectionFactor] | Sediment and Water correction factor |
| [DeviceVCF] | Device volume correction factor |
| [CTL] | Temperature correction factor |
| [CPL] | Pressure correction factor |
| [CTPL] | Temperature and Pressure correction factor |
| [CCF] | Combined correction factor |
| [DCF] | Density correction factor |
| Batch Item Tokens | |
| [Density] | Batch density |
| [DensityInAPIDegrees] | Batch density in API degrees |
| [DensityInRelativeDensity] | Batch density in relative density |
| [DensityTemperature] | Batch density temperature |
| [DensityPressure] | Batch density pressure |
| [FlowTime] | Flow time |
| [Pulses] | Pulse count |
| [Pulses_Begin] | Pulse count at the beginning of the batch |
| [Pulses_End] | Pulse count at the end of the batch |
| [EVP] | Equilibrium Vapor Pressure |
| [MeterPressure] | Meter Pressure |
| [MeterTemperature] | Meter Temperature |
| [UncorrectedDensity] | Uncorrected Density |
| [IV] | Indicated Volume |
| [IV_Begin] | Indicated Volume at the beginning of the batch |
| [IV_End] | Indicated Volume at the end of the batch |
| [GV] | Gross Volume |
| [GV_Begin] | Gross Volume at the beginning of the batch |
| [GV_End] | Gross Volume at the end of the batch |
| [GSV] | Gross Standard Volume |
| [GSV_Begin] | Gross Standard Volume at the beginning of the batch |
| [GSV_End] | Gross Standard Volume at the end of the batch |
| [NSV] | Net Standard Volume |
| [NSV_Begin] | Net Standard Volume at the beginning of the batch |
| [NSV_End] | Net Standard Volume at the end of the batch |
| [Mass] | Mass |
| [Mass_Begin] | Mass at the beginning of the batch |
| [Mass_End] | Mass at the end of the batch |
| [SWPercent] | Sediment and Water percentage |
| [SWVolume] | Sediment and Water volume |
| [SWVolume_Begin] | Sediment and Water volume at the beginning of the batch |
| [SWVolume_End] | Sediment and Water volume at the end of the batch |
| Unit Tokens | |
| [Density_Units] | Units used for Density data |
| [DensityTemperature_Units] | Units used for Density Temperature data |
| [DensityPressure_Units] | Units used for Density Pressure data |
| [EVP_Units] | Units used for Equilibrium Vapor Pressure data |
| [FlowTime_Units] | Units used for Flow Time data |
| [MeterPressure_Units] | Units used for Meter Pressure data |
| [MeterTemperature_Units] | Units used for Meter Temperature data |
| [UncorrectedDensity_Units] | Units used for Uncorrected Density data |
| [IV_Units] | Units used for Indicated Volume data |
| [GV_Units] | Units used for Gross Volume data |
| [GSV_Units] | Units used for Gross Standard Volume data |
| [NSV_Units] | Units used for Net Standard Volume data |
| [Mass_Units] | Units used for Mass data |
| [SWVolume_Units] | Units used for Sediment and Water Volume data |
| [SWPercent_Units] | Units used for Sediment and Water Percentage data |
Batch Report: SubReport Footer Tokens
Batch report subreport footers, which appear between #SubSection# SubReportFooter and #End#, can be described by the following tokens.
| Token | Description |
|---|---|
| [=] | 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 |
| [CurrentDeviceCount] | Index of the device being displayed |
| [TotalDeviceCount] | Total number of devices in the report |
| [NodeContractHour] | Contract hour of the Node |
| [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 |
| [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 |
| [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) |
Batch Report: Report Footer
Batch 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.
