预订演示

请注意 : 本帮助页面不适用于最新版本的Enterprise Architect. 最新的帮助文档在这里.

前页 后页

编写自定义集成插件

我们生活在一个高度互联的世界中,虽然专业云服务器提供了大量开箱即用的集成,但可以使用任何具有标准 Web 服务接口的产品创建自定义(专有)集成。此功能将向外部工具开放Enterprise Architect存储库的内容,并使外部工具中的信息在Enterprise Architect中可用。例如,项目管理工具可以定义有助于在Enterprise Architect中可视化的工作页面,或者自动化测试工具可以定义与Enterprise Architect中的实现和规范元素相关的测试用例和测试过程。这将需要一些技术专业知识来使用多种编程语言(如 C++ 或 C#)中的一种来创建集成,但这只需完成一次,并且可以在任意数量的存储库中使用。

专业云服务器和Enterprise Architect将完成繁重的工作,管理员无需更改专业云服务器的任何基本安全设置,因为新的集成将通过现有端口和防火墙运行。开发者也无需编写 http 监听代码,让他们聚焦于确定和配置 RESTful API 调用以将外部项目的信息传入和传出服务器。

安装专业云服务器时,启用“SBPI 示例”组件以包含自定义集成示例。启用后,示例文件的默认位置位于“SBPI Examples\ExampleIntegrationPlugins”文件夹中。例如:

C:\Program Files (x86)\ Sparx Systems \专业云服务器\SBPI Examples\ExampleIntegrationPlugins

有关详细信息,请参阅专业云服务器安装帮助主题。

注记,默认情况下不启用“SBPI 示例”安装选项。如果您已经安装了没有“SBPI 示例”的专业云服务器,您可以执行完全重新安装(启用“SBPI 示例”),或使用安装程序的“更改”选项仅添加“SBPI 示例”零件。

要编写自己的自定义集成插件,您可以从头开始,也可以复制其中一个示例并进行修改。插件可以用 C++ 或 C# 编写。

这些示例是使用 Visual Studio 2017 编写的,但这不是先决条件。

自定义集成插件必须实现 ISBPIIntegrationPlugin 中定义的接口,该接口包含在 ISBPIIntegrationPlugin.h(对于 C++)或 ISBPIIntegrationPlugin.cs(对于 C#)中。

程序的一般流程是:

  • 用户在Enterprise Architect中执行需要来自集成插件的信息的操作
  • 插件将接收到对适当接口方法的调用(或多次调用)
  • 插件解析请求,并在需要时向实际数据提供者发出自己的请求
  • 插件接收来自实际提供者的结果,并解析数据
  • 插件通过提供的回调函数向Enterprise Architect发送响应;这可以是请求的实际数据或错误值
  • Enterprise Architect接收回调数据并显示给用户

函数/类

细节

也见

检查版本

(在 C# 中不需要。)

输入:无符号int版本

如果您的插件支持请求的版本,则返回 true。

版本2 在Enterprise Architect中的元素链接或取消链接到外部项目或修改它们时添加通知。

版本2 扩展版本1 ,因此对于支持的版本(包括支持的版本)返回 true。

例如返回(版本 <= 2);

创建插件

(在 C# 中不需要。)

插件必须实现这个导出函数:

extern "C" SBPI_API SBPI_INTEGRATION_PLUGIN CreatePlugin();

它必须返回一个指向实现 ISBPIIntegrationPlugin 接口的类的指针。推荐的实现是:

SBPI_INTEGRATION_PLUGIN CreatePlugin()

{

返回新的 ExampleIntegrationPlugin;

}

新创建的 ISBPIIntegrationPlugin 在接收到 ISBPIIntegrationPlugin::Release 方法时可以被删除。

接口

dll插件必须实现 ISBPIIntegrationPlugin 接口中的所有方法。

ISBPIIntegrationPlugin 接口