Help

Configuring the Roadway Characteristics Editor web application

Several properties can be configured in the Roadway Characteristics Editor web application. Open the config.json file in the RoadwayCharacteristicsEditor web folder on the web server to modify and deploy.

Configuring the Roadway Characteristics Editor web application is one of the steps (step 8 of 9) of the Roadway Characteristics Editor deployment process. Ensure that all steps before this are completed before continuing with configuring the Roadway Characteristics Editor web application.

Roadway Characteristics Editor configuration properties

PropertiesDescription

webmap

Specifies the unique ID or URL to an authored web map hosted on 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 looks like 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",

If the web map is hosted on a server, the URL looks similar to the following: http://<HostName>/RoadwayCharacteristics/rwc.json, where rwc.json is the text file that contains the web map definition.

"webmap": "http://<Host Name>/RoadwayCharacteristics/rwc.json",

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.

banner

Specifies the banner label text, and label color and banner color. Below is the format for the banner label.

<Specified banner text here> - Esri Roads and Highways v<version>
  • label—Banner label text. Only the prefix of the banner label can be changed. The default value is Roadway Characteristics Editor.
  • labelColor—Banner label color. The default color is e8e8e8.
  • backgroundColor—Banner color. The default color is 2f2f2f.

"banner": {
        "label": "My Roadway Characteristics Editor",
        "labelColor": "#e8e8e8",
        "backgroundColor": "#2f2f22"
    }

The color is specified as #RRGGBB in HTML hexadecimal color codes.

proxyUrl

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

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

qcChecks

  • recordsPerPage

Specifies a setting for the Check Events widget.

recordsPerPage—Specifies the number of records per page within the results table for the Check Events widget.

versioning

  • visible

Specifies if the Reconcile & Post widget is visible to the user.

"versioning": {
        "visible": true
    }

dataReviewer

  • serviceUrl
  • executeBatchJobUrl
  • productionWorkspace
  • batchJobWaitTime
  • recordsPerPage

Specifies the setting for ArcGIS Data Reviewer capability in the RCE. For more information, see Integrating Data Reviewer for Server. These are optional configuration settings if Data Reviewer integration is required.

  • serviceUrl—Data Reviewer map service URL.
  • executeBatchJobUrl—Data Reviewer geoprocessing service URL.
  • productionWorkspace— File path pointing to an sde connection file to the data in the LRS that the server machine can access.
  • batchJobWaitTime—Specifies the amount of time, in milliseconds, to wait before time-out for batch job requests.
  • recordsPerPage—Specifies the number of records per page within the results table for the Reviewer Table widget.

"dataReviewer": {
    	"serviceUrl": "http://<server name>:6080/arcgis/rest/services/reviewer/MapServer",
    	"executeBatchJobUrl": "http://<server name>:6080/arcgis/rest/services/ExecuteBatchJob/GPServer",
     "batchJobWaitTime": 60,
    	"recordsPerPage": 25
}

Advanced propertiesDescription

security

  • enabled
  • tokenServer
  • tokenExpiration

Esri Roads and Highways for Server supports secure login via the ArcGIS Server Security configuration on the published map service with linear referencing capability. This security is provided via the token service. These are optional configuration settings.

  • enabled—Specifies whether token authentication is enabled for the web application.
  • tokenServer—Specifies the host name of the server that has the ArcGIS token service. If enabled is set to false, this property is ignored.
  • tokenExpiration—Specifies the duration that a token is valid, in minutes. 

"security": {
        "enabled": false,
        "tokenServer": "http://roadsandhighwayssample.esri.com/arcgis",
        "tokenExpiration": 30
    },

addData

  • cad
    • uploaderUrl
    • gpServiceUrl

Specifies the URL for the Add Data tools. See more in Adding DGN and DWG data: Deployment guide. These are optional configuration settings if the Add Data tools are not intended to be used.

  • uploaderUrl—Specifies the relative URL to the upload proxy file.
  • gpServiceUrl—Geoprocessing service URL that you have published for uploading DWG or DGN files. 

"addData": {
        "cad": {
            "uploaderUrl": "proxy/upload.ashx",
            "gpServiceUrl": "http://yourserver/arcgis/rest/services/ConvertCADToFeatureDataset/GPServer/Convert CAD to Feature Dataset"
        }
    }

uploader

  • maxUploadBytes
  • serverTimeout

Specifies the limit for the file upload operation. It is used by the Add Data tools. These are optional configuration settings if the Add Data tools are used.

  • maxUploadBytes—Specifies the maximum size, in bytes, for the file to be uploaded using the RCE. This size should be in sync with your web server's file upload limit.
  • serverTimeout—Specifies the amount of time, in milliseconds, to wait before time-out for an upload request.

"uploader": {
        "maxUploadBytes": 10485760,
        "serverTimeout": 10000
    }

excludeFields

Specifies a list of fields to be excluded from Identify, Measure Identify, Select Events by Attributes, and Advanced Route Find search results.

"excludeFields": [ "shape", "shape.len", "shape_len", "shape_length", "st_length(shape)", "shape.stlength()", "shape_area"],

search

  • recordsPerPage
  • geocoder
    • url
    • displayFieldName
    • resultFieldNames
    • useCurrentToken
    • token

