Partage via

Génération, déploiement et débogage d'objets personnalisés

  • Article

S’applique à : SQL Server SSIS Integration Runtime dans Azure Data Factory

Après avoir écrit le code d’un objet personnalisé pour Integration Services, vous devez générer l’assembly, le déployer, l’intégrer dans le concepteur SSIS afin qu’il puisse être utilisé dans des packages, puis le tester et le déboguer.

Étapes pour générer, déployer et déboguer un objet personnalisé pour Integration Services

Vous avez déjà écrit les fonctionnalités personnalisées de votre objet. À présent, vous devez les tester et les rendre disponibles aux utilisateurs. Les étapes sont très similaires pour tous les types d'objets personnalisés que vous pouvez créer pour Integration Services.

Voici les étapes à suivre pour générer, déployer et tester votre objet personnalisé.

  1. Signez l’assembly à générer à l’aide d’un nom fort.

  2. Générez l’assembly.

  3. Déployez l’assembly en le déplaçant ou en le copiant dans le dossier Integration Services approprié.

  4. Installez l’assembly dans le Global Assembly Cache (GAC).

    L'objet est automatiquement ajouté à la boîte à outils.

  5. Résolvez les problèmes liés au déploiement, si nécessaire.

  6. Testez et déboguez votre code.

Vous pouvez désormais utiliser le concepteur SSIS dans SQL Server Data Tools (SSDT) pour créer, gérer et exécuter des packages qui ciblent différentes versions de SQL Server. Pour plus d’informations sur l’impact de cette amélioration sur vos extensions personnalisées, consultez Getting your SSIS custom extensions to be supported by the multi-version support of SSDT 2015 for SQL Server 2016.

Signature de l'assembly

Lorsqu'un assembly est destiné à être partagé, il doit être installé dans le Global Assembly Cache. Une fois que l'assembly est ajouté au Global Assembly Cache, il peut être utilisé par des applications telles que SQL Server Data Tools (SSDT). Une exigence du Global Assembly Cache stipule que l'assembly doit être signé avec un nom fort, lequel garantit qu'un assembly est globalement unique. Un assembly avec nom fort possède un nom qualifié complet qui comprend son nom, sa culture, sa clé publique et son numéro de version. Le runtime utilise ces informations pour rechercher l'assembly et le distinguer des autres assemblys portant le même nom.

Pour signer un assembly avec un nom fort, vous devez d'abord avoir ou créer une paire de clés publique/privée. Cette paire de clés de chiffrement publique et privée est utilisée au moment de la génération pour créer un assembly avec nom fort.

Pour plus d'informations sur les noms forts et sur les étapes à suivre pour signer un assembly, consultez les rubriques suivantes dans la documentation du Kit de développement logiciel .NET Framework :

  • Assemblys avec noms forts

  • Création d'une paire de clés

  • Signature d'un assembly avec un nom fort

Vous pouvez signer facilement votre assembly avec un nom fort dans Visual Studio au moment de la génération. Dans la boîte de dialogue Propriétés du projet, sélectionnez l’onglet Signature. Sélectionnez l’option Signer l’assembly et indiquez le chemin du fichier de clé (.snk).

Génération de l'assembly

Après avoir signé le projet, vous devez générer ou regénérer le projet ou la solution en utilisant les commandes disponibles dans le menu Générer de SQL Server Data Tools. Votre solution peut contenir un projet séparé d' interface utilisateur personnalisée, lequel doit également être signé avec un nom fort et peut être généré en même temps.

La méthode la plus pratique pour effectuer les deux étapes suivantes, à savoir le déploiement de l’assembly et son installation dans le Global Assembly Cache, consiste à écrire le script de ces étapes sous la forme d’un événement post-build dans Visual Studio. Les événements de génération sont disponibles sur la page Compiler des propriétés d’un projet Visual Basic et sur la page Événements de génération d’un projet C#. Le chemin complet est requis pour les utilitaires d’invite de commandes tels que gacutil.exe. Les guillemets sont requis à la fois autour des chemins d'accès qui contiennent des espaces et autour des macros telles que $(TargetPath) qui s'étendent aux chemins d'accès qui contiennent des espaces.

