Home
Troubleshooting
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
Debugging failed Windows™ services
If one of the programs fails to start as a Windows™ service, it can be difficult to determine the cause. Typically the service fails to start but gives no indication of why. The Windows Event log has nothing useful and the process might not have created its log file.

Troubleshooting
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
- Troubleshooting: Installation and configuration
  You can troubleshoot some of the problems that you might encounter when you are installing, configuring, or running HCL OneTest™ API.
- Global problem notifications
  Problems can occur at a time when HCL OneTest™ API cannot display an error message. Instead, a warning icon is displayed. Double-clicking the icon reveals a list of errors.
- Working with HCL OneTest™ API logs
  To configure the HCL OneTest™ API logs, including those for the RunTest command when run from the command line, update the HCL OneTest API logging properties file.
- Working with HCL OneTest™ API Agent logs
  To configure the HCL OneTest™ API Agent logs, including those for the RunTests command when run from the command line, update the HCL OneTest API Agent logging properties file.
- Working with RQMAgent logs
  To configure the RQMAgent logs, update the RQMAgent logging properties file.
- Locating the logging properties files
  When you install HCL OneTest™ API, HCL OneTest API Agent, or HCL® Quality Server including the HTTP/TCP proxy, several logging properties files are added to each installation's home directory.
- Logging references
  You can use the following list of logging-related information to help you find information about the logs that are supported by HCL OneTest™ API. All of the programs use the Java logging framework. For details, see the Java logging framework documentation.
- Debugging failed Windows™ services
  If one of the programs fails to start as a Windows™ service, it can be difficult to determine the cause. Typically the service fails to start but gives no indication of why. The Windows Event log has nothing useful and the process might not have created its log file.
- Troubleshooting: Installation and configuration
  You can troubleshoot some of the problems that you might encounter when you are installing, configuring, or running HCL OneTest™ API.
- Troubleshooting: transports, tests, and resources
  Workarounds and solutions for transport diagnostics, creating and running tests, and saving and renaming objects are contained in this topic.
- Troubleshooting: HCL OneTest™ API Agent
  You can use workarounds to common problems that you might encounter when you install and run the HCL OneTest™ API Agent.
- Troubleshooting: HCL® Quality Server
  You can use workarounds to troubleshoot common problems that you might encounter when you use HCL® Quality Server.
- Troubleshooting: HCL OneTest™ Virtualization
  You can use workarounds to common problems that you might encounter when you use HCL OneTest™ Virtualization.
- Troubleshooting: Software AG webMethods
  You can use workarounds to problems that you might encounter when you use the Software AG webMethods.
- Troubleshooting: Websphere MQ
  You can use workarounds to problems that you might encounter when you use IBM® WebSphere® MQ with HCL OneTest™ API.
- Troubleshooting: WebSphere® Application Server
  You can use workarounds to problems that you might encounter when you use IBM® WebSphere® Application Server products with HCL OneTest™ API.
- Troubleshooting: WebSphere® Portal
  You can use workarounds to problems that you might encounter when you use IBM® WebSphere® Portal products with HCL OneTest™ API.
- Troubleshooting: TIBCO
  You can use workarounds to common problems that you might encounter when you are testing TIBCO products in HCL OneTest™ API.
- Troubleshooting: Java™ method transport
  You can use workarounds to common problems that you might encounter when you use the Java™ method transport of HCL OneTest™ API.
- Troubleshooting: Java™ applications that use JDBC
  You can use workarounds to problems that you might encounter when you test Java™ applications in HCL OneTest™ API.
- Troubleshooting: HTTP and Web Services
  You can use workarounds to common problems that you might encounter when you use HTTP and Web Services.
- Troubleshooting: TCP UDP sockets
  You can use workarounds to common problems that you might encounter when you use TCP and UDP transports.
- Troubleshooting: Testing on IBM® z/OS®
  You can use workarounds to common problems that you might encounter when you use IBM® z/OS® with HCL OneTest™ API.

Debugging failed Windows™ services

If one of the programs fails to start as a Windows™ service, it can be difficult to determine the cause. Typically the service fails to start but gives no indication of why. The Windows™ Event log has nothing useful and the process might not have created its log file.

The usual cause is that the listening port is already taken, or that the user who is associated with the service has insufficient permissions to write to files on the local system.

The Java™ services are started by using the Apache Commons daemon. For reference, see: Procrun Documentation.

Ask for assistance from your local Windows™ administrator during this process.

This example looks at HCL OneTest™ API Agent, but also works for the HTTP Proxy and HCL® Quality Server.

Run the service on the command line

Open the Windows™ Service and make a note of the name of it.
In this case, the name is OneTestAPIAgent.
Additionally, make a note of the user.
Open a command window in the Virtualization installation folder. Run the service as a console application:
```
prunsrv //TS//OneTestAPIAgent
```
If this command works, compare the permissions of the user who is logged in with the one configured in the service. You might be able to run the command as the other user:
```
runas /user:LOCALMACHINENAME\user "prunsrv //TS//OneTestAPIAgent"
```

Service Logging

It is possible to add low-level logging to the service itself. Run the following command:
```
prunmgr //ES//OneTestAPIAgent
```
Set the Level to Debug and configure the Log path folder name.
Restart the service and check the log files. Three log files are produced:
- commons-daemon.2017-09-22.log
- onetestapiagent-stderr.2017-09-22.log
- onetestapiagent-stdout.2017-09-22.log