根据 iFlow 生成 SAP CPI 技术设计文档

每个 SAP Cloud Integration（SAP CPI）项目都要求提供技术设计文档，而大多数文档都要写两遍：一次在构建之前，根据需求规范来写；另一次在交接时，根据 iFlow 来写，因为 iFlow 已经变了。第二遍基本上就是把 iFlow 中已有的内容抄一遍。

本文列出 iFlow 技术设计文档应包含的内容，并介绍如何直接根据 iFlow 生成文档，格式可以是 Word、PDF 或 HTML，也可以使用您公司自己的 Word 模板。

这份文档的用途

技术设计文档要让没有构建该 iFlow 的人明白它如何工作：它连接哪些系统、在途中如何处理消息、如何失败，以及运维人员运行它需要知道什么。它会在审查时、交接时，以及几个月后接口出故障时被阅读。

文档应包含什么

• 接口概览：名称、ID、package、用途，以及发送方和接收方及其适配器和地址。
• 流程：一张图表，以及针对每个流程的简短叙述，说明消息经历了什么。
• 路由：每个 Router、它的路由及其条件，以及默认路由。
• 映射和脚本：用一两句话说明每一个的作用。
• header 和属性：iFlow 设置和读取的内容。
• 错误处理：Exception Subprocess 及其作用。
• 安全：它使用的凭据和密钥名称（绝不包括机密本身）。
• 外部化参数，以及它使用的 Data Store、JMS 队列和 ProcessDirect 链接。
• 运维：在哪里监控它、失败时怎么办、联系谁。

为什么手写的文档会过时

这份清单上的每一项都已经存在于 iFlow 中。手工写下来，意味着要抄写地址、条件和参数名称，而 iFlow 的每一次变更都会让这份副本错得更多一点。根据 iFlow 生成的文档在生成当天是准确的，变更之后重新生成也只需一分钟。

根据 iFlow 生成

1. 在设计器中打开 iFlow，点击「Kitegra 工具」按钮并选择「为此 iFlow 生成文档」。「iFlow 文档」会在新标签页中打开。
2. 检查它读取到的内容：参与方和适配器、流程及其步骤、路由、映射和脚本、header 和属性、参数、Security Material 名称、存储和链接，以及错误处理。
3. 选择一个「模板」：「技术设计」、「简要摘要」或「运维交接」。
4. 填写「项目」和「作者」；它们会保留到下一份文档。
5. 下载为 Word、PDF 或 HTML。

图表根据 iFlow 绘制，每个流程都会得到一段叙述，例如「通过 … 接收来自 … 的消息。」和「出错时：…。」。如果不使用设计器，请改为选择「上传 iFlow（ZIP 或 .iflw）」；上传的文件不计入您套餐的 iFlow 数。PDF 中的标签为英文。

使用您公司自己的 Word 模板

如果您的项目有模板，请选择「自定义 Word 模板」。在 .docx 文件中需要填入内容的位置写上占位符，然后选择「填充并下载」：

Interface:   {{iflowName}} ({{iflowId}})
Package:     {{package}}
Project:     {{project}}        Author: {{author}}        Date: {{date}}

Purpose
{{description}}

Senders: {{senders}}        Receivers: {{receivers}}
Adapters: {{adapters}}

How it works
{{narrative}}

Routing: {{routes}}
Scripts: {{scripts}}
Error handling: {{errorHandling}}

页面会列出它填充的每个占位符，其中包括 {{iflowName}}、{{package}}、{{narrative}}、{{routes}}、{{parameters}}、{{securityMaterial}} 和 {{errorHandling}}。Message Mapping 有自己的表格：请参阅在 Excel 中编写 Message Mapping 文档。

Kitegra 如何帮您

文档属于 Kitegra 的 iFlow Docs 领域。文档在您的浏览器中生成；脚本和映射从不发送给 Kitegra。在为 iFlow 编写文档之前，审查清单可以发现那些您不想写进文档的问题。

Helper、Message Monitor、iFlow Inspector 和 iFlow Docs 各自统计您使用它们的 iFlow 数：没有 Kitegra 账户时每个模块 5 个，Free 套餐 50 个，Starter 100 个，Pro 300 个；Business 不限。Toolbox 和工作区附加功能免费。比较各套餐。

在下一个 iFlow 中试试

了解 Kitegra 为 SAP Integration Suite 设计器增加了哪些功能，或在 Kitegra 的其他 Chrome 扩展旁查看它。

常见问题