Welcome to December’s new Server Blog in which we will be discussing the AR System Java Driver
The driver program which is delivered as a Java program and includes source, is a great API learning/reference tool for AR System API users. The driver program provides a command line interface for calling every API function, and viewing return values.
Use cases can include:
- Quick prototyping
- API testing
- Running simple batch jobs
- AR server connection testing
It also includes outputs for every data structure in the API, making it a useful manual debugging tool. The driver program is interactive and 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 would make in your custom API programs.
A driver script typically begins with below commands:
- Init (initializes the user session)
- Log (gathers the login information)
- authentication string =
- login = <your login>
- password = <your password>
- locale =
- timezone =
- server = <your AR Server>
- ssp ("set server port" is optional and provides the TCP when needed)
- specific TCP port = <your TCP port>
- private queue =
- ver ("verify user" validates that the user correctly logged in)
A driver script ends with below commands:
- term (terminates the connection and logs the user out)
- q (quits the session and exists drivers)
To know the full list of command on this tool type the commands ‘?’ or ‘h’ and check documentation related, where you will be able to find the command with their purpose.
Examples of the use of the Java Driver utility
- Get a list of groups that a user belongs to with GLG command.
- Find out what the FQDN of AR Server is with GSI command.
- Test a run process command like an Application-Business-Time-Add2. If you think you got bad results in workflow, you can test it manually with different values using the PROC command in driver.
- Perform a SQL statement like the one we do to check if Oracle Case Insensitivity is enabled. And then perform a SQL to see it return Case Insensitive results.
In the below example we can confirm that user Demo is able to log into the system and user is receiving Admin privileges. This could help us to confirm rights that users are receiving when login.stats. The command used is ver.
In next example the command glg (GetList Group) was used to confirm groups that a user ‘Allan’ belongs
Basically, Java Driver utility can be used to see the behavior of your API calls in your system and is very useful to anticipate and resolve problems you may have. When Java Driver utility is launched there is a list of basic commands than can be used. In case more information is needed Please check below link for official documentation
Reference for additional information.
- Create API Programs