Pré. | Proc. |
Services SBPI personnalisés
Les services SBPI personnalisés sont des plug-ins d'intégration définis par l'utilisateur qui peuvent être appelés par les scripts ou Add-ins d' Enterprise Architect , qui peuvent ensuite utiliser les réponses pour manipuler les données du référentiel. Le plug-in personnalisé peut être appelé depuis Enterprise Architect à l'aide de la méthode d'interface d'automatisation Référentiel . CallSBPI.
La portée de ce qui peut être demandé au service et de ce qu'il peut renvoyer à Enterprise Architect n'est pas limitée. Par exemple, le service personnalisé peut 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 lui-même via des appels OSLC ou l'exécution de processus personnalisés sur les données du modèle.
Avantages
- Autoriser les demandes et réponses arbitraires
- Une fois configuré pour un modèle, il peut être appelé à partir de scripts ou Add-Ins
- Durée de vie et transfert des demandes gérés automatiquement par Pro Cloud Server
- Peut être écrit dans plusieurs langages de programmation, notamment 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 « Exemples SBPI » 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 \Exemples SBPI\ExampleServicePlugins
Consultez la rubrique Aide Installation Pro Cloud Server pour plus d’informations.
Note : 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 ».
Les plug-ins peuvent être écrits en C++ ou en C# .
Les exemples sont écrits à l’aide de Visual Studio 2017, mais ce n’est pas une condition préalable.
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 exécute une action dans Enterprise Architect qui nécessite des informations du plug-in de service via l'interface d'automatisation CallSBPI
- Le plug-in reçoit la demande
- Le plug-in analyse la requête et exécute toute action requise (par exemple, appeler un service tiers, exécuter un programme, effectuer des appels OSLC 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 module complémentaire
Interface
Fonction/Classe |
Détails |
Voir aussi |
---|---|---|
Create Plug-in (not required in C#) |
The Plug-in must implement this export function: extern "C" SBPI_SERVICE_API SBPI_SERVICE_PLUGIN CreatePlugin(); It must return a pointer to a Class that implements the ISBPIServicePlugin interface. The recommended implementation is: SBPI_SERVICE_PLUGIN CreatePlugin() { return new ExampleServicePlugin; } The newly created ISBPIServicePlugin can be deleted when it receives the ISBPIServicePlugin::Release method. |
|
Interface ISBPIServicePlugin |
Le plug-in dll doit implémenter toutes les méthodes de l'interface ISBPIServicePlugin. |
Interface ISBPIServicePlugin |
Apprendre encore plus
- Classe Référentiel (voir méthode CallSBPI )