Issue 18179: NIEM-UML Issue - Changelog (niem-uml-ftf) Source: Model Driven Solutions (Mr. Tom Digre, tom.digre(at)yahoo.com) Nature: Uncategorized Issue Severity: Summary: Issue: The MPD Specification includes several rules related to the requirement that MPDs must have changelogs. These rules are: [Rule 4-11] Every MPD that is a reference schema set (i.e., NIEM releases, core updates, and domain updates) MUST contain an XML change log artifact that: • Validates with the NIEM change log schemas (mpd-changelog.xsd andd niem-model.xsd). Note: These are the base filenames; the actual filenames also contain a version number. For example: mpd-changelog-1.0.xsd is the current version. • Records changes to previous reference schemas that thiss MPD represents. • Bears the file name "changelog.xml". โโ€ข Resides in the root directory of the MPD. [Rule 4-12] Every MPD that is an IEPD or EIEM MUST contain a change log artifact that: • Recordss changes to previous IEPD or EIEM schemas that this MPD represents. • Begins with the substring ""changelog". • Resides in the root directory of the MPD. [Rule 4-13] The initial version of an IEPD or EIEM MUST contain a change log artifact with at least one entry for its creation date. [Rule 4-13.1] If an IEPD or EIEM contains more than one change log artifact, then each change log artifact MUST: • Have a file name that begins with the substrinng "changelog". • Reside in the MPD root directory . > While the majority of an MPD-conformant changelog can be constructed from model version change analysis, there are some description fields that probably require editing by the modeler. These include: ChangeLogType ChangeLogSummaryText (String) ChangeLogSubmitterName (String) ChangeLogApplicationInstructionsText (String) ChangeInformationType ChangeSummaryText(String) ChangeReasonText (String) ChangeFullDescriptionText (String) ChangeNCCTIssueNumber (Integer) ChangeCode (Enumeration) Suggested resolution: Add the following to Profile NIEM_UML::Model_Package_Description_Profile Stereotype ChangeLogType (no specific recommendation on extension at this time) Tag ChangeLogSummaryText (String 0..1) Tag ChangeLogSubmitterName (String 0..1) Tag ChangeLogApplicationInstructionsText (String 0..1) Stereotype ChangeInformationType (no specific recommendation on extension at this time) Tag ChangeSummaryText (String 0..1) Tag ChangeReasonText (String 0..1) Tag ChangeFullDescriptionText (String 0..1) Tag ChangeNCCTIssueNumber (Integer 0..*) Tag ChangeCode (ChangeCodeSimpleType 0..*) Enumeration ChangeCodeSimpleType EnumerationLiteral new_requirement EnumerationLiteral bug_fix EnumerationLiteral refactoring EnumerationLiteral harmonization EnumerationLiteral general_improvement Resolution: Revised Text: Actions taken: October 18, 2012: received issue Discussion: End of Annotations:===== hoo-Newman-Property: ymail-3 X-Yahoo-Newman-Id: 998946.22956.bm@omp1046.mail.sp2.yahoo.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.com; s=s1024; t=1350569545; bh=VvMI8GDl03iQN4kBmsrdnCP8BVJ03FFJXb6VO8CnPHk=; h=X-YMail-OSG:Received:X-Rocket-MIMEInfo:X-Mailer:Message-ID:Date:From:Reply-To:Subject:To:Cc:MIME-Version:Content-Type; b=4zJcmO259P7VDqsai9Z4YdDiwUzVrTL0Ip/de3HB9v/BFDXdKsaHN9QIP2kK7kpY7hscvS8adwFMh7IDDCAXZOuO5qwM0Ut+THoR7yLcGP7tUPSjM1/mR00MiE+dipck6tbDPF9hmBgBBW6HKVyl4xiHNLNpBALfW4OCIwXtng8= DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=s1024; d=yahoo.com; h=X-YMail-OSG:Received:X-Rocket-MIMEInfo:X-Mailer:Message-ID:Date:From:Reply-To:Subject:To:Cc:MIME-Version:Content-Type; b=JunNoNpozorhF/QIe/+gZxFuYSFzjorpHzjA9AeADQ10HZCWSv8+Wpg9RFK8A0BlaePpIxo1Is6yM2h9efHqDKr6o50jmZrWu71PbOIu0nQx9AXjPatJ5FBgOIBNQ1xGwW/lQ1w9kQmDLsP6ne/CmXbSwtN0McnPIf9bylwcExc=; X-YMail-OSG: 1WvO3QwVM1kdSKyHN2SuH7MH89yUWjoaAEarV9GyHoiUeb5 NXTF80IrWW4SgyMEpqpDmALgjxIfSacQTf0h.EH.fwLRJmBhk3txaSMtTMB0 awpWAlE2MQkMB7SWt3gqJe1285ETIKgTA_fK4Tf.JGMtWmMjq4a4Pkm_0mHZ iYk1IgwMvNd_aL5L0tT97WobujNIo.FsWBv.ZYLuXeGd9UZ.Vpz7R6PiL1TH uEeC1Z9ngf7B3GZ.ryyyprnp_RUhlbhAo_JGB1cXNDXImNeIQfs.3tg_6bEP sIMAFy.upk3jwo0eJRHCCWNAqpur_SlvH8AR6NFjMmo_U3f_Dd8f5oKHBYeR iuBuoMADT.NbiEViPXQAXSVWq_kttf6BScWCQhrcljGTyn9FyX.9pciazIhG mEGO5kJnwg35UlYcziBaurjFZkEhH1.j3kK8fhzDg2mUssOx5AgLDo2SdjpD SlOiLYweWpv8GifDp5KY- X-Rocket-MIMEInfo: 001.001,SXNzdWU6IFRoZSBNUEQgU3BlY2lmaWNhdGlvbiBpbmNsdWRlcyBzZXZlcmFsIHJ1bGVzIHJlbGF0ZWQgdG8gdGhlIHJlcXVpcmVtZW50IHRoYXQgTVBEcyBtdXN0IGhhdmUgY2hhbmdlbG9ncy7CoCBUaGVzZSBydWxlcyBhcmU6CgpbUnVsZSA0LTExXSBFdmVyeSBNUEQgdGhhdCBpcyBhIHJlZmVyZW5jZSBzY2hlbWEgc2V0IChpLmUuLCBOSUVNIHJlbGVhc2VzLCBjb3JlIHVwZGF0ZXMsIGFuZCBkb21haW4gdXBkYXRlcykgTVVTVCBjb250YWluIGFuIFhNTCBjaGFuZ2UgbG9nIGFydGlmYWN0IHRoYXQ6CuKAoiABMAEBAQE- X-Mailer: YahooMailWebService/0.8.123.450 Date: Thu, 18 Oct 2012 07:12:25 -0700 (PDT) From: Tom Digre Reply-To: Tom Digre Subject: NIEM-UML Issue - Changelog To: "issues@omg.org" Cc: Cory Casanave Issue: The MPD Specification includes several rules related to the requirement that MPDs must have changelogs. These rules are: [Rule 4-11] Every MPD that is a reference schema set (i.e., NIEM releases, core updates, and domain updates) MUST contain an XML change log artifact that: . Validates with the NIEM change log schemas (mpd-changelog.xsd andd niem-model.xsd). Note: These are the base filenames; the actual filenames also contain a version number. For example: mpd-changelog-1.0.xsd is the current version. . Records changes to previous reference schemas that thiss MPD represents. . Bears the file name "changelog.xml". รขยข Resides in the root directory of the MPD. [Rule 4-12] Every MPD that is an IEPD or EIEM MUST contain a change log artifact that: . Recordss changes to previous IEPD or EIEM schemas that this MPD represents. . Begins with the substring ""changelog". . Resides in the root directory of the MPD. [Rule 4-13] The initial version of an IEPD or EIEM MUST contain a change log artifact with at least one entry for its creation date. [Rule 4-13.1] If an IEPD or EIEM contains more than one change log artifact, then each change log artifact MUST: . Have a file name that begins with the substrinng "changelog". . Reside in the MPD root directory . > While the majority of an MPD-conformant changelog can be constructed from model version change analysis, there are some description fields that probably require editing by the modeler. These include: ChangeLogType ChangeLogSummaryText (String) ChangeLogSubmitterName (String) ChangeLogApplicationInstructionsText (String) ChangeInformationType ChangeSummaryText(String) ChangeReasonText (String) ChangeFullDescriptionText (String) ChangeNCCTIssueNumber (Integer) ChangeCode (Enumeration) Suggested resolution: Add the following to Profile NIEM_UML::Model_Package_Description_Profile Stereotype ChangeLogType (no specific recommendation on extension at this time) Tag ChangeLogSummaryText (String 0..1) Tag ChangeLogSubmitterName (String 0..1) Tag ChangeLogApplicationInstructionsText (String 0..1) Stereotype ChangeInformationType (no specific recommendation on extension at this time) Tag ChangeSummaryText (String 0..1) Tag ChangeReasonText (String 0..1) Tag ChangeFullDescriptionText (String 0..1) Tag ChangeNCCTIssueNumber (Integer 0..*) Tag ChangeCode (ChangeCodeSimpleType 0..*) Enumeration ChangeCodeSimpleType EnumerationLiteral new_requirement EnumerationLiteral bug_fix EnumerationLiteral refactoring EnumerationLiteral harmonization EnumerationLiteral general_improvement