CodeBeamer快速上手指引
Version 192   (Nov 18 2008 17:45 by yslin) | 69 comments and attachments   (Nov 18 2008 15:58 by yslin) | 1 child page
PropertiesShow Parent
Tags:   CodeBeamer入門文件 All Tags...

CodeBeamer快速上手指引

介紹

CodeBeamer為入口網站形式的軟體開發平台,具備多種開發團隊所需的協同作業功能。 利用CodeBeamer,團隊能跨地域跨組織合作,增進組織互動,提昇使用CodeBeamer組織的競爭優勢。不僅團隊成員間的合作更密切, 也更密切與組織內相關部門或組織外的客戶、合作夥伴協同合作。

CodeBeamer適合各種開發團隊採用,開發範圍如企業內IT、政府銀行等的系統專案、套裝軟體、嵌入式系統開發、IC設計等,只要產出版本變動頻繁或需跨地域溝通協調的團隊,CodeBeamer皆可扮演很不錯的溝通協調平台。

在使用前先看看CodeBeamer知識基礎/CodeBeamer快速上手指引/CodeBeamer快速導覽吧。

開始設定系統

安裝CodeBeamer

請參考CodeBeamer知識基礎/如何安裝

設定CodeBeamer

請參考CodeBeamer知識基礎/Configuration How-to完成設定

當完成CodeBeamer的設定後,請注意CodeBeamer伺服器必須先啟動(Start)過後, 使用者才有可能由其電腦的I.E.或FireFox等網路瀏覽器登入CodeBeamer網頁。如果您是在CodeBeamer伺服器所屬的網域外登入,請採用SSL登入(Login via SSL)。新裝好的CodeBeamer原始設定的系統管理者ID和PW為bond與007。

建立CodeBeamer群組(Group)和使用者帳號(User Account)

CodeBeamer需要以使用者帳號登入才能參與整個協同作業過程。系統管理者(System Administrator)可以開放讓使用者自己建立帳號,也可以統一由系統管理者建立所有使用者帳號。 當系統管理者登入CodeBeamer後,將看到頁面右上方有System Admin的選項,點進後請選Miscellaneous,即會看到如下畫面。 此畫面的最上方列New Account處有三個選擇:

  • Only accounts with account administration permission can create new accounts (僅讓擁有帳號管理權力者新增帳號)
  • Anybody can create a new Account. Immediate account activation(每個人皆可自行新增帳號. 此帳號立即生效)
  • Anybody can create a new Account. The E-mail address will be verified by E-mail before the Account activation (每個人皆可自行新增帳號. 此帳號必須在e-mail認證過後才生效)



選擇過帳號新增的方式後,請到System Admin的User Accounts設定Groups。如果您為System Administrator,您即會看到下面這個頁面,請點選User Accounts後再按New Account即可新增User Account。

CodeBeamer預設三個Groups: External(外部夥伴)、Regular User(一般使用者)、System Administrator(系統管理者)。 您可以點每個Group列左方的Edit了解每個Group的權限,或變更此Group的名稱與權限。 如果使用團隊需要更多的Group,請按頁面New Group紐,即可馬上新增Group。

如果您使用CodeBeamer知識基礎/CodeBeamer免費版本則沒有Group功能


假設我們想增加一個專案經理(Project Manager)的Group。 請按New Group紐,您即會看到以下表格,然後請填入Group名稱與說明,選擇權限之後請按Create,即完成Group新增。


CodeBeamer的帳號輸入除了以CodeBeamer上的New Account表格一一填入帳號資料外,也可採用CSV Import的方式,或與公司內的LDAP、Active Directory整合,LDAP與Active Directory 的整合。

如果您使用CodeBeamer知識基礎/CodeBeamer免費版本則沒有支援LDAP/Active Directory功能

設定CodeBeamer Outgoing E-mail

帳號設定後,請別忘了先設定CodeBeamer與mail server連結,如此才能啟動CodeBeamer內的資訊變動立即通知相關人的機制。 如果您是系統管理者,您將可以進入右上角System Admin設定Outgoing E-mail。 以下為Outgoing E-mail的畫面。 請和公司的mail server管理者詢問Outgoing SMTP Mail Server應填的位址,並填入CodeBeamer Server 的位址到下方的Server Name,並選擇CodeBeamer Server的Port。

SCM整合

