インストールと設定

Proクラウドサーバのインストーラには、Proクラウドサーバのサービスプログラムや管理ツールのほかに、いくつかの関連機能も含まれています。このなかに、外部ツールと連携するプラグインに関するファイルも含まれています。これらのファイルは、既定の設定では C:\Program Files\Sparx Systems\Pro Cloud Server\SBPI\ folder に保存されます。

必要システム構成

外部ツールとの連携機能を利用するための条件は次の通りです。

Proクラウドサーバが正常に動作している
Proクラウドサーバが外部ツールのサーバ(例: JIRAサーバ)と通信可能
外部ツールのサーバを利用するためのログインIDなどの情報(例:JIRAのアカウントとパスワード)があること

このフォルダに含まれるファイル

インストーラで作成されるフォルダには、連携サーバの実行ファイル (SBPI.exe)、対応する外部ツールと連携するための実行ファイル (*SBPI.exe)およびサンプルの設定ファイルが含まれます。

項目	説明
連携サーバ (SBPIサーバ)	SBPI.exe のプログラムは、Proクラウドサーバと他の外部ツールとの間の管理を行います。
Application Lifecycle Manager プラグイン	ALMSbpi.exe は MicroFocus Application Lifecycle Manager (HP Quality Center) とのやりとりを行う、プラグインアプリケーションです。
Autodesk プラグイン	AutodeskSbpi.exe は AutoDesk とのやりとりを行う、プラグインアプリケーションです。
Bugzilla プラグイン	BugzillaSbpi.exe は Bugzilla とのやりとりを行う、プラグインアプリケーションです。
Confluence プラグイン	ConfluenceSbpi.exeはAtlassianのConflueceとのやりとりを行う、プラグインアプリケーションです。なお、ConfluenceのHTMLページ自体が同期されるわけではありません。
Dropbox プラグイン	DropboxSbpi.exe は Dropbox とのやりとりを行う、プラグインアプリケーションです。Dropboxに保存されている、フォルダおよびファイルが結びつけの対象です。
EA プラグイン	EASbpi.exe は他のProクラウドサーバとのやりとりを行う、プラグインアプリケーションです。パッケージ階層や検索結果と結びつけることができます。
Jazz プラグイン	JazzSbpi.exe は以下のツールとのやりとりを行う、プラグインアプリケーションです。 IBM Rational DOORS Next Generation's Requirement management tool Rational Rhapsody Design Management (DM) Rational Team Concert Change and Configuration Management (CCM) Rational Quality Manager (QM)
Jira プラグイン	JiraSbpi.exe は AtlassianのJira とのやりとりを行う、プラグインアプリケーションです。お気に入りに設定したフィルタの内容を表示します。
Salesforce プラグイン	SalesforceSbpi.exeは Salesforce Customer Relationship Management システムとのやりとりを行う、プラグインアプリケーションです。
ServiceNow プラグイン	ServiceNowSbpi.exe は ServiceNowとのやりとりを行う、プラグインアプリケーションです。
SharePoint プラグイン	SharePointSbpi.exeは、MicrosoftのSharePointとのやりとりを行う、プラグインアプリケーションです。
Azure DevOps / Team Foundation Server (TFS) プラグイン	TFSSbpi.exe は MicrosoftのAzure DevOps / Team Foundation Serverとのやりとりを行う、プラグインアプリケーションです。
Wrike プラグイン	WrikeSbpi.exe は Wrikeとのやりとりを行う、プラグインアプリケーションです。

セットアップ

外部ツールとの連携は連携サーバ (SBPI.EXE) が中心で、このサーバが1つないしは複数の連携プラグインのプログラムを起動します。連携サーバと連携プラグインは、それぞれProクラウドサーバと同じWindowsサーバで動作させることもできますし、異なるWindowsサーバで動作させることもできます。

単純な構成は、連携サーバとすべての連携プラグインをProクラウドサーバと同じ1つのサーバで動作させることです。これには2つのメリットがあります。

Proクラウドサーバを起動すると、連携サーバおよびすべての連携プラグインも同時に起動します。
クラウドサーバ設定ツールから、外部ツールとの連携プラグインに関する設定も行うことができます。

もし、Proクラウドサーバと異なるマシンで利用する場合には、該当のマシンでWindowsのサービスとして動作するように設定し、適切なパラメータを指定して正しく起動するように構成する必要があります。

単純な構成の場合の手順

クラウドサーバ設定ツールに付属するGUIの設定ツールを利用することで、プラグインの設定を簡単に行うことができます。そのため、この方法が多くの方におすすめの方法となります。ただし、すべての連携プラグインのコンポーネント (*SBPI.exe) が同時に1台のサーバで動作することになりますので、性能面で影響が出る可能性もあります。

