Working with Publishes

The Publish feature allows you to share the integration projects with others within your organization. This feature is designed to streamline collaboration, facilitate deployment, and ensure that integration solutions can be easily accessed and utilized by relevant stakeholders.

The key aspects of the publish feature are:

  • You can publish your integration projects, making them available to other users who need to view, use, or further develop the solutions. This is particularly useful for team collaboration and multi-departmental projects.

  • Published projects can be easily deployed across different environments, such as development, testing, and production. This simplifies the process of moving projects through various stages of the lifecycle.

The publish project feature ensures that your valuable integration solutions can be effectively shared, maintained, and utilized across the organization.

Note:

  • You must be an administrator to publish a project.

  • You cannot publish projects if you are logged using an external SSO application.

  • As reference data varies across different environments, you need to reconfigure the reference data as per the respective environment. So, if you are publishing a project that has a flow service with reference data, the reference data is not published along with the flow service. You are required to create the reference data in the destination environment.

Accessing Publish Wizard

You can publish a project using the Publish Project option available in the vertical ellipsis menu on the project card.

On clicking the Publish Project option, the Publish wizard opens that lets you to configure the project before publishing.

Publish Wizard

The Publish wizard contains the following pages:

  • Select assets

  • Confirm dependencies

  • Publish settings

Select assets

The Select assets screen lists all assets that are available in the project. The assets are categorized based on their type such as workflows, flow services, messaging subscribers, or REST APIs. You can select either all or specific assets that must be published. The assets are listed based on the following guidelines:

  • Assets that contain errors are not listed as they cannot be published to another environment.

  • Assets are listed based on the user’s access privileges. For example, User A selects workflow A as an asset and publishes a project. User B selects workflow B as an asset and publishes the same project. The next time they try to republish the project, on the Select Assets screen, only workflow A appears as a preselected asset for user A, and only workflow B appears as a preselected asset for user B.

Confirm dependencies

The Confirm dependencies page lists all dependent assets for the assets that were selected in the Select assets screen

Dependent asset is the asset that is being used by your asset (main) that is selected for publishing. For example, if workflow A (main) calls workflow B during its execution, this means that the workflow A is dependent on workflow B. Hence, workflow B is considered as dependent. So, even if you have not selected assets in the Select assets screen, all dependent assets are considered by default for publishing along with the main asset. Thus, the Confirm dependencies screen provides a complete view of all assets you intend to publish in one place.

Publish settings

The Publish settings screen allows you to provide details about the publish action such as name, description, and the environment on which you want to publish. These details can be helpful for your future references.

Note:

  • Only the environments that you have registered with your tenant are listed in the Publish settings screen.

  • The destination environment must be on the same or higher version as compared to the source environment. If the destination environment is on a lower version than the source environment, an error appears.

  • To publish projects across regions, both the source and destination regions must be on the version 11.0.5.

Publishing Projects

Example

Assume that there is a Demo Project 1 in your tenant that you want to publish to another tenant. This project contains the following integrations as follows:

Assume, that the Webhook - Send an Email workflow contains errors while the rest of the integrations are configured correctly.

Before you Begin

  • Ensure that the project is ready to publish.

    • Verify the configuration and correctness of the integrations.

    • Ensure all required resources (like API endpoints, connectors, and services) are properly set up.

    • Test the integrations to ensure they work as intended.

  • Ensure you have the destination environment details such as username and password.

Basic Flow

  1. Log in to your tenant.

  2. Go to the Projects dashboard and locate the project you want to publish.

  3. Click the vertical ellipsis icon available in the bottom right of the project card. A menu appears.

  4. Select Publish Project. The Publish Project wizard appears.

  5. Do the following in the Select Assets screen to select the assets that must be published:

    a. Click the drop-down icon given beside the asset type. In this example, the drop-down icon beside the workflows is clicked.

    All workflows available under the selected project are listed. The Webhook - Send an Email is not listed as the workflow contains errors.

    b. Select the workflows you want to publish. You can select specific workflows by checking respective checkboxes, or all workflows by selecting the Workflows checkbox.

    c. Click Next. The Confirm dependencies page appears listing all selected assets along with their types and dependencies.

  6. Verify the assets and their dependencies.

    In this example, the Runflow workflow calls the subflow Box workflow during its execution, which means that the Subflow Box workflow is dependent on the Runflow workflow. Previously, while selecting assets though the Subflow Box workflow was not selected for publishing, but as it is dependent on the Runflow workflow which is selected for publishing, the Subflow Box workflow is published by default.

  7. Click Next. The Publish settings screen appears.

  8. Enter the following details in the Publish settings page:

    a. Publish name: Name of the publish action.

    b. Description: Short description about the publish action.

    c. Select Environment: Destination environment on which you want to publish. The username and password fields appear.

    d. Password: Password that is associated with the user name.

    If the environment to which you want to publish a project has been already added under Environments Allow users in IBM® webMethods iPaaS, then the password prompt does not appear.

  9. Click Publish. The project is successfully published to the specified environment. Now, if you check the destination environment, you can see the published project listed in the Projects dashboard.

You can publish the same project to your destination environment any number of times.