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

# Finalize 端口

> Finalize 端口在下游工作流成功后完成被延迟的源消息，以便源端口可以安全地执行清理。

Finalize 端口用于完成被延迟的源消息。将其放在工作流成功路径的末端，用于确认工作流已成功处理某个文件，以便接收该文件的端口执行其后处理操作，例如删除源文件。Finalize 端口随知行之桥提供，无需单独的许可证。

> [!NOTE]
>
> 只有 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md) 可以延迟最终确定。其他源端口不支持此功能。

## 核心功能

* 延迟清理源文件，在下游工作流成功之前不会删除已接收的文件
* 自动处理超时，释放待处理文件以供再次接收，且不删除源文件
* 无需配置即可关联到源端口，因为消息本身携带了查找源端口所需的信息
* 消息无法最终确定时提供清晰的错误消息

## 概览

默认情况下，File 端口等源端口在接收到消息后会立即完成该消息。任何后处理操作（例如从源文件夹中删除文件）都会立即执行，即使下游工作流随后失败也是如此。

在 File 端口上启用 **延迟最终确定接收的文件** 后，端口会将每个接收到的文件保持为待处理状态。Finalize 端口会在工作流的其余部分成功后完成该待处理文件。

当消息到达 Finalize 端口时，该端口会：

1. 读取消息携带的延迟源信息。
2. 找到接收该文件的源端口。
3. 通知源端口最终确定该文件，从而触发源端口中配置的清理操作（例如，启用 **删除文件（接收后）** 时删除该文件）。

Finalize 端口没有输出，只能作为[工作流](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/flows.md)中的最后一个端口使用。

## 端口配置

本节包含所有可配置的端口属性。

### 设置选项卡

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

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

### 高级选项卡

#### 其他设置

| 设置 | 描述 |
| - | - |
| **处理延迟** | 放入 **交易** 选项卡的文件延迟处理的时间（以秒为单位）。这是一个旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)管理本地文件系统，而不是使用此设置。 |

#### 日志

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

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

### 自动化选项卡

#### 自动化设置

*与端口自动处理文件相关的设置。*

| 设置 | 描述 |
| - | - |
| **发送** | 指示端口在文件准备就绪时自动发送文件的开关。 |
| **重试间隔** | 端口在重试失败发送之前等待的时间间隔。 |
| **最大次数** | 端口尝试发送消息的次数。将此值设置为 *1* 表示端口只执行初始发送尝试，不进行重试。每次尝试之间，端口会等待 **重试间隔** 指定的时长。 |

#### 性能

*与端口资源分配相关的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**最大工作线程数**</td>
<td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。</td></tr>
<tr><td>**最大文件数**</td>
<td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。</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 通知** 设置。

### 交易选项卡

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

## 将 Finalize 与 File 端口配合使用

要将已接收文件的删除操作延迟到工作流成功之后：

