安装和配置

Sparx Systems Pro云服务器产品使用标准Microsoft Windows Installer程序包安装，该程序包包含许多可选组件。其中一个组件是Integration Plugins，它默认安装在C：\ Program Files（x86）\ Sparx Systems \ Cloud Services \ SBPI \文件夹中（假设正在使用64位机器）。

要求

要安装特定的Integration Plugin，您必须具有：

许可的Pro Cloud Server
物理网络访问托管外部数据的服务器
用于访问外部数据的用户凭据
Enterprise Architect Ultimate版本v14或更高版本

套餐里有什么？

Integration Plugins文件夹最初由Integration Server可执行文件（SBPI.exe），每个受支持的外部产品的单独可执行文件（* SBPI.exe），示例配置文件和描述手动安装和配置步骤的文本文件组成。

任务	脚本
Integraton（SBPI）服务器	通过转换Enterprise Architect请求，将它们转发到相应的插件，然后将生成的响应返回给Enterprise Architect，SBPI.exe应用程序充当Pro Cloud Server和每个插件之间的接口。
应用程序生命周期管理器插件	ALMSbpi.exe插件与MicroFocus Application Lifecycle Manager产品（以前称为HP Quality Center）交互。
Autodesk插件	AutodeskSbpi.exe插件与AutoCAD的文件和管理组件AutoDesk交互。
Bugzilla插件	BugzillaSbpi.exe插件与最初由Mozilla项目开发和使用的基于Web的缺陷/错误跟踪系统进行交互，现在已根据Mozilla公共许可协议获得许可。
Confluence插件	ConfluenceSbpi.exe插件与Atlassian的团队协作软件进行交互。
Dropbox插件	DropboxSbpi.exe插件与Dropbox基于Web的文件托管服务进行交互。
EA插件	EASbpi.exe插件与外部Sparx Systems的Enterprise Architect基于云的存储库进行交互。
Jazz插件	JazzSbpi.exe插件与IBM Rational DOORS Next Generation的需求管理工具进行交互。
Jira插件	JiraSbpi.exe插件与Atlassian的问题跟踪系统进行交互。
ServiceNow插件	ServiceNowSbpi.exe插件与ServiceNow的基于云的企业管理系统的资产管理组件进行交互。
SharePoint插件	SharePointSbpi.exe插件与Microsoft的基于Web的协作平台SharePoint交互。
Team Foundation Server（TFS）插件	TFSSbpi.exe插件与Microsoft的源代码管理交互。
Wrike插件	WrikeSbpi.exe插件与Wrike的项目管理系统交互。

如何设置

Integration框架由一个集成服务器（SBPI.EXE）应用程序组成，该应用程序启动一个或多个插件（例如DropboxSbpi.exe和JiraSbpi.exe）。可以将Integeration Server和每个Integration插件配置为在与Pro Cloud Server相同的计算机上运行，也可以在完全不同的计算机上运行。在最简单的配置中，Integration服务器和所有集成插件都安装在单个服务器上，此配置有两个主要优点：

1.只要Windows服务启动（或停止），Pro Cloud Server就会自动启动（并停止）所有已配置的插件。

2.内置到Cloud Configuration客户端的Integration配置GUI可用于完全管理Integration配置的所有方面。见表格步骤 - 简单如下。

但是，如果您选择在不同的计算机上运行Integration Server或Integration插件到Pro Cloud Server，则必须手动配置每个插件，并将其配置为使用正确的参数作为Windows服务启动。见表格步骤 - 手册如下。

步骤 - 简单

Cloud Configuration客户端中包含的Integration配置GUI消除了配置Integration Server和Data Provider所涉及的大部分复杂性，因此这是大多数用户的推荐方法。但是，此配置方法仅限于在与Pro Cloud Server相同的服务器上运行所有Integration组件（* SBPI.exe）。

