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

# ShipStation Connector Setup

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

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

## 核心功能

* 集成运输和履约平台，用于电子商务订单管理
* 基于 API 的连接，支持创建货运、物流轨迹查询、标签生成和订单管理
* 支持标准数据库操作（Select、Lookup、Upsert 和存储过程）进行数据操作

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

## 建立连接

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

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

> [!NOTE]
>
> * 只有首次创建连接时才需要登录过程。
> * ShipStation 连接可以在多个 ShipStation 端口之间重复使用。

### 输入连接设置

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

1. 提供所需信息：

   * **名称** — 连接的静态名称。
   * **类型** — 始终设置为 ShipStation。
   * **API Key** — ShipStation 账号的 API Key。
   * **API Secret** — ShipStation 账号的 API Secret。

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

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

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

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

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

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

## 选择操作

建立与 ShipStation 的连接后，你必须选择 ShipStation 端口要执行的操作。下表概述了每个操作及其在工作流程中的位置。

| 操作 | 描述 | 流程中的位置 |
| - | - | - |
| [Lookup](/26.2/self-hosted/zh/connectors/shipstation/shipstation-lookup.md) | 从 ShipStation 检索值，并将这些值插入流程中已有的知行之桥消息。 **Lookup 查询** 决定端口将从 ShipStation 检索什么值。其格式应为针对 ShipStation 表的 SQL 查询。 | 中间 |
| [Lookup 存储过程](/26.2/self-hosted/zh/connectors/shipstation/shipstation-lsp.md) | 将进入端口的数据作为存储过程的输入处理，然后将结果插入流程中已有的知行之桥消息。 你可以在 **测试 Lookup** 模态框中点击 **显示示例数据** 按钮，为所选存储过程提供示例输入并预览结果。 | 中间 |
| [Select](/26.2/self-hosted/zh/connectors/shipstation/shipstation-select.md) | 从 ShipStation 检索数据并将其引入知行之桥。 你可以使用 **过滤器** 面板向 Select 添加过滤器。这些过滤器的功能类似于 SQL 中的 *WHERE* 子句。 | 开始 |
| [执行存储过程](/26.2/self-hosted/zh/connectors/shipstation/shipstation-esp.md) | 将进入端口的数据作为存储过程的输入处理，然后将结果传递到流程下游。 你可以在 **测试执行存储过程** 模态框中点击 **显示示例数据** 按钮，为所选存储过程提供示例输入并预览结果。 | 中间 |
| [创建运输标签](/26.2/self-hosted/zh/connectors/shipstation/shipstation-create-shipment-label.md) | 在 ShipStation 中创建运输标签。 | 结束 |

## 高级选项卡

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

以下选项适用于所有数据源。

### 消息

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

### 高级设置

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

| 设置 | 描述 |
| - | - |
| **自动截断** | 启用后，端口会自动截断任何超过允许限制的字符串或二进制列值。 |
| **命令超时** | 命令执行超时时长（以秒为单位）。 |
| **最后插入 ID 查询** | 提供要执行的查询，用于检索最后插入记录的自增 ID。 |
| **日志级别** | 端口生成日志的详细程度。请求支持时，请将其设置为 **Debug**。 |
| **本地文件方案** | 用于为端口输出的消息分配文件名的方案。你可以在文件名中动态使用宏，以包含标识符和时间戳等信息。更多信息请参阅 [宏](#宏)。 |
| **记录消息** | 选中后，端口会在 Logs 目录中将消息副本保存在该消息的日志旁边。如果禁用此项，你可能无法从 **输入** 或 **输出** 选项卡下载文件副本。 |
| **最大失败记录数** | 插入期间允许失败的最大记录数，以便继续处理。默认值 0 表示任何错误都会导致输入消息被标记为 Error，并回滚任何未提交的事务。值 -1 表示忽略所有错误，端口会继续尝试插入后续记录。正值表示端口会继续尝试插入记录，直到达到阈值。 |
| **输出文件格式** | 输出数据的表示格式。默认值（XML）会使端口为处理的每条记录输出一个 XML 文件，同时可选择将多条记录合并为单个数据结构（取决于 **最大记录数** 的值）。CSV 和 TSV 选项会以相应的文件格式输出数据。此选项不适用于包含子表的复杂表结构。 |
| **处理更改间隔单位** | 仅适用于 Select 操作。当 **设置** 选项卡中 **Select 配置** 部分的 **高级** 区域选中 **使用列 *columnname* 处理新增或更改的记录** 时，此设置控制如何解释 **处理更改间隔** 设置（例如，小时、天或周）。有关此设置及下面两个设置的详细信息，请参阅 [仅处理新增或更改的记录](/26.2/self-hosted/zh/connectors/shipstation/shipstation-ac.md#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.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 语句中的列值保持不变。选中后，端口会在 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，端口会无限期重试该文件。 |
| **接收** | 端口是否应自动查询数据源。 |
| **间隔** | 自动查询尝试之间的间隔。 |
| **整点后的分钟数** | 小时计划的分钟偏移量。仅当上述间隔设置为 *Hourly* 时适用。例如，如果此值设置为 5，自动化服务会在 1:05、2:05、3:05 等时间下载。 |
| **时间** | 尝试应发生的具体时间。仅当上述间隔设置为 *Daily*、*Weekly* 或 *Monthly* 时适用。 |
| **日期** | 尝试应发生的日期。仅当上述间隔设置为 *Weekly* 或 *Monthly* 时适用。 |
| **分钟** | 尝试下载之前等待的分钟数。仅当上述间隔设置为 *Minute* 时适用。 |
| **Cron 表达式** | 表示 cron 表达式的五段式字符串，用于确定尝试应何时发生。仅当上述间隔设置为 *Advanced* 时适用。 |

### 性能

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

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

## 警报选项卡

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

在执行服务级别协议（SLA）之前，你需要设置电子邮件警报以发送通知。默认情况下，知行之桥使用 [警报](/26.2/self-hosted/zh/getting-started/administration/settings/alerts.md) 选项卡上的全局设置。要对此端口使用其它设置，请开启 **覆盖全局设置**。

默认情况下，错误警报处于启用状态，这意味着每当发生错误时都会发送电子邮件。要关闭它们，请取消选中 **启用** 复选框。

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

## SLA 选项卡

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

SLA 允许你配置流程中端口预计发送或接收的数量，并设置预计达到该数量的时间范围。当未满足 SLA 时，知行之桥会发送电子邮件警告用户，并将 SLA 标记为 *At Risk*，这意味着如果很快仍未满足 SLA，它将被标记为 *Violated*。这让用户有机会介入并确定 SLA 未满足的原因，并采取适当操作。如果在风险期结束时仍未满足 SLA，SLA 会被标记为 violated，并再次通知用户。

要定义 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 生效的星期几。必要时可使用下拉列表选择 **每天**。
* 在窗口的 **将状态设置为“At Risk”** 部分，指定 SLA 应何时标记为有风险。
  * 默认情况下，在 SLA 违规之前不会发送通知。要更改此行为，请选中 **发送“At Risk”通知**。

以下示例显示了为一个端口配置的 SLA：该端口预计在周一至周五每天接收 1000 个文件。如果在时间段结束前 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* | 将 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* | 解析为指定 vault 项的值。 |

### 示例

某些宏（例如 %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` 是 [vault](/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md) 中项目的名称。例如，`%Vault:companyname%` 解析为 vault 中存储的 `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%`


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