You must have administrator rights to access this feature.
Cartegraph provides several tools facilitating integration with the ArcGIS for Windows platform. The most common integration path connects asset records in the Cartegraph database with asset features in ArcGIS. The Cartegraph user can view and edit asset geometry and attribute information in Cartegraph, with those changes automatically updating the corresponding records in ArcGIS. Conversely, a GIS user editing the feature data in ArcGIS has their changes automatically made in Cartegraph. Users in the system can also integrate Tasks and Work Orders, which participate in a One-Way sync from Cartegraph to Esri. Other recordsets able to be associated are Requests, Resources, and Libraries, which participate in the same Two-Way sync as Assets.
Cartegraph requires any of three ArcGIS products for the integration:
- ArcGIS for Server (On-Premise Deployment)
- ArcGIS for Server + Web Adaptor (Hosted Deployment)
- ArcGIS Online
- Portal for ArcGIS (SDE or Data Store)
While the integration process is primarily the same for all three products, differences between them will be called out where appropriate.
The integration is a multistep process, consisting of the following key areas.
Not all steps may apply to your integration, depending on the ArcGIS product you are using.
- Prepare the Cartegraph database and ArcGIS geodatabase (All)
- Install the Cartegraph SOE (optional) (Server)
- Install the Cartegraph Add-In for ArcMap (Server)
- Prepare the ArcGIS feature layers and feature classes (All)
- Establish connections to the ArcGIS platform (All)
- Perform recordset and field mapping (All)
Prepare the Cartegraph Database and ArcGIS Geodatabase
Before a Cartegraph and ArcGIS integration is established, it is necessary to ensure the data schemas for recordset types in Cartegraph and feature classes in ArcGIS are aligned. Both platforms allow your organization to modify the database structures to ensure a successful integration.
The process of evaluating and correcting differences between Cartegraph and ArcGIS is called reconciling. This process typically entails manual changes to data values and/or data schemas.
Examples of such corrections
- Matching field lengths between Cartegraph and ArcGIS
- Matching field types between Cartegraph and ArcGIS
- Ensuring the presence of a unique ID per record
For more information see Normalize Cartegraph Data for ArcGIS Integrations
The checklist that follows contains step-by-step instructions for evaluating the data you need for an efficient, integrated system.
- Break apart a Feature Class to Integrate with Cartegraph. Tasks can have up to three if using full geometry.
- Combine Data to Integrate with Cartegraph.
- Create Cartegraph Fields or Recordsets to integrate with Cartegraph.
- Verify you have compatible data types.
- Field Length
- Libraries, Domains, and Subtypes
Install the Cartegraph SOE
This step is recommended only for ArcGIS for Server two-way integrations that desire real-time updates from ArcGIS to Cartegraph when set up as a two-way integration.
The extension provides two pieces of functionality:
- The extension allows the Cartegraph Add-In for ArcMap to determine which Cartegraph server it should inform about changes made to an integrated feature class.
- The extension 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 during field mapping and the integration is prevented until you address the duplicate records.
If the SOE is not used with ArcGIS Server two-way integrations:
- The Cartegraph Add-In for ArcMap is not used and any edits made in ArcMap are not updated in Cartegraph until a sync is run.
- The pre-validation of checking for duplicate records during the field mapping step is not performed. However, the initial sync fails if duplicate records are found.
- A warning message displays in the GIS Association record in Cartegraph.
The Cartegraph Server Object Extension (SOE) (ArcGIS for Server) is a file for deployment. There are two SOE files:
- Install the CartegraphSOE.soe for services published with ArcMap. Download the file for Fall 2020 or Winter 2021.
- Install the CartegraphSOE_ent.soe for services published with ArcGIS Pro. This is available with ArcGIS Server 10.6 or later. Download the file for Fall 2020 or Winter 2021.
The SOE is built using .NET; for this reason, the server must have .NET Extension Support installed(which is an option when installing ArcGIS for Server). If there are errors installing the Cartegraph SOE or restarting the map service when Cartegraph is turned on, this might be the problem. To check, go to Programs and Features and Modify the ArcGIS for Server installation. On the Select Features page of the install wizard, you’ll see the .NET piece listed. Make sure it’s on.
- Copy the CartegraphSOE.soe/CartegraphSOE_ent.soe file to the ArcGIS server.
One or both can be installed on the same server.
- Sign in to the ArcGIS Server Manager.
- Click the Site tab and select Extensions on the left.
- Click Add Extension and browse to the SOE file to select it.
- Go to the settings for any services you want to use the SOE.
- Click Capabilities and turn on Cartegraph.
- Save and Restart the service.
Integrating with Tasks and Work Orders automatically connect using the Cartegraph to Esri one-way concept. Any changes made in ArcGIS are ignored and overwritten by what is in Cartegraph. Users cannot change this option.
Install the Cartegraph Add-In for ArcMap or ArcGIS Pro
This step is recommended only for ArcGIS for Server two-way integrations that desire real-time updates from ArcGIS to Cartegraph. One-way integrations do not need the add-in, as changes made in ArcGIS are never sent to the associated Cartegraph recordset.
This add-in for Esri's ArcMap application allows edits made in ArcMap on feature classes integrated with Cartegraph to update in real-time to the corresponding record stored in Cartegraph. Without the add-in applied, any changes made to integrated feature classes in Cartegraph apply only when the background sync engine runs.
The Cartegraph Add-In for ArcMap is a single file for deployment. If you install the Add-in the Cartegraph SOE is required.
- Copy the CartegraphAddin.esriAddIn file to a location on the ArcMap machine or a shared network location.
- In ArcMap, from the Customize menu, select Add-In Manager.
- Click the Options tab and add the folder where you placed the add-in.
- For the Security Setting, select either the second or third choice to enable third-party add-ins.
- Click Customize.
- Click the Commands tab.
- For Show commands containing, enter Cartegraph.
- Select the Menus category, which displays the Cartegraph menu in the second column.
- Drag this menu up to the ArcMap menu bar.
- Click Close.
- From the new Cartegraph menu, select Cartegraph Options.
- Enter the Cartegraph Web Server URL and a Cartegraph user name and password with permissions to edit the integrated Cartegraph data.
- Click Test to confirm the settings.
- Click OK.
- Repeat this process on all ArcDesktop installs where integrated features are edited.
Once the options are set, you should not have to set them again on the workstation unless the Cartegraph URL or Cartegraph credentials change. The Cartegraph Add-in runs in the background and monitors your GIS edits, syncing them to Cartegraph when necessary to keep the databases in sync.
Install the Cartegraph Add-In on the workstation where ArcGIS Pro is installed. For more information, see Esri's instructions for managing add-ins.
- Copy the CartegraphAddinPro.esriAddinX file to a location on the ArcGIS Pro machine or a shared network location.
- 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.
- Confirm the version and digital signature and click Install Add-in.
Prepare the ArcGIS Feature Layers and Feature Classes
There are base prerequisites for all three deployment options: ArcGIS Online, ArcGIS for Server, and Portal for ArcGIS. These steps need to occur on the ArcGIS platform you have selected to ensure a successful integration:
- Upload the underlying feature data to ArcGIS Online. For specific instructions, visit: http://doc.arcgis.com/en/arcgis-online/share-maps/add-items.htm
- Common supported formats for ArcGIS Online are Shapefiles (compressed in .ZIP file), File Geodatabase containing feature classes (compressed in a .ZIP file), or comma-delimited file containing X and Y coordinates. For a complete list, visit http://doc.arcgis.com/en/arcgis-online/share-maps/supported-items.htm
- Publish the data set as a Feature Layer. Do this using the Publish command found on the details page for the data set. Specific details on the publishing process can be found here: http://doc.arcgis.com/en/arcgis-online/share-maps/publish-features.htm
- Make sure editing is enabled on the Feature Layer you are integrating against. Select the Enable editing and allow editors to Add, update, and delete features options while editing the properties of the Feature Layer
- Make sure track edits is enabled on the Feature Layer you are integrating against. Select the Keep track of who created and last updated features option while editing the properties of the Feature Layer.
- Make sure the Feature Layer is shared to the group containing the user whose credentials are used to establish the integration connection.
ArcGIS for Server
- All feature classes to which you will be integrating need to be stored in an enterprise geodatabase.
- Make sure the feature classes have Editor Tracking enabled. Right-click on the feature class and select Manage>Enable Editor Tracking, or for a more compact setup, of the four available tracking fields, Cartegraph only requires the Last Edit Date for GIS integration.
- Make sure the feature classes are Registered As Versioned.
- Publish a Feature Service with a secure connection that contains all the feature classes to be integrated:
- Using ArcMap to create a Map Project (MXD) with a layer for each feature class to be integrated is the most common approach.
- Map Services must be published in the WGS 1984 Web Mercator (auxiliary sphere) WKID 3857 coordinate system. This does not require the projection of the source feature classes comprising the basemap, but rather requires the data frame of the Map Project to be set to this coordinate system.
- Once the Map Project is complete, publish the map to ArcGIS Server with the Share as Service command, turning on the Feature Access and Cartegraph capabilities in the process. For the Feature Service make sure Create, Delete, Query, Update, and Geometry Updating are all allowed.
- The server supports only unsecured or GIS-tier authentication.
Portal for ArcGIS
Cartegraph only officially supports Portal for ArcGIS configurations where the Portal Server and the underlying ArcGIS Server are federated and registered with each other. In this configuration, a user should follow the ArcGIS Online recommendations listed previously.
Esri Portal supports only GIS-tier authentication.
Establish Connections to the ArcGIS Platform
See Cartegraph and ArcGIS Synchronization for more detail on synchronization rules and behavior. This applies to all ArcGIS integration configurations that Cartegraph supports.
Cartegraph can integrate with multiple ArcGIS data sources; a mix of ArcGIS Online, Portal for ArcGIS and ArcGIS for Server environments can be used to ensure the organization has access to all ArcGIS data sets it wished to integrate against. Connections to these ArcGIS data sources are created and managed directly within Cartegraph, and these data source connections must be established before any integrations are established.
- Open the Cartegraph website and sign in.
- Click > GIS Integration.
- Click Manage Servers.
- Click Add ArcGIS Server.
- Select the Configuration of the Arc Server.
- Enter the Server Name and Server URL fields for the ArcGIS server.
When needed, enter the portal URL field for Portal for ArcGIS Server.
- If the services are secured, enter the User Name and Password setup in the ArcGIS Server Manager.
- Click Test Connection.
- Click Finish & Save.
- Click Close.
Perform Asset and Field Mapping
Once ArcGIS data sources have been established using Manage Servers, establish an association. All Cartegraph users should be out of the system during this process.
- Open Cartegraph and click > GIS Integration.
- Click Create.
- Select the server from the Server Name field.
- Select the Feature Service.
- Select the Feature Class layer.
- Select the Cartegraph recordset.
- Some of the Feature Services and Feature Class Layers may be invalid for selection. If the item is invalid, the reason is shown in parentheses and a message displays if that item is selected.
- The choice of recordset is limited to those whose geometry type matches the feature class. For example, polygon feature classes can integrate with polygon Cartegraph recordsets. In addition, you can also integrate a feature class with non-geometry recordsets and libraries.
- To associate the feature class to a new Cartegraph library, select <New Library>. This library contains the new Cartegraph fields configured in the Field Associations list.
- Using an Esri user-named Viewer (previously Level 1) license, users can view, but not create, update, or delete content associated to an ArcGIS Online server or Portal server. See ArcGIS License Levels and Cartegraph.
- If the feature class layer is part of a geometric or utility network, the option of Geometric or Utility Network displays. This prevents any geometry changes in Cartegraph. See About Geometric or Utility Networks for more information.
- Select Inactive if you want to inactivate this association. For more information on inactive associations, see the Cartegraph Help.
Create Field Associations
After selecting the Feature Class Layer and the Cartegraph Recordset, field associations can be made in the Field Associations list. The left side of the list displays the Geodatabase Attributes and Domain/Subtypes available for the selected Feature Class Layer. The Geodatabase Attributes column shows the alias name, not the actual field name. See Campus Help for more information on GIS Integrations and creating associations for Task, Work Orders, Assets, Libraries, Requests, and Resources.