Voici un exemple de ligne de commande d'événement après génération pour un module fournisseur d'informations personnalisé :

"C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin\NETFX 4.0 Tools\gacutil.exe" -u $(TargetName)  
"C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin\NETFX 4.0 Tools\gacutil.exe" -i $(TargetFileName)  
copy $(TargetFileName) "C:\Program Files\Microsoft SQL Server\130\DTS\LogProviders "

Déploiement des assemblys

Le concepteur SSIS localise les objets personnalisés disponibles dans les packages en énumérant les fichiers trouvés dans une série de dossiers créés lors de l’installation de SQL Server Integration Services. Lorsque les paramètres d’installation SQL Server par défaut sont utilisés, cet ensemble de dossiers se trouve sous C:\Program Files\Microsoft SQL Server\130\DTS. Toutefois, si vous créez un programme d’installation pour votre objet personnalisé, vous devez examiner la valeur de la clé de Registre HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\130\SSIS\Setup\DtsPath pour vérifier l’emplacement de ce dossier.

Notes

Pour plus d’informations sur le déploiement des composants personnalisés de manière appropriée pour qu’ils fonctionnent correctement avec la prise en charge multi-version de SQL Server Data Tools, consultez Getting your SSIS custom extensions to be supported by the multi-version support of SSDT 2015 for SQL Server 2016.

Vous pouvez placer l'assembly dans le dossier de deux manières :

  • Déplacez ou copiez l'assembly compilé vers le dossier approprié après l'avoir généré. (Par commodité, vous pouvez inclure la commande de copie dans un événement après génération.)

  • Générez directement l'assembly dans le dossier approprié.

Les dossiers de déploiement suivants situés sous C:\Program Files\Microsoft SQL Server\130\DTS sont utilisés pour les différents types d’objets personnalisés :

Objet personnalisé Dossier de déploiement
Tâche Tâches
Gestionnaire de connexions Connexions
Module fournisseur d'informations LogProviders
Composant de flux de données PipelineComponents

Notes

Les assemblys sont copiés vers ces dossiers pour prendre en charge l'énumération des tâches, gestionnaires de connexions, etc. disponibles. Par conséquent, vous ne devez pas déployer des assemblys qui contiennent uniquement l'interface utilisateur personnalisée des objets personnalisés vers ces dossiers.

Installation de l'assembly dans le Global Assembly Cache

Pour installer l’assembly de tâche dans le Global Assembly Cache (GAC), utilisez l’outil en ligne de commande gacutil.exe ou faites glisser les assemblys vers le répertoire %system%\assembly. Par commodité, vous pouvez également inclure l’appel de gacutil.exe dans un événement post-build.

La commande suivante installe un composant nommé MyTask.dll dans le GAC en utilisant gacutil.exe.

gacutil /iF MyTask.dll

Vous devez fermer et rouvrir le Concepteur SSIS après avoir installé une nouvelle version de votre objet personnalisé. Si vous avez installé des versions antérieures de votre objet personnalisé dans le Global Assembly Cache, vous devez les supprimer avant d'installer la nouvelle version. Pour désinstaller un assembly, exécutez gacutil.exe et spécifiez le nom de l’assembly avec l’option /u.

Pour plus d'informations sur le Global Assembly Cache, consultez Global Assembly Cache Tool (Gactutil.exe) dans .NET Framework Tools.

Dépannage du déploiement

Si votre objet personnalisé apparaît dans la boîte à outils ou la liste des objets disponibles, mais que vous n’êtes pas en mesure de l’ajouter à un package, essayez la procédure suivante :

  1. Recherchez plusieurs versions de votre composant dans le Global Assembly Cache. S'il existe plusieurs versions du composant dans le Global Assembly Cache, il est possible que le concepteur ne soit pas en mesure de charger votre composant. Supprimez toutes les instances de l'assembly dans le Global Assembly Cache et ajoutez de nouveau l'assembly.

  2. Assurez-vous qu'une seule instance unique de l'assembly existe dans le dossier de déploiement.

  3. Actualisez la boîte à outils.

  4. Attachez Visual Studio à devenv.exe et définissez un point d’arrêt pour parcourir pas à pas votre code d’initialisation afin de vérifier qu’aucune exception ne se produit.

