Using an external capabilities file with a WPS service
In this topic
Each WPS service exposes service-level metadata through its capabilities file. The capabilities file is the XML response that clients receive when they make a GetCapabilities request to the service. Configuring an external capabilities file gives you the flexibility to do the following:
- Add metadata about the service.
- Add metadata about each service process.
To use an external capabilities file with a WPS service, you'll need to create the file and then configure the file for use with your WPS service. The sections below describe this process.
Note:
By using an external capabilities file for your WPS service, you must be responsible for validating your capabilities files against the DTD or XML schema from OGC. You also assume responsibility for all the synchronization between your capabilities file and the source data from which your WPS service is published.
Creating an external capabilities file
To configure a WPS service to use an external capabilities files, you must prepare a WPS capabilities file. You can create the file from scratch, but it's often easier to use a system-generated capabilities file as a template.
By default, the system-generated capabilities file is created automatically every time you send a WPS GetCapabilities request to the service. To use the system-generated capabilities file as a template, you need to manually send the GetCapabilities request and save the response as XML. Currently, 1.0.0 is the only WPS protocol version offered by OGC, so generating only one capabilities file is necessary.
Follow the steps below to create an external capabilities file for your WPS service.
- If you haven't done so already, publish a geoprocessing service and enable the WPS capability. For more information, see WPS services.
- In a web browser, enter the URL of your WPS service. The URL is formatted:
http://gisserver.domain.com:6080/arcgis/services/folder/service/GPServer/WPSServer
- Append ?request=GetCapabilities&version=1.0.0 to the end of the service URL and press Enter. The XML displayed in the browser is the WPS version 1.0.0 capabilities for your service.
- Save the results as an XML file. The file name must follow the format <prefix><WPS version>.xml. For example, when you save the result XML from a WPS version 1.0.0 GetCapabilities request, the file must use a common prefix (such as Roads) followed by the three-digit WPS version number (100). The resulting file is Roads100.xml.
- Configure and customize metadata information in the capabilities file.
- Move the capabilities file into a common folder that is accessible through HTTP. Typically, this will be a virtual directory on your organization's web server.
Configuring a WPS service to use external capabilities files
To configure your WPS service to use the external capabilities file, you'll need to update the WPS service to reference the URL of your capabilities file. You can do this in ArcGIS Server Manager or ArcGIS for Desktop.
In ArcGIS Server Manager:
- Open ArcGIS Server Manager and log in. If you need help with this step, see Logging in to Manager.
- Click Services > Manage Services.
- In the Manage Services module, locate your service and click Edit
. If you don't see your service in the list, it may be located within a subfolder under the Site (root) folder. - In the Edit module, click Capabilities.
- In the capabilities list, click WPS.
- In the WPS Configuration list, choose Use external capabilities files.
- In the Specify the location and prefix box, specify the URL of the folder where you placed your capabilities files plus the common prefix you used for the files. For example, if the URL to the folder that contains your files is http://webserver.domain.com/arcgis/WPS/services and the common prefix you used is Roads, then the URL you specify in the Specify the location and prefix box is http://webserver.domain.com/arcgis/WPS/services/Roads.
- Click Save and Restart.
In ArcGIS for Desktop:
- In ArcCatalog or the Catalog window in ArcGIS for Desktop, expand the GIS Servers node and establish an Administer GIS server connection type to ArcGIS Server. If you already have an Administer GIS server connection set up, you can skip this step. For instructions on how to connect, see Making an administrative connection to ArcGIS Server in ArcGIS for Desktop.
- Within your connection to ArcGIS Server, right-click your service and choose Service Properties.
- In the Service Editor, click the Capabilities tab.
- Click the WPS tab and select Use external capabilities files.
- In the Specify the location and prefix box, specify the URL of the folder where you placed your capabilities files plus the common prefix you used for the files. For example, if the URL to the folder that contains your files is http://webserver.domain.com/arcgis/WPS/services and the common prefix you used is Roads, then the URL you specify in the Specify the location and prefix box is http://webserver.domain.com/arcgis/WPS/services/Roads.
- Click OK.