GaiaBuilder.ini - merkator-software/GaiaBuilder-manual GitHub Wiki

GaiaBuilder.ini

GaiaBuilder.ini contains the global configuration of your DTAP environment. In this file, the DTAP environments are mapped onto the physical ArcGIS Server and ArcGIS Enterprise servers. This file is used as input to the Python Toolboxes for build automation. A separate configuration for end-users working with the ArcGIS Pro Add-In should be configured as a Hosted Service in your Portal. These configuration should be kept the same

The file contains a FOLDER Section, LOGGING Section, CONFIGSECTIONS Section and one or more DTAP Environments

FOLDER

Configuration of the work directories for GaiaBuilder. The directories are create as a subdirectory on the workdirectory.

  • pubfolder: Contains service definition drafs, service definition files, ArcGIS Pro project files and rewritten ArcGIS Enterprise Content.
  • logfolder: Contains the logfiles

LOGGING

  • logging : True / False , enable or disable logging
  • loglevel : 10 - 50 (DEBUG = 10, INFO = 20, WARNING = 30, ERROR = 40, CRITICAL = 50). Loglevel of GaiaBuilder. Info is advised
  • displaydebugmessages : True / False , Shows the debug messages on the console, but does not write them to the log file

CONFIGSECTIONS

  • arcgissections : Comma separated list of all DTAP Environments. Each key should be present as a config section. Rename the TEMPLATE section to your first environment, e.g.: DEV (Development)

ARCGISSECTIONS

The first ArcGIS Section is [TEMPLATE]. Copy the [TEMPLATE] section to [DEV] and configure the development environment

  • tokenurl: For a Federated ArcGIS Enterprise Environment: the URL token endpoint of your Portal Server, For a Standalone ArcGIS Server: the URL token endpoint of your ArcGIS Server. When the webadapter blocks administrative access or when the webadapter is secured with Web-tier authentication, then this should be on port 6443
  • referer: the admin endpoint of your ArcGIS Server. When the webadapter blocks administrative access or when the webadapter is secured with Web-tier authentication, then this should be on port 6443
  • portalurl: the hostname and webadaptor with trailing slash to your Portal
  • serverurl: the hostname and webadaptor with trailing slash to your ArcGIS Server. When the webadapter blocks administrative access or when the webadapter is secured with Web-tier authentication, then this should be on port 6443
  • federated: true / false , choose true when the ArcGIS Server is Federated with Portal for ArcGIS. Choose false if your ArcGIS Server is a standalone server
  • offline: true / false , choose true when your Portal Webadapter is secured with Web-tier authentication and the Python Toolbox has trouble authenticating on Portal
  • publicurl: the hostname and webadaptor with trailing slash to your ArcGIS Server.
  • agsconnectionfile: the ArcGIS Server connection file (.ags) to this server. Create this file with ArcGIS Pro and save it to the connections subdirectory of the GaiaBuilder toolbox
  • usegeoprocessingservice: true / false , choose true when using the GaiaBuilderToolbox Geoprocessing service on ArcGIS Server. The GaiaBuilderToolbox Geoprocessing must be deployed from ArcGIS Pro
  • publishonserver: true / false , default is true, choose to publish the service definition file using the GaiaBuilderToolbox Geoprocessing service, choose false to publish the service definition file from the build server. The latter requires administrative access to be enabled on the webadaptor and can be used when publishing from the GP Service isn't working
  • force_server: true / false , default is false, this option will initialize the ArcGIS Server object for publishing the mapservice using the serverurl of this Environment and will ignore the ArcGIS Server objects from the GIS. Set this to true when using the GIS server object gives warnings on initializing.
  • jobdir: the jobs directory a geoprocessing service deployed to this ArcGIS Server should use by default
  • outputdir: the output directory a geoprocessing service deployed to this ArcGIS Server should use by default
  • disable_code_import: true / false, prevents the build server and ArcGIS Enterprise from running custom code. This will block publishing Geoprocessing Services
  • toolboxname : the name of the toolbox in ArcGIS Enterprise, default is GaiaBuilderToolbox. This setting can be used to deploy the GaiaBuilder Geoprocessing service to different federated servers in the same ArcGIS Enterprise and is used to resolve the service on a specific server. Rename the GaiaBuilderToolbox in ArcGIS Enterprise accordingly.
  • proxy : http / https proxy server. E.g.: http://10.343.10.22:111
  • arcgis_rest_proxy : http / https proxy server used for requests outside of the ArcGIS API for Python. Only use this setting when a signin succeeds
  • bypassproxy : true / false , default is false. Force ArcGIS API for Python to bypass the system configured web proxy
  • usegentoken : true / false , default is false. Uses generateToken login over OAuth2 login.
  • useitemregistrycache: true / false , default is false. Setting this to true will cache the GaiaBuilder Itemregistry to a pandas dataframe. Use this cache when live querying the Hosted Featureservice has degraded performance
  • acceptcachemiss: true / false , default is false. When set to false, a cache miss will query the GaiaBuilder Itemregistry to check for updates, setting this to true will assume there is no record for the query in both the cache and the hosted featureservice
  • invalidatecache: true / false , default is false. When set to true, an update to the GaiaBuilder Itemregistry will invalidate the cache and reload the cache with the updated data the next time a query is performed on the cache
  • drop_auth: true / false, default is false. When set to true, the requests to ArcGIS Server using the ArcGIS API for Python won't include the session authentication from ArcGIS API for Python. Should be used when requests to ArcGIS Server REST API are performed twice.
  • alt_server_publish: true / false, default is false. When set to true, the Publishing Geoprocessing service is called using a pure REST API implementation instead of ArcGIS API for Python or Arcpy. Use this when latter two don't work.
  • preventremovelayeritemids: true / false, default is false. When set to true, GaiaBuilder will not remove unknow layerids from webmaps
  • asyncserviceedit: true / false, default is false. When set to true GaiaBuilder will submit a async job to edit services, use this setting when editing services takes >60 seconds on your ArcGIS Server

Geoprocessing tool

It is possible to create the ini file from the settings in the GaiaBuilder Environment Registry.

This tool can only be run after you've run Add Environment Tool from GaiaBuilder Content Publishing Toolbox

  1. Select the ArcGIS Enterprise or ArcGIS Online Portal and Sign in to this Portal with Administative Privilege
  2. Open the Geoprocessing Pane
  3. Open the GaiaBuilder Map Publishing Toolbox

images/PublishServertoolbox.png

  1. Open the Create GaiaBuilder.ini from Environmentregistry Tool
  2. Select the location where you want to save the file

images/CreateIniFile.png

  1. Click Run
  2. Not all advanced settings are available via the Environment Registry. Review and adjust the ini file before applying it.