Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Model
Properties
Source
Used by
Included schema UtilityService.xsd
Namespace http://www.iepmodel.net
Annotations
 
Defines a utility service for a site.
Properties
attribute form default unqualified
element form default unqualified
Element utilityService / energy
Namespace No namespace
Annotations
 
Names the energy fuel type.
Diagram
Diagram Common_xsd.tmp#energyClassEnum
Type energyClassEnum
Properties
content simple
Facets
enumeration Coal (anthracite)
enumeration Coal (bituminous)
enumeration Coke
enumeration Diesel
enumeration District Chilled Water
enumeration District Hot Water
enumeration District Steam
enumeration Electricity
enumeration Fuel Oil
enumeration Fuel Oil (No. 1) 
Number 1 is similar to kerosene and is the fraction that boils off right after gasoline.
enumeration Fuel Oil (No. 2)
enumeration Fuel Oil (No. 4) 
Number 4 fuel oil is usually a blend of distillate and residual fuel oils, such as No. 2 and 6; however, sometimes it is just a heavy distillate. No. 4 may be classified as diesel, distillate or residual fuel oil.
enumeration Fuel Oil (No. 5 and No. 6) 
Number 5 fuel oil and Number 6 fuel oil are called residual fuel oils (RFO) or heavy fuel oils. More Number 6 oil is produced compared to Number 5 oil, the terms heavy fuel oil and residual fuel oil  are sometimes used as names for Number 6. Number 5 and 6 are what remains of the crude oil after gasoline and the distillate fuel oils are extracted through distillation. Number 5 fuel oil is a mixture of 75-80 % Number 6 oil and 25-20% of Number 2 oil. Number 6 oil may also contain a small amount of No. 2 to get it to meet specifications.
enumeration Geothermal
enumeration Kerosene
enumeration Liquid Propane
enumeration Natural Gas
enumeration Other
enumeration Propane
enumeration Steam
enumeration Wood
Source
 
<xs:element name="energy" type="energyClassEnum">
  <xs:annotation>
    <xs:documentation>Names the energy fuel type.</xs:documentation>
  </xs:annotation>
</xs:element>
Element utilityService / utilityName
Namespace No namespace
Diagram
Diagram
Type xs:string
Properties
content simple
minOccurs 0
Source
 
<xs:element minOccurs="0" name="utilityName" type="xs:string"/>
Element utilityService / hostCustomerName
Namespace No namespace
Annotations
 
Customer name.
Diagram
Diagram
Type xs:string
Properties
content simple
minOccurs 0
maxOccurs 1
Source
 
<xs:element maxOccurs="1" minOccurs="0" name="hostCustomerName" type="xs:string">
  <xs:annotation>
    <xs:documentation>Customer name.</xs:documentation>
  </xs:annotation>
</xs:element>
Element utilityService / accountNumber
Namespace No namespace
Annotations
 
Identifier assigned by the utility.
Diagram
Diagram
Type xs:string
Properties
content simple
minOccurs 0
maxOccurs 1
Source
 
<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>
Element utilityService / serviceId
Namespace No namespace
Annotations
 
An identifier provided by the utility.
Diagram
Diagram
Type xs:string
Properties
content simple
minOccurs 0
Source
 
<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>
Element utilityService / existingRateSchedule
Namespace No namespace
Annotations
 
The utility's description of how it charges the customer for units of energy consumed.  This is the currently in effect rate schedule.
Diagram
Diagram
Type xs:string
Properties
content simple
minOccurs 0
maxOccurs 1
Source
 
<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>
Element utilityService / proposedRateSchedule
Namespace No namespace
Annotations
 
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.
Diagram
Diagram UtilityService_xsd.tmp#utilityService_utilityService_proposedRateSchedule_ScopeOfWorkIdRef
Type extension of xs:string
Properties
content complex
minOccurs 0
maxOccurs 1
Attributes
QName Type Use Annotation
ScopeOfWorkIdRef xs:IDREF optional 
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.
Source
 
