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

# Shopify 端口设置

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

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

## 核心功能

* 集成电子商务平台，支持 OAuth 和访问令牌（Access Token）身份验证
* 基于店铺 URL 的连接性，支持访问产品、订单、客户和库存数据
* 支持标准数据库操作（Select、Lookup、Upsert 和存储过程）进行数据操作

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

## 建立连接

若要允许知行之桥使用 Shopify 中的数据，必须先建立到 Shopify 的连接。建立此连接有两种方式：

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

<Note>
  - 仅在首次创建连接时需要登录过程。
  - 到 Shopify 的连接可以在多个 Shopify 端口之间重复使用。
</Note>

### 输入连接设置

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

1. 提供所需信息：

   * **Name** — 连接的静态名称。
   * **Type** — 始终设置为 Shopify。
   * **Auth Scheme** — 从列表中选择身份验证方案。选项为 **OAuth** 或 **Access Token**。
   * **Shop URL** — Shopify 商店的完整 URL。
   * **OAuth Client Id** — 账户的客户端 ID（仅 OAuth 身份验证）。
   * **OAuth Client Secret** — 账户的客户端密钥（仅 OAuth 身份验证）。
   * **Access Token** — 用于建立连接的访问令牌（仅 Access Token 身份验证）。

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

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

4. 单击**添加连接**以完成连接。

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

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

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

## 选择操作

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

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

## 高级选项卡

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

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

### 消息

| 设置               | 说明                                                                                                                                        |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| **保存到 Sent 文件夹** | 勾选此项可将端口处理的文件复制到该端口的 Sent 文件夹。                                                                                                            |
| **Sent 文件夹方案**   | 指示端口按所选间隔对 Sent 文件夹中的消息分组。例如，**Weekly** 选项会指示端口每周创建一个新子文件夹，并将该周的所有消息存储在该文件夹中。留空则表示端口将所有消息直接保存到 Sent 文件夹。对于处理大量消息的端口，使用子文件夹有助于保持消息有序并提升性能。 |

### 高级设置

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

