Note:
The ArcGIS Collector help site is retired and no longer being updated. To learn about ArcGIS Collector retirement and to find the latest information on data collection, see Collector retirement.
Once your map is ready for use in the field, deploy it to your mobile workers. Share it with them, and then they can either browse to the map in Collector or tap a custom link you've sent. Provide your mobile workers with help on using the app by customizing a field guide for your organization's data collection projects. You can also use mobile device management (MDM) software to deploy and configure the mobile app.
Share your map for use in Collector
Collector provides access to maps with editable data that are either owned by the mobile worker or shared with a group containing the mobile worker. For your mobile workers to access your shared map, they need to be members of an ArcGIS organization and have the privilege to edit features.
- If the mobile workers aren't already members of an ArcGIS organization (either in ArcGIS Online or ArcGIS Enterprise), you'll need to create accounts for them.
See Invite and add members in ArcGIS Online or Add members to your portal in ArcGIS Enterprise.
The accounts you create need to meet the ArcGIS account requirements for using Collector.
- If you don't already have a group that you'll use to manage the mobile workers who have access to your maps and data, create a group.
- Add the mobile workers to the group.
See Group assignment in ArcGIS Online, Manage groups for a specific member in ArcGIS Online, or Manage groups for a specific member in ArcGIS Enterprise. If you are using ArcGIS Enterprise and have an enterprise identity provider (IDP), you can link enterprise groups to your portal group.
- Share the map and layers with the group.
Open your map from a link
Mobile workers can browse to your map in Collector, or you can provide a URL directly to it. Make it easy for your mobile workers to open the right map and get started on their work by sharing a link directly to your map through an email, text message, web page, or another app. Use links to Collector that, when tapped, open Collector to the map you want the mobile worker to use. You can even start capturing data when the map opens. If your mobile workers are working offline, don't worry: the links still work.
Collector links
Collector links have the following format: https://collector.arcgis.app?parameter=value¶meter=value, where parameter and value pairs are replaced with the values you want to use to open a map. For example, https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&referenceContext=center¢er=34.0547155,-117.1961714 uses the parameter itemID and the value 3ac4145c1ac44aea86e9ed42e00fbb0d to open the map with that ID. The referenceContext parameter and its value center specify the type of action that should be performed in the app—in this case, centering the map. The center parameter and 34.0547155,-117.1961714 value provide the coordinates at which to center the map.
Parameters
The following parameters are supported with Collector links. If no parameters are passed, tapping the link opens Collector (or prompts you to do so).
| Parameter | Values | Notes |
|---|---|---|
portalURL | Your organization's portal URL |
|
referenceContext | What the app should do, if anything, once open and the user is signed in | The following values are supported:
|
itemID | The itemID of the map to open |
|
center | A set of latitude, longitude (y, x) coordinates at which to center the map |
|
search | An address, place, coordinate, or feature to search for |
|
featureSourceURL | The URL of the layer or table where capture is instantiated |
|
featureAttributes | A JSON dictionary of form entries for the newly captured feature |
|
geometry | Defines the location for the newly captured feature |
Note:Support is coming to Android. |
useAntennaHeight | If the antenna height of the current receiver should be subtracted from the z-value of each vertex of the location |
Note:Support is coming to Android. |
useLocationProfile | If the current location profile should be used to transform the location |
Note:Support is coming to Android. |
featureID | Uniquely identifies the feature within the layer to be updated. Must be a GlobalID field. |
Note:Support is coming to Android. |
callback | The URL to call when capturing the asset or observation is complete |
Note:Support is coming to Android. |
callbackPrompt | Prompts the mobile worker before executing the callback, and displays this value in the prompt as where the mobile worker will be taken |
Note:Support is coming to Android. |
Continue reading for examples of using these parameters to achieve specific behavior with a Collector link.
Open the map
Open the map using the following parameters:
- itemID
- referenceContext=open
- portalURL (optional)
The following are examples:
- Open the map as the currently signed-in mobile worker, or if not signed in, provide the opportunity for them to sign in: https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&referenceContext=open
- Connect to a particular portal and then open the map: https://collector.arcgis.app?portalURL=https://myportal.mycompany.com/arcgis&itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&referenceContext=open
Center the map
Open the map and center it at the provided location using the following parameters:
- itemID
- referenceContext=center
- center
The following is an example:
Search in a map
Open the map and search for an address, place, coordinate, or feature (asset or observation) by using the following parameters:
- itemID
- referenceContext=search
- search
The following are examples:
- Search for a street address in Naperville, IL: https://collector.arcgis.app?itemID=bd171bc8ba404b14a2e845fe6839e881&referenceContext=search&search=899+Aurora+Ave,+Naperville,+Illinois
- Search for a nearby gas station: https://collector.arcgis.app?itemID=bd171bc8ba404b14a2e845fe6839e881&referenceContext=search&search=gas+station
- Search for coordinates: https://collector.arcgis.app?itemID=bd171bc8ba404b14a2e845fe6839e881&referenceContext=search&search=34.0547155,-117.1961714
- Search for a feature with ID 5482236: https://collector.arcgis.app?itemID=bd171bc8ba404b14a2e845fe6839e881&referenceContext=search&search=5482236
Initiate capturing a feature
Open the map and start capturing a feature using the following parameters. Optionally provide form entries to apply to the new asset or observation.
- itemID
- referenceContext=addFeature
- geometry (optional)—If provided, defines the shape of the feature. If not provided, the mobile worker's GPS location is used for the point or the first vertex if a line or polygon.
- useAntennaHeight (optional)
- useLocationProfile (optional)
- featureSourceURL
- featureAttributes (optional)
- callback (optional)
- callbackPrompt (optional)
Note:
Support for geometry, useAntennaHeight, useLocationProfile, callback, and callbackPrompt in links is coming to Android.
The following are examples:
- Initiate capture at the mobile worker's location without providing any form entries:
- Initiate capture at a specific location and provide form entries to apply to the new asset or observation:
Note:
Form entries you pass into the new asset or observation need to be URL encoded. The unencoded URL is provided below to make it easier to read the example and understand the entries provided.
- Without URL encoding—https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&geometry=34.0547155,-117.1961714,1200&featureSourceURL=https://services9.arcgis.com/QjGvjfQhsHAmqfjP/arcgis/rest/services/DamageAssessment_Apr2018_631d0895e7d3404bb78e8e04e92d896e/FeatureServer/1&featureAttributes={"incidentid":"527","inspector":"Frank Jones","inspdate":1502917218285}
- With URL encoding of form entries—https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&geometry=34.0547155,-117.1961714,1200&featureSourceURL=https://services9.arcgis.com/QjGvjfQhsHAmqfjP/arcgis/rest/services/DamageAssessment_Apr2018_631d0895e7d3404bb78e8e04e92d896e/FeatureServer/1&featureAttributes=%7B%22incidentid%22:%22527%22,%22inspector%22:%22Frank%20Jones%22,%22inspdate%22:1502917218285%7D
- Initiate capture with a provided polygon geometry (in WGS84) without providing any form entries:
- Initiate capture at a specific location without providing any form entries, but use the antenna height to calculate the z-value and use the current location profile to transform the point as if it is from the GPS:
- Initiate capture and automatically open another app (here ArcGIS Explorer) when capture completes:
- Initiate capture and open another app after prompting (here ArcGIS Explorer) when capture completes:
Initiate updating a feature
Open the map and start updating an existing feature using the following parameters. Optionally provide form entries to apply to the updated asset or observation.
- itemID
- referenceContext=updateFeature
- featureSourceURL
- featureID
- featureAttributes (optional)
- callback (optional)
- callbackPrompt (optional)
Note:
Does not apply to table rows.
Support for callback and callbackPrompt in links is coming to Android.
The following are examples:
- Initiate updating a feature without providing any form entries:
- Initiate updating a feature and provide form entries to apply to the updated asset or observation:
Note:
Form entries you pass into the updated asset or observation need to be URL encoded. The unencoded URL is provided below to make it easier to read the example and understand the entries provided.
- Without URL encoding—https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&referenceContext=updateFeature&featureSourceURL=https://services9.arcgis.com/QjGvjfQhsHAmqfjP/arcgis/rest/services/DamageAssessment_Apr2018_631d0895e7d3404bb78e8e04e92d896e/FeatureServer/1&featureID=bb0a0c92-9f53-4367-a6a1-bc6edc605be0&featureAttributes={"incidentid":"527","inspector":"Frank Jones","inspdate":1502917218285}
- With URL encoding of form entries—https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&referenceContext=updateFeature&featureSourceURL=https://services9.arcgis.com/QjGvjfQhsHAmqfjP/arcgis/rest/services/DamageAssessment_Apr2018_631d0895e7d3404bb78e8e04e92d896e/FeatureServer/1&featureID=bb0a0c92-9f53-4367-a6a1-bc6edc605be0&featureAttributes=%7B%22incidentid%22:%22527%22,%22inspector%22:%22Frank%20Jones%22,%22inspdate%22:1502917218285%7D
Provide help to your mobile workers
While this documentation provides information about using Collector, mobile workers in the field often need something more lightweight—something that can be printed and taken along (especially if working offline). Providing them with a basic, single-page field guide that helps with common tasks and some issues makes your job supporting the mobile workers easier. A field guide template focused on common tasks and written for the mobile worker is provided. Use it to jump-start creating your own reference for your mobile workers.
- Download the field guide template.
- Customize it (add your logo, troubleshooting tips specific to your organization, and so on). Make sure to remove the first section that walks you through customizing it.
- Give it to your mobile workers.
Mobile workers can keep the guide in their pocket, and use this self-service guide to resolve issues while they're in the field.
Mobile device management
Mobile device management (MDM) refers to software used for the administration of mobile devices in an organization. An MDM is used to enhance data and network security as well as to set and enforce mobile device policies. Additionally, using an MDM increases the efficiency of app deployments and management for mobile devices, including controlling how and when an app is updated. To learn more about how Esri approaches MDM, see ArcGIS Secure Mobile Implementation Patterns in the ArcGIS Trust Center.
When preparing to deploy Collector to your organization's mobile devices via MDM, there are some application and profile settings you may want to configure. These include the portal URL and per-app VPN settings.
Caution:
If you’re using an Android device, Chrome or another browser must be installed and enabled to display the portal sign-in screen.
Collector app configuration
App configuration (also referred to as AppConfig) refers to a format for providing application settings such as portal URL, among others. Instead of configuring these settings manually each time a mobile app is installed, you can use your MDM to specify and apply app configurations automatically. These settings are defined as a dictionary of key-value pairs in an XML file. How the dictionary is created depends on the MDM you're using. To learn more about app configuration, visit the AppConfig Community.
Collector has the following settings that can be implemented with app configuration in your MDM:
| Key | Value | Notes |
|---|---|---|
portalURL | Your organization's portal URL |
|
Per-app virtual private network
Configuring a per-app virtual private network (per-app VPN) in your MDM allows you to restrict access to internal resources to specific managed apps. Collector can be deployed with this configuration. To set up per-app VPN for use with Collector, please see the software documentation for the MDM you are using.
Caution:
If you're on iOS and using ArcGIS Online or ArcGIS Enterprise 10.6.1 or later, Safari is used to display the portal sign-in screen in Collector. For this to work correctly with a per-app VPN enabled, your portal domain (for example, mycompany.com) must be specified in the Safari Domains setting in the per-app VPN profile you're using. If Safari Domains is not set correctly, the assigned mobile devices cannot access the Collector portal sign-in screen.
When you set a Safari Domain in the per-app VPN profile as described above, the Safari Browser app can also access the portal domain you specified in the Safari Domains. If you want to block this access, configure an iOS Restriction (if available in your MDM) to Block Safari Browser App on the desired devices.
After you've configured the per-app VPN settings for Collector in your MDM, when the app is launched on a managed mobile device, it will automatically connect to the designated per-app VPN. When Collector is running in the background, the per-app VPN is still connected, but only to Collector. When Collector is closed, the mobile device automatically disconnects from the per-app VPN.