Overview

The Automated Setup and Reporting tools can be used to summarize data and create reports, publish, configure, and share items to an ArcGIS organization using a Python script and JSON configuration files. These tools can be used to automate the creation of reports and sharing of feature services, maps, web applications, and operational dashboards. This automation of items is useful for organizations as they move from a development to staging to production, for developers to create multiple maps for testing scenarios, and for the creation of multiple maps with slight differences (such as a filter).

Requirements

Automated Setup & Reporting requires specific technical experience and software.

Requirement Description
Experience
  • Modifying JSON files
  • Publishing GIS services
  • Authoring maps
  • Administering groups and organizing content in an ArcGIS organization
Software
Data Publishing
  • ArcMap (Standard or Advanced) 10.2.1, 10.3, 10.4, 10.5
  • Python 2.7.x
  • Windows Task Scheduler
Map authoring
  • ArcMap (Standard or Advanced) 10.2.1, 10.3, 10.4, 10.5
  • Portal for ArcGIS 10.4, 10.5
  • ArcGIS Online
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

What you get

The Automated Setup tools are available with any of the ArcGIS Solutions that use these tools. However, if you would like to configure the tools for your own workflows and data, the Python libraries are available to download from GitHub:

What's new

Below are the release dates and notes for Automated Setup & Reporting.

Date Description
February 2016
Automated Setup
  • Updated to version 3.5.3 of ArcREST
    • Support for Python 2 and 3
    • ArcPy is now optional, but required for certain operations
    • Numerous bugs and improvements
    • New install routine
Solution Report Tools
  • Updated to version 1.2 of Solution Report Tools
  • The ability to specify a final expression for each field.
August 2015
  • Updated to version 3 of ArcREST, which includes support for additional authentication modes
  • Redesign of the ArcRESTHelper routines to streamline functions
July 2015
Solution Report Tools
  • Numerous bug fixes
Automated Setup
  • Numerous bug fixes
  • New security handler that utilizes ArcMap's and ArcCatalog's organization credentials.
May 2015
Solution Report Tools
  • Report libraries moved to a new package and separated from ArcRESTHelper
  • Option to use ArcMap expression for the reclass map
  • New option to update report data instead of overwriting it
  • New data section and preprocessing section to export data from source GDB to file GDB and run preconfigured models to create required report inputs
  • New option to create a merged csv file from all reports
  • Reporting Data, Schema and Report GDB sections moved outside each report to simplify setup.
  • Config file schema changes
    • ReportingAreas and ReportingAreasIDField moved to ReportDetails section
    • PublishData added to PublishingDetails section to allow the user to quickly bypass this entire section
    • EnableEditTracking & Capabilities parameters in FeatureServices has been replaced with the Definition section
    • RunReport added to ReportDetails section to allow the user to quickly bypass this entire section
    • Data added to ReportDetails to centrally define the data layers
    • Data parameter in each report now uses a value from the RunReports Data section instead of path to data
    • CSVOutputLocation added to ReportDetails to allow a merged CSV file result from selected reports
    • ExportDataLocally added to ReportDetails to copy the data from the data section to a local GDB before running the reports
    • TempExportLocation added to ReportDetails. Specify the path to a File GDB when you set ExportDataLocally to True
    • SchemaGDB & ResultsGDB sections added to ReportDetails to remove the redundant list of database in each report
    • ReportResultSchema & ReportResult in each report section list the layer location in the database defined in SchemaGDB and ResultGDB
    • ReportMerge added to each report to append results after each run instead of overwriting output
Automated Setup
  • ArcREST Helper is now included with ArcREST
  • Config file schema changes
    • PublishData added to PublishingDetails section to allow the user to quickly bypass this entire section
    • EnableEditTracking & Capabilities parameters in FeatureServices has been replaced with the Definition section
December 2014
  • Latest versions of the ArcREST and ArcREST Helper tools
  • Config files schema changes
    • FeatureService section to FeatureServices
    • Login info only defined in the GlobalLoginInfo file
    • EnableEditTracking parameter added to FeatureServices section
    • UpdateItemContent changes to UpdateService in MapDetails
    • Portal in login section changed to Orgurl
    • ExistingService change to ExistingServices
    • ExistingServices ReportResult tag changes to FeatureClass
    • ReplaceTag added to section
    • ReplaceInfo Section now uses the following three parameters, SearchString, ReplaceString and ReplaceType
August 2014
  • First release of Automated Setup & Reporting

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 Automated Setup & Reporting

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.

Top