Analysis Server Protocol

The Analysis Server provides a low-level interface that lets you send commands to it directly. Use of the Analysis Server Protocol is often automated through a higher level tool such as ModelCenter, but it is also useful when interacting directly with the Analysis Server to debug components. Most developers will find one of our client libraries much more useful than the low-level Protocol. There is a Java API documented in this help file in the package com.phoenix_int.aserver.client.

The easiest way to access the low-level interface is to telnet to the Analysis Server using a command such as the following:

telnet <host> 1835

This command will open a telnet session to an Analysis Server running on host. The default port is 1835.

There are two modes that can be used. By default the connection is in "human readable" mode, which is convenient for testing and debugging but less powerful than "Raw Mode".

The following commands are available from the direct interface to the Analysis Server.

Command	Description
addProxyClients	Adds a host ID to the list of client hosts in the proxy chain between client and server.
describe	Describes a published component
end	Unloads a component instance
execute	Runs a component instance
get	Gets the value of a variable
getIcon	Gets the icon data for a published component
getLicense	Retrieves Analysis Server's license agreement
getStatus	Lists the run status of all component instances
getSysInfo	Retrieves information about Analysis Server and the system it is on
getVersion	Gets the version and build number for Analysis Server
heartbeat	Starts up socket heartbeating in order to keep sockets alive through firewalls with timeouts
help	Help on Analysis Server commands
invoke	Invokes a method on a component instance
listArrayValues	Lists all the values of an array variable
listCategories	Lists all the sub-categories available in a category
listComponents	Lists all the components available in a category
listGlobals	Lists all component instances in the global namespace
listMethods	Lists all methods available on a component instance
listMonitors	Lists all available monitorable items on a component instance
listProperties	Lists all available variables and their sub-properties on a component instance or sub-variable
monitor	Starts a monitor on a raw output file or available monitor
moveObject	Moves or renames a component instance
ps	Lists all running processes for a component instance.
quit	Close the connection
set	Sets the value of a variable
setMode raw	Sets the connection into "raw" mode
start	Creates a new component instance
versions	Lists the version history of a component

See also Analysis Server