> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Form 端口

> Form 端口暴露出一个公共接口，客户端在此填写表单并将数据提交到工作流，具备拖拽式设计器和用户身份验证支持。

export const TrustedIp = () => <>
    <p><strong>可信 IP 地址</strong> 部分提供以下功能：</p>

    <table>
      <thead>
        <tr><th>功能</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td><strong>添加</strong></td><td>输入新的 IP 地址范围。</td></tr>
        <tr><td><strong>编辑</strong></td><td>修改选定的 IP 地址范围。</td></tr>
        <tr><td><strong>删除</strong></td><td>从列表中删除选定的 IP 地址范围。</td></tr>
      </tbody>
    </table>

    <p>以下限制适用于此功能：</p>

    <ul style={{
  listStyleType: 'disc',
  paddingLeft: '1.5rem'
}}>
      <li style={{
  display: 'list-item'
}}><code>localhost</code> 不能被修改或从列表中删除。</li>
      <li style={{
  display: 'list-item'
}}>任何超出定义范围的 IP 地址都将被拒绝。</li>
      <li style={{
  display: 'list-item'
}}>支持 IP 范围。例如，条目 <code>100.10.100.1-15</code> 表示允许 <code>100.10.100.1</code> 和 <code>100.10.100.15</code> 之间的 IP 地址。</li>
      <li style={{
  display: 'list-item'
}}>支持无类别域间路由 (CIDR) 表示法。例如，条目 <code>100.10.100.0/24</code> 表示允许 <code>100.10.100.0</code> 和 <code>100.10.100.255</code> 之间的 IP 地址。</li>
      <li style={{
  display: 'list-item'
}}>支持通配符模式。例如，条目 <code>100.10.100.*</code> 表示允许以 <code>100.10.100</code> 开头的 IP 地址。</li>
    </ul>

    <Note>
      <p>为了让客户端能够访问服务器，需要有清晰的网络路径。在云环境中，可能需要在三个地方进行更改：</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• 云控制台中的网络规则。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• 托管应用程序的机器上的防火墙规则。例如，在使用 Amazon AMI 时，可以使用 <em>简单防火墙</em>（UFW）来允许所需端口上的流量。Linux 环境中的常见策略是将流量从低于 1024 的端口转发到高于 1024 的非标准端口，同时将应用程序配置为使用非标准端口。这可以避免与非 root 用户绑定到低于 1024 的端口相关的权限问题。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <a href="/26.2/self-hosted/zh/getting-started/administration/settings/security">安全</a> 选项卡的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/network-access">网络访问</a> 部分。</p>
    </Note>
  </>;

export const NameDescription = ({extraRows}) => <table>
    <thead>
      <tr>
        <th>设置</th>
        <th>描述</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><strong>端口 Id</strong></td>
        <td>端口的静态、唯一标识符。</td>
      </tr>
      <tr>
        <td><strong>端口类型</strong></td>
        <td>显示端口类型及其用途的描述。</td>
      </tr>
      <tr>
        <td><strong>端口描述</strong></td>
        <td>一个可选字段，用于提供端口及其在流中的角色的自由格式描述。</td>
      </tr>
      {extraRows}
    </tbody>
  </table>;

export const SlasTab = ({siteName = "知行之桥"}) => <>
    <p><em>与配置服务级别协议 (SLA) 相关的设置。</em></p>
    <p>
      SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 <em>存在风险</em>，这意味着如果 SLA 未能尽快达到，则会被标记为 <em>已违反</em>。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
    </p>
    <p>
      要定义 SLA，请启用 <strong>预期数据量</strong>，然后点击 <strong>设置</strong> 选项卡。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
      <li>在窗口的 <strong>预计至少</strong> 部分中：
        <ul>
          <li>设置预计处理的最小事务数量（交易量）</li>
          <li>使用 <strong>每个</strong> 字段指定时间范围</li>
          <li>指示 SLA 生效的时间。如果选择 <strong>开始于</strong>，请填写日期和时间字段。</li>
          <li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 <strong>每天</strong>。</li>
        </ul>
      </li>
      <li>在窗口的 <strong>将状态设置为“有风险”</strong> 部分中，指定应将 SLA 标记为有风险的时间。
        <ul>
          <li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 <strong>发送“有风险”通知</strong>。</li>
        </ul>
      </li>
    </ul>
    <p>
      以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 <strong>设置</strong>，然后跳转到 <strong>通知 &gt; 通用通知</strong>。点击平板和铅笔图标进行编辑，并取消勾选 <strong>SLA 通知</strong> 设置。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
    <p><em>与配置通知相关的设置。</em></p>
    <p>
      在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 选项卡上的全局设置。要为此端口使用其他设置，请启用 <strong>覆盖全局设置</strong>。
    </p>
    <p>
      默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 <strong>启用</strong> 复选框。
    </p>
    <p>
      输入 <strong>主题</strong>（必填），然后（可选）输入以逗号分隔的 <strong>收件人</strong> 电子邮件列表。
    </p>
  </>;

