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

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

開始之前

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

關於這項作業

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

程序

  1. 如需範本開發程序的概觀,請檢閱設計文件範本 開始規劃您文件的結構以及可能包含的資料。 舉例來說,決定最終文件要從一個範本產生,或是從各含有可重複使用的內容片段的多個範本檔產生。
  2. 在 Document Studio 應用程式中,建立文件範本
  3. 識別資料來源中的資料來源綱目。
    • 如果要從 Rational Quality Manager 專案,新增集合中的特定資料片段(例如:測試案例詳細資料或測試 Script),或是使用已知 URL 來存取單一資源,請建構一個使用 feed 引數的 URL。您將一律使用這個綱目,並從 Rational Quality Manager 專案動態將它配置給您範本中的特定資料片段。
      • 範例:https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • 如果要從 Rational Quality Manager 專案,新增個別資源中特定的資料片段(例如:測試案例詳細資料或測試 Script),或是使用已知 URL 來存取單一資源,請建構一個使用 qm 引數的 URL:
      • 範例:https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • 如果您使用 REST 第 2 版 API 來產生文件,您必須提供服務提供者(而不是根項目)的資料來源綱目 URL。範例:
      • 不正確:https://server:port/qm/oslc_qm/catalog
      • 正確:https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
  4. 將資料來源綱目新增至文件範本。 對於 Rational Quality Manager,您可以完成下列步驟:
    1. 在 Document Studio 中,按一下資料 > 新增資料來源綱目
    2. 綱目類型中,從清單中選取綱目的類型。 針對 Rational Quality Manager,選取通用 XML
    3. 綱目檔欄位中,貼上您識別為資料來源綱目的 URL。
    4. ?abbreviate=false 附加到 URL 尾端。
      • 範例:https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    5. 資料來源 ID 欄位中,輸入範本中資料來源的名稱。下一步
    6. 如果資源位於安全伺服器,請指定使用者名稱。
    7. 如果資源位於安全伺服器,請指定密碼
    8. 從清單中選取鑑別類型 對於 Rational Quality Manager,鑑別類型是 OAuth。如果您沒有選取 OAuth,則會測試每一種鑑別類型,直到找到正確的類型,但這可能增加文件產生時間。
  5. 將元素新增至範本。 Rational Publishing Engine 有一組綜合性的範本元素,可供您用來建立文件結構。您可以將元素拖曳到範本內容編輯器中。例如,您可以新增「儲存器」元素,來保留數個段落。每一個段落可能由一個測試條件控制,且該測試條件只讓它與特定的資料產生關聯。如需相關資訊,請參閱「選用區」視圖中的範本元素新增元素至範本
  6. 利用查詢屬性變數,將資料新增到範本中。這些項目指定要在報告中產生的資訊片段。
  7. 格式化和樣式新增至元素,來控制如何在輸出中顯示它們。
  8. 建立過濾器,來縮小要取出到報告的資料。 您可以利用過濾器(一般資料來源 URI 的詳細版本)來指向特定的資料子集,以免 Rational Publishing Engine 在產生報告期間嘗試從資料來源擷取非必要的資訊。 這些過濾器必須範圍夠大,足以擷取範本所參照的所有必要資料,否則,產生的報告無法包括完整的資料。 請參閱Rational Quality Manager可報告的 REST API,以取得相關資訊。
  9. 建立排序,來組織您報告中的資料。

意見