> ## 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-Hant/scripting/arcscript.md) 或 [Python](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/scripting/python-scripting.md) 實現自定義業務邏輯
* 存取完整的訊息上下文，包括訊息標頭和檔案內容
* 整合外部庫和系統命令 (Python)
* 支援複雜的資料轉換和業務規則處理
* 使用 [connectorBatchGroupRead](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/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-Hant/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-Hant/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.