Test et débogage du code

L’approche la plus simple pour déboguer les méthodes d’exécution d’un objet personnalisé consiste à démarrer dtexec.exe à partir de Visual Studio après avoir généré votre objet personnalisé et à exécuter un package qui utilise le composant.

Si vous souhaitez déboguer les méthodes de conception du composant, comme la méthode Validate, ouvrez un package qui utilise le composant dans une deuxième instance de Visual Studio et effectuez un attachement à son processus devenv.exe.

Si vous souhaitez également déboguer les méthodes d’exécution du composant lorsqu’un package est ouvert et en cours d’exécution dans le concepteur SSIS, vous devez forcer une pause dans l’exécution du package afin de pouvoir également effectuer un attachement au processus DtsDebugHost.exe.

Pour déboguer les méthodes d'exécution d'un objet à l'aide d'un attachement à dtexec.exe

  1. Signez et générez votre projet dans la configuration de débogage, déployez-le et installez-le dans le Global Assembly Cache comme indiqué dans cette rubrique.

  2. Sous l’onglet Déboguer des Propriétés du projet, sélectionnez Démarrer le programme externe comme Première action et localisez dtexec.exe, installé par défaut dans C:\Program Files\Microsoft SQL Server\130\DTS\Binn.

  3. Dans la zone de texte Options de ligne de commande, sous Options de démarrage, entrez les arguments de ligne de commande requis pour exécuter un package qui utilise votre composant. Souvent, l'argument de ligne de commande sera consitué du commutateur /F[ILE] suivi du chemin d'accès et du nom du fichier .dtsx. Pour plus d'informations, consultez Utilitaire dtexec.

  4. Définissez des points d'arrêt dans le code source aux emplacements appropriés dans les méthodes d'exécution de votre composant.

  5. Exécutez votre projet.

Pour déboguer les méthodes de conception d'un objet personnalisé via un attachement aux outils de données SQL Server

  1. Signez et générez votre projet dans la configuration de débogage, déployez-le et installez-le dans le Global Assembly Cache comme indiqué dans cette rubrique.

  2. Définissez des points d'arrêt dans le code source aux emplacements appropriés dans les méthodes de conception de votre objet personnalisé.

  3. Ouvrez une deuxième instance de Visual Studio et chargez un projet Integration Services qui contient un package qui utilise l'objet personnalisé.

  4. Dans la première instance de Visual Studio, effectuez un attachement à la deuxième instance de devenv.exe dans laquelle le package est chargé en sélectionnant Attacher au processus dans le menu Déboguer de la première instance.

  5. Exécutez le package à partir de la deuxième instance de Visual Studio.

Pour déboguer les méthodes d'exécution d'un objet personnalisé via un attachement aux outils de données SQL Server

  1. Après avoir effectué les étapes répertoriées dans la procédure précédente, forcez une pause dans l’exécution de votre package afin de pouvoir effectuer un attachement à DtsDebugHost.exe. Vous pouvez forcer cette pause en ajoutant un point d’arrêt à l’événement OnPreExecute ou en ajoutant une tâche de script à votre projet et en entrant un script qui affiche une zone de message modale.

  2. Exécutez le package. Lorsque la pause se produit, basculez vers l’instance de Visual Studio dans laquelle votre projet de code est ouvert et sélectionnez Attacher au processus dans le menu Déboguer. Assurez-vous d’effectuer l’attachement à l’instance de DtsDebugHost.exe répertoriée sous le nom Managé, x86 dans la colonne Type, et non à l’instance répertoriée sous le nom x86 seulement.

  3. Revenez au package mis en pause et passez le point d’arrêt, ou cliquez sur OK pour fermer le message généré par la tâche de script, puis continuez l’exécution et le débogage du package.

Voir aussi

Développement d’objets personnalisés pour Integration Services
Persistance des objets personnalisés
Outils de dépannage pour le développement des packages