Version 26.1.9526

• 核心功能
• 概览
• 端口配置
  • 表单设计器选项卡
  • 设置页
    • 端口配置
    • 高级设置
  • 表单用户
    • 添加用户
    • 编辑用户
    • 删除单个用户
    • 删除多个用户
  • 服务器选项卡
    • 受信任的 IP 地址
  • 高级页面
    • 日志
    • 特殊设置
  • 通知选项卡
  • SLA 选项卡
  • 事务选项卡
• 配置 IIS 服务器
• 创建表单
  • 添加部分
  • 添加详细信息表
  • 添加字段
  • 表单字段类型
    • 文本字段选项
    • 下拉字段选项
    • 单选按钮字段选项
    • 复选框字段选项
    • 文件上传字段选项
  • 访问你的表单
• 提交新的表单数据
• 宏
  • 示例

Form 端口暴露出一个公共接口，可以将 WebForm 的数据提交到知行之桥工作流中。

核心功能

• 基于 Web 的表单创建，配备拖拽式设计器
• 支持分节（Section）、明细表（Detail Table）及多种字段类型
• 为表单提交提供用户身份验证和访问控制
• 动态表单生成，并支持自定义品牌标识和成功提示消息

概览

表单是从 Form 端口 表单设计器 创建的。 表单分为段和明细，每个段都可以有可变数量的表单字段。 更多详情请查阅提交新表单数据部分。

当你使用 Form 端口提交新数据时，你应该将端口放在连接流的开头。 客户端可以连接到 Web 接口，查看和填写表单，并将此数据提交到配置的 知行之桥工作流中。 有关更多详细信息，请参阅提交新表单数据。

以下部分说明如何配置Form 端口、创建表单和提交新表单数据。

端口配置

此部分包含所有可配置的端口属性。

表单设计器选项卡

与构建一组按部分和详细信息表组织的表单字段相关的设置。

当客户端连接到已配置的端点并提交表单时，他们会看到与上方面板中配置完全相同的字段布局。

设计器包含以下设置（有关更多详细信息，请参阅创建表单）。

• 表单 URL 已发布表单的链接。
• 表单 表单的标题（例如，您的公司名称）。
• 添加 下拉菜单，用于添加部分或详细信息表。添加部分 允许向表单添加特定部分，添加详细信息 允许向表单添加详细信息表。详细信息表就像一个预配置的表，表单用户可以根据需要为数据集添加任意数量的记录。
  • 表单字段 将字段拖放到表单的明细表和分区区域中。根据需要重复此操作多次。字段类型包括：
  • 文本字段 包含名称和描述的输入文本框。
  • 下拉列表 包含名称和下拉选项的下拉列表。
  • 单选按钮 一组包含名称和单选按钮选项的单选按钮。
  • 复选框 一组包含名称和复选框选项的复选框。
  • 文件上传 允许表单用户将特定类型的文件直接上传到表单。
• 徽标 上传公司徽标，该徽标显示在表单顶部。默认情况下，它使用知行之桥徽标。还可以更改横幅的颜色。
• 成功消息 用户成功提交表单数据后看到的确认消息。可以更改默认消息或添加其他文本。

设置页

端口配置

与端口核心配置相关的设置。

• 端口 Id 端口的静态、唯一标识符。
• 端口类型 显示端口类型及其用途的描述。
• 端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。

高级设置

• 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息，请参阅宏。

表单用户

表单用户 选项卡使你能够为客户端创建用户凭据，以便他们可以访问公共接口。 如果客户端尚未登录到应用程序管理控制台，则在浏览接口时会提示该客户端输入 User 和 Password 组合。

你可以在此选项卡上添加、编辑和删除凭据。

添加用户

添加用户用户：

1. 单击添加用户打开添加用户对话框。

2. 输入用户名和密码。（单击眼睛图标可查看密码字段的内容。）

3. 单击保存更改，新用户将添加到表单用户列表中。

编辑用户

要编辑现有用户：

1. 单击要编辑的用户旁边的省略号，然后单击编辑。

