Écrire un plugin d'intégration personnalisé

Nous vivons dans un monde hautement connecté, et bien qu'il existe une formidable liste d'intégrations prêtes à l'emploi fournies avec le Pro Cloud Server , des intégrations personnalisées (propriétaires) peuvent être créées avec n'importe quel produit doté d'une interface de service Web standard. Cette facilité ouvrira à la fois le contenu du référentiel Enterprise Architect à un outil externe et rendra les informations de l'outil externe disponibles dans Enterprise Architect . Par exemple, un outil Gestion de Projet pourrait définir des pages de travail qu'il serait utile de visualiser dans Enterprise Architect , ou un outil de test automatisé pourrait définir des cas de test et des procédures de test qui pourraient être liés à des éléments d'implémentation et de spécification dans Enterprise Architect . Cela nécessitera une certaine expertise technique pour créer une intégration à l'aide d'un certain nombre de langages de programmation tels que C++ ou C# , mais cela ne doit être fait qu'une seule fois et peut être utilisé dans n'importe quel nombre de référentiels.

Le Pro Cloud Server et Enterprise Architect feront le gros du travail, et il n'est pas nécessaire qu'un administrateur modifie les paramètres de sécurité de base du Pro Cloud Server car la nouvelle intégration fonctionnera via les ports et pare-feu existants. Le développeur n'a pas non plus besoin d'écrire du code d'écoute http, ce qui lui permet de se concentrer sur la détermination et la configuration des appels d'API RESTful pour transmettre les informations des éléments externes vers et depuis le serveur.

Lors de l'installation de Pro Cloud Server , activez le composant 'SBPI Examples' pour inclure les exemples d'intégration personnalisés. Lorsqu'il est activé, l'emplacement par défaut des fichiers d'exemple se trouve dans le dossier 'SBPI Examples\ExampleIntegrationPlugins'. Par exemple:

C:\Program Files (x86)\ Sparx Systems \ Pro Cloud Server \SBPI Examples\ExampleIntegrationPlugins

Consultez la rubrique d'aide sur l' Installation Pro Cloud Server pour plus d'informations.

Note que l'option d'installation 'SBPI Examples' n'est pas activée par défaut. Si vous avez déjà installé le Pro Cloud Server sans les "exemples SBPI", vous pouvez soit effectuer une réinstallation complète (en activant les "exemples SBPI"), soit utiliser l'option "Modifier" du programme d'installation pour ajouter uniquement les "exemples SBPI". composant.

Pour écrire votre propre plug-in d'intégration personnalisé, vous pouvez soit partir de zéro, soit faire une copie de l'un des exemples et le modifier. Les plug-ins peuvent être écrits en C++ ou C# .

Les exemples sont écrits à l'aide de Visual Studio 2017 mais ce n'est pas un pré-requis.

Le plug-in d'intégration personnalisée doit implémenter l'interface définie dans ISBPIIntegrationPlugin, qui est incluse dans ISBPIIntegrationPlugin.h (pour C++) ou ISBPIIntegrationPlugin.cs (pour C# ).

Le déroulement général du programme est le suivant :

L'utilisateur effectue une action dans Enterprise Architect qui a besoin d'informations du plug-in d'intégration
Le plug-in recevra un appel (ou plusieurs appels) vers la méthode d'interface appropriée
Le plug-in analyse la demande et, si nécessaire, fait sa propre demande au fournisseur de données réel
Le plug-in reçoit le résultat du fournisseur réel et analyse les données
Le plug-in envoie la réponse à Enterprise Architect via les fonctions de rappel fournies ; il peut s'agir soit des données réelles demandées, soit d'une valeur d'erreur
Enterprise Architect reçoit les données de rappel et les affiche à l'utilisateur

Fonction/Classe	Détails	Voir également
VérifierVersion	(Non requis en C# .) entrée : version int non signée Renvoie true si votre Plug-in supporte la version demandée. La version 2 ajoute des notifications lorsque des éléments dans Enterprise Architect sont liés ou non liés à l'élément externe, ou lorsqu'ils sont modifiés. La version 2 étend la version 1, donc renvoie true pour les versions jusqu'à et y compris la version prise en charge. par exemple retour (version <= 2);
Créer un plug-in	(Non requis en C# .) Le plug-in doit implémenter cette fonction d'exportation : externe "C" SBPI_API SBPI_INTEGRATION_PLUGIN CreatePlugin(); Il doit renvoyer un pointeur vers une classe qui implémente l'interface ISBPIIntegrationPlugin. La mise en œuvre recommandée est : SBPI_INTEGRATION_PLUGIN CréerPlugin() { renvoie un nouveau plugin d'intégration d'exemple ; } Le ISBPIIntegrationPlugin nouvellement créé peut être supprimé lorsqu'il reçoit la méthode ISBPIIntegrationPlugin::Release.
ISBPIIntegrationPlugin Interface	Le plug-in dll doit implémenter toutes les méthodes dans l'interface ISBPIIntegrationPlugin.	ISBPIIntegrationPlugin interface

Fonction/Classe

Détails

Voir également

VérifierVersion

(Non requis en C# .)

entrée : version int non signée

Renvoie true si votre Plug-in supporte la version demandée.

La version 2 ajoute des notifications lorsque des éléments dans Enterprise Architect sont liés ou non liés à l'élément externe, ou lorsqu'ils sont modifiés.

La version 2 étend la version 1, donc renvoie true pour les versions jusqu'à et y compris la version prise en charge.

par exemple retour (version <= 2);

Créer un plug-in

(Non requis en C# .)

Le plug-in doit implémenter cette fonction d'exportation :

externe "C" SBPI_API SBPI_INTEGRATION_PLUGIN CreatePlugin();

Il doit renvoyer un pointeur vers une classe qui implémente l'interface ISBPIIntegrationPlugin. La mise en œuvre recommandée est :

SBPI_INTEGRATION_PLUGIN CréerPlugin()

{

renvoie un nouveau plugin d'intégration d'exemple ;

}

Le ISBPIIntegrationPlugin nouvellement créé peut être supprimé lorsqu'il reçoit la méthode ISBPIIntegrationPlugin::Release.

ISBPIIntegrationPlugin Interface

Le plug-in dll doit implémenter toutes les méthodes dans l'interface ISBPIIntegrationPlugin.

ISBPIIntegrationPlugin interface