Share a locator

This topic describes how to share a locator as a service to an ArcGIS Enterprise portal, create a locator package, and create a mobile map package. More information about each of these can be found in Introduction to sharing locators.

Share a locator as a hosted service

Once you create a locator, you can share it on your active ArcGIS portal. Sharing a locator as a hosted service in ArcGIS Enterprise is the way you make geocoding always available to everyone in your organization. Internet or intranet users can then use the hosted locator in web apps, ArcGIS Desktop, ArcGIS Online, and other client applications.

Before sharing a locator, there are a few options for managing locator data on the server to consider. If the locator is, or should be, stored on the server in a specific location—for example, if the locator is larger than 1 GB in size—register the folder location as a data store. Using a data store can minimize service downtime when restarting or overwriting a service. If the locator is stored on a local machine, the publishing process copies the locator to the server. See the following topics to learn more about managing locator data:

• Make data accessible to ArcGIS Server
• Copying data when publishing to ArcGIS Server

Note:

You can share a locator to an ArcGIS Enterprise portal, share to ArcGIS Enterprise on Kubernetes, or publish the locator to a stand-alone ArcGIS Server. If the locator is over 1 GB in size, you must share or publish it using a data store, as it may fail to publish. Copy the locator to the folder on the server that will be registered as a data store with the federated server.

• When sharing a locator created with the Create Address Locator tool to the portal, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 10.5 with at least one federated server. However, ArcGIS Enterprise 10.9 will be the last release to support sharing locators to the portal created with the Create Address Locator tool. Re-create locators in ArcGIS Pro 2.3 or later with the Create Locator tool.
• When sharing a locator created with the Create Locator tool to the portal, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 10.6.1 or later with at least one federated server.
• When sharing a locator based on the Parcel role created with the Create Locator tool or a locator created with the Create Feature Locator tool, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 10.8 or later with at least one federated server.
• When sharing a locator created with the Create Locator tool with the Precision Type parameter set to Global Extra High or Local Extra High, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 10.8.1 or later with at least one federated server.
• When sharing a locator based on the Street Address role that supports custom offsets and intersection connectors created with the Create Locator tool in ArcGIS Pro 2.7 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise10.9 or later with at least one federated server to maintain the settings.
• When sharing a locator based on the Point Address role that supports subaddresses created with the Create Locator tool in ArcGIS Pro 2.8 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 10.9 or later with at least one federated server to reverse geocode and return subaddress results.
• When sharing a locator based on the Point Address role that supports subaddresses created with the Create Locator tool in ArcGIS Pro 2.9 or later, and Suggestions for partial subaddresses is enabled, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 10.9.1 or later with at least one federated server to return valid suggestions for partial subaddress input.
• When sharing a locator based on the Point Address role that supports subaddresses created with the Create Locator tool in ArcGIS Pro 3.0 or later, and the Show summary of subaddresses with base address suggestion, Suggest as partial unit is typed, or Suggest when base address is typed properties are enabled, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.0 or later with at least one federated server to return valid suggestions for subaddresses or subaddress summary.
• When sharing a locator based on the Point Address role created with the Create Locator tool in ArcGIS Pro 3.0 or later, and Show suggestions for partial house numbers is enabled, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.0 or later with at least one federated server to return valid suggestions for partial house number input.
• When sharing a locator created with the Create Feature Locator tool that includes custom output fields in ArcGIS Pro 3.2 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.2 or later with at least one federated server to return the custom output fields in the geocode results.
• When sharing a locator that has polygon output fields appended to it using the Add Polygon Fields To Locator tool in ArcGIS Pro 3.2 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.2 or later with at least one federated server to return the polygon output fields in the geocode results.
• When sharing a locator based on z-aware point data that is created with the Create Feature Locator tool or Create Locator tool in ArcGIS Pro 3.2 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.2 or later with at least one federated server to return the z-coordinate in the geocode results.
• When sharing a locator based on the POI role that supports categories created with the Create Locator tool in ArcGIS Pro 3.2 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.2 or later with at least one federated server to use the return collections parameter.
• When sharing a locator based on the Street Address role created with the Create Locator tool in ArcGIS Pro 3.3 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.3 or later with at least one federated server to search for a street between two cross streets.
• When sharing a locator created with the Create Locator tool in ArcGIS Pro 3.3 or later, you must be signed in, with publisher or administrator privileges, to ArcGIS Enterprise 11.3 or later with at least one federated server to return the input location when reverse geocoding.

