EXTRACTPARAMS

Used in

Servers

Extract

Parent elements

Syntax

<EXTRACTPARAMS	Attribute Description Table
clip="true \| false" [false] codepage="string" > <OUTPUTFILE... /> </EXTRACTPARAMS >

Description

Provides the structure for setting up parameters for shapefiles generated with the Extract Server.

Notes

In order to allow GET_EXTRACT requests on an ArcIMS service, the extract EXTENSION must be included in the map configuration file with at least one layer. As part of the extension, EXTRACTPARAMS is required and OUTPUTFILE and OUTPUTFIELD are optional.
In order to allow clipping for a layer in a map configuration file, EXTENSION and EXTRACTPARAMS must be included, and clip must be set to "true".
For more information on using the Extract Server, see Using GET_EXTRACT and EXTRACT.

Attribute Descriptions for EXTRACTPARAMS

Attribute	Usage
clip	Determines whether features are clipped at the current extent boundary in the viewer. If no clipping is used, features partially within the envelope are extracted in their entirety. If clipping is used, features are extracted based on the current extent boundary. Note that none of a layer's database values are prorated for any clipped features.
codepage	When codepage is used, all text fields in the extracted DBF file are encoded in the given codepage, and the codepage value is stored in a CPG file. The CPG file is included in the ZIP file. If no codepage value is used, no CPG file is generated, and the sytem default codepage is used to encode text fields in the DBF file.

Examples for EXTRACTPARAMS

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>
      <LOCALE country="US" language="en" variant="" />
      <UIFONT color="0,0,0" name="Arial" size="12" style="regular" />
      <SCREEN dpi="96" />
    </ENVIRONMENT>
    <MAP dynamic="true">
      <PROPERTIES>
        <ENVELOPE minx="-180.0" miny="-90.0" maxx="180.0" maxy="90.0" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
        <FILTERCOORDSYS id="4326" />
        <FEATURECOORDSYS id="4326"/>
      </PROPERTIES>
      <WORKSPACES>
        <SHAPEWORKSPACE name="shp_ws-2" directory="<path to USA ESRIDATA>" />
      </WORKSPACES>
      <LAYER type="featureclass" name="STATES" visible="true" id="States">
        <DATASET name="STATES" type="polygon" workspace="shp_ws-2" />
        <EXTENSION type="Extract" >
          <EXTRACTPARAMS clip="true" />
        </EXTENSION>
        <SIMPLERENDERER>
          <SIMPLEPOLYGONSYMBOL filltype="solid" fillcolor="255,0,0" />
        </SIMPLERENDERER>
      </LAYER>
      <LAYER type="featureclass" name="CITIES" visible="true" id="35">
        <DATASET name="CITIES" type="point" workspace="shp_ws-2" />
        <SIMPLERENDERER>
          <SIMPLEMARKERSYMBOL color="102,0,102" width="8.0" />
        </SIMPLERENDERER>
        <SPATIALQUERY where="POP1990 > 100000" subfields="CITY_NAME STATE_NAME POP1990 MALES FEMALES"  />
        <EXTENSION type="Extract" >
        <EXTRACTPARAMS clip="true" >
          <OUTPUTFILE file="us_cities" >
            <OUTPUTFIELD name="CITY_NAME" alias="City" />
            <OUTPUTFIELD name="STATE_NAME" alias="State" />
            <OUTPUTFIELD name="POP1990" alias="Population" />
            <OUTPUTFIELD name="MALES" alias="Male_pop" />
            <OUTPUTFIELD name="FEMALES" alias="Female_pop" />
          </OUTPUTFILE>
        </EXTRACTPARAMS>
        </EXTENSION>
      </LAYER>
    </MAP>
  </CONFIG>
</ARCXML>