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.

Change Management Resources Definition

1.0 SPECIFICATION

Introduction

Change Management resources define the change requests and tasks of the software delivery lifecycle. This specification will focus on the definition of a change request, which includes common set of properties, their types and requirements on usage. Implementations can extend this base definition of a change request by contributing their additional properties to the change request resource defintion.

Notation and Conventions

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 RFC2119. Domain name examples use RFC2606.

Terminology

Change Request - A request for change to an application or product. Typically a product request for enhancement or a report for a resolution of a product defect.

Change Request Resource

The change request resource properties are not limited to the ones defined in this specification. It is recommended to contribute resource properties in their own unique namespace, not to reuse those defined in these specifications.

XML namespace abbreviations used in this specification:

XML Representation of the Change Request Resource

The media type used for this representation MUST be application/x-oslc-cm-change-request+xml.

XML Representation Summary: ChangeRequest? Element
<oslc_cm:ChangeRequest rdf:about = xsd:anyURI >
Content: (dc:title, dc:identifier, dc:type?, dc:description?, dc:subject?, dc:creator?, dc:modified?)
</oslc_cm:ChangeRequest>
Property Representation
dc:title The required title string. Note that this element comes from the DC namespace, allowing tools unaware of the change management domain to access this element. This is sometimes also referred to as the headline or summary of the request.
dc:identifier The required, read-only identifier string. This is assigned by a change management system when a request resource has been created.
dc:type The optional type string. The type of request that is represented, such as: defect, enhancement, etc.
dc:description The optional description string. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element.
dc:subject The optional subject string. The DC namespace defines this element to be a collection of keywords. The subject element will contain keywords and tags assigned to this request.
dc:creator The optional, read-only creator element, identifying the originating user of this request.
dc:modified
The optional, read-only modified date time which must conform to RFC3339 format

Example

<?xml version="1.0" encoding="UTF-8"?>
<oslc_cm:ChangeRequest
  xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
  xmlns:dc="http://purl.org/dc/terms/"
  xmlns:oslc_cm="http://open-services.net/xmlns/cm/1.0/" 

  rdf:about="http://example.com/bugs/2314">

  <dc:title> Provide import </dc:title>
  <dc:identifier> 2314 </dc:identifier>
  <dc:type> http://myserver/mycmapp/types/Enhancement </dc:type>
  <dc:description>
    Implement the system's import capabilities.
  </dc:description>
  <dc:subject> import, blocker </dc:subject>
  <dc:creator> mailto:aadams@someemail.com </dc:creator>
  <dc:modified> 2008-09-16T08:42:11.265Z </dc:modified>
</oslc_cm:ChangeRequest> 

JSON Representation of the Change Request Resource

The media type used for this representation MUST be application/x-oslc-cm-change-request+json.

JSON Representation Summary: ChangeRequest? JSON Object
{ Content: (dc:title, dc:identifier, dc:type?, dc:description?, dc:subject?, dc:creator?, dc:modified?) }
Property Representation
rdf:about
The optional URI of this resource.
dc:title The required title string. Note that this element comes from the DC namespace, allowing tools unaware of the change management domain to access this element. This is sometimes also referred to as the headline or summary of the request.
dc:identifier The required, read-only identifier string. This is assigned by a change management system when a request resource has been created.
dc:type The optional type string. The type of request that is represented, such as: defect, enhancement, etc.
dc:description The optional description string. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element.
dc:subject The optional subject string. The DC namespace defines this element to be a collection of keywords. The subject element will contain keywords and tags assigned to this request.
dc:creator The optional, read-only creator element, identifying the originating user of this request.
dc:modified
The optional, read-only modified date time which must conform to RFC3339 format

Example

{
 "rdf:about": "http://example.com/bugs/2314", 
 "dc:title": "Provide import", 
 "dc:identifier" : "2314",
 "dc:type" : "http://myserver/mycmapp/types/Enhancement",
 "dc:description" : "Implement the system's import capabilities.",
 "dc:subject" : "import, blocker",
 "dc:creator" : "mailto:aadams@someemail.com",
 "dc:modified" : "2008-09-16T08:42:11.265Z"
} 
Topic revision: r20 - 28 May 2009 - 18:35:03 - TWikiAdminUser
Main.CmResourceDefinitionsV1 moved from Main.CmResourceDefinitions on 28 May 2009 - 14:12 by ScottBosworth - put it back
 
This site is powered by the TWiki collaboration platform 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