Simple SOAP SOE

Purpose
This sample illustrates the basic framework for creating a server object extension (SOE) that will be accessed as an ArcGIS Server Simple Object Access Protocol (SOAP) Web service. The SOE extends the functionality of a map service with a single operation to echo input text.
This sample is divided into the following parts:
  • The SOE implementation, which receives SOAP messages, processes requests, and generates SOAP responses.
  • A simple desktop client to consume the custom SOE via SOAP.
All the information needed to deploy the SOE is included in this sample encapsulated in a .soe file. Deploying the SOE from this file does not require you to open Visual Studio. However, you can open the Visual Studio solution included with this sample to explore the coding patterns used in the SOE.
The instructions below assume that you have installed the developer kit on the machine running ArcGIS Server Manager. If you installed the developer kit on some other machine, you'll need to copy the .soe file to the machine running Manager, or otherwise make the .soe file visible to Manager by placing it in a shared folder.

How to use

See How to use ArcGIS samples for help on compiling, setting up the debugger, and running the sample. If the sample has associated data, you will find that the sample's zip file includes a "data" folder alongside the language folders. However, you will need to update the sample to point to the location of the data once you have extracted all the files.

Deploy the SOE
  1. Log in to ArcGIS Server Manager and click Site.
  2. Click Extensions.
  3. Click Add Extension.
  4. Click Browse and navigate to the .soe file, which by default is located at <ArcGIS DeveloperKit install location>\Samples\ArcObjectsNet\ServerSimpleSOAPSOE\CSharp\SimpleSoapSOE\bin\Debug\SimpleSoapSOE.soe.
  5. Click OK.

Enable the SOE on a service
  1. Start ArcMap and click File > Open.
  2. Browse to or type the location of USA.mxd, which is located in <ArcGIS Developer Kit Location>\Samples\data\Usa.
  3. Click File > Share As > Service.
  4. Click Save a service definition and click Next.
  5. Choose "No available connection" and check "Include data in service definition when publishing".
  6. Change the Server type to ArcGIS Server.
  7. Leave the Service name as USA and click Next.
  8. Choose a location where you want to save the service definition, then click Continue.
  9. Click Stage to create the service definition. In the success message, note the path of your service definition (.sd).
  10. Copy the USA.sd file to the machine running ArcGIS Server Manager.
  11. On the machine running ArcGIS Server Manager, log in to Manager and click Services.
  12. If necessary, click the Manage Services tab.
  13. Click Publish Service.
  14. Click Browse, browse to the location of USA.sd on the local machine, and click Open. Then click Next.
  15. Accept the default properties for the service by clicking Next.
  16. Click Publish. This creates the USA map service.
  17. On the Services tab of Manager, select the USA map service, then select Capabilities. In the list of available capabilities, find ".NET Simple SOAP SOE" and check the box to enable it. If there is a list of available operations allowed, select all of them.
  18. Click Save, then Restart to restart the service.

Use the SOE in a client application
  1. In Visual Studio, open the SimpleSoapClient<vs_version> solution (for example, SimpleSoapClient2010.sln). The <vs_version> references the Visual Studio version of the solution. The application contains a simple Windows form with a button and a text box.
  2. A Web Reference has been added to the project to reference the SOE SOAP endpoint hosted within the ArcGIS Server Web service instance. Open the code behind for Form1 (Form1.cs).
  3. In the click event for the button, change the URL property of the proxy instance to reference the HTTP URL to the map service created in the previous section, then append the path to the Simple SOE (for example: http://<server name>:6080/arcgis/services/USA/MapServer/SimpleSoapSOE), where USA is the map service name on which the Simple SOE has been enabled.
  4. Run the application, type text in the text box, and click Execute. The same text entered is returned from the SOE.

SimpleSoapSOE\SimpleSoapSOE.cs Core SOE implementation for the SOAP Web service
SimpleSoapSOE\bin\Debug\SimpleSoapSOE.soe The deployable SOE file
SimpleSoapSOAPClient\Form1.cs Code behind for desktop client used to consume SOE via a SOAP Web service
Download the C# files

Download the files for all languages