Skip to content

Commit 9255b76

Browse files
committed
Merge branch 'master' of github.com:openintegrationhub/Connectors
2 parents f99e7d6 + 12b3f3c commit 9255b76

File tree

2 files changed

+22
-49
lines changed

2 files changed

+22
-49
lines changed

Adapters/GettingStarted/RequirementsToTestOrBuildAnAdapter.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,10 @@ Visit the official [Open Integration Hub homepage](https://www.openintegrationhu
1010

1111
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](LICENSE)
1212

13-
The Open Integration Hub enables data synchronization across a variety of applications. To create a connection and enable interaction a link is needed between the software application and the Open Integration Hub - namely an Open Integration Hub connector.
14-
1513
<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
1614

1715
- [Introduction](#introduction)
18-
- [Adapter](#adapter)
19-
- [Transformer](#transformer)
16+
- [Open Source Connectors](#open-source-connectors)
2017
- [Contribution](#contribution)
2118
- [Contribution Guidelines](#contribution-guidelines)
2219
- [Code of Conduct](#code-of-conduct)
@@ -25,33 +22,43 @@ The Open Integration Hub enables data synchronization across a variety of applic
2522
- [Folders](#folders)
2623
- [Documents](#documents)
2724
- [Workgroup](#workgroup)
28-
- [Information](#information)
2925
- [Member](#member)
3026
- [Wording](#wording)
3127

3228
<!-- /TOC -->
3329

30+
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.
31+
32+
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.
33+
Furthermore it provides functionalities to perform e.g. CRUD operations within the source system.
3434

35-
A connector connects a software solution to the Open Integration Hub. It consists of two distinct parts, namely adapter and transformer. It contains different functionalities e.g. to fetch and transform data. These functionalities are further explained in the sections [adapter](#adapter) and [transformer](#transformer). In order to achieve our goal to establish a successful open source community we need to steadily increase the number of connectors. So join us and help us grow as an open source community!
35+
For further information please read through the information within the [adapter folder](/Adapters).
3636

37+
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.
38+
39+
For further information please read through the information within the [transformer folder](/Transformer).
3740

3841
The following illustration provides a holistic overview of a connector:
3942
![Connector](Assets/ConnectorsV3.png)
4043

41-
### Adapter
4244

43-
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.
44-
Furthermore it provides functionalities to perform e.g. CRUD operations within the source system.
45+
## Open Source Connectors
4546

46-
For further information please read through the information within the [adapter folder](/Adapters).
47+
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:
4748

49+
[Open Integration Hub](https://github.com/openintegrationhub)
50+
[Flowground](https://github.com/flowground)
51+
[elastic.io](https://github.com/elasticio)
4852

49-
### Transformer
53+
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.
5054

51-
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.
55+
[node.js example](https://openintegrationhub.github.io//docs/Connectors/building-nodejs-component.html)
5256

53-
For further information please read through the information within the [transformer folder](/Transformer).
57+
If you prefer a real world example, the wice components are good place to get inspiration.
58+
59+
[Wice Adapter](https://github.com/openintegrationhub/wicecrm-adapter)
5460

61+
[Wice Transformer](https://github.com/openintegrationhub/wicecrm-transformer)
5562

5663
## Contribution
5764
### Contribution Guidelines
@@ -68,25 +75,14 @@ When looking for further information or support, please contact: philipp.hoegner
6875
### Folders
6976

7077
- [Adapters](Adapters): Describes the adapters, their goals, standardized behavior and checklists for building an adapter
71-
- [Protocols](Protocols): Collection of all taken protocols by the workgroup
78+
- [Protocols](Protocols): Archive for all protocols by the workgroup
7279
- [Transformer](Transformer): Includes the transformer concept, a basic introduction into the JSONata transformation language, transformer evolution and suggestions for possible implementations
7380

7481
### Documents
7582
- [CONTRIBUTING](CONTRIBUTING.md): Contains the contribution guideline for the Open Integration Hub project
7683
- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md): Contains an explanation of the expected behavior of the community members, following the code of conduct defined by the Contributor Covenant
7784

7885
## Workgroup
79-
### Information
80-
You have the opportunity to get your questions answered in a `weekly Q&A session`.
81-
Feel free to attend and invite other people to this session.
82-
83-
If possible please send your question in advance to **philipp.hoegner@cloudecosystem.org**.
84-
85-
The session will take place every `Monday from 11:00 - 12:00`. The first session will be next monday.
86-
87-
**GoToMeeting Link:** https://global.gotomeeting.com/join/456709357 <br>
88-
**Phone (Germany):** +49 692 5736 7317 <br>
89-
**Access-Code (Germany):** 456-709-357 <br>
9086

9187
### Member
9288
#### Connectors
@@ -99,4 +95,4 @@ The session will take place every `Monday from 11:00 - 12:00`. The first sessio
9995
| Philipp Hoegner|[philecs](https://github.com/philecs)|[Cloud Ecosystem](http://www.cloudecosystem.org/)| Committer |
10096

10197
## Wording
102-
Within the project different terms and abbreviations are frequently used. All terms and abbrevations are explained within the [glossary](https://github.com/openintegrationhub/Connectors/wiki/Glossary) and our [list of abbrevations](https://github.com/openintegrationhub/Connectors/wiki/Abbreviations).
98+
Within the project different terms and abbreviations are frequently used. All terms and abbreviations are explained within the [glossary](https://github.com/openintegrationhub/Connectors/wiki/Glossary) and our [list of abbrevations](https://github.com/openintegrationhub/Connectors/wiki/Abbreviations).

0 commit comments

Comments
 (0)