Installing the IBM Application Modernization Accelerator Developer Tools extension for Visual Studio Code

Add the IBM® Application Modernization Accelerator Developer Tools extension to your Microsoft Visual Studio Code editor.

When you install the IBM Application Modernization Accelerator Developer Tools extension to Microsoft Visual Studio Code, Liberty Tools is automatically installed from the JetBrains Marketplace.

Compatibility

The extension is compatible with Visual Studio Code 1.86.x and later.

Installing the extension in a development container is not supported.

Installing the extension from the Visual Studio Marketplace

To install from the Visual Studio Marketplace:

  1. Open the IBM Application Modernization Accelerator Developer Tools page in the Visual Studio Marketplace.

  2. Click Install on the Marketplace page.

  3. In Visual Studio Code, click Install on the extension.

From the Visual Studio Code editor

To install from your Visual Studio Code editor:

  1. In your Visual Studio Code editor, click the Extensions icon.

  2. Search for IBM Application Modernization Accelerator Developer Tools.

  3. Select the extension you need, then click Install.

Opening the extension

To open IBM Application Modernization Accelerator Developer Tools:

  1. Open the project file context menu and click Modernize Java Applications and then either Modernize to Liberty or Upgrade Java Version.

  2. Open the Visual Studio Code command palette and select IBM AMA Dev Tools: Modernize to Liberty or IBM AMA Dev Tools: Upgrade Java Version.

Setting up your enterprise Java environment

If you want to work with enterprise Java™ applications, you need to set up your environment. For more information, see Setting up your enterprise Java environment.

Applying a license key for IBM Application Modernization Accelerator Developer Tools in Visual Studio Code

Before you can use IBM Application Modernization Accelerator Developer Tools in Visual Studio Code, you must establish your entitlement, either by uploading a valid migration plan., or by applying a license key file.

Uploading a valid migration plan

You can establish your entitlement by uploading a migration plan. This option requires a valid migration plan from IBM Application Modernization Accelerator.

  1. Open the Modernize to Liberty view.

    1. In the Explorer view, right-click an application that you want to modernize and select Modernize Java Applications > Modernize to Liberty.

    2. If you do not have entitlement for IBM Application Modernization Accelerator, a warning message appears at the top of the screen.

  2. Upload a migration plan.

    1. Click Upload migration plan.

    2. Select the migration plan in the file picker and click Open.

    3. Respond to the prompts for decisions in the Modernize to Liberty view to complete the process of modernizing the application.

Applying a license key file

You can establish your entitlement by applying a license key file.

  1. Open the Manage License Key panel.

    1. In Visual Studio Code, open the command palette and select IBM AMA Dev Tools: Manage License Key.

      If you do not have entitlement for IBM Application Modernization Accelerator, a warning message appears at the top of the screen.

    2. If you already have a license key file saved on your machine, click the Manage License Key link.

      If you do not have a license key file, click IBM Passport Advantage to download one based on your entitlement. For more information, see Obtaining a valid license key in the IBM Application Modernization Accelerator documentation. Save the license key file to your local computer; it should have a .lic file extension.

  2. Apply a license key file.

    1. Click Browse to locate your license key file (for example, AMA_License_Key.lic).

    2. Select the license key file in the file picker and click Select.

      A pop-up window appears the message License key successfully processed.

    3. Click OK.

Securing your setup

IBM Application Modernization Accelerator Developer Tools doesn't provide additional security controls. Use these steps to properly secure your setup.

Your Visual Studio Code environment

Apply all Visual Studio Code updates to help ensure that you have the latest security and bug fixes. For more information, see the Microsoft Documentation.

Using the Output view to see activity details

You can use the Output view of Visual Studio Code to see details about what the extension is doing and logging, and check for any errors.

To open the Output view:

  1. In Visual Studio Code, click View, then click Output.

  2. In the Output view, use the menu to select IBM AMA Dev Tools. It provides more details about what the plug-in is doing.

To adjust the Output view and logging for the Visual Studio Code extension:

  1. In Visual Studio Code, open the extension settings for IBM Application Modernization Accelerator Developer Tools.

  2. In IBM AMA Dev Tools: Log level, switch from the default of INFO to another setting, such as WARN.

Disabling or uninstalling the extension

If necessary, you can disable the extension and keep it installed, or you can uninstall it completely.

To disable or uninstall the extension:

  1. In Visual Studio Code, click the Extensions icon to open the panel.

  2. Click the IBM Application Modernization Accelerator Developer Tools extension.

  3. Click Disable or Uninstall.