ReportingSpecifications < Main

This wiki is locked. Future workgroup activity and specification development must take place at our new wiki. For more information, see this blog post about the new governance model and this post about changes to the website.
TWiki>
Main Web>MainOslcCommonArchitecture>ReportingHome>ReportingSpecifications (21 Mar 2011, TackTong) (raw view)
---+ OSLC Reporting Specification V1.0 - DRAFT

By: The [[ReportingHome][OSLC Reporting Specification Workgroup]]

This is a DRAFT document that is under review. You can help by reviewing carefully, raising issues for discussion on the [[http://open-services.net/mailman/listinfo/oslc-reporting_open-services.net][OSLC Reporting WG mailing list]] and document specific issues that need response on the issues page here OSLCReportingV1Issues.

%TOC{depth="2"}%

---
 <!-- *************************************************************************************** -->

<!--[if !mso]> <style> v\:* {behavior:url(#default#VML);} o\:* {behavior:url(#default#VML);} w\:* {behavior:url(#default#VML);} .shape {behavior:url(#default#VML);} </style> <![endif]--><!--[if gte mso 9]><xml> <w:WordDocument> <w:View>Normal</w:View> <w:Zoom>0</w:Zoom> <w:PunctuationKerning/> <w:ValidateAgainstSchemas/> <w:SaveIfXMLInvalid>false</w:SaveIfXMLInvalid> <w:IgnoreMixedContent>false</w:IgnoreMixedContent> <w:AlwaysShowPlaceholderText>false</w:AlwaysShowPlaceholderText> <w:Compatibility> <w:BreakWrappedTables/> <w:SnapToGridInCell/> <w:WrapTextWithPunct/> <w:UseAsianBreakRules/> <w:DontGrowAutofit/> </w:Compatibility> <w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel> </w:WordDocument> </xml><![endif]--><!--[if gte mso 9]><xml> <w:LatentStyles DefLockedState="false" LatentStyleCount="156"> </w:LatentStyles> </xml><![endif]--><!--[if !mso]><object classid="clsid:38481807-CA0E-42D2-BF39-B33AF135CC4D" id=ieooui></object> <style> st1\:*{behavior:url(#ieooui) } </style> <![endif]--><!--[if gte mso 10]> <style> /* Style Definitions */ table.MsoNormalTable {mso-style-name:"Table Normal"; mso-tstyle-rowband-size:0; mso-tstyle-colband-size:0; mso-style-noshow:yes; mso-style-parent:""; mso-padding-alt:0in 5.4pt 0in 5.4pt; mso-para-margin:0in; mso-para-margin-bottom:.0001pt; mso-pagination:widow-orphan; font-size:10.0pt; font-family:"Times New Roman"; mso-ansi-language:#0400; mso-fareast-language:#0400; mso-bidi-language:#0400;} </style> <![endif]-->
<p align="center" style="text-align: center"><a name="_Toc280105312"></a><a name="_Toc269809056"></a> </p> <p align="left" style="text-align: left">This specification is based on the OSLC Reporting Workgroup&rsquo;s drafted specification. This specification will refer to topics described in OSLC Core Specification V2 ( [[OslcCoreSpecification][http://open-services.net/bin/view/Main/OslcCoreSpecification]]). A good understanding of the OSLC Core Specification V2 is pre-requisite for reading this specification. </p> <p align="left" style="text-align: left"> </p> <p align="left" style="text-align: left"> </p>

<div align="center" style="text-align: center">
---
</div> <strong><br /> </strong>

---++ <a name="_Toc269809057"></a><a name="Overview"></a><a name="_Toc280105313"></a>Overview
 <p align="left" style="text-align: left">The Open Services for Lifecycle Collaboration (OSLC) initiative is creating a family of web services specifications for products, services and other tools that support all phases of the software and product lifecycle. The purpose of these specifications is to enable integration between products that support Application Life-cycle Management (ALM) and Product Life-cycle Management (PLM). Each part of the lifecycle or domain has its own work group and specification, for example there are Change Management, Quality Management, Estimation & Measurement and more. Each of the domain specifications are built upon the OSLC Core Specification. </p> <p align="left" style="text-align: left">Reporting is cross-cutting across all domains. Reporting is built upon the Core Specification. It specifies the additional requirements on top of domain specifications that would enable OSLC Service Providers providing OSLC Services that can be consumed by OSLC Reporting Consumers. </p> <p align="left" style="text-align: left">This document will makes references to the [[OslcCoreSpecification][OSLC Core Specification]]. This document may tighten the constraints as specified in the OSLC Core Specification, but will not relax them. </p> 
---++ <a name="_Toc280105314"></a><a name="_Toc269809058"></a><a name="Glossary_of_Terms"></a>Glossary of Terms
 <p align="left" style="text-align: left">A basic set of terms are defined in Glossary of Terms in the [[http://open-services.net/bin/view/Main/OslcCoreSpecification?sortcol=table;up=#Glossary_of_terms][OSLC Core Specification]] . </p> <p align="left" style="text-align: left">Here are the terminologies introduced by Reporting. </p> <p align="left" style="text-align: left"> *Reporting Consumer* - A reporting system which consumes the OSLC services provided by OSLC Service Providers for the purpose of doing analysis and reporting on OSLC Resources. </p> 
---++ <a name="_Toc280105315"></a><a name="_Toc269809059"></a><a name="Notation_and_Conventions"></a>Notation and Conventions
 <p align="left" style="text-align: left">The key words "MUST", "MUST NOT", "REQUIRED, SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" and "OPTIONAL" in this document are to be interpreted as described in <a target="_top" href="http://www.ietf.org/rfc/rfc2119.txt">RFC2119</a>. </p> 
---++ <a name="_Toc280105316"></a><a name="_Toc269809060"></a><a name="Interface_Sequence_Diagram"></a>Interface Sequence Diagram
 <p align="left" style="text-align: left">This section illustrates the interaction between an OSLC Service Provider, a Reporting Consumer, and the reporting users. The specification assumes that the Reporting Consumer has no specific knowledge of the Service Provider or its domain resources. It relies wholly on the Service Provider for discovering the shape of resources and their properties and for the presence of an OSLC query capability. Based on the resource shape and query capabilities, a Reporting Consumer is able to offer its users the ability to design and run reports. </p><p align="left" style="text-align: left"><img alt="oslc_reporting_sequenece_diagram_110321.jpg" src="%ATTACHURL%/oslc_reporting_sequenece_diagram_110321.jpg" /> </p> <p align="left" style="text-align: left"> </p> 
---++ <a name="Service_Provider_Resource"></a> [[http://open-services.net/bin/view/Main/OslcCoreSpecification?sortcol=table;up=#Service_Provider_Resources][Service Provider Resources]]<a name="_Toc269809061"></a><a name="_Toc280105317"></a>
 <p align="left" style="text-align: left">An OSLC Service *MUST* have Query Capabilities defined in Service Resource for all resources intended for Reporting. </p> <p align="left" style="text-align: left">Each Query Capability for Reporting </p> 
   * *MUST* have oslc:queryBase pointing to the resource that has a list of resources intended for Reporting. The resources in the list *MUST* be identified as <span style="font-size: 12pt">oslc:isMemberProperty</span> in the [[http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixA?sortcol=table;up=#oslc_ResourceShape_Resource][<span style="font-size: 10.5pt; font-family: 'Times New Roman'">Resource Shape Resource</span>]] of the list resource.
   * *MUST* have <span style="font-size: 12pt">oslc:resourceShape</span> to describe the list resource.
---++ <a name="Resource_Shape_Resource"></a> [[http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixA?sortcol=table;up=#oslc_ResourceShape_Resource][Resource Shape Resource]]<a name="_Toc269809062"></a><a name="_Toc280105318"></a>
 <p align="left" style="text-align: left">For every Query Capability that an OSLC Service provides for reporting, there *MUST* be a corresponding Resource Shape Resource for the subject resource identified in the Query Capability. </p> <p align="left" style="text-align: left">Each Resource Shape Resource *MUST* have EXACTLY-ONE oslc.describes to identify the type of resource described by this shape.</p> <p align="left" style="text-align: left">For those properties in a Resource that are intended for Reporting, they *MUST* be described in the Resource Shape Resource. There is no requirement to describe all properties of a resource in Resource Shape Resource though. </p> <p align="left" style="text-align: left">If the value-type of a property is a resource type, the property *MUST* provide a shape value (oslc:valueShape) to indicate the Resource Shape that applies to the resource. This applies to properties of the referenced resource that are intended for Reporting and the Service Provider knows the shape. If the referenced resource is not managed by the Service Provider, then there is no need to provide a shape value (oslc:valueShape). </p> 
---++ <a name="Query"></a> [[OSLCCoreSpecQuery][Query]]<a name="_Toc269809063"></a><a name="_Toc280105319"></a>
 <p align="left" style="text-align: left">An OSLC Service *MUST* support [[OSLCCoreSpecQuery][OSLC Core Query Syntax]] for Query Capabilities that are intending for Reporting. </p> 
   * *SHOULD* support [[http://open-services.net/bin/view/Main/OslcCoreSpecification?sortcol=table;up=#Selective_Property_Values][<span style="font-size: 10.5pt; font-family: 'Times New Roman'">oslc.properties</span>]]
   * *SHOULD* support oslc.select
   * *SHOULD* support oslc.where
   * *SHOULD* support oslc.orderBy
   * *MAY* support oslc.searchTerms
<p align="left" style="text-align: left">An OSLC Service *SHOULD* support [[http://open-services.net/bin/view/Main/OslcCoreSpecification?sortcol=table;up=#Resource_Paging][Resource Paging]], even if the client does not specify oslc.paging=true or oslc.pageSize to the query component of the resource URI. It *MUST* include oslc:ResponseInfo as required in the response of a query. It *MUST* include oslc:nextPage in the oslc:ResponseInfo except the last page.</p> <p align="left" style="text-align: left">When a client requests a resource that an OSLC Service considers to be too large to return in one response, the OSLC Service *MUST* return a representation that contains partial information about the resource.</p> <p align="left" style="text-align: left">An OSLC Service *MUST* support oslc.properties=* and oslc.select=* that returns at least those properties that were described in Resource Shape Resource. Reporting consumers *MUST* tolerate additional unknown properties that *MAY* be returned. </p> <p align="left" style="text-align: left">OSLC Resources *SHOULD* have a property dcterms:modified for modification timestamp. Reporting Consumer will use this property in oslc.where to effect delta loading for the data warehouse use case. </p> 
---++ <a name="_Toc280105320"></a><a name="_Toc269809064"></a><a name="Resource_Representation"></a>Resource Representation
 <p align="left" style="text-align: left">An OSLC Service *MUST* provide XML representations of all Resources that are intended for Reporting following the [[http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixRepresentations?sortcol=table;table=up#Guidelines_for_application_xml][Guidelines for application/xml]]. </p> 
---++ <a name="_Toc280105321"></a><a name="_Toc269809065"></a><a name="Authentication"></a>Authentication
 <p align="left" style="text-align: left">An OSLC Service Provider *MAY* choose not to protect its resources. If it chooses to protect its resources, it *SHOULD* use either HTTP Basic Authentication, Form-based Authentication, or OAuth Authentication. </p> 
---+++ 

---++ <a name="_Toc280105324"></a><a name="_Toc269809066"></a><a name="Appendix_Guidance"></a>Appendix A: Guidelines for deletion
 <p align="left" style="text-align: left">In delta loading data warehouse use case, there is a need to inform the Reporting Consumer on deleted resources. </p> <p align="left" style="text-align: left">If resources are soft deleted (i.e. logically deleted), there would be a delete flag as a property of the resource. Thus deleted resources will be treated as changed resources. </p> <p align="left" style="text-align: left">If resources are hard deleted (i.e. physically deleted), it will be the Reporting Consumer's responsibility to send query to get resource URL (or an unique identifier, if exist) for all current resources, and then map out what have been deleted in its data repository. An alternative approach would be the Provider has a "deleted resources resource" that can return deleted resource id's with dcterms:modified. This is a more optimum approach is the Provider can support.</p> 
---++
Attachments
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
jpg	oslc_reporting_sequence_diagram_100426.jpg	manage	109.2 K	27 Apr 2010 - 02:52	TackTong	OSLC Reporting Sequence Diagram
jpg	oslc_reporting_sequenece_diagram_110321.jpg	manage	84.0 K	21 Mar 2011 - 19:51	TackTong
Topic revision: r13 - 21 Mar 2011 - 20:16:09 - TackTong
Main
Webs
Main
Sandbox
TWiki
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding this site? Send feedback