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 BMC Remedy 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
- Make sure your BMC Remedy AR System server is running.
- For Windows, double-click the driver.exe icon. For UNIX, change directories to the ARInstallDir/api/src/driver directory and type
driverat the prompt.
- Specify the login parameters with the
Use an Administrator login so that you have administrative privileges. Demo is the default system administrator.
- Initialize an API session with the
- Type the abbreviation of the function call at the command line, and supply the appropriate input parameter values. (For a list of abbreviations, type:
When you are working with the specific commands, see BMC Remedy AR System C API functions to enter the appropriate values for the function parameters. Also, if you are working with specific entries, use leading zeros to see the entry ID of those entries.
The driver program is provided as sample code and is not a supported BMC Remedy AR System utility.
Use the following information to understand how to use print.C routines, use the driver program from the command line, and create and use driver scripts: