Réserver une Démo
Pré. Proc.

Écrire un plugin d'intégration personnalisé

Nous vivons dans un monde hyperconnecté et, bien que le Pro Cloud Server propose une liste impressionnante d'intégrations prêtes à l'emploi, il est possible de créer des intégrations personnalisées (propriétaires) avec n'importe quel produit doté d'une interface de service web standard. Cette facilité permet d'ouvrir le contenu du référentiel Enterprise Architect à un outil externe et de rendre les informations de cet outil externe accessibles au sein Enterprise Architect . Par exemple, un outil Gestion de Projet peut définir des pages de travail utiles à visualiser dans Enterprise Architect , ou un outil de test automatisé peut définir des cas et des procédures de test liés aux éléments d'implémentation et de spécification d' Enterprise Architect . La création d'une telle intégration requiert une certaine expertise technique pour utiliser un langage de programmation comme C++ ou C# , mais cette opération n'est nécessaire qu'une seule fois et peut être réutilisée pour un nombre illimité de référentiels.

Le Pro Cloud Server et Enterprise Architect prennent en charge les aspects techniques complexes. L'administrateur n'a pas besoin de modifier 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. De même, le développeur n'a pas à écrire de code d'écoute HTTP et peut se concentrer sur la définition et la configuration des appels d'API RESTful pour la transmission des informations des éléments externes vers et depuis le serveur.

Lors de l'installation du Pro Cloud Server , activez le composant « Exemples SBPI » pour inclure les exemples d'intégration personnalisés. Une fois activé, l'emplacement par défaut des fichiers d'exemple est le dossier « SBPI Examples\ExampleIntegrationPlugins ». Par exemple :

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

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

Note que l'option d'installation « Exemples SBPI » n'est pas activée par défaut. Si vous avez déjà installé 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 le composant « Exemples SBPI ».

Pour créer votre propre plug-in d'intégration personnalisé, vous pouvez soit partir de zéro, soit copier un exemple 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 une condition préalable.

Le plug-in d'intégration personnalisé doit implémenter l'interface définie dans ISBPIIntegrationPlugin, qui est inclus 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 nécessite des informations provenant du plug-in d'intégration.
  • Le plug-in recevra un appel (ou plusieurs appels) à la méthode d'interface appropriée
  • Le plug-in analyse la requête et, si nécessaire, effectue sa propre requête auprès du fournisseur de données.
  • 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 demandées, soit d’une valeur d’erreur.
  • Enterprise Architect reçoit les données de rappel et les affiche à l'utilisateur.

Function/Class

Details

See also

CheckVersion

(Not required in C#.)

input: unsigned int version

Returns true if your Plug-in supports the requested version.

Version 2 adds notifications when elements in Enterprise Architect are linked or unlinked to the external item, or when they are modified.

Version 2 extends version 1, so returns true for versions up to and including the version supported.

e.g. return (version <= 2);

Create Plug-in

(Not required in C#.)

The Plug-in must implement this export function:

     extern "C" SBPI_API SBPI_INTEGRATION_PLUGIN CreatePlugin();

It must return a pointer to a class that implements the ISBPIIntegrationPlugin interface. The recommended implementation is:

     SBPI_INTEGRATION_PLUGIN CreatePlugin()

     {

           return new ExampleIntegrationPlugin;

     }

The newly created ISBPIIntegrationPlugin can be deleted when it receives the ISBPIIntegrationPlugin::Release method.

ISBPIIntegrationPlugin Interface

The dll Plug-in must implement all methods in the ISBPIIntegrationPlugin interface.

 ISBPIIntegrationPlugin interface
Pré. Proc.