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

# Kintone 端口配置

> 將知行之橋連線至 Kintone，實現資料集成與同步。

Kintone 端口可透過推送或拉取 Kintone 資料，將 Kintone 整合到您的資料流中。

## 核心功能

* 整合雲端業務應用平臺，用於自定義應用程式資料管理
* 靈活的身分驗證選項，包括密碼、API 權杖（Token）或 OAuth
* 標準資料庫操作（Select、Lookup、Upsert 和預存程序），用於資料操作

請按照以下步驟將 知行之橋 連線至 Kintone。

## 建立連線

要建立與 Kintone 的連線，請使用以下兩種方法之一：

* 將 Kintone 端口新增到流中。然後，在**設定**索引標籤上，單擊**連線**下拉式清單旁邊的**新增**。
* 開啟 知行之橋 **設定**頁面，然後開啟**連線**索引標籤。單擊**新增**，選擇 **Kintone**，然後單擊**下一步**。

> [!NOTE]
>
> * 登入流程僅在首次建立連線時需要。
> * 與 Kintone 的連線可在多個 Kintone 端口中重複使用。

## 輸入連線設定

1. 輸入連線資訊：

   * **名稱**：連線的靜態名稱，可根據需要設定。
   * **型別**：始終設定為 Kintone。
   * **連線**：用於連線的身分驗證方案。選項為**密碼**、**API 權杖**和 **OAuth**。
   * **URL**：您要連線的 Kintone 站點的 URL。

