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

# Google Storage 端口

> 知行之桥Google Storage 端口的配置与使用指南，支持从 Google Cloud Storage 服务上传和下载文件。

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

export const CommonProxySettings = () => <>
    <p>这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/security">安全设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/proxy-settings">代理设置</a> 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。</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>基于代理的防火墙的名称或 IP 地址。</td>
        </tr>
        <tr>
          <td><strong>代理端口</strong></td>
          <td>基于代理的防火墙的 TCP 端口。</td>
        </tr>
        <tr>
          <td><strong>代理用户</strong></td>
          <td>用于通过基于代理的防火墙进行身份验证的用户名。</td>
        </tr>
        <tr>
          <td><strong>代理密码</strong></td>
          <td>用于对基于代理的防火墙进行身份验证的密码。</td>
        </tr>
        <tr>
          <td><strong>身份验证方案</strong></td>
          <td>保留默认值 <strong>None</strong> 或选择以下身份验证方案之一：<strong>Basic</strong>、<strong>Digest</strong>、<strong>Proprietary</strong> 或 <strong>NTLM</strong>。</td>
        </tr>
      </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 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 = "知行之桥";

Google Storage 端口从 Google Storage 云存储服务中上传和下载文件。

## 核心功能

* Google Cloud Storage 集成，支持 OAuth 身份验证及令牌（Token）自动刷新
* 基于存储桶（Bucket）的文件组织，支持双向文件传输
* 支持 Glob 模式匹配过滤，并提供下载后可选删除文件及覆盖保护功能
* 提供可选的缓存功能，确保仅下载新增或更新的文件

## 概述

每个 Google Storage 端口与一个特定的 Google Storage 账号连接。在远程存储中，存储桶被设置为上传和／或下载目标。可以在存储桶中指定上传和下载路径，并且过滤规则只用于发送和接收指定的文件名和／或文件扩展名。

{siteNameShort} 工作流中到达 Google Storage 端口的文件将被上传至上传目标文件夹，在下载目标文件夹下的文件会被下载并进入 {siteNameShort} 工作流。

账号认证基于 OAuth，因此使用 Google Storage 端口连接之前必须先获取 OAuth 认证。一旦与 Google 的认证完成，Google Storage 端口会处理刷新 OAuth 令牌的过程，以确保身份验证会一直持续。

## 端口配置

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

### 设置

#### 授权

*与授权访问远程存储有关的设置。*

| 设置         | 描述                                                      |
| ---------- | ------------------------------------------------------- |
| **端口 ID**  | 端口的静态唯一标识符。                                             |
| **端口类型**   | 显示端口名称及其功能描述。                                           |
| **端口描述**   | 可选字段，用于对端口及其在工作流中的角色进行自由格式描述。                           |
| **客户端 ID** | 目标存储账号的客户端 ID 认证，由 Google 提供。该值应直接通过 Google Console 获得。 |
| **客户端密码**  | 目标存储账号的客户端密码认证，由 Google 提供。该值应直接通过 Google Console 获得。   |

<Note>Google 在生成 OAuth 认证时可能需要 OAuth 回调／重定向 URL。{siteNameShort} 的回调／重定向 URL 与应用程序托管处的地址和端口相同，加下面的源路径：`src/oauthCallback.rst`。例如，如果 {siteNameShort} 托管在 'mydomain.com' 的 8001 端口，应指定下面的 URL 为回调／重定向 URL：`http://mydomain.com:8001/src/oauthCallback.rst`。</Note>

#### 服务器配置

*与目标存储服务器相关的设置。*

| 设置      | 描述                               |
| ------- | -------------------------------- |
| **桶名称** | Google Storage 中用于上传和／或下载文件的存储桶。 |

#### 发送

*与上传文件到远程存储服务有关的设置。*

| 设置        | 描述                      |
| --------- | ----------------------- |
| **远程文件夹** | 端口处理过的文件将被上传到此处指定的文件夹。  |
| **覆盖**    | 是否应该覆盖或跳过已存在于远程文件夹中的文件。 |

#### 接收

*与从远程存储中下载文件有关的设置。*

| 设置        | 描述                           |
| --------- | ---------------------------- |
| **远程文件夹** | 端口从该远程文件夹下载文件。多个文件夹可以使用逗号分隔。 |
| **删除**    | 是否要从远程存储上删除已成功下载的文件。         |

#### 缓存

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

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

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

### 高级设置

#### 高级设置

*先前目录中没有包含的设置。*

