ArcGIS Enterprise SDK

ArcGIS Enterprise Software Development Kit (SDK) allows developers to extend ArcGIS Enterprise functionalities. The ArcGIS Enterprise SDK supports extending the functionality of map services and image services published from ArcGIS Pro, as well as connecting to and integrating with remote data sources not natively supported on the ArcGIS platform. The following implementations are available in the ArcGIS Enterprise SDK:

• Server object extensions (SOEs) allow you to create new service operations to extend the base service functionality. SOEs are appropriate if you want to perform some well-defined business logic to work with the GIS data and services that is not easily accomplished using the existing service APIs.

• Server object interceptors (SOIs) is capable of intercepting requests for built-in operations of map services and image services. This allows you to execute custom logic and alter the behavior of these services by overriding existing operations in a way that is seamless to existing clients, such as ArcGIS Pro, Map Viewer, and more.

• Custom data feeds (CDF) is a customization and administration workflow that allows you to bring your data from any source into ArcGIS Enterprise in real time. See how in this blog and video.

SOEs and SOIs can be developed with .NET or Java. Custom data feeds are developed in Node.js.

Get started with SOE and SOI

Get started with custom data feeds

Prerequisites

The ArcGIS Enterprise SDK is included with your license for the ArcGIS Enterprise product. There is no separate purchase or authorization mechanism specifically for the ArcGIS Enterprise SDK. However, because SOEs, SOIs, and CDF must be deployed via ArcGIS Server, you must have a licensed ArcGIS Server to deploy or test the SOE/SOI. Custom data feeds may be developed and tested but not deployed without an ArcGIS Server license.

Before you install the SDK, check System Requirements to make sure you have installed the following software or components of supported versions:

• Developing a .NET SOE or SOI:
  • Visual Studio
  • .NET Framework
• Developing a Java SOE or SOI:
  • Java IDE
  • JDK
  • Maven (required since the 10.8.1 release)
• Developing a CDF:
  • Any IDE or text editor
  • Node.js

Install ArcGIS Enterprise SDK

Follow these steps to download ArcGIS Enterprise SDK:

• Download at My Esri.

  1. Log in to https://my.esri.com website.
  2. Find ArcGIS Enterprise under Downloads tab.
  3. Click the View Downloads button.
  4. Find ArcGIS Enterprise SDK under Developer Tools section and click Download.

Refer to the following installation guides:

• Developing SOEs and SOIs in .NET
• Developing SOEs and SOIs in Java
• Developing CDF in Node.js

Build a simple SOE or SOI

The following are simple SOEs and SOIs that you can start with:

• Sample: .NET simple REST SOE sample
• Sample .NET simple SOI sample
• Walkthrough: How to create and develop a .NET REST SOE
• Walkthrough: How to create and develop a .NET SOI
• Sample: Java simple REST SOE sample
• Sample: Java simple SOI sample
• Walkthrough: How to create and develop a Java REST SOE
• Walkthrough: How to create and develop a Java SOI

Build a simple CDF

The following are simple CDF implementations that you can start with:

• Walkthrough: Integrate with the Yelp API
• Sample: Integrate with Socrata Open Source
• Sample: Integrate with a CSV File

Video

Blog