Manuel utilisateur
Ce guide décrit le flux d’utilisation complet de Data Source Explorer (DSE).
Utilisez-le lorsque vous voulez une référence détaillée couvrant :
- l’exploration et la découverte
- la revue et le test des connexions
- la navigation dans les objets
- le travail sur le schéma catalogue et le catalogue de données
- la composition des cibles de sortie
- la génération des déployables
- la revue des résultats, du schéma graphique et de l’export
- la persistance de l’espace de travail et de la configuration de job
1. Rôle de l’application
DSE est une application de bureau orientée opérateur, conçue pour découvrir des sources de données, inspecter leur structure, préparer des définitions d’extraction ou de mapping, puis générer des artefacts de sortie réutilisables.
Le flux habituel est le suivant :
- choisir une cible et lancer Discover
- inspecter l’arborescence des sources découvertes
- revoir ou modifier la connexion
- tester la connectivité
- charger tables / collections / buckets / autres objets
- examiner la structure et l’aperçu des données
- construire un Schema Catalog / Data Catalog utile
- composer des cibles de sortie lorsque des objets de destination sont nécessaires
- générer des déployables pour une ou plusieurs cibles d’exécution
- revoir les fichiers générés et, si besoin, produire le schéma graphique
2. Organisation de la fenêtre principale
Zone de commandes en haut
Elle permet de :
- choisir la langue
- utiliser le menu Workspace
- ouvrir Plugins, Logs et Help
- changer le thème
- choisir la cible de découverte puis cliquer sur Discover
Arborescence de navigation à gauche
La zone gauche affiche l’environnement découvert. Selon le contexte, vous pouvez voir :
- des bases de données
- des tables
- des vues
- des collections
- des buckets
- des stockages de fichiers/objets
- des nœuds cloud ou SaaS
- des nœuds liés au mainframe
Zone de travail à droite
Elle affiche :
- le résumé de la source sélectionnée
- les actions propres à cette source
- les listes d’objets
- des onglets de détail comme table info, preview, row details, catalog schema, data catalog et output data
3. Démarrer une session
- Lancez l’application.
- Sélectionnez la langue de l’interface si nécessaire.
- Dans la zone cible, saisissez la machine, l’hôte, l’environnement ou le chemin de découverte à inspecter.
- Choisissez le type de découverte si plusieurs modes sont proposés.
- Cliquez sur Discover.
Bonnes pratiques
- Commencez par un périmètre limité.
- Vérifiez que vous êtes dans le bon environnement avant de modifier les connexions ou de générer des sorties.
- Enregistrez l’espace de travail dès qu’un état utile a été obtenu.
4. Découvrir et explorer les sources
Après la découverte, examinez attentivement l’arborescence de gauche.
Points à vérifier :
- les icônes de type de source
- les noms des sources
- les indications d’hôte ou d’endpoint
- les statuts tels que reachable, offline, local only ou configured
- les nœuds enfants comme bases, tables, collections, buckets ou services
Flux recommandé
- développez l’arborescence niveau par niveau
- sélectionnez une source d’intérêt
- lisez le résumé à droite
- décidez si vous devez ouvrir les détails, modifier la connexion, retirer le scope ou poursuivre vers le chargement des objets
5. Revoir les détails et modifier la connexion
Pour la source sélectionnée, DSE peut proposer des actions comme :
- Open details
- Edit connection
- Remove scope
- Test connection
- Load tables
- Run sample query
- Generate deployables
- Compose targets
Open details
Affiche un résumé technique en lecture seule du nœud ou de la connexion sélectionnée.
Edit connection
À utiliser lorsque :
- la source a été découverte mais nécessite des identifiants
- l’hôte, le port, la base, le service ou le chemin doivent être corrigés
- vous souhaitez surcharger une chaîne de connexion ou un endpoint
Séquence recommandée :
- modifiez uniquement les champs nécessaires
- enregistrez la connexion
- lancez immédiatement Test connection
- poursuivez ensuite avec le chargement des objets ou la génération des déployables
6. Tester la connexion
Utilisez Test connection avant toute opération importante.
Un bon test confirme que :
- l’endpoint est joignable
- l’authentification fonctionne
- la base / le service / le bucket sont valides
- le plugin/fournisseur peut communiquer avec la source
Si le test échoue :
- vérifiez l’hôte, le port et le nom d’instance/service
- vérifiez les identifiants
- vérifiez les restrictions réseau et le pare-feu
- vérifiez que le driver/plugin attendu est installé et activé
- ouvrez Logs pour obtenir plus de détails
7. Charger les objets et inspecter la structure
Après un test réussi, cliquez sur Load tables ou sur la commande équivalente.
Selon le type de source, cela peut charger :
- des tables et vues relationnelles
- des collections documentaires
- des buckets et measurements
- d’autres groupes d’objets
Comment inspecter les objets
- sélectionnez un objet dans la liste
- consultez Table info ou l’onglet équivalent
- ouvrez Preview pour voir des lignes ou documents d’exemple
- utilisez Row details pour examiner un enregistrement précis
- consultez Catalog Schema et Data Catalog pour transformer la structure en définition réutilisable
8. Construire le Schema Catalog et le Data Catalog
Schema Catalog
Utilisez cette zone pour définir la vue structurelle des objets source pertinents pour l’extraction ou le déploiement.
Data Catalog
Utilisez cette zone pour enrichir ou revoir les champs et objets sélectionnés dans une perspective plus réutilisable et orientée utilisateur.
Bonnes pratiques
- gardez le catalogue ciblé
- évitez d’ajouter des objets expérimentaux sauf s’ils doivent apparaître dans la sortie finale
- vérifiez les noms avant de passer à la composition des cibles
9. Générer directement les Output Data
Utilisez Output Data lorsque vous souhaitez produire des artefacts de données à partir du catalogue sélectionné.
Cas d’usage :
- runs de validation
- échantillonnage
- revue opérateur
- confirmation du comportement des mappings et de l’accès aux données
Types de sortie courants :
- CSV
- Excel (
.xlsx) - JSON de synthèse ou fichiers de log
Avant un run important :
- confirmez les objets sélectionnés
- confirmez les formats de sortie
- confirmez les limites de lignes le cas échéant
- confirmez le dossier de sortie
10. Composer les cibles de sortie
Utilisez Compose targets lorsque vous avez besoin de mappings orientés destination, et pas seulement d’exploration de source.
Dans le compositeur, vous travaillez généralement avec trois niveaux :
- lignes/champs source disponibles à gauche
- une ou plusieurs cibles au centre
- les objets cible et les mappings de champs à droite
Flux type
- créez une cible de destination
- choisissez le preset ou le type de système cible
- créez un ou plusieurs objets cible
- sélectionnez les lignes/champs source
- ajoutez-les à l’objet cible sélectionné
- relisez la grille de mappings
- corrigez les avertissements de validation
- enregistrez la définition de cible
Conseils de validation
Corrigez avant l’enregistrement :
- noms de cible manquants
- doublons de noms
- noms de champs invalides pour la technologie choisie
- mappings manquants
11. Générer des déployables
Utilisez Generate deployables pour produire un runner portable ou des artefacts associés à partir du catalogue et/ou de cibles enregistrées.
Modes d’entrée
DSE prend en charge deux approches :
- utiliser directement la sélection courante du catalogue
- utiliser un ou plusieurs saved output targets
Avec les cibles enregistrées activées, vous pouvez ajouter des cibles depuis la liste, constituer un ensemble multi-cible, basculer entre les chips et supprimer une cible du job courant.
Section Destination instance
Elle configure la manière dont le déployable se connectera à la destination ou interprétera la définition de cible.
Champs à relire :
- catégorie de cible
- nom d’instance/site
- hôte/IP
- port
- base/service/chemin
- utilisateur
- mot de passe
- surcharge de chaîne de connexion
Plates-formes et runtimes
Choisissez une ou plusieurs plates-formes, puis un ou plusieurs runtime identifiers compatibles.
Output options
Choisissez les fichiers que le runner doit produire, par exemple :
- CSV
- Excel
Vérifiez aussi :
- le nombre maximal de lignes par objet
- le dossier de sortie
- l’inclusion éventuelle des chaînes de connexion dans le schéma généré
Panneau de readiness
Avant de générer, lisez la zone de préflight/readiness.
Elle doit indiquer s’il manque encore :
- des plates-formes
- des runtimes
- des formats de sortie
- un dossier de sortie
- une définition d’entrée valide
Générer
Quand tout est prêt :
- vérifiez les cibles et chips sélectionnés
- vérifiez les valeurs de destination
- vérifiez plates-formes, runtimes, formats et dossier
- cliquez sur Generate
12. Persistance de la configuration de job
Quand vous quittez Generate deployables, l’application peut demander si vous voulez conserver la configuration.
Si vous la conservez
La prochaine ouverture peut restaurer :
- les cibles enregistrées sélectionnées
- la chip active
- les valeurs de destination
- les sélections de plate-forme et RID
- les options de sortie
- le dossier de sortie
- les limites de lignes
- les autres paramètres du job
Si vous ne la conservez pas
La configuration temporaire est supprimée.
13. Revoir les déployables générés
Après génération, DSE affiche une vue de synthèse.
Utilisez-la pour :
- inspecter les entrées produites
- ouvrir le dossier de sortie
- afficher les résultats
- lancer immédiatement le runner lorsqu’un chemin de lancement direct est disponible
14. Revoir les résultats d’exécution
La fenêtre de résultats est la surface de validation post-run.
Elle peut fournir :
- la liste des fichiers générés
- leur type et taille
- des actions d’ouverture de fichier
- un aperçu par onglets pour CSV/Excel
- un aperçu texte pour JSON/log/texte
- des chips de synthèse indiquant le nombre de fichiers, le nombre de types, la disponibilité de l’aperçu et l’état du schéma graphique
Flux recommandé
- ouvrez la fenêtre de résultats
- sélectionnez chaque fichier au moins une fois
- inspectez les onglets ou le texte
- vérifiez les nombres de lignes et les noms de colonnes
- ouvrez le fichier sur disque si une validation externe est nécessaire
15. Générer le schéma graphique
Dans la fenêtre de résultats, utilisez Generate schema pour construire un graphe visuel du run.
Le graphe peut relier :
- Data Source Explorer
- les sources découvertes
- les objets sélectionnés, comme tables, collections ou buckets
- les cibles configurées
- les fichiers de sortie générés
C’est utile pour :
- la documentation
- la revue opérateur
- la validation de conception
- l’explication d’un run à une autre personne
Pendant la construction, l’indicateur de progression doit montrer qu’une activité est en cours.
Save graph
Utilisez Save graph pour exporter le schéma dans un format pris en charge, comme :
- SVG
- PNG
- BMP
- draw.io
- PlantUML / UML text
- HTML preview
16. Workspaces
Utilisez le menu Workspace pour gérer des sessions réutilisables.
Actions courantes :
- ouvrir un nouveau workspace
- ouvrir un workspace existant
- workspaces récents
- enregistrer le workspace courant
- enregistrer sous
- importer/exporter XML
- enregistrer et quitter
Recommandation
- enregistrez après une phase de découverte réussie
- enregistrez à nouveau après le travail de catalogue
- enregistrez à nouveau après la composition des cibles si le mapping est important
- utilisez Save As avant une expérimentation majeure
17. Plugins, Logs et Help
Plugins
Ouvrez Plugins pour revoir les fournisseurs/extensions disponibles. Si un type de source manque ou se comporte différemment, vérifiez d’abord l’état du plugin.
Logs
Ouvrez Logs dès que vous avez besoin de détails techniques sur la découverte, la connexion, la génération ou l’exécution.
Help
Ouvrez Help pour la documentation consultable. Appuyez sur F1 pour l’aide contextuelle.
18. Séquence d’exploitation recommandée
- ouvrez ou créez un workspace
- découvrez le périmètre visé
- sélectionnez une source et revoyez ses détails
- modifiez la connexion si nécessaire
- testez la connexion
- chargez les objets
- inspectez l’aperçu et la structure
- construisez le catalogue
- composez les cibles si le run exige un mapping explicite
- ouvrez generate deployables
- choisissez des cibles enregistrées ou l’entrée par catalogue
- relisez destination, plates-formes, runtimes, formats et dossier
- générez le déployable
- ouvrez le résumé puis les résultats
- examinez les fichiers et aperçus
- générez et enregistrez le schéma graphique si une documentation est nécessaire
- enregistrez le workspace
19. Checklist de dépannage
Discovery renvoie trop ou pas assez
- réduisez le périmètre
- vérifiez le type de cible
- confirmez que l’environnement est le bon
Test connection échoue
- vérifiez l’endpoint
- vérifiez les identifiants
- vérifiez la base / le service / le chemin
- vérifiez le réseau et le pare-feu
- inspectez les Logs
Les objets n’apparaissent pas après chargement
- confirmez d’abord que le test de connexion a réussi
- vérifiez les permissions sur la source
- rechargez après correction de la connexion
La génération est bloquée
- vérifiez le panneau de readiness
- assurez-vous d’avoir au moins une plate-forme et un runtime
- assurez-vous qu’un format de sortie et un dossier sont définis
- assurez-vous que la définition d’entrée est valide
Les résultats semblent incomplets
- vérifiez les limites de lignes
- vérifiez que la bonne sélection a été utilisée
- ouvrez directement les fichiers générés sur disque
- consultez les artefacts JSON/log de synthèse pour plus d’informations
20. Recommandations finales
Pour une expérience fiable :
- organisez les workspaces par environnement ou projet
- validez les connexions avant de charger ou générer
- gardez des définitions de cible propres et bien nommées
- relisez les fichiers générés avant de les partager
- utilisez l’export du schéma graphique pour la traçabilité et la documentation