Showing:

Annotations
Attributes
Diagrams
Facets
Properties
Source
Used by
Included schema EnergyConsumption.xsd
Namespace http://www.iepmodel.net
Annotations
 
<xs:include schemaLocation="\CommonQuantities.xsd"/>

The IEPModel team looked at using the gbXML model for energy consumption, which uses a time period ENUM of named calendar months, or "annual." 

A critical IEP use of energy consumption data is to pass historical billing data.  Billing data starts on any given date, and has a number of billing days, along with qty.  We should not assume that such raw billing data will be transformed into monthly/annual periods prior to being transferred via IEP between applications.  Consider that a PV marketer could actually collect billing data as part of their service. They would transfer the data as part of a lead that they sell to a contractor.

The IEP team agreed that it is NOT sufficient to simplify energy consumption periods into calendar months or annual periods. We agreed that it makes sense to provide for abilty to send raw billing data or monthly/annual data.

Therefore our IEP model defines an EnergyConsumption type that can contain multiple EnergyConsumptionRecords that each correspond to a defined time period.

Note that we currently use UtilityService XSD for capturing simple rough consumption estimates (e.g. I use 1000kWhrs/month, or my bill averages $X/month).
Properties
attribute form default: unqualified
element form default: unqualified
Element EnergyRecordType / DataSource
Namespace No namespace
Diagram
Diagram EnergyConsumption_xsd.tmp#EnergyDataSourceEnumType
Type EnergyDataSourceEnumType
Properties
content: simple
minOccurs: 0
maxOccurs: 1
Facets
enumeration Utility Bill
enumeration Simulated
enumeration Rated
enumeration Measured
enumeration Estimated
Source
 
<xs:element name="DataSource" type="EnergyDataSourceEnumType" minOccurs="0" maxOccurs="1"/>
Element EnergyRecordType / Description
Namespace No namespace
Annotations
 
Detail description of where the energy data comes from. For example, it may be:  a) specific piece of software, b) customer's bill, c) measurements, d) etc.  This field may contain information about who captured the data.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
maxOccurs: 1
Source
 
<xs:element name="Description" type="xs:string" minOccurs="0" maxOccurs="1">
  <xs:annotation>
    <xs:documentation>Detail description of where the energy data comes from. For example, it may be: a) specific piece of software, b) customer's bill, c) measurements, d) etc. This field may contain information about who captured the data.</xs:documentation>
  </xs:annotation>
</xs:element>
Element EnergyRecordType / EnergyAmountUnits
Namespace No namespace
Annotations
 
The Type and units of energy described in the EnergyAmount elements of each EnergyRecord.
Diagram
Diagram Common_xsd.tmp#EnergyUnitEnumType Common_xsd.tmp#EnergyUnitsType_Fuel Common_xsd.tmp#EnergyUnitsType
Type EnergyUnitsType
Type hierarchy
Properties
content: complex
Attributes
QName Type Fixed Default Use Annotation
Fuel EnergyClassEnumType optional
Source
 
<xs:element name="EnergyAmountUnits" type="EnergyUnitsType">
  <xs:annotation>
    <xs:documentation>The Type and units of energy described in the EnergyAmount elements of each EnergyRecord.</xs:documentation>
  </xs:annotation>
</xs:element>
Element EnergyRecordType / EnergyAmount
Namespace No namespace
Annotations
 
A quantity of energy. Units and energy type should be defined using the EnergyUnitsType. Each EnergyAmount instance can define the amount of energy used, saved, or produced during a defined period of time.
Diagram
Diagram Common_xsd.tmp#DataValueType_PeriodName Common_xsd.tmp#DataValueType_PeriodLength Common_xsd.tmp#DataValueType_Category Common_xsd.tmp#DataValueType_Date Common_xsd.tmp#DataValueType_Time Common_xsd.tmp#DataValueType EnergyConsumption_xsd.tmp#EnergyValueType
Type EnergyValueType
Type hierarchy
Properties
content: complex
maxOccurs: unbounded
Attributes
QName Type Fixed Default Use Annotation
Category xs:string optional 
An optional name for classifying the value. For example, energy bills frequently break the consumption down by time of use period. This category can be used to classify that time of use period.
Date xs:date optional 
This is the calendar date associated with the value. Typically used when DataValueType is used for site audit datalogging.
PeriodLength xs:decimal optional 
When data value is associated with a duration of time, this number describes its length.  Note that Units must be described in an associated TimeUnit attribute within the element where this DataValue resides.

Useful when defining energy billing periods that do not correspond to calendar months.  Use this attribute to capture the number of days in the billing period.
PeriodName xs:string optional 
An optional name for the Period in which the value was captured. Examples:  If Value is associated with a specific calendar month, then this attribute might be the month's name. If the value is an annual value, then the attribute might be "Annual."
Time xs:time optional 
This is the time of day associated with the value. Typically used when DataValueType is used for site audit datalogging.
Source
 
<xs:element maxOccurs="unbounded" name="EnergyAmount" type="EnergyValueType">
  <xs:annotation>
    <xs:documentation>A quantity of energy. Units and energy type should be defined using the EnergyUnitsType. Each EnergyAmount instance can define the amount of energy used, saved, or produced during a defined period of time.</xs:documentation>
  </xs:annotation>
