> ## 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.

# FTP Server 端口

> FTP Server 端口的配置和使用指南，提供访问内置 FTP 服务器的连接凭据。

FTP Server 端口提供了访问 知行之桥（全功能版本）FTP 服务器的连接凭据。

## 核心功能

* 全功能内置 FTP 服务端，支持 FTPS (FTP over TLS/SSL)
* 多客户端架构，具备独立的个人配置文件和目录隔离功能
* 可为每个交易伙伴配置发送与接收目录的权限
* 支持欢迎标语、文件过滤及临时文件处理，确保操作可靠
* 支持主动与被动模式，并可配置端口范围

## 概述

知行之桥 FTP 服务器主要在[个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md)页面中进行配置。一个 FTP Server 端口提供了一个唯一的客户端个人设置，以便向 FTP 服务器进行身份验证。客户端个人设置由用户名（与 FTP Server 端口的**端口 ID** 相同）、密码、发送目录、接收目录以及对目录读／写的权限组成。

FTP 客户端没有被授予访问 FTP 服务器根目录的权限，这意味着 FTP 客户端在连接后应该总是 *cd* 进入 Send（下载）和 Receive（上传）目录。

### 视频资源

观看此短视频，了解如何配置 FTP 服务器的概述。视频示例中使用了 SFTP 服务器，但 FTP 的原理是相同的。

