Utiliser OpenHEXA (version héritée)

Premiers pas¶

Une fois que vous ou quelqu'un de votre organisation a terminé le processus d'installation, vous devez compléter quelques étapes simples avant de pouvoir utiliser OpenHEXA :

1. Créer une équipe
2. Inviter quelques utilisateurs
3. Ajouter vos premières sources de données

Passons en revue le processus.

Créer une équipe¶

Tout d'abord, connectez-vous en tant qu'utilisateur root créé pendant le processus d'installation.

Ensuite, connectez-vous à OpenHEXA et, à l'aide du menu déroulant utilisateur, accédez à la section Admin.

Vous pouvez ensuite accéder à la section User management > Teams et ajouter une nouvelle équipe :

Vous n'avez besoin que de fournir un nom pour le moment, vous attribuerez les utilisateurs à l'équipe ultérieurement.

Inviter des utilisateurs¶

Maintenant que votre équipe est créée, vous pouvez inviter des utilisateurs. Allez simplement dans la section User management > Users du panneau d'administration et ajoutez un utilisateur :

À cette étape, sauf si vous avez vraiment besoin de choisir le mot de passe vous-même, vous devriez ignorer le formulaire de mot de passe : lorsque vous soumettez le formulaire de création d'utilisateur, le système enverra un email d'invitation à l'utilisateur contenant un lien lui permettant de choisir son propre mot de passe.

Ajouter une première source de données¶

Maintenant que nous avons une équipe et quelques utilisateurs, ajoutons une source de données. Nous utiliserons le connecteur DHIS2 comme exemple, le processus est presque identique pour les autres sources de données. Nous utiliserons l'instance de démonstration officielle DHIS2.

Le processus est le suivant :

Tout d'abord, allez dans DHIS2 connector > DHIS2 API Credentials dans le panneau d'administration et cliquez sur Add DHIS2 API Credentials.

Après avoir enregistré les identifiants, allez dans DHIS2 connector > DHIS2 Instances et cliquez sur Add DHIS2 instance.

Il vous suffit de sélectionner les identifiants API créés ci-dessus, de fournir l'URL de l'API et un nom pour l'instance. Enregistrez le formulaire et c'est terminé : vous avez ajouté vos premières sources de données dans OpenHEXA.

Vous voudrez peut-être ajouter d'autres sources de données à ce stade, par exemple un bucket AWS S3 — le processus est presque le même que pour une instance DHIS2, à l'exception de la partie identifiants.

Utiliser le catalogue¶

Le catalogue de données peut être utilisé pour explorer et rechercher des données dans vos sources de données.

Explorer les données¶

Allez simplement à l'interface principale OpenHEXA (c'est-à-dire quittez le panneau d'administration si vous y êtes encore) et allez dans Catalog.

À partir de là, vous pouvez voir la liste des sources de données connectées et les explorer en mode drill-down.

Rechercher des données¶

Pour utiliser le moteur de recherche OpenHEXA, cliquez simplement sur recherche dans le menu principal ou appuyez sur CMD-K, ce qui ouvrira la modale de recherche rapide. À partir de là, vous pouvez soit :

• Saisir un terme de recherche et parcourir les résultats dans la modale de recherche
• Passer à la recherche avancée

La fonctionnalité de recherche avancée vous permettra de filtrer vos résultats de recherche par type de contenu et/ou par source de données.

Utiliser les notebooks¶

L'environnement notebooks est un environnement Jupyter personnalisé.

Pour la plupart des fonctionnalités, vous pouvez vous référer à la documentation officielle JupyterLab.

OpenHEXA apporte quelques ajouts utiles aux fonctionnalités standard de Jupyter :

• Montage des buckets S3 / GCS dans le système de fichiers de votre serveur Jupyter pour un accès plus facile aux données
• Provisionnement de variables d'environnement pour les identifiants de vos sources de données
• Préinstallation d'une série de bibliothèques Python et R intéressantes

De plus, les pages de sources de données dans le catalogue de données fournissent généralement des exemples de code illustrant comment vous pouvez utiliser la source de données dans un notebook.

Utiliser les pipelines de données¶

🚧 Cette section est encore en cours de développement

OpenHEXA utilise Apache Airflow pour exécuter les pipelines de données en arrière-plan.

Avant de pouvoir utiliser un pipeline de données, vous devez :

• Provisionner une instance Airflow et y connecter un dépôt Git pour les DAGs (voir les instructions d'installation)
• Configurer un Template DAG et un ou plusieurs DAGs à l'aide du panneau d'administration dans la section Airflow Connector
• Configurer les sources de données auxquelles le pipeline peut accéder (dans Airflow Connector > Dag authorized datasources)

Une fois votre DAG correctement configuré, vous pouvez voir le pipeline correspondant dans l'interface principale OpenHEXA et l'exécuter avec la configuration souhaitée.