Connector Builder - IBM webMethods CloudStreams Connectors

Integration is an integration platform as a service (iPaaS) that lets you connect web apps, on-premises systems, and devices to create integrations and automate tasks.

Create custom cloudstreams connectors with our developer platform. Know how it works and how to install it. In addition, learn how to create a connector, add triggers, actions, lookups, and authentications to it, deploy it, and share it with other users.

You can also create custom cloudstreams connectors using the Connector Builder.

About webMethods CloudStreams

The webMethods CloudStreams provides a scalable approach for the development and governance of integration flows between SaaS applications and on-premise applications. Using webMethods CloudStreams you can perform the following:

For more details about webMethods CloudStreams, refer:

CloudStreams Documentation

Publishing and unpublishing custom webMethods CloudStreams connectors using Designer

Using IBM webMethods Designer, you can deploy custom webMethods CloudStreams connectors to your desired Integration tenant.

Note
Publishing and unpublishing custom webMethods CloudStreams connectors using IBM webMethods Designer is restricted and is not publicly available. Contact Software AG Support for more information.

In IBM webMethods Designer, you can do the following:

  1. Configure the desired Integration tenant.

  2. Publish the custom webMethods CloudStreams connector to the desired Integration tenant.

    a. Select the webMethods CloudStreams connector provider associated with the connector you want to publish.
    b. Select the connector provider package you want to publish.
    c. Select the Integration tenant(s) where you want to publish the connector.
    d. Select the custom webMethods CloudStreams connectors you want to publish.

  3. Unpublish the custom webMethods CloudStreams connector from the Integration tenant and unregister the tenant from IBM webMethods Designer.

    a. Select the webMethods CloudStreams connector provider associated with the connector you want to unpublish.
    b. Select the connector provider package you want to unpublish.
    c. Select the Integration tenant(s) from where you want to unpublish a connector.
    d. Select the custom webMethods CloudStreams connectors you want to unpublish.

Prerequisites

Configuring a tenant to Integration

Configure a tenant to the required Integration tenant in IBM webMethods Designer. For this, ensure that a valid URL exists to connect to the tenant and a valid username and password are created on the tenant.

To configure a tenant to Integration, you need to provide specific information in IBM webMethods Designer. You can add, edit, and update tenant configurations in IBM webMethods Designer.

Adding a tenant configuration

Do the following to add a tenant configuration for Integration:

  1. In IBM webMethods Designer, select Window > Preferences.

  2. In the Preferences navigation tree, select webMethods > Integration.

  3. Click Add.

  4. In the Add tenant configuration dialog box, enter the following details:

    Field Description
    Name The name to use for the Integration tenant configuration.
    Note: The name cannot contain control characters, special characters, and characters outside of the basic ASCII character set, such as multi-byte characters.
    URL URL of the Integration tenant to which IBM webMethods Designer is to connect, for example, https://sample.int-aws-us.webmethods.io
    User The user for a tenant on Integration.
    Save password (in the Eclipse secure storage) Indicates whether the password for the specified user account should be saved in Eclipse secure storage.
    Integration uses this password from the Eclipse secure storage whenever user authorization is required. If you want to save the password in Eclipse secure storage, select this option. If you decide not to save the password in Eclipse secure storage, you must specify your password each time your user authorization is required for connecting to Integration.
    Password The password for the specified user.

  5. To verify whether the added Integration tenant can be accessed by using the specified information, click Test.

  6. To store the tenant configuration details, click OK. A tenant configuration is added to the Connections page with the specified details. The first tenant configuration that you create is automatically marked as the default. This default configuration is indicated with a check mark on the Connections page. IBM webMethods Designer always uses the default tenant configuration for Integration. If there are multiple tenants configured, you can select the tenant that you want to make as the default.

Editing a tenant configuration

You can edit a tenant configuration for Integration if there are any changes in the configuration values.

  1. In IBM webMethods Designer, select Window > Preferences.

  2. In the Preferences navigation tree, select webMethods > Integration.

  3. Click Edit.

  4. Enter new values in the tenant configuration fields you want to change.

  5. In the Edit Tenant Configuration dialog box, click OK.

  6. In the Connections page, click OK.

Removing a tenant configuration

You can remove tenant configurations for Integration one at a time from the Connections page.

Do the following to remove a tenant configuration for Integration:

  1. In IBM webMethods Designer, select Window > Preferences.

  2. In the Preferences navigation tree, select webMethods > Integration.

  3. Select the Integration tenant configuration you want to remove.

  4. Click Remove. IBM webMethods Designer prompts you to confirm that you want to remove the selected tenant configuration.

  5. Click OK.

Publishing custom webMethods CloudStreams connectors to Designer

Using IBM webMethods Designer, you can deploy a custom webMethods CloudStreams connector to Integration.

Before you publish a custom webMethods CloudStreams connector to Integration, ensure that IBM webMethods Designer is configured to connect to Integration. For more information on configuring a tenant to Integration, see the Configuring a tenant to Integration section.

Note
You can also configure the tenant to Integration by clicking on the Configure option located at the right-side of the List of Target(s) dialog box.

Do the following to publish a custom webMethods CloudStreams connector to the desired Integration tenant:

  1. In the webMethods CloudStreams Development View, select and right-click on the webMethods Cloudstreams connector provider package associated with the connector that you want to publish to Integration and click Publish.

  2. In the List of Connector(s) dialog box, select one or more connectors you want to publish from the provider package and click Next.

    Note
    Connectors that have at least one resource or operation will be available for publishing.

  3. In the List of Target(s) dialog box, select the configured tenant to publish the connector and click Next.

    Note
    You can configure the connection to Integration by clicking on the Configure option located at the right-side of the List of Target(s) dialog box.

  4. In the Publish Connector dialog box, select the connector(s) you want to publish. On clicking the required connector package from the left-side of the dialog box, its corresponding properties will appear on the right-side of the dialog box. You can optionally configure the connector properties before publishing the package to Integration. These properties define the behavior of the selected connector(s) for Integration. Click Finish.

    The selected connectors are now published to the selected Integration tenant and the status is displayed in the log at the lower part of the screen.

Unpublishing custom webMethods CloudStreams connectors from Integration

Using IBM webMethods Designer, you can unpublish a published custom webMethods CloudStreams connector from the Integration tenant.

Do the following to unpublish a custom webMethods CloudStreams connector from the desired Integration tenant:

  1. In the webMethods CloudStreams Development View, select and right-click on the webMethods CloudStreams connector provider package associated with the connector that you want to unpublish from Integration and click Unpublish.

  2. In the List of Target(s) dialog box, select the tenant from where you want to unpublish the connector(s). Click Next.

    The connector(s) associated with the selected Integration tenant(s) will be retrieved.

  3. In the List of Connector(s) dialog box, select the connector(s) you want to unpublish and click Finish.

The selected tenant will be unregistered from IBM webMethods Designer and its associated connector(s) will be unpublished from Integration.