shulkaolka / Connectors

Concepts and guidlines for connector development

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Sublime's custom image

The revolution in data synchronization — the Open Integration Hub enables simple data synchronization between any software applications and thus accelerates digitalisation

Visit the official Open Integration Hub homepage

Introduction

License

The Open Integration Hub enables data synchronization across a variety of applications. To enable interaction with any software an technical component is needed to the Open Integration Hub - the connector. It consists of two distinct parts: the adapter and the transformer.

An adapter is a module for the syntactic connection of an external application and its data to the Open Integration Hub. This includes protocol translation, data format transformation, etc. Furthermore it provides functionalities to perform e.g. CRUD operations within the source system.

For further information please read through the information within the adapter folder.

A transformer is responsible to semantically transform an incoming JSON object into another JSON object. Thus the mapping between two data models is done within the transformer.

For further information please read through the information within the transformer folder.

The following illustration provides a holistic overview of a connector: Connector

Open Source Connectors

Like the Open Integration Hub services, connectors are also standardized components that can be reused in any implementation of the framework. There are several contributors that provide a wide range of open source connectors already. So before you start your own, check out what's already there:

Open Integration Hub Flowground elastic.io

If you want to build your own connector, we suggest you start with a our node.js example, to understand the structure and what you need to get going. Most components are build in node.js, although you can choose any language you want.

node.js example

If you prefer a real world example, the wice components are good place to get inspiration.

Wice Adapter

Wice Transformer

Contribution

Contribution Guidelines

Before you contribute please read our contribution guidelines.

Code of Conduct

To see how members of the community are expected to behave, please read the code of conduct. We apply the code of conduct defined by the Contributor Covenant, which is used across many open source projects, such as NodeJS, Atom and Kubernetes.

Contact

When looking for further information or support, please contact: robin.brinkmann@cloudecosystem.org.

Content

Folders

  • Adapters: Describes the adapters, their goals, standardized behavior and checklists for building an adapter
  • Protocols: Archive for all protocols by the workgroup
  • Transformer: Includes the transformer concept, a basic introduction into the JSONata transformation language, transformer evolution and suggestions for possible implementations

Documents

  • CONTRIBUTING: Contains the contribution guideline for the Open Integration Hub project
  • CODE_OF_CONDUCT: Contains an explanation of the expected behavior of the community members, following the code of conduct defined by the Contributor Covenant

Workgroup

Member

Connectors

Member Name GitHub Alias Company Role
Selim Achmerzaev sachmerz Basaas Committer
Igor Drobiazko drobiazko Elastic.io Committer
Franz Degenhardt FranzDegenhardt X-Integrate Committer
Hansjörg Schmidt hschmidthh Wice Committer

Wording

Within the project different terms and abbreviations are frequently used. All terms and abbreviations are explained within the glossary and our list of abbrevations.

About

Concepts and guidlines for connector development

License:Apache License 2.0


Languages

Language:JavaScript 100.0%