Balance Details 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 BalanceDetailsTemplate.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.
See Reports: Balance Details for information about the report command.
See Balance Details Report Definition Files for information about the report definition.
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_Net] is a valid token. If you use [Vol_Net] (not a valid token) instead of [Volume_Net], the value will be displayed as "[Vol_Net]" instead of displaying the volume value desired, since [Vol_Net] is not a valid token.
|
[Vol_Net] |
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.
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. |
This value is used to specify the report name. Example Balance Details |
|
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. |
This value is used to specify the report command name. Example BALD Note: Maximum of 7 characters; letters or numbers only, no spaces. |
Balance 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 is used to represent the standard FMS report type you are configuring. |
This value is used along with NodeResolutionMethod to indicate the type of report to build. Example Balance |
|
NodeResolutionMethod |
The value defined in this cell is used to represent the method used to resolve which Nodes are shown in the report |
This value is used along with ReportType to indicate the type of report to build. Example Worksheet |
|
RecordSpan |
The value defined in this cell will be used to specify the record span format for the report. |
Enter one of the following options.
This parameter is required. |
|
The value defined in this cell will be used to specify how each Node is identified in your report. |
Enter one of the following options to indicate how to identify the Nodes.
|
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.
Balance Details report headers, which appear above #EndReportHdr#, can be described by the following tokens.
| Token | Description |
|---|---|
| [GeneratedDateTime] | The time the report was generated, in Local time (L) |
| [TotalStationCount] | The total number of station Nodes in the report |
Balance Details report data table headers, which appear between #SubSection# DataTableHeader 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 |
| [NodeName:X] | The name of the station Node, where "X" will represent the specific Node, and is based on the value of the DisplayNode parameter (either Name or Description) |
| Units | |
| [Energy_Units] | The units used for Energy data |
| [Mass_Units] | The units used for Mass data |
| [Volume_Units] | The units used for Volume data |
Note: Energy and Volume data cell values have meaning according to the Node type selected, as follows:
Balance Details report data table parameters, 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 |
| [BeginDateTime] | The start date, in Contract day (C), of the time range for the record |
| [FirstRow] | The row number of the first row in the data table |
| [RowNumber] | The current row number |
| Balance Details Tokens | |
| [Avg_Acceptability] | The numerical percentage value indicating the relative validity of the data |
| [Energy_In:X] | The incoming energy value, where "X" will represent the specific Node |
| [Energy_Out:X] | The outgoing energy value, where "X" will represent the specific Node |
| [Energy_Net] | The net energy gain/loss, where "X" will represent the specific Node |
| [Energy_Change] | The change in energy |
| [Mass_In:X] | The incoming mass value, where "X" will represent the specific Node |
| [Mass_Out:X] | The outgoing mass value, where "X" will represent the specific Node |
| [Mass_Net] | The net mass gain/loss |
| [Mass_Change] | The change in mass |
| [Volume_In:X] | The incoming volume value, where "X" will represent the specific Node |
| [Volume_Out:X] | The outgoing volume value, where "X" will represent the specific Node |
| [Volume_Net] | The net volume gain/loss |
| [Volume_Change] | The change in volume |
Balance Details 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] | The row number of the first row in the data table |
| [LastRow] | The row number of the last row in the data table |
| [BeginDateTime] | The start date, in Contract day (C), of the time range for the record |
| [EndDateTime] | The end date, in Contract day (C), of the time range for the record |
| [GeneratedDateTime] | The time the report was generated, in Local time (L) |
| [TotalStationCount] | The total number of station Nodes in the report |
Balance Details 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.
|
|
|