CodeBeamer可以連結CVS與SubVersion,也可就客戶需求整合VSS,PVCS,ClearCase等SCM軟體. CodeBeamer並對CVS/SubVersion支援SCMLoop功能,如果要快速了解SCMLoop功能,可參考CodeBeamer知識基礎/CodeBeamer+SubVersion實務操作手冊

My Start, Account Info, Tags

編輯MyStart頁

當您一登入CodeBeamer,CodeBeamer將帶您到MyStart頁。此頁您可以參考CodeBeamer WIKI Help加入您最常去的網頁連結,也可用CodeBeamer已有的plug-in將您所有相關工作的列表,如

[{Table style='width:100%'

|(padding-bottom:20px;) [{MyOpenTrackerItemsPlugin}]|<
|[{MyApprovalsPlugin}]|
}]

代表

 建議也可以考慮加

[{ProjectList}]

 列出所有參加的專案, 方便以後到MyStart頁即可點選跳到專案的主頁.

Account Info

請確認time zone與e-mail正確輸入, 至於Data Format請與CodeBeamer要整合的系統相同會比較方便。CodeBeamer帳號的Mobile可以填skype帳號, 只要使用者的client端有安裝Skype,點此skype帳號將自動連接Skype系統撥號。

在5.2版起, 每個account可以輸入多個e-mail, 如此可方便此帳號擁有者在多個e-mail可收到notification。 只要在不同的e-mail間加";"即可讓系統同時通知多個e-mail。 

跨專案的Tags以幫助知識管理

CodeBeamer可以讓使用者於系統中的artifact item去Add Tag (通常是在那個item點進去後右上的Actions下拉功能列中)。 如果要總覽所有的Tags與Tags下所有的資訊,在點入My Start頁時,My Start的Tab附近有個叫Tags的Tab, 點入即可看到所有大家經年累月的整理。

Trackers的Add Tag功能鍵於每個issue頁右上Actions的下拉選單中, Documents的文檔(File)的Add Tag在文檔的Property頁右上Actions的下拉選單中, Forums的Add Tag在其每個Topic頁的右上Actions的下拉選單中。  

開始設定專案

新增專案與專案列表

將滑鼠移到Projects TAB上, 您將看到Browse Projects和Recent Projects。點Browse Projects,將帶您到專案瀏覽頁,也可直接點Recent Projects上的任何一個專案名稱, 則直接帶您到點選專案的入口頁(WIKI)。 在專案瀏覽頁,您可在權限內New Project或New Working Set,並設定專案所屬的Working Set。 也可選擇看到所有自己權限內可看到的專案(All Projects),或參與的專案(My Projects),或哪一Working Set的專案,另外也可以Customize,方便整理專案所屬的Working Set。



CodeBeamer的New Project時可以讓您挑選系統中您可接觸的專案template成為新增Project的設定。如果您是在Project List View被設定在某個working set下做New Project,此時可挑選的project template僅限於此working set下的projects。

每個專案的工具

新增專案後, 點入專案, 您將看到上方一整列的TAB:個人起始頁(My Start)、專案(Projects)、維基(WIKI)、文件管理(Documents)、事件追蹤(Trackers)、建構管理(CMDB)、報告(Reports)、群組討論(Forums)、聊天室(Chats)、軟體建構(Builds)、原始碼瀏覽分析(Source Code)、專案成員管理(Members)、專案管理(Admin)。


建構管理(CMDB)為選擇的功能,非標準功能

建立專案成員與角色

如果您使用CodeBeamer知識基礎/CodeBeamer免費版本則沒有專案角色功能
請到所要工作的專案, 如果您有設定此專案的成員與角色的權限,您將會看到上面有個叫Members的TAB, 請按此進入成員與角色的設定區。



建立專案的入口頁:WIKI

每個專案的維基頁為每個專案的入口頁。對於每個WIKI頁,您可以按左上角的Edit, 或到某個wiki頁中有出現[edit]的段落做編輯(如果您有WIKI編輯權限)。 WIKI編輯的方法有兩種, 一種是WYSIWYG(即見即所得)的方法, 一種是Wiki Markup的方法。如下圖, 當您點WYSIWYG, 將出現一排工具列, 您再點最右邊的圖形icon, 則會帶出第二排工具列. 您只要移鼠標到icon上, 即會出現此icon的功能說明文字。  當您在編輯WIKI頁時, CodeBeamer在編輯頁面皆會出現Help, 您可以隨時點入參考。也歡迎參考CodeBeamer知識基礎/Q&A/Wiki Q & A, 或點入每個在此專案的WIKI頁, 按Edit, 選擇Wiki Markup的format, 您即可看到這些WIKI內容是如何寫的。