| 设置                 | 说明                                                                                                                                                                                                                                                                                                                                                      |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **自动截断**           | 启用后，端口会自动截断超过允许限制的任何字符串或二进制列值。                                                                                                                                                                                                                                                                                                                          |
| **命令超时**           | 命令执行超时时长（秒）。                                                                                                                                                                                                                                                                                                                                            |
| **最后插入 ID 查询**     | 提供要执行的查询，用于检索最后插入记录的自增 ID。                                                                                                                                                                                                                                                                                                                              |
| **日志级别**           | 端口生成日志的详细程度。请求支持时，请将其设置为 **Debug**。                                                                                                                                                                                                                                                                                                                     |
| **本地文件方案**         | 为端口输出的消息分配文件名的方案。可以在文件名中使用宏，动态包含标识符和时间戳等信息。有关更多信息，请参见[宏](#宏)。                                                                                                                                                                                                                                                                                           |
| **日志消息**           | 勾选后，端口会在 Logs 目录中将消息副本与该消息的日志保存在一起。如果禁用此项，可能无法从**输入**或**输出**选项卡下载文件副本。                                                                                                                                                                                                                                                                                  |
| **最大失败记录数**        | 插入期间允许失败且仍继续处理的最大记录数。默认值 0 表示任何错误都会导致输入消息标记为 Error，并回滚所有未提交事务。值 -1 表示忽略所有错误，端口继续尝试插入后续记录。正值表示端口会继续尝试插入记录，直到达到该阈值。                                                                                                                                                                                                                                       |
| **输出文件格式**         | 输出数据的表示格式。默认值（XML）会使端口为每条处理记录输出一个 XML 文件，也可以根据**最大记录数**的值将多条记录组合到单个数据结构中。CSV 和 TSV 选项会以各自的文件格式输出数据。对于包含子表的复杂表结构，此选项不可用。                                                                                                                                                                                                                                 |
| **处理更改间隔单位**       | 仅适用于 Select 操作。当在**设置**选项卡中 **Select 配置**部分的**高级**区域勾选**使用列 *columnname* 处理新的或更改的记录**时，此项控制如何解释**处理更改间隔**设置（例如小时、天或周）。有关此设置和以下两个设置的详细信息，请参见[只处理新的或更改的记录](./shopify-ac#only-process-new-or-changed-records)。                                                                                                                                             |
| **处理更改间隔**         | 当在**设置**选项卡的 **Select 配置**部分勾选**使用列 *columnname* 处理新的或更改的记录**时，此项控制知行之桥首次尝试处理多少历史数据。例如，保留默认值 180（天）表示知行之桥仅尝试处理最近 180 天内创建或修改的数据。                                                                                                                                                                                                                        |
| **处理更改开始日期**       | 当在**设置**选项卡的 **Select 配置**部分勾选**使用列 *columnname* 处理新的或更改的记录**时，此项控制要检索数据的开始日期。                                                                                                                                                                                                                                                                          |
| **重置历史记录**         | 重置勾选**使用列 *columnname* 处理新的或更改的记录**时存储的缓存。                                                                                                                                                                                                                                                                                                              |
| **批处理输入大小**        | 如果数据源支持批处理，则为一个批次中的最大查询数。                                                                                                                                                                                                                                                                                                                               |
| **批处理大小**          | 一个批处理组中的最大批处理消息数。                                                                                                                                                                                                                                                                                                                                       |
| **最大记录数**          | 单个输出消息中包含的最大记录数。使用 -1 表示所有输出记录都应放入单个文件，使用 0 表示端口可根据配置的**输出文件格式**自行决定。默认情况下，XML 每个文件输出一条记录，平面文件格式会将所有记录包含在一个文件中。                                                                                                                                                                                                                                         |
| **事务大小**           | 一个事务中的最大查询数。                                                                                                                                                                                                                                                                                                                                            |
| **处理延迟**           | 放入 Input 文件夹的文件延迟处理的时长（秒）。这是一个旧版设置。最佳实践是[使用 File 端口](/26.2/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`）。正常的端口用例和功能不应需要使用这些设置。 |

## 自动化选项卡

### 自动化设置

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

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

### 性能

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

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

## 告警选项卡

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

在执行服务级别协议（SLA）之前，需要设置电子邮件告警通知。默认情况下，知行之桥使用[告警](/26.2/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="空 SLA 配置" width="1514" height="1730" data-path="public/images/sla_empty.png" />

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

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

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

<Note>
  如有必要，可以关闭 SLA 告警。这在维护窗口期间很有用。单击导航栏上的**设置**，然后导航到**告警 > 常规告警**。单击平板和铅笔图标进行编辑，并取消勾选 **SLA Alerts** 设置。
</Note>

## 宏

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

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

| 宏                       | 说明                                                                                                                                         |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| ConnectorID             | 计算为端口的 ConnectorID。                                                                                                                        |
| Ext                     | 计算为端口当前正在处理文件的文件扩展名。                                                                                                                       |
| Filename                | 计算为端口当前正在处理文件的文件名（包含扩展名）。                                                                                                                  |
| FilenameNoExt           | 计算为端口当前正在处理文件的文件名（不包含扩展名）。                                                                                                                 |
| MessageId               | 计算为端口输出消息的 MessageId。                                                                                                                      |
| RegexFilename:*pattern* | 对端口当前正在处理文件的文件名应用 RegEx 模式。                                                                                                                |
| Header:*headername*     | 计算为端口当前正在处理消息上目标消息头（`headername`）的值。                                                                                                       |
| LongDate                | 计算为系统当前日期时间的长格式（例如 Wednesday, January 24, 2024）。                                                                                           |
| ShortDate               | 计算为系统当前日期时间的 yyyy-MM-dd 格式（例如 2024-01-24）。                                                                                                 |
| DateFormat:*format*     | 计算为按指定格式（`format`）表示的系统当前日期时间。有关可用日期时间格式，请参见[示例日期格式](/26.2/self-hosted/zh/scripting/date-formatters#date-formats-with-literal-characters)。 |
| Vault:*vaultitem*       | 计算为指定保管库项的值。                                                                                                                               |
| Table                   | 计算为端口从中选择数据的表名。                                                                                                                            |
| PK                      | 计算为从表中接收记录的主键值。                                                                                                                            |
| Sequence                | 根据接收的总记录数计算为四位数字。                                                                                                                          |
| FileFormat              | 计算为输出文件格式（XML、CSV 或 TSV）。                                                                                                                  |

### 示例

某些宏（例如 %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.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault)中某项的名称。例如，`%Vault:companyname%` 解析为保管库中存储的 `companyname` 项的值。
* %DateFormat:format%：其中 `format` 是可接受的日期格式（详情请参见[示例日期格式](/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%`