This document is a step-by-step guide to help you understand how our system works and the steps necessary to get a simple connector pushed and ready for a successful integration using flowground platform.
Upload your SSH Key
The first step would be to upload your SSH Key to authorise your deployment via git-push process. Please note that failure to provide (upload) a unique SSH key would result in error “Permission denied” during the code Push phase.
Clone and prepare your connector
If you have you have prepared your connector locally by following instructions in how to build a connector in Node.js or Java then you can skip this step. Otherwise, you can clone one of our template repositories to go through these steps couple of times to familiarise yourself. At the moment we are supporting only Node.js and Java so here are connector templates in each language respectively:
For example, in case of Node.js you could start like this:
Checking the directory where you have cloned the connector:
More information is available in Building a connector in Node.js help page.
Prepare the remote repository
At this stage, we want to know which repositories we have access to:
Now we need to add a new repository in our platform by following instructions in Managing your Teams/Connectors page. For a simplicity let us take the same name for the repository creation petstore-connector-nodejs, and let’s say we have created this particular repository in the development team called dev-build. The platform would create a specific git repository like this:
dev-build@git.**flow**ground:petstore-component-nodejs.git. Then we add this repository to our local git configuration of local repository like this
Our repository is ready to receive the petstore-connector-nodejs component.
Push your connector
After performing all the task described above we are ready to push our code to the newly created repository. To do that we will type:
Before your push would go ahead the system will want to authenticate your SSH Key which we have created specifically for this. Please type yes and accept it to proceed.
Use the connector
The newly added connector is in the list of connector when you start creating your integration flow.
If your connector has only Action function then your connector would show only when selecting an Action function while building the integration flow.
If your connector has only Trigger function then your connector would show only when selecting a Trigger connector.