2. 编辑凭据并单击保存更改。 如果你决定不进行更改，请单击 取消 退出对话框。

删除单个用户

要删除单个用户：

1. 点击要编辑的用户旁边的省略号，然后点击“删除”。

2. 点击“删除”以删除用户，或点击“取消”以取消删除请求。

删除多个用户

要删除多个用户，请选中要删除的用户对应的复选框，然后点击“删除”。确认删除或取消删除请求。

服务器选项卡

受信任的 IP 地址

此选项卡上的 可信 IP 地址 部分提供以下功能：

• 添加 输入新的 IP 地址范围。
• 编辑 修改选定的 IP 地址范围。
• 删除 从列表中删除选定的 IP 地址范围。

以下限制适用于此功能：

• localhost 不能被修改或从列表中删除。
• 任何超出定义范围的 IP 地址都将被拒绝。
• 支持IP范围。 例如，“100.10.100.1-15”条目表示允许100.10.100.1至100.10.100.15之间的IP地址访问。
• 支持 无类别域间路由(CIDR) 表示法。 例如，“100.10.100.0/24”条目表示允许100.10.100.0至100.10.100.255之间的IP地址访问。
• 支持通配符模式。 例如，条目 100.10.100.* 表示允许以 100.10.100 开头的 IP 地址。 任何超出该范围的 IP 地址都将被拒绝。

注意：为了让客户端能够访问服务器，需要有清晰的网络路径。在云环境中，可能需要在三个地方进行更改：

• 云控制台中的网络规则。
• 托管应用程序的机器上的防火墙规则。例如，在使用 Amazon AMI 时，可以使用 简单防火墙 (UFW) 来允许所需端口上的流量。Linux 环境中的常见策略是将流量从低于 1024 的端口转发到高于 1024 的非标准端口，同时将应用程序配置为使用非标准端口。这可以避免与非 root 用户绑定到低于 1024 的端口相关的权限问题。
• 安全选项卡的网络访问部分。

高级页面

日志

• 日志级别 端口生成的日志详尽程度。请求支持时，请将此项设置为 Debug。
• 日志子文件夹方案：指示端口根据所选的时间间隔对日志（Logs）文件夹中的文件进行分组。每周（Weekly）选项（默认设置）指示端口每周创建一个新子文件夹，并将该周的所有日志存储在其中。如果此设置留空，则端口将所有日志直接保存在日志文件夹中。对于处理大量事务的端口，使用子文件夹有助于保持日志井然有序并提高性能。
• 日志消息 勾选此项后，处理文件的日志条目将包含该文件本身的副本。如果禁用此项，可能无法从交易页面下载文件副本。

特殊设置

特殊设置 适用于特定用例。

• 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置，例如setting1=value1;setting2=value2。 正常的端口用例和功能不需要使用这些设置。

通知选项卡

与配置通知相关的设置。

在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥使用 通知 选项卡上的全局设置。要为此端口使用其他设置，请启用覆盖全局设置。

默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中启用复选框。

输入主题（必填），然后（可选）输入以逗号分隔的收件人电子邮件列表。

SLA 选项卡

与配置服务级别协议 (SLA) 相关的设置。

SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥会发送电子邮件警告用户，并将 SLA 标记为_存在风险_，这意味着如果 SLA 未能尽快达到，则会被标记为_已违反_。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为_已违反_，并再次通知用户。

要定义 SLA，请启用预期数据量，然后点击设置选项卡。

• 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
• 在窗口的预计至少部分中：
  • 设置预计处理的最小事务数量（交易量）
  • 使用每个字段指定时间范围
  • 指示 SLA 生效的时间。如果选择开始于，请填写日期和时间字段。
  • 勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择每天。
• 在窗口的将状态设置为“有风险”部分中，指定应将 SLA 标记为有风险的时间。
  • 默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选发送“有风险”通知。

以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。

注意：如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的设置，然后跳转到通知 > 通用通知。点击平板和铅笔图标进行编辑，并取消勾选 SLA 通知设置。