項目	説明
外部ツールと連携するためにProクラウドサーバを設定する	Proクラウドサーバが外部ツールとの連携を行うための設定は、レジストリに設定されますが、クラウドサーバ設定ツールの外部ツールのタブでこの設定を行うことができます。これにより、設定のためにレジストリを直接編集する必要はありません。
外部ツールを設定する	それぞれの連携プラグインは、レジストリの [HKEY_USERS\.DEFAULT\Software\Sparx Systems\SQLBridge\SBPI\Plugins\{unique}と、設定ファイルにて設定を行います。Proクラウドサーバ設定ツールを利用することで、レジストリや設定ファイルを直接編集する必要はありません。 (参考:連携プラグインの設定)
ファイアーウォールを設定する	連携サーバ (SBPI.exe) はEnterprise Architectクライアントからの接続を受け付ける必要があります。Proクラウドサーバをインストールすると、自動的にこの通信のためのルールがWindowsファイアーウォールに対して設定されます。必要に応じて、この既定のルールを見なし、セキュリティ面で問題がないようにしてください。

手作業での設定する場合の手順

ここで説明する設定は、外部ツールとの連携サーバが、Proクラウドサーバと異なるマシンで動作する場合のみ必要となる設定です。

項目

説明

外部ツールと連携するためにProクラウドサーバを設定する

1つのProクラウドサーバは、1つの外部ツールとの連携サーバと連携できます。この設定はレジストリに定義します。

以下はその定義例です。

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

"Enabled"="true"

"LocalPort"=dword:00001f90

"UseLegacy"="false"

"Arguments"="-port 8080 -protocol http"

"Protocol"="https"

"Server"="localhost"

"Port"=dword:00001f90

"IgnoreSSLErrors"="true"

"AttemptAutoDiscovery"="true"

"ClientProtocol"="http"

"ClientServer"="alternativeservername"

"ClientPort"=dword:00001f90

項目	説明
Enabled	設定内容を有効にするかどうかを true あるいは false で指定します。例: dword:00001f90 (10進数で 8080)
LocalPort	UseLegacyの設定がfalseの場合に、連携サーバが監視・通信するポート番号を指定します。例: dword:00001f90 (10進数で 8080)
UseLegacy	連携サーバが参照する設定について、詳細な設定(true) あるいは簡易な設定(false) で指定します。
Arguments	連携サーバを起動する際の引数です。例にあるように、通信するポート番号を指定する必要があります。例: "-port 8080"
Protocol	連携サーバとの通信プロトコルを、http か https のいずれかで指定します。他の設定と組み合わせ、({protocol}://{server-name}:{port} の形で通信を行います。Proクラウドサーバのマシンからこの設定で通信可能である必要があります。
Server	連携サーバが動作するマシン名(あるいはIPアドレス)を指定します。この内容はEnterprise Architectクライアントに転送されますので、Enterprise Architectの利用者のマシンから解決可能な情報でなければなりません。
Port	16進数で、連携サーバが通信するポートを指定する必要があります。Argumentsとして指定する内容と一致しなければなりません。例: dword:00001f90 (10進数の 8080)
IgnoreSSLErrors	この設定をtrueにすると、SSLに関連するエラーがある場合でも無視します。
AttemptAutoDiscovery	Proクラウドサーバが、Enterprise Architectクライアントのネットワークのアドレスを自動的に判別するかどうかをtrue あるいは false で指定します。
ClientProtocol	Enterprise Architectと連携サーバとの通信プロトコルを、http か https のいずれかで指定します。他の設定と組み合わせ、({protocol}://{server-name}:{port} の形で通信を行います。Enterprise Architectが動作するマシンからこの設定で通信可能である必要があります。
ClientServer	連携サーバが動作するマシン名(あるいはIPアドレス)を指定します。この内容はEnterprise Architectクライアントに転送されますので、Enterprise Architectの利用者のマシンから解決可能な情報でなければなりません。
ClientPort	16進数で、連携サーバが通信するポートを指定する必要があります。Argumentsとして指定する内容と一致しなければなりません。例: dword:00001f90 (10進数の 8080)

それぞれの外部ツールでは、連携プラグインから外部ツールのデータを参照・編集するための追加の情報が必要です。これらの設定はconfigファイルに保存されます。このファイルは、プラグインのexeファイルと同じ位置に配置されます。

外部ツールを設定する

それぞれの外部ツールは、レジストリ [HKEY_USERS\.DEFAULT\Software\Sparx Systems\SQLBridge\SBPI\Plugins\{unique} に設定する必要があります。 {unique} は、外部ツールごとの一意なUUIDを指定します。以下は定義の一例です。

[HKEY_USERS\.DEFAULT\Software\Sparx Systems\SQLBridge\SBPI\Plugins\

{853489C1-4C22-4bad-9A8E-3098D07A3FC1}]

"AutoStart"="true"

"Enabled"="true"

"Group"=""

"Name"="Sparx Systems Sample account"

"Port"=dword:00001f91

"Prefix"="jr1"

"TypeKey"="jira"

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

"Config"="jr1.config"

項目	説明
AutoStart	連携サーバが外部ツールとのプロバイダ(*sbpi.exe)を自動的に起動するかどうかを true あるいは false で指定します。
Enabled	連携サーバが外部ツールとのプロバイダと通信するかどうかを true あるいは false で指定します。
Group	Enterprise Architect内でグループ化して表示する場合のグループ番号を指定します。
Name	外部ツールのデータを利用者に示す文字列を指定します。Enterprise Architect内で表示されます。例: 'Sparx Systems Sample account'
Port	連携サーバからの通信を受け取るためのポート番号を16進数で指定します。引数として指定した値と一致する必要があります。例: dword:00001f91
Prefix	外部ツールのデータへのリンクの情報として、Enterprise Architectのモデル内に保存される情報のプレフィックスとなる文字列を指定します。例: jira::10001 (10001 は Jira の object ID です)
TypeKey	外部ツールとの連携機能を示す文字列です。以下のいずれかのみが利用できます。 cint, csvc, alm, ad, bug, cflu, drop, ea, jazz, jira, sf, now, sp, tfs, wrike
Arguments	プラグインを起動する際に実行ファイルに渡す引数(パラメータ)です。ポート番号と設定ファイルのファイル名を渡す必要があります。例: "-port 8081 -config Jira1.config"
Config	バージョン4.1以降では利用しません。

それぞれの外部ツールでは、連携プラグインから外部ツールのデータを参照・編集するための追加の情報が必要です。これらの設定はconfigファイルに保存されます。このファイルは、プラグインのexeファイルと同じ位置に配置されます。例えば、Jiraに関する設定をJira1.configファイルとして作成し、以下のような内容を含む必要があります。

SERVER=example.com

PROTOCOL=https

PORT=443

BASEURL=myproject

USERNAME=

PASSWORD=

CREATEITEMS=false

MODIFYITEMS=false

POSTDISCUSSIONS=true

PROXY=10.0.0.0:3128

PROXYBYPASS=<local>;10.*

IGNORESSLERRORS=true

項目	説明
PROTOCOL	外部サーバを通信するためのプロトコルです。例: https
SERVER	外部ツールのサーバ名(あるいはIPアドレス)です。例: example.com
PORT	外部サーバを通信するためのポート番号です。例: 443
BASEURL	外部ツールが複数のプロジェクトを扱うことが可能で、URLで区別する場合には、そのURLを指定します。例: Enterprise Architect SBPI では、BaseURLとして利用するプロジェクトの別名を指定する必要があります。
USERNAME	下記「追記1」をご覧ください。
PASSWORD	下記「追記1」をご覧ください。
CREATEITEMS	外部ツールのデータの作成が可能かどうかを指定します。下記「追記2」もご覧ください。既定値: false
MODIFYITEMS	外部ツールのデータの編集が可能かどうかを指定します。下記「追記2」もご覧ください。既定値: false
POSTDISCUSSIONS	投稿が可能かどうかを指定します。下記「追記2」もご覧ください。既定値: true
PROXY	オプション - プロキシサーバのIPアドレスを指定します。例: 10.0.0.0:3128
PROXYBYPASS	オプション - プロキシを通さないIPアドレスを指定します。例: <local>;10.*
IGNORESSLERRORS	オプション - SSLの証明書のエラーを無視するかどうかを指定します。

追記1

外部ツールが OAuth 2 認証に対応している場合には、Enterprise Architectから参照する場合にWebブラウザのウィンドウが開き、認証情報を入力できます。
この処理の中で、Enterprise Architect自身は入力された内容を参照したり保存したりすることはありません。外部ツールとの連携では、一時的なトークンを利用して通信します。
外部ツールがベーシック認証に対応している場合には、設定ファイル内にユーザー名とパスワードを設定できます。
設定ファイルでユーザー名とパスワードが指定されていない場合には、外部ツールの内容を参照する際に入力画面を表示します。

追記 2

参照・編集・投稿が可能かどうかは外部ツールに依存します。

プロジェクトとプラグインを結びつける

Enterprise Architectのプロジェクトから外部のツールのデータを参照するためには、Enterprise Architectのプロジェクトと外部ツールの「結びつけ」の設定が必要となります。この設定は、レジストリの [HKEY_USERS\.DEFAULT\Software\Sparx Systems\SQLBridge\SBPI\Bindings\{unique}] に定義します。ここで、 {unique} は16進数8桁の一意な文字列を指定します。以下の内容は定義の一例です。

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

Bindings\B6EE6851]

"LocalModel"="eaexample"

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

項目

説明

LocalModel

対象のプロジェクトの別名です。

例: eaexample

Plugin

外部ツールごとに一意となるIDです。

例: {853489C1-4C22-4bad-9A8E-3098D07A3FC1}

補足事項

統合サーバあるいは外部ツールでSSLを利用する

もし、外部ツールとの通信をHTTPSでおこなう場合には、証明書ファイル "server.pem" が外部ツールのディレクトリあるいは連携サーバのディレクトリに必要です。既定のインストール位置を利用する場合には、"C:\Program Files\SparxSystems Japan\Pro Cloud Server\SBPI" が配置すべき位置になります。

SSL証明書や自己証明書・"server.pem"ファイルの作成方法などはこのヘルプの範囲外となるため、説明していません。

Enterprise Architectプラグイン

BaseURLにはProクラウドサーバで設定する別名を指定してください。
通信先のサーバはProクラウドサーバである必要があります。また、OSLCが有効になっている必要があります。

参照: