Prérequis

Avant de commencer, assurez-vous d’être connecté à la plateforme Ferronext.

Pour accéder à l’interface de déploiement d’une source de données :

1. Rendez-vous dans la section Sources de données depuis le menu de navigation latéral.
2. Sélectionnez la source pour laquelle vous souhaitez créer un déploiement.
3. Deux accès sont possibles :
   • Cliquez sur l’onglet Déploiements, puis sur le bouton + pour créer un nouveau déploiement.
   • Cliquez sur le bouton ⋯, puis sélectionnez Configurer un déploiement dans le menu déroulant.
4. Dans la section Connectivité, sélectionnez le protocole Base de données.

Configuration d'un déploiement base de données

Démonstration vidéo

La vidéo ci-dessus vous montre rapidement les étapes de configuration. Vous retrouverez ci-dessous une explication plus détaillée, illustrée par des captures d’écran.

Interface de configuration

Le formulaire de configuration d'un déploiement base de données comporte plusieurs sections à renseigner.

Ce protocole permet de se connecter à une source de données relationnelle ou NoSQL et extraire périodiquement ou ponctuellement des enregistrements pour les ingérer dans une source de données Ferronext.

Structure de la configuration

La configuration est divisée en plusieurs sections :

1. Connectivité – paramètres de connexion selon le type de base.
2. Correspondances – mappage entre les champs/colonnes de la base et les variables de la source Ferronext.
3. Filtres – (optionnel) application de filtres.
4. Paramètres de déploiement – déclenchement, rythme, date de début, etc.
5. Résumé – vérification avant déploiement.

Connectivité

Choisissez d’abord le type de base (actuellement supportés) :

PostgreSQL MySQL MariaDB MongoDB Elasticsearch

En fonction du choix, renseignez les champs de connexion ci-dessous.

PostgreSQL

PostgreSQL est un système de gestion de base de données relationnelle (SGBDR) open-source, riche en fonctionnalités, robuste et adapté aux données structurées.

Champs à renseigner :

1. Hôte (Host)

   • Adresse du serveur PostgreSQL (nom DNS ou IP).
   • Exemple : db.example.com ou 192.168.1.10.

2. Port

   • Port TCP utilisé par PostgreSQL (par défaut 5432).

3. Nom de la base de données (Database name)

   • Nom logique de la base contenant les tables à lire.
   • Exemple : database.

4. Nom de la table

   • Table SQL à partir de laquelle vous voulez récupérer les données.
   • Exemple : sensor_readings.

5. Nom d'utilisateur

   • Compte utilisé pour se connecter. Privilèges recommandés : utilisateur en lecture seule (SELECT) sur les tables ciblées.

6. Mot de passe

   • Mot de passe associé à l’utilisateur.

7. Schéma (facultatif, public par défaut)

   • Schéma contenant la table (public est le schéma par défaut sous PostgreSQL).
   • Si votre table est dans un schéma personnalisé, renseignez-le ici.

MySQL

MySQL est un SGBDR largement utilisé, performant pour de nombreuses applications web et systèmes métiers.

Champs à renseigner :

1. Hôte (Host)

   • Adresse du serveur MySQL (nom DNS ou IP).
   • Exemple : db.example.com ou 192.168.1.10.

2. Port

   • Port TCP utilisé par MySQL (par défaut 5432).

3. Nom de la base de données (Database name)

   • Nom logique de la base contenant les tables à lire.
   • Exemple : database.

4. Nom de la table

   • Table SQL à partir de laquelle vous voulez récupérer les données.
   • Exemple : sensor_readings.

5. Nom d'utilisateur

   • Compte utilisé pour se connecter. Privilèges recommandés : utilisateur en lecture seule (SELECT) sur les tables ciblées.

6. Mot de passe

   • Mot de passe associé à l’utilisateur.

MariaDB

MariaDB est un fork de MySQL, compatible sur la plupart des points, souvent utilisé comme alternative open-source.

Champs à renseigner :

1. Hôte (Host)

   • Adresse du serveur MariaDB (nom DNS ou IP).
   • Exemple : db.example.com ou 192.168.1.10.

2. Port

   • Port TCP utilisé par MariaDB (par défaut 5432).

