Réserver une Démo

SVP notez : Cette page d’aide n’est pas pour la dernière version d’Enterprise Architect. La dernière aide peut être trouvée ici.

Pré. Proc.

Installer et configurer

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

Exigences

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

  • Un Pro Cloud Server sous licence
  • Accès réseau physique à 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
    Nb : L'édition d'essai Enterprise Architect fournit un accès en lecture seule aux intégrations

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

Le dossier Integration Plug-ins 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

La description

Voir également

Serveur d'intégration (SBPI)

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

Plug-in du gestionnaire de cycle de vie des applications

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

Plug-in Autodesk

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

Plug-in BugzillaComment

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

Plug-in Confluence

Le plug-in ConfluenceSbpi.exe interagit avec le logiciel Team Collaboration 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 de Confluence n'est pas synchronisé.

Plug-in 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.

Plug-in EA

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

Plugin Jazz

Le plug-in JazzSbpi.exe interagit avec :

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

Plugin Jira

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

Force de vente

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.

Plug-in Azure DevOps/TFS

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

Plug-in Wrike

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

Comment configurer

L'infrastructure d'intégration se compose d'une application de 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 être 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. Il y a deux avantages principaux avec cette configuration :

  1. Le Pro Cloud Server démarre (et arrête) 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 de exécuter au serveur d'intégration ou aux plug-ins d'intégration sur des machines différentes du Pro Cloud Server , chacun des plug-ins individuels doit être configuré manuellement et configuré pour démarrer en tant que services Windows avec le bon paramètres. Voir le tableau Étapes - Manuel .

Étapes - simples

L'interface graphique de configuration d'intégration incluse dans le client de configuration du Cloud supprime la majeure partie de la complexité liée à la configuration du serveur d'intégration et du ou 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 .

Marcher

La description

Voir également

Configuration 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 du Pro Cloud Server permet la définition et la maintenance des options du serveur d'intégration sans que vous ayez à manipuler manuellement le registre ou la configuration des dossiers.

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. Voir la rubrique WebConfig - Integration Plug-ins pour plus de détails.

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 paramètres dans un fichier de configuration. Encore une fois, l'onglet "Intégration" dans le client de configuration Cloud permet la définition et la maintenance des détails du fournisseur de données d'intégration sans que vous ayez à 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 , PCS version 4.1 achemine maintenant toutes les requêtes pour le serveur d'intégration (SBPI.exe) via les ports PCS normaux, donc si vous utilisez PCS 4.1 ou une version ultérieure, il aucune règle de pare-feu supplémentaire n'est nécessaire autre que 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 être autorisé à accéder via n'importe quel pare-feu local afin que les clients Enterprise Architect puissent s'y connecter. Le programme d'installation de Pro Cloud Server créera automatiquement une exception de pare-feu qui permet à toutes les demandes entrantes d'être transmises à SBPI.exe ; cependant, 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 seront exécuter sur des machines différentes du Pro Cloud Server , sinon le tableau Étapes - Simple doit être utilisé.

Marcher

La description

Voir également

Configuration 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 comme 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é"="vrai"

"LocalPort"=dword:00001f90

"UseLegacy"="faux"

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

"Protocole"="https"

"Serveur"="localhost"

"Port"=dword:00001f90

"IgnoreSSLErrors"="true"

"AttemptAutoDiscovery"="true"

"Protocole Client"="http"

"ClientServer"="nom du serveur alternatif"

