OUTPUT

Used in

CONFIG  REQUEST  RESPONSE  

Servers

Image  Extract  

Parent elements

EXTRACT  IMAGE  LAYOUT  METADATA_CONFIG  PROPERTIES 

Syntax

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


Notes


Attribute Descriptions for OUTPUT


When parent element is EXTRACT:
AttributeUsage
fileFull pathname and filename for location of ZIP file generated by the ArcIMS Spatial Server. UNC pathnames are valid (\\myComputer\arcims\output).
urlURL used by client to retrieve ZIP file.

When parent element is IMAGE:
AttributeUsage
fileFull pathname and filename for location of map image generated by the ArcIMS Spatial Server. UNC pathnames are valid (\\myComputer\arcims\output).
heightHeight 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.
typeReturned 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.
urlURL used by client to retrieve map image.
widthWidth 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:
AttributeUsage
baseurlPaired with path. URL of output directory if default filename is generated by ArcIMS. Do not include a filename.
pathPaired 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:
AttributeUsage
methodSpecifies 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:
AttributeUsage
baseurlPaired with path. URL of output directory if default filename is generated by ArcIMS. Do not include a filename.
namePaired 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).
pathPaired with baseurl. Directory to output ZIP file generated by Extract Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
urlPaired 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:
AttributeUsage
baseurlPaired with path. URL of output directory if default filename is generated by ArcIMS. Do not include a filename.
legendbaseurlPaired with legendpath. URL of output directory if default legend filename is generated by ArcIMS. Do not include a filename.
legendnamePaired 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).
legendpathPaired with legendbaseurl. Directory to output legend file generated by Image Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
legendurlPaired with legendname. URL of output legend file. Include filename as part of URL. The filename must match the filename used in legendname.
namePaired 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).
pathPaired with baseurl. Directory to output file generated by the Image Server. Do not include the filename. UNC pathnames are valid (\\myComputer\arcims\output).
typeOutput image file type. Can be gif, jpg, png8 (8 bit), png (24 bit).
urlPaired with name. URL of output file. Include filename as part of URL. The filename must match the filename used in name.
Back to top 

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

Back to top