[//player.bilibili.com/player.html?aid=743047147\&bvid=BV1Pk4y1K78m\&cid=1185850253\&page=1](//player.bilibili.com/player.html?aid=743047147\&bvid=BV1Pk4y1K78m\&cid=1185850253\&page=1)

## 个人设置

在与单个 FTP Server 端口建立连接之前，必须配置个人设置中的 FTP 服务器。在导航栏中点击**个人设置**，然后打开 **FTP Server** 页面。

### 服务器配置

*服务器实现设置。*

| 设置 | 描述 |
| - | - |
| **端口** | FTP 服务器将侦听传入连接的端口。 |
| **FTP Over TLS** | 当客户端连接到服务器时，应该如何协商 TLS／SSL。当设置为 "Explicit" 时，应首先建立明文连接，然后用显式命令启动 TLS／SSL。当设置为 "Implicit" 时，应立即协商 TLS／SSL，而无需首先建立明文连接。 |
| **服务器 TLS 证书** | 服务器的 TLS 证书。仅当服务器作为 FTPS 服务器运行时才需要（启用了 TLS）。 |
| **证书密码** | 访问**服务器 TLS 证书**所需的密码。 |
| **登录提示** | 连接到服务器时要呈现给 FTP 客户端的横幅。 |
| **根目录** | 服务器的根目录。将在单个客户端个人设置的根目录下创建子文件夹（即每个已配置的 FTP Server 端口）。每个客户端个人设置都包括一个 Send 文件夹（客户端可以从服务器下载文件）和一个 Receive 文件夹（客户端可以将文件上传到服务器）。 |
| **文件过滤规则** | 一种全局模式，用于确定 FTP 服务器接受哪种文件。可以指定多个模式，用逗号分隔（例如，\*.X12，\*.edi），可以指定负模式来排除某些文件模式（例如 -\*.txt）。 |

### 其它设置

*未包含在先前类别中的设置。*

| 设置 | 描述 |
| - | - |
| **主动模式** | 检查此项以在远程 FTP 服务器上启用主动模式。请注意，被动模式不太可能导致防火墙干扰连接。 |
| **空闲超时** | 设置一个时间（秒）以判断一个用户是否活动。 |
| **被动模式端口范围** | 使用被动模式时，应用程序使用任何可用端口来侦听传入的数据连接。这可以通过将此字段设置为"开始-结束"格式的端口范围来覆盖，例如："1024-" 表示高于 1024（含 1024）的任何值，"1024-2048" 表示介于 1024 和 2048（含 1024 和 2048）之间的端口。 |
| **被动模式地址** | 当使用被动模式时，应用程序返回本地接口的 IP 地址。这可以通过将该字段设置为所需的公共 IP 地址来覆盖。 |
| **启用 TLS 协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳做法是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，仅在交易伙伴不支持更高版本时使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持，可能会被拒绝。 |

#### 日志

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

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日志级别**</td>
<td>端口生成的日志的详细程度。当请求支持时，请将其设置为 **Debug**。</td></tr>
<tr><td>**日志轮换间隔**</td>
<td>创建新日志文件之前等待的天数。</td></tr>
<tr><td>**日志删除间隔**</td>
<td>删除旧日志文件之前等待的天数。</td></tr></tbody></table>

#### 其他设置

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

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

## 端口设置

在配置了 FTP 服务器个人设置之后，可以在工作流页面中创建 FTP Server 端口，并为特定的交易伙伴进行配置。

### 设置

#### 配置

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

#### 服务器状态

*端口底层服务的当前状态。可用状态如下：*

<table><thead><tr><th>状态</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**活动**</td>
<td>服务正在运行。</td></tr>
<tr><td>**非活动**</td>
<td>服务已配置，但当前未运行。</td></tr>
<tr><td>**未配置**</td>
<td>底层配置文件或服务尚未设置。</td></tr></tbody></table>

根据是否已创建 FTP 配置文件，点击**配置 FTP 配置文件**或**查看 FTP 配置文件**链接，在新选项卡中打开该配置文件。

#### 用户配置

*用于向本地 FTP 服务器进行身份验证的凭据。*

| 设置 | 描述 |
| - | - |
| **用户名** | 用于登录到本地 FTP 服务器的用户名凭据。该值始终与**端口 ID** 相同。 |
| **密码** | 与**用户名**关联的密码凭据。 |

#### 权限

*与配置的客户端对发送和接收文件夹的读／写权限相关的设置。*

| 设置 | 描述 |
| - | - |
| **发送目录权限** | 使用复选框设置 *Send* 目录的读／写权限。这个文件夹是客户端用来下载文件的。 |
| **接收目录权限** | 使用复选框设置 *Receive* 目录的读／写权限。这个文件夹是客户端用来上传文件的。 |

### 高级设置

#### 本地文件夹

*与客户端上传和下载文件的文件夹相关的设置。*

| 设置 | 描述 |
| - | - |
| **Send 文件夹** | 客户端可以下载位于 Send 文件夹中的文件。 |
| **Receive 文件夹** | 客户端上传的文件应该放在 Receive 文件夹中。文件将保留在 Receive 文件夹中，或者传递到工作流中下一个连接的端口。 |

#### 其它设置

*未包含在先前类别中的设置。*

| 设置 | 描述 |
| - | - |
| **主目录** | 已配置的服务器路径，连接用户登录后将从此路径开始。有关有效位置以及路径验证方式，请参阅[主目录](#主目录)。 |
| **文件过滤规则** | 一种全局模式，用于确定哪些文件可以上传到该用户的目录中。当需要为每个用户指定过滤器时，覆盖 FTP [个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md)页面中相同的设置。 |
| **发送后删除文件** | 客户端接收 Send 文件夹中的文件后，是否应将其从文件夹中删除。 |
| **临时接收扩展名** | 可以匹配扩展名的文件不会记录在接收表中，并且在重命名文件之前不会触发接收后事件。指定为逗号分隔的扩展名列表。 |
| **超时时间** | 在引发超时错误之前，服务器等待连接响应的持续时间（秒）。 |
| **保存 Subfolder** | 选中此项可将 Subfolder 消息头添加到收到的消息中。此消息头表示相对于本地文件夹的路径。 |
| **本地文件命名规则** | 用于为端口输出消息分配文件名的规则。可以在文件名中使用宏动态包含标识符和时间戳等信息。更多信息，请参见[宏](#宏)。 |

#### 消息

*消息设置确定端口如何搜索消息并在处理后管理它们。*

**注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**保存到已发送文件夹**（已弃用）</td>
<td>将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受[静态加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保护。</td></tr>
<tr><td>**已发送文件夹方案**（已弃用）</td>
<td>按所选时间间隔对 **Sent** 文件夹中的文件进行分组。仅在启用**保存到已发送文件夹**时适用。</td></tr></tbody></table>

#### 日志

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

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

#### 其他设置

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

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

### 告警选项卡

*与配置通知相关的设置。*

在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 选项卡上的全局设置。要为此端口使用其他设置，请启用 **覆盖全局设置**。

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

输入 **主题**（必填）。勾选**允许在主题中使用 ArcScript**，即可在**主题**字段中使用 ArcScript。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。

（可选）输入以逗号分隔的**收件人**电子邮件地址列表。

### SLA 选项卡

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

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

SLA 转换为 *存在风险* 或 *已违反* 状态时，也会写入[应用程序日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，这意味着应用性能监控 (APM) 和日志采集工具也可以针对这些状态发出警报。

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

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

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

![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png)

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

## 主目录

**主目录**设置控制客户端登录 FTP Server 端口后进入的初始文件夹。可在端口的**高级**选项卡中，于**其它设置**下进行配置。当从允许配置登录目录的其他 FTP 软件迁移，或者自动化系统登录后不执行导航（`cd`）命令、直接在当前目录上传或下载时，此设置很有用。

该字段默认为空，也接受服务器路径：

* \*\*空（默认）：\*\*客户端进入虚拟根目录 (`/`)。
* \*\*设置为路径：\*\*登录成功后，客户端的初始工作目录为指定路径。客户端连接后如果不更改目录便立即上传、下载或列出文件，将在主目录内执行操作。

主目录必须是以 `/` 开头的服务器路径，相对于端口[配置文件](#个人设置)中定义的**根目录**解析，并且必须与已配置的服务器位置匹配；不能设置为仅存在于磁盘上的任意路径。FTP Server 端口的有效位置包括：

* `/`（虚拟根目录）：字段为空时的默认值，因此显式设置为 `/` 不会产生额外效果
* `/Send`
* `/Receive`

该字段会规范化输入，因此 `Receive`、`/Receive`、`\Receive` 和 `/Receive/` 都被视为相同路径。保存端口时会验证该值；如果路径与已配置的服务器位置不匹配，系统将显示指出无效值的错误。

> [!NOTE]
>
> 主目录只设置登录时的初始目录。它不是 chroot 或隔离区，不会限制客户端之后可导航到的文件夹；文件夹访问仍由[权限设置](#权限)控制。

## 建立连接

每个 FTP Server 端口代表一个交易伙伴的连接参数。交易伙伴应使用[个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md)页面中 FTP 服务器的设置（端口、TLS 模式等）和 FTP Server 端口中的[用户配置](#用户配置)设置（用户名、密码）连接到 FTP 服务器。

每个交易伙伴都有一对单独的发送和接收目录，它们是根目录的子文件夹。交易伙伴应该从 Send 文件夹下载文件，并将文件上传到 Receive 文件夹。不允许客户端从根目录上传或下载文件。

## 宏

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

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

<table><thead><tr><th>宏</th><th>描述</th></tr></thead>
<tbody><tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
<tr><td>ConnectorName</td><td>替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。</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:*pattern*</td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
<tr><td>Header:*headername*</td><td>替换为端口正在处理的当前消息的目标消息头（`headername`）的值。</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:*format*</td><td>以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。</td></tr>
<tr><td>Vault:*vaultitem*</td><td>计算指定保管库项目的值。</td></tr></tbody></table>

### 示例

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

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

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

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

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

## 常见错误

### 错误：无法绑定指定端口：拒绝访问。

**原因**

这个错误会发生在托管 知行之桥 的进程没有足够权限在指定端口上建立监听时。

> [!NOTE]
>
> 在某些情况下（例如 Linux 环境和在 Amazon AMI 中运行的托管实例），不能使用低于 1024 的端口。

**解决方案**

选择其他端口，或将托管 知行之桥 的进程身份更改为具有绑定到该端口的权限的用户。

Amazon AMI 托管版本的 知行之桥 使用 Ubuntu 操作系统，因此 知行软件 建议您使用 *Uncomplicated Firewall*（UFW）管理端口权限问题。例如，在 知行之桥 中将 FTP Server 设置为在端口 8021 运行，并在操作系统层面使用 UFW 将端口 21 转发到 8021，如下所示：

```
ufw allow 21/tcp
ufw allow 8021/tcp
echo "
*nat
:PREROUTING ACCEPT [0:0]
-A PREROUTING -p tcp --dport 21 -j REDIRECT --to-port 8021
COMMIT" >> /etc/ufw/before.rules
```

如果您的环境使用不同的 Linux 操作系统，知行软件 建议您绑定到限制范围以上的端口（例如，FTP 流量的 8021）并使用 `iptables` 将所需端口上的传入请求路由到允许的端口：

`iptables -t nat -I PREROUTING -p tcp --dport 21 -j REDIRECT --to-port 8021`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.