OUTPUT

Used in

Servers

Image Extract

Parent elements

EXTRACT IMAGE LAYOUT METADATA_CONFIG PROPERTIES

Syntax

<OUTPUT	Attribute Description Table
When parent element is EXTRACT: *(r)url="string"* file="string" When parent element is IMAGE: *(r)url="string"* file="string" height="integer" type="gif \| jpg \| png \| png8" width="integer" When parent element is METADATA_CONFIG and using the Metadata Server: baseurl="string" path="string" When parent element is PROPERTIES in a map configuration file using in an Image Service: method="stream" When parent element is PROPERTIES in GET_EXTRACT: baseurl="string" name="string" path="string" url="string" When parent element is PROPERTIES in GET_IMAGE: 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 >
(r): Attribute or child element is required.

Description

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

Restrictions

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 GET_EXTRACT, the filename extension is restricted to *.zip. When using GET_IMAGE, filename extensions are restricted to *.bmp, *.jpg, *.png, *.gif, and *.tif.
When using an ArcIMS HTML Viewer, ArcIMS Java Viewer, ArcExplorer-Java Edition, or any other client using the ArcIMS Servlet Connector, the OUTPUT element is restricted.
- In IMAGE, EXTRACT, LEGEND, and LAYERIMAGE 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, spatialServer.AllowOutputTypeChange, and spatialServer.AllowResponsePath to True in esrimap_prop. This property file is found in the same directory as the ArcIMS Servlet Connector.

For more information on the location of esrimap_prop and its properties, see ArcIMS Help.These restrictions apply only when the ArcIMS Servlet Connector is used. They do not apply to the ActiveX, ColdFusion, or Java Connectors, or Web ADF's.
Image output can be streamed in Base64 encoded format and returned as part of the IMAGE response. This is an alternative to generating images in an output directory. The following restrictions apply:
- Valid only with Image Services.
- Valid only when using the Java Connector, Web ADF for the Microsoft .NET Framework, or Web ADF for the Java Platform. Streamed images are not supported with the ActiveX, ColdFusion, or Servlet Connectors.
- In the map configuration file, the following line must be included in the PROPERTIES section: <OUTPUT method="stream" />.
- When creating an Image Service in ArcIMS Administrator, the Directory Location and HTTP Location must both be filled out. A dummy location can be used rather than pointing to an actual directory.
In an IMAGE response, if an image is streamed, the attributes file and url are not included and are not required.
Known limit: When OUTPUT method="stream" and when SEPARATELAYER is requested with an invalid layer id, a malformed response is returned in the case where a map and/or legend was also requested. If the SEPARATELAYER with the invalid layer id is the only output image requested, an correct error message is returned.

Notes

When not restricted, and OUTPUT is used in a map configuration file, the output file location overrides the location assigned when the service 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 service 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 ArcIMS Help.
When an image is streamed, the stream is contained between the OUTPUT elements.
For more information on using OUTPUT, see Using GET_IMAGE and IMAGE with Image Services and Using GET_EXTRACT and EXTRACT.

Attribute Descriptions for OUTPUT

When parent element is EXTRACT:

Attribute	Usage
file	Full pathname and filename for location of ZIP file generated by the ArcIMS Spatial Server. UNC pathnames are valid (\\myComputer\arcims\output).
url	URL used by client to retrieve ZIP file.

When parent element is IMAGE:

Attribute	Usage
file	Full pathname and filename for location of map image generated by the ArcIMS Spatial Server. UNC pathnames are valid (\\myComputer\arcims\output).
height	Height in pixels. 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.
type	Returned when OUTPUT method="stream" in a map configuration file for Image Services. Valid only when the Java Connector, the Web ADF for the Microsoft .NET Framework, or the Web ADF for the Java Platform is used.
url	URL used by client to retrieve map image.
width	Width in pixels. 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 METADATA_CONFIG and using the Metadata Server:

Attribute	Usage
baseurl	Paired with path. URL of output directory if default filename is generated by ArcIMS. Do not include a filename.
path	Paired with baseurl. Directory to output file generated by the Metadata Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).

When parent element is PROPERTIES in a map configuration file using in an Image Service:

Attribute	Usage
method	Specifies that image output for an Image Service should be streamed in Base64 encoded format. Valid only with Image Services used with the Java Connector or Web ADF.

When parent element is PROPERTIES in GET_EXTRACT:

Attribute	Usage
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. 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 in GET_IMAGE:

Attribute	Usage
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 the Image Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
type	Output image file type. Can be gif, jpg, png8 (8 bit), png (24 bit).
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 RESPONSE with OUTPUT restricted.

<?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>

Example 2: When in a RESPONSE with no restrictions on OUTPUT.

<?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: In a RESPONSE when autoresize is used in GET_IMAGE, and the image has been resized.

<?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 4: When in a REQUEST.

Example 5: Request that includes OUTPUT information for both the image and legend. Name/url attribute pairs are used.

<?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 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>
    </GET_IMAGE>
  </REQUEST>
</ARCXML>

Example 6: When used in an IMAGE response and image is streamed using Base64 encoding.

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <RESPONSE>
    <IMAGE>
      <ENVELOPE minx="-180" miny="-135" maxx="180" maxy="135" />
      <OUTPUT type="jpg">/9j/4AAQSk ... ZJRgABZ</OUTPUT>
      <LEGEND type="jpg" >/9j/4AAQSkZJRgABAQA ... UDBAQEAZ</LEGEND>
    </IMAGE>
  </RESPONSE>
</ARCXML>