<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>
Element utilityService / blendedRate
Namespace No namespace
Annotations
 
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
Diagram
Diagram Common_xsd.tmp#monetary_unit Common_xsd.tmp#monetary
Type monetary
Properties
content complex
minOccurs 0
maxOccurs 1
Attributes
QName Type Use
unit monetaryUnitEnum optional
Source
 
<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>
Element utilityService / energyConsumption
Namespace No namespace
Annotations
 
Multiple Energy Consumption elements are allowed in case of multiple revenue meters.
Diagram
Diagram EnergyConsumption_xsd.tmp#energyRecord_periodStart EnergyConsumption_xsd.tmp#energyRecord_periodUnits EnergyConsumption_xsd.tmp#energyRecord_revenueMeterIdRef EnergyConsumption_xsd.tmp#energyRecord_dataSource EnergyConsumption_xsd.tmp#energyRecord_description EnergyConsumption_xsd.tmp#energyRecord_energyAmountUnits EnergyConsumption_xsd.tmp#energyRecord_energyAmounts EnergyConsumption_xsd.tmp#energyRecord_peakDemands EnergyConsumption_xsd.tmp#energyRecord_energyCosts EnergyConsumption_xsd.tmp#energyRecord
Type energyRecord
Properties
content complex
minOccurs 0
maxOccurs 1
Model
Children dataSource, description, energyAmountUnits, energyAmounts, energyCosts, peakDemands
Instance
 
<energyConsumption periodStart="" periodUnits="" revenueMeterIdRef="">
  <dataSource>{0,1}</dataSource>
  <description>{0,1}</description>
  <energyAmountUnits>{1,1}</energyAmountUnits>
  <energyAmounts>{0,1}</energyAmounts>
  <peakDemands>{0,1}</peakDemands>
  <energyCosts>{0,1}</energyCosts>
</energyConsumption>
Attributes
QName Type Use Annotation
periodStart xs:dateTime optional 
Start date of the time period covered by this Energy Consumption record. Use this attribute in conjunction with the PeriodLength attributes of the EnergyAmount elements when defining consecutive billing periods that do not correspond to calendar months. Put the billing days in the PeriodLength attribute.
periodUnits timeUnitEnum optional 
Describes the Units of time for the PeriodLength attribute within the EnergyAmounts.
revenueMeterIdRef xs:IDREF optional 
A reference to a an optionally defined meter in the UtilityService XSD.  When benchmarking, a consumed quantity of energy must be associated to a defined revenue meter.
Source
 
<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>
Element utilityService / utilityMeterId
Namespace No namespace
Annotations
 
Utility's identifier for the meter.

Utiility interconnections may require meter number. Utility incentive programs may require meter id as well.
Diagram
Diagram
Type xs:string
Properties
content simple
minOccurs 0
maxOccurs 1
Source
 
<xs:element maxOccurs="1" minOccurs="0" name="utilityMeterId" type="xs:string">
  <xs:annotation>
    <xs:documentation>Utility's identifier for the meter. Utiility interconnections may require meter number. Utility incentive programs may require meter id as well.</xs:documentation>
  </xs:annotation>
</xs:element>
Element utilityService / electricDIstributionSystemIdRef
Namespace No namespace
Annotations
 
Reference to the associated physical service electric distribution system.
Diagram
Diagram
Type xs:IDREF
Properties
content simple
minOccurs 0
Source
 
<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>
Element utilityService / spaces
Namespace No namespace
Diagram
Diagram UtilityService_xsd.tmp#utilityService_utilityService_spaces_space
Properties
content complex
minOccurs 0
Model
Children space
Instance
 
<spaces>
  <space>{1,unbounded}</space>
</spaces>
Source
 
<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>
Element utilityService / spaces / space
Namespace No namespace
Annotations
 
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
Diagram
Diagram
Type xs:IDREF
Properties
content simple
minOccurs 1
maxOccurs unbounded
Source
 
<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>
Element utilityService / metering
Namespace No namespace
Diagram
Diagram UtilityService_xsd.tmp#meteringTypesEnum
Type meteringTypesEnum
Properties
content simple
minOccurs 0
maxOccurs 1
Facets
enumeration Individually Metered
enumeration Master Metered
Source
 
