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

# GISB 端口

> 知行之橋GISB 端口的配置與使用指南，支援使用氣體工業標準委員會 (GISB) 協議傳送和接收訊息。

GISB 端口支援使用氣體工業標準委員會 (GISB) 協議傳送和接收訊息。

## 核心功能

* 支援用於能源行業 B2B 通訊的 GISB 協議
* 具備數字簽章和加密功能，並支援金鑰管理
* 提供回執處理和確認管理，確保可靠交付
* 支援多個 GISB 版本，具備可配置的協議選項

## 概覽

GISB 連線在兩個位置進行配置。使用本地 GISB 識別碼、個人金鑰和所有 GISB 連線的全域資訊配置 GISB [個人設定](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/getting-started/administration/profiles.md) 頁面。然後使用特定於單個貿易伙伴的連線設定配置各個 GISB 端口。當 GISB 端口處理輸入檔案時，會將其打包並傳送給指定的貿易伙伴。

當 知行之橋 透過 GISB 接收到檔案時，它會嘗試將該檔案路由到特定的 GISB 端口。應用程式使用訊息中的 GISB ID 來確定哪個 GISB 端口應該接收該檔案。當檔案被路由到 GISB 端口時，該檔案被放置在端口的 **交易** 索引標籤中，或者被傳遞到工作流程中的下一個端口。

## 個人設定

必須先配置 GISB 配置檔案，然後才能與各個 GISB 端口建立連線。單擊頂部功能表欄上的 **個人設定 > GISB**。

### GISB 頁

#### 個人資訊

*用於識別本地配置檔案的設定。*

| 設定 | 描述 |
| - | - |
| **GISB ID** | 您的 GISB 識別碼。由 知行之橋 傳送的訊息包含此值作為 `GISB-From` 訊息頭。傳入訊息必須將此值作為 `GISB-To` 訊息頭才能成功接收。GISB 識別碼區分大小寫。 |

#### 個人金鑰

*與私有解密和簽章憑證相關的設定。*

| 設定 | 描述 |
| - | - |
| **金鑰** | 用於解密傳入訊息和簽署傳出訊息的金鑰。 |
| **密碼** | 存取本地金鑰所需的密碼。 |

#### 應用程式 URL

*與從公共網路存取 知行之橋 相關的設定和顯示值。*

| 設定 | 描述 |
| - | - |
| **接收 URL** | 知行之橋 偵聽傳入 GISB 訊息的 URL。與所有貿易伙伴共享此 URL。 |

#### 雜項

*特殊設定適用於特定用例。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他設定**</td>
<td>允許在以分號分隔的清單中配置隱藏的端口設定，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用這些設定。</td></tr></tbody></table>

## 端口配置

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

### 設定

#### 交易夥伴資訊

*用於識別和連線特定交易夥伴的設定。*

| 設定 | 描述 |
| - | - |
| **端口 ID** | 端口的靜態唯一識別碼。 |
| **端口型別** | 顯示端口名稱及其功能描述。 |
| **端口描述** | 可選欄位，用於對端口及其在工作流程中的角色進行自由格式描述。 |
| **GISB ID** | 目標交易夥伴的 ID。此值包含在傳出訊息中，還用於將傳入訊息路由到適當的 GISB 端口。 |
| **交易夥伴 URL** | 應該傳送傳出訊息的交易夥伴的公共 URL。 |
| **GISB 版本** | GISB 用戶端的協議版本。 |

#### 連線資訊

*為指定的交易夥伴設定相關的連線參數。*

| 設定 | 描述 |
| - | - |
| **訊息傳送安全性** | 是否對傳出訊息進行簽章和/或加密。知行軟體強烈建議使用簽章和加密。 |
| **訊息接收安全性** | 是否要求對傳入訊息進行簽章和加密。如果收到的訊息沒有所需的安全參數，將引發錯誤。 |
| **用戶端逾時** | 端口在引發逾時錯誤之前等待連線回應的時間（以秒為單位）。 |

#### 接收方

*與傳送和請求訊息回執相關的設定。*

| 設定 | 描述 |
| - | - |
| **安全性** | 收據是否應包括驗證訊息完整性和接收者身份的簽章塊。 |

#### 交易夥伴金鑰／憑證

*與交易夥伴提供的公共憑證相關的設定。*

| 設定 | 描述 |
| - | - |
| **接收方金鑰** | 用於加密和簽章驗證的公開金鑰。使用 **匯入金鑰** 按鈕，然後瀏覽到要匯入的金鑰。 |
| **TLS 伺服器憑證** | 用於驗證 TLS/SSL 伺服器身份的公開金鑰憑證。僅當交易夥伴的 GISB 系統需要 HTTPS（而非 HTTP）時才需要。如果交易夥伴未提供 TLS 伺服器憑證，可以將該設定留空以允許底層 OS/JVM 執行憑證驗證，也可以將其設定為 `Any Certificate` 以無條件信任目標伺服器的身份。 |

### 進階設定

#### 首選個人設定

*在此 GISB 端口的個人設定頁面中覆蓋 GISB 配置的設定。設定首選個人設定允許對某些交易夥伴使用不同的金鑰和 ID。*

| 設定 | 描述 |
| - | - |
| **本地 GISB ID** | 您的 GISB 識別碼。 |
| **金鑰** | 用於解密傳入訊息和簽章傳出訊息的金鑰。 |
| **密碼** | 存取本地金鑰所需的密碼。 |

#### TLS 用戶端認證

*與需要雙向 TLS 身分驗證時的用戶端身分驗證相關的設定。*

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**私有憑證**</td>
<td>TLS 用戶端身分驗證期間提供的私有憑證。</td></tr>
<tr><td>**憑證密碼**</td>
<td>存取 TLS 用戶端憑證所需的密碼。</td></tr></tbody></table>

