IBM webMethods Hybrid Integration connector builder

Installation

  npm i @webmethodsio/[email protected] -g

NOTE: This client requires node version 22.15.1

Contents

• Get Started
• Commands
• Guide to create a Connector

Get Started

The IBM webMethods Integration Connector Builder is a command-line tool designed for creating custom connectors for IBM webMethods Integration. It enables you to build, deploy, and share your own connectors within the IBM webMethods Integration environment.

Commands

Following are the commands which IBM webMethods Integration connector builder supports.

• wmio connectors
• wmio auth
• wmio create
• wmio deploy
• wmio download
• wmio help
• wmio init
• wmio login
• wmio logout
• wmio versions
• wmio swagger
• wmio oauth
• wmio attach
• wmio detach
• wmio postman
• wmio action
• wmio trigger
• wmio lookup
• wmio unpublish
• wmio migrate

connectors

Use this command to display all the connectors created by current user.

  // command options -f or --filter="published=true"
  wmio connectors

Sample Output:

| App Name  |      Version    |      created_at          |
|---------- |-----------------| -------------------------|
| Github    |   1.0           | 2017-06-19T14:22:23.485Z |
| Facebook  |   2.0           | 2017-06-20T11:11:24.485Z |
| Gmail     |   2.0           | 2017-06-23T10:03:22.485Z |

auth

Use this command to add an authentication for your connector.

  wmio auth

create

Use this command to add a new trigger, action, lookup.

  wmio create trigger new_push
  wmio create action create_user
  wmio create lookup list_users

deploy

Use this command for building and deploying the connector on IBM webMethods Integration.

  wmio deploy

download

Use this command for download a zip file of your connector.

  wmio download

help

Use this command to list all the commands you can use.

  wmio help

Sample Output:

|  Command    |    Example                           |                      Info                                  |
|----------   |--------------------------------------|------------------------------------------------------------|
| connectors  |   wmio connectors                    | Lists all the connectors of the current user               |
| auth        |   wmio auth                          | Adds an authentication for your connector                  |
| create      |   wmio create trigger trigger_name   | Adds a new trigger, action and lookup                      |
| deploy      |   wmio deploy                        | Builds and deploys connector on IBM webMethods Integration |
| download    |   wmio download                      | Downloads zip of your connector                            |
| help        |   wmio help                          | Lists all the commands                                     |
| init        |   wmio init example                  | Initializes a new connector                                |
| login       |   wmio login                         | Login to IBM webMethods Integration account                |
| logout      |   wmio logout                        | Logout from IBM webMethods Integration account             |
| versions    |   wmio versions                      | Lists all the versions of your current connector           |
| oauth       |   wmio oauth deploy                  | Deploy custom user oauth to IBM webMethods Integration     |
| attach      |   wmio attach lookup                 | To attach lookup in any specific actions or triggers field |
| detach      |   wmio detach lookup                 | To detach lookup in any specific actions or triggers field |
| postman     |   wmio postman [file.json]           | To import action from postman collection exported json     |
| swagger     |   wmio swagger [swagger.json|yaml]   | To import action from swagger file                         |
| migrate     |   wmio migrate                       | To migrate a connector to other region                     |

init

Use this command to create an initial project.

  wmio init [path] [foldername] --template=minimal
  wmio init example

• Options
  • template - Optional template argument. Default minimal

login

Use this command for configuring your deploy key and logging into IBM webMethods Integration.

  wmio login
  // or
  wmio login https://mytenanturl.ibm.com [email protected] developer_key

logout

Use this command for deleting access token from your home directory.

  wmio logout

versions

Use this command for displaying all the versions and their status of the current connector.

  wmio versions

Sample Output:

| App name  |   Version     |  Status   |
|---------- |:------------: |-----------|
| Github    |      1        | Published |
|           |      2        | Pending   |
-----------------------------------------

swagger

To import all swagger api calls as an action in connector.

  wmio swagger <swagger file path>

oauth

To deploy custom user oauth to IBM webMethods Integration.

  wmio oauth deploy

attach lookup

To attach lookup in any specific action's or trigger's input field.

  wmio attach lookup

detach lookup

To detach lookup in any specific action's or trigger's input field.

  wmio detach lookup

postman

To create actions from postman collections exported json.

  wmio postman [box-exported-v2.1.json]

action

Short hand for wmio create action action_name

  wmio action action_name command

trigger

Short hand for wmio create trigger trigger_name

  wmio trigger trigger_name

lookup

Short hand for wmio create lookup lookup_name

  wmio lookup lookup_name

test

To test and run your action/trigger(polling)/auth locally provided you fill the mock_input in your action/trigger(polling)/auth file.

wmio test

whoami

Displays current logged in user information.

wmio whoami

unpublish

Unpublishes the connector which is published or global and it's respective actions/triggers will not be visible.

wmio unpublish

migrate

Migrates the connector you own to other account in different region.

wmio migrate