步骤	描述	请参阅
配置Pro Cloud Server进行集成	可以将Sparx Systems Pro Cloud Server的每个安装配置为与单个Integration Server进行通信，此定义的配置选项定义为一系列注册表设置，但Cloud Configuration Client中的Integration选项卡允许定义和维护Integration Server选项，无需用户手动操作注册表。下图显示了具有默认设置的Integration Server的定义：	用户指南
配置集成数据提供程序	每个数据提供程序（或插件）都定义为[HKEY_USERS \ .DEFAULT \ Software \ Sparx Systems \ SQLBridge \ SBPI \ Plugins \ {unique}中的一系列注册表项以及配置文件中的设置。Cloud Configuration Client中的Integration选项卡再次允许定义和维护Integration Data Provider详细信息，而无需用户手动操作注册表和配置文件。	添加/编辑数据提供者
配置防火墙	通常需要通过任何本地防火墙授予集成服务器（SBPI.exe）访问权限，以便Enterprise Architect客户端可以连接到它。Pro Cloud Server安装程序将自动创建防火墙例外，允许任何传入请求传递到SBPI.exe; 但是，应检查并调整默认设置以适合您的环境。

步骤

描述

请参阅

配置Pro Cloud Server进行集成

可以将Sparx Systems Pro Cloud Server的每个安装配置为与单个Integration Server进行通信，此定义的配置选项定义为一系列注册表设置，但Cloud Configuration Client中的Integration选项卡允许定义和维护Integration Server选项，无需用户手动操作注册表。

下图显示了具有默认设置的Integration Server的定义：

用户指南

配置集成数据提供程序

每个数据提供程序（或插件）都定义为[HKEY_USERS \ .DEFAULT \ Software \ Sparx Systems \ SQLBridge \ SBPI \ Plugins \ {unique}中的一系列注册表项以及配置文件中的设置。Cloud Configuration Client中的Integration选项卡再次允许定义和维护Integration Data Provider详细信息，而无需用户手动操作注册表和配置文件。

添加/编辑数据提供者

配置防火墙

通常需要通过任何本地防火墙授予集成服务器（SBPI.exe）访问权限，以便Enterprise Architect客户端可以连接到它。Pro Cloud Server安装程序将自动创建防火墙例外，允许任何传入请求传递到SBPI.exe; 但是，应检查并调整默认设置以适合您的环境。

步骤 - 手动

重要说明：仅当Integration组件需要在不同的计算机上运行到Pro Cloud Server时才需要执行这些步骤，否则应使用Steps - Simple。

步骤	描述
配置Pro Cloud Server进行集成	Sparx Systems Pro云服务器的每个安装都可以配置为与单个集成（或SBPI）服务器通信，这些配置选项被定义为一系列注册表设置。这是Integration服务器的所有有效选项的示例： [HKEY_USERS \ .DEFAULT \ Software \ Sparx Systems \ SQLBridge \ SBPI \ Server] "Arguments"="-port 8080" "Port"=dword:00001f90 "Path"="C:\\Program Files (x86)\\Sparx Systems\\Cloud Services\\SBPI\\SBPI.exe" "Protocol"="http" "Server"="yourdomain.com" 参数 - 用于启动SBPI服务器的参数，包括服务器应侦听的端口; 例如“-port 8080” 端口 - 十六进制值，表示SBPI服务器应侦听的端口号，该值应与参数中指定的值匹配; 例如双字：00001f90（十进制8080）路径 - SBPI服务器EXE的完整路径; 当SBPI.EXE和Pro Cloud Server在同一台机器上运行时，PCS将尝试在此位置启动SBPI.exe; 例如“C：\\ Program Files（x86）\\ Sparx Systems \\ Cloud Services \\ SBPI \\ SBPI.exe” 协议 - 应该用于与托管SBPI服务器的计算机通信的协议; 即http或https 服务器 - 托管SPBI服务器的计算机的名称（或IP号）（例如yourdomain.com）; 重要的是要意识到这个地址被转发到客户端（Enterprise Architect），以便它可以发出直接请求，这意味着名称或IP必须可以从客户端机器解析注意：通常需要通过任何本地防火墙授予SBPI服务器访问权限，以便客户端可以连接到该服务器。ProCloudServer安装程序将自动创建一个防火墙例外，允许任何传入的请求通过; 但是，应检查并调整默认设置以适合您的环境。
配置外部数据源	每个外部数据源在[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}] "Arguments"="-port 8081 -config Jira1.config" "Name"="Sparx Systems Sample account" "Path"="C:\\Program Files (x86)\\Sparx Systems\\Cloud Services\\SBPI\\JiraSbpi.exe" "Port"=dword:00001f91 "Prefix"="jira" "Protocol"="http" "Server"="127.0.0.1" "Type"="Jira" 参数 - 应该用于启动插件的参数，包括插件应该监听的端口和配置文件的名称; 例如“-port 8081 -config Jira1.config” 名称 - 描述外部数据源的“友好”项目名称，显示给所有Enterprise Architect用户; 例如'Sparx Systems Sample account' 路径 - 插件EXE的完整路径; 例如C：\ Program Files（x86）\ Sparx Systems \ Cloud Services \ Service \ JiraSbpi.exe Port - 一个十六进制值，表示外部数据源期望接收请求的端口号，该值应与参数中指定的值匹配; 例如：dword：00001f91 前缀 - 对用户有意义的简短唯一名称，并为Enterprise Architect模型中存储的每个链接添加前缀; 例如jira :: 10001（其中10001是Jira对象ID）协议 - 应该用于与托管插件的计算机进行通信的协议; 例如http或https 服务器 - 托管插件的计算机的名称（或IP号）（例如yourdomain.com或127.0.0.1）; 重要的是要意识到这个地址是相对于托管SBPI服务器的机器，因此名称或IP必须可以从SBPI主机解析类型 - 在Enterprise Architect中“分组”外部数据源的通用名称每个外部数据源都需要自己的一组选项来定义配置的插件如何连接到外部数据源的详细信息。这些设置存储在.CONFIG文件中，该文件与插件的.EXE文件位于同一位置。例如，使用上面的定义需要创建“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 SERVER - 外部数据源服务器的名称（或IP号）; 例如example.com 协议 - 通信协议; 例如https PORT - 外部数据源配置为侦听的端口; 例如443 BASEURL - 当外部数据源支持多个“项目”时，BaseURL属性标识应该使用哪个; 例如，对于Enterprise Architect SBPI，BaseURL是PCS中定义的DB别名 USERNAME - 可选 - 请参阅注释1 密码 - 可选 - 见注1 CREATEITEMS - 定义Enterprise Architect用户是否可以在外部数据源中创建项目 - 请参阅注释2; 默认值：false MODIFYITEMS - 定义Enterprise Architect用户是否可以修改外部数据源中的现有项目 - 请参阅注释2; 默认值：false POSTDISCUSSIONS - 定义Enterprise Architect用户是否可以向外部数据源中的项添加讨论 - 请参阅注释2; 默认值：true PROXY - 可选 - 代理服务器的服务器名称或IP号和端口; 例如10.0.0.0:3128 PROXYBYPASS - 可选 - 不应通过代理发送的半号分隔的IP号列表; 例如<local>; 10. * IGNORESSLERRORS - 可选 - 一个布尔值，用于忽略任何SSL证书错误注1 如果外部服务器支持OAuth 2身份验证（Autodesk，Dropbox和Wrike），则在从Enterprise Architect中进行访问时，将打开一个浏览器窗口，提示您登录外部帐户并允许Enterprise Architect访问您的帐户。 Enterprise Architect永远不会在此过程中看到您的凭据，而是为其提供了访问外部帐户的唯一令牌。如果外部服务器允许基本身份验证，则可以在配置文件中选择性地设置用户名和密码。如果未在配置文件中指定用户名和密码，Enterprise Architect将提示您输入用于访问外部数据的凭据。笔记2 并非所有外部产品都支持创建和修改其对象，例如Dropbox。
配置外部数据源的模型	为了使Enterprise Architect模型的用户能够连接到给定的外部数据源，需要配置Enterprise Architect模型和外部数据源之间的“绑定”，这由[HKEY_USERS]中的一系列注册表设置执行。每个模型/外部数据源组合的.DEFAULT \ Software \ Sparx Systems \ SQLBridge \ SBPI \ Bindings \ {unique}。其中{unique}是唯一标识绑定的8个十六进制数字。例如： [HKEY_USERS \ .DEFAULT \ Software \ Sparx Systems \ SQLBridge \ SBPI \ Bindings \ B6EE6851] “LocalModel”= “eaexample” “Plugin”= “{853489C1-4C22-4bad-9A8E-3098D07A3FC1}” LocalModel - 模型的DB别名; 例如，eaexample 插件 - 外部数据源的UUID; 例如{853489C1-4C22-4bad-9A8E-3098D07A3FC1}

步骤

描述

配置Pro Cloud Server进行集成

Sparx Systems Pro云服务器的每个安装都可以配置为与单个集成（或SBPI）服务器通信，这些配置选项被定义为一系列注册表设置。

这是Integration服务器的所有有效选项的示例：

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

"Arguments"="-port 8080"

"Port"=dword:00001f90

"Path"="C:\\Program Files (x86)\\Sparx Systems\\Cloud Services\\SBPI\\SBPI.exe"

"Protocol"="http"

"Server"="yourdomain.com"

参数 - 用于启动SBPI服务器的参数，包括服务器应侦听的端口; 例如“-port 8080”
端口 - 十六进制值，表示SBPI服务器应侦听的端口号，该值应与参数中指定的值匹配; 例如双字：00001f90（十进制8080）
路径 - SBPI服务器EXE的完整路径; 当SBPI.EXE和Pro Cloud Server在同一台机器上运行时，PCS将尝试在此位置启动SBPI.exe; 例如“C：\\ Program Files（x86）\\ Sparx Systems \\ Cloud Services \\ SBPI \\ SBPI.exe”
协议 - 应该用于与托管SBPI服务器的计算机通信的协议; 即http或https
服务器 - 托管SPBI服务器的计算机的名称（或IP号）（例如yourdomain.com）; 重要的是要意识到这个地址被转发到客户端（Enterprise Architect），以便它可以发出直接请求，这意味着名称或IP必须可以从客户端机器解析

注意： 通常需要通过任何本地防火墙授予SBPI服务器访问权限，以便客户端可以连接到该服务器。ProCloudServer安装程序将自动创建一个防火墙例外，允许任何传入的请求通过; 但是，应检查并调整默认设置以适合您的环境。

配置外部数据源

每个外部数据源在[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}]

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

