|
| 1 | +# Add Federal Fields |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +This proposal is to add new elements under the `FederalBuilding` element: |
| 6 | + |
| 7 | +* `auc:Agency` - this field already exists. It is a text field and should probably stay that way to map to different tools. For the CERL use case, this maps to "DOD" |
| 8 | +* `auc:SubAgency` - Sub Agency according to agency's organizational structure. For CERL's workflow, this would be "Army". |
| 9 | +* `auc:SubAgencySubLevel1` - Sub Agency Sub Level 1 represents another level down in the agency's organizational structure. For CERL's workflow, this would be the "Accountable Organization". |
| 10 | +* `auc:SubAgencySubLevel2` - Sub Agency Sub Level 2 represents another level down in the agency's organization structure. For CERL's workflow this would be the "Accountable Sub Organization". |
| 11 | +* `Facility` - Federal Facility represents another level down in the agency's organization structure. For CERL's workflow, this would be the "Installation". |
| 12 | +* `FacilitySubLevel1` - Federal Facility Sub Level 1 represents another level down in the agency's organization structure. For CERL's workflow, this would be the "Site". |
| 13 | +* `FacilitySubLevel2` - Federal Facility Sub Level 2 represents another level down in the agency's organization structure. For CERL's workflow, this would also be "Site". |
| 14 | +* `FacilityNumber` - Unique identifier of a federal facility. |
| 15 | +* `PrimaryCategoryCode` - The Building's primary category code, indicating the building classification. |
| 16 | + |
| 17 | +## Justification |
| 18 | + |
| 19 | +The addition of these fields will facilitate data transfer between SEED and Audit Template to support the CERL workflow. |
| 20 | + |
| 21 | +## Implementation |
| 22 | + |
| 23 | +Under `auc:FederalBuilding`: |
| 24 | + |
| 25 | +```xml |
| 26 | + <xs:element name="FederalBuilding" minOccurs="0"> |
| 27 | + <xs:annotation> |
| 28 | + <xs:documentation>If exists then the building is owned by the federal government.</xs:documentation> |
| 29 | + </xs:annotation> |
| 30 | + <xs:complexType> |
| 31 | + <xs:sequence> |
| 32 | + <xs:element name="Agency" type="xs:string" minOccurs="0"> |
| 33 | + <xs:annotation> |
| 34 | + <xs:documentation>Federal agency, required to designate a building as a federal property in ENERGY STAR Portfolio Manager.</xs:documentation> |
| 35 | + </xs:annotation> |
| 36 | + </xs:element> |
| 37 | + <xs:element name="SubAgency" type="xs:string" minOccurs="0"> |
| 38 | + <xs:annotation> |
| 39 | + <xs:documentation>Federal sub agency, according to organizational structure of the specified agency.</xs:documentation> |
| 40 | + </xs:annotation> |
| 41 | + </xs:element> |
| 42 | + <xs:element name="SubAgencySubLevel1" type="xs:string" minOccurs="0"> |
| 43 | + <xs:annotation> |
| 44 | + <xs:documentation>Federal sub agency sub level 1, according to organizational structure of the specified agency.</xs:documentation> |
| 45 | + </xs:annotation> |
| 46 | + </xs:element> |
| 47 | + <xs:element name="SubAgencySubLevel2" type="xs:string" minOccurs="0"> |
| 48 | + <xs:annotation> |
| 49 | + <xs:documentation>Federal sub agency sub level 2, according to organizational structure of the specified agency.</xs:documentation> |
| 50 | + </xs:annotation> |
| 51 | + </xs:element> |
| 52 | + <xs:element name="Facility" type="xs:string" minOccurs="0"> |
| 53 | + <xs:annotation> |
| 54 | + <xs:documentation>Federal facility, according to organization structure of the specified agency.</xs:documentation> |
| 55 | + </xs:annotation> |
| 56 | + </xs:element> |
| 57 | + <xs:element name="FacilitySubLevel1" type="xs:string" minOccurs="0"> |
| 58 | + <xs:annotation> |
| 59 | + <xs:documentation>Federal facility sub level 1, according to organization structure of the specified agency.</xs:documentation> |
| 60 | + </xs:annotation> |
| 61 | + </xs:element> |
| 62 | + <xs:element name="FacilitySubLevel2" type="xs:string" minOccurs="0"> |
| 63 | + <xs:annotation> |
| 64 | + <xs:documentation>Federal facility sub level 2, according to organization structure of the specified agency.</xs:documentation> |
| 65 | + </xs:annotation> |
| 66 | + </xs:element> |
| 67 | + <xs:element name="FacilityNumber" type="xs:string" minOccurs="0"> |
| 68 | + <xs:annotation> |
| 69 | + <xs:documentation>Unique federal facility number.</xs:documentation> |
| 70 | + </xs:annotation> |
| 71 | + </xs:element> |
| 72 | + <xs:element name="PrimaryCategoryCode" type="xs:string" minOccurs="0"> |
| 73 | + <xs:annotation> |
| 74 | + <xs:documentation>Category code classification of the building.</xs:documentation> |
| 75 | + </xs:annotation> |
| 76 | + </xs:element> |
| 77 | + <xs:element name="DepartmentRegion" type="xs:string" minOccurs="0"> |
| 78 | + <xs:annotation> |
| 79 | + <xs:documentation>Federal department/region, required to designate a building as a federal property in ENERGY STAR Portfolio Manager.</xs:documentation> |
| 80 | + </xs:annotation> |
| 81 | + </xs:element> |
| 82 | + </xs:sequence> |
| 83 | + </xs:complexType> |
| 84 | + </xs:element> |
| 85 | +``` |
| 86 | + |
| 87 | +## Example XML |
| 88 | + |
| 89 | +```xml |
| 90 | +<auc:BuildingSync xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 https://raw.github.com/BuildingSync/schema/v2.6.0/BuildingSync.xsd" version="2.6.0"> |
| 91 | + <auc:Facilities> |
| 92 | + <auc:Facility ID="Facility-1"> |
| 93 | + <auc:Sites> |
| 94 | + <auc:Site ID="Site-1"> |
| 95 | + <auc:Buildings> |
| 96 | + <auc:Building ID="Building-1"> |
| 97 | + <auc:FederalBuilding> |
| 98 | + <auc:Agency>DOD</auc:Agency> |
| 99 | + <auc:SubAgency>Army</auc:SubAgency> |
| 100 | + <auc:SubAgencySubLevel1>Accountable Organization</auc:SubAgencySubLevel1> |
| 101 | + <auc:SubAgencySubLevel2>Accountable Sub Org</auc:SubAgencySubLevel2> |
| 102 | + <auc:Facility>Installation</auc:Facility> |
| 103 | + <auc:FacilitySubLevel1>Site</auc:FacilitySubLevel1> |
| 104 | + <auc:FacilitySubLevel2>Site</auc:FacilitySubLevel2> |
| 105 | + <auc:FacilityNumber>123456</auc:FacilityNumber> |
| 106 | + <auc:PrimaryCategoryCode>123456</auc:PrimaryCategoryCode> |
| 107 | + </auc:FederalBuilding> |
| 108 | + <auc:PremisesName>Test Property</auc:PremisesName> |
| 109 | + ... |
| 110 | + </auc:Building> |
| 111 | + </auc:Buildings> |
| 112 | + </auc:Site> |
| 113 | + </auc:Sites> |
| 114 | + </auc:Facility> |
| 115 | + </auc:Facilities> |
| 116 | +</auc:BuildingSync> |
| 117 | +``` |
0 commit comments