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

# File 端口

> File 端口可将文件从外部目录拉入工作流，并将工作流中的文件推送到外部目录。

export const CommonCacheCleanup = () => <>
    <p>知行之桥会自动清理资源缓存。此过程在每次接收周期的后台运行，删除远程服务器上已不存在的文件对应的过期缓存条目。这使得缓存大小始终保持在可管理范围内，无需任何手动操作。</p>
    <p>默认情况下，文件保留 30 天，但您可以在<strong>高级</strong>选项卡的<strong>其他设置</strong>字段中使用 <code>ResourceCacheRetentionDays</code> 设置来调整保留时间以适应您的环境。例如，<code>ResourceCacheRetentionDays=15</code> 表示文件保留 15 天后将被删除。</p>
  </>;

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 Message = () => <>
    <p><em>消息设置确定端口如何搜索消息并在处理后管理它们。</em></p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>保存到已发送文件夹</strong></td>
            <td>选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。</td>
          </tr>
        
        <tr>
          <td><strong>已发送文件夹方案</strong></td>
          <td>端口根据选定的时间间隔对 <strong>已发送</strong> 文件夹中的文件进行分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 <strong>已发送</strong> 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。</td>
        </tr>
      </tbody>
    </table>
  </>;

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 Performance = () => <>
    <p><em>与端口资源分配相关的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>最大工作线程数</strong></td>
          <td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
        <tr>
          <td><strong>最大文件数</strong></td>
          <td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

File 端口能够：

* 将文件从外部目录拉入到 {siteName} 工作流中。
* 将文件从 {siteNameShort} 工作流导出到外部目录中。

## 核心功能

* 集成本地和网络文件系统，支持 UNC 路径
* 为受保护的网络位置提供可配置的身份验证（仅限 .NET 版本）
* 支持 Glob 模式匹配的高级过滤功能及递归目录查找
* 支持带暂存和重命名操作的临时文件处理，确保传输的可靠性
* 提供可选的缓存功能，确保仅下载新增或更新的文件

## 概览

每个 File 端口都需要配置磁盘路径，该路径决定了它将从哪个文件夹读取文件或向哪个文件夹写入文件。可以是本地磁盘路径，也可以是网络上其它文件位置的 UNC 路径。

当 File 端口从配置的路径接收到文件时，它会将接收到的文件传递给 {siteNameShort} 工作流中的下一个端口，不会修改文件。这样，File 端口可用于轮询外部文件夹，以将文件拉入工作流。

当 {siteNameShort} 工作流中的文件被 File 端口处理时，该文件将被写入到配置路径下的文件夹中。通过这种方式，File 端口可用于将已处理的文件放在应用程序外部的位置。

File 端口可以配置用户名／密码凭据，以提供对外部文件路径的访问，否则应用程序将无法访问这些路径。这允许 {siteNameShort} 从受保护的文件夹位置提取文件，而不需要授予整个应用程序对受保护位置的访问权限。

