Connectors
GenericsData Module 
General - Connectors
The connector makes it possible to define the communication protocol making it possible to reach data.
The connectors are managed at the level of the GenericsData module of the DataChain offer.
Principles
-
The number of Connectors is not limited.
-
The connector represents Level 1 of the DataChain value chain. cf General Principles
-
Necessary and Required.
-
Linked to one or more repositories.
-
Multiple connectors of the same type can be created.
Metadata
Like all DataChain elements, an connector has a metadata panel consisting of:
-
a label (Required)
-
from a description
-
of n tags
-
of a type of license (Free entry)
Connector Settings
The parameters define all the information necessary for the implementation of the communication protocol.
Depending on the type of protocol chosen, the parameters are variable. The DataChain solution integrates the basic types of standard connectors.
-
HDFS Connector
-
SFTP connector
-
Database Connector
-
Oracle
-
Sql Server
-
Post Gres
-
MariaDb
-
MySql
-
MongoDb
-
Neo4J
-
-
S3 connector (AWS)
-
ElasticSearch Connector
-
Http/Https Connector
-
…
Creating a Connector
The creation of a connector (like all the management of connectors) is carried out from the Module GenericsData of DataChain
Step 1: Access to connector management
Step 2: Creating the connector
Entering the metadata
-
Each Connector has a metadata panel.
Entering a label is mandatory.
Optional input fields can be used to provide additional information. An icon can be assigned to the connector using the commands in its metadata panel_.
It is advisable to save the metadata panel as soon as you have completed your entries.
Use the button 
situated in the right-hand part of the connector screen banner.
Connector type
-
The choice of connector type is mandatory.
-
Use the Type connecteur choice box and select a connector (Database, SFTP, HDFS, Http/https, Elastics Search, S3, …)
Parameters according to connector type
Sql and NoSql databases
There are two ways of entering connection parameters for databases
Assisted mode (automatically generated connection string)
-
Database type (Required)
-
User (Required)
-
Password (Required)
-
Host (Required)
-
Port (Required)
-
Database name (Required)
-
Complement (free entry)
-
Connection string: _This field is filled in automatically based on the information entered.
Free mode (connection string to be entered manually)
-
Database type (Required)
-
User (Required)
-
Password (Required)
-
Connection string: free input zone.
SFTP
-
Host (Required)
-
Port (Required)
-
Si SSH
-
Public key (Required)
-
Secret passphrase (Required)
-
-
If no SSH_
-
User (Required)
-
Password
-
S3 (AWS)
-
AWS access key (Required)
-
AWS secret key (Required)
-
AWS Endpoint (Required)
-
Connection test Once the information has been entered, an
button allows you to perform a connection test and validate (or invalidate) the protocol parameters. -
Connector Registration
-
To save all the connector information, click on the button
-
The
button provides access to the list of existing connectors.
-
File Explorer
The explorer is available for HDFS, MiNio, S3 and SFTP connectors.+ It allows you to view all the directories containing remote files.
To explore remote files, click on "Explore".
Editing a connector
-
Access to GenericsData module
-
Left Menu Bar
-
Choice of Menu Connectors
-
Search in the list of the targeted connector
The lists of the elements of the DataChain offer have filter and search functions on columns. Use these functions to find the targeted connector.
-
Click on the label of the chosen connector or on the
icon at the end of the line.
Deleting a DataChain connector
-
Access to GenericsData module
-
Left Menu Bar
-
Menu Choice Connectors
-
Search in the list of the targeted connector
The lists of the elements of the DataChain offer have filter and search functions on columns. Use these functions to find the targeted connector.
-
Option 1: Use the
icon button at the end of the line and confirm the action. -
Option 2:
-
Click on the label of the chosen connector or on the
icon at the end of the line. -
Once the connector edition page is displayed, click on the
button then confirm the action.
-
When removing a connector, an impact check is performed.
If the connector is consumed (used in a repository as a parameter, or in an export template), then deletion is not possible.
A message will indicate to the user, the repositories or export templates consuming the connector
Special case of the Local Connector
DataChain embeds a connector in its base deployment. It allows to integrate data without the need to create a connector.
Note that when using a local connector, the data will be physically stored in the DataChain context.
Also note that the local connector is not available or visible in the list of connectors.
When setting up a repository, it is then possible to choose either a configured connector or the local connector mode
Quick Reference
Creation of a Connector
| Steps | Objective | Stock | Landmarks |
|---|---|---|---|
1 |
Access to the list of Connectors. Connector menu |
Left Menu GenericsData |
|
2 |
Creating a new connector |
Click on New button |
|
3 |
Metadata entry |
Enter a label (Required) |
Metadata pane |
4 |
Choosing a connector type |
List of available connectors |
|
5 |
Entering connector type information |
settings pane (different depending on connector type) |
|
6 |
Registration |
Save button |
|