Publishing a network utility service

Available with Business Analyst license.

The Publish Routing Services utility allows you to publish directions, routing, and logistics services based on a network dataset to your ArcGIS Server. These services are similar to the routing services available with ArcGIS Online, but are published on-premises based on your own street network dataset.

Once published, the services can be used with Business Analyst Enterprise for creating study areas based on driving and walking times and distances.

License:

To use this utility, your ArcGIS Server site needs to have an ArcGIS Network Analyst extension license.

Data requirements

A street network dataset for the USA is provided for Business Analyst Enterprise users in file geodatabase format (. gdb file). Before using the .gdb file, you must install the Business Analyst data license (. sdlic ), which is emailed at the time of purchase or data update. You can review the license information in ArcGIS Pro to verify that the *. sdlic license file is enabled. Once enabled, the publish routing services utility can be used to publish services from the .gdb file.

If the publisher machine and the GeoEnrichment Server machine are the same (If ArcGIS Pro is installed on the server), you can authorize the data with Pro. If ArcGIS Pro is not installed on the server, you can use the DataLicInstall utility:

1. Open a Windows Command Prompt instance (cmd), as an administrator, on a machine with ArcGIS Server installed.
2. Right click on CMD > run as an administrator.
3. Change directory to the ArcGIS Server Program Files bin directory.

   cd C:\Program Files\ArcGIS\Server\bin

   The command line appears as follows:

   C:\Program Files\ArcGIS\Server\bin>

4. Type in the following:

   DataLicInstall.exe C:\FolderName\<nameOfLicenseFile>.sdlic

5. Press Enter to install the license.
6. After the license file successfully installs, restart the ArcGIS Server Windows service for the changes to take effect.

Note:

All data needed for street address geocoding and network analysis are included with the 2022 US Data for Business Analyst on My Esri.

ArcGIS StreetMap Premium product downloads for Pro and Enterprise may appear in your My Esri list. These files are not needed and should not be downloaded. Please follow the steps for downloading the street data below.

Downloading the street network data

1. On the My Esri site, click My Organizations then click Downloads.
2. Verify that you are in the Products section. In the Quick Search text box, enter Business Analyst or Business.
3. Look for ArcGIS Business Analyst Enterprise with 2022 U.S. Data and ensure the version is 10.9.1. Click View Downloads.

   There will be two downloads for the street data, both will need to be downloaded on a folder to your local drive.

4. Click the Download Components tab then click Data and Content to expand the list of files.
5. Locate #1 ArcGIS Business Analyst Enterprise 2022 Street Data (U.S.A) and click Download.
6. In the Esri Download Manager dialog, click Click to download your file now.
7. Locate #2 ArcGIS Business Analyst Enterprise 2022 Street Data (U.S.A) and click Download.
8. Locate #3 ArcGIS Business Analyst Enterprise 2022 Street Data (U.S.A) and click Download.
9. The Destination Folder for Files dialog will appear. Keep the default location or click Browse to choose a different location.
10. Right click on ArcGIS_BAEnterprise_StreetsData_USA_2022.7z (1).001 and click 7-Zip > Extract Here.

    Note:

    You will only need to extract from the first compressed file (ArcGIS_BAEnterprise_StreetsData_USA_2022.7z (1).001). The extraction process automatically extracts and reassembles Files 001, 002, and 003 to create the full 2022 U.S. data pack. Do not attempt to extract File 002 or 003.

Tip:

While you can keep the network dataset in a shared location that is accessible to all the machines in your GIS server site, it is recommended to copy the network dataset locally, on each machine, for best performance when running the services.

Parameters

The following parameters are available when running the publishroutingservices.bat script:

Parameter	Details
-u	User name for a user with publisher or administrative privileges in the ArcGIS Server site. If the site is federated with a portal, the user must be a portal user and can have administrative privilege or a publisher privilege that allows publishing web tools and publishing server-based layers. If the site is not federated, the user must have administrative privileges. If your site is configured with web-tier authentication, specify a built-in user, such as the primary site administrator account or the initial administrator account in your portal.
-p	The password of the user who was specified with the -u parameter.
-s	The fully qualified domain name of the machine running ArcGIS Server, such as gisserver.domain.com, or the local URL to your ArcGIS Server site in the format https://gisserver.domain.com:6443/arcgis.
-P	The fully qualified domain name of the machine, such as gisportal.domain.com, where Portal, to which your ArcGIS Server site federates with, is installed. The value can also be a local URL to the portal in the format https://gisportal.domain.com:7443/arcgis A value for this option is required only if the ArcGIS Server that will host the routing services is federated with the portal.
-n	The full path to the network dataset. Along with the path to the file geodatabase, the path should also include the name of the network dataset and the name of the feature dataset containing the network dataset. For example, a value for this option can be c:\data\Streets.gdb\Routing\Routing_ND on Windows and /data/Streets.gdb/Routing/Routing_ND on Linux where Streets.gdb is the file geodatabase that has a network dataset named Routing_ND in a feature dataset named Routing.
-o	Path to a folder where the utility will create the service definition files for the services and a log file named publishroutingservices.log that includes the details about the execution as well as any errors that might be encountered.
-h	Prints help for the utility.

Example usage

The ArcGIS Server install includes a script that will help to publish a network service which can be used for routing by the ArcGIS Business Analyst Server service. This script is installed to <ArcGIS Server Install Location>/ArcGIS/Server/Tools/PublishRoutingServices and is named publishroutingservices.bat.

In this example, the streets data copied locally to the C drive. The staging folder for the service definition files is RoutingSDs, it must be created prior to running the utility.

publishroutingservices.bat -s ServerMachine.domain.com -P PortalMachine.domain.com -u PortalAdminUser -p PortalAdminPassword -n "Streets Data\NorthAmerica.gdb\Routing\Routing_ND" -o C:\RoutingSDs

Configuring a network utility services from ArcGIS Online

You have the option to configure your portal to use utility services from ArcGIS Online instead of publishing them to your own server. This has the added benefit of providing street network coverage outside the United States. If you would like to use online network services provided by Esri, you must have an ArcGIS Online organizational account. The account must have credits associated with it and the correct permissions to use the utility services.

The ArcGIS Online network services provide coverage for several countries or areas and can be configured in the portal following the steps below.

1. Sign in to the portal website as a member of the default administrator role in your organization.
2. At the top of the site, click Organization and click the Settings tab.
3. Click ArcGIS Online on the left side of the page.
4. Select Network.
5. Enter the credentials for the ArcGIS Online account that is to be used for the utility services.
6. Click Configure.

Next step

Publishing a geocode utility service