Create Workato custom connector locally

Workato Introduction

Workato is a low-code/no-code, cloud-based iPaaS Solution, that is hosted on public cloud infrastructure from Google Cloud Platform and Amazon Web Services (AWS). It means everything what you create here is drag and drop application component which resides on cloud.

Workato Connector

To achieve any automation in Workato tool we create a recipe. Recipe contains set of actions to perform any business automation. To define actions in the recipes we use connectors. Hence, Workato connectors are the building blocks of recipes. Connector in the Workato can be a readily available in the Workato marketplace which we just need to drag in the recipe flow to use its capability which we called it as pre-build connectors or we can create our own connectors as per our requirement which we called it as custom connectors. A connector allows Workato to interact with a single application through a series of triggers and actions.

There is two ways to build SDK connector.

Cloud SDK Console

To know more about Cloud SDK Console, follow this link. Using the Workato Connector SDK | Workato Docs

SDK Gem This is a local development method. Where we can build our own connectors locally and which can be deployed to the cloud upon connector functioning as expected. Following is the detailed information on local custom connector development.

Local connector involved a series of steps which are given below:

1. Ruby Installation Process

Download the Ruby installer from RubyInstaller for Windows prefer 2.7.X version.

Complete the installation process follow instructions appears on installation wizard.

Installing MYSYS2 Components:

[Note: Simply press the enter to download the required package for Workato-connector-sdk ]

You can verify your Ruby version by running ruby -v command

2. Workato Installation Process

To install charlock_holmes use ridk exec pacman -S mingw-w64-x86_64-icu icu-devel icu command

Run gem install charlock_holmes — –with-icui18nlib=icuin –with- icudatalib=icudt command

For windows users, need to install tzinfo-data gem by running gem install tzinfo-data command

To install the Workato-Connector-sdk, by using gem install workato-connector-sdk command

Verify that your gem is correctly installed by workato command and to check the exact location of the gem, use gem which workato-connector-sdk command

[Note: Now you are all set-up with environment, which is required to develop custom connector on your local machine]

3. Creating Custom Connector

To create a new connector project use workato new<PATH> command

In PATH provide the local path of system where you want to install required file to create connector. you may be prompted about HTTP mocking behavior.

Enter your choice using 1 or 2

Can see some files are installed in your provided path, right click on connector choose the edit with notepad++ option

Write your custom connector source code there once done with code save it and exit

(Sample source code, this connector doesn’t need any credential for connection)

If your connector needs connection credential use below commands

set EDITOR=notepad

workato edit settings.yaml ——- this is for simple one

set EDITOR=notepad

workato edit settings.yaml.enc ———–this is for secure one

To test your connector, use workato exce test command

Test your connector’s triggers or actions with below command

workato exec actions.<action>.execute

workato exec triggers.<Triggers>.poll

4. Deploying Custom Connector to Cloud

Push to your Workato workspace workato push –api- email=’WORKATO_EMAIL_ADDRESS’ –api-token=’WORKATO API TOKEN’-n=’Initial version’ –environment=’https://app.workato.com

Password Generator Custom Connector:

This connector is created as part of POC. This connector will help to generate assign the password when the user signup for first time.

You can see your connector in Workato workspace connector SDK. You can also customize the logo of connector.

Recipe using custom connector

(You can use connector in recipe according to your need.)

In this way, we can create custom connector locally and deploy it to Workato workspace and use accordingly as per the requirements in recipes.

Perficient + Workato

At Perficient, we excel in tactical Workato implementations by helping you address the full spectrum of challenges with lasting solutions, rather than relying on band-aid fixes. The end result is intelligent, multifunctional assets that reduce costs over time and equip your organization to proactively prepare for future integration demands.

Create Workato custom connector locally