<xs:element maxOccurs="1" minOccurs="0" name="metering" type="meteringTypesEnum"/>
Element utilityService / utilityTransformerConnection
Namespace No namespace
Diagram
Diagram UtilityService_xsd.tmp#utilityTransformerConnectionTypesEnum
Type utilityTransformerConnectionTypesEnum
Properties
content simple
minOccurs 0
maxOccurs 1
Facets
enumeration Secondary
enumeration Transmission
enumeration Primary
Source
 
<xs:element maxOccurs="1" minOccurs="0" name="utilityTransformerConnection" type="utilityTransformerConnectionTypesEnum"/>
Element utilityService / providesWaterHeating
Namespace No namespace
Annotations
 
Value = true if this UtilityService is known to provide the energy used for heating water.
Diagram
Diagram
Type xs:boolean
Properties
content simple
minOccurs 0
Source
 
<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>
Complex Type utilityService
Namespace http://www.iepmodel.net
Annotations
 
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.
Diagram
Diagram UtilityService_xsd.tmp#utilityService_id UtilityService_xsd.tmp#utilityService_revenueMeterIdRef UtilityService_xsd.tmp#utilityService_energy UtilityService_xsd.tmp#utilityService_utilityName UtilityService_xsd.tmp#utilityService_hostCustomerName UtilityService_xsd.tmp#utilityService_accountNumber UtilityService_xsd.tmp#utilityService_serviceId UtilityService_xsd.tmp#utilityService_existingRateSchedule UtilityService_xsd.tmp#utilityService_proposedRateSchedule UtilityService_xsd.tmp#utilityService_blendedRate UtilityService_xsd.tmp#utilityService_energyConsumption UtilityService_xsd.tmp#utilityService_utilityMeterId UtilityService_xsd.tmp#utilityService_electricDIstributionSystemIdRef UtilityService_xsd.tmp#utilityService_spaces UtilityService_xsd.tmp#utilityService_metering UtilityService_xsd.tmp#utilityService_utilityTransformerConnection UtilityService_xsd.tmp#utilityService_providesWaterHeating
Used by
Model
Children accountNumber, blendedRate, electricDIstributionSystemIdRef, energy, energyConsumption, existingRateSchedule, hostCustomerName, metering, proposedRateSchedule, providesWaterHeating, serviceId, spaces, utilityMeterId, utilityName, utilityTransformerConnection
Attributes
QName Type Use Annotation
id xs:ID optional
revenueMeterIdRef xs:IDREF optional 
When UtilityService is used within a Project.xsd, this attribute can reference a defined meter instance in the ElectricalDistributionHierarchy, or within a PvSystem.
Source
 
<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 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. Utiility 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 ElectricalDistributionHierarchy, or within a PvSystem.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>
Simple Type meteringTypesEnum
Namespace http://www.iepmodel.net
Annotations
 
Master metered or individually metered.
Diagram
Diagram
Type restriction of xs:string
Facets
enumeration Individually Metered
enumeration Master Metered
Used by
Source
 
<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>
Simple Type utilityTransformerConnectionTypesEnum
Namespace http://www.iepmodel.net
Annotations
 
The level at which the service connection is made to the utility's electrical services (primary, secondary, transmission).
Diagram
Diagram
Type restriction of xs:string
Facets
enumeration Secondary
enumeration Transmission
enumeration Primary
Used by
Source
 
<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>
Attribute utilityService / proposedRateSchedule / @ScopeOfWorkIdRef
Namespace No namespace
Annotations
 
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.
Type xs:IDREF
Properties
content simple
Used by
Source
 
<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>
Attribute utilityService / @id
Namespace No namespace
Type xs:ID
Properties
content simple
Used by
Complex Type utilityService
Source
 
<xs:attribute name="id" type="xs:ID"/>
Attribute utilityService / @revenueMeterIdRef
Namespace No namespace
Annotations
 
When UtilityService is used within a Project.xsd, this attribute can reference a defined meter instance in the ElectricalDistributionHierarchy, or within a PvSystem.
Type xs:IDREF
Properties
content simple
Used by
Complex Type utilityService
Source
 
<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 ElectricalDistributionHierarchy, or within a PvSystem.</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Editor.