File 端口中配置的路径可以使用宏动态填充。更多信息，请参见[宏](#宏)部分。

## 端口配置

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

### 设置

#### 端口设置

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

| 设置        | 描述                                                 |
| --------- | -------------------------------------------------- |
| **端口 ID** | 端口的静态唯一标识符。                                        |
| **端口类型**  | 显示端口名称及其功能描述。                                      |
| **端口描述**  | 一个可选字段，用于对端口及其在工作流中的角色进行自由说明。                      |
| **路径**    | 端口从中获取文件或将文件推送到的外部文件路径。路径可以包含宏以进行动态求值，详情参见[宏](#宏)。 |

#### 接收

*与从外部文件路径提取文件相关的设置。*

| 设置            | 描述                                                                                        |
| ------------- | ----------------------------------------------------------------------------------------- |
| **文件掩码**      | 一种全局模式，用于过滤应该从已配置的**路径**中提取的文件。只有与文件掩码匹配的文件才会被提取。此设置可与**高级**选项卡中的**接收过滤规则**结合使用，以指定多个过滤器。 |
| **删除文件（接收后）** | 当文件被获取到 {siteNameShort} 工作流后，是否从外部路径中删除文件。                                                |

#### 认证

| 设置      | 描述                                      |
| ------- | --------------------------------------- |
| **用户名** | 用于访问文件的 Windows 用户帐户。如果未指定，端口将使用当前用户帐户。 |
| **密码**  | 指定用户帐户的密码。                              |
| **域**   | Windows 用户帐户的域。如果指定的用户是本地用户帐户，则该值可以为空。  |

#### 缓存

*与缓存及多次下载之间文件比对相关的设置。*

| 设置         | 描述                                                  |
| ---------- | --------------------------------------------------- |
| **文件大小比对** | 选中此项可保存已下载文件名和大小的记录。之前已下载的文件将被跳过，除非文件大小与上次下载不同。     |
| **时间戳比对**  | 选中此项可保存已下载文件名和最后修改时间戳的记录。之前已下载的文件将被跳过，除非时间戳与上次下载不同。 |

<Note><CommonCacheCleanup /> 启用缓存后，文件名不区分大小写。例如，端口无法区分 `TEST.TXT` 和 `test.txt`。</Note>

### 高级设置

#### 高级设置

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

| 设置           | 描述                                                                                                                                     |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| **最大下载文件数**  | 在单个接收间隔内将提取的最大文件数。如果该值不是正整数，将不会应用任何限制。                                                                                                 |
| **复写选项**     | 当端口尝试将文件写入外部路径并且该文件已经存在时，指定端口如何处理。端口可以将当前文件重命名为唯一的文件名，\_覆盖\_现有文件，\_追加\_当前文件到现有文件，\_跳过\_操作且不报错，或者\_停止\_操作并抛出错误。                         |
| **延迟接收**     | 端口在从远程路径接收文件之前等待的时间（秒）。                                                                                                                |
| **递归子目录**    | 设置为 true 以下载目标远程路径子文件夹中的文件。为接收到的文件保留目录结构。                                                                                              |
| **临时发送路径**   | 在将文件移动到配置的目标路径之前，用作暂存文件夹的目录。                                                                                                           |
| **临时发送前缀**   | 如果指定，端口将上传带有临时前缀的文件，然后在操作完成后将文件重命名为其原始文件名。                                                                                             |
| **临时发送扩展名**  | 如果指定，端口将上传带有临时扩展名的文件，然后在操作完成后将文件重命名为其原始文件名和扩展名。                                                                                        |
| **最小文件大小**   | 要处理的最小文件大小（以字节为单位）。如果正在上传的文件小于指定大小，则最终确定为 **Skipped**。对于正在下载的文件，端口会添加一个事务日志条目，指示该文件因其大小而被跳过。                                           |
| **本地文件命名规则** | 用于为端口输出消息分配文件名的规则。可以在文件名中使用宏动态包含标识符和时间戳等信息。更多信息，请参见[宏](#宏)。                                                                            |
| **接收过滤规则**   | 一个全局模式过滤器，用于确定应该从远程存储下载哪些文件（例如 \*.txt）。负模式可用于指示不应下载的文件（例如 -\*.tmp）。当需要多个**文件掩码**模式时，应使用此设置。多个模式可以用逗号分隔，除非找到完全匹配，否则后面的过滤器优先。            |
| **处理延迟**     | **事务**选项卡中文件处理延迟的时间（秒）。这是一个旧版设置。最佳做法是[使用 File 端口](../flows/designing-a-flow#interacting-with-the-local-file-system)来管理本地文件系统，而不是使用此设置。 |

#### 消息

<Message />

#### 日志

<Logging />

#### 其他设置

<MiscConnector />

### 自动化

#### 自动化设置

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

| 设置         | 描述                                                                                                                                                                                                                                                                                                                                       |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **发送**     | 切换开关，用于指示端口在文件准备好后自动发送文件。                                                                                                                                                                                                                                                                                                                |
| **重试间隔**   | 端口在重试失败发送之前等待的间隔时间。                                                                                                                                                                                                                                                                                                                      |
| **最大重试次数** | 端口尝试发送消息的次数。将此值设置为 *1* 表示端口仅进行初始发送尝试而不重试。端口在每次尝试之间等待**重试间隔**指定的时长。                                                                                                                                                                                                                                                                       |
| **接收**     | 切换开关，用于指示端口在文件准备好后自动处理文件并将其发送到**事务**选项卡。                                                                                                                                                                                                                                                                                                 |
| **间隔**     | 端口处理所有待处理文件并将其发送到**事务**选项卡的间隔时间。下一个字段取决于此处的选择：<br />**每小时** — *整点后分钟数*下拉菜单允许你指定每小时接收文件的分钟偏移量。<br />**每天** — 出现*时间*字段，用于指定接收文件的时间（UTC）。<br />**每周** — 出现两个字段。*日期*允许你选择处理日，*时间*允许你指定处理时间（UTC）。<br />**每月** — 出现两个字段。*日期*允许你选择月中处理日，*时间*允许你指定处理时间（UTC）。<br />**分钟** — 出现*分钟数*字段，用于指定处理间隔的分钟数。<br />**高级** — 出现五位 *Cron 表达式*字段，允许你指定精确的处理间隔。 |

#### 性能

<Performance />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 建立连接

File 端口必须具有适当的权限，才能从配置的**路径**读取／写入。当配置的路径是到网络上另一个服务器的 UNC 路径时，权限问题是主要关注的问题，但是当从本地磁盘上受保护的文件夹推送或提取文件时，也可能出现权限问题。

如果运行 {siteNameShort} 的用户没有访问该路径的权限，请在**设置**选项卡的[认证](#认证)部分，将**用户名**、**密码**和**域**字段设置为具有相应权限的特定用户。

## 发送／接收文件

### 发送文件

File 端口将文件从**事务**选项卡发送到**路径**中指定的外部文件夹。如果在[自动化](#自动化设置)选项卡中启用了**发送**功能，文件将自动发送。

### 接收文件

File 端口从**路径**中指定的外部文件夹接收文件，并将它们放置在端口的**事务**选项卡中。如果 File 端口连接到工作流中的另一个端口，则文件不会保留在此文件夹中，而是传递到下一个连接的端口。

如果在[自动化](#自动化设置)选项卡中启用了**接收**功能，端口将自动轮询外部文件夹以接收文件。

端口将只提取与指定**文件掩码**匹配的文件。如果**启用时间戳比对**或**启用文件大小比对**已启用，端口将缓存从远程路径提取的文件名，并且仅接收以前未收到的文件或自上次收到后已修改的文件。

### 子目录消息头

如果**递归子目录**设置为 **True**，File 端口从**路径**接收文件时：

* 收到的文件消息将在其元数据中包含子目录消息头。
* 这个消息头包含子目录，其相对于配置的**路径**。
* 这个子目录消息头可以被其它支持该功能的发送端口所识别和支持。

当发送文件时，如果发送到 File 端口**路径**的消息中存在子目录消息头：

* 文件将被放置在子目录消息头中指定的子目录（相对于 File 端口的路径设置）中。
* 如果有权限，子目录会被自动创建。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />