Extend services

You can extend map and image services published from ArcGIS Pro with server object extensions (SOEs). SOEs allow you to create service operations to extend the base service functionality. They can be developed using ArcGIS Enterprise SDK.

These extensions are encapsulated in .soe files and can be added to your organization and managed from ArcGIS Enterprise Manager.

Add an extension

To add an extension to an organization, you need the .soe file that was created by the extension developer. The file can contain one or many extensions.

Once you have the file, perform the following steps:

  1. Sign in to ArcGIS Enterprise Manager as an administrator.
  2. Click the Extensions button in the sidebar.

    The extensions page appears.

  3. Click Add extension.
  4. Click Choose file and choose an .soe file to add to your organization.
  5. Click Add extension.

    The .soe file is added to the organization.

Now that you have added the extension to your organization, you must register the extension with a service. To do so, enable the SOE capability on the desired map or image service when publishing the service from ArcGIS Pro.

Configure debug settings

To enable debugging, ArcGIS Enterprise Manager allows you to alter extension behavior. You can suspend the service startup so that you can attach your debugger to the service process before the extension initialization methods are called. You can also specify a range of ports that will be used when debugging the service.

To access these debugging settings in Enterprise Manager, follow these steps:

  1. Sign in to ArcGIS Enterprise Manager as an administrator.
  2. Click the Services button in the sidebar.

    The services page appears.

  3. Locate and click the name of a service registered with a SOE.
  4. Select the Advanced tab and enable debug mode.

    Extension debug settings appear once debug mode is enabled.

  5. Optionally, enable Suspend service at startup and specify the number of seconds that the service startup should be delayed.
  6. Optionally, specify a range of ports to be used when debugging.
  7. Click Save.

Delete an extension

When you delete an extension in ArcGIS Enterprise Manager, the extension is removed from your organization. If the extension is registered with a service, deleting the extension will also unregister it from the service.

To delete an extension, follow these steps:

  1. Sign in to ArcGIS Enterprise Manager as an administrator.
  2. Click the Extensions button in the sidebar.

    The extensions page appears.

  3. Click the More options button for the extension you want to delete and click Delete.
  4. Click Delete again to confirm.

    The extension is unregistered from the service and removed from the organization.

Update an extension

You can update an extension that has been added to your organization by adding its updated .soe file.

To update the extension, follow these steps:

  1. Sign in to ArcGIS Enterprise Manager as an administrator.
  2. Click the Extensions button in the sidebar.

    The extensions page appears.

  3. Click the More options button for the extension you want to update and click Update.
  4. Click Choose File and select the updated version of the .soe file.

    The file name must match the original .soe file name.

  5. Click Update extension.

    The extension is updated with the new .soe file.