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.

CautionCaution:

This script tool is not intended for general use. This tool is intended specifically for the use of a Clip and Ship \ Data Extraction geoprocessing service. This tool can be used as part of a Clip and Ship model tool, such as the server model tool Extract Data Task. To create your own Extract Data tool which expands this tool's capabilities, you can copy this tool and its Python script into your project folder and modify it there. If you are only looking for simple tools to subset feature data without specifying selected layers, output format, and spatial reference, look in the Extract toolset or at the Clip tool.

Usage

Syntax

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

The Layers to be clipped. Layers should be either feature or raster layers.

Feature Layer; Raster Layer
Area_of_Interest

The area by which the layers will be clipped.

Feature Set
Feature_Format

The format in which the output features will be delivered.

The string provided in the Feature Format parameter should be formatted as follows:

  • Name or format - Short Name - extension (if any).
NoteNote:

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_R2006, DWG_R2007, DWG_R2010, DXF_R14, DXF_R2000, DXF_R2004, DXF_R2005, DXF_R2006, DXF_R2007, and DXF_R2010.

The formats described in the example are the supported default formats. Exporting to non-default formats is supported using Quick Export Tool and that requires the Data Interoperability extension be installed. The Data Interoperability extension is not installed by default with ArcGIS Desktop or ArcGIS Server. If you have the Data Interoperability extension installed, here are the instructions to add another format to the default listadd, remove or modify default list

LicenseLicense:
String
Raster_Format

The format in which the output raster datasets will be delivered.

The string provided in the Raster Format parameter 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
CautionCaution:

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 please read Technical Specifications for Raster Datasets.

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 Web Mercator
  • NAD 1983 HARN StatePlane Oregon North FIPS 3601
  • 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 file(s) 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 install Coordinate System folder.

Folder
Output_Zip_File

The output Zip File that will contain the extracted data.

File

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes

5/9/2011