Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Statement update #372

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Statement update #372

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a86372
Proposed retailcustomer.xsd Statement update
KlaarDeSchepper Apr 1, 2022
b4cf69a
Removed pattern restriction for attachmentFileName
KlaarDeSchepper Apr 5, 2022
815d69b
Updated element naming and annotation, added MediaType enumeration, a…
KlaarDeSchepper Apr 8, 2022
158f3ef
Updated types for fileName and statementURL, added .zip as MediaType
KlaarDeSchepper Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 158 additions & 13 deletions etc/retailcustomer.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://naesb.org/espi/customer"
targetNamespace="http://naesb.org/espi/customer"
elementFormDefault="qualified" version="3.3.20200130">
<!--
targetNamespace="http://naesb.org/espi/customer" elementFormDefault="qualified"
version="3.3.20200130">
<!--
==========================================================================
Schema: retailcustomer.xsd
Version: North American Energy Standards Board (NAESB) REQ.21 ESPI Model Business Practices,
Expand Down Expand Up @@ -40,7 +40,7 @@ ______________________________________________________
==========================================================================
Schema: retailcustomer.xsd
Version: 3.3.20200130
Author: Ron Pasquarelli & Marty Burns (NIST), John Teeter (for NIST), Don Coffin (REMI Networks)
Author: Ron Pasquarelli & Marty Burns (NIST), John Teeter (for NIST), Don Coffin (REMI Networks), Klaar De Schepper (Flux Tailor)
==========================================================================
Copyright (c) 2018-2020 Green Button Alliance, Inc.