事务选项卡

此选项卡列出了与端口关联的所有消息。使用搜索栏查找特定消息，或点击漏斗图标应用过滤器。可以按时间、消息方向和/或状态进行过滤。

收到的表单回复会显示在此选项卡上。

配置 IIS 服务器

如果你的知行之桥实例托管在 IIS 服务器上，并且你使用 Microsoft Windows 身份验证登录到应用程序，则必须为你的用户禁用 Windows 身份验证。 否则，Form 端口无法正确验证用户，端口将无法正常工作。

要禁用 Windows 身份验证：

1. 在你的 IIS 管理器中，在基本应用程序路径中创建一个名为 connector 的新文件夹。

2. 在 IIS（右窗格中）下为 connector 文件夹选择 Authentication。

   

3. 将此文件夹的 Windows 身份验证 设置为 禁用。

   

创建表单

表单包含字段、部分和详细信息：

• 部分：将字段分组的标题
• 详细信息：类似于预配置表的对象，表单用户可以在其中根据需要为数据集添加任意数量的记录
• 字段：带有标签的输入框，用户可在此输入表单数据

首先，点击表单标题旁边的“添加”按钮，然后选择“添加部分”或“添加详细信息”。

添加部分

“部分”通过将表单中的字段按标题分类来划分字段。例如，“收货人”部分可能包含“地址”、“城市”和“邮政编码”等字段。

向表单添加字段并非必须使用“部分”。但是，“部分”提供了项目的逻辑分组，有助于用户快速理解表单。

要添加部分：

1. 从下拉菜单中选择“添加部分”。输入部分名称。

2. 现在您可以开始向该部分添加字段。

添加详细信息表

详细信息表允许表单创建者在 Web 表单中嵌入表格，以实现结构化的、基于行的数据输入。它们包含可配置的列数，可以在表单创建期间定义这些列数。它们非常适合在单次表单提交中捕获可重复的数据集。最终用户可以根据需要动态添加任意数量的行，并为这些行中的每一列输入值。有关示例，请参阅访问你的表单。

要将详细信息表添加到表单：

1. 从下拉菜单中点击“添加详细信息”。输入名称。

2. 现在可以向表中添加列了。选择任意表单字段类型。

添加字段

字段是表单的基本输入单位。

添加字段：

1. 将对象从“表单字段”部分拖放到您的部分或详细信息表中。

2. 输入“显示名称”（例如，订单项 ID）。默认情况下，系统会填充“XML 名称”，但可以使用“覆盖”复选框提供其他名称。

3. 使用“必填”复选框指定该字段是否为必填字段。

4. 其他选项因表单字段类型 而异。以下示例显示了正在定义的文本字段。完成字段定义后，点击“添加”。

提示：

• 要编辑字段，请点击其名称的链接或名称右侧的省略号。
• 要移除字段，请点击省略号并选择“移除实例”。
• 将字段拖放到部分或详细信息表中，即可重新排列它们在表单中的位置。

表单字段类型

文本字段选项

• 显示名称：表单中字段的名称。
• XML 名称：显示名称的净化版本。它必须是有效的 XML 元素名称。
• 覆盖：复选框，用于更改默认的 XML 名称。
• 必填：复选框，用于指示该字段是否为必填项。
• 默认值：使用此处提供的文本填充表单。
• 描述：帮助文本，用于描述字段的用途。

下拉字段选项

• 显示名称：表单中字段的名称。
• XML 名称：显示名称的净化版本。它必须是有效的 XML 元素名称。
• 覆盖：复选框，用于更改默认的 XML 名称。
• 下拉选项：表单下拉字段中显示的选项列表。点击“添加选项”即可添加所需的选项。
• 必填：复选框，用于指示该字段是否为必填项。
• 默认值：使用此处提供的文本填充表单。
• 描述：辅助文本，用于描述该字段的用途。

单选按钮字段选项

