OUTPUT

OUTPUT

Used in: CONFIG REQUEST RESPONSE
Parent elements: EXTRACT IMAGE PROPERTIES

<OUTPUT	Attribute Description Table
When parent element is IMAGE, EXTRACT: *file ="string"* *url ="string"* height ="number" width ="number" When parent element is PROPERTIES and using the Extract Server: baseurl ="string" name ="string" path ="string" url ="string" When parent element is PROPERTIES and using the Image Server: baseurl ="string" legendbaseurl ="string" legendname ="string" legendpath ="string" legendurl ="string" name ="string" path ="string" type ="gif \| jpg \| png \| png8" [jpg] url ="string" > No child elements </OUTPUT >
Bold: Attribute or child element is required.

Description:

Defines pathname and URL for output map images, legend images, and ZIP files containing extracted shapefiles.

Restrictions:

Used only for Image Server and Extract Server.
When using GET_EXTRACT, the filename extension is restricted to *.zip. When using GET_IMAGE, filename extensions are restricted to *.jpg, *.png, or *.gif.

OUTPUT works with paired attributes. If one of the attributes is used, its pair is also required. The attribute pairs are listed in the table below.

Attribute	Paired Attribute	Filename Assignment
path	baseurl	ArcIMS assigns random filename.
name	url	User assigns a filename.
legendpath	legendbaseurl	ArcIMS assigns random filename.
legendname	legendurl	User assigns a filename.

When using an ArcIMS HTML Viewer, ArcIMS Java Viewer, ArcExplorer 3, or any other browser using the ArcIMS Servlet Connector, the OUTPUT element is restricted.
- In IMAGE and EXTRACT responses, the attribute file is not returned.
- In GET_IMAGE and GET_EXTRACT requests, OUTPUT is ignored.
- In map configuration files, OUTPUT is ignored and is not included in a SERVICEINFO response.
These restrictions can be lifted by setting the properties spatialServer.AllowRequestOutput and spatialServer.AllowResponsePath to true in esrimap_prop. This property file is found in the servlet engine directory. For more information on the location of esrimap_prop and its properties, see the topic "Administering the ArcIMS Servlet Connector" in the System Administration chapter of the Using ArcIMS Help Contents.

These restrictions apply only when the ArcIMS Servlet Connector is used. They do not apply to the ActiveX or ColdFusion Connectors or to other connectors using the ArcIMS Application Server Link.

Notes:

When not restricted, and OUTPUT is used in a map configuration file, the output file location overrides the location assigned when the MapService was started. If OUTPUT is used in a request, the file output location in the request overrides both OUTPUT in the map configuration file and the location assigned when the MapService was started.
If OUTPUT is used, the output files are not automatically deleted by ArcIMS Tasker. In order for the files to be deleted, the taskfile property must be set in tasker.properties. For information on setting this property, see the topic "Setting up ArcIMS Monitor and ArcIMS Tasker Property Files" in the System Administration: Administering Property Files chapter of the ArcIMS Help Contents.
When the information for a legend image name and/or location is included in OUTPUT, in order to generate a legend, the LEGEND element must still be included.
For more information on using OUTPUT, see Using GET_IMAGE and IMAGE and Using GET_EXTRACT and EXTRACT.

Attribute Descriptions for OUTPUT:

When parent element is IMAGE, EXTRACT:

Attribute	Usage	Back to Top
file	Full pathname and filename for location of map image generated by the ArcIMS Spatial Server. UNC pathnames are valid (\\myComputer\arcims\output).
height	If autoresize is used in a GET_IMAGE request, and the requested map is larger than the image memory limit, then the generated map is resized to fit within the image memory limit. In this case, the height of the output image is included in the IMAGE response.
url	URL used by client to retrieve map image.
width	If autoresize is used in a GET_IMAGE request, and the requested map is larger than the image memory limit, then the generated map is resized to fit within the image memory limit. In this case, the width of the image is included in the IMAGE response.

When parent element is PROPERTIES and using the Extract Server:

Attribute	Usage	Back to Top
baseurl	Paired with path. URL of output directory if default filename is generated by ArcIMS. Do not include a filename.
name	Paired with url. User assigns an output ZIP filename. Only filenames with a *.zip extension are valid. Use full pathname along with the filename. The filename must match the filename used in url. UNC pathnames are valid (\\myComputer\arcims\output\myfile.zip).
path	Paired with baseurl. Directory to output ZIP file generated by Extract Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
url	Paired with name. URL of output ZIP file. Include filename as part of URL. The filename must match the filename used in name.

