Skip to main content
Cartegraph Campus

Cartegraph Add-In for ArcGIS Pro

You must have administrator rights to access this feature.

For Cartegraph data integrated with ArcGIS, the nightly GIS sync process keeps the two systems synchronized. Also, if a user edits integrated data in OMS, OMS immediately and automatically updates the corresponding GIS data. This add-in syncs data edits made in ArcGIS Pro to the customer's Cartegraph database. If you edit data that is part of a two-way integration in ArcGIS Pro, the ArcGIS Pro workstation should have the Cartegraph ArcGIS Pro Add-in installed. These are the workstations where GIS users edit GIS data with ArcGIS Pro. As GIS data is edited in ArcGIS Pro, the add-in component communicates with the Cartegraph Web server to keep the Cartegraph database in sync with the geodatabase.  In order for the Add-In to work, the SOE must be installed on the ArcServer and the feature layer must be registered as versioned. If the add-in is not installed or not configured, the sync must run to see any updates in Cartegraph.

A Cartegraph add-in exists for editing GIS data in ArcMap. ArcGIS Pro is another GIS editor that is gaining in popularity because of its modern user interface and ever-increasing feature set. Like ArcMap, ArcGIS Pro also supports add-ins, but the internal architecture is quite different from ArcMap, so add-ins for the two environments are not interchangeable. To give ArcGIS Pro users the same live-sync capability as ArcMap, Cartegraph offers the Cartegraph ArcGIS Pro Add-In.

Prerequisites

Minimum versions for inter-application compatibility:

  • OMS Winter 2020 (version 22)
  • ArcGIS Pro 2.5 / ArcMap 10.3
  • ArcGIS for Server 10.6
  • Cartegraph Add-In for ArcMap version 1.2
  • Cartegraph Add-In for ArcGIS Pro version 1.2
  • Cartegraph SOE version 1.2
  • Cartegraph SOE (Enterprise version) version 1.2

Functions of the Cartegraph Server Object Extension

Cartegraph GIS integrations require the GIS data to be published as feature services. To enable full functionality of the Cartegraph Add-Ins, one or both Cartegraph server object extensions (SOEs) should be installed on the ArcGIS server that hosts the feature services. The regular SOE supports feature services that were published from ArcMap, and the enterprise SOE supports feature services that were published from ArcGIS Pro. If the ArcGIS server hosts both types of feature service, both SOEs should be installed.

The SOE provides two pieces of functionality for proper integration between Cartegraph and the Esri ArcGIS server:

  • The extension writes a metadata tag to each feature class Cartegraph integrates with. This metadata tag ensures the feature class in question only integrates to one instance of Cartegraph, since it reads the integration information from the tag and also allows the Cartegraph Add-In for ArcGIS Pro to determine which Cartegraph server it should inform about changes made to an integrated feature class.
  • The extension also checks for duplicate records in the feature class at the time of integration by scanning the unique ID field determined by the end-user during field mapping to ensure a successful integration. If duplicates are found, you are informed and the integration is prevented until you address the duplicate records.

Use the Cartegraph user name and password instead of the ArcGIS Identity user name and password.

The Add-In for ArcMap requires the SOE, but the Add-In for ArcGIS Pro requires it only for certain types of GIS data connections:

Editing environment

Map layer data connection

Editing experience

SOE required?

ArcMap

Connection to geodatabase

Explicit start/stop editing, save/discard, undo/redo.

Required

 

Connection to feature service

Must create local copy to edit. Not supported by the Cartegraph Add-In.

N/A

ArcGIS Pro

Connection to geodatabase

Undo/redo, save/discard

Required

 

Connection to feature service 

Edits immediately committed (no explicit save, discard, undo/redo). For branch versioning, Add-In only supports editing default version.

Not required

Connection Types and Versioning

The Cartegraph Add-In’s awareness of edits to GIS data depends on several factors:

  • Whether you’re editing in ArcMap or ArcGIS Pro
  • How the map layer is connected to the data (geodatabase or feature services connection)
  • Whether the GIS data is versioned
  • What type of versioning (traditional or branched) is being used

In cases where the Add-in is aware of your changes, it will immediately notify OMS and update the corresponding Cartegraph data. Otherwise, Cartegraph will see the changes during the next scheduled nightly GIS sync.

ArcMap

Feature Service Connections

The Cartegraph Add-In only supports editing data in map layers that are connected through a geodatabase connection. While you can connect a layer to a feature service, to edit the data,you must create a local copy of the data, edit that, then synchronize the copy back to the feature service. The Cartegraph Add-In does not support this workflow. OMS won’t be made aware of the edits until the nightly scheduled OMS GIS sync process runs.

Versions

The Cartegraph Add-In will notify OMS of edits you make to versioned GIS data if the version you are editing in ArcMap matches the version you published as the feature service for Cartegraph integration. The Add-In is aware of your manual edits and also changes that are the result of reconciling and posting to other versions.

However, if you edit a different version than the feature service version, the Add-In will not notify Cartegraph. Also, if you reconcile and post from a different version, even if the target of the reconcile/post is the feature service version, the Add-In will not notify Cartegraph. In these cases, the nightly scheduled OMS GIS sync process will make OMS aware of the changes.

ArcGIS Pro

Feature Service Connections