#### HTTP 認證

*與 HTTP 用戶端身分驗證相關的設定。*

| 設定 | 描述 |
| - | - |
| **HTTP 認證** | 是否啟用用戶端 HTTP 認證。 |
| **HTTP 認證型別** | 是以加密格式（摘要認證）還是以純文字格式（基本認證）提供 HTTP 身分驗證憑據。只有當連線是 HTTPS 連線（而非 HTTP）時，才應該使用基本認證。 |
| **使用者名稱** | 用於 HTTP 用戶端認證的使用者憑據。 |
| **密碼** | 用於 HTTP 用戶端認證的密碼憑據。 |

#### 代理配置

這是一組用於識別連線所經代理並對其進行身分驗證的設定。預設情況下，本節使用 [安全設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 頁面的 [代理設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/proxy-settings.md) 部分中的全域設定。清除此核取方塊可為您的端口提供特定的設定。

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**代理型別**</td>
<td>基於代理的防火牆使用的協議。</td></tr>
<tr><td>**代理主機**</td>
<td>基於代理的防火牆的名稱或 IP 地址。</td></tr>
<tr><td>**代理端口**</td>
<td>基於代理的防火牆的 TCP 端口。</td></tr>
<tr><td>**代理使用者**</td>
<td>用於透過基於代理的防火牆進行身分驗證的使用者名稱。</td></tr>
<tr><td>**代理密碼**</td>
<td>用於對基於代理的防火牆進行身分驗證的密碼。</td></tr>
<tr><td>**身分驗證方案**</td>
<td>保留預設值 **None** 或選擇以下身分驗證方案之一：**Basic**、**Digest**、**Proprietary** 或 **NTLM**。</td></tr></tbody></table>

#### 進階設定

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

| 設定 | 描述 |
| - | - |
| **壓縮方法** | 壓縮傳出有效負載時使用的演算法。 |
| **EDI 型別** | 要使用的 EDI 訊息型別。預設值為 X12。 |
| **加密演算法** | 加密傳出訊息時使用的演算法。 |
| **摺疊標頭** | 選中此項可讓端口在標頭超過一定長度時摺疊標頭。 |
| **資料包型別** | 選中此項可讓端口從 **接收方金鑰憑證** 讀取功能，以確定是否需要舊的資料包型別。如果金鑰需要較舊的資料包型別，則使用它。 |
| **簽章和加密** | 選中此項可讓端口在同一步驟中執行簽章和加密。 |
| **簽章演算法** | 簽章傳出訊息時使用的演算法。 |
| **TLS 已啟用協議** | 建立傳出連線時支援的 TLS/SSL 協議清單。最佳實踐是僅使用 TLS 協議。SSL v2 和 SSL v3 被認為存在漏洞，只有在貿易伙伴不支援更高版本時才應使用。請注意，TLS v1.3 尚未被普遍採用，如果目標伺服器不支援它，可能會被拒絕。 |
| **臨時檔案** | 選中此項可讓端口將要處理的資料寫入臨時檔案，然後在臨時檔案完全寫入後將其移入處理。 |
| **本地檔案命名方案** | 為端口輸出訊息分配檔名的方案。可以在檔名中使用宏來動態包含識別碼和時間戳等資訊。更多資訊，請參閱[宏](#宏)。 |
| **處理延遲** | 放置在 **交易** 索引標籤中的檔案處理延遲的時間量（以秒為單位）。這是一箇舊版設定。最佳實踐是[使用檔案端口](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/flows/designing-a-flow.md#與本地檔案系統互動)來管理本地檔案系統，而不是此設定。 |

#### 訊息

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

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

#### 雜項

*特殊設定適用於特定用例。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他設定**</td>
<td>允許在以分號分隔的清單中配置隱藏的端口設定，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用這些設定。</td></tr></tbody></table>

### 自動化

#### 自動化設定

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

| 設定 | 描述 |
| - | - |
| **傳送** | 到達端口的檔案是否會作為 GISB 訊息自動傳送。 |
| **重試間隔** | 傳送失敗重試之前的時間。當伺服器沒有對傳送嘗試做出回應，或者對未收到檔案的通訊做出否定回應時，會觸發重試。 |
| **最大重試次數** | 端口處理輸入檔案的最大次數。是否成功基於伺服器確認和回執的驗證（如需要回執）。如果設定為 0，端口將無限次重試該檔案。 |

#### 效能

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

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

## 交易夥伴設定

交易夥伴必須共享配置新的 GISB 端口時所需的連線細節。這些細節至少應包括：

* GISB ID
* 交易夥伴 URL
* 接收方金鑰憑證

## 傳送和接收檔案

在配置了 GISB 個人設定和特定於交易夥伴的 GISB 端口之後，可以安全地傳送和接收檔案。

### 傳送檔案

在 GISB 端口中，**交易** 索引標籤顯示應該傳送給目標交易夥伴的檔案。如果啟用了[自動化](#自動化)索引標籤的 **傳送**，到達此索引標籤的檔案將被自動打包並傳送。透過展開與傳輸檔案相關聯的行，可以存取所有傳輸的日誌檔案。

**建立測試檔案** 按鈕可用於生成一系列簡單的測試檔案，以傳送給交易夥伴。

### 接收檔案

在 GISB 端口中，**交易** 索引標籤顯示由應用程式接收並路由到端口的檔案（基於傳入的 GISB 訊息中的 GISB ID）。每個檔案行都可以展開，以顯示傳輸可用日誌的清單。

這些檔案位於端口的 **交易** 索引標籤中。如果端口連線到流中的其他端口，檔案將自動從 GISB 端口的 **交易** 索引標籤移動到工作流程中下一個端口的 **交易** 索引標籤。

## 宏

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

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