Services SBPI personnalisés

Les services SBPI personnalisés sont des plug-ins d'intégration définis par l'utilisateur qui peuvent être invoqués par les scripts ou les compléments d' Enterprise Architect , qui peuvent ensuite utiliser les réponses pour manipuler les données du référentiel. Le Custom Plug-In peut être appelé depuis Enterprise Architect en utilisant le Référentiel . Appelez la méthode d'interface d'automatisation SBPI.

La portée de ce qui peut être demandé au service et de ce qu'il peut retourner à Enterprise Architect n'est pas limitée. Par exemple, le service personnalisé pourrait répondre à une demande de collecte d'informations auprès d'un service tiers et les renvoyer au script Enterprise Architect . D'autres utilisations possibles incluent l'exécution d'actions sur les données du modèle elles-mêmes via des appels OSLC ou l'exécution de processus personnalisés sur les données du modèle.

Avantages

Autoriser les demandes et les réponses arbitraires
Une fois configuré pour un modèle, peut être appelé à partir de scripts ou Add-Ins
Durée de vie et transfert des demandes automatiquement gérés par Pro Cloud Server
Peut être écrit dans plusieurs langages de programmation, y compris C++ ou C#

Aperçu

Pour écrire votre propre plug-in de service personnalisé, vous pouvez soit partir de zéro, soit faire une copie de l'un des exemples et le modifier.

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

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

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.

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 de service personnalisé doit implémenter l'interface définie dans ISBPIServicePlugin, qui est incluse dans ISBPIServicePlugin.h (pour C++) ou ISBPIServicePlugin.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 de service via l'interface d'automatisation CallSBPI

Le Plug-in reçoit la requête

Le plug-in analyse la demande et effectue toute action requise (par exemple, appeler un service tiers, effectuer un programme, effectuer des appels exécuter vers Pro Cloud Server )

Le plug-in envoie une 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 utilise dans le script ou le complément

Interface

Fonction/Classe	Détails	Voir également
Créer un plug-in (non requis en C# )	Le plug-in doit implémenter cette fonction d'exportation : externe "C" SBPI_SERVICE_API SBPI_SERVICE_PLUGIN CreatePlugin(); Il doit renvoyer un pointeur vers une classe qui implémente l'interface ISBPIServicePlugin. La mise en œuvre recommandée est : SBPI_SERVICE_PLUGIN CréerPlugin() { renvoie le nouveau ExampleServicePlugin ; } Le ISBPIServicePlugin nouvellement créé peut être supprimé lorsqu'il reçoit la méthode ISBPIServicePlugin::Release.
Interface ISBPIServicePlugin	Le plug-in dll doit implémenter toutes les méthodes dans l'interface ISBPIServicePlugin.	Interface ISBPIServicePlugin

Fonction/Classe

Détails

Voir également

Créer un plug-in (non requis en C# )

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

externe "C" SBPI_SERVICE_API SBPI_SERVICE_PLUGIN CreatePlugin();

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

SBPI_SERVICE_PLUGIN CréerPlugin()

{

renvoie le nouveau ExampleServicePlugin ;

}

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

Interface ISBPIServicePlugin

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