</xs:element>
Element EnergyRecordType / PeakDemand
Namespace No namespace
Annotations
 
For cases where Electric Demand charges are relevant, this optional element can be used to capture the Peak power demand in kW during the period defined.
Diagram
Diagram Common_xsd.tmp#DataValueType_PeriodName Common_xsd.tmp#DataValueType_PeriodLength Common_xsd.tmp#DataValueType_Category Common_xsd.tmp#DataValueType_Date Common_xsd.tmp#DataValueType_Time Common_xsd.tmp#DataValueType EnergyConsumption_xsd.tmp#PeakPowerType
Type PeakPowerType
Type hierarchy
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Attributes
QName Type Fixed Default Use Annotation
Category xs:string optional 
An optional name for classifying the value. For example, energy bills frequently break the consumption down by time of use period. This category can be used to classify that time of use period.
Date xs:date optional 
This is the calendar date associated with the value. Typically used when DataValueType is used for site audit datalogging.
PeriodLength xs:decimal optional 
When data value is associated with a duration of time, this number describes its length.  Note that Units must be described in an associated TimeUnit attribute within the element where this DataValue resides.

Useful when defining energy billing periods that do not correspond to calendar months.  Use this attribute to capture the number of days in the billing period.
PeriodName xs:string optional 
An optional name for the Period in which the value was captured. Examples:  If Value is associated with a specific calendar month, then this attribute might be the month's name. If the value is an annual value, then the attribute might be "Annual."
Time xs:time optional 
This is the time of day associated with the value. Typically used when DataValueType is used for site audit datalogging.
Source
 
<xs:element minOccurs="0" name="PeakDemand" type="PeakPowerType" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>For cases where Electric Demand charges are relevant, this optional element can be used to capture the Peak power demand in kW during the period defined.</xs:documentation>
  </xs:annotation>
</xs:element>
Complex Type EnergyRecordType
Namespace http://www.iepmodel.net
Annotations
 
A series of energy quanities each of which are associated with a defined period. An energy record can cover multiple utility billing periods.
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
Used by
Model DataSource{0,1} , Description{0,1} , EnergyAmountUnits , EnergyAmount+ , PeakDemand*
Children DataSource, Description, EnergyAmount, EnergyAmountUnits, PeakDemand
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:complexType name="EnergyRecordType">
  <xs:annotation>
    <xs:documentation>A series of energy quanities each of which are associated with a defined period. An energy record can cover multiple utility billing periods.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="DataSource" type="EnergyDataSourceEnumType" minOccurs="0" maxOccurs="1"/>
    <xs:element name="Description" type="xs:string" minOccurs="0" maxOccurs="1">
      <xs:annotation>
        <xs:documentation>Detail description of where the energy data comes from. For example, it may be: a) specific piece of software, b) customer's bill, c) measurements, d) etc. This field may contain information about who captured the data.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="EnergyAmountUnits" type="EnergyUnitsType">
      <xs:annotation>
        <xs:documentation>The Type and units of energy described in the EnergyAmount elements of each EnergyRecord.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element maxOccurs="unbounded" name="EnergyAmount" type="EnergyValueType">
      <xs:annotation>
        <xs:documentation>A quantity of energy. Units and energy type should be defined using the EnergyUnitsType. Each EnergyAmount instance can define the amount of energy used, saved, or produced during a defined period of time.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="PeakDemand" type="PeakPowerType" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>For cases where Electric Demand charges are relevant, this optional element can be used to capture the Peak power demand in kW during the period defined.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
  <xs:attribute name="PeriodStart" type="xs:dateTime">
    <xs:annotation>
      <xs:documentation>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.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="PeriodUnits" type="TimeUnitEnumType">
    <xs:annotation>
      <xs:documentation>Describes the Units of time for the PeriodLength attribute within the EnergyAmounts.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="RevenueMeterIdRef" type="xs:IDREF">
    <xs:annotation>
      <xs:documentation>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.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>
Simple Type EnergyDataSourceEnumType
Namespace http://www.iepmodel.net
Annotations
 
This enumeration indicates where the energy consumption data originated.
Diagram
Diagram
Type restriction of xs:string
Facets
enumeration Utility Bill
enumeration Simulated
enumeration Rated
enumeration Measured
enumeration Estimated
Used by
Source
 
<xs:simpleType name="EnergyDataSourceEnumType">
  <xs:annotation>
    <xs:documentation>This enumeration indicates where the energy consumption data originated.</xs:documentation>
  </xs:annotation>
  <xs:restriction base="xs:string">
    <xs:enumeration value="Utility Bill"/>
    <xs:enumeration value="Simulated"/>
    <xs:enumeration value="Rated"/>
    <xs:enumeration value="Measured"/>
    <xs:enumeration value="Estimated"/>
  </xs:restriction>
</xs:simpleType>
Complex Type EnergyValueType
Namespace http://www.iepmodel.net
Annotations
 
