Troubleshooting for User Build

Nothing happens when "Run IBM User Build" option is clicked

Possible reasons

This issue can occur if Z Open Editor cannot find a proper Java™ SDK to start Language Server Protocol. Make sure Z Open Editor is using a valid Java SDK. Follow instructions on configuring Java in the Getting started.

Local copybooks or includes for a file are not found

Possible reasons

• Copybooks or Includes cannot be found by the user build.

  Make sure IBM Z® Open Editor property groups are set up so that it can locate copybooks or include files. Details on configuring property groups are available in Setting property groups. To test whether a copybook can be resolved, open a program file in the editor and move your mouse cursor over the copybook or include file name. If a preview appears, it means the copybook or include is resolved successfully.

• IBM Z Open Editor Language Server protocol did not resolve copybooks for the user build.

  • Try closing and reopening the COBOL, PL/I, or HLASM file.
  • Try reloading the editor. In VS Code, open the command palette by pressing Ctrl+Shift+P and search for >Developer: Reload Window. Click the command to execute it.

User Build gets stuck executing an SSH command when using z/OSMF

An example output is as follows:

...
Using ssh profile myZoweSSHProfile
Using zowe profile myZoweCLIProfile
Executing ssh command:
 mkdir -p /u/user/projects/wazi-sample/COBOL

Possible reasons

You are not authenticated through a firewall. If a firewall protects your z/OS® instance, make sure you are authenticated. Verify that you can issue Zowe™ SSH commands with your SSH profile. See the examples in the Zowe doc site.

User Build gets stuck after Fetching build file dependencies...

Possible reasons

This issue can occur if the language server fails to fetch dependencies. Try reloading the window. In VS Code, open the command palette by pressing Ctrl+Shift+P and search for >Developer: Reload Window. Then run User Build again.

User Build cannot find the ZAPP dbb profile and prints Required setting is missing for all ZAPP settings

Possible reasons

This error might occur for several reasons:

• Reason 1: Your ZAPP file is invalid. Ensure that the ZAPP file is valid. Review the IBM Z Open Editor Output log for more information.
• Reason 2: An invalid profile is defined under the dbbDefaultZappProfile VS Code User setting. Leave this setting blank so that User Build selects the first defined profile, or specify an existing valid profile.
• Reason 3: If none of the above applies, try reloading the VS Code window. In VS Code, open the command palette by pressing Ctrl+Shift+P and search for >Developer: Reload Window. Then run User Build again.

Could not automatically get active VS Code workspace folder for this file error

Trying to run a user build on a file produces the following error:

Could not automatically get active VS Code workspace folder for this file. Make sure you are running User Build from a file that belongs to an active workspace opened locally in your editor. You can also define the localWorkspacePath setting to resolve this issue.

Possible reasons

This error might occur for the following reasons:

• Reason 1: You are running a user build on a file that does not belong to an active workspace in VS Code. Make sure you import your project into VS Code properly.

  To add a folder to the workspace, select File > Add Folder to Workspace and choose your project folder.

• Reason 2: The active file was not detected by VS Code because another window has focus. For example, if you have an active terminal open in VS Code, it can take focus away from the editor. Close other windows and terminals, then try again.

All configured authentication methods failed when using z/OSMF and SSH

Using ssh profile myZoweSSHProfile
Using zowe profile profile myZoweCLIProfile
Identified local root workspace path as c:\Users\zopeneditor-sample
Running setup to build c:\Users\zopeneditor-sample\COBOL\SAM1.cbl program.
Executing ssh command:
 mkdir -p /u/user/zopeneditor-sample
An error occurred: All configured authentication methods failed

Possible reasons

• This error occurs when the Zowe SSH profile is not valid. Ensure that the profile has the correct host, user name, password, and port defined.

  Run the following command to test whether the profile is valid. Replace the command inside the quotes with your own command:

  zowe uss issue ssh --ssh-profile myZoweSSHProfile "mkdir -p /u/user/zopeneditor-sample"
  

• This error occurs when the Zowe CLI profile is not valid. Verify that you can execute Zowe CLI commands using that profile.

To run a user build, ensure that a Zowe profile is created and defined in settings. If no credentials are found for the profile during the initial run of an IBM User Build, you are prompted to enter your credentials for the z/OS connection. Both the Secure Credential Store plug‑in and plain text credentials are supported.