Esri ArcGIS Subscriptions
Utility Cloud can directly connect to Esri’s various ArcGIS products to send data securely and automatically to and from Utility Cloud and ArcGIS. You can link any account to an ArcGIS account and link your feature layers to an asset class in Utility Cloud, or automatically create a new one. Once linked, your assets will be kept in sync with your features, automatically updating on a schedule.
Your account’s Esri configuration
On any account, you can enable Esri syncing by linking that account to an Esri account. To link your account to Esri, you’ll need the below data from Esri:
- Service URL: The feature service URL used to find your features in ArcGIS.
- Token URL: This is the URL used by Utility Cloud to authenticate with ArcGIS.
- Username: The username you use to log into ArcGIS.
- Password: The password associated with the above username
You can additionally receive notifications on the progress of your Esri subscriptions by entering any email address in the Email List field and can choose to receive either all notifications or only exceptions in the Email type field.
Linking your account to Esri
To link your account to Esri:
- Navigate to the Account Details of the account you’d like to link to Esri.
- In the lower right of the page, select Authentication in the Esri Online Subscriptions panel.
- Enter the required values.
- Optionally, enter any users you’d like to receive notifications and which notifications to receive.
- Select Test Connection to verify Utility Cloud can successfully link with Esri.
- Select Save.
Once your account has successfully been linked, you can then begin creating your Esri subscriptions.
Security Right Required: View Accounts; Edit User Esri Online Subscriptions
Your service URL
The service URL is the URL that Utility Cloud uses to find your feature layers. In ArcGIS Online, you can find your service URL in the Overview section of any feature layer. In the lower right of the page, under URL you’ll see a full URL of the feature layer in the below format:
https://<host>/<uniqueID>/ArcGIS/rest/services/<serviceName>/FeatureServer/
Your service URL will be included in this full URL and be in the below format:
https://<host>/<uniqueID>/ArcGIS/rest/services/
Your token URL
The token URL is the URL that Utility Cloud uses to securely authenticate with Esri. In ArcGIS Online, the token URL will follow the below format:
https://<organization>.maps.arcgis.com/sharing/rest/generateToken?f=json
Your Esri subscription
With any account linked to Esri, you can create an Esri subscription. An Esri subscription is a link between any feature layer in a linked ArcGIS account and a specific asset class in your account. Your subscription will automatically sync on a schedule, or a sync can be started at any time. You can additionally choose which attributes are synced between ArcGIS and Utility Cloud, and whether your data’s source of truth is Utility Cloud, Esri, or whichever source was most recently edited to keep both aligned.
When creating any Esri subscription, you’ll need to enter the below information:
- Name: This is the name of your subscription. You can give it any name that will be easy for you to find later.
- Interval: The interval your Esri subscription will automatically sync. You can set your subscription to Sync Daily, Weekly, Monthly, Quarterly, or Yearly.
- Feature Server: The feature server containing the feature layer you’d like to link to Utility Cloud.
- Feature Layer: The feature layer you’d like to link to an asset class in Utility Cloud.
- Asset Class: The asset class you’d like to link to your feature layer. When creating an Esri subscription, you can either select an existing asset class or select Create New to automatically create an asset class based on your subscription.
- Unique Key: This is the unique identifier between ArcGIS and Utility Cloud to determine which feature is associated with each asset. Your feature layer must contain a field with a unique ID assigned to each asset.
- Data Policy: This determines the source of truth for your assets and features whenever a sync is performed.
- Esri Wins: Any changes in ArcGIS will overwrite any changes in Utility Cloud since your last sync.
- UC Wins: Any changes in Utility Cloud will be sent to ArcGIS at the time of saving those changes, ensuring ArcGIS is up to date and matches Utility Cloud. Changes in ArcGIS will not be applied in Utility Cloud.
- Newest wins: The latest change in either Utility Cloud or ArcGIS will be applied to your assets and features. Any changes in Utility Cloud will be sent to ArcGIS at the time of saving those changes, and at the time of a scheduled sync, changes in ArcGIS will be sent back to Utility Cloud.
- Attributes to Sync: The attributes from your feature layer you’d like to send between Utility Cloud and ArcGIS. If an attribute in ArcGIS does not have a match in Utility Cloud, that attribute will be added to the asset class automatically.
- Asset Description: The description of your assets created in Utility Cloud. You can make your asset description dynamic by using an attribute from your feature layer enclosed in angle brackets. For example, if you gave an asset description of “Hydrant - <FacilityID>”, if the value for FacilityID were 5 then that asset’s description would be “Hydrant 5”.
Creating and editing your Esri subscriptions
To create your Esri subscription:
- Navigate to the Account Details of any account already linked to Esri.
- In the lower right of the page, select Add Subscription in the Esri Online Subscriptions panel.
- Enter the above required values.
- Optionally, enter any users you’d like to receive notifications and which notifications to receive.
- Select Preview Data to review the data syncing to Utility cloud matches what you’d expect based on the information you entered.
- Select Save.
Once saved, your Esri subscription will begin syncing. When it’s finished, it will automatically sync at the scheduled interval you selected.
To edit your Esri subscription, select the Edit icon next to your subscription and update any of the above values. Subscriptions can only be edited in the Complete status.
To force a sync outside of your scheduled interval, select the Refresh icon next to your subscription. Like editing, a force sync can only be performed on a subscription in the Complete status.
Esri Layer Sync Status
Once your Esri subscription has been saved, it will appear in the Esri Online Subscriptions. Each subscription will be followed by its status and the date of its last sync.
The statuses for an Esri subscription are:
- Saved (0): Your subscription is saved and pending validation before syncing.
- Validating (1): Your subscription is being validated so that the data structure matches between Utility Cloud and ArcGIS. This includes verifying if required Utility Cloud fields have a value in ArcGIS or matches between data types.
- Queued (2): Your subscription has passed validation and is queued to be synced.
- In Progress (3): Your subscription is syncing with Utility Cloud. Assets are being created or updated as needed.
- Completed (5). Your subscription has successfully synced without error.
- Error (4): Either an error was encountered in validation or an unexpected error was encountered while syncing. Any errors will need to be corrected and the subscription resaved before syncing again. An email with details regarding the issue encountered will be sent to any email addresses on the Email List field on the account’s Esri settings. Once the issue is resolved, a new sync will automatically begin on resaving the subscription.
- Inactive: Your subscription is no longer active and will no longer automatically sync.