If you are a member of a custom role in ArcGIS Enterprise 10.6 or later, be sure the administrator has granted you the Publish server-based layers privilege. For details about publishing a locator to a stand-alone ArcGIS Server 10.6 or later, see Publish a geocode service.

1. On the Share tab of the ribbon, in the Share As group, click the Locator drop-down menu and click Share locator .

   Tip:

   Alternatively, in the Catalog pane, expand Locators or folder connection in the Folders category , right-click the locator to share, and choose Share As Locator .

   The Select the Locator to Share dialog box appears.

2. Browse to select the locator to share and click OK.

   The Share Locator pane appears.

3. Fill in the information on the General tab of the Share Locator pane.
   1. Keep or change the name of the locator in the Name text box, which is automatically populated with the name of the locator.
   2. Optionally, add information to the Summary and Tags fields.

      A summary and tags are required when sharing to an ArcGIS Enterprise 10.9 or earlier portal.

      You can enter a maximum of 128 tags.

   3. Under Location, use the Portal Folder menu to choose a folder in your portal content in which to store the locator. Optionally, create a folder.

      By default, the locator is stored at the root level of your portal content.

      Tip:

      Click the Browse button to browse to a folder in your portal content. You can also type a folder name in the text box.

   4. Use the Server and Folder drop-down menus to specify the federated server where the service is published and the folder where it is stored. Optionally, create a folder.

      By default, the service is stored in the root folder of the hosting server.

      Note:

      If the locator is over 1 GB, click the Data Stores button to open the Manage Registered Data Stores pane. Use this pane to register folders with federated servers.

   5. Optionally, define which people in your organization you want to share the locator with by modifying Sharing Option.
4. Optionally, modify the service properties on the Configuration tab of the Share Locator tab.
5. Review the folder structure into which the locator will be shared on the Content tab of the Share Locator tab.
6. Under Finish Sharing, click Analyze to identify potential issues or limitations.

   The Messages tab displays errors and warnings raised by the analysis. Right-click a message to get more information, access the associated help topic, or access suggested fixes. Errors must be resolved before you can share the locator or save the service definition. Resolving warnings is recommended but not required.

   Learn more about analyzing GIS resources

7. After you have resolved errors, and optionally, resolved warnings, click Publish to share the locator.

   If you want to save a service definition for the locator instead, click the Publish drop-down arrow and click Save As SD. To learn more, see Save a service definition for a locator.

   The locator is now running on the federated server on your portal and can be accessed by users and clients on your network. If you shared the locator as a server administrator and allowed web access to the service, the service is also now available on the web.

   You can add the locator from your portal to a project from the Portal tab of the Catalog pane. Browse to the shared locator there, right-click the locator, and choose Add to project. You can then use the locator in the Locate pane, in the Geocode Table pane, and in the geocoding geoprocessing tools.

Share a locator package

To distribute a locator inside or outside your organization, complete the following steps to create a locator package:

1. On the Analysis tab of the ribbon, click the Tools button to open the Geoprocessing pane.

   The Geoprocessing pane appears.

2. In the text box, search for the Package Locator tool, and click it to open it.

   The Package Locator tool opens.

3. For the Input Locator parameter, browse to the locator on disk that you want to package and share with others in your organization.
4. For the Output Locator parameter, specify a location on disk to save the locator package.
5. Click Run to run the tool.

   Once the tool has finished running, a .gcpk file is created, containing all the files from the original locator that can be shared for use in disconnected environments.

Share a locator in a mobile map package

To share a locator for use in disconnected environments, complete the following steps to create a mobile map package for use in mobile apps:

1. On the Share tab of the ribbon, in the Package section, click Mobile Map.

   The Package Mobile Map pane appears.

2. Select the Save package to file option if it's not selected by default.

   The output is saved as an .mmpk file on disk.

3. Specify a save location and output file name in the Name text box.

   A default name and save location is generated automatically, but you can change them.

4. Provide Summary and Tags text to describe the locator and help users search for it or understand what it does.

   Note:

   You can enter a maximum of 128 tags.

5. Optionally, change the extent of the map to be included in the mobile map package and specify whether to clip the data to that extent.

   If Clip is checked, the locator is also clipped to the specified map extent. The clipped locator in the mobile map package only returns geocode results that are within the specified map extent.

6. Check the Include Locator check box.

   Checking this box ensures that the locator is included with the mobile map package.

7. Click Package to create the mobile map package.

   Once the tool has finished running, an .mmpk file is created, containing all the files from the original locator that can be shared for use in disconnected mobile environments.

By examining why you need to share a locator with your organization and how it will be used, you can determine whether sharing a locator as a hosted service or as a package is the best workflow to achieve your goals.