History   View   Links to this page 2012 December 13 | 01:00 pm

This page is to work through a proposal for how V3 vocabs should look. This is based off of evolving Core work

Resource ChangeRequest

The Change Request resource is a single definition used to define many kinds of change requests such as: defect, enhancement, task, bug, activity, etc. There are a fair number of common properties between these different kinds of change requests and can use some of the properties in the follow definition to identify them.

The Change Request resource properties are not limited to the ones defined in this specification, service providers may provide additional properties. It is recommended that any additional properties exist in their own unique namespace and not use the namespaces defined in these specifications.

  • Name: ChangeRequest
  • Type URI http://open-services.net/ns/cm#ChangeRequest
Prefixed Name Occurs Read-only Value-type Representation Range Description
OSLC Core: Common Properties
oslc:shortTitle zero-or-one unspecified XMLLiteral n/a n/a Short name identifying a resource, often used as an abbreviated identifier for presentation to end-users. SHOULD include only content that is valid inside an XHTML <span> element.
dcterms:description zero-or-one unspecified XMLLiteral n/a n/a Descriptive text (reference: Dublin Core) about resource represented as rich text in XHTML content. SHOULD include only content that is valid and suitable inside an XHTML <div> element.
dcterms:title exactly-one unspecified XMLLiteral n/a n/a Title (reference: Dublin Core) or often a single line summary of the resource represented as rich text in XHTML content. SHOULD include only content that is valid and suitable inside an XHTML <div> element.
dcterms:identifier exactly-one True String n/a n/a A unique identifier for a resource. Assigned by the service provider when a resource is created. Not intended for end-user display.
dcterms:subject zero-or-many False String n/a n/a Tag or keyword for a resource. Each occurrence of a dcterms:subject property denotes an additional tag for the resource.
dcterms:creator zero-or-many unspecified Either Resource or Local Resource Either Reference or Inline any Creator or creators of resource (reference: Dublin Core). It is likely that the target resource will be a foaf:Person but that is not necessarily the case.
dcterms:contributor zero-or-many unspecified Either Resource or Local Resource Either Reference or Inline any The person(s) who are responsible for the work needed to complete the change request (reference: Dublin Core). It is likely that the target resource will be a foaf:Person but that is not necessarily the case.
dcterms:created zero-or-one True !DateTime n/a n/a Timestamp of resource creation (reference: Dublin Core).
dcterms:modified zero-or-one True !DateTime n/a n/a Timestamp last latest resource modification (reference: Dublin Core).
rdf:type zero-or-many unspecified Resource Reference n/a The resource type URIs. One of at least has the value of http://open-services.net/ns/cm#ChangeRequest
oslc:serviceProvider zero-or-many unspecified Resource Reference oslc:ServiceProvider The scope of a resource is a URI for the resource’s OSLC Service Provider.
oslc:instanceShape zero-or-one unspecified Resource Reference oslc:ResourceShape Resource Shape that provides hints as to resource property value-types and allowed values.
oslc:discussedBy zero-or-one unspecified Resource Either oslc:Discussion A series of notes and comments about this change request.
Prefixed Name Occurs Read-only Value-type Representation Range Description
OSLC CM: Start of additional properties
dcterms:type zero-or-more unspecified String n/a n/a A short string representation for the type, example ‘Defect’.
oslc_cm:closeDate zero-or-one true !DateTime n/a n/a The date at which no further activity or work is intended to be conducted.
oslc_cm:status zero-or-one unspecified String n/a n/a Used to indicate the status of the change request based on values defined by the service provider. Most often a read-only property. Some possible values may include: ‘Submitted’, ‘Done’, ‘InProgress’, etc.
Prefixed Name Occurs Read-only Value-type Represen-tation Range Description
State predicate properties: This grouping of properties define a set of computed state predicates, see section on State Predicates for more information. The only restriction on valid state predicate combinations is that if oslc_cm:inprogress is true, then oslc_cm:fixed and oslc_cm:closed must also be false
oslc_cm:closed zero-or-one True Boolean n/a n/a Whether or not the Change Request is completely done, no further fixes or fix verification is needed.
oslc_cm:inprogress zero-or-one True Boolean n/a n/a Whether or not the Change Request in a state indicating that active work is occurring. If oslc_cm:inprogress is true, then oslc_cm:fixed and oslc_cm:closed must also be false
oslc_cm:fixed zero-or-one True Boolean n/a n/a Whether or not the Change Request has been fixed.
oslc_cm:approved zero-or-one True Boolean n/a n/a Whether or not the Change Request has been approved.
oslc_cm:reviewed zero-or-one True Boolean n/a n/a Whether or not the Change Request has been reviewed.
oslc_cm:verified zero-or-one True Boolean n/a n/a Whether or not the resolution or fix of the Change Request has been verified.
Prefixed Name Occurs Read-only Value-type Representation Range Description
Relationship properties: This grouping of properties are used to identify relationships between resources managed by other OSLC Service Providers
oslc_cm:relatedChangeRequest zero-or-many False Resource Reference any This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_cm:ChangeRequest but that is not necessarily the case.
oslc_cm:affectsPlanItem zero-or-many False Resource Reference any Change request affects a plan item. It is likely that the target resource will be an oslc_cm:ChangeRequest but that is not necessarily the case.
oslc_cm:affectedByDefect zero-or-many False Resource Reference any Change request is affected by a reported defect. It is likely that the target resource will be an oslc_cm:ChangeRequest but that is not necessarily the case.
oslc_cm:tracksRequirement zero-or-many False Resource Reference any Tracks the associated Requirement or Requirement !ChangeSet resources. It is likely that the target resource will be an oslc_rm:Requirement but that is not necessarily the case.
oslc_cm:implementsRequirement zero-or-many False Resource Reference any Implements associated Requirement. It is likely that the target resource will be an oslc_rm:Requirement but that is not necessarily the case.
oslc_cm:affectsRequirement zero-or-many False Resource Reference any Change request affecting a Requirement. It is likely that the target resource will be an oslc_rm:Requirement but that is not necessarily the case.
oslc_cm:testedByTestCase zero-or-many False Resource Reference any Test case by which this change request is tested. It is likely that the target resource will be an oslc_qm:TestCase but that is not necessarily the case.
oslc_cm:affectsTestResult zero-or-many False Resource Reference any Associated QM resource that is affected by this Change Request. It is likely that the target resource will be an oslc_qm:TestResult but that is not necessarily the case.
oslc_cm:blocksTestExecutionRecord zero-or-many False Resource Reference any Associated QM resource that is blocked by this Change Request. It is likely that the target resource will be an oslc_qm:TestExecutionRecord but that is not necessarily the case.
oslc_cm:relatedTestExecutionRecord zero-or-many False Resource Reference any Related to a QM test execution resource. It is likely that the target resource will be an oslc_qm:TestExecutionRecord but that is not necessarily the case.
oslc_cm:relatedTestCase zero-or-many False Resource Reference any Related QM test case resource. It is likely that the target resource will be an oslc_qm:TestCase but that is not necessarily the case.
oslc_cm:relatedTestPlan zero-or-many False Resource Reference any Related QM test plan resource. It is likely that the target resource will be an oslc_qm:TestPlan but that is not necessarily the case.
oslc_cm:relatedTestScript zero-or-many False Resource Reference any Related QM test script resource. It is likely that the target resource will be an oslc_qm:TestScript but that is not necessarily the case.
oslc_cm:tracksChangeSet zero-or-many False Resource Reference any Tracks SCM change set resource. It is likely that the target resource will be an oslc_scm:ChangeSet but that is not necessarily the case.

Naming convention for relationship properties follows this pattern:

  • related - Identifies a loose relationship between a Change Request and referenced resource. These relationships can be used to name associated resources managed by other service providers.
  • tracks - Identifies that a Change Request is used to track the lifecycle of referenced resource. From the CM tool perspective, these relationships can be used to track work that needs to be done for referenced resources.
  • affects - Indicates that the Change Request affects, has been predetermined to have impact, related resource. These property relationships can be used to understand the potential impact of referenced resources.