設計範本並以 IBM Rational Team Concert 作為資料來源

報告設計者可以使用 Document Studio 來匯入資料來源綱目,並建置報告範本。

開始之前

提示: Rational® Publishing Engine 安裝架構包含一組範例報告。在您開始發佈文件之前,您可以探索這個範例文件產生實務。請參閱建立 REST 範例範本
熟悉 Rational Team Concert REST 服務,以及當您利用 Rational Publishing EngineRational Team Concert 擷取資料時所需的各種 URL。請參閱可報告的 REST API Wiki:Rational Team Concert 提供的資源
Rational Team Concert 可報告的 REST API 有別於許多傳統的網域 API。相對於提供指向特定項目(例如,單一工作項目或單一建置結果)的資源 URL,可報告的 REST API 是提供整體資源的存取。每一個整體資源各是一個儲存器資源,其代表一或多個元素的查詢結果。
  • foundation:「共用」構件,例如,專案區域、團隊區域、貢獻者、反覆運算和鏈結。
  • workitem:「工作項目」構件,例如,摘要、種類、嚴重性和優先順序。
  • apt:「敏捷規劃」構件,例如,團隊產能、資源排程和缺勤狀況。
  • generic:「通用」構件。
  • build:「建置」構件,例如,建置結果、建置結果要素項、建置定義和建置引擎。
  • scm:「來源控制」構件,例如,串流和元件,以及串流調整大小差異。
這些資源讓您在收集報告資料時,更具有過濾和查詢彈性。舉例來說,視傳遞給 REST API 的查詢或過濾器而定,工作項目資源可能包含與工作項目相關的一或多個元素。

關於這項作業

資料是用 REST API 來擷取。這個介面由資料來源應用程式安裝與實作,並與 Rational Publishing Engine 分開運作。如需該資料來源的 REST API 相關資訊,請參閱該資料來源的說明文件。

程序

  1. 如需範本開發程序的概觀,請檢閱設計文件範本 開始規劃您文件的結構以及可能包含的資料。 舉例來說,決定最終文件要從一個範本產生,或是從各含有可重複使用的內容片段的多個範本檔產生。
  2. 在 Document Studio 應用程式中,建立文件範本
  3. 將資料來源綱目新增至文件範本。 對於 Rational Team Concert,您可以輸入應用程式的基本 URL,來探索資料來源綱目。
    1. 在 Document Studio 中,按一下資料 > 新增資料來源綱目
    2. 綱目類型中,從清單中選取綱目的類型。 針對 Rational Team Concert,選取 REST
    3. 綱目檔欄位中,貼上您識別為資料來源綱目的 URL。
      • https://server:port/ccm/rpt/repository/foundation
      • https://server:port/ccm/rpt/repository/workitem
      • https://server:port/ccm/rpt/repository/apt
      • https://server:port/ccm/rpt/repository/generic
      • https://server:port/ccm/rpt/repository/scm
      • https://server:port/ccm/rpt/repository/build
    4. ?metadata=schema 附加到 URL 尾端。
      • 範例:https://server:port/ccm/rpt/repository/workitem?metadata=schema
    5. 資料來源 ID 欄位中,輸入範本中資料來源的名稱。下一步
    6. 如果資源位於安全伺服器,請指定使用者名稱。
    7. 如果資源位於安全伺服器,請指定密碼
    8. 從清單中選取鑑別類型 對於 Rational Team Concert,鑑別類型是 OAuth。如果您沒有選取 OAuth,則會測試每一種鑑別類型,直到找到正確的類型,但這可能增加文件產生時間。
    9. 按一下完成 您選取的資料來源綱目會顯示在「資料來源綱目」視圖中。
  4. 將元素新增至範本。 Rational Publishing Engine 有一組綜合性的範本元素,可供您用來建立文件結構。您可以將元素拖曳到範本內容編輯器中。例如,您可以新增「儲存器」元素,來保留數個段落。每一個段落可能由一個測試條件控制,且該測試條件只讓它與特定的資料產生關聯。如需相關資訊,請參閱「選用區」視圖中的範本元素新增元素至範本
  5. 利用查詢屬性變數,將資料新增到範本中。這些項目指定要在報告中產生的資訊片段。
  6. 格式化和樣式新增至元素,來控制如何在輸出中顯示它們。
  7. 建立過濾器,來縮小要取出到報告的資料。 您可以利用過濾器(一般資料來源 URI 的詳細版本)來指向特定的資料子集,以免 Rational Publishing Engine 在產生報告期間嘗試從資料來源擷取非必要的資訊。 這些過濾器必須範圍夠大,足以擷取範本所參照的所有必要資料,否則,產生的報告無法包括完整的資料。 Rational Team Concert 支援在原生過濾器中使用「可報告的 REST 第 1 版」資料來源。如需相關資訊,請參閱 Jazz.net 上的 Reportable REST API 範例:
    [projectArea/name="JKESample"]/*
    解析後的要求:
    https://server:port/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    註: 並非所有欄位都可以用來進行原生過濾。
  8. 建立排序,來組織您報告中的資料。

意見