2. 輸入所選身分驗證方案的連線資訊：

   * [密碼](#密碼)
   * [API 權杖](#api-權杖)
   * [OAuth](#oauth)

3. 在端口配置面板的**連線**下拉式清單中選擇新增的連線。

### 密碼

1. 在**使用者名稱**欄位中，輸入用於登入的使用者名稱。

2. 在**密碼**欄位中，輸入該使用者的密碼。

3. 如有需要，單擊**進階**開啟進階連線設定功能表。大多數情況下無需使用。

4. 單擊**測試連線**，確認 知行之橋 可使用提供的資訊連線至 Kintone。如果發生錯誤，請檢查所有欄位並重試。

5. 單擊**新增連線**完成連線設定。

### API 權杖

1. 在 **ApiToken** 欄位中，提供用於身分驗證的 API 權杖。

2. 如有需要，單擊**進階**開啟進階連線設定功能表。大多數情況下無需使用。

3. 單擊**測試連線**，確認 知行之橋 可使用提供的資訊連線至 Kintone。如果發生錯誤，請檢查所有欄位並重試。

4. 單擊**新增連線**完成連線設定。

### OAuth

1. 在 **OAuth Client Id** 欄位中，輸入您帳戶的用戶端 ID。

2. 在 **OAuth Client Secret** 欄位中，輸入您帳戶的用戶端金鑰。

3. 如有需要，單擊**進階**開啟進階連線設定功能表。大多數情況下無需使用。

4. 單擊**連線**。

5. 在開啟的新標籤頁中，登入您的 Kintone 帳戶。如有提示，請授予存取權限。

6. 傳回 知行之橋。

   * 若連線成功，單擊**新增連線**。
   * 若連線失敗，請檢查您的 URL 和登入憑據，然後重試。

> [!NOTE]
>
> **進階**索引標籤上還有特定於資料來源的身分驗證和配置選項。本文件未完整記錄這些選項，但您可以在 我們網站的 [線上幫助檔案](https://www.kasoftware.com/articles.html) 頁面上找到資料來源的詳細資訊。

## 選擇操作

建立與 Kintone 的連線後，您必須選擇 Kintone 端口要執行的操作。下表列出了每種操作及其在 知行之橋 流中的位置。

| 操作 | 說明 | 流中的位置 |
| - | - | - |
| [Upsert](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/kintone/kintone-upsert.md) | 插入或更新 Kintone 資料。預設情況下，如果 Kintone 中已存在記錄，則使用輸入中提供的值對 Kintone 中的現有資料執行更新。 | 結尾 |
| [Lookup](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/kintone/kintone-lookup.md) | 從 Kintone 檢索值，並將其插入流中已存在的 知行之橋 訊息。 **Lookup 查詢**決定端口從 Kintone 檢索的值，應將其格式化為針對 Kintone 表的 SQL 查詢。 | 中間 |
| [Lookup 預存程序](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/kintone/kintone-lsp.md) | 將進入端口的資料作為預存程序的輸入，然後將結果插入流中已存在的 知行之橋 訊息。 您可以在**測試 Lookup** 對話方塊中單擊**顯示範例資料**按鈕，為選定的預存程序提供範例輸入並預覽結果。 | 中間 |
| [Select](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/kintone/kintone-select.md) | 從 Kintone 檢索資料並引入 知行之橋。 您可以使用**過濾器**面板向 Select 新增過濾條件。這些過濾器的功能類似於 SQL 中的 *WHERE* 子句。 | 開始 |
| [執行預存程序](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/kintone/kintone-esp.md) | 將進入端口的資料作為預存程序的輸入，然後將結果傳遞至流的下游。 您可以在**測試執行預存程序**對話方塊中單擊**顯示範例資料**按鈕，為選定的預存程序提供範例輸入並預覽結果。 | 中間 |

## 進階選項卡

**進階**索引標籤上的許多設定是從您所使用的資料來源動態載入的，因此本文件中不涵蓋這些設定。您可以在 我們網站的 [線上幫助檔案](https://www.kasoftware.com/articles.html) 頁面上找到資料來源的詳細資訊。

以下描述的選項適用於所有資料來源。

### 訊息

> [!NOTE]
>
> **儲存至 Sent 資料夾**和**Sent 資料夾方案**設定已棄用，預設處於隱藏狀態。只有先前已啟用這些設定或將其配置為非預設值的端口才會顯示它們。若要保留成功處理的檔案副本，請在工作流程中右鍵單擊該端口，選擇**顯示成功路徑**，然後將成功路徑連線到[File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/file.md)。

| 設定 | 描述 |
| - | - |
| **儲存至 Sent 資料夾**（已棄用） | 將端口處理的檔案複製到 Sent 資料夾。預設停用。儲存到 Sent 資料夾中的檔案不受靜態加密保護。 |
| **Sent 資料夾方案**（已棄用） | 按所選時間間隔對 Sent 資料夾中的檔案進行分組。僅在啟用**儲存至 Sent 資料夾**時適用。 |

### AI

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**自訂 AI 提示詞**</td>
<td>僅當在 **操作** 索引標籤上啟用 **對應** 時可見。選取此項可覆寫 AI 輔助對應在來源文件與目的文件之間建立對應時使用的預設系統提示詞和使用者提示詞內容。未選取時，端口使用預設提示詞產生對應。首次啟用該核取方塊時，預設提示詞會顯示在文字方塊中。</td></tr></tbody></table>
![自訂 AI 提示詞設定](https://docs.kasoftware.com/26.4/images/customize_ai_prompts.png)

### 進階設定

\_進階設定\_是依賴任意資料庫驅動程式（例如 Database、CData 和 API 端口）來連線各種資料來源的端口的通用設定。

| 設定 | 說明 |
| - | - |
| **自動截斷** | 啟用後，端口會自動截斷超出允許長度限制的字串或二進位列值。 |
| **命令逾時** | 命令執行的逾時時間（以秒為單位）。 |
| **最後插入的 ID 查詢** | 提供一個查詢，用於檢索最後插入記錄的自增 ID。 |
| **日誌級別** | 端口生成的日誌的詳細程度。請求支援時，請將其設定為 **Debug**。 |
| **本地檔案命名方案** | 用於為端口輸出的訊息分配檔名的方案。您可以在檔名中動態使用宏，以包含識別碼和時間戳等資訊。有關更多資訊，請參閱[宏](#宏)。 |
| **記錄訊息** | 勾選後，端口會在日誌目錄中的訊息日誌旁邊儲存訊息副本。如果停用此功能，您可能無法從**輸入**或**輸出**索引標籤下載檔案副本。 |
| **最大失敗記錄數** | 允許插入失敗的最大記錄數，以便繼續處理。預設值 0 表示任何錯誤都會導致輸入訊息被標記為"錯誤"，未提交的交易將被復原。值 -1 表示忽略所有錯誤，端口繼續嘗試插入後續記錄。正值表示端口在達到閾值之前繼續嘗試插入記錄。 |
| **輸出檔案格式** | 表示輸出資料的格式。預設值（XML）使端口為每條處理的記錄輸出一個 XML 檔案，同時可選擇將多條記錄合併為單個資料結構（取決於**最大記錄數**的值）。CSV 和 TSV 選項以各自的檔案格式輸出資料。此選項不適用於包含子表的複雜表結構。 |
| **處理變更間隔單位** | 僅適用於 Select 操作。當在**設定**索引標籤的 **Select 配置**的**進階**部分勾選**使用列 *columnname* 處理新記錄或已更改記錄**時，此選項控制如何解讀**處理變更間隔**設定（例如，小時、天或周）。有關此設定和以下兩項設定的詳細資訊，請參閱[僅處理新記錄或已更改記錄](https://docs.kasoftware.com/26.4/self-hosted/zh-Hant/connectors/kintone/kintone-ac.md#僅處理新記錄或已更改的記錄)。 |
| **處理變更間隔** | 當在**設定**索引標籤的 **Select 配置**部分勾選**使用列 *columnname* 處理新記錄或已更改記錄**時，此選項控制 知行之橋 在第一次嘗試時處理多少歷史資料。例如，保持預設值 180（天）意味著 知行之橋 僅嘗試處理最近 180 天內建立或修改的資料。 |
| **處理變更起始日期** | 當在**設定**索引標籤的 **Select 配置**部分勾選**使用列 *columnname* 處理新記錄或已更改記錄**時，此選項控制要檢索的資料的起始日期。 |
| **重置歷史記錄** | 重置勾選**使用列 *columnname* 處理新記錄或已更改記錄**時儲存的快取。 |
| **批次輸入大小** | 如果資料來源支援批次處理，則批次處理中的最大查詢數。 |
| **批次大小** | 批次組中的最大批次訊息數。 |
| **最大記錄數** | 單個輸出訊息中包含的最大記錄數。使用 -1 表示所有輸出記錄都放在一個檔案中，使用 0 表示端口可根據配置的**輸出檔案格式**自行決定。預設情況下，XML 每條記錄輸出一個檔案，而平面檔案格式將所有記錄包含在一個檔案中。 |
| **交易大小** | 一個交易中的最大查詢數。 |
| **處理延遲** | 放置在輸入資料夾中的檔案被延遲處理的時間（以秒為單位）。這是一箇舊版設定。最佳做法是[使用檔案端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)來管理本地檔案系統，而不是使用此設定。 |
| **插入空值** | 取消勾選時（預設），端口在構建 INSERT 和 UPDATE 語句時跳過空 XML 元素，導致資料庫對 INSERT 語句使用預設列值，對 UPDATE 語句保持列值不變。勾選時，端口在 INSERT 和 UPDATE 語句中包含空 XML 元素，使用空字串作為列的值。 |
| **插入 Null 值** | 取消勾選時（預設），端口在構建 INSERT 和 UPDATE 語句時跳過 null XML 元素（由 `xsi:nil="true"` 屬性標示）。勾選時，端口在 INSERT 和 UPDATE 語句中包含 null XML 元素，使用 null 作為列的值。被視為 null 的情況包括：`Not exist`、`<element/>`、`<element xsi:nil="true"/>`、`<element xsi:nil="true"></element>`、`<element null="true"/>` 和 `<element null="true"></element>`。 |
| **Lookup 快取** | 勾選**啟用 Lookup 快取**可在本地快取中執行查詢，然後再直接在資料來源上執行（當快取中未傳回記錄時）。取消勾選時（預設），查詢直接在資料來源上執行。以下 Lookup 快取選項僅在勾選**啟用 Lookup 快取**時可用。 |
| **Lookup 快取提供程式** | 指定用於連線快取資料庫的驅動程式。 |
| **Lookup 快取連接字串** | 設定後，端口使用此處指定的資料庫進行快取。 |
| **Lookup 快取容差** | 指定端口應多久查詢資料來源一次以重新整理快取。與**容差單位**選項配合使用。 |
| **Lookup 快取容差單位** | 選擇**分鐘**、**小時**或**天**。 |
| **日誌子資料夾方案** | 指示端口按所選時間間隔對 `Logs` 資料夾中的檔案進行分組。例如，**每週**選項指示端口每週建立一個新子資料夾，並將該周的所有日誌儲存在該資料夾中。空白設定表示端口將所有日誌直接儲存在 `Logs` 資料夾中。對於處理大量交易的端口，使用子資料夾有助於保持日誌整潔並提升效能。 |

### 雜項

\_雜項設定\_用於特定使用場景。

| 設定 | 說明 |
| - | - |
| **其他設定** | 允許您以分號分隔的清單（例如 `setting1=value1;setting2=value2`）配置隱藏的端口設定。正常端口使用場景和功能通常不需要使用這些設定。 |

## 自動化索引標籤

### 自動化設定

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

| 設定 | 說明 |
| - | - |
| **傳送** | 到達端口的檔案是否會自動傳送。 |
| **重試間隔** | 重試失敗傳送之前的分鐘數。 |
| **最大嘗試次數** | 端口處理檔案的最大次數。是否成功取決於是否收到伺服器確認。如果將此值設定為 0，端口將無限期地重試檔案。 |
| **接收** | 端口是否應自動查詢資料來源。 |
| **間隔** | 自動查詢嘗試之間的間隔。 |
| **每小時的分鐘數** | 每小時計劃的分鐘偏移量。僅當上方間隔設定為\_每小時\_時適用。例如，如果此值設定為 5，自動化服務將在 1:05、2:05、3:05 等時間下載。 |
| **時間** | 應進行嘗試的一天中的時間。僅當上方間隔設定為\_每天\_、\_每週\_或\_每月\_時適用。 |
| **天** | 應進行嘗試的日期。僅當上方間隔設定為\_每週\_或\_每月\_時適用。 |
| **分鐘** | 嘗試下載前等待的分鐘數。僅當上方間隔設定為\_分鐘\_時適用。 |
| **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>

未執行與無資料

該卡片會區分尚未執行的端口與已執行但未找到任何內容的端口。如果 **上次處理結果** 為空白，表示自動化尚未執行，請檢查 **下次執行時間** 和排程設定。如果結果為 **無資料**，表示自動化已按排程執行，但資料來源未傳回任何內容，請檢查資料來源中是否有新資料。

已停用的端口

已停用的端口會保留其上次執行資訊，因此您仍可以檢視其上次執行的時間及結果。只有 **下次執行時間** 會被清除。

### 效能

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

| 設定 | 說明 |
| - | - |
| **最大工作執行緒數** | 從執行緒池中消耗的處理此端口檔案的最大工作執行緒數。如果設定了此值，它將覆蓋[進階設定](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)部分的預設設定。 |
| **最大檔案數** | 分配給端口的每個執行緒傳送的最大檔案數。如果設定了此值，它將覆蓋[進階設定](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)部分的預設設定。 |

## 警示索引標籤

*與配置警示相關的設定。*

在執行服務級別協議（SLA）之前，您需要設定電子郵件警示以接收通知。預設情況下，知行之橋 使用[警示](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md)索引標籤上的全域設定。要為此端口使用其他設定，請開啟**覆蓋全域設定**。

預設情況下，錯誤警示已啟用，這意味著每當發生錯誤時都會傳送電子郵件。要關閉它們，請取消勾選**啟用**核取方塊。

輸入**主題**（必填），然後可選地輸入以逗號分隔的**收件人**電子郵件清單。

## SLA 索引標籤

*與配置服務級別協議（SLA）相關的設定。*

SLA 允許您配置流中端口預期傳送或接收的數量，並設定預期滿足該數量的時間範圍。當 SLA 未滿足時，知行之橋 會傳送電子郵件警告使用者，並將 SLA 標記為\_存在風險\_，這意味著如果 SLA 很快未得到滿足，它將被標記為\_違反\_。這給使用者提供了介入的機會，以確定 SLA 未滿足的原因並採取適當措施。如果在風險期結束時 SLA 仍未滿足，SLA 將被標記為違反，並再次通知使用者。

要定義 SLA，請開啟**預期數量**，然後單擊**設定**索引標籤。

![Empty SLA configuration](https://mintcdn.com/qiao/V5zXPPmcRAz2rNUe/26.4/images/sla_empty.png?fit=max\&auto=format\&n=V5zXPPmcRAz2rNUe\&q=85\&s=7d1ed28e2ba8f87a5029d1f12116663d)

* 如果您的端口有獨立的傳送和接收操作，請使用選項按鈕指定 SLA 適用的方向。
* 在視窗的**至少期望**部分：
  * 設定您期望處理的最少交易數（數量）
  * 使用**每**欄位指定時間範圍
  * 指明 SLA 何時生效。如果選擇**從...開始**，請填寫日期和時間欄位。
  * 勾選您希望 SLA 生效的星期幾核取方塊。如有必要，使用下拉功能表選擇**每天**。
* 在視窗的\*\*將狀態設定為"存在風險"\*\*部分，指定 SLA 何時應被標記為存在風險。
  * 預設情況下，在 SLA 違反之前不會傳送通知。要更改此行為，請勾選**傳送"存在風險"通知**。

以下範例顯示為端口配置的 SLA，該端口期望每天（週一至週五）接收 1000 個檔案。如果在時間段結束前 1 小時尚未收到 1000 個檔案，將傳送存在風險通知。

![SLA 配置範例](https://mintcdn.com/qiao/V5zXPPmcRAz2rNUe/26.4/images/sla_defined.png?fit=max\&auto=format\&n=V5zXPPmcRAz2rNUe\&q=85\&s=841f9268cb071c48106a7a77750a9332)

> [!NOTE]
>
> 如有必要，您可以關閉 SLA 警示。這在維護視窗期間很有用。單擊導覽列上的**設定**，然後導航至**警示 > 常規警示**。單擊平板電腦和鉛筆圖示進行編輯，並取消勾選 **SLA 警示**設定。

## 宏

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

知行之橋 支援以下宏，所有宏均使用以下語法：`%Macro%`。

| 宏 | 說明 |
| - | - |
| ConnectionName | 解析為端口使用的連線名稱。 |
| ConnectorID | 解析為端口的 ConnectorID。 |
| Ext | 解析為端口當前處理檔案的副檔名。 |
| Filename | 解析為端口當前處理檔案的檔名（包含副檔名）。 |
| FilenameNoExt | 解析為端口當前處理檔案的檔名（不含副檔名）。 |
| MessageId | 解析為端口輸出的訊息的 MessageId。 |
| RegexFilename:*pattern* | 將規則運算式模式應用於端口當前處理檔案的檔名。 |
| Header:*headername* | 解析為端口當前處理訊息上目標標頭（`headername`）的值。 |
| LongDate | 解析為系統當前日期時間的長格式（例如，Wednesday, January 24, 2024）。 |
| ShortDate | 解析為系統當前日期時間的 yyyy-MM-dd 格式（例如，2024-01-24）。 |
| DateFormat:*format* | 解析為系統當前日期時間的指定格式（`format`）。有關可用的日期時間格式，請參閱[範例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#带字面字符的日期格式)。 |
| Vault:*vaultitem* | 解析為指定保管庫專案的值。 |
| Table | 解析為端口從中選擇資料的表名。 |
| PK | 解析為從表中接收記錄的主索引鍵值。 |
| Sequence | 根據端口接收的總記錄數解析為四位數（例如，%Sequence% 在傳回第五條記錄時解析為 0005）。 |
| FileFormat | 解析為端口進階選項卡上指定的輸出檔案格式（XML、CSV 或 TSV）。 |

### 範例

某些宏（如 %Ext% 和 %ShortDate%）不需要參數，但其他宏需要。所有需要參數的宏均使用以下語法：`%Macro:argument%`

以下是需要參數的宏範例：

* %Header:headername%：其中 `headername` 是訊息上標頭的名稱。
* %Header:mycustomheader% 解析為輸入訊息上設定的 `mycustomheader` 標頭的值。
* %Header:ponum% 解析為輸入訊息上設定的 `ponum` 標頭的值。
* %RegexFilename:pattern%：其中 `pattern` 是規則運算式模式。例如，`%RegexFilename:^([\w][A-Za-z]+)%` 匹配並解析為檔名中的第一個單詞，且不區分大小寫（`test_file.xml` 解析為 `test`）。
* %Vault:vaultitem%：其中 `vaultitem` 是[保管庫](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md)中專案的名稱。例如，`%Vault:companyname%` 解析為保管庫中儲存的 `companyname` 專案的值。
* %DateFormat:format%：其中 `format` 是可接受的日期格式（詳情請參閱[範例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#示例日期格式)）。例如，`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%` 解析為檔案上的日期和時間戳。

您還可以建立更復雜的宏，如以下範例所示：

* 在一個檔名中組合多個宏：`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%`
* 在宏外包含文字：`MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%`
* 在宏內包含文字：`%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%`


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