"Name"="Sparx Systems Sample account"

"Path"="C:\\Program Files (x86)\\Sparx Systems\\Cloud Services\\SBPI\\JiraSbpi.exe"

"Port"=dword:00001f91

"Prefix"="jira"

"Protocol"="http"

"Server"="127.0.0.1"

"Type"="Jira"

参数 - 应该用于启动插件的参数，包括插件应该监听的端口和配置文件的名称; 例如“-port 8081 -config Jira1.config”

名称 - 描述外部数据源的“友好”项目名称，显示给所有Enterprise Architect用户; 例如'Sparx Systems Sample account'

路径 - 插件EXE的完整路径; 例如C：\ Program Files（x86）\ Sparx Systems \ Cloud Services \ Service \ JiraSbpi.exe

Port - 一个十六进制值，表示外部数据源期望接收请求的端口号，该值应与参数中指定的值匹配; 例如：dword：00001f91

前缀 - 对用户有意义的简短唯一名称，并为Enterprise Architect模型中存储的每个链接添加前缀; 例如jira :: 10001（其中10001是Jira对象ID）

协议 - 应该用于与托管插件的计算机进行通信的协议; 例如http或https

服务器 - 托管插件的计算机的名称（或IP号）（例如yourdomain.com或127.0.0.1）; 重要的是要意识到这个地址是相对于托管SBPI服务器的机器，因此名称或IP必须可以从SBPI主机解析

