Facility Reports for Gas Gathering

Pipeline operators are required to report on their gas gathering system annually. The Facility Reports for Gas Gathering solution can be used to help summarize information needed for this annual report. In addition to summarizing the report content, the results can be published to your ArcGIS organization as a service, map, and app. The summary report can also be exported out as a CSV file.

The reports include summarizations of Onshore Type A, Onshore Type B, and Offshore pipe by material, installation decade, DOT class, and nominal diameter. Additionally, this solution include summarization reports of eliminated or repaired leaks by cause.


Please review the known issues before configuration of this solution on your data.


Facility Reports for Gas Gathering requires specific technical experience and software.

Requirement Description
  • Modifying JSON files
  • Publishing GIS services
  • Authoring maps
  • Administering groups and organizing content in an ArcGIS organization
Report Generation
  • ArcMap (Standard or Advanced) 10.2.1, 10.3, 10.4
  • Python 2.7.x
Map Service Hosting
  • ArcGIS Online
  • ArcGIS Enterprise (Standard or Advanced) 10.5
  • ArcGIS for Server (Standard or Advanced) 10.3, 10.4
    • Portal for ArcGIS
Application hosting
  • ArcGIS Enterprise 10.5
  • Portal for ArcGIS 10.4
  • ArcGIS Online
  • Basic Viewer (ArcGIS configurable web application template)

What you get

When you download Facility Reports for Gas Gathering, you'll find the following in the zip file:

Directory Item Description
Application A set of Python 2.7 scripts to create and update the required services, maps, and apps in your organization. These scripts utilize the Automated Setup & Reporting tools.
Maps and GDBs GatheringReports.gdb The geodatabase contains the schema for the gathering reports.
NapervilleGas.gdb The geodatabase contains sample gas network and reporting data.
ReportProcessing.tbx The ArcGIS Toolbox containing the report preprocessing tools and models.
GasGatheringReport.mxd The ArcMap document with the report layers designed to be published as a feature service.

What's new

Below are the release dates and notes for Facility Reports for Gas Gathering.

Date Description
June 2016
  • A resolution to an issue in which the pre-processing geoprocessing models did not preserve the Global ID field of input feature classes.
  • The UPDM.gdb has been removed and replaced with the NapervilleGas.gdb.
  • The ReportingArea parameter now uses the P_ServiceArea included with the NapervilleGas.gdb.
February 2016
  • Most recent version of the Automated Setup & Reporting tools. See the release notes for more details.
  • An update to the data query expressions from EXTRACT(YEAR from CURRENT_DATE) to a hard coded date.
  • The most recent Utility and Pipeline Data Model with sample data.
December 2015
  • First release of Facility Reports for Gas Gathering

Known issues

  • This solution uses the Intersect geoprocessing tool. If you have line features in the same layer that overlap (for example, in a 3d view the line would look like a "Z") and using a field other than Shape Length for reporting, the results will be incorrect.
  • If you are using a field other than Shape Length to calculate a report summary and your data is being split by your reporting district, the results will be incorrect as this field is not being adjusted by the percentage that record falls into the reporting zone.
  • The automated setup utilizes ArcREST, which does not support application and enterprise logins.
  • When publishing to Portal for ArcGIS, the Hosting Server must use an ArcGIS Data Store as a managed geodatabase.
  • When publishing to Portal for ArcGIS with an ArcGIS Data Store Hosting Server, field names will be auto converted to lowercase. The tools will update the maps created, but apps are not updated to handle this conversion.
  • The script is delivered using relative paths. To use this without changing to absolute paths, you need to have python.exe as the default file extension for .py files and the path to Python in your systems path variable.

Get started with Facility Reports for Gas Gathering

Solution Report Tools preview release

The next release of the Solution Report tools solves the known issues relating to Intersect and the Shape Length field. A preview of this next release is available on GeoNet.