OSLC PROMCODE Specification Appendix A - PROMCODE Resource Shape

OASIS Working Draft

Specification URIs

This version:

Latest versions:
none

Latest editor's draft:
http://tools.oasis-open.org/version-control/browse/wsvn/oslc-promcode/shape/trunk/shape.html

Technical Committee:
OASIS OSLC PROMCODE TC

Editors:
Mikio Aoyama, Nanzan University
Kazuhiro Funakoshi, NEC Corporation
Yoshio Horiuchi, IBM
Tsutomu Kamimura, IBM
Shigeaki Matsumoto, NEC Corporation
Arthur Ryman, IBM
Masaki Wakao, IBM,
Kazuo Yabuta, Fujitsu Limited
Hiroyuki Yoshida, Fujitsu Limited

Abstract:
This defines the definitions of the OSLC PROMCODE defined utilizing the OSLC Core Shape Resource definition. Implementations may use these shapes to as a basis for their work, providing their own property additions and additional constraints on OSLC defined properties.

Status:

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current OASIS publications can be found in the OASIS standards page at https://www.oasis-open.org/standards.

This document was published by the as a Working Draft. If you wish to make comments regarding this document, please send them to oslc-promcode-comment@lists.oasis-open.org (subscribe, archives). All comments are welcome.


Citation format:
When referencing this specification the following citation format should be used: TBD

An appendix of the OASIS OSLC Lifecycle Integration for Project Management of Contracted Delivery (OSLC PROMCODE)


Notices

Copyright © OASIS Open © 2015 . All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/policies-guidelines/trademark for above guidance.


Conventions

In this section, Resource Shape is represented in RDF+Turtle format. The following common URI prefixes are used throughout this section.

$ ManagedItem.ttl
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix dcterms: <http://purl.org/dc/terms/> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix oslc: <http://open-services.net/ns/core#> .
@prefix ext: <http://ww.w3.org/TODO:extendsShapeNameSpace> .
@prefix promcode: <http://open-services.net/ns/promcode#> .
@prefix shapebase <http://open-services.net/ns/promcode/shapes/1.0/> .
@prefix ems: <http://open-services.net/ns/ems#> .

Artifact

An artifact is a work product that is produced in a project. An artifact may be physical or digital.

Artifact Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:producedFor Zeor-or-many unspecified Resource WorkItem producedFor is a relation between artifacts and scope items or work items. Artifacts are produced in the course of implementing scope and work items.
promcode:isPartOf Zero-or-one unspecified Resource Artifact isPartOf is a relation between a child Artifact and its parent Artifact. A Artifact may have multiple child WorkItems

IssueCollection

An IssueCollection is a resource which is a subclass of ManagedItemCollection. An IssueCollection only collects Issues. All of Issues raised in a project should be collected by an IssueCollection.

IssueCollection Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:collects Zero-or-many unspecified AnyResource Issue collects is a relation between IssueCollection and Issue. Issues are usually managed differently to other ManagedItems.

Issue

An issue is a situation that must be resolved in order to meet the objectives of a project. Failure to resolve the situation may result in negative consequences for the project, such as a schedule delay.

Issue Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:stateOfIssue exactly-one unspecified AnyResource N/A stateOfIssue is a relation between Issue and State. The State resources defines set of values which represent state of issue.
promcode:raisedDate Zero-or-one unspecified dateTime N/A raisedDate is a property which describes the date of the issue raised on.
promcode:raisedBy Zero-or-many unspecified Resource ManagedItem raisedBy is a relation between issues and managed items. An issue may be raised by one or more managed items. Note that that property is closely related to dcterms:relation and should be regarded as a subproperty of it.

ManagedItemCollection

A managed item collection is container of managed items. Any combination of subclass such as a scope item, work item, artifact or issue can be hold in a ManagedItemCollection as a snapshot. ManagedItemCollection has concrete subclasses such as Plan, Report and IssueCollection.

