This documentation supports the 21.3 version of Action Request System.

To view an earlier version, select the version from the Product version menu.

Using the driver program

The driver program provides a command line interface for calling every API function, and viewing return values. On a Windows installation, the driver program is installed in the Api\driver directory under the server directory. For Linux and UNIX installations, it is installed in the api/src/driver directory under the server directory.

It also includes print routines for every data structure in the API, making it a useful manual debugging tool. The driver program is not interactive, but you can use it to log in to the  AR System server and observe the results and behavior of the equivalent function calls that you make in your API programs.

After compiling the source code or locating the prebuilt program supplied with the API, you can use driver for a number of purposes:

  • To identify function input parameters and load them with appropriate values
  • To examine the content and structure of function output parameters
  • To experiment with different parameter values

To use the driver program

  1. Make sure your AR System server  is running.
  2. Open the javadriver.bat file located in the <ARSystem_Installation_Home>\Arserver\api\lib\ directory. 
  3. Initialize an API session with the init command.
  4. Specify the login parameters with the log command.
    Use an Administrator login so that you have administrative privileges. Demo is the default system administrator.
  5. Specify the server port using the ssp command.
  6. Use the ver command. The ver command checks if the information provided is correct and the Java driver is connected to the AR System server .
  7. Type the abbreviation of the function call at the command line, and supply the appropriate input parameter values. (For a list of abbreviations, type: ? )

For more information about programming with JAVA API, see Programming with the Java API.


The driver program is provided as sample code and is not a supported AR System utility.

Related topics

Using the driver program from the command line

Creating and using driver scripts

Was this page helpful? Yes No Submitting... Thank you