类型 - 在Enterprise Architect中“分组”外部数据源的通用名称

每个外部数据源都需要自己的一组选项来定义配置的插件如何连接到外部数据源的详细信息。这些设置存储在.CONFIG文件中，该文件与插件的.EXE文件位于同一位置。例如，使用上面的定义需要创建“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

SERVER - 外部数据源服务器的名称（或IP号）; 例如example.com

协议 - 通信协议; 例如https

PORT - 外部数据源配置为侦听的端口; 例如443

BASEURL - 当外部数据源支持多个“项目”时，BaseURL属性标识应该使用哪个; 例如，对于Enterprise Architect SBPI，BaseURL是PCS中定义的DB别名

USERNAME - 可选 - 请参阅注释1

密码 - 可选 - 见注1

CREATEITEMS - 定义Enterprise Architect用户是否可以在外部数据源中创建项目 - 请参阅注释2; 默认值：false

MODIFYITEMS - 定义Enterprise Architect用户是否可以修改外部数据源中的现有项目 - 请参阅注释2; 默认值：false

POSTDISCUSSIONS - 定义Enterprise Architect用户是否可以向外部数据源中的项添加讨论 - 请参阅注释2; 默认值：true

PROXY - 可选 - 代理服务器的服务器名称或IP号和端口; 例如10.0.0.0:3128

