About the Console Client

LegacyLegacy:

ArcGIS 10 is the last release of the stand-alone ArcGIS Image Server product. The image service definition (.ISDef) has been replaced by an improved geodatabase data model—the mosaic dataset—which can be published as an image service using the ArcGIS Server Image extension.

Console Client is a tool that enables command line requests to be made to the server and service provider. These can be scripted to automate requests for imagery. Clients can interactively type commands in the text area (black area) in Console Client. The commands are issued to the server or service provider. To open the Console Client window, click Start > Programs > ArcGIS > Image Server > Console Client 10.

Console Client

The Console Client user interface includes the following components:

The Console Client user interface contains the following buttons:

There are different commands that can be run on Console Client. The syntax for these commands is listed in the table.

Command

Description

Parameters

Init.Client

Initializes the ArcGIS Image Server Client. Should be done automatically if this is not the first command that you are running. This command can be run as part of a script.

None

Open.Server

Opens the specified image server.

Server Name

List.Services

Lists available services running on the opened server and displays an error message if server is not running.

None

Open.Service

Opens the specified service. The service should be listed on the server. You can also open a service not running on a server as an .ISDef file. You can also open an .ISRef file that contains references to a service.

Source

Set.OutputImage

Sets the path of the output image. If the path is not set, the default location for Windows Server 2003 and Windows XP—C:\Documents and Settings\<user login>\My Documents\ESRI\Image Server\ConsoleClient\—is taken. In Windows Vista, Windows Server 2008 and Windows 7, C:\Users\<username>\Documents\ESRI\Image Server\ConsoleClient\ is taken as the default location of the output image.

Path

Set.Script

Exits the current script and starts running the newly defined script. Loads the current report if the path is not defined.

Path

Set.OutputReport

Defines the name of the output report file. If no parameters are specified, the output path is set as undefined and no reports are output. If defined, details written to the Command Prompt window are also output to the specified report file. If an existing file is defined, a report with the following name is created: reportPath_YYMMDDHHSS.XXX, where XXX is the extension from report path.

NoteNote:

The report file is formatted such that it can be used as an input script.

Set.OutputMetaData

Writes the metadata to the specified file. If the path is not defined, by default, metadata is output to the same location as that of the output image. The name of the file is the same as the image name but with an .xml extension.

Path

Get.Image

Gets the image with the specified area of interest (AOI) from the current service. The image is output to the file, the display, MetaDataoutput, and/or HistStatscomputed based on the set current parameters. If FileName is not defined, the name Image is used. Existing files are overwritten.

Min X, Min Y, Max X, Max Y, Number of Columns, Number of Rows, FileName

Process.Run

Executes an external command with optional command line arguments.

Arguments

Show.AboutBox

Displays the Console Client About box.

Gen.RandomAOIs

Creates a set of random requests within the extents of the image service.

  • N is the number of requests to make. 0=infinite.
  • NCols,NRows is the size of the request (may not be <1).
  • Wait is an optional wait time in seconds between each request; can be 0.
  • MinWidth is the minimum request width (may not be <=0). If Undefined, then set as BasePixelSize*NCols.
  • MaxWidth is the maximum request width (must be >= MinWidth). If undefined, set as MinWidth*10.
  • The report file should include the requests made; without a >.

Minimum Width, Maximum Width, Number of Columns, Number of Rows, Count

Set.OutputImageFormat

Sets the format of the image to be output.

  • Format (TIFF or JPEG 2000. TIFF is generally the most efficient.)
  • Compression Quality (Value of 100% is the best quality; however, it affects the total size the least. A value of 1% would result in the smallest transmission size.)
  • Tile Size (A value of 0 means none are tiled. Using tiled images provides faster access to large rasters.)

List.ServiceInfo

Lists all the information related to a service.

Wait

Delays or pauses the execution for the specified duration.

Duration

Help

Shows help for all commands.

Exit

Closes all connections and shuts down the application.

Console Client syntax

Related Topics


4/18/2011