Detailed Release Note Change 238257 Re-baseline UMIG XSDs

Context Risks identified with UMIG XSD modelling approach Solution Dependency on external custom tooling Prone to inconsistencies and manual errors Complicated versioning approach Solution Migration of modelling tool Rationalization of modelling approach Goal Isofunctional XSDs with the same “look and feel” Result 6.5.1.11 published on 04/05/2018: first “new style” XSDs 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

“New style” XSDs “New style” XSDs already published in v6.5.1.11 and v6.5.1.12 AllocationResultsForTransmissionSystemOperatorElectricity BasicPreswitchInformation BasicPreswitchInformationForThirdParty BasicPreswitchInformationForThirdPartySynchronous BasicPreswitchInformationSynchronous FullPreswitchInformation FullPreswitchInformationForThirdParty MeterReadBeginIndex NotificationOfActivationOfServiceComponent RequestRectification Corrections and other differences with previous publications Removal of comments Different order of elements, complexTypes,... Addition of space before closing tag Removal of unused datatypes Enumeration restrictions Replaced fixed values 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Removal of comments As-is To-be Disclaimer & comments for readability Comments deleted from all XSDs No impact 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Different order of elements, complexTypes,... As-is To-be Certain order of elements (and tags) Different order of elements (and tags) in all XSDs No impact Consequence: compare between old and new version of XSD not possible with “standard” tools (e.g. XMLSpy) Workaround: open source tool “XmlDiff” https://github.com/GeertBellekens/XmlDiff/releases 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Addition of space before closing tag As-is To-be No space before closing tag Space added before closing tag in all XSDs No impact 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Removal of unused datatypes As-is To-be Certain datatypes present in MessageDataType XSDs, but not used Unused datatypes deleted from all MessageDataType XSDs No impact 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Enumeration restrictions As-is To-be Not always a restriction on the possible values where a code list is used Example: code list contains values BH8 and BMO, but not shown where code list is actually used Restrictions added everywhere an enumeration is used No impact 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

“fixed” attribute is used to restrict value Replaced fixed value As-is To-be “fixed” attribute is used to restrict value Enumeration with only 1 possible value is used Impact: Change 237930 created for new minor version of following XSDs IndividualTransactionCostInvoicingInvoice TransactionCostInvoicingDataByServiceDeliveryPoint 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Change 238257 - additional scope Incremental publication approach not optimal  new minor version of all UMIG XSDs to be published in v6.5.1.13 (27/07/2018) Further optimizations within the same new minor version Merge of document XSDs Reduction of number of elements Different order of elements, complexTypes,... Removal of enumeration descriptions Renaming of XSD files Restructuring of ZIP-file 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Merge of document XSDs As-is To-be 3 document XSDs for 1 message Import of generic code list XSDs To-be 1 XSD for 1 message, including the used codes No more dependency on separate generic code list XSDs UMIG - IM - XD - 05 - XML Schemas As-is To-be Total number of XSDs 588 139* document XSDs 387 generic XSDs 201 Example: RequestMoveIn 42 3 document XSDs 39 generic XSDs 1 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs” * 129 XSDs previously in the zip-file + 10 UMIG PPP XSDs

Illustration: impact of a simple change Requirement Add a new value “XYZ” for attribute EnergyBusinessLabel for use in RequestMoveIn * EnergyBusinessLabel is present in 74 messages, so generic code list 260_BE000202 is imported in the MessageDataType XSD of these messages. The other 2 document XSDs also receive a new minor version.  Impact on 244 XSDs even though the new value will only be used for RequestMoveIn. As-is To-be New minor version of 2 generic code list XSDs 260_BE000009 260_BE000202 New minor version of all 222 document XSDs* AggregatedGridfeeInvoice AggregatedPrepaymentGridfeeInvoice ... New minor version of 1 XSD RequestMoveIn Total = 224 XSDs Total = 1 XSD 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Pros and cons Pro Lifecycle of a message independent of other messages Complexity hidden, but consistency guaranteed by underlying model (managed at Atrias) No import of generic XSDs needed for code lists, all enumeration values are included in the XSD itself Size of XSD reduced  better performance Non-breaking change (new minor version) Compare between following versions will be easier to interpret Con Compare between previous version and first new version will be impossible to interpret Atrias will compare through “flattening” the old XSDs & will validate old sample XML messages with the new XSDs 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Reduction of number of elements As-is Multiple elements possible as root element XML can be XSD-valid if wrong root element is chosen To-be Limit to 1 element 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Different order of elements, complexTypes,... As-is No clear order To-be Root element Complex types (alphabetically) Data types (alphabetically) Code lists (alphabetically) Consequences for compare between 2 versions Compare between v6.5.1.12 and v6.5.1.13 will be impossible to interpret Compare between v6.5.1.13 and following versions will be easier to interpret 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Removal of enumeration descriptions As-is Description of enumeration values included in generic code list XSDs To-be Remove descriptions from XSDs Alternative solution Complete list of enumerations and their values available in “UMIG - SD - XD - 05 - Code Lists” (improved version) Message-specific list or enumerations and their values available in new UMIG deliverables (work-in-progress) 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Renaming of XSD files As-is To-be Prefix “ebIX_” in XSD filename Example ebIX_MessageBusinessInformationEntities_RequestMoveIn_02-07p001.xsd ebIX_MessageDataType_RequestMoveIn_02-07p001.xsd ebIX_RequestMoveIn_02-07p001.xsd To-be Delete prefix in XSD filename RequestMoveIn_02-07p002.xsd 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”

Restructuring of ZIP-file As-is “document” folder Subfolder for each message 3 document XSDs for each message “generic” folder code list XSDs WSDLs MsgDefinitions XSDs To-be “WSDL” folder All MsgDefinitions XSDs and WSDLs “XSD” folder All XSDs without subfolders 27/07/2018 Detailed Release Note - Change “238257: Re-baseline UMIG XSDs”