Back to Top

Configure utility services

In this topic

  1. Configure printing
  2. Configure GeoEnrichment
  3. Geocoding
  4. Configure directions and routing

Members of the default administrator role and those in custom roles with the appropriate privileges can configure the website to use different utility services to perform printing, geocoding, and routing tasks.

To configure utility services, complete the following steps:

  1. Verify that you are signed in as a member of the default administrator role or a custom role with administrative privileges to manage utility services.
  2. At the top of the site, click Organization and click the Settings tab.
  3. Click Utility services.
  4. Configure any of the following utility services:
    • Printing
    • GeoEnrichment
    • Geocoding
    • Directions and Routing
Tip:

To reset the configured service back to the default service, delete the URL and click Save. When you refresh the page, the utility service reverts to the default URL.

Configure printing

A print service is used to print and preview maps from the Print button in Map Viewer and Map Viewer Classic, and from print widgets in apps created using ArcGIS apps, such as Web AppBuilder and Instant Apps. Apps use the print service in their print widgets to create printable documents with the layouts available in that print service. Print layout templates from the service are accessible through the Print button in Map Viewer and Map Viewer Classic to anyone inside or outside your organization who can access your organization's map viewers. The layouts are based on what's provided in the organization's print service and include any dynamic text placed on the layout. Administrators can create, update, and delete the layout templates for a more customized experience.

Configure a print service

You can use print services from currently supported releases of ArcGIS Server. Asynchronous print services are not supported. If your external print service is secure, you need to first create a secure service item in ArcGIS Online that stores the credentials required to access the print service. You can then configure the service URL provided by the secure service item as a custom print service. Print services can be internal or external. Internal print services only work for printing when Map Viewer, Map Viewer Classic, or apps have access to the internal print service. To print layers secured with web-tier authentication, you must use a custom print service configured to handle web-tier authentication.

  1. Access the utility service settings page.
  2. In the Printing section, provide the URL of the synchronous print service, for example, https://webadaptorhost.domain.com/webadaptorname/rest/services/Utilities/PrintTools/GPServer/Export%20Web%20Map%20Task and click Save.

    You must specify the Export Web Map Task REST URL of the print service. Asynchronous print services are not supported.

    After validating the REST URL you provided, the initial layout templates are available through the print service (with the option to print the legend if it is available). If your organization has more than one print layout, the Print button in Map Viewer Classic and Map Viewer provide a list of the print layouts. You can create, edit, or delete templates to have a more customized experience for printing maps in Map Viewer and Map Viewer Classic. These changes are saved as a setting in your organization; they are not saved to the print service.

  3. Manage the layout templates in the following ways:
    • To create a new layout, click Create Print Template and provide a name up to 50 characters in length and a description up to 120 characters in length. The characters < and > are filtered out. Choose the format—Image (PNG32) or PDF—and a layout (provided by the print service), and check the box to print the legend if the service includes a legend. Click Create and click Save to save the new layout.
    • To view information about a template, click the information button Information next to the template.
    • To edit an existing template, click the edit button Edit next to the template and make your updates. Click Update to review your changes and click Save.
    • To delete an existing template, click the delete button Delete next to the template.
    • To update the template list to what's currently provided in the print service, click Refresh.
    • If you want the default Map Viewer or Map Viewer Classic print experience, delete all your layout templates and click Save. Map Only appears in your template list.

Configure custom print layout templates (beta)

Print layout templates contain page setup information for creating printer-friendly documents for maps in Map Viewer. You can publish custom print layout templates as items to ArcGIS Online and share them with a group. You can then configure the group as the organization's layout template group (beta). All custom print layout templates shared with this group are available as template options when printing in Map Viewer.

You can access custom print layout templates that have been published as items to ArcGIS Online and shared with a layout template group (beta) without configuring a print service.

Note:

Printing from layout items is only available when a template group is configured. Printing from these items will always use the ArcGIS print service, even if you have a custom print service configured. Printing from layout items requires that the services behind the layers in the map are externally available. To print layers secured with web-tier authentication, you must use a custom print service configured to handle web-tier authentication.

Printing from custom layout templates is available to Professional and Professional Plus users. For more information, see User types.

For more information about print layouts, see Layout files in ArcGIS Pro.

To publish a custom print layout template and configure the organization's layout template group (beta), complete the following steps:

  1. Make a layout in ArcGIS Pro and save the layout as a .pagx file.
  2. Sign in to ArcGIS Online and verify that you have the privilege to create content.
  3. Add the file as an item to ArcGIS Online.

    The layout file appears in your content.

  4. At the top of the site, click Groups, and create a group with which to share the layout file or share it with an existing group.

    The layout file is shared with a group and is available for printing in Map Viewer.

  5. Verify that you are signed in as a member of the default administrator role or a custom role with the administrative privilege to manage the organization website.
  6. At the top of the site, click Organization and click the Settings tab.
  7. Click Utility services.
  8. In the Printing section, under Layout template group (Beta), click the Edit button Edit for Layout template group to open the Group drop-down menu and choose your group.
    Note:

    To make custom layout templates available to all organization members in Map Viewer, the layout template group must be viewable by all organization members, and the template items must be shared with both the group and the organization.

  9. To change how the templates are sorted in the Template drop-down menu in Map Viewer, select a field in the Sort order menu, and to change how the templates are ordered, choose Ascending or Descending.

