設計範本並以 Rational ClearQuest 作為資料來源

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

開始之前

提示: Rational® Publishing Engine 安裝架構包含一組範例報告。在您開始發佈文件之前,您可以探索這個範例文件產生實務。請參閱建立 REST 範例範本
熟悉 Rational ClearQuest® REST 服務,以及利用 Rational Publishing EngineRational ClearQuest 擷取資料所需要的各種 URL。請參閱關於 Rational ClearQuest 資訊中心

關於這項作業

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

程序

  1. 如需範本開發程序的概觀,請檢閱設計文件範本 開始規劃您文件的結構以及可能包含的資料。 舉例來說,決定最終文件要從一個範本產生,或是從各含有可重複使用的內容片段的多個範本檔產生。
  2. 在 Document Studio 應用程式中,建立文件範本
  3. 將資料來源綱目新增至文件範本。 對於 Rational ClearQuest,您可以輸入應用程式的基本 URL,來探索資料來源綱目。
    1. 開啟適用於您 Rational ClearQuest 版本的綱目探索精靈
      • 若為使用 REST 第 1 版的舊版 Rational ClearQuest,請按一下資料 > 綱目探索 > REST 綱目探索
      • 若為使用 REST 第 2 版的新版 Rational ClearQuest,請按一下資料 > 綱目探索 > REST 第 2 版綱目探索
    2. 指定資源的基本 URL
      • 若為 Rational ClearQuest REST 第 1 版,Rational Publishing Engine 會使用 Rational Data Services 來探索綱目和查詢資料。Data Services 的基本 URL 是:https://server:port/DataServices/ClearQuest
      • 若為 Rational ClearQuest REST 第 2 版,則是從 ServiceProvider URL 啟動。使用者可以造訪 Rational ClearQuest REST 第 2 版 ServiceCatalog URL(例如 https://server:port/context/oslc)來取得 ServiceProvider URL。 請將 HTTP 標頭 OSLC-Core-Version 設為 2.0,並接受 application/rdf+xml。 您可以在傳回的結果中找到 ServiceProvider URL rdf:about
        如果您使用 REST 第 2 版 API 來產生文件,您必須提供服務提供者(而不是根項目)的資料來源綱目 URL。範例:
        • 不正確:https://server:port/cqweb/oslc
        • 正確:https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
    3. 從清單中選取鑑別類型 如果您沒有選取類型,則會測試每一種類型,直到找到正確的類型,但這可能增加文件產生時間。
    4. 如果資源位於安全伺服器,請指定使用者名稱。
    5. 如果資源位於安全伺服器,請指定密碼
    6. 下一步 您輸入的基本 URL 中會自動附加 ?metadata=schema。 範例:https://server:port/service/cq/records/defects?metadata=schema
    7. 按一下完成 您選取的資料來源綱目會顯示在「資料來源綱目」視圖中。
  4. 將元素新增至範本。 Rational Publishing Engine 有一組綜合性的範本元素,可供您用來建立文件結構。您可以將元素拖曳到範本內容編輯器中。例如,您可以新增「儲存器」元素,來保留數個段落。每一個段落可能由一個測試條件控制,且該測試條件只讓它與特定的資料產生關聯。如需相關資訊,請參閱「選用區」視圖中的範本元素新增元素至範本
  5. 利用查詢屬性變數,將資料新增到範本中。這些項目指定要在報告中產生的資訊片段。
  6. 格式化和樣式新增至元素,來控制如何在輸出中顯示它們。
  7. 建立過濾器,來縮小要取出到報告的資料。 您可以利用過濾器(一般資料來源 URI 的詳細版本)來指向特定的資料子集,以免 Rational Publishing Engine 在產生報告期間嘗試從資料來源擷取非必要的資訊。 這些過濾器必須範圍夠大,足以擷取範本所參照的所有必要資料,否則,產生的報告無法包括完整的資料。

    Rational ClearQuest 配接器支援使用「可報告的 REST 第 1 版」資料來源中的原生過濾。 在「可報告的 REST 第 1 版」原生過濾器中,您只需在方括弧 [] 之間輸入文字。過濾器的其餘部分由 Rational Publishing Engine 產生。 如需相關資訊,請參閱 可報告的 REST 第 1 版

    沒有配接器的 Rational ClearQuest 第 8 版支援從可報告的 REST 第 2 版資料來源進行原生過。如需相關資訊,請參閱 Rational ClearQuest OSLC CM REST API

    變數過濾器範例:
    cq:Product{cq:Product="${productName}") 
    解析後的過濾器範例,其中 productNameRational Publishing Engine
    cq:Product{cq:Product="Rational Publishing Engine")
    註:
    • 只有在需要時,才會對資料來源發出要求。例如,您可以使用條件,使得只有包含資料的元素才會顯示在輸出中。對儲存器元素的條件可以是 variable == "true"。如果不符合這個條件,表示沒有資料符合變數條件,也不會對資料來源發出要求。
    • 您可以在發出要求之前先計算原生過濾器。在發現查詢之處,就會計算原生過濾器,並使用該處的變數值。因此您可以在範本中執行計算,而這會影響原生過濾器。
  8. 建立排序,來組織您報告中的資料。

意見