Getting Started

This help explains how you can use the IBM webMethods Package Registry web portal to browse and install modules that can enhance your webMethods projects.

What is IBM webMethods Package Registry?

IBM webMethods Package Registry is a set of repositories that reference both official IBM licensed modules and public packages for webMethods. The Package Registry enables you to use the webMethods Package Manager (wpm) command-line tool to add features to your integration projects.

You can use the wpm CLI tool and the Package Registry to add modules, such as the JDBC or SAP adapters, to the pre-built images that IBM provides at https://containers.webmethods.io/products, without using IBM webMethods Installer or IBM webMethods Update Manager.

The Package Registry web portal is available at https://packages.webmethods.io, and you can obtain the wpm command-line tool from IBM webMethods Installer or from the pre-built Docker images for Integration Server or Microservices Runtime available at https://containers.webmethods.io/products. You do not have to install the wpm client locally to browse the available packages in the Package Registry web portal.

For more information about wpm, see the IBM webMethods Package Manager CLI Reference guide.

Types of Package Repositories

The Package Registry provides two repositories:

If you do not see the package that you require in the ‘licensed’ repository, this might be because of licensing restrictions. Reach out to either your IBM webMethods representative or contact IBM support if you believe this is an error. Keep in mind that not all IBM webMethods modules have been migrated to the Package Registry yet.

Accessing the 'licensed' repository using the wpm CLI tool

The ‘licensed’ repository is private and only authorized users can use the wpm command-line tool to view or pull packages from this repository. You cannot input your Empower credentials directly in wpm. Instead, you must create an access token in the Package Registry web portal and use that token to authenticate your account. For example, you can use the following command to install the WmJDBCAdapter, authenticate your account using wpm, and install the WmJDBCAdapter package:

wpm install -ws registry-server -wr registry-name  -j token-value WmJDBCAdapter:optional-package-version
Important
IBM recommends that you keep your access token secret and store it in a secure way.

To create an access token in the Package Registry web portal

  1. In a web browser, navigate to https://packages.webmethods.io and use your Empower credentials to sign in.

  2. Navigate to Account Button > Settings and click Create.

  3. In Label enter a descriptive name for the token.

  4. Optionally, in Duration enter a number of days before the token expires. If you do not specify a value, the token does not expire.

    Important
    You can only copy the value of the token immediately after you create it. If you navigate away or refresh the page, you can no longer copy the token.

Downloading a Package Using Package Registry

Depending on your preferences, you can download a package in one of the following ways:

To download a package from the Package Registry web portal

  1. In a web browser, navigate to https://packages.webmethods.io and use your Empower credentials to sign in.

  2. Select a registry and click the name of the package you want to download.

    Tip
    Use the search bar at the top of the page or click one of the out-of-the-box filter categories to find a specific package or to refine the list of packages displayed on the page.
  3. Optionally, use the drop-down menu to select a specific version of the package.

  4. Click Download Button to view the Package Manifest and Git Info details for the selected version of the package.

  5. Use one of the following ways to download the package:

    • Click Download Button to download the package to your file system.
    • Click Copy Button to copy a wpm command which pulls and installs the package into your integration project.