From 7ce351383c10ba5cdbc4cce8e190f7503725c93e Mon Sep 17 00:00:00 2001
From: Mark Borkum <mark.borkum@pnnl.gov>
Date: Tue, 23 Aug 2022 10:30:38 -0700
Subject: [PATCH 1/2] Create Add Equipment ID.md

---
 proposals/2022/Add Equipment ID.md | 53 ++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 proposals/2022/Add Equipment ID.md

diff --git a/proposals/2022/Add Equipment ID.md b/proposals/2022/Add Equipment ID.md
new file mode 100644
index 00000000..884e33aa
--- /dev/null
+++ b/proposals/2022/Add Equipment ID.md	
@@ -0,0 +1,53 @@
+# Add Equipment ID
+
+## Overview
+
+This proposal is to add an "Equipment ID" element to the schema.
+
+## Justification
+
+The schema has an "ID" attribute for each top-level plant/system type; however, the IDs themselves are opaque (i.e., their values can be tested for equality, but otherwise, convey no information) and are locally-unique to the XML document (i.e., their values are only unique within the scope of the XML document). Hence, the "ID" attribute can be used to *identify* and *reference* an element, but not to *name* said element.
+
+The schema has elements to describe the equipment manufacturer, the year of manufacture, and the model number; however, there is no element for the equipment ID (e.g., "AHU-1", "PTAC-Room-42", or "ABC123").
+
+## Implementation
+
+This proposal is implemented by adding a new element:
+
+```xml
+<xs:element name="EquipmentID" type="xs:string">
+  <xs:annotation>
+    <xs:documentation>Identifier for the equipment.</xs:documentation>
+  </xs:annotation>
+</xs:element>
+```
+
+The new element is added to the `<xs:sequence>` for the following types:
+
+* `<auc:AntiSweatHeaters>`
+* `<auc:ConveyanceSystemType>`
+* `<auc:CookingSystemType>`
+* `<auc:CoolingSource>`
+* `<auc:CriticalITSystemType>`
+* `<auc:Delivery>`
+* `<auc:DishwasherSystemType>`
+* `<auc:DomesticHotWaterSystemType>`
+* `<auc:DuctSystemType>`
+* `<auc:FanSystemType>`
+* `<auc:FenestrationSystemType>`
+* `<auc:HeatRecoverySystemType>`
+* `<auc:HeatingSource>`
+* `<auc:LaundrySystemType>`
+* `<auc:LightingSystemType>`
+* `<auc:MotorSystemType>`
+* `<auc:OnsiteStorageTransmissionGenerationSystemType>`
+* `<auc:OtherHVACSystemType>`
+* `<auc:PlugElectricLoadType>`
+* `<auc:PoolType>`
+* `<auc:ProcessGasElectricLoadType>`
+* `<auc:PumpSystemType>`
+* `<auc:RefrigerationSystemType>`
+* `<auc:Solar>`
+* `<auc:WaterUseType>`
+
+The types, above, were identified programmatically using the following XPath: `//xs:complexType[xs:sequence/xs:element[@ref = "auc:Manufacturer"]]`.

From c8ef19f29ae5ea58397bcf90b19c9e09321a5380 Mon Sep 17 00:00:00 2001
From: Mark Borkum <mark.borkum@pnnl.gov>
Date: Tue, 1 Nov 2022 09:26:34 -0700
Subject: [PATCH 2/2] Add EquipmentID element to schema

This commit implements the proposal by adding the `auc:EquipmentID` child element to the proposed elements.
---
 BuildingSync.xsd | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/BuildingSync.xsd b/BuildingSync.xsd
index f4330f10..07927272 100644
--- a/BuildingSync.xsd
+++ b/BuildingSync.xsd
@@ -5206,6 +5206,7 @@
                         <xs:element ref="auc:ModelNumber" minOccurs="0"/>
                         <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
                         <xs:element ref="auc:Quantity" minOccurs="0"/>
