预订演示
前页 后页

安装和配置

Sparx Systems专业云服务器产品使用标准的Microsoft窗口安装程序包进行安装,其中包括许多可选组件。这些组件之一是集成插件,它默认安装到 C:\Program Files (x86)\ Sparx Systems \专业云服务器\SBPI\ 文件夹中(假设使用的是 64 位计算机)。

需求

为了安装特定的集成插件您必须具有:

  • A许可的专业云服务器
  • PCS服务器和托管外部数据的服务器之间的网络访问
  • 访问外部数据的用户凭证
  • Enterprise Architect企业、统一或终极版、v14或更高版本
    注意: Enterprise Architect试用版提供对集成的只读访问权限

包裹里有什么?

集成插件文件夹最初由集成服务器可执行文件(SBPI.exe)、每个受支持的外部产品的单独可执行文件(*SBPI.exe)、示例配置文件以及描述手动安装和配置步骤的文本文件组成。

插件

描述

也见

集成(SBPI)服务器

SBPI.exe 应用程序充当专业云服务器和每个插件之间的接口,通过转换Enterprise Architect请求,将其转发到适当的插件,然后将生成的响应返回给Enterprise Architect 。

应用程序生命周期管理器插件

ALMSbpi.exe 插件与 MicroFocus Application Lifecycle Manager 产品(以前称为 HP Quality Center)进行交互。

Autodesk插件

AutodeskSbpi.exe插件与AutoCAD的文件和管理组件AutoDesk交互。

Bugzilla插件

BugzillaSbpi.exe插件与基于 Web 的缺陷/错误跟踪系统交互,该系统最初由 Mozilla 项目开发和使用,现在根据 Mozilla 公共许可协议获得许可。

Confluence插件

ConfluenceSbpi.exe插件与Atlassian的Team协作软件交互,可以列出空间并链接到页面。

注记:Confluence HTML 页面的内容未同步。

Dropbox插件

DropboxSbpi.exe 插件与 Dropbox 的 Web 文件托管服务交互。它能够列出 Dropbox 中的文件夹并链接到单个文件。

EA插件

EASbpi.exe插件与外部Sparx Systems的Enterprise Architect云存储库交互。它能够浏览包层次结构或执行基于搜索的查询。

爵士乐插件

JazzSbpi.exe插件与以下内容交互:

  • IBM Rational DOORS Next Generation 的需求管理工具
  • Rational Rhapsody设计管理 (DM)
  • Rational Team Concert更改和配置管理 (CCM)
  • 理性质量经理(QM)

Jira插件

JiraSbpi.exe 插件与 Atlassian 的问题跟踪系统交互。它能够列出用户收藏的过滤器(也称为加星标的过滤器)。每个过滤器都会列出其返回的所有 Jira 项目。

Salesforce

SalesforceSbpi.exe 插件与Salesforce的顾客关系管理系统交互。

ServiceNow插件

ServiceNowSbpi.exe 插件与 ServiceNow 基于云的企业管理系统的资产管理组件进行交互。

SharePoint插件

SharePointSbpi.exe插件与微软基于Web的协作平台SharePoint进行交互。

Azure DevOps / TFS插件

TFSSbpi.exe插件与 Microsoft 的Azure DevOps /团队基础服务器(TFS) 工作项交互

Wrike插件

WrikeSbpi.exe插件与Wrike的项目管理系统交互。

如何设置

集成框架由一个集成服务器 (SBPI.EXE) 应用程序组成,该应用程序启动一个或多个插件(例如 DropboxSbpi.exe 和 JiraSbpi.exe)。  集成服务器和每个集成插件可以配置为在与专业云服务器相同的计算机上运行,也可以在完全不同的计算机上运行。  在最简单的配置中,集成服务器和所有集成插件都安装在单个服务器上。这种配置有两个主要优点:

  1. 每当其窗口服务启动(或停止)时,专业云服务器将自动启动(和停止)所有配置的插件。
  2. 云配置客户端内置的集成配置 GUI 可用于全面管理集成配置的各个方面;请参阅步骤 - 简单表。
