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

# WooCommerce 端口配置

> 将知行之桥连接至 WooCommerce 以进行数据集成与同步

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

## 核心功能

* 集成 WordPress 电子商务平台，用于在线商店数据管理
* 支持标准数据库操作（Select、Lookup、Upsert 和存储过程）进行数据操作

请按照以下步骤将知行之桥连接至 WooCommerce。

## 建立连接

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

* 将 WooCommerce 端口添加到您的流中。然后在设置面板中，点击"连接"下拉列表旁边的**创建**按钮。
* 打开知行之桥**系统设置**页面，然后打开**连接**选项卡。点击**添加**，选择 **WooCommerce**，然后点击**下一步**。

> [!NOTE]
>
> * 登录过程仅在首次创建连接时需要。
> * 与 WooCommerce 的连接可在多个 WooCommerce 端口中复用。

### 输入连接配置

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

1. 输入连接信息：

   * **名称** — 连接的静态名称，可自行设定。
   * **类型** — 始终设置为 WooCommerce。
   * **身份验证方案** — 用于连接的身份验证方案。选项为 **Basic**、**OAuth 1.0 One Legged** 或 **OAuth 2.0**。

2. 根据所选身份验证方案输入连接信息：

   * [Basic 认证](#basic-认证)
   * [OAuth 1.0 One Legged](#oauth-10-one-legged)
   * [OAuth 2.0](#oauth-20)

### Basic 认证

1. 在 **URL** 中，提供要连接的 WooCommerce 实例的基本 URL。

2. 在 **User** 中，输入用于登录的用户名。

3. 在 **密码** 中，输入该用户的密码。

4. 继续[完成连接](#完成连接)。

### OAuth 1.0 One Legged

1. 在 **URL** 中，提供要连接的 WooCommerce 实例的基本 URL。

2. 打开 WooCommerce **配置**页面。

3. 打开**高级设置**选项卡。

4. 在 **REST API** 部分，点击 **Add key**。

5. 提供所需信息，然后点击 **Generate API Key**。

6. 从 WooCommerce 中复制 **Consumer key** 和 **Consumer secret** 的值，并将其输入到知行之桥连接中。

7. 继续[完成连接](#完成连接)。

### OAuth 2.0

首先，按照以下步骤为您的 WordPress 服务器配置 OAuth 2.0：

1. 下载 [OAuth 2.0 Server 插件](https://wordpress.org/plugins/oauth2-provider/)。

2. 解压插件存档，并将 `oauth2-provider` 文件夹复制到 `wp-content\plugins` 文件夹中。

3. 在 WordPress 管理界面中激活该插件。

然后，打开 WordPress 管理界面并按照以下步骤操作：

1. 打开 **OAuth Server** 页面。

2. 点击 **Add New Client**。

3. 提供所需信息，然后点击 **Create Client**。

4. 将 **Client Key** 的值复制到知行之桥的 **OAuth Client Id** 中。

5. 将 **Client Secret** 的值复制到知行之桥的 **OAuth Client Secret** 中。

6. 在知行之桥的 **URL** 中，提供要连接的 WooCommerce 实例的基本 URL。

7. 继续[完成连接](#完成连接)。

### 完成连接

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

2. 点击**测试连接**，确认知行之桥可以使用所提供的信息连接到 WooCommerce。如果出现错误，请检查所有字段并重试。

3. 点击**添加连接**以完成连接的创建。

4. 在端口配置面板的**连接**下拉列表中，选择刚创建的连接。

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

## 选择操作

建立与 WooCommerce 的连接后，您需要选择 WooCommerce 端口将执行的操作。下表概述了每种操作及其在工作流中的位置。

| 操作 | 描述 | 在流中的位置 |
| - | - | - |
| [Upsert](https://docs.kasoftware.com/26.2/self-hosted/zh/connectors/woocommerce/woocommerce-upsert.md) | 将数据插入或更新到 WooCommerce 中。默认情况下，如果 WooCommerce 中已存在记录，则使用输入中提供的值对现有数据执行更新。 | 末端 |
| [Lookup](https://docs.kasoftware.com/26.2/self-hosted/zh/connectors/woocommerce/woocommerce-lookup.md) | 从 WooCommerce 中检索值，并将这些值插入到流中已存在的知行之桥消息中。 **查找查询**决定端口将从 WooCommerce 中检索什么值，应格式化为针对 WooCommerce 表的 SQL 查询。 | 中间 |
| [Lookup 存储过程](https://docs.kasoftware.com/26.2/self-hosted/zh/connectors/woocommerce/woocommerce-lsp.md) | 将进入端口的数据视为存储过程的输入，然后将结果插入到流中已存在的知行之桥消息中。 可以在**测试查找**模态框中点击**显示示例数据**按钮，向所选存储过程提供示例输入并预览结果。 | 中间 |
| [Select](https://docs.kasoftware.com/26.2/self-hosted/zh/connectors/woocommerce/woocommerce-select.md) | 从 WooCommerce 中检索数据并将其引入知行之桥。 可以使用**筛选器**面板向 Select 添加筛选条件，这些筛选条件类似于 SQL 中的 *WHERE* 子句。 | 开始 |
| [执行存储过程](https://docs.kasoftware.com/26.2/self-hosted/zh/connectors/woocommerce/woocommerce-esp.md) | 将进入端口的数据视为存储过程的输入，然后将结果传递到下游。 可以在**测试执行存储过程**模态框中点击**显示示例数据**按钮，向所选存储过程提供示例输入并预览结果。 | 中间 |

## 高级设置选项卡

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

以下选项对所有数据源均可用。

### 消息

| 设置 | 描述 |
| - | - |
| **保存至 Sent 文件夹** | 选中此项可将端口处理的文件副本保存到端口的"已发送"文件夹中。 |
| **Sent 文件夹方案** | 指示端口按所选时间间隔对"已发送"文件夹中的消息进行分组。例如，**每周**选项指示端口每周创建一个新子文件夹，并将该周的所有消息存储在该文件夹中。空白设置指示端口将所有消息直接保存在"已发送"文件夹中。对于处理大量消息的端口，使用子文件夹有助于保持消息有序并提升性能。 |

### 高级设置

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

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

### 其他

\_其他设置\_适用于特定使用场景。

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

## 自动化选项卡

### 自动化设置

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

| 设置 | 描述 |
| - | - |
| **发送** | 到达端口的文件是否会被自动发送。 |
| **重试间隔** | 发送失败后重试之前的等待分钟数。 |
| **最大尝试次数** | 端口处理文件的最大次数。是否成功基于服务器的成功确认。如果设置为 0，则端口将无限次重试。 |
| **接收** | 端口是否应自动查询数据源。 |
| **间隔** | 自动查询尝试之间的间隔。 |
| **整点后分钟数** | 小时计划的分钟偏移量。仅当上方间隔设置为\_每小时\_时适用。例如，如果此值设置为 5，则自动化服务在 1:05、2:05、3:05 等时下载。 |
| **时间** | 尝试应发生的时间。仅当上方间隔设置为\_每日\_、\_每周\_或\_每月\_时适用。 |
| **日期** | 尝试应发生的日期。仅当上方间隔设置为\_每周\_或\_每月\_时适用。 |
| **分钟** | 尝试下载前等待的分钟数。仅当上方间隔设置为\_分钟\_时适用。 |
| **Cron 表达式** | 确定尝试发生时间的五位 cron 表达式字符串。仅当上方间隔设置为\_高级\_时适用。 |

### 性能

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

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

## 告警选项卡

*与配置告警相关的设置。*

在执行服务级别协议（SLA）之前，您需要设置电子邮件告警以接收通知。默认情况下，知行之桥使用[告警](https://docs.kasoftware.com/26.2/self-hosted/zh/getting-started/administration/settings/alerts.md)选项卡上的全局设置。要为此端口使用其他设置，请打开**覆盖全局设置**开关。

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

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

## SLA 选项卡

*与配置服务级别协议（SLA）相关的设置。*

SLA 允许您配置流中端口预期发送或接收的数量，以及您期望在多少时间内达到该数量。知行之桥会在 SLA 未达到时发送电子邮件警告用户，并将 SLA 标记为\_风险中\_，这意味着如果 SLA 很快未达到，它将被标记为\_违反\_。这给用户机会介入并确定 SLA 未达到的原因，并采取适当行动。如果在风险期结束时 SLA 仍未达到，则 SLA 将被标记为违反，并再次通知用户。

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

![空 SLA 配置](https://mintcdn.com/qiao/-jYFWMm20-sP0gQr/26.2/images/sla_empty.png?fit=max\&auto=format\&n=-jYFWMm20-sP0gQr\&q=85\&s=bb610de5fc6ab03b11763b214b31a474)

* 如果您的端口有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
* 在**至少期望**部分：
  * 设置您期望处理的最小事务数量（数量）
  * 使用**每**字段指定时间范围
  * 指定 SLA 应何时生效。如果您选择**从...开始**，请填写日期和时间字段。
  * 勾选您希望 SLA 生效的星期几。如有必要，使用下拉列表选择**每天**。
* 在\*\*将状态设置为"风险中"\*\*部分，指定何时将 SLA 标记为风险中。
  * 默认情况下，在 SLA 违反之前不发送通知。要更改此设置，请勾选**发送"风险中"通知**。

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

![SLA 配置示例](https://mintcdn.com/qiao/-jYFWMm20-sP0gQr/26.2/images/sla_defined.png?fit=max\&auto=format\&n=-jYFWMm20-sP0gQr\&q=85\&s=ba5ca24e6f31a35b1a2d66dc14fb9d6d)

> [!NOTE]
>
> 如有必要，您可以关闭 SLA 告警，这在维护窗口期间很有用。点击导航栏上的**设置**，然后导航到**告警 > 通用告警**。点击平板和铅笔图标进行编辑，并取消勾选 **SLA 告警**设置。

## 宏

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

知行之桥支持以下宏，所有宏均使用以下语法：`%Macro%`。

| 宏 | 描述 |
| - | - |
| ConnectorID | 评估为端口的 ConnectorID。 |
| Ext | 评估为端口当前正在处理的文件的扩展名。 |
| Filename | 评估为端口当前正在处理的文件的文件名（含扩展名）。 |
| FilenameNoExt | 评估为端口当前正在处理的文件的文件名（不含扩展名）。 |
| MessageId | 评估为端口输出的消息的 MessageId。 |
| RegexFilename:*pattern* | 对端口当前正在处理的文件的文件名应用正则表达式模式。 |
| Header:*headername* | 评估为端口当前正在处理的消息上目标标头（`headername`）的值。 |
| LongDate | 评估为系统当前日期时间的完整格式（例如 Wednesday, January 24, 2024）。 |
| ShortDate | 评估为系统当前日期时间的 yyyy-MM-dd 格式（例如 2024-01-24）。 |
| DateFormat:*format* | 评估为系统当前日期时间的指定格式（`format`）。有关可用的日期时间格式，请参阅[示例日期格式](https://docs.kasoftware.com/26.2/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` 是[保管库](https://docs.kasoftware.com/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md)中某项的名称。例如，`%Vault:companyname%` 解析为保管库中存储的 `companyname` 项的值。
* %DateFormat:format%：其中 `format` 是接受的日期格式（详见[示例日期格式](https://docs.kasoftware.com/26.2/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%`


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