| 设置           | 描述                                                                                                                                                                                                  |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **递归**       | 是否下载远程目标路径子文件夹下的文件。                                                                                                                                                                                 |
| **使用虚拟主机**   | 默认情况下（*自动*），端口会根据存储桶名称尝试确定使用哪种请求方式。设置为 *True* 可强制使用托管样式的请求引用存储桶：`http://yourbucket.storage.googleapis.com/yourobject`。设置为 *False* 可使用路径样式的请求：`http://storage.googleapis.com/yourbucket/yourobject`。 |
| **超时时间**     | 端口在抛出超时错误之前等待连接响应的持续时间。                                                                                                                                                                             |
| **接收过滤规则**   | 全局模式过滤规则，用来确定从远程存储下载哪些文件（例如 \*.txt）。负模式用来确定 *不* 下载哪些文件（例如 -\*.tmp）。多模式可以使用逗号分隔，除非文件名完全匹配，否则优先使用后面的过滤规则。                                                                                             |
| **本地文件命名方案** | 为端口输出消息分配文件名的方案。可以在文件名中使用宏来动态包含标识符和时间戳等信息。更多信息，请参阅[宏](#宏)。                                                                                                                                          |
| **处理延迟**     | 放置在 **交易** 选项卡中的文件处理延迟的时间量（以秒为单位）。这是一个旧版设置。最佳实践是[使用文件端口](../flows/designing-a-flow#interacting-with-the-local-file-system)来管理本地文件系统，而不是此设置。                                                         |

#### 代理配置

<CommonProxySettings />

#### 消息

<Message />

#### 日志

<Logging />

#### 杂项

<MiscConnector />

### 自动化

#### 自动化设置

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

| 设置           | 描述                                                                         |
| ------------ | -------------------------------------------------------------------------- |
| **发送**       | 到达端口的文件是否会被自动上传。                                                           |
| **重试间隔**     | 上传失败后进行重试之前的时间间隔。                                                          |
| **最大重试次数**   | 端口处理输入文件的最大次数。是否成功基于服务器确认。如果设置为 0，端口将无限次重试该文件。                             |
| **下载**       | 端口是否应自动轮询要下载文件的远程下载路径。                                                     |
| **间隔**       | 自动下载尝试之间的间隔。                                                               |
| **小时偏移分钟数**  | 每小时计划的分钟偏移量。仅当上方间隔设置为 *每小时* 时适用。例如，如果此值设置为 5，自动化服务将在 1:05、2:05、3:05 等时间下载。 |
| **时间**       | 尝试发生的时间。仅当上方间隔设置为 *每天*、*每周* 或 *每月* 时适用。                                    |
| **日期**       | 尝试发生的日期。仅当上方间隔设置为 *每周* 或 *每月* 时适用。                                         |
| **分钟**       | 尝试下载前等待的分钟数。仅当上方间隔设置为 *分钟* 时适用。                                            |
| **Cron 表达式** | 一个五位字符串，表示决定尝试时间的 Cron 表达式。仅当上方间隔设置为 *高级* 时适用。                             |

#### 性能

<Performance />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 建立连接

Google Storage 需要 OAuth 认证以建立连接。OAuth 认证应该通过 Google Console 从 Google 直接获取，然后在[设置](#设置)选项卡上的以下端口字段中指定：

* OAuth 客户端 ID
* OAuth 客户端密码

Google 在生成 OAuth 认证时可能需要 OAuth 回调／重定向 URL。{siteNameShort} 的回调／重定向 URL 与应用程序托管处的地址和端口相同，加下面的源路径：`src/oauthCallback.rst`。例如，如果 {siteNameShort} 托管在 'mydomain.com' 的 8001 端口，应指定下面的 URL 为回调／重定向 URL：`http://mydomain.com:8001/src/oauthCallback.rst`。

一旦与 Google 的认证完成，Google Storage 端口会处理刷新 OAuth 令牌的过程，以确保身份验证会一直持续。

## 上传和下载

### 上传

要上传文件，将[服务器配置](#服务器配置)部分的 **桶名称** 字段设置为目标存储桶，然后将[发送](#发送)部分的 **远程文件夹** 字段设置为文件应被上传的文件夹。每个 Google Storage 端口上传到一个特定的文件夹位置。

使用 **覆盖远程文件** 选项，可以确定是覆盖还是跳过远程文件夹中已存在的文件。

配置之后，放置在端口 **事务** 选项卡中的文件将会被上传至远程存储。如果 **发送自动化** 启用，上传将会自动进行；否则，可以通过 **事务** 选项卡发送单个文件。

### 下载

要下载文件，将[接收](#接收)部分的 **远程文件夹** 字段设置为下载文件的文件夹。多个下载文件夹可以使用逗号分隔。

可以将[高级设置](#高级设置)选项卡上的 **接收过滤规则** 字段设置为全局过滤规则，以指定应从远程存储下载哪些文件（例如 \*.txt）。可以使用负模式来确定 *不* 下载哪些文件（例如 -\*.tmp）。使用逗号分隔列表指定多个过滤规则。

使用 **删除** 选项用于切换是否从远程存储中删除成功下载的文件。

配置之后，将会根据 **接收**[自动化设置](#自动化设置)的设置下载文件，或者在 **事务** 选项卡中通过点击 **接收** 按钮手动下载。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />