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

# ZUGFeRD 端口

> 知行之橋ZUGFeRD 端口的配置和使用指南。

ZUGFeRD 端口從 PDF 和 XML 發票檔案生成 ZUGFeRD 檔案，或從 ZUGFeRD 檔案中提取發票 XML 檔案。

## 核心功能

* 德國電子發票標準，結合 PDF 與 XML，並支援雙向處理（提取 XML 或生成 ZUGFeRD 檔案）
* 支援版本 1.0、2.0、2.1，以及多種一致性級別（MINIMUM、BASIC、EN 16931、EXTENDED 和 XRECHNUNG）
* 支援 PDF/A-3 格式，可在人工可讀 PDF 中嵌入機器可讀 XML，並支援批次處理組處理

## 概觀

ZUGFeRD 端口透過整合 ZUGFeRD（Zentraler User Guide des Forums elektronische Rechnung Deutschland）標準來促進電子發票交換，該標準將人類可讀和機器可讀的資料結合在單個文件中。它基於 PDF/A-3 標準，允許將 XML 資料嵌入 PDF 檔案。這種混合格式確保發票既可以被人輕鬆閱讀，也可以由計算機系統自動處理。ZUGFeRD 端口允許你透過兩種方式與 ZUGFeRD 檔案互動：

* [解析 ZUGFeRD 檔案](#解析-zugferd-檔案)
* [生成 ZUGFeRD 檔案](#生成-zugferd-檔案)

端口會根據提供的輸入型別確定要執行的操作。

## 端口配置

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

### 設定索引標籤

#### 配置

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

| 設定 | 說明 |
| - | - |
| **端口 ID** | 端口的靜態唯一識別碼。 |
| **端口型別** | 顯示端口名稱及其功能說明。 |
| **端口說明** | 可選欄位，用於自由描述端口及其在工作流程中的作用。 |
| **版本** | 生成的 ZUGFeRD 檔案中使用的 ZUGFeRD 版本。 |

#### 進階設定

*前述類別中未包含的設定。*

| 設定 | 說明 |
| - | - |
| **一致性級別** | 生成的 ZUGFeRD 檔案中使用的一致性級別。選項包括：BASIC、EXTENDED、MINIMUM、BASIC WL、EN 16931、XRECHNUNG。 |
| **發票說明** | 生成的 ZUGFeRD 檔案中使用的自由文字說明。 |

### 進階選項卡

#### 訊息

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

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

### 自動化索引標籤

#### 自動化設定

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

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

#### 效能

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

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

## 解析 ZUGFeRD 檔案

端口期望接收 PDF 檔案作為輸入，並讀取該檔案以提取附加的 XML，然後傳送到工作流程下游。

### 處理多個附件

你可能會收到包含多個附件的 PDF 檔案。預設情況下，端口會將所有附件傳遞到工作流程下游，併為每條訊息新增訊息頭：

* ZUGFeRD-File-Index：每個附件的附件編號
* ZUGFeRD-File-Count：電子郵件中的附件總數
* ZUGFeRD-File-Name：原始 PDF 檔名
* ZUGFeRD-File-Description：發票 XML 和附件的說明
* ZUGFeRD-File-Parameters：發票 XML 和附件的其他檔案參數
* ZUGFeRD-File-Relationship：發票 XML 和附件的檔案關係。發票 XML 通常為 "Alternative"，附件通常為 "Data"、"Supplement" 等。
* ZUGFeRD-File-Subtype：發票 XML 和附件的檔案子型別。這通常是檔案的 MIME-Type，例如 text\xml 或 application\pdf。

## 生成 ZUGFeRD 檔案

端口期望接收一個批次處理組，其中恰好包含一條 PDF 批次處理訊息和一條 XML 批次處理訊息。在工作流程中將這些批次處理組傳送到 ZUGFeRD 端口之前，請使用 [Batch Create](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/batch-create.md) 端口建立它們。如果包含多於一條 PDF 或 XML 批次處理訊息，或者批次處理組中缺少其中任意一種訊息，則會引發錯誤。

UI 中所有 ZUGFeRD 特定設定（版本、一致性級別和發票說明）僅用於生成 ZUGFeRD 檔案。解析完全不涉及這些設定。

* **版本**：控制生成檔案時使用的 ZUGFeRD 版本。知行之橋 支援版本 1.0、2.0 和 2.1。

* **一致性級別**：ZUGFeRD 標準主要包括以下一致性級別：
  * MINIMUM
    * 包含最基本的發票資訊，例如發票號、日期和金額。
    * 資料以 PDF/A-3 格式嵌入，便於人類閱讀和簡單系統處理。

  * BASIC
    * 在 MINIMUM 級別的基礎上包含更多結構化資料，例如買方和賣方詳細資訊、稅務資訊和付款條件。
    * 適用於需要適度自動化的場景。

  * BASIC WL
    * 與 BASIC 類似，但針對特定用例定製，通常包含某些行業或地區的附加欄位。
    * 增強專門場景中的互操作性。

  * EN 16931 (COMFORT)
    * 符合歐盟標準 EN 16931，為高度自動化處理提供完整的結構化資料。
    * 適合複雜業務流程和系統整合。

  * EXTENDED
    * 在 EN 16931 的基礎上擴充套件，允許包含行業或公司特定的附加資訊。
    * 專為具有獨特需求的企業設計。

  * XRECHNUNG
    * 基於 ZUGFeRD 的德國特定配置檔案，符合公共部門發票的 XRechnung 標準。
    * 確保符合德國公共採購法規。

* **發票說明**：PDF 閱讀器會顯示 PDF 附件的可選說明。此設定控制 XML 附件使用的說明。

### 生成範例檔案

若要生成可用於測試的範例檔案，請導航到端口的 **交易** 索引標籤，然後點選 **生成範例檔案** ![生成範例檔案](https://mintcdn.com/qiao/kYLwR1iZrGqYINH1/26.4/images/generate_test_file.png?fit=max\&auto=format\&n=kYLwR1iZrGqYINH1\&q=85\&s=8a5a31a44e461f7817c2b75c29d576c4) 按鈕。這會在 Send 資料夾中建立一個 PDF 檔案。端口處理該 PDF 時，會生成一個 XML 輸出檔案，其中包含從 PDF 中提取的發票資料。

## 宏

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

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