IEPModel/UtilityService.xsd at develop · mpalmquist/IEPModel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0"?>
<!--**************************************************************************
	schema: UtilityService.xsd v 2.0
	Author(s):
	v 2.0  Michael Palmquist, SolarNexus Inc
	v 1.x  Michael Palmquist, SolarNexus Inc
**************************************************************************** -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.iepmodel.net"
	xmlns="http://www.iepmodel.net" elementFormDefault="qualified">
	<xs:annotation>
		<xs:documentation>Defines a utility service for a site.</xs:documentation>
	</xs:annotation>
	<xs:include schemaLocation="Common.xsd"/>
	<xs:include schemaLocation="EnergyConsumption.xsd"/>
	<xs:simpleType name="meteringTypesEnum">
		<xs:annotation>
			<xs:documentation>Master metered or individually metered.</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:enumeration value="INDIVIDUALLY_METERED"/>
			<xs:enumeration value="MASTER_METERED"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:simpleType name="utilityTransformerConnectionTypesEnum">
		<xs:annotation>
			<xs:documentation>The level at which the service connection is made to the utility's electrical services (primary, secondary, transmission).</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:enumeration value="SECONDARY"/>
			<xs:enumeration value="TRANSMISSION"/>
			<xs:enumeration value="PRIMARY"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:complexType name="utilityService">
		<xs:annotation>
			<xs:documentation>An energy service for a single fuel type. A utility typically provides this service, although a propane or heating oil provider can fit as well. Describes the customer's service attributes as well as utility bills based on metering of an energy service.</xs:documentation>
		</xs:annotation>
		<xs:sequence maxOccurs="1" minOccurs="1">
			<xs:element name="energy" type="energyClassEnum">
				<xs:annotation>
					<xs:documentation>Names the energy fuel type.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="utilityId" type="xs:positiveInteger" minOccurs="0">
				<xs:annotation>
					<xs:documentation>EIA Utility ID.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element minOccurs="0" name="utilityName" type="xs:string"/>
			<xs:element maxOccurs="1" minOccurs="0" name="hostCustomerName" type="xs:string">
				<xs:annotation>
					<xs:documentation>Customer name.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="accountNumber" type="xs:string">
				<xs:annotation>
					<xs:documentation>Identifier assigned by the utility.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element minOccurs="0" name="serviceId" type="xs:string">
				<xs:annotation>
					<xs:documentation>An identifier provided by the utility.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="existingRateSchedule" type="xs:string">
				<xs:annotation>
					<xs:documentation>The utility's description of how it charges the customer for units of energy consumed.  This is the currently in effect rate schedule.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="proposedRateSchedule">
				<xs:annotation>
					<xs:documentation>The utility's description of how it charges the customer for units of energy consumed.  This is the proposed rate schedule in cases where the project includes a change of rate schedule.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:simpleContent>
						<xs:extension base="xs:string">
							<xs:attribute name="ScopeOfWorkIdRef" type="xs:IDREF">
								<xs:annotation>
									<xs:documentation>This ID is used to associate the ProposedRateSchedule with a single ScopeOfWork in a Project. A project may have more than one ScopeOfWork defined. The proposed rate schedule may differ from one Scope Of Work to another.</xs:documentation>
								</xs:annotation>
							</xs:attribute>
						</xs:extension>
					</xs:simpleContent>
				</xs:complexType>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="blendedRate" type="monetary">
				<xs:annotation>
					<xs:documentation>Blended rate is an average per unit rate that may blend various rates based on tier, time of use and seasonal changes into a single rate. This will be in cents/kwh or dollars/therm</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="energyConsumption" type="energyRecord">
				<xs:annotation>
					<xs:documentation>Multiple Energy Consumption elements are allowed in case of multiple revenue meters.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="utilityMeterId" type="xs:string">
				<xs:annotation>
					<xs:documentation>Utility's identifier for the meter.

Utility interconnections may require meter number. Utility incentive programs may require meter id as well.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element minOccurs="0" name="electricDistributionSystemIdRef" type="xs:IDREF">
				<xs:annotation>
					<xs:documentation>Reference to the associated physical service electric distribution system.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element minOccurs="0" name="spaces">
				<xs:complexType>
					<xs:sequence>
						<xs:element maxOccurs="unbounded" minOccurs="1" name="space" type="xs:IDREF">
							<xs:annotation>
								<xs:documentation>A building consists of one or many spaces. This object provides a high level specification of the building space profile intended for use with Projects and simulations such as SaveEnergy123 and Portfolio Manager.

                https://saveenergy123.com/

                http://www.energystar.gov/index.cfm?c=evaluate_performance.bus_portfoliomanager</xs:documentation>
							</xs:annotation>
						</xs:element>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element maxOccurs="1" minOccurs="0" name="metering" type="meteringTypesEnum"/>
			<xs:element maxOccurs="1" minOccurs="0" name="utilityTransformerConnection"
				type="utilityTransformerConnectionTypesEnum"/>
			<xs:element minOccurs="0" name="providesWaterHeating" type="xs:boolean">
				<xs:annotation>
					<xs:documentation>Value = true if this UtilityService is known to provide the energy used for heating water. </xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="id" type="xs:ID"/>
		<xs:attribute name="revenueMeterIdRef" type="xs:IDREF">
			<xs:annotation>
				<xs:documentation>When UtilityService is used within a Project.xsd, this attribute can reference a defined meter instance in the electricDistributionSystem, or within a pvSystem.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
</xs:schema>