export const MiscConnector = () => <>
    <p><em>特殊设置适用于特定用例。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>其他设置</strong></td>
          <td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 <code>setting1=value1;setting2=value2</code>。正常的端口用例和功能不需要使用这些设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>用于管理日志创建和存储的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>日志级别</strong></td>
          <td>指定要记录在端口日志目录中的信息类型：
            <ul>
              <li><b>None</b> - 不创建任何日志。</li>
              <li><b>Error</b> - 仅当端口遇到错误时才创建日志。</li>
              <li><b>Warning</b> - 仅当端口发出警告时才创建日志。</li>
              <li><b>Info</b> - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
              <li><b>Debug</b> - 记录成功和失败工作流的详细调试信息。</li>
              <li><b>Trace</b> - 记录成功和失败工作流的详细跟踪信息。</li>
            </ul>
            <strong>请注意：</strong><strong>Debug</strong> 和 <strong>Trace</strong> 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td>
        </tr>
        <tr>
          <td><strong>日志文件夹结构</strong></td>
          <td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td>
        </tr>
        <tr>
          <td><strong>保留消息副本</strong></td>
          <td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：<code>%Macro:argument%</code>
    </p>

    <p>以下是带有参数的宏的一些示例：</p>

    <ul>
      <li>%Header:headername%：其中 <code>headername</code> 是消息上消息头的名称。</li>
      <li>%Header:mycustomheader% 解析为输入消息上设置的 <code>mycustomheader</code> 消息头的值。</li>
      <li>%Header:ponum% 解析为输入消息上设置的 <code>ponum</code> 消息头的值。</li>
      <li>%RegexFilename:pattern%：其中 <code>pattern</code> 是正则表达式模式。例如，<code>%RegexFilename:^([\w][A-Za-z]+)%</code> 匹配并解析为文件名中的第一个单词，并且不区分大小写（<code>test_file.xml</code> 解析为 <code>test</code>）。</li>
      <li>%Vault:vaultitem%：其中 <code>vaultitem</code> 是 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault">vault</a> 中项目的名称。例如，<code>%Vault:companyname%</code> 解析为存储在保管库中的 <code>companyname</code> 项的值。</li>
      <li>%DateFormat:format%：其中 <code>format</code> 是可接受的日期格式（有关详细信息，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#sample-date-formats">示例日期格式</a>）。例如，<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> 解析为文件上的日期和时间戳。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

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

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

export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
    <p>
      在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
    </p>

    <p>{siteName} 支持这些宏，它们都使用以下语法：<code>%Macro%</code>。</p>

    <table>
      <thead>
        <tr><th>宏</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
        <tr><td>Ext</td><td>替换为端口当前正在处理的文件的文件扩展名。</td></tr>
        <tr><td>Filename</td><td>替换为端口当前正在处理的文件的文件名（包括扩展名）。</td></tr>
        <tr><td>FilenameNoExt</td><td>替换为端口当前正在处理的文件的文件名（不带扩展名）。</td></tr>
        <tr><td>MessageId</td><td>计算端口输出的消息的 MessageId。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>替换为端口正在处理的当前消息的目标消息头（<code>headername</code>）的值。</td></tr>
        <tr><td>LongDate</td><td>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</td></tr>
        <tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>以指定格式（<code>format</code>）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">示例日期格式</a>。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>计算指定保管库项目的值。</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

Form 端口暴露出一个公共接口，可以将 WebForm 的数据提交到 {siteName} 工作流中。

## 核心功能

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

## 概览

