bfexport 參照

使用 bfexport 指令,可將專案資料匯出至具名的 XML 檔,或將專案資料傳送至顯示終端機(標準輸出)以供檢視。匯出檔含有單一專案或專案 Snapshot 的專案配置資料。

語法

bfexport

bfexport [-l]
bfexport [-l] <project_name>
bfexport [-c "<comment>"] [-f <file_name>] [-g] [-s] [-C] [-L ] [-n ] 
<project_name> | <project_name> <snapshot_name> | <project_id>

用法

如果要完成一般的專案匯出作業,請使用下列的指令選項:
  • 如果要顯示指令語法,請直接使用 bfexport(不含任何選項)。
  • 如果要列出儲存在 Build Forge 資料庫中的專案名稱和專案 ID,請使用 bfexport -l。

    在指令輸出中,專案名稱後面會附加 Snapshot 名稱:<project_ID>: <project_name> - <snapshot_name>

  • 若要將專案資料傳送至 XML 檔,請使用 bfexport -f <file_name>。您必須指定 -f <file_name> 選項,才能產生一個可用來匯入專案資料的檔案。
  • 在 z/Linux 平台上,您必須將指令執行成 bfexport.pl。而在其他所有平台上,指令不需要副檔名。

必備條件與限制

請在 Build Forge 安裝目錄中尋找 bfexport 公用程式。

匯出檔中不會包含伺服器的授權密碼;在匯入之後,您必須在使用者介面中手動輸入伺服器授權密碼。

bfexport 指令必須能夠找到 buildforge.conf 檔以及存取 Build Forge 資料庫。請從 buildforge.conf 所在的目錄執行 bfexport,此目錄在 Windows 上是 <bfinstall>,而在 UNIX 及 Linux 上則是 <bfinstall>/Platform。

範例

若要將輸出寫入至檔案,請使用 -f <file_name> 選項。在下列範例中,helloworld 為輸出檔名稱,並且使用的是專案 ID 而非專案名稱。

bfexport -c "Saving a copy of project before making changes" 
 -f helloworld 675B57CC-8366-11DD-B2E0-043C04E44E1A

若只要匯出預設專案 Snapshot,請使用 <project_name>。

bfexport -f helloworld test_project

若要匯出專案的一個 Snapshot,請使用 <project_name> <snapshot_name>。

bfexport -f helloworld test_project snapshot_1

如果母專案 Snapshot 不是預設專案,您必須指定 <project_name> 且後面跟著 parent 關鍵字,才能匯出母專案 Snapshot。

bfexport -f helloworld test_project parent

選項說明

選項 說明
<project_name> 要匯出的專案名稱。專案名稱或專案 ID 為必要的。如果專案名稱含有空格,則必須用引號括住名稱。

請在指令選項後面指定專案名稱。

<snapshot_name> 要匯出的專案 Snapshot 名稱;專案名稱為必要的,其語法如下:
<project_name> <snapshot_name>

請在指令選項後面指定專案名稱和 Snapshot 名稱。如果專案或 Snapshot 名稱含有空格,則必須用引號括住名稱。

<project_id> 要匯出之專案的 ID。專案 ID 為一個 UUID。專案 ID 或專案名稱為必要的。

請在指令選項後面指定專案 ID。

-f <file_name> bfexport 輸出用的 XML 檔名稱。如果您沒有提供路徑名稱,則會採用現行工作目錄。如果檔名包含空格,必須用引號括住名稱。

如果您沒有提供檔名,則會將 bfexport 輸出傳送至標準輸出。

註: 標準輸出僅供檢視用。請勿將標準輸出重新導向至檔案;產生的檔案含有記載訊息,因此無法作為 bfimport 指令或使用者介面匯入公用程式的匯入檔。
parent 如果母專案 Snapshot 不是預設的專案 Snapshot,則必須使用這個關鍵字,來匯出母專案 Snapshot。

請在專案 Snapshot 名稱後面指定 parent 關鍵字:

bfexport -f helloworld test_project parent
-l 依名稱和專案 ID,列出資料庫中的專案。-l 選項不能搭配其他選項使用。
-c "<comment>" 併入註解。您必須用引號括住註解(例如 "my project version 50")。註解會新增至 <buildforge> XML 元素。
-g 將隸屬於指定來接收通知之存取群組的使用者,儲存至 XML 檔。使用者及其內容會列在 <user> XML 元素中。需要 -s。
-s 將定義在「管理主控台」中的伺服器,儲存至 XML 檔。伺服器及其內容,連同任何相關聯的 <auth> 和 <collector> 資訊,都會列在 <server> XML 元素中。
-L 將定義在使用者介面中的 LDAP 網域控制器,儲存至 XML 檔。LDAP 網域控制站及其內容會列在 <ldap> XML 元素中。
-n 將指派給專案和步驟的通知範本,儲存至 XML 檔。通知範本及其內容會列在 <mail-template> XML 元素中。
-C 將針對專案指派給伺服器的收集器,儲存至 XML 檔。收集器及其內容會列在 <collector> XML 元素中。需要 -s。

疑難排解

如果您遇到的是找不到報告檔案或程式庫的錯誤,請確定已正確地設定程式庫路徑。

正確的設定位於 <bfinstall>/rc/buildforge 中。請檢查程式庫路徑變數,以及在該檔案中設定的其他變數。視需要重設它們,然後匯出它們。


意見