• 显示名称：表单中字段的名称。
• XML 名称：显示名称的净化版本。它必须是有效的 XML 元素名称。
• 覆盖：复选框，用于更改默认的 XML 名称。
• 单选按钮选项：表单单选按钮字段中显示的选项列表。点击“添加选项”即可添加所需的选项。
• 必填：复选框，用于指示该字段是否为必填项。
• 默认值：使用此处提供的文本填充表单。
• 描述：辅助文本，用于描述该字段的用途。

复选框字段选项

• 显示名称：表单中字段的名称。
• XML 名称：显示名称的净化版本。它必须是有效的 XML 元素名称。
• 覆盖：复选框，允许您更改默认的 XML 名称。
• 复选框选项：表单复选框字段中显示的选项列表。点击添加选项添加所需的选项。
• 必填：复选框，指示该字段是否为必填项。
• 默认值：使用此处提供的文本填充表单。
• 描述：描述字段用途的帮助文本。

文件上传字段选项

• 显示名称：表单中字段的名称。
• XML 名称：显示名称的净化版本。它必须是有效的 XML 元素名称。
• 覆盖：复选框，允许您更改默认的 XML 名称。
• 接受的文件类型扩展名：允许上传的文件类型列表。例如，.xml 仅接受 XML 文件。要允许所有文件类型，请使用 *。点击添加选项添加需要的选项。
• 必填：复选框指示该字段是否为必填项。
• 默认值：使用此处提供的文本填充表单。
• 描述：辅助文本，描述该字段的用途。

访问你的表单

表单设计完成后，点击设计器顶部的“表单 URL”链接即可访问。以下表单是一个简单的示例：

提交新的表单数据

在表单编辑器中创建表单后，用户可以访问Form 端口的 Web 接口并通过表单提交数据。

对于主表单中的字段，用户只需输入与表单标签相对应的值（取自你拖入表单设计器的字段名称）。

用户可以通过点击“添加行”向详细信息表添加行。用户输入所有数据后，点击“提交”即可提交数据。如果提交成功，系统会显示类似以下内容的消息。

当用户提交表单时，表单数据会被推送到“事务”选项卡。输出是一个包含以下结构的 XML 文件：

<Items>
  <FormTitle>
    <FieldA>data</FieldA>
    <FieldB>more data</FieldB>
    <FieldC>even more data</FieldC>
    <DetailTitle>
      <SubFieldA>123</SubFieldA>
      <SubFieldB>456</SubFieldB>
    </DetailTitle>
    <DetailTitle>
      <SubFieldA>135</SubFieldA>
      <SubFieldB>246</SubFieldB>
    </DetailTitle>
  </FormTitle>
</Items>

此输出非常适合由 XMLMap 端口 处理，以便可以将其映射为可供另一个端口使用的 XML 格式。

宏

在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。 通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。 这有助于确保文件名反映对组织重要的详细信息。

知行之桥 支持这些宏，它们都使用以下语法：%Macro%。

示例

某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。 所有带有参数的宏都使用以下语法：%Macro:argument%

以下是带有参数的宏的一些示例：

• %Header:headername%：其中 headername 是消息上消息头的名称。
• %Header:mycustomheader% 解析为输入消息上设置的 mycustomheader 消息头的值。
• %Header:ponum% 解析为输入消息上设置的 ponum 消息头的值。
• %RegexFilename:pattern%：其中“pattern”是正则表达式模式。 例如，%RegexFilename:^([\w][A-Za-z]+)% 匹配并解析为文件名中的第一个单词，并且不区分大小写（test_file.xml解析为test） 。
• %Vault:vaultitem%：其中 vaultitem 是 vault 中项目的名称。 例如，%Vault:companyname%解析为存储在保管库中的companyname项的值。
• %DateFormat:format%：其中 format 是可接受的日期格式（有关详细信息，请参阅示例日期格式）。 例如，%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%解析为文件上的日期和时间戳。

还可以创建更复杂的宏，如以下示例所示：

• 将多个宏组合在一个文件名中：%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
• 包括宏之外的文本：MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
• 在宏中包含文本： %DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%