Skip To Content

Configuration properties for Roadway Reporter

Several properties can be configured on the ArcGIS Roadway Reporter web app. Open the config.json file in the RoadwayReporter web folder on the web server to modify and set up these properties.

Configuring the Roadway Reporter web app is one of the steps in deploying Roadway Reporter. Ensure that all steps prior to this are completed before continuing with configuring the Roadway Reporter web app.

PropertiesDescription

webmap

Specifies the unique ID or URL to an authored web map hosted on either ArcGIS.com or the web server. After authoring a web map and sharing it publicly, the contents can be accessed directly by a URL.

For example, if the web map is hosted on ArcGIS.com, log in with your Global Account and browse to My Content. Click the title of the web map you are interested in to get more details. At this point, the URL will have the following format: http://www.arcgis.com/home/item.html?id=<webmapID>.

For example, http://www.arcgis.com/home/item.html?id=1dcf369089804329946e3b3abf385251

Ensure the web map is shared with everyone (public).

Copy only the ID portion of the URL as the web map ID value for the configuration.

"webmap": "1dcf369089804329946e3b3abf385251",

geometryServiceUrl

Specifies the URL to a geometry service. By default, the configuration file contains a link to the geometry service hosted on ArcGIS Online, but it can be configured to refer to any geometry service hosted on any other ArcGIS server instance.

proxyUrl

Specifies the relative URL to the proxy page on the web server.

"proxyUrl": "proxy/proxy.ashx",

Security

  • enabled
  • refreshTokenExpiration

ArcGIS Roads and Highways Server supports secure login via portal on the published map service with linear referencing capability. This security is provided using OAuth 2.0. These are optional configuration settings.

enabled—Specifies whether token authentication is enabled for the web app.

Note:

By default, tokenSecurity is disabled. If this setting is disabled, a portal configuration is not required, but you will not be able to save report configurations. This setting should only be disabled to test your deployment of Roadway Reporter.

refreshTokenExpiration—Specifies the duration that a refresh token is valid, in minutes.

portal

  • appID
  • url

In order to secure access to Roadway Reporter, you must first register the web app with either Portal for ArcGIS or ArcGIS Online.

appID—Specifies the application ID after Roadway Reporter has been registered with either Portal for ArcGIS or ArcGIS Online.

url—Specifies the startup URL for your portal or ArcGIS Online configuration.

  • If you are using Portal for ArcGIS, the URL is http://<portal domain>/arcgis
  • If you are using ArcGIS Online, the URL is http://www.arcgis.com

generateReportUrl

Specifies the URL to the generate report geoprocessing service published to your instance of ArcGIS Server. Browse to the ArcGIS REST Services Directory and select the GenerateReport geoprocessing service. Copy the URL for the Generate Report task. The URL will have the following format: http://gisserver.domain.com:6080/rest/services/GenerateReport/GPServer/Generate%20Report.

generateReportWaitTime

The time in seconds you will wait for the generate geoprocessing tool to become available if the max number of instances is already in use. The default value is 60 seconds.

uniqueMileageFieldsLimit

The maximum number of unique values that will be populated when you create mileage fields based on unique values. The default is 20 unique values.

spatialQueryLimit

Specifies the maximum number of routes to display per query. The default value is 6,000 routes. This is an optional configuration setting.

Note:

If the spatialQueryLimit is too high, the routes will not display on the map.

email

  • smtpServer
  • smtpPort
  • smtpSecurity
  • smtpUsername
  • smtpPassword
  • senderEmailAddress

If you set up email credentials, then Roadway Reporter can send an email link to download the report once it's ready.

smtpServer—The valid email server to use

smtpPort—The port on the email server to use (default 25)

smtpSecurity—The email server security type; either SSL or TLS

smtpUsername—The secure valid email server's user name

smtpPassword—The secure valid email server's password

senderEmailAddress—The email address from which email will be sent