Troubleshooting the Helix ALM Test Management plugin for Jenkins issues
Use the following information to troubleshoot problems when using the Helix ALM Test Management plugin for Jenkins.
Viewing the Jenkins system log
The plugin writes messages to the Jenkins system log. View the log to help with troubleshooting.
1. From the Jenkins dashboard, click Manage Jenkins.
The Manage Jenkins page opens.
2. Click System Log.
The Log Recorders page opens.
3. Click All Jenkins Logs.
The log is displayed.
Common connection problems
The following error messages related to connection issues may be displayed when configuring or using the plugin.
| Error message | Troubleshooting tips |
|---|---|
| Cannot connect to the REST API server at <address>. | Make sure the specified REST API address is correct. Make sure the REST API server is running. Make sure the host computer running the Jenkins server can reach the REST API Server. Your computer may connect to the Jenkins host and REST API host, but the Jenkins host must connect to the REST API host. Make sure that the REST API is not using the same port in use by another application. |
| The SSL certificate used by the specified REST API server is invalid and cannot be used. | The SSL certificate is invalid and cannot be parsed by Java. Use a different certificate or upgrade the Helix ALM REST API to version 2022.2.0 or later. This error will likely be displayed if you are using a REST API Server that is version 2022.1.0 or earlier and have not customized the SSL certificate the REST API is using as a workaround to a Java issue. |
| The SSL certificate used by the specified REST API server is invalid. To use still connect to this server select the "Accept SSL certificates" and try again. | The specified REST API server is using an SSL certificate that is not valid. For example, it could be a self-signed or expired certificate. Make sure Accept SSL certificates is selected. |
| Cannot connect to the specified Helix ALM REST API server because it is an old version that is not supported. The REST API version must be 2022.2.0 or later. | The specified REST API server is old and needs to be upgraded to version 2022.2.0 or later. |
| The specified credentials are invalid. | Make sure that the specified Credentials are correct. If using an API key, make sure that the value in the in the Secret field contains the key ID and key secret in the following format: <KeyID>:<Key secret> |
| The specified user does not have permission to access any Helix ALM projects using the REST API. | Make sure the user specified in the Credentials has security permissions to use the REST API. The Allow Login Via SOAP security command must be enabled for the security group the user is in. |
Other common problems
Always check the following if problems with the plugin occur. Make sure that:
- The credentials are correct for the user specified to log in to Helix ALM.
- The user specified in the credentials has security permissions to use the REST API. The Allow Login Via SOAP security command must be enabled for the security group the user is in.
Specific troubleshooting tips
If you are experiencing any of the following problems with the plugin, make sure you check the information in Basic troubleshooting tips first.
| Problem | Other troubleshooting tips to use in addition to the basic tips |
|---|---|
| The Projects list is empty | Make sure the project exists on the Helix ALM Server. Make sure the user specified in the credentials is in a security group in the project. |
| The Automation suite list is empty | Make sure the selected Helix ALM project has at least one automation suite. |
| The Test run set field is empty. | Make sure the selected Helix ALM project has at least one test run set. |
| A build in Jenkins finishes, but cannot be submitted. The build status in Jenkins is Unstable. If the build started from Jenkins, no data is submitted to Helix ALM. If the build started from Helix ALM, the build status displayed in Helix ALM is Error or Finished - Results Unknown. | If the status is Error, the Helix ALM Server successfully started the build, but the connection to Jenkins to check the build status failed. Helix ALM repeats the connection request, but if it continues to fail, the build status is set to Error. If the status is Finished - Results Unknown, the Helix ALM Server successfully started the build and confirmed it ran and finished, but the Jenkins plugin did not submit results to the parent automation suite. Make sure the Helix ALM REST API Server is running and Jenkins can connect to it. |