From ad980cfc081a07a05af11ed481f07235b924b9c1 Mon Sep 17 00:00:00 2001 From: Mark Borkum Date: Wed, 2 Apr 2025 11:09:46 -0700 Subject: [PATCH 1/5] Proposal: Add Optional Elements to All Assets --- BuildingSync.xsd | 141 ++++++++++++++++++ .../Add Optional Elements to All Assets.md | 71 +++++++++ 2 files changed, 212 insertions(+) create mode 100644 proposals/2025/Add Optional Elements to All Assets.md diff --git a/BuildingSync.xsd b/BuildingSync.xsd index 339d2f48..284db2b3 100644 --- a/BuildingSync.xsd +++ b/BuildingSync.xsd @@ -308,6 +308,16 @@ + + + + + + + + + + @@ -373,6 +383,16 @@ + + + + + + + + + + @@ -5494,6 +5514,8 @@ + + @@ -5645,6 +5667,7 @@ + @@ -5838,6 +5861,9 @@ + + + @@ -5943,6 +5969,14 @@ + + + + + + + + @@ -6189,6 +6223,10 @@ + + + + @@ -6432,6 +6470,13 @@ + + + + + + + @@ -6608,6 +6653,13 @@ + + + + + + + @@ -6891,6 +6943,13 @@ + + + + + + + @@ -7165,6 +7224,7 @@ + @@ -7668,6 +7728,7 @@ + @@ -8318,6 +8379,7 @@ + @@ -8571,6 +8633,15 @@ + + + + + + + + + @@ -8603,6 +8674,7 @@ + @@ -8717,6 +8789,7 @@ + @@ -8830,6 +8903,7 @@ + @@ -8990,6 +9064,8 @@ + + @@ -9213,6 +9289,7 @@ + @@ -9359,6 +9436,7 @@ + @@ -9447,6 +9525,9 @@ + + + @@ -9666,6 +9747,15 @@ + + + + + + + + + @@ -9829,6 +9919,15 @@ + + + + + + + + + @@ -10078,6 +10177,15 @@ + + + + + + + + + @@ -10567,6 +10675,11 @@ + + + + + @@ -10682,6 +10795,15 @@ + + + + + + + + + @@ -10919,6 +11041,15 @@ + + + + + + + + + @@ -11003,6 +11134,7 @@ + @@ -11094,6 +11226,7 @@ + @@ -11178,6 +11311,7 @@ + @@ -11574,6 +11708,8 @@ + + @@ -11700,6 +11836,9 @@ + + + @@ -11808,6 +11947,8 @@ + + diff --git a/proposals/2025/Add Optional Elements to All Assets.md b/proposals/2025/Add Optional Elements to All Assets.md new file mode 100644 index 00000000..b36eb0cd --- /dev/null +++ b/proposals/2025/Add Optional Elements to All Assets.md @@ -0,0 +1,71 @@ +# Add Optional Elements to All Assets + +## Overview + +In BuildingSync XML schema, the following optional `xs:element`s are defined for almost all `xs:complexType`s for “assets” (plants, systems, units of equipment, etc.): + +* EquipmentCondition +* EquipmentID +* LinkedPremises +* Location +* Manufacturer +* ModelNumber +* PrimaryFuel +* Quantity +* ThirdPartyCertification +* UserDefinedFields +* YearInstalled +* YearOfManufacture + +The use case for the definition of these optional `xs:element`s is asset tracking and management. They include, but are not limited to, the manufacturer name, year of manufacture, model number, and tag for the asset, along with its year of installation, location, and condition. They also include BuildingSync-specific `xs:element`s for linking the asset to premises that it serves and for representing software-specific, user-defined fields. + +This proposal is to add these optional `xs:element`s to the `xs:complexType`s for all assets. + +The changes that are recommended by this proposal are non-breaking because all the `xs:element`s are optional (viz., `minOccurs="0"`). + +## Justification + +The following table shows which optional `xs:element`s are currently defined for each `xs:complexType`: + +| |EquipmentCondition|EquipmentID|LinkedPremises|Location|Manufacturer|ModelNumber|PrimaryFuel|Quantity|ThirdPartyCertification|UserDefinedFields|YearInstalled|YearOfManufacture| +|-|-|-|-|-|-|-|-|-|-|-|-|-| +|AirInfiltrationSystem|N|N|Y|N|N|N|N|N|N|Y|N|N| +|AntiSweatHeaters|N|Y|N|N|Y|Y|N|N|N|N|N|N| +|CeilingSystemType|N|N|N|N|N|N|N|Y|N|Y|Y|N| +|CondenserPlantType|Y|N|N|Y|N|N|Y|N|N|Y|Y|N| +|ConveyanceSystemType|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|CookingSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|CoolingPlantType|Y|N|N|Y|N|N|Y|N|N|Y|Y|N| +|CoolingSource|Y|Y|N|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|CriticalITSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|Delivery|Y|Y|N|N|Y|Y|Y|Y|Y|N|Y|Y| +|DishwasherSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|DomesticHotWaterSystemType|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|DuctSystemType|N|N|Y|Y|Y|Y|N|Y|N|Y|Y|Y| +|ExteriorFloorSystemType|N|N|N|N|N|N|N|Y|N|Y|Y|N| +|FanSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|FenestrationSystemType|N|Y|N|N|Y|Y|N|Y|Y|Y|Y|N| +|FoundationSystemType|N|N|N|N|N|N|N|Y|N|Y|Y|N| +|HVACSystemType|N|N|Y|Y|N|N|N|Y|N|Y|N|N| +|HeatRecoverySystemType|N|Y|N|Y|Y|Y|N|Y|Y|Y|Y|Y| +|HeatingPlantType|Y|N|N|Y|N|N|Y|N|N|Y|Y|N| +|HeatingSource|Y|Y|N|Y|Y|Y|Y|Y|N|Y|Y|Y| +|LaundrySystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|LightingSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|MotorSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|OnsiteStorageTransmissionGenerationSystemType|N|Y|Y|Y|Y|Y|N|Y|Y|Y|Y|Y| +|OtherHVACSystemType|Y|Y|Y|Y|Y|Y|Y|Y|N|Y|Y|Y| +|PlugElectricLoadType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|PoolType|N|Y|Y|Y|Y|Y|N|Y|Y|Y|Y|N| +|ProcessGasElectricLoadType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|PumpSystemType|N|Y|N|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|RefrigerationSystemType|N|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y|Y| +|RoofSystemType|N|N|N|N|N|N|N|Y|N|Y|Y|N| +|WallSystemType|N|N|N|N|N|N|N|Y|N|Y|Y|N| +|WaterInfiltrationSystem|N|N|Y|N|N|N|N|N|N|Y|N|N| +|WaterUseType|N|Y|Y|Y|Y|Y|N|Y|Y|Y|Y|Y| +|**Total**|9/35|23/35|20/35|25/35|24/35|24/35|20/35|29/35|20/35|33/35|31/35|21/35| + +## Implementation + +When they are absent, the optional `xs:element`s are added to the `xs:complexType`s. From dd801d33dc621455e10c673a59b9096f485e937a Mon Sep 17 00:00:00 2001 From: Mark Borkum Date: Wed, 2 Apr 2025 11:34:05 -0700 Subject: [PATCH 2/5] Rename `auc:EquipmentCondition` elements so that test suite passes --- BuildingSync.xsd | 51 ++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/BuildingSync.xsd b/BuildingSync.xsd index 284db2b3..d9e5f632 100644 --- a/BuildingSync.xsd +++ b/BuildingSync.xsd @@ -308,7 +308,7 @@ - + @@ -383,7 +383,7 @@ - + @@ -5969,7 +5969,7 @@ - + @@ -6223,7 +6223,7 @@ - + @@ -7728,7 +7728,7 @@ - + @@ -8379,7 +8379,7 @@ - + @@ -8633,7 +8633,7 @@ - + @@ -8674,7 +8674,7 @@ - + @@ -8789,7 +8789,7 @@ - + @@ -8903,7 +8903,7 @@ - + @@ -9064,7 +9064,7 @@ - + @@ -9289,7 +9289,7 @@ - + @@ -9436,7 +9436,7 @@ - + @@ -9525,7 +9525,7 @@ - + @@ -9747,7 +9747,7 @@ - + @@ -9919,7 +9919,7 @@ - + @@ -10177,7 +10177,6 @@ - @@ -10675,7 +10674,7 @@ - + @@ -10795,7 +10794,7 @@ - + @@ -11041,7 +11040,7 @@ - + @@ -11134,7 +11133,7 @@ - + @@ -11226,7 +11225,7 @@ - + @@ -11311,7 +11310,7 @@ - + @@ -11708,7 +11707,7 @@ - + @@ -11836,7 +11835,7 @@ - + @@ -11947,7 +11946,7 @@ - + From 50d330b8ba10a857254a3909b93b4f7548928eb1 Mon Sep 17 00:00:00 2001 From: Mark Borkum Date: Tue, 15 Apr 2025 13:44:41 -0700 Subject: [PATCH 3/5] Update BuildingSync.xsd --- BuildingSync.xsd | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/BuildingSync.xsd b/BuildingSync.xsd index d9e5f632..c4edc2a4 100644 --- a/BuildingSync.xsd +++ b/BuildingSync.xsd @@ -308,7 +308,7 @@ - + @@ -5969,7 +5969,7 @@ - + @@ -7728,7 +7728,7 @@ - + @@ -9747,7 +9747,7 @@ - + @@ -9919,7 +9919,7 @@ - + @@ -10794,7 +10794,7 @@ - + @@ -11040,7 +11040,7 @@ - + @@ -11225,7 +11225,7 @@ - + @@ -11310,7 +11310,7 @@ - + @@ -11946,7 +11946,7 @@ - + From c14c9017c63b7c72e8b364e792dae654e1bda62a Mon Sep 17 00:00:00 2001 From: Mark Borkum Date: Tue, 15 Apr 2025 13:46:00 -0700 Subject: [PATCH 4/5] Update BuildingSync.xsd --- BuildingSync.xsd | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/BuildingSync.xsd b/BuildingSync.xsd index c4edc2a4..5a4e20d8 100644 --- a/BuildingSync.xsd +++ b/BuildingSync.xsd @@ -383,7 +383,7 @@ - + @@ -6223,7 +6223,7 @@ - + @@ -10674,7 +10674,7 @@ - + From d2da8487fed2d4b3455e3a4f6eda835dfbeb161e Mon Sep 17 00:00:00 2001 From: JieXiong9119 <69597597+JieXiong9119@users.noreply.github.com> Date: Thu, 17 Apr 2025 10:28:17 -0600 Subject: [PATCH 5/5] revise HVACControlCondition to HVACSystemCondition --- BuildingSync.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BuildingSync.xsd b/BuildingSync.xsd index 5a4e20d8..2d28fd1c 100644 --- a/BuildingSync.xsd +++ b/BuildingSync.xsd @@ -5969,7 +5969,7 @@ - +