Showing:

Annotations
Attributes
Diagrams
Facets
Instances
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 UtilityServiceType / Energy
Namespace No namespace
Annotations
Names the energy fuel type.
Diagram
Diagram Common_xsd.tmp#EnergyClassEnumType
Type EnergyClassEnumType
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 (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="EnergyClassEnumType">
  <xs:annotation>
    <xs:documentation>Names the energy fuel type.</xs:documentation>
  </xs:annotation>
</xs:element>
Element UtilityServiceType / 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 UtilityServiceType / 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 UtilityServiceType / 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 UtilityServiceType / 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 UtilityServiceType / 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 UtilityServiceType / 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#UtilityServiceType_UtilityServiceType_ProposedRateSchedule_ScopeOfWorkIdRef
Type extension of xs:string
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Attributes
QName Type Fixed Default 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="unbounded" 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 UtilityServiceType / 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#MonetaryType_Unit Common_xsd.tmp#MonetaryType
Type MonetaryType
Properties
content: complex
minOccurs: 0
maxOccurs: 1
Attributes
QName Type Fixed Default Use Annotation
Unit MonetaryUnitEnumType optional
Source
<xs:element maxOccurs="1" minOccurs="0" name="BlendedRate" type="MonetaryType">
  <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 UtilityServiceType / EnergyConsumption
Namespace No namespace
Annotations
Multiple Energy Consumption elements are allowed in case of multiple revenue meters.
Diagram
Diagram EnergyConsumption_xsd.tmp#EnergyRecordType_PeriodStart EnergyConsumption_xsd.tmp#EnergyRecordType_PeriodUnits EnergyConsumption_xsd.tmp#EnergyRecordType_RevenueMeterIdRef EnergyConsumption_xsd.tmp#EnergyRecordType_DataSource EnergyConsumption_xsd.tmp#EnergyRecordType_Description EnergyConsumption_xsd.tmp#EnergyRecordType_EnergyAmountUnits EnergyConsumption_xsd.tmp#EnergyRecordType_EnergyAmount EnergyConsumption_xsd.tmp#EnergyRecordType_PeakDemand EnergyConsumption_xsd.tmp#EnergyRecordType
Type EnergyRecordType
Properties
content: complex
minOccurs: 0
maxOccurs: 1
Model DataSource{0,1} , Description{0,1} , EnergyAmountUnits , EnergyAmount+ , PeakDemand*
Children DataSource, Description, EnergyAmount, EnergyAmountUnits, PeakDemand
Instance
<EnergyConsumption PeriodStart="" PeriodUnits="" RevenueMeterIdRef="">
  <DataSource>{0,1}</DataSource>
  <Description>{0,1}</Description>
  <EnergyAmountUnits Fuel="">{1,1}</EnergyAmountUnits>
  <EnergyAmount Category="" Date="" PeriodLength="" PeriodName="" Time="">{1,unbounded}</EnergyAmount>
  <PeakDemand Category="" Date="" PeriodLength="" PeriodName="" Time="">{0,unbounded}</PeakDemand>
</EnergyConsumption>
Attributes
QName Type Fixed Default 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 TimeUnitEnumType 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="EnergyRecordType">
  <xs:annotation>
    <xs:documentation>Multiple Energy Consumption elements are allowed in case of multiple revenue meters.</xs:documentation>
  </xs:annotation>
</xs:element>
Element UtilityServiceType / 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 UtilityServiceType / 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: 0
maxOccurs: unbounded
Source
<xs:element maxOccurs="unbounded" minOccurs="0" 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 UtilityServiceType / Metering
Namespace No namespace
Diagram
Diagram UtilityService_xsd.tmp#MeteringTypesEnumType
Type MeteringTypesEnumType
Properties
content: simple
minOccurs: 0
maxOccurs: 1
Facets
enumeration Individually Metered
enumeration Master Metered
Source
<xs:element maxOccurs="1" minOccurs="0" name="Metering" type="MeteringTypesEnumType"/>
Element UtilityServiceType / UtilityTransformerConnection
Namespace No namespace
Diagram
Diagram UtilityService_xsd.tmp#UtilityTransformerConnectionTypesEnumType
Type UtilityTransformerConnectionTypesEnumType
Properties
content: simple
minOccurs: 0
maxOccurs: 1
Facets
enumeration Secondary
enumeration Transmission
enumeration Primary
Source
<xs:element maxOccurs="1" minOccurs="0" name="UtilityTransformerConnection" type="UtilityTransformerConnectionTypesEnumType"/>
Element UtilityServiceType / 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 UtilityServiceType
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#UtilityServiceType_RevenueMeterIdRef UtilityService_xsd.tmp#UtilityServiceType_Energy UtilityService_xsd.tmp#UtilityServiceType_UtilityName UtilityService_xsd.tmp#UtilityServiceType_HostCustomerName UtilityService_xsd.tmp#UtilityServiceType_AccountNumber UtilityService_xsd.tmp#UtilityServiceType_ServiceId UtilityService_xsd.tmp#UtilityServiceType_ExistingRateSchedule UtilityService_xsd.tmp#UtilityServiceType_ProposedRateSchedule UtilityService_xsd.tmp#UtilityServiceType_BlendedRate UtilityService_xsd.tmp#UtilityServiceType_EnergyConsumption UtilityService_xsd.tmp#UtilityServiceType_UtilityMeterId UtilityService_xsd.tmp#UtilityServiceType_Space UtilityService_xsd.tmp#UtilityServiceType_Metering UtilityService_xsd.tmp#UtilityServiceType_UtilityTransformerConnection UtilityService_xsd.tmp#UtilityServiceType_ProvidesWaterHeating
Used by
Model Energy , UtilityName{0,1} , HostCustomerName{0,1} , AccountNumber{0,1} , ServiceId{0,1} , ExistingRateSchedule{0,1} , ProposedRateSchedule* , BlendedRate{0,1} , EnergyConsumption{0,1} , UtilityMeterId{0,1} , Space* , Metering{0,1} , UtilityTransformerConnection{0,1} , ProvidesWaterHeating{0,1}
Children AccountNumber, BlendedRate, Energy, EnergyConsumption, ExistingRateSchedule, HostCustomerName, Metering, ProposedRateSchedule, ProvidesWaterHeating, ServiceId, Space, UtilityMeterId, UtilityName, UtilityTransformerConnection
Attributes
QName Type Fixed Default Use Annotation
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="UtilityServiceType">
  <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="EnergyClassEnumType">
      <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="unbounded" 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="MonetaryType">
      <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="EnergyRecordType">
      <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 maxOccurs="unbounded" minOccurs="0" 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:element maxOccurs="1" minOccurs="0" name="Metering" type="MeteringTypesEnumType"/>
    <xs:element maxOccurs="1" minOccurs="0" name="UtilityTransformerConnection" type="UtilityTransformerConnectionTypesEnumType"/>
    <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="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 MeteringTypesEnumType
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="MeteringTypesEnumType">
  <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 UtilityTransformerConnectionTypesEnumType
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="UtilityTransformerConnectionTypesEnumType">
  <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 UtilityServiceType / 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 UtilityServiceType / @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 UtilityServiceType
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>