如果您要加圖,請先把圖由此頁上方顯示comments and attachments數量的link進去加attachments,然後在WIKI編輯頁放圖的位置寫入 [!圖檔全名!] 即可。如果您想加圖到右側副頁中, 請點其properties, 再點其comments and attachment加入圖檔後, 如上述加圖的寫法,即可順利加圖進去。 請注意圖的大小請先調整適當再加入。 

 

CodeBeamer在5.0版起, 新增許多Wiki Plugin, 這些Plugin在專案建立時將自動出現在專案的WIKI首頁。 這些Wiki Plugin如 [{ProjectInfoPlugin}],[{RecentTrackerItemsPlugin}] , [{CommitStatisticsPlugin}], [{SourceCodeSummaryPlugin}] , [{MembersPlugin}], [{RecentNewsPlugin}], [{RecentBuildsPlugin}], [{RecentDocumentsPlugin}] 等,其中較窄的資料如[{MembersPlugin}], [{RecentNewsPlugin}], [{RecentDocumentsPlugin}] 也可考慮移到右方的副頁。



若您要在此網頁加子頁的話, 可以按此頁上方顯示child pages數量的link進去加子頁。每個WIKI頁的權限(permissions)跟變動通知設定(notification)請按左上Properties進去點選設定。 建議您在做完child pages後, 到link需放置的地方Edit, 運用WYSIWYG的編輯模式, 點選Insert Interwiki Link from History, 再點選要插入的項目,即馬上寫入此連結的Wiki頁名稱與連結。 如果您是在Wiki Markup的模式下編輯, 您可運用右上方的History查到剛寫過的[WIKIPAGE#], 然後將這些link放到右側副頁或相關內容中。 

CodeBeamer的WIKI可被輸出為PDF檔案。

CodeBeamer的WIKI有Edit lock的功能, 如果您有權限編輯, 按Edit後卻看不到SAVE的icon, 此表示這個文件正在被別人編輯中

建立專案中的事項追蹤(Trackers)

CodeBeamer可以讓您任意開各種Tracker(Bug Tracker, Change Request Tracker, Task Tracker, Requirement Tracker, Meeting Tracker, Release Tracker....), 也可以將所有原始設定的Tracker都改名成專案所需做的Tracker 。 對於開發型的專案, 我們建議加一個叫做Release的Tracker, 專門做Release的追蹤與管理。

 在Tracker名稱旁的下引號與進入Tracker後第一頁右上角的Actions中,您將可以找到設定Tracker欄位,流程,權限,metadata的Customize連結 。此外,也有從外層直接按New Issue的連結,減少操作的步驟。




CodeBeamer的Tracker可讓使用者篩選欄位條件找列出想看的所有issues。

請按上圖"more details"的連結,您將看到所有可篩選的欄位,或您也可以設定常用的tracker view,只要在Tracker list上方的Filter旁按New,即可設定常用的tracker view。 以下為按New之後的條件篩選畫面:


並非每種Tracker都需要Workflow, 所以CodeBeamer讓您可以到每個Tracker的Customize的General設定區選擇是否要Workflow, 如果您勾選Workflow, Workflow Transitions的TAB將會出現。


如果您使用CodeBeamer知識基礎/CodeBeamer免費版本則沒有Workflow功能


請參考CodeBeamer知識基礎/Tracker的Transition Workflow 規劃與應用-以Bug 追蹤流程為案例做Workflow的設定.

在Customize那頁,General的設定除了決定此Tracker是否要用workflow之外, 還要注意此Tracker的Type, 因為您選擇的Type, 將會決定此Tracker中的資料丟到哪個統計運算中。CodeBeamer會幫您做專案的Open/Close Task, Estimated/Spent Hours, Bugs by Category, Bugs by Date, Bugs per KLOC, Bugs by Severity, Bugs by Age, Estimated and Spent Task Efforts in Hours, Requirements with Cummulative Change, Gantt Chart, ......etc。 

5.2版以後, CodeBeamer的Field可以無限增加, 且Field的format更多, 如您也可以做multiple choice, 只要在Field Properties中的欄位中挑選choice型式的欄位, 給與欄位名稱(可以寫中文或任何utf-8支援個文字), 並勾選旁邊的multiple, 您將可以做多選的欄位。

 

另外, CodeBeamer的choice選項內容可以是Static的,由負責製定此tracker的人輸入固定的選項(請到Choice Lists去寫入,CodeBemer可讓您輸入無限的choice list items), 也可以由其他的Tracker種類中的所有tracker items來做選項。 此可以運用的情況如一個Bug Tracker的表單, 需要有此Bug的”回報客戶"的資料, 所以我們可以在表單中加一個choice field, 讓填表人挑選回報此Bug的客戶名, 挑選單可來自另一個叫做”客戶名單管理”的Tracker, 裡面的tracker items由sales動態輸入客戶的資料.此欄位選的資料, 將可以讓讀者馬上點選連結到選項的tracker item內容,即客戶名單管理中的表單資料, 有可能包含客戶的公司名, 聯絡人,聯絡電話,e-mail, 參與的專案等等。如果您有加購CMDB模組, CMDB的Category, 也有類似Tracker的功能. 以下圖中的Items from Category在CMDB中才有用, 如果您要在Tracker加此類的field設定, 請挑選Items from Tracker。

 

Field Properties製定完後, 請到Permissions與Field Access去勾選所有角色的權限。

CodeBeamer的每個tracker item(issue)除了comment, association, attachment之外, 還可以做SCMLoop的issue與commit code連結的功能, 請參考CodeBeamer知識基礎/CodeBeamer+SubVersion實務操作手冊Permission denied [DOC:7392]

5.2版起, CodeBeamer的每個tracker  item (issue)可以再加無限層的sub-issue。 請到每個issue的Children去New Child。 

此外,5.2版起,CodeBeamer的每個tracker  item (issue)將自動將所有related issues表列秀出, 請參考Related Issues說明

 

  • 5.2版起, CodeBeamer的notification mail可以讓使用者直接reply mail,即將其reply的內容貼入相對的CodeBeamer Tracker Item 的comment中
  • 為維護統計資料的長期一致性, Tracker的Type必須在新增的時候選擇正確,且不容許以後修改時變更,所以修改置換Tracker的名稱和敘述時(請到TrackerCustomize/General修改),請挑選同Type的Tracker才可做修改,或另外New Tracker,對於不需要的Tracker,請到其Customize/General按Delete鍵即可刪除. 

建立專案的文件(Documents)



建立專案的論壇(Forums)


5.2版起, CodeBeamer的notification mail可以讓使用者直接reply mail,即將其reply的內容貼入相對的CodeBeamer Forum Topic 的thread中

專案報告

每個專案的Trackers具有依權限範圍顯示的即時趨勢報告(Trends)、狀況與嚴重度的統計(Reports by Status & Severity)和甘特圖(Gantt Tasks)





另外於Source Code也有程式碼變化報告(Commit History, Code Changes Trends)。


CodeBeamer也提供篩選條件制作報告的功能, 請選Reports TAB, 將可選擇Single Reports或Merged Reports。 Simple reports(簡明報告)將依專案與Tracker一一表列符合條件的事件;Merged reports(綜合報告)則是將所有符合條件的列在同一表單中,不特別標出專案和Tracker的名稱。


Template

為了節省您的專案或Tracker的設定時間,CodeBeamer可以讓您於新增專案時選擇之前已設定過的專案或在新增Tracker時選擇之前已設定過的Tracker。 專案的Template繼承包含專案的角色,所有Trackers和Forums的設定。 Tracker的Template繼承則包含field、permission、workflow的設定。 在5.2版以前, 繼承的Tracker Template不會隨著源頭變動而變動。


5.2版起, 系統原始設定改成新增的Tracker如繼承某Tracker Template, 當母template變動時, 所有繼承它的tracker設定也將都跟著變動。如果您只想要copy此template, 不需要當母template變動時其也跟著變動的話, 請在Add New Tracker時選擇Template Tracker後, 在其旁邊的”Do not inherit template configuration: Make a copy”打勾。

 

更多詳細使用說明, 請參考User Guide

 諮詢服務

如果您使用上有任何問題,歡迎與嵌藝創研軟體科技聯絡

e-mailinfo@esast.com
電話886-3-5588567
傳真886-3-5584315
網站http://www.esast.com
線上問答Feature Request or Question