referencedsourcegear

OpenServicesforLifecycleCollaborationProductLifecycleManagementSpecificationVersion1.
0Status:V1.
0ExperimentalSpecification–October11,2011ThisVersionV1.
0ExperimentalSpecification–October11,2011LatestVersionPreviousVersionAuthorsGrayBachelorContributorsSeeContributorssectionbelowTableofContentsIntroductionTerminologyBaseRequirementsComplianceSpecificationVersioningNamespacesResourceFormatsAuthenticationErrorResponsesPaginationRequestingandUpdatingPropertiesStatePredicatesLabelsforRelationshipsPLCMResourceDefinitionsResourceChangeRequestResourceProductResourceProductversionResourceproductviewPLCMServiceProviderCapabilitiesServiceProviderResourcesCreationFactoriesQueryCapabilitiesDelegatedUIsUsageIdentifiersVersionCompatibilitywith1.
0SpecificationsMediaTypesRequestingformatsAppendixA:SamplesAppendixB:ResourceShapesAppendixC:NoticesandReferencesContributorsReportingIssuesontheSpecificationIntellectualPropertyCovenantReferencesLicenseThisworkislicensedunderaCreativeCommonsAttributionLicense.
NotationandConventionsThekeywords"MUST","MUSTNOT","REQUIRED","SHALL","SHALLNOT","SHOULD","SHOULDNOT","RECOMMENDED","MAY",and"OPTIONAL"inthisdocumentaretobeinterpretedasdescribedinRFC2119.
DomainnameexamplesuseRFC2606.
Introduction(thissectionisinformative)ThisspecificationdefinesaRESTfulwebservicesinterfaceforProductLifecycleChangeManagement,themanagementofproductdefinitionchangerequests,activities,tasksandselectedrelationshipsbetweenproductresourcesthoseandrelatedresourcessuchaschangerequests,requirements,implementationmodelresourcesandinthefutureproject,category,releaseandplan.
Tosupportthesescenarios,thisspecificationdefinesasetofHTTP-basedRESTfulinterfacesintermsofHTTPmethods:GET,POST,PUTandDELETE,HTTPresponsecodes,contenttypehandlingandresourceformats.
TheintentofthisspecificationistodefinethecapabilitiesneededtosupportintegrationscenariosdefinedbytheProductLifecycleChangeManagementworkinggroupandnottoprovideacomprehensiveinterfacetoProductLifecycleChangeManagement.
Theresourceformatsandoperationsmaynotmatchexactlythenativemodelssupportedbychangeproductlifecyclemanagementserviceprovidersbutareintendedtobecompatiblewiththem.
Theapproachtosupportingthesescenariosistodelegateoperations,asdrivenbyserviceprovidercontributeduserinterfaces,asmuchaspossibleandnotrequireaserviceprovidertoexposeitscompletedatamodelandapplicationlogic.
ThefollowingfigureillustrateshowthisPLCMspecificationrelatestootherOSLCspecifications.
ItextendsandrestrictstheOSLCCore,whilereferencingresourcesdefinedinotherdomainspecifications.
TerminologyChangeRequestProductResource-Adefinitionofrequestforchangetoanapplicationoraproduct.
Typicallyaproductrequestforenhancement,areportforaresolutionofaproductdefectorsimplyabugreport.
Actsasacollectororuniquereferencingresourceforaproduct.
Aproductcanhostmultiplelogicalorphysicalproductvariantsorexplicitlydefineaspecificvariant.
Productversion–anindicationofchangestoaproduct,asanindividualproductorameansofhostingmultipleproducts,withinasingleproductdefinition.
Productview–adescriptionofthecompositionofaproduct,typicallybydomain.
Theviewmayhavemoreconstituents,i.
e.
componentsthanisnecessarytoallowformoreexplicitcompositionbywayofvariationthroughoptions.
Consumer-animplementationoftheOSLCChangeProductLifecycleManagementspecificationsasaclient.
OSLCPLCMConsumersconsumeservicesprovidedbyserviceprovidersServiceProvider-animplementationoftheOSLCProductLifecycleChangeManagementspecificationsasaserver.
OSLCPLCMclientsconsumetheseservicesBaseRequirementsComplianceThisspecificationisbasedonOSLCCoreSpecification.
OSLCPLCMconsumersandserviceprovidersMUSTbecompliantwithboththecorespecificationandthisPLCMspecification,andSHOULDfollowalltheguidelinesandrecommendationsinboththesespecifications.
ThefollowingtablesummarizestherequirementsfromOSLCCoreSpecificationaswellassomeadditionalspecifictoPLCM.
NotethatthisspecificationfurtherrestrictssomeoftherequirementsforOSLCCoreSpecification.
SeefurthersectionsinthisspecificationortheOSLCCoreSpecificationtogetfurtherdetailsoneachoftheserequirements.
RequirementLevelMeaningUnknownpropertiesandcontentMAY/MUSTOSLCservicesMAYignoreunknowncontentandOSLCclientsMUSTpreserveunknowncontentResourceOperationsMUSTOSLCserviceMUSTsupportresourceoperationsviastandardHTTPoperationsResourcePagingMAYOSLCservicesMAYprovidepagingforresourcesbutonlywhenspecificallyrequestedbyclientPartialResourceRepresentationsMAY/MUSTOSLCservicesMUSTsupportrequestforasubsetofaresource'spropertiesviatheoslc.
propertiesURLparameterretrievalviaHTTPGETandMAYsupportviaHTTPPUTPartialUpdateMAYOSLCservicesMAYsupportpartialupdateofresourcesusingpatchsemanticsServiceProviderResourcesMAY/MUSTOSLCserviceprovidersMAYprovideaServiceProviderCatalogandMUSTprovideaServiceProviderresourceCreationFactoriesMUSTOSLCserviceprovidersMUSTprovidecreationfactoriestoenableresourcecreationviaHTTPPOSTQueryCapabilitiesMUSTOSLCserviceprovidersMUSTprovidequerycapabilitiestoenableclientstoqueryforresourcesQuerySyntaxMUSTOSLCquerycapabilitiesMUSTsupporttheOSLCCoreQuerySyntaxandMAYuseotherquerysyntaxDelegatedUIDialogsMUSTOSLCServicesMUSTofferdelegatedUIdialogs(creationandselections)specifiedviaserviceproviderresourceUIPreviewSHOULDOSLCServicesSHOULDofferUIpreviewsforresourcesthatmaybereferencedbyotherresourcesHTTPBasicAuthenticationMAYOSLCServicesMAYsupportBasicAuthandshoulddosoonlyoverHTTPSOAuthAuthenticationSHOULDOSLCServicesSHOULDsupportOAuthandcanindicatetherequiredOAuthURLsviatheserviceproviderresourceErrorResponsesMAYOSLCServicesMAYprovideerrorresponsesusingCoredefinederrorformatsRDF/XMLRepresentationsMUST/SHOULDOSLCservicesMUSTprovideanRDF/XMLrepresentationforHTTPGETrequestsandSHOULDsupportRDF/XMLrepresentationsonPOSTandPUTrequests.
XMLRepresentationsMUSTOSLCservicesMUSTprovideaXMLrepresentationforHTTPGET,POSTandPUTrequeststhatconformtotheCoreGuidelinesforXML.
JSONRepresentationsMUSTOSLCservicesMUSTprovideJSONrepresentationsforHTTPGET,POSTandPUTrequeststhatconformtotheCoreGuidelinesforJSONHTMLRepresentationsSHOULDOSLCservicesSHOULDprovideHTMLrepresentationsforHTTPGETrequestsSpecificationVersioningSeeOSLCCoreSpecificationVersioningsection.
ServiceprovidersthatsupporttheresourceformatsandservicesinthisspecificationMUSTuseHTTPresponseheaderofOSLC-Core-Versionwithavalueof2.
0.
ConsumersMAYrequestformatsandservicesdefinedinthisdocumentbyprovidingaHTTPrequestheaderofOSLC-Core-Versionwithavalueof2.
0.
SeesectionbelowonVersionCompatibilitywithOSLCCM1.
0Specifications.
NamespacesInadditiontothenamespaceURIsandnamespaceprefixesoslc,rdf,dctermsandfoafdefinedintheOSLCCorespecification,OSLCPLMCMdefinesthenamespaceURIofhttp://open-services.
net/ns/plcm#withanamespaceprefixofoslc_plcmThisspecificationalsousesthesenamespaceprefixdefinitions:oslc_rm:http://open-services.
net/ns/cm#(Reference:OSLCCM)oslc_am:http://open-services.
net/ns/rm#(Reference:OSLCAM)oslc_rm:http://open-services.
net/ns/rm#(Reference:OSLCRM)oslc_qm:http://open-services.
net/ns/qm#(Reference:OSLCQM)oslc_scm:http://open-services.
net/ns/scm#(Reference:OSLCSCM)ResourceFormatsInadditiontotherequirementsforOSLCCoreResourceFormatssection,thissectionoutlinesfurtherrefinementsandrestrictions.
ForHTTPGETrequestsonallOSLCPLCMandOSLCCoredefinedresourcetypes,PLCMProvidersMUSTprovideRDF/XML,XML.
andJSONrepresentations.
TheXMLandJSONrepresentationsSHOULDfollowtheguidelinesoutlinedintheOSLCCoreRepresentationsGuidance.
PLCMConsumersrequestingRDF/XMLSHOULDbepreparedforanyvalidRDF/XMLdocument.
PLCMConsumersrequestingXMLorJSONSHOULDbepreparedforrepresentationsthatfollowtheguidelinesoutlinedintheOSLCCoreRepresentationsGuidance.
PLCMProvidersSHOULDsupportan[X]HTMLrepresentationandauserinterface(UI)previewasdefinedbyUIPreviewGuidanceForHTTPPUT/POSTrequestformatsforresourcetypeofChangeRequest:PLCMProvidersMUSTacceptXMLandJSONrepresentationsandSHOULDacceptRDF/XMLrepresentations.
CPLMProvidersacceptingRDF/XMLSHOULDbepreparedforanyvalidRDF/XMLdocument.
ForXMLorJSON,PLCMProvidersSHOULDbepreparedforrepresentationsthatfollowtheguidelinesoutlinedintheOSLCCoreRepresentationsGuidance.
ForHTTPGETresponseformatsforQueryrequests,PLCMProvidersMUSTprovideRDF/XML,XML,AtomSyndicationFormatXMLandJSONrepresentations.
WhenPLCMConsumersrequest:application/rdf+xmlPLCMProvidersMUSTrespondwithRDF/XMLrepresentationwithoutrestrictions.
application/jsonPLCMProvidersMUSTrespondwithJSONrepresentationasdefinedintheOSLCCoreRepresentationsGuidance.
application/xmlPLCMProviderMUSTrespondwithOSLC-definedabbreviatedXMLrepresentationasdefinedintheOSLCCoreRepresentationsGuidanceapplication/atom+xmlPLCMProviderMUSTrespondwithAtomSyndicationFormatXMLrepresentationasdefinedintheOSLCCoreRepresentationsGuidanceTheAtomSyndicationFormatXMLrepresentationSHOULDuseRDF/XMLrepresentationwithoutrestrictionsfortheatom:contententriesrepresentingtheresourcerepresentations.
SeeQueryCapabilitiesforadditionalinformationwhenResourceShapesaffectrepresentation.
ContentNegotiationOSLCCoreGuidanceclearlypointstoRDFrepresentations(andspecificallyRDF/XML)asaconventionthatallOSLCProviderimplementationsminimallyprovideandaccept.
OSLCPLCMProviderimplementationsarestronglyencouragedtoadoptthisconvention.
FutureversionsofthisspecificationareexpectedtorequireRDFrepresentationsforalloperationsandrelaxrequirementsforspecializedXMLrepresentations.
XMLRepresentation-identifiedbytheapplication/xmlcontenttype.
FormatrepresentationrulesareoutlinedinCoreOSLCCoreResourceFormatssectionRDF/XMLRepresentation-identifiedbytheapplication/rdf+xmlcontenttype.
Noadditionalguidanceisgiven.
TheOSLCCoredescribesanalgorithmforgeneratingconsistentformatsthatareusedasexamplesonly.
JSONRepresentation-identifiedbytheapplication/jsoncontenttype.
FormatrepresentationrulesareoutlinedinCoreOSLCCoreResourceFormatssection.
AtomSyndicationFormatXMLRepresentation-identifiedbytheapplication/atom+xmlcontenttype.
FormatrepresentationrulesareoutlinedinCoreOSLCCoreResourceFormatssection.
AuthenticationSeeOSLCCoreAuthenticationsection.
InadditiontotheOSLCCoreauthenticationrequirements,OSLCPLCMservicesprovidersSHOULDsupportOAuth.
ErrorResponsesSeeOSLCCoreErrorResponsessection.
OSLCPLCMputsnoadditionalconstraintsonerrorresponses.
PaginationOSLCCPLMserviceprovidersSHOULDsupportpaginationofqueryresultsandMAYsupportpaginationofasingleresource'spropertiesasdefinedbytheOSLCCoreSpecification.
RequestingandUpdatingPropertiesRequestingaSubsetofPropertiesAclientMAYrequestasubsetofaresource'spropertiesaswellaspropertiesfromareferencedresource.
InordertosupportthisbehavioraserviceproviderMUSTsupporttheoslc.
propertiesandoslc.
prefixURLparameteronaHTTPGETrequestonindividualresourcerequestoracollectionofresourcesbyquery.
Iftheoslc.
propertiesparameterisomittedontherequest,thenallresourcepropertiesMUSTbeprovidedintheresponse.
UpdatingaSubsetofPropertiesAclientMAYrequestthatasubsetofaresource'spropertiesbeupdatedbyidentifyingthosepropertiestobemodifiedusingtheoslc.
propertiesURLparameteronaHTTPPUTrequest.
Iftheparameteroslc.
propertiescontainsavalidresourcepropertyontherequestthatisnotprovidedinthecontent,theserverMUSTsettheresource'spropertytoanulloremptyvalue.
Iftheparameteroslc.
propertiescontainsaninvalidresourceproperty,thena409ConflictMUSTbereturned.
UpdatingMulti-ValuedPropertiesFormulti-valuedpropertiesthatcontainalargenumberofvalues,itmaybedifficultandinefficienttoaddorremovepropertyvalues.
OSLCPLCMServiceProvidersSHOULDprovidesupportforapartialupdateofthemulti-valuedpropertiesasdefinedbyOSLCCorePartialUpdate.
StatePredicatesAnProbablythemostimportantpropertyofaProductChangeRequestisthelifecyclestatusproperty.
"Status"specifiesanassessmentorindicatorofProductconditionorstate,whichmayalsoexistinsomethelocationofaChangeRequestinaworkflow.
Inqueries,theoslc_plcm:statuspropertyisusedtofilterchangerequest(e.
g.
allProductschangerequeststhataresayin"Generalreleasefixed")andmaybeusedtoperformstatetransitions(notpartofthisspecification)onaProductchangerequest,e.
g.
withdrawingclosingaProductchangerequestas"Withdrawnfixed".
TheproblemisthatdifferentPLCMserviceprovidersusedifferentproperties(orevenasetofproperties)anddifferentvaluestorepresenttheProductlifecyclechangerequest'sstate.
Evenprovidingaccesstometadatadoesnothelpbecauseknowingallpossiblestatevaluesdoesnotrevealthesemanticsofastate.
Predicatesareexposedassingle-valueoftenread-onlypropertiesonaChangeProductRequestresource.
Anattempttoupdateread-onlypredicatesSHOULDbeansweredwitha409ConflictHTTPstatuscode.
TheirpresenceinaresourcerepresentationusedforanupdateviaPUTMUSTNOTpreventtheresourcefrombeingupdated.
PredicatesMUSTbequeryable.
TheChangeRequestProductresourcedefinitionsectionsdefinesthecompletesetofpredicates.
LabelsforRelationshipsChangeManagementProductrelationshipstootherresourcesarerepresentedaspropertieswhosevaluesaretheURIoftheobjectortargetresource.
WhenaProductLifecycleChangeManagementrelationshippropertyistobepresentedinauserinterface,itmaybehelpfultoprovideaninformativeandusefultextuallabelforthatrelationshipinstance.
(ThisinadditiontotherelationshippropertyURIandtheobjectresourceURI,whicharealsocandidatesforpresentationtoauser.
)Tothisend,OSLCprovidersMAYsupportadcterms:titlelinkpropertyinChangeProductLifecycleManagementresourcerepresentations,usingtheanchorapproachoutlinedintheOSLCCoreLinksGuidance.
RDF/XMLandXMLexampleusingreifiedstatement:Defect123:ProblemsduringinstallJSONexampleusingrefiedstatement:{"prefixes":{"dcterms":"http://purl.
org/dc/terms/","rdf"http://www.
w3.
org/1999/02/22-rdf-syntax-ns#","oslc"http://open-services.
net/ns/core#","oslc_cm":"http://open-services.
net/ns/cm#"},"rdf:type"rdf:resource":"http://open-services.
net/ns/cm#ChangeRequest"}],"rdf:about":"http://example.
com/bugs/4321","oslc_cm:relatedChangeRequest":{"rdf:resource":"http://anotherexample.
com/defects/123","dcterms:title":"Defect123:Problemsduringinstall"}}PLCMResourceDefinitionsPropertyvaluetypesthatarenotdefinedinthefollowingsections,aredefinedinOSLCCore-DefiningOSLCPropertiesResourceChangeRequestProductTheChangeRequestProductresourceisasingledefinitionusedtodefinemanykindsofproductchasngerequestssuchas:individualproducts,families,variantsdefect,enhancement,task,bug,activity,etc.
Thereareafairnumberofcommonpropertiesbetweenthesedifferentkindsofproductchangerequestsandcanusesomeofthepropertiesinthefollowdefinitiontoidentifythem.
TheProductChangeRequestresourcepropertiesarenotlimitedtotheonesdefinedinthisspecification,serviceprovidersmayprovideadditionalproperties.
Itisrecommendedthatanyadditionalpropertiesexistintheirownuniquenamespaceandnotusethenamespacesdefinedinthesespecifications.
Name:ChangeRequestProductTypeURIhttp://open-services.
net/ns/plm#ProductResourceProductversionTheProductversionresourceisusedtosupportidentificationofchangestoaProductresourceTheProductVersionresourcepropertiesarenotlimitedtotheonesdefinedinthisspecification,serviceprovidersmayprovideadditionalproperties.
Itisrecommendedthatanyadditionalpropertiesexistintheirownuniquenamespaceandnotusethenamespacesdefinedinthesespecifications.
Name:ProductVersionTypeURIhttp://open-services.
net/ns/plm#ProductVersionResourceProductviewTheProductviewresourceisaresolveddefinitionofthecompositionofaProductversion.
Thatcompositionmayallowmanykindsofproductssuchas:individualproducts,families,variantsetctobehostedandresolved,eitherfullytoaspecificcompositionortosomesuper-set.
TheProductViewresourcepropertiesarenotlimitedtotheonesdefinedinthisspecification,serviceprovidersmayprovideadditionalproperties.
Itisrecommendedthatanyadditionalpropertiesexistintheirownuniquenamespaceandnotusethenamespacesdefinedinthesespecifications.
Name:ProductViewTypeURIhttp://open-services.
net/ns/plm#ProductViewPrefixedNameOccursRead-onlyValue-typeRepresen-tationRangeDescriptionRecommendedconstrainedusageofselectedOSLCCore:CommonPropertiesoslc:shortTitlezero-or-oneunspecifiedXMLLiteraln/an/aShortnameidentifyingaresource,oftenusedasanabbreviatedidentifierforpresentationtoend-users.
SHOULDincludeonlycontentthatisvalidinsideanXHTMLelement.
SHOULDrepresenttheProductnumberdcterms:descriptionzero-or-oneunspecifiedXMLLiteraln/an/aDescriptivetext(reference:DublinCore)aboutresourcerepresentedasrichtextinXHTMLcontent.
SHOULDincludeonlycontentthatisvalidandsuitableinsideanXHTMLelement.
SHOULDrepresenttheProductdescriptiondcterms:titleexactly-oneunspecifiedXMLLiteraln/an/aTitle(reference:DublinCore)oroftenasinglelinesummaryoftheresourcerepresentedasrichtextinXHTMLcontent.
SHOULDincludeonlycontentthatisvalidandsuitableinsideanXHTMLelement.
SHOULDrepresenttheproductnamedcterms:identifierexactly-oneTrueStringn/an/aAuniqueidentifierforaresource.
Assignedbytheserviceproviderwhenaresourceiscreated.
Notintendedforend-userdisplay.
SHOULDrepresenttheApplicationuniqueidfortheproductresource/object.
dcterms:subjectzero-or-manyFalseStringn/an/aTagorkeywordforaresource.
Eachoccurrenceofadcterms:subjectpropertydenotesanadditionaltagfortheresource.
WithinaProductviewresourceSHOULDrepresenttheProductversionUsageofCore:Commonpropertiesdcterms:creatorzero-or-manyunspecifiedEitherResourceorLocalResourceEitherReferenceorInlineanyCreatororcreatorsofresource(reference:DublinCore).
Itislikelythatthetargetresourcewillbeafoaf:Personbutthatisnotnecessarilythecase.
dcterms:contributorzero-or-manyunspecifiedEitherResourceorLocalResourceEitherReferenceorInlineanyTheperson(s)whoareresponsiblefortheworkneededtocompletethechangerequest(reference:DublinCore).
Itislikelythatthetargetresourcewillbeafoaf:Personbutthatisnotnecessarilythecase.
dcterms:createdzero-or-oneTrueDateTimen/an/aTimestampofresourcecreation(reference:DublinCore).
dcterms:modifiedzero-or-oneTrueDateTimen/an/aTimestamplastlatestresourcemodification(reference:DublinCore).
rdf:typezero-or-manyunspecifiedResourceReferencen/aTheresourcetypeURIs.
Oneofatleasthasthevalueofhttp://open-services.
net/ns/cm#ChangeRequestoslc:serviceProviderzero-or-manyunspecifiedResourceReferenceoslc:ServiceProviderThescopeofaresourceisaURIfortheresource'sOSLCServiceProvider.
oslc:instanceShapezero-or-oneunspecifiedResourceReferenceoslc:ResourceShapeResourceShapethatprovideshintsastoresourcepropertyvalue-typesandallowedvalues.
oslc:discussedByzero-or-oneunspecifiedResourceEitheroslc:DiscussionAseriesofnotesandcommentsaboutthischangerequest.
PrefixedNameOccursRead-onlyValue-typeRepresen-tationRangeDescriptionOSLCPCLM:Startofadditionalpropertiesdcterms:isVersionOfzerooroneUnspecifiedEitherResourceorLocalResourceEitherReferenceorInlineresourceofsametypeArelatedresourceofwhichthedescribedresourceisaversion,edition,oradaptation.
OSLCusagerequiresthetargetresourceMUSTbearesourceofthesametypeastheowningresource.
dcterms:hasVersionzeroormanyUnspecifiedEitherResourceorLocalResourceEitherReferenceorInlineresourceofsametypeArelatedresourcethatisaversion,edition,oradaptationofthedescribedresource.
OSLCusagerequiresthetargetresourceMUSTbearesourceofthesametypeastheowningresource.
dcterms:replaceszeroormanyUnspecifiedEitherResourceorLocalResourceEitherReferenceorInlineresourceofsametypeArelatedresourcethatissupplanted,displaced,orsupersededbythedescribedresource.
OSLCusagerequiresthetargetresourceMUSTbearesourceofthesametypeastheowningresource.
dcterms:hasPartzeroormanyUnspecifiedEitherResourceorLocalResourceresourceofsametypeArelatedresourcethatidentiesaproductmebrshipofaview.
applicationRefProvidesareferencelocaterforalocalapplicationthatisunabletouseURIsdirectlytolocateresourcesVariantExpressionZeroormanyAnexpressionprovidedasannotationtoalinkthatisprocessedbyaProductresourcetoresolveproductvariation;henceresolvingtoaversionand/orviewdcterms:typezero-or-moreunspecifiedStringn/an/aAshortstringrepresentationforthetype,example'Defect'.
oslc_cm:closeDatezero-or-onetrueDateTimen/an/aThedateatwhichnofurtheractivityorworkisintendedtobeconducted.
oslc_cm:statuszero-or-oneunspecifiedStringn/an/aUsedtoindicatethestatusofthechangerequestbasedonvaluesdefinedbytheserviceprovider.
Mostoftenaread-onlyproperty.
Somepossiblevaluesmayinclude:'Submitted','Done','InProgress',etc.
SHOULDrepresentProductlifecyclestatusPrefixedNameOccursRead-onlyValue-typeRepresen-tationRangeDescriptionStatepredicateproperties:Thisgroupingofpropertiesdefineasetofcomputedstatepredicates,seesectiononStatePredicatesformoreinformation.
Theonlyrestrictiononvalidstatepredicatecombinationsisthatifoslc_cm:inprogressistrue,thenoslc_cm:fixedandoslc_cm:closedmustalsobefalseoslc_cm:closedzero-or-oneTrueBooleann/an/aWhetherornottheChangeRequestiscompletelydone,nofurtherfixesorfixverificationisneeded.
oslc_cm:inprogresszero-or-oneTrueBooleann/an/aWhetherornottheChangeRequestinastateindicatingthatactiveworkisoccurring.
Ifoslc_cm:inprogressistrue,thenoslc_cm:fixedandoslc_cm:closedmustalsobefalseoslc_cm:fixedzero-or-oneTrueBooleann/an/aWhetherornottheChangeRequesthasbeenfixed.
oslc_cm:approvedzero-or-oneTrueBooleann/an/aWhetherornottheChangeRequesthasbeenapproved.
oslc_cm:reviewedzero-or-oneTrueBooleann/an/aWhetherornottheChangeRequesthasbeenreviewed.
oslc_cm:verifiedzero-or-oneTrueBooleann/an/aWhetherornottheresolutionorfixoftheChangeRequesthasbeenverified.
PrefixedNameOccursRead-onlyValue-typeRepresen-tationRangeDescriptionRelationshipproperties:ThisgroupingofpropertiesareusedtoidentifyrelationshipsbetweenresourcesmanagedbyotherOSLCServiceProvidersoslc_cm:relatedChangeRequestzero-or-manyFalseResourceReferenceanyThisrelationshipislooselycoupledandhasnospecificmeaning.
Itislikelythatthetargetresourcewillbeanoslc_cm:ChangeRequestbutthatisnotnecessarilythecase.
oslc_cm:affectsPlanItemzero-or-manyFalseResourceReferenceanyChangerequestaffectsaplanitem.
Itislikelythatthetargetresourcewillbeanoslc_cm:ChangeRequestbutthatisnotnecessarilythecase.
oslc_cm:affectedByDefectzero-or-manyFalseResourceReferenceanyChangerequestisaffectedbyareporteddefect.
Itislikelythatthetargetresourcewillbeanoslc_cm:ChangeRequestbutthatisnotnecessarilythecase.
oslc_cm:tracksRequirementzero-or-manyFalseResourceReferenceanyTrackstheassociatedRequirementorRequirementChangeSetresources.
Itislikelythatthetargetresourcewillbeanoslc_rm:Requirementbutthatisnotnecessarilythecase.
oslc_cm:implementsRequirementzero-or-manyFalseResourceReferenceanyImplementsassociatedRequirement.
Itislikelythatthetargetresourcewillbeanoslc_rm:Requirementbutthatisnotnecessarilythecase.
oslc_cm:affectsRequirementzero-or-manyFalseResourceReferenceanyChangerequestaffectingaRequirement.
Itislikelythatthetargetresourcewillbeanoslc_rm:Requirementbutthatisnotnecessarilythecase.
oslc_cm:testedByTestCasezero-or-manyFalseResourceReferenceanyTestcasebywhichthischangerequestistested.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestCasebutthatisnotnecessarilythecase.
oslc_cm:affectsTestResultzero-or-manyFalseResourceReferenceanyAssociatedQMresourcethatisaffectedbythisChangeRequest.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestResultbutthatisnotnecessarilythecase.
oslc_cm:blocksTestExecutionRecordzero-or-manyFalseResourceReferenceanyAssociatedQMresourcethatisblockedbythisChangeRequest.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestExecutionRecordbutthatisnotnecessarilythecase.
oslc_cm:relatedTestExecutionRecordzero-or-manyFalseResourceReferenceanyRelatedtoaQMtestexecutionresource.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestExecutionRecordbutthatisnotnecessarilythecase.
oslc_cm:relatedTestCasezero-or-manyFalseResourceReferenceanyRelatedQMtestcaseresource.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestCasebutthatisnotnecessarilythecase.
oslc_cm:relatedTestPlanzero-or-manyFalseResourceReferenceanyRelatedQMtestplanresource.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestPlanbutthatisnotnecessarilythecase.
oslc_cm:relatedTestScriptzero-or-manyFalseResourceReferenceanyRelatedQMtestscriptresource.
Itislikelythatthetargetresourcewillbeanoslc_qm:TestScriptbutthatisnotnecessarilythecase.
oslc_cm:tracksChangeSetzero-or-manyFalseResourceReferenceanyTracksSCMchangesetresource.
Itislikelythatthetargetresourcewillbeanoslc_scm:ChangeSetbutthatisnotnecessarilythecase.
Namingconventionforrelationshippropertiesfollowsthispattern:related-IdentifiesalooserelationshipbetweenaChangeRequestProductandreferencedresource.
Theserelationshipscanbeusedtonameassociatedresourcesmanagedbyotherserviceproviders.
tracks-IdentifiesthataChangeRequestProductisusedtotrackthelifecycleofreferencedresource.
FromthePLCMtoolperspective,theserelationshipscanbeusedtotrackworkthatneedstobedoneforreferencedresources.
affects-IndicatesthattheChangeRequestProductaffects,hasbeenpredeterminedtohaveimpact,relatedresource.
Thesepropertyrelationshipscanbeusedtounderstandthepotentialimpactofreferencedresources.
PLCMServiceProviderCapabilitiesServiceProviderResourcesOSLCCPLMserviceprovidersMUSTprovideaServiceProviderResourcethatcanberetrievedataimplementationdependentURI.
OSLCCPLMserviceprovidersMAYprovideaServiceProviderCatalogResourcethatcanberetrievedataimplementationdependentURI.
OSLCCPLMserviceprovidersMUSTprovideaoslc:serviceProviderpropertyfortheirdefinedresourcesthatwillbetheURItoaServiceProviderResource.
OSLCCPLMserviceprovidersMUSTsupplyavalueofhttp://open-services.
net/ns/plcm#forthepropertyoslc:domainoneitheroslc:Serviceoroslc:ServiceProviderCatalogresources.
CreationFactoriesOSLCPLCMserviceprovidersMUSTsupportCreationFactoriesandlistthemintheServiceProviderResourceasdefinedbyOSLCCore.
OSLCCPLMserviceprovidersSHOULDsupportResourceShapesforCreationFactoriesasdefinedinOSLCCoreSpecificationQueryCapabilitiesOSLCCPLMserviceprovidersMUSTsupporttheQueryCapabilitiesasdefinedbyOSLCCore.
OSLCCPLMserviceprovidersSHOULDsupportResourceShapesforQueryCapabilityasdefinedinOSLCCoreSpecificationTheQueryCapabilityMUSTsupporttheseparameters:oslc.
whereoslc.
selectoslc.
propertiesoslc.
prefixIfshapeinformationisNOTpresentwiththeQueryCapability,serviceprovidersSHOULDusethesedefaultpropertiestocontaintheresult:ForRDF/XMLandXML,userdf:Descriptionandrdfs:memberasdefinedinOSLCCoreRDF/XMLExamplesForJSON,thequeryresultsarecontainedwithinoslc:resultsarray.
SeeOSLCCoreRepresentationGuidanceforJSONDelegatedUIsOSLCPLCMserviceprovidersMUSTsupporttheselectionandcreationofresourcesbydelegatedweb-baseduserinterfacedialogsDelegatedUIsasdefinedbyOSLCCore.
OSLCPLCMserviceprovidersMAYsupportthepre-fillingofcreationdialogsbasedonthedefinitionatDelegatedUIs.
UsageIdentifiersOSLCCPLMserviceprovidercanidentifytheusageofvariousserviceswithadditionalpropertyvaluesfortheOSLCCoredefinedoslc:usagepropertyonoslc:Dialog,CreationFactoryandQueryCapability.
Theoslc:usagepropertyvalueofhttp://open-services.
net/ns/core#defaultwillbeusedtodesignatethedefaultorprimaryservicetobeusedbyconsumerswhenmultipleentriesarefound.
Theadditionalpropertyvaluesforoslc:usageare:http://open-services.
net/ns/cm#defect-primarilyusedbyQMtoolstoreportdefectsintesting.
http://open-services.
net/ns/cm#planItem-usedbyQMandPPMtoolsforassociatingchangerequestsintoplans(project,release,sprint,etc).
http://open-services.
net/ns/cm#task-usedbyQMandPPMtoolsforassociatingchangerequestsintoexecutableandtrack-ableitems.
http://open-services.
net/ns/cm#requirementsChangeRequest-usedbyRMtoolsforassociatingachangerequestforusageintrackingchangestoaRequirementsresourceVersionCompatibilitywith1.
0SpecificationsThegoalistoprovideasmoothtransitionto2.
0forbothConsumersandProviders.
Thissectionwillclarifytheusageof1.
0mediatypessothatProviderscansupportboth1.
0and2.
0ConsumerswhenHTTPrequestsaremadeforaresourcewiththesameURI.
NetworkaddressableresourceURIsusedfor1.
0resourcesforthesetypes:ChangeRequest,ServiceDescriptorandServiceProviderCatalog,shouldnothavetochange.
Consumerswhosupportboth1.
0and2.
0,shouldonlypreservetheseresourceURIs.
WhenaProviderstartstoserve2.
0resourceformats,forinstancetheServiceProviderresource,itisrecommendedtoupdateitslocallystoredorcachedinformationaboutthecontentsoftheServiceProviderresourceastheURIstovariouscapabilitiesmayhavechanged(query,delegatedUIs,factories,etc).
MediaTypesForaChangeRequestResourceformatidentificationofRDF/XMLandXML,themediatypeusedforthisrepresentationSHOULDbeapplication/rdf+xmlorapplication/xml.
TheusageoftheOSLCCM1.
0definedmediatypesofapplication/x-oslc-cm-change-request+xml,application/x-oslc-cm-service-description+xmlandapplication/x-oslc-disc-service-provider-catalog+xmlisbeingdepreciated.
ForaChangeRequestResourceformatidentificationofJSON,themediatypeusedforthisrepresentationSHOULDbeapplication/json.
TheusageoftheOSLCCM1.
0definedmediatypeofapplication/x-oslc-cm-change-request+jsonisbeingdepreciated.
RequestingformatsCM1.
0consumerswantingtorequest1.
0resourceformatswillnotneedtochangeiftheyused1.
0definedmediatypes(application/x-oslc-cm*),seeOSLC-CM1.
0.
CM2.
0consumersshouldusemediatypesasdefinedinthisspecificationforrequests,excludingtheOSLCCM1.
0specificmediatypes(application/x-oslc-cm*).
CMconsumerssupportingboth1.
0and2.
0,shouldrequestrequestboth1.
0and2.
0mediatypesonHTTPGETrequestsasusuallydonewithHTTPrequestparameterAcceptgivingappropriatequality(SeeHTTPAccept)weightingtohelpdistinguishtheirpreferredcontent.
Foradditionalguidance,aCM2.
0consumerorprovidermayreferencetheOSLC-Core-VersionHTTPheaderwithavalueof2.
0.
AppendixA:Samples(thissectionisinformative)SeePlCmSpecificationV12SamplesAppendixB:ResourceShapes(thissectionisinformative)SeePlCmSpecificationV12ShapesAppendixC:NoticesandReferencesContributorsSteveSpeicher(IBM,OSLC-CMLead)OlivierBerger(InstitutTELECOM)ScottBosworth(IBM)GaryDang(Accenture)SusanDuncan(Oracle)RobertElves(Tasktop)MatsGothe(IBM)DaveJohnson(IBM)MikKersten(Tasktop)SamLee(IBM)MarkRinger(Rally)EricSink(SourceGear)PatrickStreule(IBM)MattThomas(BSDGroup)DenisTyrell(Oracle)RandyVogel(Accenture)AndreWeinand(IBM)SofiaYeung(Oracle)GrayBachelor(IBM)MikeLoeffler(GM)….
….
.
ReportingIssuesontheSpecificationTheworkinggroupparticipantswhoauthorandmaintainthisworkingdraftspecification,monitoradistributionlistwhereissuesorquestionscanberaised,seeChangePLMManagementMailingListAlsotheissuesfoundwiththisspecificationandtheirresolutioncanbefoundatPlCmSpecV12IssuesIntellectualPropertyCovenantThemembersoftheWorkingGroup(orasappropriate,theiremployers)havedocumentedaPatentNon-AssertionCovenantforimplementationsofthePLCM12.
0Specification,asdescribedintheopen-services.
netTermsofUse.
DetailsoftheCovenantmaybefoundhere.
ReferencesOSLC-CM1.
0-OSLCChangeManagementSpecification1.
0OSLCCore-OSLCCoreSpecification2.
0OSLC-CM-OSLCCMSpecification2.
0OSLC-SCM1.
0-OSLCSoftwareConfigurationManagementSpecification1.
0OSLC-QM2.
0-OSLCQualityManagementSpecification2.
0OSLC-RM2.
0-OSLCRequirementsManagementSpecification2.
0ATOM-RFC4287-AtomSyndicationFormatDublinCore1.
1-DublinCoreMetadataElementSet,Version1.
1FOAF-FriendofaFriend(FOAF)v0.
98HTTP1.
1-Hyper-textTransferProtocol(HTTP/1.
1)JSON-JavaScriptObjectNotationPLMXML–www.
plmxml.
org/Schemas/PLMXMLSchemaOAuth1.
0a-RFC5849-TheOAuth1.
0ProtocolRDF/XMLConcepts-RDF/XMLConceptsandAbstractSyntaxRDF/XMLSyntax-RDF/XMLSyntaxSpecification(Revised)URISyntax-URIGenericSyntaxXMLNamespaces-NamespacesinXML1.
0(ThirdEdition)XSDDatatypes-XMLSchemaPart2:DatatypesSecondEdition