When parent element is PROPERTIES and using the Image Server:

Attribute	Usage	Back to Top
baseurl	Paired with path. URL of output directory if default filename is generated by ArcIMS. Do not include a filename.
legendbaseurl	Paired with legendpath. URL of output directory if default legend filename is generated by ArcIMS. Do not include a filename.
legendname	Paired with legendurl. User assigns an output legend filename. Use full pathname along with the filename. The filename must match the filename used in legendurl. UNC pathnames are valid (\\myComputer\arcims\output\mylegend.jpg).
legendpath	Paired with legendbaseurl. Directory to output legend file generated by Image Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
legendurl	Paired with legendname. URL of output legend file. Include filename as part of URL. The filename must match the filename used in legendname.
name	Paired with url. User assigns an output filename. Use full pathname along with the filename. Only filenames with a .jpg, .png, or *.gif extension are valid. The filename must match the filename used in url. UNC pathnames are valid (\\myComputer\arcims\output\myfile.jpg).
path	Paired with baseurl. Directory to output file generated by Image Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
type	Output image file type.
url	Paired with name. URL of output file. Include filename as part of URL. The filename must match the filename used in name.

Examples for OUTPUT:

Example 1: When in a REQUEST.	Back to Top
<?xml version="1.0" encoding="UTF-8"?> <ARCXML version="1.1"> <REQUEST> <GET_IMAGE> <PROPERTIES> <ENVELOPE minx="-180" miny="-90" maxx="180" maxy="90" /> <IMAGESIZE width="643" height="502" /> <OUTPUT name="c:\arcims\myfile.jpg" url="http://mymachine.domain.com/myfile.jpg" /> </PROPERTIES> </GET_IMAGE> </REQUEST> </ARCXML>

Example 2: When in a RESPONSE with no restrictions on OUTPUT.	Back to Top
<?xml version="1.0" encoding="UTF8"?> <ARCXML version="1.1"> <RESPONSE> <IMAGE> <ENVELOPE minx="-80.00000000" miny="-56.00000000" maxx="80.00000000" maxy="56.00000000" /> <OUTPUT file="F:\WorldMap_MYMACHINE16114829.jpg" url="http://mymachine.domain.com/maps/WorldMap_MYMACHINE16114829.jpg" /> </IMAGE> </RESPONSE> </ARCXML>

Example 3: Map configuration file that includes OUTPUT information for both the image and legend. Name/url attribute pairs are used.

Back to Top

<?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" />
        <OUTPUT legendname="c:\arcims\website\legend.jpg" legendurl="http://mymachine.domain.com/website/legend.jpg" name="c:\arcims\website\map.jpg" url="http://mymachine.domain.com/website/map.jpg"  />
        <LEGEND title="Legend" font="Arial" columns="1" width="170" height="300" backgroundcolor="255,255,0" >
      </PROPERTIES>
      <WORKSPACES>
        <SHAPEWORKSPACE name="shp_ws-0" directory="<path to WORLD ESRIDATA>" />
      </WORKSPACES>
      <LAYER type="featureclass" name="CITIES" visible="true" id="4">
        <DATASET name="CITIES" type="point" workspace="shp_ws-0" />
        <SIMPLERENDERER>
          <SIMPLEMARKERSYMBOL color="102,0,102" width="8.0" />
        </SIMPLERENDERER>
      </LAYER>
    </MAP>
  </CONFIG>
</ARCXML>

Example 4: In a RESPONSE when autoresize is used in GET_IMAGE, and the image has been resized.	Back to Top
<?xml version="1.0" encoding="UTF8"?> <ARCXML version="1.1"> <RESPONSE> <IMAGE> <ENVELOPE minx="-180" miny="-135" maxx="180" maxy="135" /> <OUTPUT file="c:\arcims\output\world_MYMACHINE8236420.png" url="http://mymachine.domain.com/output/world_MYMACHINE8236420.png" width="591" height="443"/> </IMAGE> </RESPONSE> </ARCXML>

Example 5: When in a RESPONSE with OUTPUT restricted.	Back to Top
<?xml version="1.0" encoding="UTF8"?> <ARCXML version="1.1"> <RESPONSE> <IMAGE> <ENVELOPE minx="-80.00000000" miny="-56.00000000" maxx="80.00000000" maxy="56.00000000" /> <OUTPUT url="http://mymachine.domain.com/maps/WorldMap_MYMACHINE16114829.jpg" /> </IMAGE> </RESPONSE> </ARCXML>