A quantity of energy produced, consumed, or saved. If relevant, use name attribute to describe Time of Use period.
Diagram
Diagram Common_xsd.tmp#DataValueType_PeriodName Common_xsd.tmp#DataValueType_PeriodLength Common_xsd.tmp#DataValueType_Category Common_xsd.tmp#DataValueType_Date Common_xsd.tmp#DataValueType_Time Common_xsd.tmp#DataValueType
Type extension of DataValueType
Type hierarchy
Used by
Attributes
QName Type Fixed Default Use Annotation
Category xs:string optional 
An optional name for classifying the value. For example, energy bills frequently break the consumption down by time of use period. This category can be used to classify that time of use period.
Date xs:date optional 
This is the calendar date associated with the value. Typically used when DataValueType is used for site audit datalogging.
PeriodLength xs:decimal optional 
When data value is associated with a duration of time, this number describes its length.  Note that Units must be described in an associated TimeUnit attribute within the element where this DataValue resides.

Useful when defining energy billing periods that do not correspond to calendar months.  Use this attribute to capture the number of days in the billing period.
PeriodName xs:string optional 
An optional name for the Period in which the value was captured. Examples:  If Value is associated with a specific calendar month, then this attribute might be the month's name. If the value is an annual value, then the attribute might be "Annual."
Time xs:time optional 
This is the time of day associated with the value. Typically used when DataValueType is used for site audit datalogging.
Source
 
<xs:complexType name="EnergyValueType">
  <xs:annotation>
    <xs:documentation>A quantity of energy produced, consumed, or saved. If relevant, use name attribute to describe Time of Use period.</xs:documentation>
  </xs:annotation>
  <xs:simpleContent>
    <xs:extension base="DataValueType"/>
  </xs:simpleContent>
</xs:complexType>
Complex Type PeakPowerType
Namespace http://www.iepmodel.net
Annotations
 
The peak power quantity, given in kilowatts (kW), at a specified time. For cases where Demand charges are relevant.

Use the Date and Time attributes to express exact time of peak demand, if required.
Diagram
Diagram Common_xsd.tmp#DataValueType_PeriodName Common_xsd.tmp#DataValueType_PeriodLength Common_xsd.tmp#DataValueType_Category Common_xsd.tmp#DataValueType_Date Common_xsd.tmp#DataValueType_Time Common_xsd.tmp#DataValueType
Type extension of DataValueType
Type hierarchy
Used by
Attributes
QName Type Fixed Default Use Annotation
Category xs:string optional 
An optional name for classifying the value. For example, energy bills frequently break the consumption down by time of use period. This category can be used to classify that time of use period.
Date xs:date optional 
This is the calendar date associated with the value. Typically used when DataValueType is used for site audit datalogging.
PeriodLength xs:decimal optional 
When data value is associated with a duration of time, this number describes its length.  Note that Units must be described in an associated TimeUnit attribute within the element where this DataValue resides.

Useful when defining energy billing periods that do not correspond to calendar months.  Use this attribute to capture the number of days in the billing period.
PeriodName xs:string optional 
An optional name for the Period in which the value was captured. Examples:  If Value is associated with a specific calendar month, then this attribute might be the month's name. If the value is an annual value, then the attribute might be "Annual."
Time xs:time optional 
This is the time of day associated with the value. Typically used when DataValueType is used for site audit datalogging.
Source
 
<xs:complexType name="PeakPowerType">
  <xs:annotation>
    <xs:documentation>The peak power quantity, given in kilowatts (kW), at a specified time. For cases where Demand charges are relevant. Use the Date and Time attributes to express exact time of peak demand, if required.</xs:documentation>
  </xs:annotation>
  <xs:simpleContent>
    <xs:extension base="DataValueType">
    </xs:extension>
  </xs:simpleContent>
</xs:complexType>
Attribute EnergyRecordType / @PeriodStart
Namespace No namespace
Annotations
 
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.
Type xs:dateTime
Properties
content: simple
Used by
Complex Type EnergyRecordType
Source
 
<xs:attribute name="PeriodStart" type="xs:dateTime">
  <xs:annotation>
    <xs:documentation>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.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute EnergyRecordType / @PeriodUnits
Namespace No namespace
Annotations
 
Describes the Units of time for the PeriodLength attribute within the EnergyAmounts.
Type TimeUnitEnumType
Properties
content: simple
Facets
enumeration Day
enumeration Hour
enumeration Minute
enumeration Month
enumeration Second
enumeration Week
enumeration Year
Used by
Complex Type EnergyRecordType
Source
 
<xs:attribute name="PeriodUnits" type="TimeUnitEnumType">
  <xs:annotation>
    <xs:documentation>Describes the Units of time for the PeriodLength attribute within the EnergyAmounts.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute EnergyRecordType / @RevenueMeterIdRef
Namespace No namespace
Annotations
 
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.
Type xs:IDREF
Properties
content: simple
Used by
Complex Type EnergyRecordType
Source
 
<xs:attribute name="RevenueMeterIdRef" type="xs:IDREF">
  <xs:annotation>
    <xs:documentation>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.</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Developer.