使用綱目探索精靈來新增 REST 資料來源綱目
您可以為 REST 資料來源建立資料來源綱目。藉由相同的結構,以及相同或類似的屬性清單,建立綱目可簡化模組文件範本的編寫。
關於這項作業
在您使用「
」精靈來建立資料來源綱目時,您可以從您應用程式可能支援的下列兩個可報告的 REST 選項選取:REST API 1.0 或 REST API 2.0。如果您不知道您應用程式支援的 REST API 版本,請向系統管理者詢問。
綱目探索 (REST API 1.0)
程序
在 Document Studio 中,按一下
資料
>
綱目探索
>
REST 綱目探索
。
指定連線詳細資料:
輸入資料來源的
名稱
。
輸入資料來源的
說明
。
指定資源的
基本 URL
。
從清單中選取
鑑別類型
。
如果沒有選取類型,就會測試每一個類型,直到找到正確類型為止。指定類型就不需要執行這項程序。
如果資源位於安全伺服器,請指定
使用者
名稱。
如果資源位於安全伺服器,請指定
密碼
。
按
下一步
。
視您的資料來源是否使用資料服務而定,會顯示下列其中一個視窗:
如果資料來源不使用資料服務,會顯示「
建立資源
」視窗。
輸入新資源的
名稱
。
輸入新資源的
說明
。
輸入新資源的
相對路徑
。
如果 REST 資料來源可透過「報告資料服務配接器」來存取,會顯示「
使用資料服務來尋找
」視窗。
在 XML 綱目樹狀結構中選取元素。
從屬性清單中選取
href
值。
按
下一步
。會顯示所選資源的資源 URL。
選取 URL,然後按一下
完成
,或使用 URL 來尋找子項資源。如果要尋找子項資源,請執行下列動作:
選取資源 URL,然後按
下一步
。
在 XML 綱目窗格中選取元素。
從屬性清單中選取
href
。
若有找到子項資源,請按一下
完成
。精靈已完成,且 URL 會顯示在「配置」視窗中。如果資源位於安全伺服器上,請在配置視窗中輸入使用者名稱與密碼。
綱目探索 (REST API 2.0)
關於這項作業
註:
Rational® Publishing Engine
只支援縮寫的 RDF。提供者必須接受並允許使用
application/xml
要求。請參閱
Open Services for Lifecycle Collaboration 核心規格 2.0 版
.
Rational Publishing Engine
只支援遵循
可報告的 REST 第 2 版規格
的 OSLC 第 2 版提供者
「OSLC 服務」必須已在「服務資源」中,針對您想報告的所有資源,定義「查詢功能」。
用於報告的每一項查詢功能:
必須將
oslc:queryBase
指向一個含有用於報告之資源清單的資源。必須在清單資源的「資源型態資源」中,將清單中的資源識別為
oslc:isMemberProperty
。
必須含有
oslc:resourceShape
,來說明清單資源。
程序
按一下
資料
>
綱目探索
>
REST 第 2 版綱目探索
。
指定連線詳細資料:
指定資源的
基本 URL
。
進一步瞭解 REST 服務提供者 URL
您必須知道您想接受之服務提供者的 URL。這個 URL 是可報告 REST 資料來源之「報告資料服務」應用程式 URL 的對應項目。
Rational Publishing Engine
會從資料來源提取資料來作為查詢清單。可從中查詢及解譯資料的服務會儲存這些資源。該服務也會提供查詢服務,以方便根據一組條件來過濾資料,或精簡其中的部分資料。這些查詢是一種資源類型,可讓您存取特定類型的資源。可報告的 ID2 服務可以顯示各種資源類型,例如:產品或使用者變更要求。查詢服務可協助使用者有效地擷取資料或一部分資料,但查詢服務不是必要的。查詢服務適用於所有資源。每一項產品可以定義其資源以及用來存取這些資源的查詢。
從清單中選取
鑑別類型
。
如果資源位於安全伺服器,請指定
使用者
名稱。
如果資源位於安全伺服器,請指定
密碼
。
按
下一步
。
選取 REST 第 2 版服務和其對應的查詢,然後按
下一步
。
這時會顯示所選服務的內容。
從清單中選取必要的內容,並按一下
測試 oslc.select
。
「
結果確認
」視窗會顯示選取的服務。請確認服務是正確的。如果您按一下
更正
,
測試 oslc.select
欄位狀態會變成
true
。按
下一步
。
測試 oslc.properties
欄位不會經常使用。
在
查詢包含 oslc.where 子句
和
查詢包含 oslc.orderBy 子句
中,您必須只輸入查詢的過濾器或排序子句,例如
cq:Product{cq:Product=
"Rational Publishing Engine"
}
。
按一下
測試 oslc.where
和
測試 oslc.orderBy
,來驗證連線。
Rational Publishing Engine
會使用所定義的選項來建立完整要求。
按
下一步
。這時會顯示查詢的摘要。按一下
完成
。精靈已完成,且 URL 會顯示在「
配置
」視窗中。如果資源位於安全伺服器上,您可以在「
配置
」視窗中提供使用者名稱與密碼。
相關概念
:
資料來源鑑別
相關資訊
:
RESTful Web 服務:基本觀念
意見