Specifies the setting for find/search capability in the RCE.

  • recordsPerPage—Specifies the number of records per page within the results table for Find Route and Find Addresses.
  • geocoder—Specifies the single-line geocoder service you want to use for Find Addresses. These are optional configuration settings.

"search": {
        "recordsPerPage": 10,
        "geocoder": {
            "url": "http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer",
            "displayFieldName": "Match_addr",
            "resultFieldNames": ["Addr_type", "Score"],
            "useCurrentToken": false,
            "token": ""
        }
    }

selectEventsByAttribute

  • maxUniqueRecordCount

Specifies the setting for the Select by Attributes widget.

excludeFields—Specifies the list of fields to exclude from the Selecting events by attribute widget. Administrators can choose to exclude certain fields that are not intended to be edited.

maxUniqueRecordCount—Specifies the maximum number of unique values for the Get Unique Values tool.

"selectEventsByAttribute": {
        "maxUniqueRecordCount": 1000
    }

eventAttributes

  • recordsPerPage
  • errorCellColor
  • editedCellColor
  • nonEditableCellColor

Specifies the settings anywhere the RCE allows users to edit the cell, such as with the Event Attributes, Attribute Set, Split Events, and Merge Events widgets.

  • recordsPerPage—Specifies the number of records per page within the results table.
  • errorCellColor—Specifies the background color of a cell that has failed data validation as you edit.
  • editedCellColor—Specifies the background color of a cell that has been edited.
  • nonEditableCellColor—Specifies the background color of a noneditable cell within the table.

"eventAttributes": {
        "recordsPerPage": 10,
        "errorCellColor": "#ff9999",
        "editedCellColor": "#ffff99",
        "nonEditableCellColor": "#eeeeee"
    },
RCE results grid

selectionSymbols

Specifies the style, color, width, size, and outline of all feature selections made on the map.

"selectionSymbols": {
        "line": { "style": "solid", "color": "#00ffff", "width": 3 },
        "point": { "style": "diamond", "color": "#00ffff", "size": 12, "outline": { "style": "solid", "color": "#008080", "width": 2 } },
        "fromMeasure": { "style": "cross", "color": "#008000", "size": 14, "outline": { "style": "solid", "color": "#00c000", "width": 3 } },
        "toMeasure": { "style": "x", "color": "#ff0000", "size": 12, "outline": { "style": "solid", "color": "#ff0000", "width": 3 } }
    }

Types of line symbols include solid, dash, dot, dashdot, and dashdotdot.

Types of point symbols include circle, square, x, cross, and diamond.

The color is specified as #RRGGBB in HTML hexadecimal color codes.

snapSymbol

Specifies the style, color, width, size, and outline of the point symbol during snapping. 

"snapSymbol": 
{ "style": "cross", "color": "#ff0000", "size": 16, 
"outline": {"style": "solid", "color": "#ff0000", "width": 3}
 },

Types of point symbols include circle, square, x, cross, and diamond.

Types of line symbols include solid, dash, dot, dashdot, and dashdotdot.

The color is specified as #RRGGBB in HTML hexadecimal color codes.

attributeSets

  • folder

Custom attribute sets can be added to the RCE by adding attribute set files to the attributeSets folder located in the Roadway Characteristics Editor folder. Additionally, you can modify the config.json file to use a custom folder created in the Roadway Characteristics Editor folder.

"attributeSets": {
    	"folder": "attributeSets"
    }

folder—Specifies the name of the attribute sets folder.

attributeSetsEditing

  • showEventIDField

Specifies if you want to show an event ID field on the Attribute set configuration dialog box.

"attributeSetEditing": {
        "showEventIDField": false
    },

showEventIDField—Valid values are true and false.

addPointEvents

  • showEventIDField

Specifies if you want to show an event ID field in the Add Point Event widget. 

"addPointEvents": {
        "showEventIDField": false
    },

showEventIDField—Valid values are true and false.

conflictPrevention

  • hideTransferButtons

Specifies if you want to show the transfer lock buttons in the Locks Table widget. Allow Lock Transfer in ALRS properties needs to be enabled to transfer locks. For more information, see Enabling conflict prevention in the ALRS.

"conflictPrevention": {
    	"hideTransferButtons": false
    },

hideTransferButtons—Valid values are true and false.

addLinearEvents

  • retireOverlaps
  • mergeCoincident
  • preventInvalidMeasures

Specifies if you want the Retire overlaps, Merge coincident events, and Prevent measures not on route check boxes checked or unchecked by default in the Add Linear Event widget. 

"addLinearEvents": {
        "retireOverlaps": false
        "mergeCoincident": false
        "preventInvalidMeasures": false
    },

  • retireOverlaps—Valid values are true and false.
  • mergeCoincident—Valid values are true and false.
  • preventInvalidMeasures—Valid values are true and false.

wkidList

  • label
  • wkid

Configure a well-known ID (WKID) to specify the spatial reference of point event coordinates when adding point events by coordinate location. This configuration is optional. 

"wkidList": [
    	{ "label": "GCS_WGS_1984", "wkid": 4326 }
    ]

  • label—Specifies the name of the spatial reference.
  • wkid—Specifies the WKID of the spatial reference.