但是,如果您选择在与专业云服务器不同的计算机上运行集成服务器或集成插件,则必须手动配置每个单独的插件,并配置为使用正确的参数启动窗口服务。请参阅步骤 - 手册表。

步骤 - 简单

云配置客户端中包含的集成配置 GUI 消除了配置集成服务器和数据提供者所涉及的大部分复杂性,因此这是大多数用户推荐的方法。  但是,此配置方法仅限于在与专业云服务器相同的服务器上运行所有集成组件(*SBPI.exe)。

描述

也见

配置专业云服务器进行集成

Sparx Systems专业云服务器的每个安装都可以配置为与单个集成服务器通信;该定义的配置选项被定义为一系列注册表设置,但是专业云服务器配置客户端中的“集成”选项卡允许定义和维护集成服务器选项,而无需您手动操作注册表或配置文件。

此图显示了具有默认设置的集成服务器的定义:

或者,可以通过 WebConfig 接口配置集成服务器和插件。有关详细信息,请参阅WebConfig -集成插件主题。

配置集成数据提供者

每个数据提供者(或插件)都定义为 [HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\插件\{unique}] 中的一系列注册表项,以及配置文件中的设置。同样,云配置客户端中的“集成”选项卡允许您定义和维护集成数据提供者的详细信息,而无需您手动操作注册表和配置文件。

添加/编辑数据提供者

配置防火墙

为了尽量减少配置专业云服务器及其特征所需的防火墙规则,PCS 版本1现在通过普通 PCS 端口路由对集成服务器 (SBPI.exe) 的所有请求,因此,如果您使用 PCS 1或更高版本,除了Enterprise Architect客户端与专业云服务器通信的规则之外,不需要其他防火墙规则。

对于 PCS 版本 3 和 4,集成服务器 (SBPI.exe) 通常必须获得本地防火墙的访问权限,以便Enterprise Architect客户端能够连接到它。专业云服务器安装程序会自动创建防火墙例外,允许任何传入请求传递到 SBPI.exe;但是,您应该检查并调整默认设置以适合您的环境。

步骤 - 手动

重要提示:仅当集成组件将在与专业云服务器不同的计算机上运行时才需要这些步骤,否则应使用步骤 - 简单表。

描述

也见

配置专业云服务器进行集成

每个Sparx Systems专业云服务器的安装都可以配置为与单个集成(SBPI) 服务器通信。这些配置选项定义为一系列注册表设置。

这是集成服务器所有有效选项的示例:

[HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\服务器]

“已启用”=“true”

“本地端口”=dword:00001f90

“UseLegacy”=“ false ”

“参数”=“-端口 8080 -协议 http”

“协议”=“ https ”

“服务器”=“ localhost ”

“端口”=dword:00001f90

“忽略SSL错误”=“true”

“AttemptAutoDiscovery”=“true”

“客户端协议”=“http”

“客户端服务器”=“备用服务器名称”

