Adding packages

You can add your own webMethods packages that are stored in an external repository to a project and use it along with other assets in the project.

Before you begin

  • Make sure that you have the GitHub account details to access the repository where the packages are available.
  • Before exporting the packages created in webMethods Service Designer, make sure of the following details.
    • Enable auditing for each service that you want to monitor in the Monitor page. Remember to enable this option where low-level monitoring is needed as it has a performance impact on your processing. Any errors that are propagated to a parent service are then shown up in Monitoring.
    • Update the package dependencies to reflect any packages that it depends on. This is an important step as during loading, the dependent packages are automatically added to your target runtimes if not already present.
    • Make sure that the Visible property is set to public to allow workflows to use webMethods CloudStreams connectors or flow services that are created in webMethods Service Designer.
    • For packages created using the local development feature in webMethods Service Designer, make sure that the Enforce a single Git repository property is selected. When you set this property, the webMethods package is automatically converted into a Git repository, aligning it with the native structure of webMethods Integration packages. For more information, see Using the Local Service Development Feature in webMethods Service Development Help.

About this task

Key points to consider when adding packages are:
  • It is not possible to import a webMethods Integration project package into another webMethods Integration project. Projects are considered top-level integrations and must be deployed independently. Create a custom package if you want to share code between projects and use messaging for intra project collaboration.
  • Only the recent versions of the webMethods CloudStreams connector provider packages are supported.
  • Database, IBM® Power, SAP® ERP, Kafka, IBM MQ, PeopleSoft, SharePoint, AS400, and HDFS accounts imported from Git are disabled. Update the password before enabling the accounts.
  • Global variables of the type password that are imported from Git are initially set to null. Update the global variables of type password before you run the flow services by using them.

Procedure

  1. From the navigation pane, go to Projects and select a project.
  2. Click Packages.
    The Packages page is displayed listing packages that are already added to the project.
  3. Click Add package.
    The Add Package page appears.
  4. Select Git.
    The options to enter Git details are displayed.
  5. Enter the following details and click Next.
    Git URL
    The URL of the package repository where the package is hosted.
    Source Control
    The display name of the account that is associated with the repository. The drop-down menu displays all Git accounts available to you.
    Note: You can add a new Git account by clicking Add.
  6. Select a particular branch or tag of the repository to use as the source for the package in the Git branch/Tag field.
  7. Click Continue.
    The runtime replica automatically compares the version of an incoming package with the one already installed and displays appropriate messages. If the version is the same, installation is skipped; if newer, an upgrade proceeds; if older, the action is blocked. Based on the outcome, and you can choose to continue or cancel the task.
    A confirmation message appears after a successful addition of the package.

Results

The package is added to your project. The assets such as flow services, connectors, and any other artifacts that are associated with the package can now be used in your project.