All custom layout templates shared with the group are available in the Template section of the Print pane when printing a map layout in Map Viewer. You must be signed in to your organization to access these items.

Configure GeoEnrichment

GeoEnrichment services provide the ability to get facts about a location or area. The content being served by the custom GeoEnrichment service can include ArcGIS Business Analyst Enterprise data or a custom dataset published to a federated server in an ArcGIS Enterprise deployment.

To use a custom GeoEnrichment service that is secured, you must add the service as an item in your organization to store the ArcGIS Enterprise credentials necessary to access the service. GeoEnrichment services from federated ArcGIS Server 10.7 sites and later are supported.

  1. Sign in to your organization as a member of the default administrator role or a custom administrative role that has privileges to create content and administer utility services.
  2. Follow the steps to add an item from a URL to create a layer item for the GeoEnrichment service, providing the following information:
    1. Choose ArcGIS Server web service for the item type.
    2. Provide the URL to the custom GeoEnrichment service in the URL field.

      For example, type https://gisserver.domain.com/arcgis/rest/services/World/GeoEnrichmentServer in the URL field.

    3. Because the service is secured, provide and store credentials with the item to allow everyone who uses the GeoEnrichment service to access the service using the account you provide.

      If you do not store credentials with the item, GeoEnrichment functionality may be limited.

    When you finish adding the GeoEnrichment service from a URL, the new item's page appears.

  3. Share the item with your organization.
  4. Select the URL on the Overview tab of the GeoEnrichment service's item page and click Copy.
  5. Use the GeoEnrichment item to configure the GeoEnrichment utility service.
    1. Click Organization > Settings > Utility services.
    2. Click the edit button under GeoEnrichment and paste the URL.
    3. Click Save.

Geocoding

A locator is used to search for and locate addresses and places on a map. ArcGIS Online is configured to use the ArcGIS Geocoding service, which allows you to find and map a specified address or place-name (geosearch). For members with the appropriate privileges, the ArcGIS Geocoding service can also be used to geocode a large number of addresses at once (batch geocoding), such as when you publish a hosted feature layer from a .csv file that contains addresses.

You can specify locators that members of your organization can access. You can add a locator by referencing the URL of your locator or use an existing locator view or locator (geocode service) in your organization.

Note:
  • If you specify one or more locator views along with the ArcGIS Geocoding service, users may encounter multiple matching suggestions when searching for locations. To ensure an optimal publishing and geosearch experience, configure batch geocoding and geosearch as appropriate when configuring locators for your organization.
  • Using the ArcGIS Geocoding service or views of this locator for batch geocoding (including publishing .csv or Excel files as hosted feature layers) consumes credits. Using locators for geosearch does not consume credits.

Learn more about the requirements for configuring custom locators

Add a locator

To add a locator, complete the following steps:

  1. Access the utility service settings page.
  2. In the Geocoding section, click Add locator and do one of the following:
    • Select From URL and provide the URL to the locator—for example, https://webadaptorhost.domain.com/webadaptorname/rest/services/World/GeocodeServer.
    • Select From Existing Locator and select the locator item. This option does not appear if there is no locator item in your organization's content, and only locators shared with your organization or with the public are available for selection.
      Note:

      Anonymous users only have access to locator views that are shared with the public. Locator views that are shared with the organization are only accessible to organization members. Anonymous users cannot perform geosearch in any apps using locators that are only shared with the organization.

  3. For Locator Name, provide the name you want to appear in the drop-down menu of locators on the site (for example, in Map Viewer).
    Tip:

    Provide a descriptive name for the locator—for example, Restaurant Locator.

  4. For Placeholder Text, provide a hint that will appear in the input box on the site.
    Tip:

    Make the hint as clear as possible—for example, Enter a restaurant name.

  5. Optionally check the appropriate boxes to allow geosearch and batch geocoding, and click OK.
  6. Repeat the process to add more locators.
  7. Manage the locators in the following ways:
    • To edit an existing locator, click the More options button More options next to the locator and click Edit. Make your updates and click Save.
    • To delete an existing locator, click the More options button More options next to the locator and click Delete.
    • To reorder how the locators appear in the geosearch drop-down menu on the site, drag the locator up or down to the correct position.
Tip:

If your organization needs to delete a locator item in the future, you must remove it from the list before deleting the item.

Configure directions and routing

A route service is used to get directions in Map Viewer and Map Viewer Classic. Route services from ArcGIS Server 10.0 and later are supported. Secure internal route services are not supported. Organizations can also configure travel modes to model the mode of transportation used by apps consuming the route service. Travel modes define how a pedestrian, car, truck, or other medium of transportation moves through the streets. A travel mode can be general—for example, to model typical trucks—or more specific, such as to model ladder trucks or rescue trucks.

  1. Access the utility service settings page.
  2. In the Directions and Routing section, under Route service, provide the URL of the route service, for example, https://gisserver.domain.com/arcgis/rest/services/World/Route/NAServer/Route_World.
  3. To configure travel modes to use with the route service, under Travel modes, click Create travel mode, and configure the various travel options.

    See Travel modes for complete details on how to configure travel modes.

Feedback on this topic?

In this topic
  1. Configure printing
  2. Configure GeoEnrichment
  3. Geocoding
  4. Configure directions and routing