3. Nom de la base de données (Database name)

   • Nom logique de la base contenant les tables à lire.
   • Exemple : database.

4. Nom de la table

   • Table SQL à partir de laquelle vous voulez récupérer les données.
   • Exemple : sensor_readings.

5. Nom d'utilisateur

   • Compte utilisé pour se connecter. Privilèges recommandés : utilisateur en lecture seule (SELECT) sur les tables ciblées.

6. Mot de passe

   • Mot de passe associé à l’utilisateur.

MongoDB

MongoDB est une base de données NoSQL orientée documents. Les données sont stockées sous forme de documents JSON (BSON).

Champs à renseigner :

1. Hôte
   • Nom DNS, IP ou chaîne de connexion (cluster).
2. Port
   • Port utilisé par MongoDB (par défaut 27017).
3. Nom de la base de données
   • Base contenant la collection cible.
4. Nom de la collection (équivalent à la table)
   • Collection à interroger (ex. readings).
5. Nom d'utilisateur
   • Compte utilisé pour se connecter. Privilèges recommandés : utilisateur en lecture seule sur les tables ciblées.
6. Mot de passe
   • Mot de passe associé à l’utilisateur.

Elasticsearch

Elasticsearch est un moteur de recherche et d'indexation distribué, souvent utilisé pour stocker et analyser de grandes quantités de logs et séries temporelles.

Champs à renseigner :

1. Hôte
   • URL du cluster Elastic (ex. https://es.example.com).
2. Méthode d'authentification :
   • Utilisateur / Mot de passe : authentification HTTP basic.
   • Clé d'API : utiliser une API key comme méthode sécurisée.
3. Nom de l'index (équivalent à une table)
4. Index contenant les documents à lire (ex. sensor-readings-*).
5. Port
   • Généralement 9200 pour HTTP.

Correspondances

La correspondance relie les champs/colonnes de la base aux variables définies dans votre source Ferronext. C’est une étape critique pour assurer que les données récupérées s’insèrent correctement dans le modèle de la source.

Étapes recommandées

1. Sélection de la table/collection La plateforme peut lister automatiquement ses champs/colonnes pour faciliter le mapping.

2. Sélection des variables dans la source de donnée Choisissez les variables cibles.

3. Association des champs Sélectionnez les colonnes à mapper sur les différentes variables.

Filtres

Ajoutez des filtres personnalisés pour déploiement uniquement les données correspondant à des critères spécifiques. Pour chaque filtre, vous devez :

• Sélectionner un champ dans votre source.
• Choisir un opérateur (exemples : inférieur ou égal, supérieur ou égal, égal, contient, etc.).
• Renseigner une valeur de comparaison adaptée.

Le type de champ influence les options proposées :

Type de champ	Interface proposée
Date	Sélecteur de date (calendrier)
Texte	Champ texte + opérateur : égal, contient…
Numérique	Champ numérique + opérateur de comparaison
Catégorie	Liste déroulante avec les valeurs possibles

Paramètres de déploiement

Les paramètres définissent quand et comment le module extrait la donnée.

1. Type de déclenchement

• Unique : le déploiement s'exécute une seule fois (ex. extraction historique ponctuelle). Utilisation : backfill ponctuel, récupération d’un dump. Vous devez préciser la date/heure d’exécution.

• Régulier : le déploiement s'exécute périodiquement selon une fréquence. Choix du rythme (exemples disponibles) : 1 minute, 5 minutes, 10 minutes, 15 minutes, 30 minutes, 1 heure, 6 heures, 1 jour.

info

Pour des extraits fréquents, privilégiez des requêtes incrémentales (uniquement les nouvelles lignes après la dernière date traitée).

2. Début du déploiement (date de démarrage)

• Date/heure à laquelle la première exécution aura lieu.
• Pour un déclenchement régulier, c’est la première exécution de la série.

3. Description

• Texte libre pour documenter l’objectif du déploiement. Exemple : Récupération des relevés de température - ligne A.

Résumé

Avant d’enregistrer le déploiement, la page propose un récapitulatif de toutes les informations :

• Paramètres de connectivité.
• Correspondances champs → variables.
• Filtres appliqués.
• Paramètres de déclenchement (type, rythme, date de début).