Configuring the IBM Bob Premium Package for Z extension

Edit online

Learn how to configure the IBM Bob Premium Package for Z extension.

Setting the Z Understand server address

Optionally, you can configure the Refactoring services URL using the following steps:

  1. Using the Command Palette:

    1. Open the IBM® Bob command palette by selecting View > Command Palette from the IBM Bob menu.
    2. Enter Preferences: Open User Settings in the command palette.
    3. Search for IBM Bob for Z to locate the extension settings.

    Using the Settings menu:

    1. In the Manage menu, select Settings to view the configuration settings.
    2. In the Search settings box, enter Understand to view all Understand configuration options.
  2. In Bob-z > Understand: URL, enter the URL of the Z Understand server or Refactoring services endpoint. For example, https://your-understand-server.com:9444.
  3. In the Accounts menu, select the Sign in with Z Understand to use IBM Bob Premium Package for Z option.
  4. When prompted, click Open to view the login page to sign in to the Z Understand server.
  5. Enter the server credentials. You are now logged in to the Z Understand server.

Managing certificates

If your Refactoring services uses an untrusted or self-signed certificate, you must add the refactoring-assistant-ui.crt from the Refactoring services to the trust chain of your operating system.
  • On MacOS, double-click the certificate to install it by using the Keychain Access tool. In the same tool, change the certificate’s trust setting to Always Trust.
  • On Windows, double-click the certificate to install it by using the Certificate MMC snap-in. For self-signed certificates, make sure that it is installed to Trusted Root Certification Authorities folder.
If the certificate is signed by intermediate or root certificate authorities that are unknown to the operating system, you must complete the following additional steps:
  1. Add the intermediate and root certificates to the trust chain of your operating system.
  2. Save the certificate chain as a file in PEM format, arranging the certificates' information in a hierarchical order so that the trusted root certificate details appear at the end of the file. Then, set the absolute path to the PEM file as the value of the Bob-z > Understand: Certificate setting.
Note: A certificate chain is a sequence of digital certificates where each certificate is validated by the subsequent one, connecting to a trusted root certificate. It ensures the authenticity of the certificate by linking it to a trusted authority.
Note: A PEM (Privacy-Enhanced Mail) format certificate is a Base64-encoded text file that contains cryptographic keys, certificates, or related information. It is commonly used for SSL certificates and has a file extension such as .pem, .crt, or .key.

Setting the authentication callback port

Z Understand authentication is processed in a web browser, which redirects to IBM Bob after login. The Bob-z > Understand > : Callback Port setting determines the local port to monitor for this redirect. To configure the callback port, complete the following steps:
  1. Open the IBM Bob Command Palette by selecting View > Command Palette from the IBM Bob menu.
  2. Enter Preferences: Open User Settings in the command palette.
  3. Search for IBM Bob for Z to locate the extension settings.
  4. Enter the local port that is available as the Bob-z > Understand: Callback Port property value. If you are using an earlier version of Z Understand, then verify the redirect port with your administrator.

Configuring the Z Open Editor MCP server

For information about configuring the Z Open Editor MCP server, see Set up for IBM Bob Premium Package for Z.