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

# Script 端口

> 使用 ArcScript 或 Python 执行自定义函数和操作，包括数据转换、外部调用和业务规则处理。

Script 端口提供了执行 知行之桥 内置端口中不可用的函数或操作的能力。

## 核心功能

* 使用 [ArcScript](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/arcscript.md) 或 [Python](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/python-scripting.md) 实现自定义业务逻辑
* 访问完整的消息上下文，包括消息标头和文件内容
* 集成外部库和系统命令 (Python)
* 支持复杂的数据转换和业务规则处理
* 使用 [connectorBatchGroupRead](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/operations/op-connector-batch-group-read.md) 知行之桥Script 操作处理批处理组消息

## 概述

Script 端口使用强大的 ArcScript 脚本语言来完成各种自定义行为。每当文档被放入端口的[事务](#事务选项卡)选项卡时，端口中配置的脚本就会运行。脚本可以读取和修改输入文档，也可以让输入文档仅触发端口中配置的外部函数。Script 端口也可以通过[自动化](#自动化选项卡)选项卡上的**接收**自动化按计划运行。

以下是可配置 Script 端口执行的一些任务：

* 使用自定义 SQL 查询返回的数据替换输入文档中的值
* 调用自定义 Web 服务以触发专用工作流
* 通过 sysExecute 操作运行外部脚本或可执行文件

为 Script 端口确定合适的任务后，请阅读脚本文档，了解如何使用 ArcScript 调用各种操作。

## 端口配置

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

### Script 选项卡

*与编写和测试脚本相关的选项。*

![](https://mintcdn.com/qiao/V5zXPPmcRAz2rNUe/26.4/images/script_tab.png?fit=max\&auto=format\&n=V5zXPPmcRAz2rNUe\&q=85\&s=bc899c8a7dfcc97fa915a3f9bf052bc1)

| 设置 | 说明 |
| - | - |
| **操作下拉菜单** | 选择端口的操作。（有关这三个选项的详细信息，请参阅[操作](#操作)。） |
| **ArcScript 编辑器** | 使用编辑器编写脚本。工具栏包含撤消、重做、删除、复制和格式化等标准编辑选项。它还包含一个用于隐藏右侧窗格中“插入选项”的选项。 |
| **插入选项** | 右侧窗格中的面板可让您通过单击轻松将代码插入脚本。下拉菜单包含**输入和输出**（例如 ConnectorId 或 Encoding；可用选项取决于配置的操作）、**代码片段**、关键字、运算符和格式化程序。找到要插入的代码，然后单击即可添加。 |
| **测试选项卡** | 指定是否以消息正文或标头形式查看脚本输入和/或输出。此选项卡上的选项会因脚本的操作类型而异（例如，触发器脚本没有输入）。单击**测试**以测试脚本。 |
| **日志选项卡** | 显示测试日志。 |
| **上次更新时间** | 显示脚本上次修改和保存的日期时间。 |
| **自动更新** | 使用切换开关在每次修改后自动测试脚本。 |

#### 操作

此端口可以执行三种端口操作类型中的任何一种：

• *触发* 按计划执行一个 script ，并且可能会生成要沿着工作流发送的文件。此操作充当工作流的起点。

• *转换* 接受来自工作流的消息作为 script 的输入并生成输出。此操作充当工作流的中间部分。

• *终结* 接受来自工作流的消息作为 script 的输入并充当工作流的终点。

### 设置选项卡

#### 配置

*与端口核心操作相关的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**端口 Id**</td>
<td>端口的静态、唯一标识符。</td></tr>
<tr><td>**端口类型**</td>
<td>显示端口类型及其用途的描述。</td></tr>
<tr><td>**端口描述**</td>
<td>一个可选字段，用于提供端口及其在流中的角色的自由格式描述。</td></tr></tbody></table>

#### 高级设置

| 设置 | 说明 |
| - | - |
| **本地文件方案** | 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏来包含标识符和时间戳等信息。有关更多信息，请参阅[宏](#宏)。 |

### 高级选项卡

#### 消息

*消息设置确定端口如何搜索消息并在处理后管理它们。*

**注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**保存到已发送文件夹**（已弃用）</td>
<td>将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受[静态加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保护。</td></tr>
<tr><td>**已发送文件夹方案**（已弃用）</td>
<td>按所选时间间隔对 **Sent** 文件夹中的文件进行分组。仅在启用**保存到已发送文件夹**时适用。</td></tr></tbody></table>

#### 日志

*用于管理日志创建和存储的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日志级别**</td>
<td>指定要记录在端口日志目录中的信息类型：
<ul><li>**None** - 不创建任何日志。</li>
<li>**Error** - 仅当端口遇到错误时才创建日志。</li>
<li>**Warning** - 仅当端口发出警告时才创建日志。</li>
<li>**Info** - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
<li>**Debug** - 记录成功和失败工作流的详细调试信息。</li>
<li>**Trace** - 记录成功和失败工作流的详细跟踪信息。</li></ul>
\*\*请注意：\*\***Debug** 和 **Trace** 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td></tr>
<tr><td>**日志文件夹结构**</td>
<td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td></tr>
<tr><td>**保留消息副本**</td>
<td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td></tr></tbody></table>

#### 其他设置

| 设置 | 说明 |
| - | - |
| **处理延迟** | 放入**事务**选项卡的文件延迟处理的时间（以秒为单位）。这是一个旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)管理本地文件系统，而不是使用此设置。 |

#### 杂项

*特殊设置适用于特定用例。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

### 自动化选项卡

#### 自动化设置

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

| 设置 | 说明 |
| - | - |
| **发送** | 到达端口的消息是否会自动处理。 |
| **重试间隔** | 端口在重试失败的脚本执行之前等待的分钟数。 |
| **最大重试次数** | 端口在引发错误之前重试失败脚本执行的次数。 |
| **接收** | 端口是否应按配置的计划自动运行脚本。 |
| **接收执行间隔** | 接收自动化计划所用的时间单位（如分钟、小时或天）。 |
| **经过整点的分钟数** | 小时计划的分钟偏移量。仅当上述间隔设置为\_每小时\_时适用。 |
| **时间** | 尝试发生的具体时间。仅当上述间隔设置为\_每天\_、\_每周\_或\_每月\_时适用。 |
| **日期** | 尝试发生的日期。仅当上述间隔设置为\_每周\_或\_每月\_时适用。 |
| **分钟** | 尝试下载前等待的分钟数。仅当上述间隔设置为\_分钟\_时适用。 |
| **Cron 表达式** | 表示 Cron 表达式的五段字符串，用于确定尝试发生的时间。仅当上述间隔设置为\_高级\_时适用。 |
| **开始日期和时间** | 自动化首次运行的日期和时间。之后的每次运行都遵循上方的间隔设置。上次和下次运行时间显示在 [自动化状态](#自动化状态) 部分中。 |

#### 自动化状态

*只读摘要，显示自动化是否正在运行、上次运行的结果以及下次运行的时间。*

**自动化状态**卡片显示在 **自动化** 选项卡的 **启用** 复选框下方，适用于 **接收**、**下载** 和 **定时发送** 自动化。该卡片回答三个问题：自动化是否已运行、运行是否成功，以及下次运行的时间。

在保存端口之前，当您更改 **启用** 复选框，或者更改 **间隔** 或 **开始日期和时间** 设置时，卡片会随之更新。

![自动化选项卡上的自动化状态卡片，显示已暂停状态、失败的上次处理结果以及下次运行时间](https://docs.kasoftware.com/26.4/images/automation-status-card.png)

状态

端口自动化的当前状态。

<table><thead><tr><th>状态</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**进行中**</td>
<td>当前有一次运行正在进行，或者其他实例已锁定该计划时段。</td></tr>
<tr><td>**空闲**</td>
<td>自动化正在等待下一次计划运行。</td></tr>
<tr><td>**已暂停**</td>
<td>端口在多次运行失败后处于[退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)状态，自动化服务会跳过该端口。</td></tr>
<tr><td>**已禁用**</td>
<td>该端口的自动化已关闭。</td></tr></tbody></table>

上次运行时间

最近一次运行的结果。

<table><thead><tr><th>字段</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日期**</td>
<td>上次运行的计划时间。</td></tr>
<tr><td>**上次处理开始时间**</td>
<td>端口实际开始处理上次运行的时间。该时间可能略晚于计划时间。</td></tr>
<tr><td>**上次处理结果**</td>
<td>上次运行的结果：
<ul><li>**成功**：运行已完成并处理了数据。</li>
<li>**无数据**：运行已完成，但没有需要处理的内容，例如查询未返回任何行。</li>
<li>**失败**：运行未完成。</li></ul></td></tr>
<tr><td>**上次成功时间**</td>
<td>最近一次成功运行的日期和时间。当上次运行失败或未返回数据时，会显示此字段，以便您了解端口已有多长时间未成功运行。</td></tr></tbody></table>

下次运行时间

**日期** 字段显示自动化下一次计划运行的时间。自动化禁用时，该字段为空。

查看详情

**已暂停** 状态、**失败** 结果和 **无数据** 结果都包含一个 **查看详情** 链接，单击后会打开一个显示完整消息的对话框：

<ul><li>**已暂停**：列出每个处于退避状态的实例、其失败次数以及自动化服务恢复的时间。有关端口如何退出此状态，请参阅[端口退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)。</li>
<li>**失败**：显示上次失败运行的错误消息。</li>
<li>**无数据**：显示端口报告的消息，例如 `0 rows returned`。</li></ul>

未运行与无数据

该卡片会区分尚未运行的端口与已运行但未找到任何内容的端口。如果 **上次处理结果** 为空，说明自动化尚未运行，请检查 **下次运行时间** 和计划设置。如果结果为 **无数据**，说明自动化已按计划运行，但数据源未返回任何内容，请检查数据源中是否有新数据。

已禁用的端口

已禁用的端口会保留其上次运行信息，因此您仍可以查看其上次运行的时间及结果。只有 **下次运行时间** 会被清除。

#### 性能

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

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

### 警报选项卡

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

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

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

输入 **主题**（必填）。勾选**允许在主题中使用 ArcScript**，即可在**主题**字段中使用 ArcScript。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。

（可选）输入以逗号分隔的**收件人**电子邮件地址列表。

### SLA 选项卡

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

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

SLA 转换为 *存在风险* 或 *已违反* 状态时，也会写入[应用程序日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，这意味着应用性能监控 (APM) 和日志采集工具也可以针对这些状态发出警报。

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

![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png)
<ul><li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
<li>在窗口的 **预计至少** 部分中：
<ul><li>设置预计处理的最小事务数量（交易量）</li>
<li>使用 **每个** 字段指定时间范围</li>
<li>指示 SLA 生效的时间。如果选择 **开始于**，请填写日期和时间字段。</li>
<li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 **每天**。</li></ul></li>
<li>在窗口的 **将状态设置为“有风险”** 部分中，指定应将 SLA 标记为有风险的时间。
<ul><li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 **发送“有风险”通知**。</li></ul></li></ul>

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

![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png)

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

### 事务选项卡

此选项卡列出了与端口关联的所有消息。使用搜索栏查找特定消息，或单击漏斗图标应用过滤器。您可以按时间、消息方向和/或状态进行过滤。

此选项卡上的选项会因端口的[操作类型](#操作)而异：

* 如果端口是**触发器**，请使用**接收**按钮启动工作流。
* 如果端口是**转换**或**终结**，请使用**上传文件**按钮将文件上传到工作流。

## 使用 arc:push 关键字

[arc:push](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/keyword-reference/op-arc-push.md) 关键字通常用于 Script 端口，以将项目传递到脚本的输出 Feed。此外，当从“插入选项”菜单中选择 **Output** 属性时，如果脚本中尚未包含 `arc:push` 关键字，知行之桥 会自动注入该关键字，以确保脚本正常运行。以下是三个常见用例。

1 创建并输出文件：

```xml theme={null}
<arc:set attr="output.filename" value="results.txt" />
<arc:set attr="output.data" value="This is my result" />
<arc:push item="output" />
```

2 将输入文件作为输出传递：

```xml theme={null}
<arc:set attr="output.filepath" value="[filepath]" />
<arc:push item="output" />
```

3 向 Script 端口日志文件写入条目：

```xml theme={null}
<arc:set attr="logger.log#" value="Custom Log entry line 1" />
<arc:set attr="logger.log#" value="Custom Log entry line 2" />
<arc:push item="logger" />
```

## 宏

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

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

<table><thead><tr><th>宏</th><th>描述</th></tr></thead>
<tbody><tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
<tr><td>ConnectorName</td><td>替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。</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:*pattern*</td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
<tr><td>Header:*headername*</td><td>替换为端口正在处理的当前消息的目标消息头（`headername`）的值。</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:*format*</td><td>以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。</td></tr>
<tr><td>Vault:*vaultitem*</td><td>计算指定保管库项目的值。</td></tr></tbody></table>

### 示例

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

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

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

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

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


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