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

# XML Group 端口

> 按鍵欄位對相關 XML 記錄集合進行分組和聚合，支援 MIN、MAX、SUM、AVG、COUNT 和 CONCATENATE 函式。

XML Group 端口處理相關 XML 記錄集合，並按列對其進行分組，以實現高效的資料管理和分析。

## 核心功能

* 支援層級 XML 記錄分組與聚合，可按鍵分組並使用多個分組鍵
* 支援透過 XPath 識別並執行 MIN、MAX、SUM、AVG、COUNT 和 CONCATENATE 等聚合函式
* 在新增彙總和分組元素的同時保留原始記錄結構

## 概觀

XML Group 端口透過聚合、驗證和轉換結構化資料來處理相關 XML 記錄集合，以便與各種系統無縫整合。它能夠高效處理層級 XML 資料，確保資料交換、報告和自動化工作流程等應用之間的一致性和互操作性。

## 端口配置

本節包含所有可配置的端口屬性。

### 組配置索引標籤

*與配置組相關的設定。*

#### 範例檔案

*使用 **範例檔案** 切換按鈕指定範例檔案，使端口能夠提供有關文件的更多上下文。有關更多資訊，請參閱[使用範例檔案](#使用範例檔案)。*

| 設定 | 說明 |
| - | - |
| **範例檔案** | 選擇現有範例檔案，或上傳新檔案。 |

#### 迴圈設定

*與端口應使用的 XPath 相關的設定，該 XPath 表示輸入文件中的單條記錄；同時還包括用於儲存每組相關記錄的 XML 元素。*

| 設定 | 說明 |
| - | - |
| **元素名稱** | 輸出檔案中用於分組的 XML 元素名稱。 |
| **記錄 XPath** | 輸入中的哪個 XPath 應代表單條記錄。 |

#### 分組設定

*定義每條記錄中哪些元素用於確定每個組鍵值的設定。有關更多資訊，請參閱[使用分組設定](#使用分組設定)。*

| 設定 | 說明 |
| - | - |
| **元素名稱** | 告訴端口在輸出檔案中用於分組的 XML 元素應命名為什麼。這通常與 **鍵 XPath** 指向的輸入檔案元素名稱相同，但也可以使用不同名稱。 |
| **鍵 XPath** | 輸入檔案中要用作 *key*（分組依據）的元素的 XPath。**鍵 XPath** 相對於 **記錄 XPath**。 |
| **新增鍵 XPath** | 點選此按鈕以定義其他鍵。 |

#### 聚合設定

*使用 **聚合設定** 切換按鈕檢視用於定義如何彙總每個組中記錄的設定。有關更多資訊，請參閱[使用聚合設定](#使用聚合設定)。*

| 設定 | 說明 |
| - | - |
| **元素名稱** | 用於彙總記錄的 XPath 名稱。 |
| **函式** | 用作聚合的函式。可從 MIN、MAX、SUM、AVG、COUNT 和 CONCATENATE 中選擇。 |
| **XPath** | 要聚合的元素的相對 XPath。 |
| **新增聚合 XPath** | 點選此按鈕以新增更多聚合 XPath。 |

#### 排序依據設定

*使用 **排序依據** 切換按鈕檢視用於定義如何對每個組中的記錄進行排序的設定。*

| 設定 | 說明 |
| - | - |
| **XPath** | 用於排序的元素的相對 XPath。 |
| **排序依據** | 按升序還是降序排序。 |
| **新增排序依據 XPath** | 點選此按鈕以新增更多用於排序的 XPath。 |

### 設定索引標籤

#### 配置

*與建立連線相關的設定。*

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

### 自動化索引標籤

#### 自動化設定

*與端口自動處理檔案相關的設定。*

| 設定 | 說明 |
| - | - |
| **傳送** | 勾選此項，使端口在組準備就緒後自動傳送。 |

#### 效能

*與端口資源分配相關的設定。*

<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 通知** 設定。

### 進階選項卡

#### 訊息

*訊息設定確定端口如何搜尋訊息並在處理後管理它們。*

**注意：**以下設定已棄用，預設處於隱藏狀態。只有先前已啟用這些設定或將其配置為非預設值的端口才會顯示它們。若要保留成功處理的檔案副本，請在工作流程中右鍵單擊該端口，選擇**顯示成功路徑**，然後將成功路徑連線到 [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>

## 使用範例檔案

開啟 **範例檔案** 以上傳一個範例輸入 XML，該 XML 模擬將傳遞到端口中的 XML 輸入。

啟用後，它會為 UI 中的每個 XPath 欄位提供 XPath 助手，從而更容易檢視文件結構並選擇正確的 XPath。根據 XPath 在端口中代表的內容，只能點選符合條件的 XML 元素。

例如，在 **迴圈設定** 中，只能選擇父元素，因為 知行之橋 期望這些元素代表一條 *記錄*。

![](https://mintcdn.com/qiao/cAp6sdkg0SyWJqZM/26.4/images/xml-group-loop-settings.png?fit=max\&auto=format\&n=cAp6sdkg0SyWJqZM\&q=85\&s=0c6e6d21de30412d777c223b9f1bbec2)

然後，在 **分組設定** 中，可見元素是 **迴圈設定** 父元素的子元素，因為 知行之橋 期望 *key* 元素是父記錄的子元素。

![](https://mintcdn.com/qiao/cAp6sdkg0SyWJqZM/26.4/images/xml-group-group-settings.png?fit=max\&auto=format\&n=cAp6sdkg0SyWJqZM\&q=85\&s=1e4bde1c6a6b79426e43e4cc6dc94415)

## 使用分組設定

分組設定定義每條記錄中用於確定每個組鍵值的元素。鍵通常是 `Id` 值，例如 `CustomerID` 或 `InvoiceID`。可以有多個鍵，它們會作為[迴圈設定](#迴圈設定)中設定的元素名稱和 XPath 的子項出現。

* **元素名稱** 告訴端口在輸出檔案中用於分組的 XML 元素應命名為什麼。這通常與鍵 XPath 指向的輸入檔案元素名稱相同，但也可以使用不同名稱。
* **鍵 XPath** 是輸入檔案中要用作 *key*（分組依據）的元素的 XPath。**鍵 XPath** 相對於 **記錄 XPath**。

例如，在以下 XML 中，`<MaterialCode>` 元素是鍵。這樣就可以在輸出中將 `ALPHA`、`BRAVO` 和 `CHARLIE` 的所有出現項分組在一起，而不是分別出現多個重複項。

```xml theme={null}
<Items>
    <Invoice>
        <InvoiceDetail>
            <MaterialCode>ALPHA</MaterialCode>
            <MaterialCodeDescription>Alpha Materials</MaterialCodeDescription>
            <NetAmount>1000.00</NetAmount>
        </InvoiceDetail>
        <InvoiceDetail>
            <MaterialCode>ALPHA</MaterialCode>
            <MaterialCodeDescription>Alpha Materials</MaterialCodeDescription>
            <NetAmount>2000.00</NetAmount>
        </InvoiceDetail>
        <InvoiceDetail>
            <MaterialCode>BRAVO</MaterialCode>
            <MaterialCodeDescription>Bravo Materials</MaterialCodeDescription>
            <NetAmount>100.00</NetAmount>
        </InvoiceDetail>
        <InvoiceDetail>
            <MaterialCode>CHARLIE</MaterialCode>
            <MaterialCodeDescription>Charlie Materials</MaterialCodeDescription>
            <NetAmount>500.00</NetAmount>
        </InvoiceDetail>
        <InvoiceDetail>
            <MaterialCode>CHARLIE</MaterialCode>
            <MaterialCodeDescription>Charlie Materials</MaterialCodeDescription>
            <NetAmount>100.00</NetAmount>
        </InvoiceDetail>
    </Invoice>
</Items>
```

## 使用聚合設定

聚合設定控制端口應如何聚合資料。可以定義一個 XPath，其中包含要執行操作運算子（MIN、MAX、SUM、AVG、COUNT、CONCATENATE）的值，然後端口會對組中的所有記錄執行該運算子。一個常見範例是對每條記錄的價格求和。

以下範例使用前面圖片中描述的 **迴圈設定** 和 **分組設定**，以及以下 **聚合設定**：

![](https://mintcdn.com/qiao/cAp6sdkg0SyWJqZM/26.4/images/xml-group-group-settings.png?fit=max\&auto=format\&n=cAp6sdkg0SyWJqZM\&q=85\&s=1e4bde1c6a6b79426e43e4cc6dc94415)

使用上一節中的 XML 會生成一個輸出 XML，其中每個鍵元素（`MaterialCode`）都有一個 `InvoiceDetailGroup`。每個 `InvoiceDetailGroup` 內都有來自 **分組設定** 的 `MaterialCode` 鍵，以及來自 **聚合設定** 的計算結果 `NetAmountSUM`。最後，還會包含原始的 `InvoiceDetail` 元素及其子元素：

```xml theme={null}
<Items>
  <Invoice>
    <InvoiceDetailGroup>
      <MaterialCode>ALPHA</MaterialCode>
      <NetAmountSUM>3000</NetAmountSUM>
      <InvoiceDetail>
        <MaterialCode>ALPHA</MaterialCode>
        <MaterialCodeDescription>Alpha Materials</MaterialCodeDescription>
        <NetAmount>1000.00</NetAmount>
      </InvoiceDetail>
      <InvoiceDetail>
        <MaterialCode>ALPHA</MaterialCode>
        <MaterialCodeDescription>Alpha Materials</MaterialCodeDescription>
        <NetAmount>2000.00</NetAmount>
      </InvoiceDetail>
    </InvoiceDetailGroup>
    <InvoiceDetailGroup>
      <MaterialCode>BRAVO</MaterialCode>
      <NetAmountSUM>100.00</NetAmountSUM>
      <InvoiceDetail>
        <MaterialCode>BRAVO</MaterialCode>
        <MaterialCodeDescription>Bravo Materials</MaterialCodeDescription>
        <NetAmount>100.00</NetAmount>
      </InvoiceDetail>
    </InvoiceDetailGroup>
    <InvoiceDetailGroup>
      <MaterialCode>CHARLIE</MaterialCode>
      <NetAmountSUM>600</NetAmountSUM>
      <InvoiceDetail>
        <MaterialCode>CHARLIE</MaterialCode>
        <MaterialCodeDescription>Charlie Materials</MaterialCodeDescription>
        <NetAmount>500.00</NetAmount>
      </InvoiceDetail>
      <InvoiceDetail>
        <MaterialCode>CHARLIE</MaterialCode>
        <MaterialCodeDescription>Charlie Materials</MaterialCodeDescription>
        <NetAmount>100.00</NetAmount>
      </InvoiceDetail>
    </InvoiceDetailGroup>
  </Invoice>
</Items>
```

由於關聯記錄已作為鍵的巢狀子項存在，而不是扁平結構，因此當此 XML 進入 [XML Map](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/xml-map/xml-map.md) 端口時更易於處理。

## 宏

在檔案命名策略中使用宏可以提高組織效率和對資料的上下文理解。透過將宏合併到檔名中，可以動態地包含相關資訊，例如識別碼、時間戳和訊息頭資訊，從而為每個檔案提供有價值的上下文。這有助於確保檔名反映對組織重要的詳細資訊。

知行之桥 支援這些宏，它們都使用以下語法：`%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.