+                        <xs:element ref="auc:EquipmentID" minOccurs="0"/>
                       </xs:sequence>
                       <xs:attribute name="ID" type="xs:ID" use="required"/>
                       <xs:attribute ref="auc:Status"/>
@@ -5356,6 +5357,7 @@
                         <xs:element ref="auc:ModelNumber" minOccurs="0"/>
                         <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
                         <xs:element ref="auc:Quantity" minOccurs="0"/>
+                        <xs:element ref="auc:EquipmentID" minOccurs="0"/>
                       </xs:sequence>
                       <xs:attribute name="ID" type="xs:ID" use="required"/>
                       <xs:attribute ref="auc:Status"/>
@@ -5548,6 +5550,7 @@
                         <xs:element ref="auc:ThirdPartyCertification" minOccurs="0"/>
                         <xs:element ref="auc:Quantity" minOccurs="0"/>
                         <xs:element name="DeliveryCondition" type="auc:EquipmentCondition" minOccurs="0"/>
+                        <xs:element ref="auc:EquipmentID" minOccurs="0"/>
                       </xs:sequence>
                       <xs:attribute name="ID" type="xs:ID" use="required"/>
                       <xs:attribute ref="auc:Status">
@@ -6886,6 +6889,7 @@
       </xs:element>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -7361,6 +7365,7 @@
       </xs:element>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -7553,6 +7558,7 @@
                                           <xs:element ref="auc:Manufacturer" minOccurs="0"/>
                                           <xs:element ref="auc:ModelNumber" minOccurs="0"/>
                                           <xs:element ref="auc:Location" minOccurs="0"/>
+                                          <xs:element ref="auc:EquipmentID" minOccurs="0"/>
                                         </xs:sequence>
                                       </xs:complexType>
                                     </xs:element>
@@ -7867,6 +7873,7 @@
       </xs:element>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -7976,6 +7983,7 @@
       </xs:element>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -8228,6 +8236,7 @@
                         </xs:element>
                         <xs:element ref="auc:Manufacturer" minOccurs="0"/>
                         <xs:element ref="auc:ModelNumber" minOccurs="0"/>
+                        <xs:element ref="auc:EquipmentID" minOccurs="0"/>
                       </xs:sequence>
                     </xs:complexType>
                   </xs:element>
@@ -8259,6 +8268,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -8372,6 +8382,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -8484,6 +8495,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -8643,6 +8655,7 @@
       <xs:element ref="auc:Location" minOccurs="0"/>
       <xs:element ref="auc:LinkedSystemIDs" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -8865,6 +8878,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:LinkedSystemIDs" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -9010,6 +9024,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:LinkedSystemIDs" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -9097,6 +9112,7 @@
       <xs:element ref="auc:ModelNumber" minOccurs="0"/>
       <xs:element ref="auc:Location" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -10216,6 +10232,7 @@
       <xs:element ref="auc:Manufacturer" minOccurs="0"/>
       <xs:element ref="auc:ModelNumber" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -10651,6 +10668,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -10741,6 +10759,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Source"/>
@@ -10824,6 +10843,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Source"/>
@@ -10913,6 +10933,7 @@
       <xs:element ref="auc:Location" minOccurs="0"/>
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -11218,6 +11239,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -11343,6 +11365,7 @@
       <xs:element ref="auc:Location" minOccurs="0"/>
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -11450,6 +11473,7 @@
       <xs:element ref="auc:LinkedPremises" minOccurs="0"/>
       <xs:element ref="auc:UserDefinedFields" minOccurs="0"/>
       <xs:element ref="auc:Quantity" minOccurs="0"/>
+      <xs:element ref="auc:EquipmentID" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="ID" type="xs:ID" use="required"/>
     <xs:attribute ref="auc:Status"/>
@@ -16856,4 +16880,9 @@
       </xs:sequence>
     </xs:complexType>
   </xs:element>
+  <xs:element name="EquipmentID" type="xs:string">
+    <xs:annotation>
+      <xs:documentation>Identifier for the equipment.</xs:documentation>
+    </xs:annotation>
+  </xs:element>
 </xs:schema>