Installing IBM Engineering Workflow Management client for Microsoft Visual Studio IDE

The Engineering Workflow Management client for Microsoft Visual Studio IDE is distributed as a downloadable file via the IBM® Installation Manager.

Before you begin

  • The Engineering Workflow Management client for Microsoft Visual Studio IDE requires .NET Framework version 4.7.2 or higher.
  • For Visual Studio 2022 IDE, you must install Engineering Workflow Management client for Microsoft Visual Studio 2022 IDE.
  • For other supported Visual Studio IDE versions, you must install Engineering Workflow Management client for Microsoft Visual Studio IDE.
  • The supported operating systems are Windows 10 and Windows 11.
  • Ensure that you have Microsoft Edge Chromium Evergreen Runtime installed on your machine. You can install the most recent Microsoft Edge Chromium Evergreen Runtime from here.
Note:
  • Windows 10 (all editions) includes the .NET Framework 4.6 and Windows 11 includes the .NET Framework 4.8 as an OS component and it is installed by default.
  • When you are facing any issue with Microsoft Edge WebView2 Runtime installation, check whether you have any previous versions of Microsoft Edge WebView2 Runtime that are downloaded by Windows Update, which are pending installation. If so, install those updates first before installing the Microsoft Edge WebView2 Runtime through the evergreen installer.

Procedure

  1. Download one of the following installation packages.

    There are three methods to install the Engineering Workflow Management client for Microsoft Visual Studio IDE.

    • Client CD Contents .zip file - IBM Installation Manager local install for client: This archive file contains the IBM Installation Manager launchpad and a local copy of the Engineering Workflow Management client for Microsoft Visual Studio IDE. The benefit of using the local install package is that it allows the installation to proceed without an Internet connection. This is a .zip file that is not self-extracting .
    • IBM Installation Manager web install for client, server, and optional components: This archive file contains the IBM Installation Manager launchpad program and the predefined installation repository locations. This is a self-extracting file that will start the IBM Installation Manager launchpad program after extracting the contents. The benefit of using the web installation package is that it reduces the initial download and the installation process only downloads the resources that you choose to install.
      Note: The web install requires an Internet connection during the installation process.
    • Full DVD Contents .zip file: This archive file contains the IBM Installation Manager launchpad and a local copy of all the installable resources. The benefit of using the local install package is that it allows the installation to proceed without an Internet connection. This is a .zip file that is not self extracting.
  2. Start the launchpad. You must have administrator privileges to run the launchpad.

    If IBM Installation Manager is not already running, complete the following steps to start it.

    • If you are using the Client CD Contents .zip file, extract the contents of the archive into a temporary directory and run the launchpad.
      • Open a command prompt and change to the directory where you extracted the .zip file to, and enter launchpad.
    • If you are using the Full DVD Contents .zip file, extract the contents of the archive into a temporary directory and run the launchpad.
      • Open a command prompt and change to the directory where you extracted the .zip file to, and enter launchpad.
  3. Click Install an IDE client, and then click IBM Engineering Workflow Management - client for Microsoft Visual Studio IDE.
    The IBM Installation Manager wizard is displayed. The wizard guides you through to install the client.
  4. Start Microsoft Visual Studio to work with the Engineering Workflow Management client for Microsoft Visual Studio IDE.
  5. Optional: Select Jazz® Source Control as your default source control system:
    1. From the menu, click Tools > Options.
    2. In the Options window, expand Source Control and click Plug-in Selection.
    3. On the Plug-In Selection page, from the Current source control plug-in list, select Jazz Source Control.
    4. Click OK.
    Note: Before you attempt to uninstall the Engineering Workflow Management client for Microsoft Visual Studio IDE, ensure that Microsoft Visual Studio is installed.
  6. Connect to the server.
    The easiest way to connect to a server is using the Team Invitation. If you do not have an invitation, you can connect manually.
    1. Click File > Accept team invitation. The wizard guides you through the process.
      Note: If you do not have an invitation, you need the URI or URL from your server admin. (An example format is https://example.com:9443/jazz). Click the connecting to an existing project area hyperlink that appears in the Accept Team Invitation window.
    2. Follow the instructions in the wizard to set up your connection.
      Note: IBM Engineering Workflow Management supports TLS v1.2 and TLS v1.3, you can change the TLS configuration from the Microsoft Visual Studio IDE preferences.

Example

Troubleshooting: Here are some suggested problem management techniques.
  • Start with an empty sandbox.
  • Check that the client and server versions match.
  • Check that the server is running. Confirm by using the status URL; for example, https://example.com:9443/jts.