表单是从 Form 端口**表单设计器**选项卡创建的。表单分为段和明细，每个段都可以有可变数量的表单字段。更多详情请查阅[创建表单](#创建表单)部分。

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

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

## 端口配置

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

### 表单设计器选项卡

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

<img src="https://mintcdn.com/qiao/U-KEZ9JbQY4Wqs1D/public/images/Form_connector_form_designer.png?fit=max&auto=format&n=U-KEZ9JbQY4Wqs1D&q=85&s=3b5cd88395c72e97070d39cce50dcbbe" width="700" data-path="public/images/Form_connector_form_designer.png" />

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

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

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

### 设置页

#### 端口配置

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

<NameDescription />

#### 高级设置

| 设置           | 描述                                                          |
| ------------ | ----------------------------------------------------------- |
| **本地文件命名规则** | 用于为端口输出消息分配文件名的规则。可以在文件名中使用宏动态包含标识符和时间戳等信息。更多信息，请参见[宏](#宏)。 |

### 表单用户

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

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

#### 添加用户

添加用户凭据：

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

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

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

#### 编辑用户

要编辑现有用户：

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

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

#### 删除单个用户

要删除单个用户：

1. 点击要删除的用户旁边的省略号，然后点击**删除**。

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

#### 删除多个用户

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

### 服务器选项卡

#### 受信任的 IP 地址

<TrustedIp />

### 高级页面

#### 日志

<Logging />

#### 其他设置

<MiscConnector />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

### 事务选项卡

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

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

## 配置 IIS 服务器

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

要禁用 Windows 身份验证：

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

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

   <img src="https://mintcdn.com/qiao/bVtjD3fvHFZBo1vE/public/images/form_iis_1.png?fit=max&auto=format&n=bVtjD3fvHFZBo1vE&q=85&s=5f95a2a7a8a28cead6d764af7c315774" width="450" data-path="public/images/form_iis_1.png" />

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

   <img src="https://mintcdn.com/qiao/bVtjD3fvHFZBo1vE/public/images/form_iis_2.png?fit=max&auto=format&n=bVtjD3fvHFZBo1vE&q=85&s=75ccca5148e7f42c2616fab7ef8bab4f" width="500" data-path="public/images/form_iis_2.png" />

## 创建表单

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

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

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

### 添加部分

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

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

要添加部分：

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

2. 现在您可以开始向该部分[添加字段](#添加字段)。

   <img src="https://mintcdn.com/qiao/U-KEZ9JbQY4Wqs1D/public/images/Form_connector_form_designer_add_section_results.png?fit=max&auto=format&n=U-KEZ9JbQY4Wqs1D&q=85&s=73b30c6bfe5c5f7d718119bac44a2b2b" width="450" data-path="public/images/Form_connector_form_designer_add_section_results.png" />

### 添加详细信息表

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

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

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

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

   <img src="https://mintcdn.com/qiao/U-KEZ9JbQY4Wqs1D/public/images/Form_connector_form_designer_add_detail_result.png?fit=max&auto=format&n=U-KEZ9JbQY4Wqs1D&q=85&s=28fbe39114205a5e3c8285b2b42a4eb0" width="450" data-path="public/images/Form_connector_form_designer_add_detail_result.png" />

### 添加字段

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

添加字段：

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

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

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

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

   <img src="https://mintcdn.com/qiao/U-KEZ9JbQY4Wqs1D/public/images/Form_connector_form_designer_form_field.png?fit=max&auto=format&n=U-KEZ9JbQY4Wqs1D&q=85&s=0b32b7992c435ec4dc60730e103bdcb9" width="450" data-path="public/images/Form_connector_form_designer_form_field.png" />

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

### 表单字段类型

#### 文本字段选项

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

#### 下拉字段选项

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

#### 单选按钮字段选项

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

#### 复选框字段选项

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

#### 文件上传字段选项

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

### 访问你的表单

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

<img src="https://mintlify.s3.us-west-1.amazonaws.com/qiao/public/images/Form_connector_final_form.png" width="650" />

## 提交新的表单数据

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

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

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

<img src="https://mintcdn.com/qiao/U-KEZ9JbQY4Wqs1D/public/images/Form_connector_form_designer_success_message.png?fit=max&auto=format&n=U-KEZ9JbQY4Wqs1D&q=85&s=da9190562b7886f367c0cd6ba31f4091" width="250" data-path="public/images/Form_connector_form_designer_success_message.png" />

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

```xml theme={null}
<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-map/xml-map) 处理，以便可以将其映射为可供另一个端口使用的 XML 格式。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />
