SERVICE

Used in

Application Server RESPONSE Application Server Administration

Parent elements

Syntax

<SERVICE	Attribute Description Table
When parent element is SERVICES in ADMINCMD while adding a Feature Service: *(r)axl="string"* *(r)name="string"* (r)type="add" *(r)vsname="string"* When parent element is SERVICES in ADMINCMD while adding an Image or ArcMap Image Service: *(r)axl="string"* *(r)cleanup="integer"* (r)imagememory="1-NNN" *(r)imgloc="string"* *(r)imgurl="string"* *(r)name="string"* (r)type="add" *(r)vsname="string"* imgtype="JPG \| PNG8 \| PNG \| GIF" [JPG] When parent element is SERVICES in ADMINCMD while removing, starting, or stopping an ArcIMS service: *(r)name="string"* (r)type="remove \| start \| stop" When parent element is SERVICES in Application Server RESPONSE: (r)access="PUBLIC \| PRIVATE" *(r)name="string"* *(r)servicegroup="string"* (r)status="ENABLED \| DISABLED" *(r)type="string"* (r)version="ArcMap \| [empty]" > When parent element is SERVICES in ADMINCMD: No Child Elements When parent element is SERVICES in Application Server RESPONSE: (r)<CLEANUP... /> (r)<ENVIRONMENT... /> </SERVICE >
(r): Attribute or child element is required.

Description

In an application server RESPONSE, SERVICE returns information for each ArcIMS service on the specified host or server.
When used in application server administration, SERVICE contains the information needed to start a service from a command line.

Notes

SERVICE inside of ADMINCMD is used to administer ArcIMS Spatial Servers from the command line. To do this, two files are used:
- An ADMINCMD XML file
- A batch file or script
The ADMINCMD XML file contains the instructions for adding, starting, stopping, and removing ArcIMS services. See the examples for proper construction of an ADMINCMD XML file.

On Windows, the batch file contains one line:

<jre directory>\java.exe com.esri.aims.admincore.cmd.Exec http://mymachine.domain.com Username Password file filename

Where:
- <jre directory>\java.exe is the location of a java.exe file. If the directory path has spaces, you must use quotes, for example, "C:\Program Files\arcGIS\ArcIMS\Jre\bin\java.exe"
- http://mymachine.domain.com is the host machine.
- Username is the user name for ArcIMS administration.
- Password is the password for ArcIMS administration.
- Filename is the full pathname and name of the ADMINCMD XML file, for example, c:\arcims\axl\admincmd.xml.
- Note: the parameter "file" must be included before the filename.
The above command can also be typed on the command line in lieu of using the batch file.

On UNIX, a script file is used. In the following example, note that the line beginning with "java -cp" is all one line:
#!/bin/csh

setenv JARHOME $AIMSHOME/Manager/lib
setenv AIMSHOST $argv[1]

java -cp $JARHOME/jaxp.jar:$JARHOME/parser.jar:$JARHOME/esri_mo10.jar: $JARHOME/esri_mo10res.jar:$JARHOME/arcims_admincore.jar:$JARHOME/arcims_admin.jar: $JARHOME/jcert.jar:$JARHOME/jnet.jar:$JARHOME/jsse.jar:$JARHOME/arcims_resadmin.jar com.esri.aims.admincore.cmd.Exec http://$AIMSHOST Username Password file $argv[2]

Where:
- $argv[1] is the hostname.
- $argv[2] is the name of the ADMINCMD XML file, for example, admincmd.xml.
- Username and Password are the username and password for ArcIMS adminstration.
- Note: the parameter "file" must be included before $argv[2].

Attribute Descriptions for SERVICE

When parent element is SERVICES in ADMINCMD while adding a Feature Service:

Attribute	Usage
axl	Full pathname to map configuration file.
name	Name of ArcIMS service. Service names are case sensitive.
type	Type of action on service.
vsname	Virtual Server name for assigning ArcIMS service.

When parent element is SERVICES in ADMINCMD while adding an Image or ArcMap Image Service:

Attribute	Usage
axl	Full pathname to map configuration file or ArcMap document.
cleanup	Interval for the number of minutes between the deletion of image files from the Output directory.
imagememory	Maximum size of map image allowed in megabytes. A one megabyte image is approximately 512 x 512 pixels, or 262144 pixels total.
imgloc	Full pathname to Output directory for generated map and legend images.
imgtype	Image format for the output map images.
imgurl	URL to Output directory for generated map and legend images.
name	Name of ArcIMS service. Service names are case sensitive.
type	Type of action on service.
vsname	Virtual Server name for assigning ArcIMS service.

When parent element is SERVICES in ADMINCMD while removing, starting, or stopping an ArcIMS service:

Attribute	Usage
name	Name of ArcIMS service. Service names are case sensitive.
type	Type of action on service.

When parent element is SERVICES in Application Server RESPONSE:

Attribute	Usage
access	Access type of the Virtual Server. PUBLIC means that the Virtual Server and ArcIMS service can be accessed directly by requests from a client. By default, Image, Feature, ArcMap, and Metadata Servers are public. When access is PRIVATE, Virtual Servers are accessed by redirecting requests from a public server to a private one. Private Virtual Servers include Geocode, Query, and Extract Servers.
name	Name of service running on host machine.
servicegroup	Virtual Server name to which the specified ArcIMS service belongs.
status	Identifies if service is currently running or not.
type	Virtual Server type to which the specified ArcIMS service belongs.
version	Value is "ArcMap" for ArcMap Image Services. Value is blank for all other service types.

Examples for SERVICE

Example 1: An ADMINCMD XML file for adding and starting an ArcIMS service from the command line.

<?xml version="1.0"?>
<ADMINCMD version="1.0">
  <SERVICES>
    <SERVICE type="add" name="world_image"
          axl="c:\arcims\axl\world.axl"
          vsname="ImageServer1"
          imgloc="c:\arcims\output"
          imgurl="http://mycomputer.domain.com/output"
          imagememory="4"
          cleanup="20"
          imgtype="JPG" />

    <SERVICE type="start" name="world_image" />

    <SERVICE type="add" name="world_arcmap"
          axl="c:\arcims\axl\world.mxd"
          vsname="ImageServerArcMap1"
          imgloc="c:\arcims\output"
          imgurl="http://mycomputer.domain.com/output"
          imagememory="4"
          cleanup="20"
          imgtype="JPG" />

    <SERVICE type="start" name="world_arcmap" />

    <SERVICE type="add" name="world_feature"
          axl="c:\arcims\axl\world.axl"
          vsname="FeatureServer1"
/>

    <SERVICE type="start" name="world_feature" />

  </SERVICES>
</ADMINCMD>

Example 2: An ADMINCMD XML file for stopping and deleting an ArcIMS service from the command line.

<?xml version="1.0"?>
<ADMINCMD version="1.0">
  <SERVICES>
    <SERVICE type="stop" name="world_image" />
    <SERVICE type="remove" name="world_image" />
  </SERVICES>
</ADMINCMD>

Example 3: When in an application server RESPONSE to GETCLIENTSERVICES.

<?xml version="1.0"?>
<ARCXML version="1.1">
  <RESPONSE>
    <SERVICES>
      <SERVICE name="world" servicegroup="ImageServerArcMap1" access="PUBLIC" type="ImageServer" version="ArcMap"  status="ENABLED" >
        <IMAGE type="JPG" />
        <CLEANUP interval="10" />
      </SERVICE>
      <SERVICE name="europe" servicegroup="ImageServer1" access="PUBLIC" type="ImageServer" version=""  status="ENABLED" >
        <IMAGE type="JPG" />
        <ENVIRONMENT>
          <LOCALE country="US" language="en" variant="" />
          <UIFONT name="Arial" />
        </ENVIRONMENT>
        <CLEANUP interval="10" />
      </SERVICE>
      <SERVICE name="usa" servicegroup="FeatureServer1" access="PUBLIC" type="FeatureServer" version=""  status="ENABLED" >
        <ENVIRONMENT>
          <LOCALE country="US" language="en" variant="" />
          <UIFONT name="Arial" />
        </ENVIRONMENT>
        <CLEANUP interval="10" />
      </SERVICE>
    </SERVICES>
  </RESPONSE>
</ARCXML>