ManagedItemCollection Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:collects Zero-or-many unspecified AnyResource WorkItem collects is a relation between a ManagedItemCollection and ManagedItems. ManagedItemCollection only collects any combination of subclass such as a scope item, work item, artifact or issue.
promcode:belongsTo Zero-or-one unspecified AnyResource Project belongsTo is a relation between ManagedItemCollections and a project. A project has several snapshots until completion. Sometimes a supplier or an acquirer operates several projects in parallel. The supplier or the acquirer identifies which snapshot should belong to a project. This relation may be omitted when the project is obvious between a supplier and an acquirer.
dcterms:date Zero-or-one unspecified dateTime N/A date is either a property of Measurements or a property of ManagementItemCollection. It is the date on which the measurement was made when it is used in Measurements. It is the date on which the collection is held when it is used in ManagedItemCollection.
dcterms:title Zero-or-one unspecified string N/A A title string for a ManagedItemCollection.
dcterms:identifier Exactly-one unspecified string N/A A unique idetifier for a ManagedItemCollection.

ManagedItem

A managed item is a scope item, work item, artifact, issue, or some other entity that is part of a project. Managed item resources use dcterms:type to specify concrete subclasses. This practice is deprecated in OSLC Core 3.0.

ManagedItem Properties
Prefixed Name Occurs Read-only Value-type Range Description
dcterms:description Zero-or-one unspecified string N/A description is a property of ManagedItem to help human to understand the abstract of the item.
dcterms:title Zero-or-one unspecified string N/A A title string for a ManagedItem and ManagedItemCollection.
dcterms:identifier Exactly-one unspecified string N/A A unique identifier for a ManagedItem and ManagedItemCollection.

Measure

A measure is an observation of some measurable aspect of an artifact.

Measure Properties
Prefixed Name Occurs Read-only Value-type Range Description
ems:metric Zero-or-one unspecified Resource N/A metric is a relation between Measure and Metric. It defines type of size which a Measure refer to.
ems:unitOfMeasure Zero-or-one unspecified Resource N/A unitOfMeasure is a property of measure resources. It is unit of volume. If acquirer sums up same type of measures in report, the value should be converted according to the unit.
ems:numericValue Exactly-one unspecified decimal N/A numericValue is a property of measure resources. It is either the actual value of a measurement or criteria value of a MeasurementCriteria.
dcterms:title Zero-or-one unspecified string N/A title is a property of measure resources to distinguish each other for human. It should be simple but descriptive.

Measurement

A measurement measures some aspect of an artifact at some point in time.

Measurement Properties
Prefixed Name Occurs Read-only Value-type Range Description
ems:observes Zero-or-many unspecified Resource Measure observes is a relation between measurements and measures. A measurement observes a measure. Note that property is related to similar properties in the OSLC EMS specification
promcode:measures Exactly-one unspecified Resource Artifact measures is a relation between measurements and artifacts. A measurement measures an artifact.
promcode:date Exactly-one unspecified dataTime N/A date is either a property of Measurements or a property of ManagementItemCollection. It is the date on which the measurement was made when it is used in Measurements. It is the date on which the collection is held when it is used in ManagedItemCollection.

Plan

A Plan is a resource which is a subclass of ManagedItemCollection to describe a plan, which is agreed between an acquirer and a supplier at project initiation. A plan consists of ScopeItems, WorkItems, Artifacts, Targets and Measures.

Plan Properties
Prefixed Name Occurs Read-only Value-type Range Description

Project

A project is software development work to achieve some business goal.

Project Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:actualEndDate Zero-or-one unspecified dateTime N/A actualEndDate is a property of Project that stands for actual end date of the project.
promcode:plannedEndDate Zero-or-one unspecified dateTime N/A plannedEndDate is a property of Project that defines when the project should be end.
promcode:actualStartDate Zero-or-one unspecified dateTime N/A actualStartDate is a property of Project that stands for actual start date of the project.
promcode:plannedStartDate Zero-or-one unspecified dateTime N/A plannedStartDate is a property of Project that defines when the project should be started.
dcterms:description Zero-or-one unspecified string N/A description is a property of Projects to help human to understand the abstract of the Project.
dcterms:title Zero-or-one unspecified string N/A A title string for a Project.
dcterms:identifier Exactly-one unspecified string N/A A unique identifier for a Project.
promcode:unitOfScopeItemSize Zero-or-one unspecified Resource N/A unitOfScopeItemSize is a relation between Project and UnitType. It is unit of volume. It defines volume of size which all the ScopeItems refer to in a project.
promcode:typeOfScopeItemSize Zero-or-one unspecified Resource N/A typeOfScopeItemSize is a relation between Project and MeasureType. It defines type of size which all the ScopeItems refer to in a project.