ArcGIS Pro allows you to edit data from feature service connections (and geodatabase connections), without the “make local copy then sync to server” workflow of ArcMap. The Cartegraph Add-In supports feature service connections and will immediately notify OMS of changes—with one exception: For branch versioned feature services, the Add-In only supports editing the default version.

Versions

For traditional versioning, the add-in will notify OMS of your edits if the version you are editing in ArcMap matches the version you published as the feature service for Cartegraph integration. This is whether ArcGIS Pro’s data connection is to the geodatabase or to the feature service. Unlike the Add-In for ArcMap, however, the ArcGIS Pro Add-In is not aware of data changing due to reconciles and posts, even if the data changing is in the current version. Any data that changes because of reconciling and posting will only be visible to Cartegraph after the scheduled nightly sync.

For branch versioning, the add-in only sees manual changes you make the default version. If you edit data in child versions, the add-in isn’t aware of it. Also, if Pro is connected to a child version and you reconcile and post to the default version, even though this may change data in the default version, the add-in is not aware of the changes.

Install the Add-In for ArcGIS Pro

Install the Cartegraph Add-In on the workstation where ArcGIS Pro is installed. For more information, see Esri's instructions for managing add-ins.  Download the add-In for ArcGIS Pro file for Winter 2020 or Spring 2020.

  1. Copy the CartegraphAddinPro.esriAddinX file to a location on the ArcGIS Pro machine or a shared network location.
  2. Navigate to the location with the CartegraphAddin.esriAddIn file and double-click the file. The Add-In installation utility opens. The utility validates the add-in and copies it to the appropriate well-known folder.

A well-known folder is a location where Esri ArcGIS Add-in Installation Utility and the Add-In Manager look for add-ins.

  1. Confirm the version and digital signature and click Install Add-in.

Configure the Add-In

Once the Cartegraph Add-In is installed, it must be configured to communicate with Cartegraph OMS.

  1. Start ArcGIS Pro.
  2. On the opening screen’s lower-left corner, click Settings, which opens ArcGIS Pro’s Backstage View.
  3. Click Add-In Manager on the left to confirm the Cartegraph Add-In is installed. It will be listed under My Add-Ins.
  4. Click Options on the left to open the Options dialog.
  5. On the left under Application settings, find Cartegraph and select it.
  6. Enter the Cartegraph web address, such as https://cgweb.cartegraphoms.com/MyCityName.
  7. Enter the OMS username and password the Add-In should use to edit OMS data.

Note that you cannot use an ArcGIS Identity for this; you must use OMS credentials.

  1. Click Test to confirm the web address and credentials are valid.
  2. Click the Options dialog OK button to save the settings.
  3. To close the Backstage View, click the back arrow in the upper-left.
  4. Once you have opened a project in ArcGIS Pro, to go to the Backstage View click the Project tab.
  5. ArcGIS Pro will remember the add-in settings so you should only need to configure them once.

Edit Data

Once the Add-In is configured, you can edit GIS data in the usual way and the add-in will notify OMS of each change you make, keeping any integrated OMS data in sync. Here are things to keep in mind:

  • The type of connection you use to add the GIS data to the map affects the edit experience:
    • If you connect directly to a versioned feature class in an enterprise geodatabase or to the default version of a branch-versioned feature service, long transactions are supported. You can make many changes like adding, editing, or deleting features, and undoing or redoing the changes. You can then save all the changes to commit them to the GIS datastore, or discard the changes. When you save, the add-in notifies OMS of all the changes you made.
    • If the connection does not support long transactions, then there is no undo/redo or save/discard functionality available. Every change you make is immediately committed to the GIS datastore, and the add-in immediately notifies OMS of each individual change you make.
  • The attribute that links the map layer to Cartegraph (we’ll call it the CarteID), has some special behavior when the add-in is communicating with OMS.
    • If you add a new feature, you can leave the CarteID empty. When you save the feature and the Add-In notifies OMS, OMS will auto-number the attribute. If you refresh the data source of the map layer, you should see this auto-numbered value appear.
    • You can also manually assign a CarteID to a new feature. The Add-In will confirm the value you assign is unique and display an error message if it isn’t.
    • In order to maintain the proper linkage to OMS, the Add-In will not allow you to edit an existing CarteID. Instead, if you want to change it you must edit the corresponding ID field in OMS.
  • For other attributes that are integrated with Cartegraph, the add-in performs some basic validation and displays error messages for invalid data. For example, if a text attribute is integrated with Cartegraph, the add-in ensures the text isn’t too long to fit in the corresponding Cartegraph field.
  • If you delete a feature, the add-in will not delete the corresponding Cartegraph record but instead will retire it by setting its Retired date. This way any historical data associated with the Cartegraph record is maintained. If you truly want to completely delete the Cartegraph record, you must do it in OMS.
  • If you split a feature, or copy and paste a feature, you are creating new features from an existing one. To create new Cartegraph records for the new features, the Add-In will use the OMS Duplicate command to duplicate the record corresponding to the original feature. This will duplicate all the fields in the record, but no child data like tasks, inspections, or attachments. OMS will auto-number the new records, and if you refresh the GIS data you will see the new CarteIDs. NOTE: Split, divide and possibly some other tools may not work correctly with the Pro add-in for ArcGIS Online hosted layers.
  • If you combine features with the Merge tool, you are effectively editing one feature and deleting the rest. The add-in will edit the record corresponding to the remaining feature, then retire the rest.