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

Installer et configurer

Le produit Sparx Systems Pro Cloud Server s'installe à l'aide d'un paquetage Microsoft Windows Installer standard qui inclut un certain nombre de composants optionnels. L'un de ces composants est Integration Plug-ins, qui est installé par défaut dans le dossier C:\Program Files (x86)\ Sparx Systems \ Pro Cloud Server \SBPI\ (en supposant qu'une machine 64 bits soit utilisée).

Exigences

Pour installer un plug-in d'intégration particulier, vous devez disposer de :

  • Un Pro Cloud Server sous licence
  • Accès réseau entre le serveur PCS et un serveur hébergeant les données externes
  • Informations d'identification de l'utilisateur pour accéder aux données externes
  • Enterprise Architect Corporate , Unified ou Ultimate Edition, v14 ou version ultérieure
    Remarque : l'édition d'essai Enterprise Architect fournit un accès en lecture seule aux intégrations

Qu'y a-t-il dans le paquet?

Le dossier Plug-ins d'intégration se compose initialement d'un exécutable du serveur d'intégration (SBPI.exe), d'un exécutable distinct (*SBPI.exe) pour chaque produit externe pris en charge, d'un exemple de fichier de configuration et d'un fichier texte décrivant les étapes d'installation et de configuration manuelles.

Brancher

Description

Voir aussi

Serveur d'intégration (SBPI)

L'application SBPI.exe agit comme interface entre Pro Cloud Server et chacun des plug-ins, en traduisant les requêtes Enterprise Architect , en les transmettant au plug-in approprié, puis en renvoyant la réponse générée à Enterprise Architect .

Plug-in Gestionnaire du cycle de vie des applications

Le plug-in ALMSbpi.exe interagit avec le produit MicroFocus Application Lifecycle Manager (anciennement connu sous le nom de HP Quality Center).

Module d'extension Autodesk

Le plug-in AutodeskSbpi.exe interagit avec le composant de gestion et de fichiers d'AutoCAD, AutoDesk.

Module d'extension Bugzilla

Le plug-in BugzillaSbpi.exe interagit avec le système de suivi des défauts/bugs basé sur le Web qui a été développé et utilisé à l'origine par le projet Mozilla et est maintenant sous licence dans le cadre de l'accord de licence publique Mozilla.

Plugin Confluence

Le plug-in ConfluenceSbpi.exe interagit avec le logiciel de collaboration en équipe d'Atlassian. Il est capable de lister des espaces et de créer des liens vers des pages.

Note que le contenu des pages HTML Confluence n'est pas synchronisé.

Module d'extension Dropbox

Le plug-in DropboxSbpi.exe interagit avec le service d'hébergement de fichiers Web de Dropbox. Il est capable de répertorier les dossiers dans Dropbox et de créer des liens vers des fichiers individuels.

Module d'extension EA

Le plug-in EASbpi.exe interagit avec les référentiels externes Enterprise Architect Cloud de Sparx Systems . Il est capable de parcourir la hiérarchie Paquetage ou d'effectuer des requêtes basées sur la recherche.

Plug-in Jazz

Le plug-in JazzSbpi.exe interagit avec :

  • Outil de gestion des exigences IBM Rational DOORS Next Generation
  • Gestion de la conception (DM) de Rational Rhapsody
  • Rational Team Concert Gestion des changements et de la configuration (CCM)
  • Responsable Qualité Rational (QM)

Plugin Jira

Le plug-in JiraSbpi.exe interagit avec le système de suivi des problèmes d'Atlassian. Il est capable de lister les filtres favoris d'un utilisateur (également appelés filtres étoilés ). Chaque filtre listera ensuite tous les éléments Jira renvoyés par le filtre.

Salesforce

Le plug-in SalesforceSbpi.exe interagit avec le système de gestion de la relation client de Salesforce.

Plug-in ServiceNow

Le plug-in ServiceNowSbpi.exe interagit avec le composant de gestion des actifs de ServiceNow de son système de gestion d'entreprise basé sur le Cloud.

Plug-in SharePoint

Le plug-in SharePointSbpi.exe interagit avec la plate-forme collaborative Web de Microsoft, SharePoint.

Module d'extension Azure DevOps / TFS

Le plug-in TFSSbpi.exe interagit avec les éléments de travail Azure DevOps / Team Foundation Server (TFS) de Microsoft

Plugin Wrike

Le plug-in WrikeSbpi.exe interagit avec le système de gestion de projet de Wrike.

Comment configurer

Le framework d'intégration se compose d'une application serveur d'intégration (SBPI.EXE) qui démarre un ou plusieurs plug-ins (tels que DropboxSbpi.exe et JiraSbpi.exe). Le serveur d'intégration et chaque plug-in d'intégration peuvent être configurés pour exécuter soit sur la même machine que le Pro Cloud Server , soit sur des machines complètement différentes. Dans la configuration la plus simple, le serveur d'intégration et tous les plug-ins d'intégration sont installés sur un seul serveur. Cette configuration présente deux avantages principaux :

  1. Le Pro Cloud Server démarrera (et arrêtera) automatiquement tous les plug-ins configurés chaque fois que son service Windows est démarré (ou arrêté).
  2. L'interface graphique de configuration d'intégration intégrée au client de configuration Cloud peut être utilisée pour gérer complètement tous les aspects de la configuration d'intégration ; voir le tableau Étapes - Simple .
Toutefois, si vous choisissez d' exécuter le serveur d'intégration ou les plug-ins d'intégration sur des machines différentes de celles du Pro Cloud Server , chacun des plug-ins individuels doit être configuré manuellement et configuré pour démarrer en tant que services Windows avec les paramètres corrects. Consultez le tableau Étapes - Manuel .

Étapes - Simple

L'interface graphique de configuration d'intégration incluse dans le client de configuration Cloud élimine la majeure partie de la complexité liée à la configuration du serveur d'intégration et des fournisseurs de données. Il s'agit donc de la méthode recommandée pour la plupart des utilisateurs. Cependant, cette méthode de configuration est limitée à l'exécution de tous les composants d'intégration (*SBPI.exe) sur le même serveur que le Pro Cloud Server .

Étape

Description

Voir aussi

Configuration de Pro Cloud Server pour l'intégration

Chaque installation de Sparx Systems Pro Cloud Server peut être configurée pour communiquer avec un seul serveur d'intégration ; les options de configuration de cette définition sont définies comme une série de paramètres de registre. Cependant, l'onglet « Intégration » dans le client de configuration Pro Cloud Server permet la définition et la maintenance des options du serveur d'intégration sans que vous ayez besoin de manipuler manuellement le registre ou les fichiers de configuration.

Cette image montre la définition d'un serveur d'intégration avec les paramètres par défaut :

Alternativement, le serveur d'intégration et les plug-ins peuvent être configurés via l'interface WebConfig. Pour plus de détails, consultez la rubrique WebConfig - Plugins d'intégration .

Configuration des fournisseurs de données d'intégration

Chaque fournisseur de données (ou plug-in) est défini à la fois comme une série d'entrées de registre dans [HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\ Plugins \{unique} et comme des paramètres dans un fichier de configuration. Là encore, l'onglet « Intégration » du client de configuration Cloud permet de définir et de gérer les détails du fournisseur de données d'intégration sans avoir à manipuler manuellement le registre et les fichiers de configuration.

Ajouter/modifier un fournisseur de données

Configuration du pare-feu

Afin de minimiser les règles de pare-feu nécessaires pour configurer le Pro Cloud Server et ses fonctionnalités , la version 4.1 de PCS achemine maintenant toutes les requêtes pour le serveur d'intégration (SBPI.exe) via les ports PCS normaux. Par conséquent, si vous utilisez PCS 4.1 ou une version ultérieure, aucune règle de pare-feu supplémentaire n'est nécessaire, à l'exception de celles permettant au client Enterprise Architect de communiquer avec le Pro Cloud Server .

Pour les versions 3 et 4 du PCS, le serveur d'intégration (SBPI.exe) doit généralement bénéficier d'un accès via un pare-feu local afin que les clients Enterprise Architect puissent s'y connecter. Le programme d'installation Pro Cloud Server crée automatiquement une exception de pare-feu qui permet à toutes les demandes entrantes d'être transmises à SBPI.exe. Toutefois, les paramètres par défaut doivent être revus et ajustés en fonction de votre environnement.

Étapes - Manuel

Important : ces étapes ne sont nécessaires que si les composants d'intégration doivent être exécuter sur des machines différentes de celles du Pro Cloud Server . Sinon, le tableau Étapes - Simple doit être utilisé.

Étape

Description

Voir aussi

Configuration de Pro Cloud Server pour l'intégration

Chaque installation de Sparx Systems Pro Cloud Server peut être configurée pour communiquer avec un seul serveur d'intégration (ou SBPI). Ces options de configuration sont définies sous la forme d'une série de paramètres de registre.

Voici un exemple de toutes les options valides pour le serveur d'intégration :

[HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\Server]

"Activé" = "true"

"LocalPort"=dword:00001f90

"UseLegacy" = "false"

"Arguments"="-port 8080 -protocole http"

"Protocole"="https"

"Serveur"="localhost"

"Port"=dword:00001f90

"IgnoreSSLErrors" = "true"

"AttemptAutoDiscovery" = "true"

"ClientProtocol"="http"

"ClientServer" = "nom du serveur alternatif"

"ClientPort"=dword:00001f90

  • Activé - vrai ou faux, représentant le numéro de port sur lequel le serveur SBPI doit écouter, dont valeur doit correspondre à la valeur spécifiée dans les arguments ; par exemple, dword:00001f90 (décimal 8080)
  • LocalPort - une valeur hexadécimale, représentant le numéro de port sur lequel le serveur d'intégration écoute lorsque l'option Utiliser l'héritage est FAUX ; par exemple, dword:00001f90 (décimal 8080)
  • UseLegacy - true ou false, contrôle si l'ensemble simple (false) ou complexe (true) d'options de configuration doit être utilisé par le serveur d'intégration
  • Arguments - non utilisés dans Pro Cloud Server 4.1 ou versions ultérieures ; dans les versions antérieures, cela représente les arguments utilisés pour démarrer le serveur d'intégration, qui incluent le port et le protocole sur lesquels le serveur doit écouter, par exemple, « -port 8080 -protocol http »
  • Protocole - http ou https, le protocole qui doit être utilisé pour communiquer avec la machine hébergeant le serveur d'intégration lorsque l'option Utiliser l'héritage est VRAI ; ce champ est combiné avec le « Serveur » et le « Port » pour former l'URL du serveur d'intégration, à laquelle le Pro Cloud Server enverra les requêtes liées à SBPI
    Note : l'URL complète ({protocole}://{nom-du-serveur}:{port} doit pouvoir être résolue par la machine Pro Cloud Server
  • Serveur - le nom (ou le numéro IP) de la machine hébergeant le serveur d'intégration lorsque l'option Utiliser l'héritage est VRAIE (par exemple, votredomaine.com) ; ce champ est combiné avec le « Protocole » et le « Port » pour former l'URL du serveur d'intégration, à laquelle le Pro Cloud Server enverra les requêtes liées à SBPI
    Note : l'URL complète ({protocole}://{nom-du-serveur}:{port} doit pouvoir être résolue par la machine Pro Cloud Server
  • Port - une valeur hexadécimale, représentant le numéro de port sur lequel le serveur d'intégration écoute lorsque l'option Utiliser l'héritage est VRAI - par exemple, dword:00001f90 (décimal 8080) ; ce champ est combiné avec le « Protocole » et le « Serveur » pour former l'URL du serveur d'intégration, à laquelle le Pro Cloud Server enverra les requêtes liées à SBPI
    Note : l'URL complète ({protocole}://{nom-du-serveur}:{port} doit pouvoir être résolue par la machine Pro Cloud Server
  • IgnoreSSLErrors - true ou false, définit si les erreurs liées à SSL qui se produisent lors de la communication avec le composant Integration Server doivent être ignorées lorsque l'option Utiliser l'héritage est TRUE
  • AttemptAutoDiscovery - true ou false, définit si le Pro Cloud Server doit automatiquement tenter de déterminer l'adresse réseau du client Enterprise Architect et la fournir au serveur d'intégration lorsque l'option Utiliser l'héritage est VRAI
  • ClientProtocol - http ou https, définit le protocole qui, lorsqu'il est combiné avec « ClientServer » et « ClientPort », forme l'URL résoluble que les clients Enterprise Architect peuvent communiquer au serveur d'intégration lorsque l'option Utiliser l'héritage est VRAI
    Note : l'URL complète ({protocole}://{nom-du-serveur}:{port} doit pouvoir être résolue par la machine cliente Enterprise Architect
  • ClientServer - définit le nom du serveur (ou le numéro IP) qui, lorsqu'il est combiné avec « ClientProtocol » et « ClientPort », forme l'URL résoluble que les clients Enterprise Architect peuvent communiquer au serveur d'intégration lorsque l'option Utiliser l'héritage est VRAI
    Note : l'URL complète ({protocole}://{nom-du-serveur}:{port} doit pouvoir être résolue par la machine cliente Enterprise Architect
  • ClientPort - une valeur hexadécimale définissant le numéro de port qui, lorsqu'il est combiné avec « ClientProtocol » et « ClientServer », forme l'URL résoluble que les clients Enterprise Architect peuvent communiquer au serveur d'intégration lorsque l'option Utiliser l'héritage est VRAI ; par exemple, dword:00001f90 (décimal 8080)
    Note : l'URL complète ({protocole}://{nom-du-serveur}:{port} doit pouvoir être résolue par la machine cliente Enterprise Architect
Note : à partir de la version 4.1 de Pro Cloud Server , le serveur d'intégration n'a pas besoin de disposer de ses propres règles de pare-feu pour que les clients Enterprise Architect puissent communiquer avec lui. Pour les versions 3 et 4 de PCS, le serveur d'intégration (SBPI.exe) doit généralement disposer d'un accès via un pare-feu local pour que les clients puissent s'y connecter. Le programme d'installation Pro Cloud Server crée automatiquement une exception de pare-feu qui permet de transmettre toute demande entrante. Toutefois, les paramètres par défaut doivent être revus et ajustés en fonction de votre environnement.

Configuration des fournisseurs de données

Chaque fournisseur de données est défini comme une série d'entrées de registre dans :

[HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\ Plugins \{unique}

où {unique} est un UUID unique pour le fournisseur de données.

Voici un exemple de définition complète d'un fournisseur de données externes :

[HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\ Plugins \{853489C1-4C22-4bad-9A8E-3098D07A3FC1}]

"Démarrage automatique" = "true"

"Activé" = "true"

"Groupe"=" "

"Nom"=" Exemple de compte Sparx Systems "

"Port"=dword:00001f91

"Préfixe"="jr1"

"TypeKey" = "jira"

"Arguments" = "-port 8081 -config jr.config"

"Config" = "jr1.config"

  • AutoStart - true ou false, définit si le serveur d'intégration (SBPI.exe) doit maintenir un processus en cours d'exécution (*sbpi.exe) pour ce fournisseur de données
  • Activé - vrai ou faux, définit si le serveur d'intégration (SBPI.exe) doit autoriser la transmission des communications à ce fournisseur de données
  • Groupe - une valeur facultative qui peut être utilisée pour « trier » les fournisseurs en groupes lorsqu'ils sont affichés dans Enterprise Architect
  • Nom - un nom de projet « convivial » pour décrire le fournisseur de données externe, qui est affiché à tous les utilisateurs Enterprise Architect ; par exemple « Compte d'exemple Sparx Systems »
  • Port - une valeur hexadécimale représentant le numéro de port sur lequel la source de données externe s'attend à recevoir des requêtes, dont valeur doit correspondre à la valeur spécifiée dans les arguments ; par exemple, dword:00001f91 (décimal 8081)
  • Préfixe - un nom court et unique qui est significatif pour les utilisateurs et qui préfixe chaque lien stocké dans le modèle Enterprise Architect ; par exemple, jr1::10001 (où 10001 est l' ID object Jira)
  • TypeKey - définit le type de fournisseur du fournisseur de données actuel ; seules ces valeurs prises en charge peuvent être utilisées : cint, csvc, alm, ad, bug, cflu, drop, ea, jazz, jira, sf, maintenant , sp, tfs, wrike
  • Arguments - obsolète à partir de PCS 4.1, une liste d'arguments dynamique est construite à partir des paramètres individuels ; les versions antérieures utilisaient ce champ pour définir les arguments à utiliser pour démarrer le plug-in d'intégration, y compris le port, le protocole et le nom du fichier de configuration
  • Config - obsolète à partir de PCS 4.1, le nom du fichier de configuration est maintenant le préfixe avec un '.config' ; dans les versions PCS 3 et PCS 4, ce champ a reçu une valeur indépendante qui devait être unique
Chaque fournisseur de données externe nécessite son propre ensemble d'options pour définir les détails de la manière dont le plug-in configuré se connecte à la source de données externe. Ces paramètres sont stockés dans un fichier .config qui se trouve au même emplacement que le fichier .exe du plug-in. Par exemple, en utilisant la définition ci-dessus, un fichier « jr1.config » devrait être créé et contiendrait des informations similaires à celles-ci :

PROTOCOLE=https

SERVEUR=exemple.com

PORT=443

BASEURL=monprojet

NOM D'UTILISATEUR=

MOT DE PASSE=

CREATEITEMS=faux

MODIFYITEMS=faux

POST-DISCUTIONS = vrai

PROXY=10.0.0.0:3128

PROXYBYPASS=<local>;10.*

IGNORESSERRORS=vrai

  • PROTOCOLE - le protocole de communication, http ou https
  • SERVEUR - le nom (ou le numéro IP) du serveur de la source de données externe, tel que example.com
  • PORT - le port sur lequel la source de données externe est configurée pour écouter, tel que 443
  • BASEURL - lorsque la source de données externe supporte plusieurs « projets », la propriété BaseURL identifie celui qui doit être utilisé ; par exemple, pour Enterprise Architect SBPI, la BaseURL est l'alias de la base de données tel que défini dans le PCS
  • NOM D'UTILISATEUR - facultatif - voir Note 1
  • MOT DE PASSE - facultatif - voir Note 1
  • CREATEITEMS - définit si les utilisateurs Enterprise Architect peuvent créer des éléments dans la source de données externe - voir Remarque 2 ; valeur par défaut : false
  • MODIFYITEMS - définit si les utilisateurs Enterprise Architect peuvent modifier les éléments existants dans la source de données externe - voir Note2 ; valeur par défaut : false
  • POSTDISCUSSIONS - définit si les utilisateurs Enterprise Architect peuvent ajouter des discussions aux éléments de la source de données externe - voir Note2 ; valeur par défaut : true
  • PROXY - facultatif - le nom du serveur ou le numéro IP et le port du serveur proxy, tel que 10.0.0.0:3128
  • PROXYBYPASS - facultatif - une liste séparée par des points-virgules de numéros IP qui ne doivent pas être envoyés via le proxy ; par exemple, <local> ;10.*
  • IGNORESSLERRORS - facultatif - une valeur booléenne pour ignorer les erreurs de certificat SSL

Note 1

  • Si le serveur externe supporte l'authentification OAuth 2 (Autodesk, Dropbox et Wrike), lors de l'accès depuis Enterprise Architect , une fenêtre de navigateur s'ouvre et vous prompt à vous log au compte externe et à autoriser Enterprise Architect à accéder à votre compte
  • Enterprise Architect ne voit jamais vos informations d'identification dans ce processus ; à la place, il reçoit un jeton unique pour accéder au compte externe
  • Si le serveur externe autorise l'authentification de base, le nom d'utilisateur et le mot de passe peuvent être éventuellement définis dans le fichier de configuration
  • Si le nom d'utilisateur et le mot de passe ne sont pas spécifiés dans le fichier de configuration, Enterprise Architect vous prompt des informations d'identification pour accéder aux données externes
Note 2
  • Tous les produits externes ne prennent pas support la création et la modification de leurs objets ; par exemple, Dropbox ne le fait pas.

Configuration des modèles pour les fournisseurs de données externes

Pour que les utilisateurs d'un modèle Enterprise Architect puissent se connecter à un fournisseur de données externe donné, une « liaison » entre le modèle Enterprise Architect et le fournisseur de données externe doit être configurée. Cette opération est effectuée par une série de paramètres de registre dans [HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\Bindings\{unique}] pour chaque combinaison modèle/fournisseur de données externe. Dans cette string , {unique} est un nombre hexadécimal à 8 chiffres identifiant de manière unique la liaison. Par exemple :

[HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\Bindings\B6EE6851]

"LocalModel" = "eaexample"

"Plugin"="{853489C1-4C22-4bad-9A8E-3098D07A3FC1} "

  • LocalModel - l'alias DB du modèle, tel que « eaexample »
  • Plugin - l'UUID de la source de données externe ; par exemple, {853489C1-4C22-4bad-9A8E-3098D07A3FC1}

Notes spéciales

Utilisation de SSL au niveau du serveur d'intégration ou du fournisseur

Si vous choisissez d'implémenter le protocole HTTPS au niveau du serveur d'intégration ou du fournisseur d'intégration, les exécutables d'intégration (*SBPI.EXE) nécessiteront un fichier « server.pem » dans le même dossier qu'eux-mêmes ; par conséquent, si vous utilisez le chemin d'installation par défaut, cela signifie que « server.pem » doit être placé dans le dossier C:\Program Files (x86)\ Sparx Systems \ Pro Cloud Server \SBPI\.

Consultez la section Certificats SSL dans la rubrique d'aide Ajouter une définition de port et les Certificats SSL auto-signés Rubrique d'aide pour plus d'informations sur la façon de créer un fichier « server.pem » valide.

Le plug-in d'intégration pour Exigences Enterprise Architect :

  • L'URL de base comme alias de base de données du modèle
  • Le modèle défini configuré comme « Activé » et « Activer Fonctionnalités Pro (OSLC, WebEA et intégration) » dans le Pro Cloud Server