UMLNIEM — NIEM-UML Issue - Changelog

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

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:
The suggested resolution is accepted.