“客户端端口”=dword:00001f90

  • Enabled - true or false ,代表 SBPI 服务器应监听的端口号,该值应与参数中指定的值匹配;例如,dword:00001f90(十进制 8080)
  • LocalPort - 一个十六进制值,表示当使用选项为 FALSE 时集成服务器正在侦听的端口号;例如,dword:00001f90(十进制 8080)
  • UseLegacy - true or false ,控制集成服务器是否应使用简单( false )或复杂( true )配置选项集
  • 参数- 在专业云服务器1或更高版本中未使用;在早期版本中,这表示用于启动集成服务器的参数,其中包括服务器应侦听的端口和协议 - 例如,“-port 8080 -protocol http”
  • 协议- http 或https ,当使用选项为 TRUE 时,应用于与集成服务器的计算机进行通信的协议;该字段与“服务器”和“端口”组合形成集成服务器的URL,专业云服务器将向该URL发送SBPI相关请求
    注记:完成URL ({protocol}://{server-name}:{port} 必须可由专业云服务器机器解析
  • 服务器- 当使用选项为 TRUE 时托管集成服务器的计算机的名称(或 IP 号)(例如,yourdomain.com);该字段与“Protocol”和“端口”组合形成集成服务器的URL,专业云服务器将向该URL发送SBPI相关请求
    注记:完成URL ({protocol}://{server-name}:{port} 必须可由专业云服务器机器解析
  • 端口- 一个十六进制值,表示当使用选项为 TRUE 时集成服务器正在侦听的端口号 - 例如,dword:00001f90(十进制 8080);该字段与“Protocol”和“服务器”组合形成集成服务器的URL,专业云服务器将向该URL发送SBPI相关请求
    注记:完成URL ({protocol}://{server-name}:{port} 必须可由专业云服务器机器解析
  • IgnoreSSLErrors - true or false ,定义在使用Legacy选项为TRUE时是否应忽略与集成服务器组件通信时发生的SSL相关错误
  • AttemptAutoDiscovery - true or false ,定义专业云服务器是否应在使用选项为 TRUE 时自动尝试确定Enterprise Architect客户端的网络地址并将其提供给集成服务器
  • ClientProtocol - http 或https ,定义与“ClientServer”和“ClientPort”结合使用的协议,形成可解析的 URL,当使用Legacy 选项为 TRUE 时, Enterprise Architect客户端可以与集成服务器通信
    注记:完成URL ({protocol}://{server-name}:{port} 必须能够被Enterprise Architect客户端计算机解析
  • ClientServer - 定义服务器名称(或 IP 号码),当与“ClientProtocol”和“ClientPort”组合时,形成Enterprise Architect客户端在使用Legacy 选项为 TRUE 时可以与集成服务器通信的可解析 URL
    注记:完成URL ({protocol}://{server-name}:{port} 必须能够被Enterprise Architect客户端计算机解析
  • ClientPort - 定义端口号的十六进制值,当与“ClientProtocol”和“ClientServer”组合时,形成可解析的 URL,当使用Legacy 选项为 TRUE 时, Enterprise Architect客户端可以与集成服务器通信;例如,dword:00001f90(十进制 8080)
    注记:完成URL ({protocol}://{server-name}:{port} 必须能够被Enterprise Architect客户端计算机解析
注记:从专业云服务器1版本开始,集成服务器无需设置自己的防火墙规则, Enterprise Architect客户端即可与其通信。对于 PCS 3 和 4 版本,集成服务器(SBPI.exe) 通常需要获得通过任何本地防火墙的访问权限,以便客户端可以连接到它。专业云服务器安装程序将自动创建防火墙例外,允许任何传入请求通过;但是,您应该检查并调整默认设置以适合您的环境。

配置数据提供者

每个数据提供者被定义为以下一系列注册表项:

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

其中 {unique} 是数据提供者的唯一 UUID。

这是一个完成外部数据提供者定义的示例:

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

“自动启动”=“true”

“已启用”=“true”

"组"=""

“名称”=“ Sparx Systems示例帐户”

"端口"=dword:00001f91

"前缀"="jr1"

“TypeKey”=“jira”

“参数”=“-port 8081 -config jr.config”

“配置”=“jr1.config”

  • AutoStart - true or false ,定义集成服务器(SBPI.exe) 是否应为此数据提供者维护正在运行的进程 (*sbpi.exe)
  • Enabled - true or false ,定义集成服务器(SBPI.exe) 是否应允许将通信转发到此数据提供者
  • - 可选值,可用于在Enterprise Architect中显示时将提供商“排序”成组
  • 名称- 用于描述外部数据提供者“友好”项目名称,显示给所有Enterprise Architect用户;例如“ Sparx Systems示例帐户”
  • 端口- 一个十六进制值,表示外部数据源期望接收请求的端口号,该值应与参数中指定的值匹配;例如,dword:00001f91(十进制 8081)
  • 前缀- 对用户有意义的简短唯一名称,作为Enterprise Architect模型中存储的每个链接的前缀;例如,jr1::10001(其中 10001 是 Jira object ID)
  • TypeKey - 定义当前数据提供者的提供者类型;只能使用以下受支持的值: cint、csvc、alm、ad、bug、cflu、drop、ea、jazz、jira、sf、现在、sp、tfs、wrike
  • 参数- 从 PCS 1开始已弃用,动态参数列表是根据各个设置构建的;早期版本使用此字段来定义启动集成插件时应使用的参数,包括端口、协议和配置文件名
  • 配置- 从 PCS 1开始已弃用,配置文件名现在是带有“.config”前缀;在 PCS 3 和 PCS 4 版本中,此字段被赋予一个必须是唯一的独立值
每个外部数据提供者需要一组自己的选项来定义已配置的插件如何连接到外部数据源的细节。这些设置存储在与插件的 .exe 文件位于同一位置的 .config 文件中。例如,使用上述定义,需要创建一个“jr1.config”,其中包含类似如下信息:

协议=https

服务器=example.com

端口=443

BASEURL=我的项目

用户名=

密码=

CREATEITEMS=false

修改项目=假

后讨论=真

代理=10.0.0.0:3128

PROXYBYPASS=<本地>;10.*

IGNORESSLERRORS=true

  • PROTOCOL - 通信协议,http 或https
  • SERVER - 外部数据源服务器的名称(或 IP 号码),例如 example.com
  • PORT - 配置外部数据源监听的端口,例如 443
  • BASEURL - 当外部数据源支持多个“项目”时,BaseURL属性标识应使用哪个项目;例如,对于Enterprise Architect SBPI,BaseURL 是 PCS 中定义的 DB别名
  • 用户名- 可选 - 参见注释 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内部访问时,将打开一个浏览器窗口并提示您log外部帐户并允许Enterprise Architect访问您的帐户
  • Enterprise Architect在此过程中永远不会看到您的凭据;相反,它会提供一个唯一的令牌来访问外部帐户
  • 如果外部服务器允许基本身份验证,则可以在配置文件中选择性地设置用户名和密码
  • 如果配置文件中未指定用户名和密码, Enterprise Architect将提示您输入访问外部数据的凭据
注2
  • 并非所有外部产品都支持创建和修改其对象;例如,Dropbox 不支持

为外部数据提供者配置模型

为了让Enterprise Architect模型的用户连接到给定的外部数据提供者,必须配置Enterprise Architect模型和外部数据提供者之间的“绑定”。此操作通过 [HKEY_USERS\.DEFAULT\Software\ Sparx Systems \SQLBridge\SBPI\Bindings\{unique}] 中针对每个模型/外部数据源组合的一系列提供者设置来执行。在此string中,{unique} 是一个 8 位十六进制数,用于唯一标识绑定。例如:

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

“LocalModel”=“eaexample”

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

  • LocalModel -模型的 DB别名,例如 'eaexample'
  • 插件 - 外部数据源的 UUID;例如 {853489C1-4C22-4bad-9A8E-3098D07A3FC1}

特别注记

在集成服务器或提供者级别使用 SSL

如果您选择在集成服务器级别或集成提供者级别实现 HTTPS 协议,则集成可执行文件 (*SBPI.EXE) 将需要一个与其自身位于同一文件夹中的“server.pem”文件;因此,如果使用默认安装路径,这意味着“server.pem”应放置在 C:\Program Files (x86)\ Sparx Systems \专业云服务器\SBPI\ 文件夹中。

请参阅添加端口定义帮助主题中的“SSL 证书”部分和自签名 SSL 证书部分 帮助主题 有关如何创建有效的“server.pem”文件的更多信息。

针对Enterprise Architect需求的集成插件:

  • BaseURL 作为模型的 DB别名
  • 定义的模型在专业云服务器中配置为“启用”和“启用专业特征(OSLC、 WebEA和集成)”