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

# BigCommerce 端口配置

> 将知行之桥连接到 BigCommerce 以进行数据集成和同步

BigCommerce 端口允许通过向 BigCommerce 推送数据或从 BigCommerce 拉取数据，将 BigCommerce 集成到数据流中。

## 核心功能

* 具有特定商店访问控制功能的电子商务平台集成
* 用于安全 API 连接的访问令牌身份验证
* 用于数据操作的标准数据库端口操作（Select、Lookup、Upsert 和存储过程）

按照以下步骤将知行之桥连接到 BigCommerce。

## 建立连接

要允许知行之桥使用 BigCommerce 中的数据，必须先建立与 BigCommerce 的连接。可以通过两种方式建立此连接：

* 将 BigCommerce 端口添加到流程中。然后在**设置**选项卡中，点击 Connection 下拉列表旁边的**创建**。
* 打开知行之桥**设置**页面，然后打开**连接**选项卡。点击**添加**，选择 **BigCommerce**，然后点击**下一步**。

<Note>
  - 只有首次创建连接时才需要登录过程。
  - BigCommerce 连接可在多个 BigCommerce 端口之间重复使用。
</Note>

### 输入连接设置

打开新连接对话框后，请按照以下步骤操作：

1. 提供所需信息：

   * **名称** — 连接的静态名称。
   * **类型** — 始终设置为 BigCommerce。
   * **Store ID** — BigCommerce 账户的商店哈希。
   * **Access Token** — 用于建立连接的访问令牌。

2. 可选地，点击**高级**打开高级连接设置下拉菜单。大多数情况下不需要这些设置。

3. 点击**测试连接**，确保知行之桥可以使用提供的信息连接到 BigCommerce。如果发生错误，请检查所有字段并重试。

4. 点击**添加连接**完成连接。

5. 在端口配置窗格的 **Connection** 下拉列表中，选择新创建的连接。

6. 点击**保存更改**。

