ESRI ArcGIS Pro Plugin

Prev Next

ArcGIS Pro is Esri’s desktop GIS application for creating, editing, analyzing, and visualizing spatial data in 2D and 3D. It integrates mapping, imagery, and geoprocessing tools, supports workflows like cartography, spatial analysis, and data management, and connects to ArcGIS Online, ArcGIS Enterprise, and local file geodatabases for sharing and collaboration.

Important Note

ArcGIS Pro Syncing must be enabled to utilize this plugin. Please Contact CivicPlus Support to enable syncing.

Plugin Setup

Each user syncing from ArcGIS Pro must generate an Authorization Code to authenticate and verify their identity.  This code is used to log into the Asset Management system from within ArcGIS Pro. The code is unique to the logged-in user and linked to their database record.

Get an Authorization Code

Important Note

Each user should generate their own authorization code and use their own ArcGIS login for audit purposes. If users share a single authorization code across multiple ArcGIS Pro logins, you may experience processing issues with two users pushing updates at the same time. If this occurs, it will not be possible to accurately audit and determine who did what and when. This is not supported configuration and should not be expected to work reliably.

  1. Click the Account dropdown menu

  2. Click Authentication Code

  3. Copy this authentication code

    Note:

    This authentication code will be used in the following instructions. We advise pasting this code into a word document or notepad for easy reference.

Install the ArcGIS Pro Add-In

  1. Download the CivicPlus.esriAddinX file

  2. Launch ArcGIS Pro and log in

  3. Open the ArcGIS Pro settings

    1. In an open project, click the Project tab

    2. On the start page, click Add-In Manager

  4. Click Add-In Manager

  5. Click the Options tab

  6. Create an ESRI Well Known folder if one does not exist

    Note:

    If a ESRI Well Known folder does exist, skip to step 7.

    1. Click the Options tab

    2. Click Add Folder

    3. Select the folder you want to designate as the well-known folder

    4. Click OK

    5. Exit ArcGIS Pro

  7. Copy the CivicPlus.esriAddinX file on your computer

  8. Paste the CivicPlus.esriAddinX file into the well-known folder

  9. Start ArcGIS Pro

    Note:

    Restart all ArcGIS Pro instances after moving the add-in file to the well-known folder. The add-in will not be available for use until ArcGIS Pro is restarted with the add-in in the well-known folder.

  10. Validate that the add-in has been installed

    1. Open the ArcGIS Pro settings page

    2. Click Add-In Manager

    3. Confirm that there is a Shared Add-In section labeled Beehive Add-in

  11. Open the ArcGIS Pro project with the layers to push to Asset Management

  12. Click Add-In

  13. Select GIS Push

  14. Enter the Authentication Code

  15. Click OK

Configure the Plugin

Enable Layers to Sync

Each layer must correspond to an asset class in Asset Management and a layer in ArcGIS Pro for syncing to work. An entry in this table is required for every layer to sync. Below is a list of columns and the fields required for the GIS Sync table.

Important Note

The LayerName in this table must exactly match the Alias of the layer in ArcGIS Pro you configure to sync. Casing matters. If the LayerName does not match the Alias, the layer will not be available for syncing.

Column Name

Data Type

Required

Purpose and Description

SyncType

string

Yes

Must be set to PushTool for the layer to show up in the GIS Push Tool inside of ArcMap.

EntityTypeId

integer

Yes

The Asset Class ID of the Asset Class you are configuring for sync.

TokenURL

string

No

Not used with the GIS Push Tool. Leave blank.

TokenPassword

string

No

Not used with the GIS Push Tool. Leave blank.

LayerURL

string

No

Not used with the GIS Push Tool. Leave blank.

LayerName

string

Yes

The Alias name in ArcGIS Pro of the layer that the user wants to push to Asset Management.

GISJoinColumn

strong

Yes

The unique ID in the GIS data that will be used to join data. This field must be unique in the data. If the data in this column is not unique, syncs will fail.

GlobalIdName

string

Yes

The GlobalId field needs to be set, even if it is not used. We strongly suggest that Global IDs for each layer that you are syncing be turned on to guarantee a unique join column for the sync process to use.

LookupItemName

string

Yes

Set to Name1 or Name2. Specifies joining on the Name1 or Name2 option in the met.LookupItem table for domains. Domain values may be configured differently as either a value or code. This selects which lookup value to use during syncing.

CreateAssets

bit

Yes

Designates if you want the GIS Sync Push Process to create new assets or only update existing assets. Typically set to 1 in a standard implementation.

IsDeleted

bit

Yes

Designates whether the layer is enabled or not. Must be set to 0 for layer to sync.

TokenUserName

string

No

Not used with the GIS Push Tool. Leave blank.

DeleteWhenNotMatched

bit

Yes

Deletes assets present in Beehive but absent from the GIS Sync layer. Set to 0 to avoid deleting assets if the unique ID in a GIS system changes. Use caution to prevent unintended consequences.

Field Mapping

In addition to each asset class being tied, you will also need to do a field mapping. The easiest way to accomplish this is to Update Entity Properties through the Admin application. Each field that will be synced needs to be mapped.

Important Note

Field names much match exactly. Casing matters: “testfieldname” is not the same as “TestFieldName” and will not match or sync if the fields do not match exactly.

Instructions

  1. Log in to the Asset Management Admin Application

  2. Click Properties

  3. Pick the asset class to be configured for GIS Sync

  4. Click the property in the Property Selection list that needs to be mapped

  5. Type the GIS Property Name into the External Sync Property box

  6. Click Save

Syncing from ArcGIS Pro to Asset Management

Important Note

  • Once you have finished all your setup steps, please contact our support team to enable the syncing on our side. Once complete, you can proceed to testing a sync.

  • End-users cannot sync 1-2 records at a time as they did in ArcMap. Syncing alayer sends all its records to the asset management application.

Initiate a Sync

This method requires manual syncing. Users must run the sync process within ArcGIS Pro:

  1. Click the GIS push add-in button

  2. Check the box or boxes for each layer you want to sync

  3. Click OK to begin the sync

The layer data is securely created and uploaded to the Asset Management Application for processing. The status of all GIS Pushes is displayed in the Asset Management application. Use this application to view progress, status, successful sync counts, or errors. The easiest way to do this is through the GIS Push History query.