PROXYBYPASS - 可选 - 不应通过代理发送的半号分隔的IP号列表; 例如<local>; 10. *

IGNORESSLERRORS - 可选 - 一个布尔值，用于忽略任何SSL证书错误

注1

如果外部服务器支持OAuth 2身份验证（Autodesk，Dropbox和Wrike），则在从Enterprise Architect中进行访问时，将打开一个浏览器窗口，提示您登录外部帐户并允许Enterprise Architect访问您的帐户。

Enterprise Architect永远不会在此过程中看到您的凭据，而是为其提供了访问外部帐户的唯一令牌。

如果外部服务器允许基本身份验证，则可以在配置文件中选择性地设置用户名和密码。

如果未在配置文件中指定用户名和密码，Enterprise Architect将提示您输入用于访问外部数据的凭据。

笔记2

并非所有外部产品都支持创建和修改其对象，例如Dropbox。

配置外部数据源的模型

为了使Enterprise Architect模型的用户能够连接到给定的外部数据源，需要配置Enterprise Architect模型和外部数据源之间的“绑定”，这由[HKEY_USERS]中的一系列注册表设置执行。每个模型/外部数据源组合的.DEFAULT \ Software \ Sparx Systems \ SQLBridge \ SBPI \ Bindings \ {unique}。其中{unique}是唯一标识绑定的8个十六进制数字。例如：

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

“LocalModel”= “eaexample”

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

LocalModel - 模型的DB别名; 例如，eaexample

插件 - 外部数据源的UUID; 例如{853489C1-4C22-4bad-9A8E-3098D07A3FC1}

特别说明

在Integration Server或提供程序级别使用SSL

如果您选择在Intergration Server或Integration Provider级别实施HTTPS协议，则Integration Executables（* SBPI.EXE）将需要与其自身位于同一文件夹中的“server.pem”文件，因此如果使用默认安装路径意味着'server.pem'应该放在C：\ Program Files（x86）\ Sparx Systems \ Cloud Services \ SBPI \文件夹中。

有关如何创建有效“server.pem”文件的详细信息，请参阅页面上的使用OpenSSL的SSL证书和自签名证书部分添加端口定义。

Enterprise Architect的Integration插件需要

- BaseURL是模型的DB Alias

- 必须在Pro Cloud Server中将定义的模型配置为“启用”和“启用专业版功能（OSLC，WebEA和集成）”

Integration Plugins返回什么数据

Sparx Systems开发的每个Integration插件都根据产品外部数据中的“ 过滤器 ”或位置返回信息。Enterprise Architect，Jira和TFS等产品提供了一种自定义返回数据的机制，而其他产品只返回数据中特定位置的所有信息。

注意：对于Enterprise Architect，Jira或TFS，必须在Enterprise Architect请求Integration Plugin连接到它们之前配置过滤器。

提供商	信息返回
应用程序Lifecycle Manager	根据缺陷，要求和测试的内部列表返回的信息。
AutoDesk	根据以下内容返回的信息：Hubs \| 项目\| 文件夹
Bugzilla	根据以下内容返回的信息：产品\| 组件\| <组件中的所有项目>
Dropbox	根据以下内容返回的信息：文件夹
EA	显示本地模型中定义的“外部模型”搜索列表。看屏幕'在项目中查找'\| 外部模型
Jazz	根据以下内容返回的信息：（DoorsNG） - 文件夹
Jira	显示“收藏夹过滤器”列表。请参阅菜单选项问题\| 管理过滤器
ServiceNow	根据内部表的内容返回的信息：数据库目录，应用程序，硬件，计算机，应用程序服务器，基础结构服务，数据库实例，网络设备，服务器
Team Foundation Server	显示TFS全局和“我的...”查询列表
Wrike	根据以下内容返回的信息：Accounts \| 文件夹