How to consume custom tools in ArcGIS Desktop

Custom geoprocessing function tools can be accessed from and consumed in ArcGIS Desktop and Server after the tools are registered with ArcGIS. This topic describes how to import the custom tool in ArcGIS Desktop and execute it.

After placing the jar files containing your custom GP tools in the apprpriate environment, the tools can be consumed in ArcGIS Desktop or in a Java application using the ArcObjects Geoprocessing application programming interfaces (APIs). To consume a custom tool in ArcGIS Server, deploy the tool as described in the "Developing Extensions" -> "Custom Geoprocessing Tools" -> "Consume" -> "Building a custom geoprocessing tool in Eclipse IDE" topic and then consume it as REST or SOAP service. More details are provided in the Geoprocessing documentation in ArcGIS Resource Center.
To consume the custom geoprocessing tool in ArcGIS Desktop, perform the following steps:
  1. Open ArcMap or ArcCatalog application.
  2. Expand Toolboxes, in the Catalog window.
  1. Create a new toolbox in "My Toolboxes". Right click "My Toolboxes", and select "New" -> "Toolbox".

  1. Provide a name and press Enter and your toolbox is ready to add new/custom tools to.

  1. Right-click the new toolbox, click Add, and click Tool.
  2. In the Add Tool dialog box, select Custom JavaFunctionFactory (in the figure below, its called DFFunctionFactory), and click OK.
  1. To execute the tool in ArcToolbox, double-click the tool.
  1. View the tool's parameters in the dialog that pops up. The description of the tool and its parameters are displayed in the help window. The output feature is not shown in the tool dialog box since it is of parameter type derived.
  1. Click the Input Features open folder icon button and browse to the test data (for example, %ArcGIS Devkit Home%\java\samples\data\usa\states.lyr).
  2. Make a copy of the test data, since some features might be deleted.
  3. Click the SQL Expression icon button. The Query Builder dialog box opens.
  4. Build the query to select the features to be deleted.
  5. Click OK to execute the tool.
  6. Verify in ArcCatalog that the selected features were deleted.
You can also test the tool by consuming it in a Java application. For more information, see How to consume custom geoprocessing tools in Java applications.

See Also:

How to consume custom geoprocessing tools in Java applications

Development licensingDeployment licensing
Engine Developer KitEngine
ArcGIS for Desktop BasicArcGIS for Desktop Basic
ArcGIS for Desktop StandardArcGIS for Desktop Standard
ArcGIS for Desktop AdvancedArcGIS for Desktop Advanced