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

# Partner Mailbox 端口

> 知行之桥 Partner Mailbox 端口的配置和使用指南。

Partner Mailbox 端口为交易伙伴提供一个私有的、基于浏览器的邮箱，用于自助文件交换。交易伙伴登录后可下载为其暂存的文件，也可上传要发送的文件。

## 核心功能

* 每个交易伙伴一个邮箱，每个邮箱都有各自的凭据、URL 和文件夹树
* 为不具备常规 MFT 能力的交易伙伴提供自助文件交换
* 结构清晰的发送和接收文件夹树，支持拖放管理
* 针对已下载文件的文件保留控制，支持重新下载
* 文件扩展名筛选，用于控制交易伙伴可以上传的文件
* 可为面向交易伙伴的邮箱页面自定义页面标题和 Logo 品牌
* 使用标准 `SubFolder` 消息头按文件夹路由，与其他 MFT 端口保持一致

## 概览

每个 Partner Mailbox 端口代表一个交易伙伴的邮箱。交易伙伴打开专用网页，使用用户名和密码进行身份验证，然后即可下载为其暂存的文件并上传要发送的文件。多个交易伙伴需要多个端口实例。

[交易伙伴的邮箱页面](#交易伙伴邮箱视图)分为两个部分：暂存供交易伙伴下载的文件（发送文件夹），以及交易伙伴可以上传文件的文件夹（接收文件夹）。每个部分都使用一棵独立的文件夹树，由管理员在端口配置中进行管理。

交易伙伴上传的文件会像来自任何其他端口的文件一样，以消息的形式进入知行之桥工作流。工作流中的路由由 `SubFolder` 消息头处理，详见[路由的工作原理](#路由的工作原理)。

> [!NOTE]
>
> 目前，网页是唯一的访问方式。通过 SFTP 和 FTP 访问同一邮箱的功能计划在未来版本中提供。

## 端口配置

### 邮箱配置选项卡

此选项卡顶部显示的 **交易伙伴邮箱 URL** 是交易伙伴访问其邮箱所使用的地址。该 URL 的格式为 `.../connector/<workspace>/<connectorId>/mailbox.rst`。完成配置后，请将此 URL 分享给交易伙伴。

#### 邮箱身份验证

*交易伙伴登录邮箱页面时使用的凭据。*

| 设置 | 描述 |
| - | - |
| **用户** | 交易伙伴邮箱帐户的用户名。每个邮箱只有一个帐户。 |
| **密码** | 交易伙伴邮箱帐户的密码。 |

#### 文件管理 - 交易伙伴下载

*控制为交易伙伴暂存的文件在下载后如何管理的设置。*

| 设置 | 描述 |
| - | - |
| **当交易伙伴下载文件时** | 是保留文件以供重新下载，还是在首次下载后将其移除。**保留文件直到保留期结束** 允许在文件过期之前重复下载，而 **下载后删除** 会在首次下载后移除文件。将 **已下载文件的保留期** 设置为 0 与 **下载后删除** 的效果相同。 |
| **已下载文件的保留期** | 已下载文件可供重新下载的天数。默认值为 7 天。保留期从首次下载之日起计算，而不是从文件暂存之时起计算，并且重新下载不会重置计时。仅当 **当交易伙伴下载文件时** 设置为 **保留文件直到保留期结束** 时适用。 |

#### 文件管理 - 交易伙伴上传

*控制允许交易伙伴上传哪些文件的设置。*

| 设置 | 描述 |
| - | - |
| **文件扩展名** | 在接受文件之前对其应用的通配符模式筛选器。例如，`*.txt` 仅接受 .txt 文件，`-*.pdf` 会阻止 .pdf 文件。多个文件类型之间用逗号分隔。留空则接受所有文件类型。 |

#### 交易伙伴邮箱页面

*面向交易伙伴的邮箱页面外观设置。*

| 设置 | 描述 |
| - | - |
| **页面标题** | 显示在交易伙伴邮箱页面顶部的标题。 |
| **交易伙伴邮箱 Logo** | 在邮箱页面上作为 Logo 显示的图片，以及 Logo 区域的背景颜色。 |

#### 交易伙伴邮箱文件夹

文件夹配置分为两个选项卡：**发送文件夹** 用于存放暂存供交易伙伴下载的文件，**接收文件夹** 是交易伙伴上传文件的文件夹。每个选项卡都有一棵独立的文件夹树，从一个根文件夹开始。**部分标题** 字段用于设置交易伙伴页面上该部分上方显示的标题。

您可以在根文件夹下添加、重命名、移动和删除任意层级的子文件夹。文件夹名称只能包含字母、数字和下划线，并且在同一父文件夹中必须唯一（比较时不区分大小写）。根文件夹无法删除。

将鼠标悬停在文件夹上，必要时可使用写字板和铅笔图标对其重命名。使用带加号的文件夹图标可向树中添加子文件夹。顶层文件夹无法删除，但可以单击垃圾桶图标删除子文件夹。有关详细信息，请参阅[管理文件夹树](#管理文件夹树)。

##### 发送文件夹

| 设置 | 描述 |
| - | - |
| **部分标题** | 交易伙伴邮箱页面上下载部分上方显示的标题。默认为 **Files For You**。 |

##### 接收文件夹

| 设置 | 描述 |
| - | - |
| **部分标题** | 交易伙伴邮箱页面上上传部分上方显示的标题。默认为 **Your submissions**。 |

### 设置选项卡

#### 端口信息

*用于标识和描述端口的常规设置。*

| 设置 | 描述 |
| - | - |
| **端口 Id** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能说明。 |
| **端口描述** | 可选字段，用于以自由文本形式描述端口及其在工作流中的角色。 |

### 高级选项卡

#### 高级设置

| 设置 | 描述 |
| - | - |
| **上传历史保留期** | 交易伙伴上传的文件在其邮箱页面的提交历史中保持可见的天数。默认值为 30 天。文件本身在被接受时就会立即传递给工作流；此设置仅控制交易伙伴可以在多长时间内看到自己已提交该文件。 |

#### 日志

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

<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 通知** 设置。

## 路由的工作原理

Partner Mailbox 端口中的路由使用其他 MFT 端口所采用的标准 `SubFolder` 消息头机制。

**交易伙伴上传（接收文件夹）**

当交易伙伴上传文件时，文件会被写入交易伙伴在邮箱页面上选择的接收子文件夹。生成的消息带有一个 `SubFolder` 消息头，其值为该文件夹的路径。随后，[Branch](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/branch.md) 等下游端口可以根据该消息头的值对消息进行路由。这正是定义多个接收子文件夹的主要原因：交易伙伴可以通过选择相应的文件夹来表明所发送文件的类型，工作流则据此进行分支处理。

**为交易伙伴暂存文件（发送文件夹）**

要将文件投递到交易伙伴页面上的特定发送子文件夹，上游端口或脚本必须在消息到达 Partner Mailbox 端口\_之前\_将 `SubFolder` 消息头设置为目标子文件夹路径。端口本身没有路由 UI。您必须在工作流的前面设置该消息头，通常使用 [Script](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/script.md) 端口。

> [!NOTE]
>
> 在上游端口中设置 `SubFolder` 消息头时请格外注意。如果该消息头缺失或设置为不存在的路径，文件将被报告为无法投递，并添加到出错消息视图中。有关详细信息，请参阅[管理文件夹树](#管理文件夹树)。

## 管理文件夹树

重命名、移动或删除发送或接收文件夹，可能会影响已暂存或正在传输中的文件。在确认此类更改之前，知行之桥会显示受影响文件夹中当前的文件数量。请在继续操作之前确认不会有文件被滞留。

重命名或移动文件夹后，已暂存在旧路径下的文件不会自动更新。任何将 `SubFolder` 消息头设置为旧路径的上游端口或脚本，也必须更新为使用新路径。

被报告为无法投递的文件会显示在出错消息视图中。添加缺失的文件夹或更正上游脚本后，可以将这些文件重新排队。

## 保留期与文件生命周期

以下规则决定了发送文件夹中的文件在暂存后如何管理：

* **下载后删除**：文件在首次下载后会从交易伙伴的邮箱页面中移除。将 **已下载文件的保留期** 设置为 0 具有相同的效果。
* **保留文件直到保留期结束**：在保留期到期之前，交易伙伴可以重新下载该文件。每次下载都会在端口的交易日志中记录为一次成功发送。
* **保留期从首次下载开始计算**，而不是从文件暂存之时开始计算。重新下载不会重置保留期。
* **从未被下载的文件永远不会**因保留期设置而**被清除**。这些文件会一直可用，直到被手动移除。
* **应用程序级别和工作区级别的发送文件夹[清理设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/cleanup-settings.md)不会影响 Partner Mailbox 的发送文件夹。** Partner Mailbox 端口会独立管理其保留期。

## 交易伙伴邮箱视图

交易伙伴通过访问 **邮箱配置** 选项卡上显示的 **交易伙伴邮箱 URL** 并输入其凭据来访问邮箱。身份验证使用浏览器原生的基本身份验证。

邮箱页面包含两个部分，如下图所示：

![交易伙伴邮箱页面，并排显示“给您的文件”和“您提交的文件”两个部分](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/partner-mailbox-page.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=68ca47a2c20191b0bc8cf44d239d2f28)

### 给您的文件（发送文件夹）

列出暂存供交易伙伴下载的文件。每一行显示文件名、文件大小、文件暂存日期和状态。对于交易伙伴尚未下载的文件，状态为 **Available**；对于已下载的文件，状态为 **Downloaded** 并附带首次下载的日期。下载按钮仅显示在可用的行上。下载整个文件夹时，会返回一个以该文件夹命名的 zip 文件。保留期已过的文件会从列表中静默消失。

### 您提交的文件（接收文件夹）

列出交易伙伴已上传的文件。每一行显示文件名、文件大小、提交日期和时间以及状态。要上传文件，交易伙伴可以将文件拖放到上传区域，或使用文件选择器，文件将上传到当前选定的接收子文件夹。上传成功和失败均以 Toast 通知的形式显示；因文件扩展名筛选器而被阻止的上传会附带一条说明拒绝原因的通知。


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