Extract Data (Server)

Summary

Extracts selected layers in the specified area of interest to a specific format and spatial reference. The extracted data is then written to a zip file.

Caution:

This tool is intended primarily for use as part of a geoprocessing service. When using this tool as part of a geoprocessing service, copy the tool into a custom toolbox, edit the model, and reconfigure it as necessary. Because the geoprocessing service wizard is not available in ArcGIS Desktop, you have to save the contained toolbox as any supported previous version then publish it from ArcGIS Desktop of the same version of the toolbox. After publishing, you can connect to the server and use the service from ArcGIS Desktop.

Usage

  • A custom spatial reference name can be entered into the Spatial Reference parameter provided that the folder containing the custom spatial reference is specified in the Custom Spatial Reference Folder parameter.

Syntax

ExtractData(Layers_to_Clip, Area_of_Interest, Feature_Format, Raster_Format, Spatial_Reference, {Custom_Spatial_Reference_Folder}, Output_Zip_File)
ParameterExplanationData Type
Layers_to_Clip
[Layer,...]

The layers to be clipped. Layers must be feature or raster layers in the map's table of contents. Layer files do not work for this parameter.

Layer
Area_of_Interest

One or more polygons by which the layers will be clipped.

Feature Set
Feature_Format

The format in which the output features will be delivered. The string provided should be formatted as follows:

  • Name or format - Short Name - extension (if any)
The hyphen between the components is required, as well as the spaces around the hyphen.

For example:

  • File Geodatabase - GDB - .gdb
  • Shapefile - SHP - .shp
  • Autodesk AutoCAD - DXF_R2007 - .dxf
  • Autodesk AutoCAD - DWG_R2007 - .dwg
  • Bentley Microstation Design (V8) - DGN_V8 - .dgn

Internally, this tool uses the Export to CAD tool to convert data to the .dgn, .dwg, and .dxf CAD formats. The list of short names supported includes DGN_V8, DWG_R14, DWG_R2000, DWG_R2004, DWG_R2005, DWG_R2007, DWG_R2010, DXF_R14, DXF_R2000, DXF_R2004, DXF_R2005, DXF_R2007, and DXF_R2010.

String
Raster_Format

The format in which the output raster datasets will be delivered. The string provided should be formatted as follows:

  • Name of format - Short Name - extension (if any)

Any of the following strings will work:

  • Esri GRID - GRID
  • File Geodatabase - GDB - .gdb
  • ERDAS IMAGINE - IMG - .img
  • Tagged Image File Format - TIFF - .tif
  • Portable Network Graphics - PNG - .png
  • Graphic Interchange Format - GIF - .gif
  • Joint Photographics Experts Group - JPEG - .jpg
  • Joint Photographics Experts Group - JPEG - .jp2
  • Bitmap - BMP - .bmp
Caution:

Some of the above raster formats have limitations and not all data can be converted to the format. For a list of formats and their limitations, see List of supported sensors.

String
Spatial_Reference

The spatial reference of the output data delivered by the tool.

For standard Esri spatial references, the name you provide here should be the name of the desired coordinate system. This name corresponds to the name of the spatial reference's projection file. Alternatively, you can use the Well Known ID (WKID) of the coordinate system.

For example:

  • Sinusoidal (world)
  • WGS 1984 World Mercator
  • NAD 1983 HARN StatePlane Oregon North FIPS 3601 (Meters)
  • WGS 1984 UTM Zone 11N
  • 102003
  • 54001
  • If you want the output to have the same coordinate system as the input, then use the string Same As Input.

For any custom projection, the name specified should be the name of the custom projection file (without extension). The location of the custom projection files should be specified in the Custom_Spatial_Reference_Folder parameter.

String
Custom_Spatial_Reference_Folder
(Optional)

The location of any custom projection file or files referenced in the Spatial Reference parameter. This is only necessary if the custom projection file is not in the default installation Coordinate System folder.

Folder
Output_Zip_File

The zip file that will contain the extracted data.

File

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

Related topics