Installation and setup

Install builder

You first need to install it on your system by running this command:

npm install -g @webmethodsio/wmiocli

You can now start building your application.

Quick setup guide

If you are already familiar with webMethods CLI Connector Builder, use this guide to quickly build and deploy your connectors.

1. Install the builder globally.

   npm install -g @webmethodsio/wmiocli

2. Log in to webMethods Integration.

   wmio login

   When prompted, enter tenant URL, email ID associated with the tenant, and the tenant developer key. You can find the developer key by clicking the profile icon and selecting Profile.

   After a successful login, the CLI Connector Builder is ready to use.

3. Create an application with minimum required files.

   wmio init

   Provide a name for the application when prompted.

4. Move into a new directory.

   cd <application_name>

5. Install all libraries needed for the webMethods CLI Connector Builder application.

   npm install

   You now have a local working application.

6. Add action, trigger, and lookup.

   To add an action in your application, use wmio create action <action_name> or wmio action <action_name>

   When you run this command, a new action folder is created in your application’s directory with a <action_name.js> file in it. Add your action code in that file’s execute function and update the input and output schema based on your requirements.

   To add a lookup in your application, use wmio create lookup <lookup_name> or wmio lookup <lookup_name>

   When you run this command, a new lookup folder is created in your application’s directory with a <lookup_name.js> file in it. Add your lookup code in that file.

   To add a trigger in your application, use wmio create trigger <trigger_name> or wmio trigger <trigger_name>

   When you run this command, a new trigger folder is created in your application’s directory with a <trigger_name.js> file in it. Add your trigger code in that file.

   Note: Action, trigger, and lookup names must contain only alphanumeric characters and underscores.

7. Configure authentication.

   wmio auth

   Select the authentication type (basic/apikey/oauth/custom) when prompted. When you select an authentication type, an authentication.js file is created in your application’s directory. Add authentication logic to this authentication.js file.

   Note: If you want to implement Noauth for your custom connectors, refer to the Authentications section.
8. Test the application.

   Testing is performed using the mock data defined in the code.

   wmio test

9. Deploy the application to webMethods Integration.

   wmio deploy

   After deployment, refresh the webMethods Integration user interface. The connector appears under the Services > Connectors and is available for local use. You can also download the application. To make your application globally available, kindly contact Global Support.

   Note: Refer to the Help section to get more details about the webMethods CLI Connector Builder commands.

Creating local applications

Once you have installed the webMethods CLI Connector Builder package, you can install the webMethods CLI Connector Builder and set up your authentication to create a working application.

It is private and visible in your Connectors panel under the Services tab. Before we go through the steps to create a local application, let’s understand the important blocks that make the application.