80 likes | 210 Views
OSLC Reporting POC implementation. Dragos Cojocari March 2010. Purpose. Verify that RPE can consume data using the OLSC Reporting Specification 1.0 Scope Defined by http://open-services.net/bin/view/Main/ResourceQuery#spec Main objectives Validate query language
E N D
OSLC ReportingPOC implementation Dragos Cojocari March 2010
Purpose • Verify that RPE can consume data using the OLSC Reporting Specification 1.0 • Scope • Defined by http://open-services.net/bin/view/Main/ResourceQuery#spec • Main objectives • Validate query language • Validate automatic result set schema construction
Solution • The main features of the POC are: • Manual input of resource shape definition • Graphic query building • Automatic construction of result set schema • Request data from the source provider using the built query • The tool will be built as a standalone tool. • The tool will have a single UI screen to allow the user a global view at all times • allows an immediate validation of the query building and the construction of the result set schema • most bits of the POC can be immediately integrated in RPE • the POC can be used as a reference implementation as well as a simple test tool for providers.
Resource shape definition • Entered as XSD • The user will point the tool to an XSD file • Entered visually using a tree editor that supports adding nodes of type “element” and “attribute” • The resources will be of two types: list and simple. Is this needed? • Advantages • Sufficient to validate query building and result set schema construction • decouples the POC from the Resource Shape Definition • prevents hard coding the resource shape definition
Query Building • The user will define the query in the following way: • Define the oslc.prefix for the resource • define the oslc.select and oslc.properties values by selecting the appropriate nodes in the resource shape tree • (optional) type the oslc.where value in a text box • (optional) type the oslc.limit value in a text box • (optional) type the oslc.orderBy value in a text box • The tool will encode the request to valid URL syntax
Construction of result set schema • The tool will create the result schema based on the resource shape definition and the current query value • How is the oslc.prefix reflected in the result set?
Request data from provider • The user needs to define the URL where the query must be sent • ex: https://localhost:9443/testcase • The user needs to provide authentication information: • Credentials • Authentication type ( the POC will support only basic and form based authentication) • The user sends the request by clicking the “SEND“ button • The status and error information of the HTTP requests and responses are provided to the user • The result data is saved in a temporary folder and the link is provided to the user to open it