Search

Form 端口

Version 24.3.9111

Form 端口

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

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

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

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

端口配置

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

设置页

端口配置

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

  • 端口 Id 端口的静态、唯一标识符。
  • 端口类型 显示端口类型及其用途的描述。
  • 端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
  • 表单 URL 客户可以访问你的 Web 表单、填写表单字段并将数据提交到知行之桥的公共接口/URL。

表单设计器

表单设计器 支持构建一组按段和明细组织的表单字段。

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

表单设计器包含以下设置：

  • 添加：单击此按钮可添加部分或字段。 添加段允许向表单添加特定部分，而添加明细允许根据数据集的需要添加任意数量的详细信息实例。

  • 表单字段：单击 新增字段 并提供字段名称来创建字段，然后将其拖放到详细信息或部分中。 根据需要重复此操作多次。

  • 成功消息 - 此文本框显示用户在成功提交表单数据后看到的确认消息。 下图显示了用户看到的默认消息。 你可以更改该消息或在 成功消息 文本框中向消息添加其他文本。

有关如何使用这些设置创建表单的更多明细，请参阅创建表单。

消息

消息设置 确定端口如何搜索消息并在处理后管理它们。 可以将消息保存到你的 已发送 文件夹，或者可以根据 已发送 文件夹方案将它们保存，如下所述。

  • 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
  • 已发送文件夹方案 端口根据选定的时间间隔对已发送文件夹中的文件进行分组。例如，选项每周（Weekly）指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在“Sent”文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。

日志

管理日志的创建和存储的设置。

  • 日志级别 端口生成的日志的详细程度。 当端口请求支持时，请将其设置为 调试。
  • 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如，Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口，使用子文件夹有助于保持日志井井有条并提高性能。
  • 保留消息副本 选中此项可使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能，端口可能无法从 输入 或 输出 选项卡下载文件的副本。

特殊设置

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

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

通知

与配置警报和服务等级协议 (SLA) 相关的设置。

端口邮件设置

在执行 SLA 之前，需要设置电子邮件警报以获取通知。 单击 配置通知 将打开一个新的浏览器窗口，转到 系统设置，可以在其中设置系统范围的警报。 有关详细信息，请参阅通知。

服务等级协议 (SLA) 配置

SLA 能够配置期望工作流中的端口发送或接收的数量，并设置期望满足该数量的时间范围。 知行之桥在不满足 SLA 时发送电子邮件警告用户，并将 SLA 标记为 有风险，这意味着如果很快不满足 SLA，则会将其标记为 已违反。 这使用户有机会介入并确定未满足 SLA 的原因，并采取适当的措施。 如果在风险时间段结束时仍未满足 SLA，则将 SLA 标记为违反，并再次通知用户。

要定义 SLA，请单击 添加预期数量条件。

  • 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 所属的方向。
  • 将 期待至少 设置为期望处理的最小交易数量（交易量），然后使用 每 字段指定时间范围。
  • 默认情况下，SLA 每天都有效。 要更改此设置，请取消选中每日，然后选中想要的一周中的几天的框。
  • 使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
  • 默认情况下，在违反 SLA 之前不会发送通知。 要更改此设置，请选中 发送“有风险”通知。

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

用户

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

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

添加凭据

添加用户凭据：

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

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

  3. 单击 保存设置，凭据将显示在 用户 部分中。

编辑凭证

要编辑现有凭据：

  1. 选择你要编辑的凭据的用户名旁边的复选框。 选择用户会启用 编辑 按钮。

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

删除凭证

要删除现有凭据：

  1. 选中你要删除的凭据的用户名旁边的复选框。 选择用户会启用 删除 按钮。

  2. 单击确定删除凭据或单击取消取消删除请求。

配置 IIS 服务器

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

要禁用 Windows 身份验证：

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

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

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

服务器

受信任的 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 的端口相关的权限问题。
  • 系统设置 页面的 受信任的 IP 地址 部分。

创建表单

form 可以包含字段、段和明细：

  • 字段：带有标签的输入框，用户可以在其中输入表单数据。

  • 段：将字段组合在一起的标题。

  • 明细：可能会多次重复某个变量的部分。

添加字段

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

添加字段：

  1. 单击新字段。

  2. 在文本字段中输入字段名称（例如，行项目 ID）并按 Enter。 完成此步骤后，新字段将出现在 表单字段 框中。

  3. 将你想要的字段拖放到 明细 或 段 框中。 以下示例说明了将字段移动到 明细 框中：

    注意：

    • 你需要单击加号 (+) 为要拖到明细框中的每个新字段打开一行。 每行可以包含两个字段。

    • 你可以在表单设计器中拖放字段来自定义表单的布局。

    • 如果你的窗格设置为默认大小，则 表单字段 框会与窗格上的其他类别对齐。 但是，如果你展开窗格，该框会变小并附加到窗格的右侧，如下所示。

添加段

段 通过在标题下对字段进行分类来划分表单中的字段。 例如，Ship To 段可能包含 Address、City 和 Zip 等字段。

不需要段来向表单添加字段。 但是，段提供了项目的逻辑分组，可帮助用户快速理解表单。 你可以通过单击 + 按钮展开一个段以为更多字段腾出空间。

要添加一个段：

  1. 在设计器中单击“添加”，然后选择“添加段”。 在对话框中输入部分名称，然后单击 确定。

  2. 新段出现在表单设计器中。

注意：你可以在表单设计器中拖放段来自定义表单的布局。

添加明细

当某些表单字段将重复可变次数时，你应该使用明细。 例如，你可能希望将可变数量的行项目作为采购订单的一部分或可变数量的客户地址。 这样，当用户填写表单时，他们可以根据特定数据集的需要添加尽可能多的明细实例。 因此，如果用户需要提交包含三个行项目的采购订单数据，他们可以在初始明细中添加两个行项目明细，并使用特定行项目的数据填写每个明细。

要向表单添加明细：

  1. 在设计器中单击添加，然后选择添加明细。 在对话框中输入名称，然后单击 确定。

  2. 新的明细出现在表单设计器中。

访问你的表单

完成表单设计后，你可以通过单击 表单 URL 下的链接访问它（在 配置 选项卡上的 端口配置 中）。 下面的表格是一个简单的例子：

提交新的表单数据

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

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

用户可以通过单击 + 按钮添加更多详细信息行。 用户输入所有数据后，只需单击提交即可提交数据。

用户提交表单后，表单数据被推送到Form 端口的 输出 选项卡上可用的 接收 文件夹。 输出是一个包含以下结构的 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 格式。