系統會監視下列的變數名稱。當步驟的環境包含其中一個變數時(不論是具體的或是繼承自專案或伺服器),就會執行動作。
變數 |
內容 |
---|---|
_CI_BUILD_DELETE |
將此變數設為任何值,以便在工作執行之後,刪除該建置及相關聯的建置資料。(如果沒有執行其他專案建置,標籤變數便會重設為刪除建置之前的起始值)。 |
_CI_BUILD_KEEP |
將此變數設為任何值,在工作執行之後保留該建置及相關建置資料。例如,如果您的工作包含配接器鏈結,當配接器步驟失敗時,並不會執行其他專案步驟。舉個例說,這時候您可能希望保留該工作的一份建置記錄副本,作為除錯用。 |
CLEARCASE_VIEW |
啟動指定的 ClearCase 視圖。這個變數中指定的視圖必須存在,而且使用這個變數的步驟必須設為 "absolute"。在執行 Microsoft Windows 的系統中,這個變數必須搭配 bfagent.conf 中代理程式的 cc_suppress_server_root 配置選項來使用。 |
_CLEARCASE_VIEWS |
指定指令執行之前要啟動的 ClearCase 視圖清單。將此值設定為以逗點區隔的視圖清單;例如,"View1,View2,View3"。 |
_CLEARCASE_VOBS |
指定指令執行之前要裝載的 ClearCase VOB 清單。將此值設定為以逗點區隔的 VOB 清單;例如,"\Vob1,\Vob2,\Vob3"。 |
_CONTEXT_LOG_RANGE |
使用此變數將日誌輸出限制為接近過濾相符項的行數。它接受正整數值,而且會使系統省略除了下列項目以外的日誌輸出:命中的每一個過濾字串附近的行號,其大小相當於此變數的值。例如,如果您將變數設為 5,則日誌只會顯示含有過濾相符項的字行,以及這些相符項的前面 5 行和後面 5 行。 註: 這個變數僅用於 Perl 引擎專案。
|
_ERROR_THRESHOLD |
建立接受的錯誤數上限(您定義的「設定失敗」過濾器所捕捉的錯誤)。您可以利用這個變數,來建立個別步驟或一個專案的失敗和訊息臨界值。 請使用下列其中一種格式:
當您在步驟中使用變數時,系統會在個別步驟中計算錯誤。其他可用的格式有:
附註:此變數計算的錯誤會定義為利用「設定失敗」動作符合過濾器的字串,且它們已指派給專案中的步驟。過濾器已識別為失敗的每一個字串,將在步驟總計中算一個錯誤,也在專案總計中算一個錯誤。 |
_EXITCODE_MAP |
指定系統應接受為步驟成功指標的數字清單(以逗點、空格、分號或冒號區隔)。依預設,結束碼 0 表示成功;指定此變數之後,它所列出的任何值也表示成功。 |
_InterfaceLoggingLevel |
控制當 Build Forge 執行配接器步驟時,要記載多少日誌資料。請在您的配接器環境中建立一個環境變數,將它命名為 _InterfaceLoggingLevel。然後指派 0 到 8 的一個整數值給它。記載層次也包含在內,例如,層次 2 包含層次 1 和層次 0 的資訊。
|
_LOG |
指定路徑名稱以建立包含 Build Forge Agent 原始輸出的日誌檔。 註: 這個日誌不包含時間戳記(除非您還指定了 _LOG_TIMESTAMP)。這個檔案中的日誌資料格式通常如下所示:代理程式碼、日誌儲存區和訊息。
請使用此變數,在伺服器上儲存工作日誌的副本。如果該檔案存在,系統會附加在它後面。 |
_LOG_TIMESTAMP |
以時間戳記作為從 _LOG 輸出的每一行的字首。這個變數的值應該是採用 strftime 語法的格式字串,此語法與 .date 和 .gmdate 環境指令所使用的語法相同。 註: 需要有 _LOG。
|
_MAP |
如需如何使用此變數的一些討論,請參閱對映 Windows 磁碟機。 |
_NO_PREPARSE_COMMAND |
系統通常會在傳送指令至代理程式之前試圖解析環境變數的值。當您定義 _NO_PREPARSE_COMMAND 變數(及任何值)之後,系統會將變數傳送至代理程式,而不解析它們。使用此變數可確保作業系統 Shell 會處理變數。 |
_PRISM_DIR_POSTCMD |
搭配使用 IDE 的外掛程式。它可以指定一個指令,在執行專案步驟之後,對目錄執行此指令。請參閱測試專案的特殊變數。 |
_PRISM_DIR_PRECMD |
搭配使用 IDE 的外掛程式。它可以指定一個指令,在目錄複製到專案步驟的伺服器之前,對這些目錄執行這個指令。請參閱測試專案的特殊變數。 |
_PRISM_FILE_POSTCMD |
搭配使用 IDE 的外掛程式。它可以指定一個指令,在執行專案步驟之後,對檔案執行此指令。請參閱測試專案的特殊變數。 |
_PRISM_FILE_PRECMD |
搭配使用 IDE 的外掛程式。它可以指定一個指令,在檔案複製到專案步驟的伺服器之前,對這些檔案執行這個指令。請參閱測試專案的特殊變數。 |
_SUPPRESS_ENV_OUTPUT |
指定系統會省略來自日誌的環境訊息。依預設不會設定此變數,而且會先列印環境中的所有變數值,之後再執行步驟指令。這些值在步驟日誌中會顯示為 ENV 項目。這個變數可以設為下列值:
|
_SUPPRESS_AGENT_LOG_OUTPUT |
設為 1 時,可以防止代理程式將日誌資料傳送至引擎。與 _SUPPRESS_LOG_OUTPUT 相比,其中的日誌資料是從代理程式傳送,但被引擎捨棄。 註: 使用這個變數會時,不會進行過濾器比對。
|
_SUPPRESS_LOG_OUTPUT |
將此變數設為任何值會導致引擎捨棄幾乎所有從代理程式收到的日誌輸出。仍會保留部分主控台記錄。會顯示過濾相符項。 |
_TIMEOUT |
這個值會置換專案中的一個步驟或所有步驟的 Timeout 內容。 |
_TRAP |
現行步驟失敗時執行的字串;此字串可設為執行檔或指令的名稱。附註:指令輸出不會傳回至主控台,因為當步驟失敗時,主控台和代理程式之間的連線會關閉;如果您想要保留透過 _TRAP 發出的指令輸出,請讓該指令將其輸出寫入檔案以供稍後擷取。 |
_USE_BFCREDS |
若設為 1,系統會使用使用者的 登入認證來登入伺服器,而不是儲存在附加至伺服器的伺服器權限中的認證。系統會使用啟動專案的使用者的「管理主控台」登入認證,來執行專案中的指令。您可以對單一步驟設定此變數,或對整個專案設定。
註: 如果您使用 LDAP/Active Directory 鑑別,則必須將在本端儲存使用者鑑別系統設定設為「是」(預設值),_USE_BFCREDS 函數才能運作。若設為「是」,則系統會快取加密格式的使用者鑑別資訊,然後存取要使用於_USE_BFCREDS 的使用者鑑別資訊。
提示: 如果是在 Windows 上,請考慮同時
設定 _USE_BFCREDS_DOMAIN 變數。
|
_USE_BFCREDS_DOMAIN(僅適用於 Windows) |
若設為 1,系統除了使用 _USE_BFCREDS 用來登入伺服器的登入認證外,還會使用使用者的 網域。 |
_XSTREAM_PROTOCOL type |
在代理程式之間啟用直接檔案傳送。 重要: 在某些作業系統上,代理程式對於直接檔案傳輸的支援有限,甚至不支援。請參閱配置代理程式之間的直接檔案傳輸。
引擎、傳送代理程式及接收代理程式必須全都支援直接檔案傳送。如果有任一個不支援,則會忽略 _XSTREAM_PROTOCOL 且沒有任何警告,然後使用正常的檔案傳送方法。 接收代理程式必須能夠在傳送代理程式主機上建立 TCP 連線。如果它們存在,則必須將防火牆配置為容許連線。 通訊協定類型能決定編碼資料的方法,並且為下列其中一項:
|