Report

A Report is a resource which is a subclass of ManagedItemCollection to describe a report. A Report is associated to corresponding Plan.

Report Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:correspondsTo Exactly-one unspecified AnyResource Plan correspondsTo is a relation between a Plan and Reports. Report is submitted to the corresponding plan. If plan is changed, the report is submitted to the new plan.

RiskCollection

RiskCollection Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:collects Zero-or-many unspecified AnyResource Risk collects is a relation between RiskCollection and Risk. Risks are usually managed differently to other ManagedItems.

Risk

Risk Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:stateOfRisk exactly-one unspecified AnyResource N/A stateOfRisk is a relation between Risk and State. The State resource defines set of values which represent state of risk.
promcode:identifiedDate Zero-or-one unspecified dateTime N/A identifiedDate is a property which describes the date of the risk identified on.
promcode:identifiedBy Zero-or-many unspecified Resource ManagedItem identifiedBy is a relation between risks and managed items. A risk may be identified by one or more managed items. Note that the property is closely related to dcterms:relation and should be regarded as a subproperty of it.

ScopeItem

A ScopeItem defines the work to be included in or excluded from a project. It defines the boundaries of the project.

ScopeItem Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:isPartOf Zero-or-one unspecified Resource ScopeItem isPartOf is a relation between child ScopeItem and its parent ScopeItem. A ScopeItem may have multiple child ScopeItems.
promcode:actualSize Zero-or-one unspecified decimal N/A actualSize is a measurement of the actual size of a scope item.
promcode:plannedSize Zero-or-one unspecified decimal N/A plannedSize is an estimate of the planned size of a scope item. The unit of size is implicit because an acquirer and suppliers preliminarily agree the unit of size.

Target

A target is value which an artifact should be achieved by a supplier until the project completes.

Target Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:determines Zero-or-many unspecified Resource Measure determines is a relation between a Target and Measures. Before project execution, an acquirer and a supplier determine which type of measure should be used. Once selected, the measures are traced until project completion.
promcode:definedFor Exactly-one unspecified Resource Artifact definedFor is a relation between a Target and an Artifact. Before project execution, an acquirer and a supplier define a criterion for an artifact. The criterion may relate quality assurance. The supplier makes effort to achieve the criteria until project completion. Some artifact may define no criterion.

WorkItem

A work item describes work to be performed in a project delivery contract. It adds detail to the description of work that is described by a scope item. These details typically include cost, schedule, and resource requirements. The set of all work items in a project form a work breakdown structure.

WorkItem Properties
Prefixed Name Occurs Read-only Value-type Range Description
promcode:representedBy Zero-or-one unspecified AnyResource N/A representedBy is a relation between work items and people. A work item may be represented by a person who acts as the contact for the work item. This person is responsible for the progress of this work item. This person may or may not actually do the required work.
promcode:requiredBy Zero-or-many unspecified Resource Artifact requiredBy is a relation between work items and managed items. A work item may be required by a scope item or an artifact.
promcode:isPartOf Zero-or-one unspecified Resource WorkItem isPartOf is a relation between a child WorkItem and its parent WorkItem. A WorkItem may have multiple child WorkItems.
promcode:actualEndDate Zero-or-one unspecified dateTime N/A actualEndDate is a property of WorkItem that stands for actual end date of the project.
promcode:plannedEndDate Zero-or-one unspecified dateTime N/A plannedEndDate is a property of WorkItem that defines when the project should be end.
promcode:actualStartDate Zero-or-one unspecified dateTime N/A actualStartDate is a property of WorkItem that stands for actual start date of the project.
promcode:plannedStartDate Zero-or-one unspecified dateTime N/A plannedStartDate is a property of WorkItem that defines when the project should be started.

shape.html (last edited 2015-04-01 02:09:27 by f-jiang)