Expand All @@ -65,7 +65,7 @@ ______________________________________________________
END NOTICE
______________________________________________________
-->
<!-- edited with XMLSpy v2019 rel. 3 sp1 (x64) (http://www.altova.com) by Donald Coffin (REMI Networks) -->
<!-- edited with XMLSpy v2019 rel. 3 sp1 (x64) (http://www.altova.com) by Donald Coffin (REMI Networks) -->
<xs:annotation>
<xs:documentation>
The retail customer schema provides details about a UsagePoint that are considered Personally identifiable information (PII) and
Expand Down Expand Up @@ -159,7 +159,8 @@ Resources
<xs:documentation>The last amount that will be billed to the customer prior to shut off of the account.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="notifications" type="AccountNotification" minOccurs="0" maxOccurs="unbounded">
<xs:element name="notifications" type="AccountNotification" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Set of customer account notifications.</xs:documentation>
</xs:annotation>
Expand Down Expand Up @@ -200,12 +201,14 @@ Resources
<xs:documentation>Final date and time the service will be billed to the previous customer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DemandResponseProgram" type="DemandResponseProgram" minOccurs="0" maxOccurs="unbounded">
<xs:element name="DemandResponseProgram" type="DemandResponseProgram"
minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Demand Response program characteristics covered by Customer Agreement</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PricingStructures" type="PricingStructure" minOccurs="0" maxOccurs="unbounded">
<xs:element name="PricingStructures" type="PricingStructure" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All pricing structures applicable to this customer agreement.</xs:documentation>
</xs:annotation>
Expand All @@ -215,7 +218,8 @@ Resources
<xs:documentation>Currency for all monetary amounts for this agreement.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="futureStatus" type="Status" minOccurs="0" maxOccurs="unbounded">
<xs:element name="futureStatus" type="Status" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>[extension] Known future changes to CustomerAgreement's Status of Service.</xs:documentation>
</xs:annotation>
Expand Down Expand Up @@ -274,7 +278,8 @@ Some devices may use an optical port that conforms to the ANSI C12.18 standard f
<xs:documentation>Meter form designation per ANSI C12.10 or other applicable standard. An alphanumeric designation denoting the circuit arrangement for which the meter is applicable and its specific terminal arrangement.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MeterMultipliers" type="MeterMultiplier" minOccurs="0" maxOccurs="unbounded">
<xs:element name="MeterMultipliers" type="MeterMultiplier" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All multipliers applied at this meter.</xs:documentation>
</xs:annotation>
Expand All @@ -295,7 +300,8 @@ Some devices may use an optical port that conforms to the ANSI C12.18 standard f
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="programDateIdMapping" type="ProgramDateIdMapping" minOccurs="0">
<xs:element name="programDateIdMapping" type="ProgramDateIdMapping"
minOccurs="0">
<xs:annotation>
<xs:documentation>[extension] Program date description</xs:documentation>
</xs:annotation>
Expand Down Expand Up @@ -326,7 +332,8 @@ Some devices may use an optical port that conforms to the ANSI C12.18 standard f
<xs:documentation>True if inspection is needed of facilities at this service location. This could be requested by a customer, due to suspected tampering, environmental concerns (e.g., a fire in the vicinity), or to correct incompatible data.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="UsagePoints" type="UsagePoints" minOccurs="0" maxOccurs="unbounded">
<xs:element name="UsagePoints" type="UsagePoints" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All usage points delivering service (of the same type) to this service location.</xs:documentation>
</xs:annotation>
Expand Down Expand Up @@ -366,6 +373,28 @@ Some devices may use an optical port that conforms to the ANSI C12.18 standard f
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Statement">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Billing statement for provided services.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="IssueDateTime" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Date and time at which a billing statement was issued.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statementRef" type="StatementRef" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Contains document reference metadata needed to access a document representation of a billing statement.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="TimeConfiguration">
<xs:annotation>
<xs:documentation>[extension] Contains attributes related to the configuration of the time service.</xs:documentation>
Expand Down Expand Up @@ -978,7 +1007,8 @@ Example values for 'docStatus.status' are draft, approved, cancelled, etc.</xs:d
<xs:documentation>Status of this location.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="positionPoints" type="PositionPoint" minOccurs="0" maxOccurs="unbounded">
<xs:element name="positionPoints" type="PositionPoint" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.</xs:documentation>
</xs:annotation>
Expand Down Expand Up @@ -1226,6 +1256,32 @@ Example values for 'docStatus.status' are draft, approved, cancelled, etc.</xs:d
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="StatementRef">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] A sequence of references to a document associated with a Statement.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="fileName" minOccurs="0" type="String512">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Name of document or file including filename extension if present.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mediaType" minOccurs="0" type="MediaType">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Document media type as published by IANA, see https://www.iana.org/assignments/media-types for more information.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statementURL" type="xs:anyURI">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] URL used to access a representation of a statement, for example a bill image. Use CDATA or URL encoding to escape characters not allowed in XML.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Status">
<xs:annotation>
<xs:documentation>Current status information relevant to an entity.</xs:documentation>
Expand Down Expand Up @@ -1806,6 +1862,93 @@ Month: 3</xs:documentation>
</xs:simpleType>
</xs:union>
</xs:simpleType>
<xs:simpleType name="MediaType">
<xs:annotation>
<xs:documentation>[extension Copright GBA] Media type for document as registered by IANA, allowed subset in enumeration.</xs:documentation>
</xs:annotation>
<xs:union memberTypes="xs:string">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="application/json">
<xs:annotation>
<xs:documentation>json</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="application/pdf">
<xs:annotation>
<xs:documentation>pdf</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="application/vnd.ms-excel">
<xs:annotation>
<xs:documentation>vnd.ms-excel</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="application/vnd.oasis.opendocument.spreadsheet">
<xs:annotation>
<xs:documentation>vnd.oasis.opendocument.spreadsheet</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="application/vnd.oasis.opendocument.text">
<xs:annotation>
<xs:documentation>vnd.oasis.opendocument.text</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration
value="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet">
<xs:annotation>
<xs:documentation>vnd.openxmlformats-officedocument.spreadsheetml.sheet</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="application/zip">
<xs:annotation>
<xs:documentation>zip</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="image/gif">
<xs:annotation>
<xs:documentation>gif</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="image/jpeg">
<xs:annotation>
<xs:documentation>jpeg</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="image/png">
<xs:annotation>
<xs:documentation>png</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="text/csv">
<xs:annotation>
<xs:documentation>csv</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="text/html">
<xs:annotation>
<xs:documentation>html</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="text/plain">
<xs:annotation>
<xs:documentation>plain</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="text/rtf">
<xs:annotation>
<xs:documentation>rtf</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="text/xml">
<xs:annotation>
<xs:documentation>XML</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>
<xs:simpleType name="MeterMultiplierKind">
<xs:annotation>
<xs:documentation>Kind of meter multiplier.</xs:documentation>
Expand Down Expand Up @@ -3033,6 +3176,8 @@ Global Elements
<xs:element name="ProgramDateIdMappings" type="ProgramDateIdMappings"/>
<xs:element name="ServiceLocation" type="ServiceLocation"/>
<xs:element name="ServiceSupplier" type="ServiceSupplier"/>
<xs:element name="Statement" type="Statement"/>
<xs:element name="StatementRef" type="StatementRef"/>
<xs:element name="Status" type="Status"/>
<xs:element name="StreetAddress" type="StreetAddress"/>
<xs:element name="StreetDetail" type="StreetDetail"/>
Expand Down