<Note>
  **高级**选项卡上还有特定于数据源的身份验证和配置选项。本文档并未全部描述这些选项，但可以在我们网站的[在线帮助文件](https://www.kasoftware.com/articles.html)页面找到数据源的详细信息。
</Note>

## 选择一个操作

与 BigCommerce 建立连接后，必须选择 BigCommerce 端口将执行的操作。下表概述了每个操作及其在知行之桥工作流中的位置。

| 操作                               | 描述                                                                                                                 | 工作流中位置 |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------ |
| [Upsert](./bigcommerce-upsert)   | 插入或更新 BigCommerce 数据。默认情况下，如果 BigCommerce 中已存在记录，则使用输入提供的值更新 BigCommerce 中的现有数据。                                   | 终点     |
| [Lookup](./bigcommerce-lookup)   | 从 BigCommerce 检索值，并将这些值插入流程中已存在的知行之桥消息。<br />**Lookup 查询**确定端口将从 BigCommerce 检索什么值。它应格式化为针对 BigCommerce 表的 SQL 查询。 | 中间     |
| [Lookup 存储过程](./bigcommerce-lsp) | 将进入端口的数据视为存储过程输入，然后将结果插入流程中的现有知行之桥消息。<br />可以在**测试 Lookup** 模态框中点击**显示示例数据**按钮，为所选存储过程提供示例输入并预览结果。                 | 中间     |
| [Select](./bigcommerce-select)   | 从 BigCommerce 检索数据并将其带入知行之桥。<br />可以使用**过滤器**面板向 Select 添加过滤器。这些过滤器的功能类似于 SQL 中的 *WHERE* 子句。                       | 起点     |
| [执行存储过程](./bigcommerce-esp)      | 将进入端口的数据视为存储过程输入，然后将结果传递到流程下游。<br />可以在**测试执行存储过程**模态框中点击**显示示例数据**按钮，为所选存储过程提供示例输入并预览结果。                          | 中间     |

## 高级页面 (Advanced Tab)

**高级**选项卡上的许多设置都是从正在使用的数据源动态加载的，因此本文档中未介绍这些设置。可以在我们网站的[在线帮助文件](https://www.kasoftware.com/articles.html)页面找到数据源的详细信息。

下面描述的选项适用于所有数据源。

### 消息

<Note>
  **保存至 Sent 文件夹**和**Sent 文件夹方案**设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到[File 端口](../file)。
</Note>

| 设置                    | 描述                                                  |
| --------------------- | --------------------------------------------------- |
| **保存至 Sent 文件夹**（已弃用） | 将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受静态加密保护。 |
| **Sent 文件夹方案**（已弃用）   | 按所选时间间隔对 Sent 文件夹中的文件进行分组。仅在启用**保存至 Sent 文件夹**时适用。  |

### 高级设置

*高级设置* 是依赖任意数据库驱动程序（例如 Database、CData 和 API 端口）连接到各种数据源的端口的通用设置。

| 设置                 | 描述                                                                                                                                                                                                                                                                                                                                                      |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **自动截断**           | 启用后，端口会自动截断任何超过允许限制的字符串或二进制列值。                                                                                                                                                                                                                                                                                                                          |
| **命令超时时间**         | 命令执行超时时长（以秒为单位）。                                                                                                                                                                                                                                                                                                                                        |
| **上次插入的 ID 查询**    | 提供要执行的查询，以检索上次插入记录的自动递增 ID。                                                                                                                                                                                                                                                                                                                             |
| **日志级别**           | 端口生成的日志详细程度。请求支持时，请将其设置为 **Debug**。                                                                                                                                                                                                                                                                                                                     |
| **本地文件方案**         | 为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符和时间戳等信息。有关更多信息，请参阅[宏](#宏)。                                                                                                                                                                                                                                                                                          |
| **日志消息**           | 勾选后，端口会在 Logs 目录中将消息副本保存在该消息日志旁边。如果禁用此项，可能无法从**输入**或**输出**选项卡下载文件副本。                                                                                                                                                                                                                                                                                    |
| **最大失败记录数**        | 插入期间允许失败以继续处理的最大记录数。默认值 0 表示任何错误都会导致输入消息被标记为错误，并回滚任何未提交事务。值 -1 表示忽略所有错误，端口继续尝试插入后续记录。正值表示端口继续尝试插入记录，直到达到阈值。                                                                                                                                                                                                                                             |
| **输出文件格式**         | 输出数据的表示格式。默认值 (XML) 会使端口为处理的每条记录输出一个 XML 文件，同时可选择将多条记录组合成单个数据结构（取决于**最大记录数**的值）。CSV 和 TSV 选项会以各自文件格式输出数据。此选项不适用于包含子表的复杂表结构。                                                                                                                                                                                                                             |
| **处理更改间隔单位**       | 仅适用于 Select 操作。当在**设置**选项卡的 **Select 配置**部分的**高级**部分选中**使用列 *columnname* 处理新的或更改的记录**时，此项控制如何解释**处理更改间隔**设置（例如小时、天或周）。有关此设置和以下两个设置的详细信息，请参阅[只处理新的或更改的记录](./bigcommerce-ac#只处理新的或更改的记录)。                                                                                                                                                                 |
| **处理更改间隔**         | 当在**设置**选项卡的 **Select 配置**部分选中**使用列 *columnname* 处理新的或更改的记录**时，此项控制知行之桥首次尝试处理多少历史数据。例如，保留默认值 180（天）表示知行之桥仅尝试处理最近 180 天内创建或修改的数据。                                                                                                                                                                                                                        |
| **处理更改开始日期**       | 当在**设置**选项卡的 **Select 配置**部分选中**使用列 *columnname* 处理新的或更改的记录**时，此项控制要检索数据的开始日期。                                                                                                                                                                                                                                                                          |
| **重置历史记录**         | 重置选中**使用列 *columnname* 处理新的或更改的记录**时存储的缓存。                                                                                                                                                                                                                                                                                                              |
| **批处理输入大小**        | 如果数据源支持批处理，则为批处理中查询的最大数量。                                                                                                                                                                                                                                                                                                                               |
| **批处理大小**          | 批次组中批次消息的最大数量。                                                                                                                                                                                                                                                                                                                                          |
| **最大记录数**          | 单个输出消息中包含的最大记录数。使用 -1 表示所有输出记录应放入单个文件，使用 0 表示端口可以根据配置的**输出文件格式**决定。默认情况下，XML 每个文件输出一条记录，平面文件格式则在一个文件中包含所有记录。                                                                                                                                                                                                                                            |
| **事务大小**           | 事务中的最大查询数。                                                                                                                                                                                                                                                                                                                                              |
| **处理延迟**           | 对放置在输入文件夹中的文件延迟处理的时间（以秒为单位）。这是旧版设置。最佳实践是[使用 File 端口](/26.3/self-hosted/zh/flows/designing-a-flow#interacting-with-the-local-file-system)管理本地文件系统，而不是使用此设置。                                                                                                                                                                                              |
| **插入空值**           | 未选中（默认）时，端口在构建 INSERT 和 UPDATE 语句时会跳过空 XML 元素。这会导致数据库对 INSERT 语句使用默认列值，并使 UPDATE 语句的列值保持不变。选中后，端口会在 INSERT 和 UPDATE 语句中包含空 XML 元素，并使用空字符串作为列值。                                                                                                                                                                                                          |
| **插入 Null**        | 未选中（默认）时，端口在构建 INSERT 和 UPDATE 语句时会跳过 null XML 元素（由 `xsi:nil="true"` 属性指示）。这会导致数据库对 INSERT 语句使用默认列值，并使 UPDATE 语句的列值保持不变。选中后，端口会在 INSERT 和 UPDATE 语句中包含 null XML 元素，并使用 null 作为列值。被视为 null 的情况包括：`Not exist`、`<element/>`、`<element xsi:nil="true"/>`、`<element xsi:nil="true"></element>`、`<element null="true"/>` 和 `<element null="true"></element>`。 |
| **Lookup 缓存**      | 勾选**启用 Lookup 缓存**可在直接对数据源执行查询之前先查询本地缓存（当缓存未返回任何记录时）。未选中（默认）时，查询会直接对数据源执行。以下 Lookup 缓存选项仅在选中**启用 Lookup 缓存**时可用。                                                                                                                                                                                                                                        |
| **Lookup 缓存提供程序**  | 指定使用哪个驱动程序来连接缓存数据库。                                                                                                                                                                                                                                                                                                                                     |
| **Lookup 缓存连接字符串** | 设置后，端口使用此处指定的数据库进行缓存。                                                                                                                                                                                                                                                                                                                                   |
| **Lookup 缓存容差**    | 指定端口查询数据源以刷新缓存的频率。与**容差单位**选项结合使用。                                                                                                                                                                                                                                                                                                                      |
| **Lookup 缓存容差单位**  | 选择 **Minute**、**Hour** 或 **Day**。                                                                                                                                                                                                                                                                                                                       |
| **日志子文件夹方案**       | 指示端口根据所选间隔对 `Logs` 文件夹中的文件进行分组。例如，**Weekly** 选项指示端口每周创建一个新子文件夹，并将该周的所有日志存储在该文件夹中。空白设置会使端口直接将所有日志保存在 `Logs` 文件夹中。对于处理大量交易的端口，使用子文件夹有助于保持日志有序并提高性能。                                                                                                                                                                                                       |

### 其他设置

*其他设置* 适用于特定用例。

| 设置       | 描述                                                                           |
| -------- | ---------------------------------------------------------------------------- |
| **其他设置** | 允许以分号分隔列表配置隐藏端口设置（例如 `setting1=value1;setting2=value2`）。正常端口用例和功能不应需要使用这些设置。 |

## 自动化页面 (Automation Tab)

### 自动化设置

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

| 设置           | 描述                                                                           |
| ------------ | ---------------------------------------------------------------------------- |
| **发送**       | 到达端口的文件是否自动发送。                                                               |
| **重试间隔**     | 发送失败后重试前的分钟数。                                                                |
| **最大重试次数**   | 端口处理文件的最大次数。是否成功以服务器成功确认作为衡量标准。如果设置为 0，端口会无限期重试文件。                           |
| **接收**       | 端口是否应自动查询数据源。                                                                |
| **间隔**       | 自动查询尝试之间的间隔。                                                                 |
| **整点后分钟数**   | 小时计划的分钟偏移量。仅在上方间隔设置为 *Hourly* 时适用。例如，如果该值设置为 5，自动化服务将在 1:05、2:05、3:05 等时间下载。 |
| **时间**       | 应执行尝试的一天中的时间。仅在上方间隔设置为 *Daily*、*Weekly* 或 *Monthly* 时适用。                     |
| **日期**       | 应执行尝试的日期。仅在上方间隔设置为 *Weekly* 或 *Monthly* 时适用。                                 |
| **分钟**       | 尝试下载前等待的分钟数。仅在上方间隔设置为 *Minute* 时适用。                                          |
| **Cron 表达式** | 表示 cron 表达式的五段字符串，用于确定何时执行尝试。仅在上方间隔设置为 *Advanced* 时适用。                       |

### 性能

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

| 设置          | 描述                                                                                                                                                                                                                         |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **最大工作线程数** | 此端口处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖[高级设置](/26.3/self-hosted/zh/getting-started/administration/settings/advanced-settings)页面[性能设置](/26.3/self-hosted/zh/getting-started/administration/settings/performance-settings)部分的默认设置。 |
| **最大文件数**   | 分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖[高级设置](/26.3/self-hosted/zh/getting-started/administration/settings/advanced-settings)页面[性能设置](/26.3/self-hosted/zh/getting-started/administration/settings/performance-settings)部分的默认设置。      |

## 通知选项卡

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

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

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

输入**主题**（必填），然后可选地输入以逗号分隔的**收件人**邮箱列表。

## SLA 选项卡

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

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

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

<img src="https://mintcdn.com/qiao/ilnLy7gsSdFqbKmI/public/images/sla_empty.png?fit=max&auto=format&n=ilnLy7gsSdFqbKmI&q=85&s=9cd47a4173ed889fe20ff78de28190be" alt="Empty SLA configuration" width="1514" height="1730" data-path="public/images/sla_empty.png" />

* 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 所属的方向。
* 在窗口的**期待至少**部分：
  * 设置期望处理的最小交易数量（交易量）
  * 使用**每**字段指定时间范围
  * 指定 SLA 何时生效。如果选择**开始于**，请完成日期和时间字段。
  * 勾选希望 SLA 生效的星期几。如有需要，使用下拉菜单选择**每天**。
* 在窗口的\*\*将状态设置为“有风险”\*\*部分，指定何时应将 SLA 标记为存在风险。
  * 默认情况下，在 SLA 违反之前不会发送通知。要更改此设置，请选中**发送“有风险”通知**。

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

<img src="https://mintcdn.com/qiao/ilnLy7gsSdFqbKmI/public/images/sla_defined.png?fit=max&auto=format&n=ilnLy7gsSdFqbKmI&q=85&s=33e5282b3f7970e3e1fef056825d7772" alt="SLA Configuration Example" width="1408" height="1550" data-path="public/images/sla_defined.png" />

<Note>
  如有需要，可以关闭 SLA 警报。这在维护窗口期间非常有用。点击导航栏上的**设置**，然后导航到**通知 > 通用通知**。点击平板和铅笔图标进行编辑，并取消选中 **SLA 警报**设置。
</Note>

## 宏

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

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

| 宏                       | 描述                                                                                                                                        |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| ConnectorID             | 替换为端口的 ConnectorID。                                                                                                                       |
| Ext                     | 替换为端口当前正在处理的文件的文件扩展名。                                                                                                                     |
| Filename                | 替换为端口当前正在处理的文件名（包括扩展名）。                                                                                                                   |
| FilenameNoExt           | 替换为端口当前正在处理的文件名（不带扩展名）。                                                                                                                   |
| MessageId               | 替换为端口输出消息的 MessageId。                                                                                                                     |
| RegexFilename:*pattern* | 将正则表达式模式应用于端口当前正在处理的文件名。                                                                                                                  |
| Header:*headername*     | 替换为端口当前正在处理的消息上目标消息头 (`headername`) 的值。                                                                                                   |
| LongDate                | 以长格式替换为系统当前日期时间（例如，2024 年 1 月 24 日星期三）。                                                                                                   |
| ShortDate               | 以 yyyy-MM-dd 格式替换为系统当前日期时间（例如 2024-01-24）。                                                                                                |
| DateFormat:*format*     | 以指定格式 (`format`) 替换为系统当前日期时间。有关可用日期时间格式，请参阅[示例日期格式](/26.3/self-hosted/zh/scripting/date-formatters#date-formats-with-literal-characters)。 |
| Vault:*vaultitem*       | 替换为指定保管库项目的值。                                                                                                                             |

### 示例

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

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

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

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

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