Job Report Templates

Job 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, JobTemplate.xlsx, for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.

• Use the JobTemplate.xlsx sample report template file as the basis for a standard job report. The sample shows records displayed in rows by default; you can insert alternative parameters into the ReportDefinition Worksheet to display records in columns if preferred.

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

• ReportParameters
• Worksheet
• CellMapping
• Enum

The ReportSheet sheet includes the sections and fields describing 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: Job for information about the report command.

See Job Report Definition Files for information about the report definition.

Editing Considerations

Job Report templates can be refined and edited after creation to customize the output. When planned changes to a template are structurally significant however, e.g. adding multiple columns, blocks of content, images, etc., it is recommended that you take precautions to reference the correct template in the future.

The following actions are recommended.

• Track the date of the major template change.
• Save the edited template with a new command name to be identifiable.

After the date of the change, reference the correct command name to run reports using the desired report format.

See Managing Report Template Files and Creating and Editing Report Template Files for more information.

Displaying Additional (Non-Token) Elements

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.

Example

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

[Null]

You can insert images into reports, with some guidelines.

• Images on the first page of output are fully supported, and will repeat as entered on subsequent pages.
• Images inserted after initial template use, or on/after the second page of output, may alter the structure of the template. In such cases, this could require additional planning and awareness of editing considerations prior to making the change.

Configuring the ReportDefinition

The ReportDefinition uses parameters to describe the type of report for the service to build and the values that appear in the cells. The following parameters determine the described characteristics of your report.

Job 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 Calibration Job
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 JCALIB Note: Maximum of 7 characters; letters or numbers only, no spaces.

Job Report: Worksheet Parameters

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 Job
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 -
PageBreaks	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 station.	Enter a value to indicate whether or not to insert page breaks. Options are Yes or No. Default value is Yes.
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.
AutoCalibrationDisplayFormat Use to determine behavior when constructing reports that display auto-calibration data records.	The value defined in this cell will be used to specify whether to display auto-calibration values in rows or columns.	Enter one of the following options. JobValuesAsRows JobValuesAsColumns Default value is JobValuesAsRows. This parameter is optional.
AutoCalibrationRangeToHide Use to determine behavior when constructing reports that display auto-calibration data records.	If used, the value range defined in this cell will be used to specify the range of rows/columns in which automatic calibration values are stored.	Enter one of the following options. None [xx-yy] e.g."[24-42]" to specify the beginning and ending rows/columns of the range to contain automatic calibration values, enclosed in brackets Default value is blank (not used). 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 Job Report Definitions (FMS Explorer) or Reports: Job (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 Job Report Definitions (FMS Explorer) or Reports: Job (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.

Job Report: CellMapping Parameters

Cell mapping parameters, which appear between #CellMapping# and #End#, define the FMS enumerations mapped to specific report cell locations on the ReportSheet. Map the FMS Enumeration items to cells where they will appear in the ReportSheet.

Items in the format eFMS_JOB_VALUE_DATA_ITEM are internally defined tokens in the FMS Service. Items in the format {DataItem} are user-defined custom tokens.

For recalculation to succeed, the template ReportSheet must contain at least two discrete instances of at least one of the following FMS Enumeration item pairs:

• eFMS_JOB_VALUE_SP_STD_TEST and eFMS_JOB_VALUE_SP_FOUND

• eFMS_JOB_VALUE_DP_STD_TEST and eFMS_JOB_VALUE_DP_FOUND

• eFMS_JOB_VALUE_TEMP_STD_TEST and eFMS_JOB_VALUE_TEMP_FOUND

The following table lists default mapping values provided in the ReportDefinition sheet of the sample report template file (JobTemplate.xlsx), to illustrate some values that might be used. This is merely a sample; customize your template content to suit your specific business needs. See FMS Dispatch Data Items for more information about valid FMS data items used for CygNet Dispatch.

Sample Job Report Template Cell Mapping Values

Cell	CellName	FMSEnum (FMS Data Item Enumeration)	EnumInstance	Units	Required	Load Previous	Publisher Token
C2	MeterName	eFMS_JOB_METER_NAME	1	N/A	No	Yes	N/A
C3	MeterDesc	eFMS_JOB_METER_DESC	1	N/A	No	Yes	N/A
H2	JobStartDate	eFMS_JOB_START_DATE	1	N/A	No	No	N/A
H3	JobStartTime	eFMS_JOB_START_TIME	1	N/A	No	No	N/A
K2	Field	{Field}	1	N/A	No	Yes	N/A
C4	APINumber	{API}	1	N/A	No	Yes	N/A
E4	FedID	{FedID}	1	N/A	No	Yes	N/A
J4	CompanyName	{CompanyName}	1	N/A	No	Yes	N/A
C7	MeterMake	{MeterMake}	1	N/A	No	Yes	N/A
F7	MeterModel	{MeterModel}	1	N/A	No	Yes	N/A
K7	MeterSerial	{MeterSerial}	1	N/A	No	Yes	N/A
B44	JobUserName	eFMS_JOB_LOGGED_IN_USER_NAME	1	N/A	Yes	No	N/A
A27	SPTest1	eFMS_JOB_VALUE_SP_STD_TEST	1	psi	Yes	No	N/A
A28	SPTest2	eFMS_JOB_VALUE_SP_STD_TEST	2	psi	Yes	No	N/A
A29	SPTest3	eFMS_JOB_VALUE_SP_STD_TEST	3	psi	Yes	No	N/A
A30	SPTest4	eFMS_JOB_VALUE_SP_STD_TEST	4	psi	Yes	No	N/A
A31	SPTest5	eFMS_JOB_VALUE_SP_STD_TEST	5	psi	Yes	No	N/A
A32	SPTest6	eFMS_JOB_VALUE_SP_STD_TEST	6	psi	Yes	No	N/A
A33	SPTest7	eFMS_JOB_VALUE_SP_STD_TEST	7	psi	Yes	No	N/A
B27	SPFound1	eFMS_JOB_VALUE_SP_FOUND	1	psi	Yes	No	N/A
B28	SPFound2	eFMS_JOB_VALUE_SP_FOUND	2	psi	Yes	No	N/A
B29	SPFound3	eFMS_JOB_VALUE_SP_FOUND	3	psi	Yes	No	N/A
B30	SPFound4	eFMS_JOB_VALUE_SP_FOUND	4	psi	Yes	No	N/A
B31	SPFound5	eFMS_JOB_VALUE_SP_FOUND	5	psi	Yes	No	N/A
B32	SPFound6	eFMS_JOB_VALUE_SP_FOUND	6	psi	Yes	No	N/A
B33	SPFound7	eFMS_JOB_VALUE_SP_FOUND	7	psi	Yes	No	N/A
D27	SPLeft1	eFMS_JOB_VALUE_SP_LEFT	1	psi	Yes	No	N/A
D28	SPLeft2	eFMS_JOB_VALUE_SP_LEFT	2	psi	Yes	No	N/A
D29	SPLeft3	eFMS_JOB_VALUE_SP_LEFT	3	psi	Yes	No	N/A
D30	SPLeft4	eFMS_JOB_VALUE_SP_LEFT	4	psi	Yes	No	N/A
D31	SPLeft5	eFMS_JOB_VALUE_SP_LEFT	5	psi	Yes	No	N/A
D32	SPLeft6	eFMS_JOB_VALUE_SP_LEFT	6	psi	Yes	No	N/A
D33	SPLeft7	eFMS_JOB_VALUE_SP_LEFT	7	psi	Yes	No	N/A
I27	DPTest1	eFMS_JOB_VALUE_DP_STD_TEST	1	inH2O	Yes	No	N/A
I28	DPTest2	eFMS_JOB_VALUE_DP_STD_TEST	2	inH2O	Yes	No	N/A
I29	DPTest3	eFMS_JOB_VALUE_DP_STD_TEST	3	inH2O	Yes	No	N/A
I30	DPTest4	eFMS_JOB_VALUE_DP_STD_TEST	4	inH2O	Yes	No	N/A
I31	DPTest5	eFMS_JOB_VALUE_DP_STD_TEST	5	inH2O	Yes	No	N/A
I32	DPTest6	eFMS_JOB_VALUE_DP_STD_TEST	6	inH2O	Yes	No	N/A
I33	DPTest7	eFMS_JOB_VALUE_DP_STD_TEST	7	inH2O	Yes	No	N/A
K27	DPFound1	eFMS_JOB_VALUE_DP_FOUND	1	inH2O	Yes	No	N/A
K28	DPFound2	eFMS_JOB_VALUE_DP_FOUND	2	inH2O	Yes	No	N/A
K29	DPFound3	eFMS_JOB_VALUE_DP_FOUND	3	inH2O	Yes	No	N/A
K30	DPFound4	eFMS_JOB_VALUE_DP_FOUND	4	inH2O	Yes	No	N/A
K31	DPFound5	eFMS_JOB_VALUE_DP_FOUND	5	inH2O	Yes	No	N/A
K32	DPFound6	eFMS_JOB_VALUE_DP_FOUND	6	inH2O	Yes	No	N/A
K33	DPFound7	eFMS_JOB_VALUE_DP_FOUND	7	inH2O	Yes	No	N/A
M27	DPLeft1	eFMS_JOB_VALUE_DP_LEFT	1	inH2O	Yes	No	N/A
M28	DPLeft2	eFMS_JOB_VALUE_DP_LEFT	2	inH2O	Yes	No	N/A
M29	DPLeft3	eFMS_JOB_VALUE_DP_LEFT	3	inH2O	Yes	No	N/A
M30	DPLeft4	eFMS_JOB_VALUE_DP_LEFT	4	inH2O	Yes	No	N/A
M31	DPLeft5	eFMS_JOB_VALUE_DP_LEFT	5	inH2O	Yes	No	N/A
M32	DPLeft6	eFMS_JOB_VALUE_DP_LEFT	6	inH2O	Yes	No	N/A
M33	DPLeft7	eFMS_JOB_VALUE_DP_LEFT	7	inH2O	Yes	No	N/A
A38	TempTest1	eFMS_JOB_VALUE_TEMP_STD_TEST	1	F	Yes	No	N/A
A39	TempTest2	eFMS_JOB_VALUE_TEMP_STD_TEST	2	F	Yes	No	N/A
A40	TempTest3	eFMS_JOB_VALUE_TEMP_STD_TEST	3	F	Yes	No	N/A
A41	TempTest4	eFMS_JOB_VALUE_TEMP_STD_TEST	4	F	Yes	No	N/A
A42	TempTest5	eFMS_JOB_VALUE_TEMP_STD_TEST	5	F	Yes	No	N/A
B38	TempFound1	eFMS_JOB_VALUE_TEMP_FOUND	1	F	Yes	No	N/A
B39	TempFound2	eFMS_JOB_VALUE_TEMP_FOUND	2	F	Yes	No	N/A
B40	TempFound3	eFMS_JOB_VALUE_TEMP_FOUND	3	F	Yes	No	N/A
B41	TempFound4	eFMS_JOB_VALUE_TEMP_FOUND	4	F	Yes	No	N/A
B42	TempFound5	eFMS_JOB_VALUE_TEMP_FOUND	5	F	Yes	No	N/A
D38	TempLeft1	eFMS_JOB_VALUE_TEMP_LEFT	1	F	Yes	No	N/A
D39	TempLeft2	eFMS_JOB_VALUE_TEMP_LEFT	2	F	Yes	No	N/A
D40	TempLeft3	eFMS_JOB_VALUE_TEMP_LEFT	3	F	Yes	No	N/A
D41	TempLeft4	eFMS_JOB_VALUE_TEMP_LEFT	4	F	Yes	No	N/A
D42	TempLeft5	eFMS_JOB_VALUE_TEMP_LEFT	5	F	Yes	No	N/A

Job Report: Enum Parameters

Enumeration parameters, which appear between #Enum# and #End#, can be defined as necessary. Select and enter values to appear in the drop-down lists in your .xlsx ReportSheet. Configure the cells to customize the selections to have available for your report.

The following table includes some sample parameter values that you might elect to show as value options in a report.

Parameter	Description
Yes	[various] - Yes
No	[various] - No
Barton Chart	Device make - Barton Chart
ABB EGM	Device make - ABB EGM
Fisher EGM	Device make - Fisher EGM
Bristol EGM	Device make - Bristol EGM
Flange	Tap type - Flange
Pipe	Tap type - Pipe
Up	Tap location - Upstream
Down	Tap location - Downstream
Senior	Orifice fitting type - Senior
Simplex	Orifice fitting type - Simplex
OFU	Orifice fitting type - Orifice Flange Union
Other	Orifice fitting type - Other than listed options

Configuring the ReportSheet

The ReportSheet page of the template contains all sections/fields to describe the formatting and content details for the report type named in the ReportName field of the ReportDefinition page. Configure the cells, sections, and labels to customize the report to your needs. When configuration is complete, save the settings.