Debugging API Project build in the z/OS Connect Designer

An error might occur when the API Project is automatically built within IBM® z/OS Connect Designer. The apiproject.log contains details of any errors that occur. The error detail might also recommend running the build with --info or --debug to get more log output to help in resolving problems.

Note: From 3.0.68, the environment variables IBM_ZOSCONNECT_GRADLE_DEBUG or IBM_ZOSCONNECT_GRADLE_INFO can be set to true to enable debug or information-level log outputs.

zosConnect-3.0 Applies to zosConnect-3.0.

Containers Applies to z/OS Connect container deployments.

About this task

The Gradle build for the API Project can be run manually with an integrated terminal. The additional Gradle arguments can then be included in the command to view full Gradle output in the terminal.

Procedure

  1. In a command line on the machine where z/OS Connect Designer container is running, run docker ps to find out the container ID.
  2. Attach a command prompt to the running container by running docker exec -it <containerId> bash in the command prompt.
    In this command containerId specifies the container ID from the previous step.
  3. Change directory into the API project by running cd /workspace/project.
    Note: You can use a different directory if you configured the project environment variable ZCON_DESIGNER_PROJECT.
  4. Use Gradle build <args> to run the Gradle build with more arguments. Replace <args> with any additional arguments for Gradle. The full Gradle output is written to the active terminal.
    For example, --info