Extract Data Task (Server)

Summary

Extracts the selected layers in the specified area of interest to the selected formats and spatial reference, then returns all the data in 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

  • The drop-down for the Feature Format and Raster Format parameters contains a list of default formats. These default formats are set from the Value List filter on the Parameters tab of the model Properties.

  • You can add, modify, or remove the list of formats for either the Feature Format parameter or the Raster Format parameter. You will have to copy this model to your own custom toolbox before making any changes.

    1. Right-click a copied version of this tool and select Properties.
    2. In the properties dialog box that appears, click the Parameters tab.
    3. Find the parameter of interest in the table of parameters. On the right side of the table click Ellipsis to bring up its value list. The set of default formats should be listed.
    4. Add, modify, or remove formats from the list as desired. The string you provide needs to be delimited as: Name of format - Short Name - Extension. The hyphens are required and there must be one space before and after the hyphen.
    5. Click OK to apply the changes and exit.

Parameters

LabelExplanationData Type
Layers to Clip

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

Some of the above raster formats have limitations and not all data can be converted to the format.

String
Output Zip File

The zip file that will contain the extracted data.

File

arcpy.server.ExtractDataTask(Layers_to_Clip, Area_of_Interest, Feature_Format, Raster_Format, Output_Zip_File)
NameExplanationData 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
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