1. 在接收文件的 File 端口上，启用 **延迟最终确定接收的文件**；如果希望删除源文件，还需启用 **删除文件（接收后）**。请参阅[接收](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md#接收)。
2. 构建处理该文件的工作流的其余部分。
3. 添加一个 Finalize 端口，并将其连接到处理该文件的最后一个端口的 **成功路径**。

例如，某个工作流先使用 File 端口接收文件，再使用 X12 端口对其进行转换，然后将数据 upsert 到 SQL Server，最后对文件进行最终确定，其配置如下：

![包含 File 端口、X12 端口、SQL Server 端口和 Finalize 端口的工作流](https://mintcdn.com/qiao/kYLwR1iZrGqYINH1/26.4/images/finalize-flow.png?fit=max\&auto=format\&n=kYLwR1iZrGqYINH1\&q=85\&s=75756e1f66745065f1c531e76d53c639)

1. File 端口从其配置的路径接收文件，并将其保持为待处理状态。
2. X12 端口将文件转换为 XML。
3. SQL Server 端口将 XML 数据 upsert 到 SQL Server。
4. SQL Server 端口的 **成功路径** 连接到 Finalize 端口，由 Finalize 端口完成该待处理文件。

只有在工作流开头接收文件的 File 端口才能延迟最终确定。工作流后面用于将文件发送到文件夹的 File 端口不会延迟任何操作，但工作流仍可以以一个 Finalize 端口结束，以完成原始文件。

在发生以下任一情况之前，文件会一直保持待处理状态，且不会被再次接收：

* **文件到达 Finalize 端口。** File 端口完成该文件并执行配置的清理操作。
* **达到待处理超时时间。** 此超时由 File 端口 [自动化选项卡](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md#自动化设置) 上的 **接收待处理超时（分）** 设置控制。消息会被标记为 Pending Timeout 错误，源文件不会被删除，并且该文件会被释放，以便可以再次接收。

> [!NOTE]
>
> 并非来自启用了延迟最终确定的端口的消息无法被最终确定。将普通消息发送到 Finalize 端口会导致错误。

### 源文件变更

如果源文件在接收之后、最终确定之前发生了变更，端口不会删除该文件。应用程序日志中会包含以下消息，其中 `{0}` 为文件名：

`Source file '{0}' changed after it was received. Deferred finalization will not delete it.`

### 待处理超时

File 端口 **自动化** 选项卡上的 **接收待处理超时（分）** 设置控制已接收文件保持待处理状态的时长。默认值为 10 分钟；设置为 0 时，文件会无限期保持待处理状态。如果待处理消息在超时之前未被最终确定：

* 应用程序日志会记录该消息在等待最终确定时超过了待处理超时时间。
* 系统会发送一封主题为 **Send Failure: Pending Timeout** 的错误通知。
* 消息会被标记为 Pending Timeout 错误，在 **交易** 选项卡中显示为 **Error**。
* 源文件不会被删除，该文件将可以被再次接收。

待处理消息检查作为 **检查待处理** 自动化操作运行。在 **Debug** [日志级别](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#日志级别)下，[自动化日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#自动化日志)会记录每次检查以及其处理的超时消息数量。

### 延迟消息信息

为延迟最终确定而保留的文件会在其消息头中携带额外信息。要查看这些消息头，请在 File 端口的 **交易** 选项卡中打开该消息，然后转到 **详细信息** 选项卡。

| 消息头 | 描述 |
| - | - |
| **File-Deferred-Source** | 等待最终确定的源文件的路径。 |
| **Defer-Finalize** | 属于最终确定链的工作区、端口和消息 Id。Finalize 端口使用此消息头查找源端口以及要完成的待处理消息。 |
| **Processed** | 列出处理过该消息的每个端口及其状态。在消息被最终确定之前，启用了延迟最终确定的 File 端口会显示为 **待处理**。 |

## 故障排除

当 Finalize 端口无法完成消息时，会报告以下错误。

| 错误 | 原因和解决方法 |
| - | - |
| The message has no deferred source lineage. | 该消息并非来自启用了延迟最终确定的端口。请在启动该工作流的 File 端口上启用 **延迟最终确定接收的文件**。要进行确认，请检查该消息的详细信息中是否包含 **Defer-Finalize** 消息头。 |
| The deferred source lineage is invalid or has already been completed. | 用于标识源消息的信息格式不正确，或者该消息已被最终确定。请检查工作流是否多次将同一消息发送到 Finalize 端口。 |
| The deferred source connector `{workspace}:{connector}` does not exist. | 源端口在接收文件后被删除或重命名。请恢复该端口，或从源端重新处理该文件。 |
| The deferred source connector `{workspace}:{connector}` is busy. | 源端口正在处理其他工作。请在源端口处理完成后重试发送。 |
| The pending source message `{id}` does not exist in `{workspace}:{connector}`. | 待处理消息在到达 Finalize 端口之前已超时。如果此情况经常发生，请检查工作流完成所需的时间是否超过了 File 端口的 **接收待处理超时（分）**，并在需要时增大该超时值。 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
设置	描述
端口 Id	端口的静态、唯一标识符。
端口类型	显示端口类型及其用途的描述。
端口描述	一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
设置	描述
日志级别	指定要记录在端口日志目录中的信息类型： None - 不创建任何日志。 Error - 仅当端口遇到错误时才创建日志。 Warning - 仅当端口发出警告时才创建日志。 Info - 记录工作流的一般信息，包括任何错误和警告（如果适用）。 Debug - 记录成功和失败工作流的详细调试信息。 Trace - 记录成功和失败工作流的详细跟踪信息。 \\请注意：\\Debug 和 Trace 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。
日志文件夹结构	指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。
保留消息副本	指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。
设置	描述
最大工作线程数	此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。
最大文件数	分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。