"ClientPort"=dword:00001f90

  • Activé - vrai ou faux, représentant le numéro de port sur lequel le serveur valeur doit écouter, dont la 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 Use Legacy est FALSE ; par exemple, dword:00001f90 (décimal 8080)
  • UseLegacy - true ou false, contrôle si l'ensemble d'options de configuration simple (false) ou complexe (true) 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 Use Legacy est TRUE ; ce champ est combiné avec le 'Serveur' et le 'Port' pour former l'URL du serveur d'intégration, auquel le Pro Cloud Server enverra les demandes liées à SBPI
    Note : L'URL complète ({protocol}://{server-name} :{port} doit pouvoir être résolue par la machine Pro Cloud Server
  • Serveur - le nom (ou numéro IP) de la machine hébergeant le serveur d'intégration lorsque l'option Use Legacy est TRUE (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 demandes liées à SBPI
    Note : L'URL complète ({protocol}://{server-name} :{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 Use Legacy est TRUE - 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 demandes liées à SBPI
    Note : L'URL complète ({protocol}://{server-name} :{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 Use Legacy 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 de la fournir au serveur d'intégration lorsque l'option Use Legacy est TRUE
  • 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 Use Legacy est TRUE
    Note : L'URL complète ({protocol}://{server-name} :{port} doit pouvoir être résolue par la machine cliente d' Enterprise Architect
  • ClientServer - définit le nom du serveur (ou numéro IP) qui, lorsqu'il est combiné avec le 'ClientProtocol' et 'ClientPort', forme l'URL résoluble que les clients Enterprise Architect peuvent communiquer au serveur d'intégration lorsque l'option Use Legacy est TRUE
    Note : L'URL complète ({protocol}://{server-name} :{port} doit pouvoir être résolue par la machine cliente d' 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 Use Legacy est TRUE ; par exemple, dword:00001f90 (décimal 8080)
    Note : L'URL complète ({protocol}://{server-name} :{port} doit pouvoir être résolue par la machine cliente d' Enterprise Architect
Note : À partir de la version 4.1 du Pro Cloud Server , le Serveur d'intégration n'a pas besoin d'avoir ses propres règles de pare-feu pour que les clients Enterprise Architect puissent communiquer avec lui. Pour les versions PCS 3 et 4, le serveur d'intégration (SBPI.exe) doit généralement être autorisé à accéder via n'importe quel pare-feu local afin que les clients puissent s'y connecter. Le programme d'installation de Pro Cloud Server créera automatiquement une exception de pare-feu qui permet à toute demande entrante d'être transmise ; cependant, 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 de fournisseur de données externe :

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

"Démarrage automatique"="vrai"

"Activé"="vrai"

"Groupe"=" "

"Name"=" Exemple de compte Sparx Systems "

"Port"=dword:00001f91

"Préfixe"="jr1"

"TypeKey"="jira"

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

"Config"="jr1.config"

  • AutoStart - vrai ou faux, 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 le transfert des communications vers 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é pour tous les utilisateurs d' Enterprise Architect ; par exemple ' Sparx Systems Sample account'
  • 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, laquelle valeur doit correspondre à la valeur spécifiée dans les arguments ; par exemple, dword:00001f91 (décimal 8081)
  • Préfixe - un nom unique court 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ètes à partir de PCS 4.1, une liste d'arguments dynamiques 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 avait 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 façon dont le plug-in configuré se connecte à la source de données externe. Ces paramètres sont stockés dans un fichier .config qui réside au même emplacement que le fichier .exe du plug-in. Par exemple, en utilisant la définition ci-dessus, un 'jr1.config' devrait être créé et contiendrait des informations similaires à ceci :

PROTOCOLE=https

SERVEUR=exemple.com

PORT=443

BASEURL=monprojet

NOM D'UTILISATEUR=

MOT DE PASSE=

CREATEITEMS=faux

MODIFYITEMS=false

POSTDISCUSSIONS=vrai

PROXY=10.0.0.0:3128

PROXYBYPASS=<local>;10.*

IGNORESSLERRORS=vrai

  • PROTOCOLE - le protocole de communication, http ou https
  • SERVER - 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, par exemple 443
  • BASEURL - lorsque la source de données externe prend en 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 base de données tel que défini dans le PCS
  • USERNAME - facultatif - voir Note1
  • MOT DE PASSE - facultatif - voir Remarque1
  • CREATEITEMS - définit si les utilisateurs Enterprise Architect peuvent créer des éléments dans la source de données externe - voir Note2 ; valeur par défaut : valeur
  • 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 : valeur
  • POSTDISCUSSIONS - définit si les utilisateurs Enterprise Architect peuvent ajouter des discussions aux éléments dans la source de données externe - voir Note2 ; valeur par défaut : valeur
  • PROXY - facultatif - le nom du serveur ou le numéro IP et le port du serveur proxy, par exemple 10.0.0.0:3128
  • PROXYBYPASS - facultatif - une liste de numéros IP séparés par des points-virgules 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 prend en supporte l'authentification OAuth 2 (Autodesk, Dropbox et Wrike), lors de l'accès depuis Enterprise Architect , une fenêtre de navigateur s'ouvrira 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 est fourni avec 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 éventuellement être 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 en support la création et la modification de leurs objets ; par exemple, Dropbox ne

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

Pour que les utilisateurs d'un modèle Enterprise Architect se connectent à 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. Ceci est effectué 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"

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

  • LocalModel - l'alias de base de données 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 signifierait que 'server.pem' devrait être placé dans le dossier C:\Program Files (x86)\ Sparx Systems \ Pro Cloud Server \SBPI\.

Voir la section Certificats SSL dans la rubrique d'aide Add a Port Definition et les Self-Signed SSL Certificates Rubrique d'aide pour plus d'informations sur la création d'un fichier 'server.pem' valide.

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

  • La BaseURL comme alias de base de données du modèle
  • Le modèle défini configuré comme 'Enabled' et 'Enable Pro Fonctionnalités (OSLC, WebEA and Integration)' dans le Pro Cloud Server