schema location: | ..\PipeFunctionalAcknowledgement.xsd |
attribute form default: | unqualified |
element form default: | qualified |
Elements |
PIPEFunctionalAcknowledgement |
schema location: | ..\TypeDef\GDARTypeMarketDirectory.xsd |
attribute form default: | unqualified |
element form default: | qualified |
Complex types |
MarketParticipant |
MarketParticipantDirectory |
Recipient |
Sender |
schema location: | ..\TypeDef\GDARTypeStatusInfoPIPE.xsd |
attribute form default: | unqualified |
element form default: | qualified |
Simple types |
ReferenceNumberPIPE |
StatusPIPE |
StatusReasonPIPE |
diagram | ![]() |
||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||
children | MarketParticipantDirectory PIPEStatus | ||||||||||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||
source | <xs:element name="PIPEFunctionalAcknowledgement"> <xs:annotation> <xs:documentation>Document type name, stands for Participant Interface Process for Energy Functional Acknowledgement.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="MarketParticipantDirectory" type="MarketParticipantDirectory"> <xs:annotation> <xs:documentation>Contains tags that define all the Market Participants involved in the particular PIP Transaction.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="PIPEStatus"> <xs:complexType> <xs:sequence> <xs:element name="Status" type="StatusPIPE"> <xs:annotation> <xs:documentation>Indicates the status of the PIP Transaction or PIPE Functional Acknowledgement</xs:documentation> </xs:annotation> </xs:element> <xs:element name="StatusReason" type="StatusReasonPIPE"> <xs:annotation> <xs:documentation>Tag used to define the rejection or error.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="OriginalDocumentReferenceNumber" type="ReferenceNumberPIPE" use="required"> <xs:annotation> <xs:documentation>The reference number of the PIPE document being acknowledged.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="DocumentReferenceNumber" type="ReferenceNumberPIPE" use="required"> <xs:annotation> <xs:documentation>Uniquely identifies this PIPE Functional Acknowledgement.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="CreationDate" type="xs:dateTime" use="required"> <xs:annotation> <xs:documentation>System date and time stamp of when the transaction is generated.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Version" use="required"> <xs:annotation> <xs:documentation>Identifies the version of the PIPEDocument schema.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="1.1"/> </xs:restriction> </xs:simpleType> </xs:attribute> </xs:complexType> </xs:element> |
diagram | ![]() |
||||
type | MarketParticipantDirectory | ||||
properties |
|
||||
children | Sender Recipient | ||||
annotation |
|
||||
source | <xs:element name="MarketParticipantDirectory" type="MarketParticipantDirectory"> <xs:annotation> <xs:documentation>Contains tags that define all the Market Participants involved in the particular PIP Transaction.</xs:documentation> </xs:annotation> </xs:element> |
diagram | ![]() |
||||||||||||||
properties |
|
||||||||||||||
children | Status StatusReason | ||||||||||||||
attributes |
|
||||||||||||||
source | <xs:element name="PIPEStatus"> <xs:complexType> <xs:sequence> <xs:element name="Status" type="StatusPIPE"> <xs:annotation> <xs:documentation>Indicates the status of the PIP Transaction or PIPE Functional Acknowledgement</xs:documentation> </xs:annotation> </xs:element> <xs:element name="StatusReason" type="StatusReasonPIPE"> <xs:annotation> <xs:documentation>Tag used to define the rejection or error.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="OriginalDocumentReferenceNumber" type="ReferenceNumberPIPE" use="required"> <xs:annotation> <xs:documentation>The reference number of the PIPE document being acknowledged.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> |
diagram | ![]() |
||||
type | StatusPIPE | ||||
properties |
|
||||
facets |
|
||||
annotation |
|
||||
source | <xs:element name="Status" type="StatusPIPE"> <xs:annotation> <xs:documentation>Indicates the status of the PIP Transaction or PIPE Functional Acknowledgement</xs:documentation> </xs:annotation> </xs:element> |
diagram | ![]() |
||||||||||||
type | StatusReasonPIPE | ||||||||||||
properties |
|
||||||||||||
facets |
|
||||||||||||
annotation |
|
||||||||||||
source | <xs:element name="StatusReason" type="StatusReasonPIPE"> <xs:annotation> <xs:documentation>Tag used to define the rejection or error.</xs:documentation> </xs:annotation> </xs:element> |
diagram | ![]() |
||
children | CompanyName MarketParticipantIdentifier | ||
used by |
|
||
annotation |
|
||
source | <xs:complexType name="MarketParticipant"> <xs:annotation> <xs:documentation>Contains the relevant information pertaining to a particular Market Participant.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="CompanyName"> <xs:annotation> <xs:documentation>Identifies the name of the company that describes the particular Market Participant.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="100"/> <xs:minLength value="1"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="MarketParticipantIdentifier"> <xs:annotation> <xs:documentation>Unique identifier for the specific Market Participant.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:length value="10"/> </xs:restriction> </xs:simpleType> </xs:element> </xs:sequence> </xs:complexType> |
diagram | ![]() |
||||
type | restriction of xs:string | ||||
properties |
|
||||
facets |
|
||||
annotation |
|
||||
source | <xs:element name="CompanyName"> <xs:annotation> <xs:documentation>Identifies the name of the company that describes the particular Market Participant.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="100"/> <xs:minLength value="1"/> </xs:restriction> </xs:simpleType> </xs:element> |
diagram | ![]() |
||||
type | restriction of xs:string | ||||
properties |
|
||||
facets |
|
||||
annotation |
|
||||
source | <xs:element name="MarketParticipantIdentifier"> <xs:annotation> <xs:documentation>Unique identifier for the specific Market Participant.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:length value="10"/> </xs:restriction> </xs:simpleType> </xs:element> |
diagram | ![]() |
||
children | Sender Recipient | ||
used by |
|
||
annotation |
|
||
source | <xs:complexType name="MarketParticipantDirectory"> <xs:annotation> <xs:documentation>Contains the data structure that defines the set of Market Participants involved in all PIPs contained in the PIPE document.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="Sender" type="Sender"> <xs:annotation> <xs:documentation>Used to identify the sender of the PIPE Functional Acknowledgement.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Recipient" type="Recipient"> <xs:annotation> <xs:documentation>Used to identify the recipient of the PIPE Functional Acknowledgement.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | ![]() |
||||
type | Sender | ||||
properties |
|
||||
children | MarketParticipant | ||||
annotation |
|
||||
source | <xs:element name="Sender" type="Sender"> <xs:annotation> <xs:documentation>Used to identify the sender of the PIPE Functional Acknowledgement.</xs:documentation> </xs:annotation> </xs:element> |
diagram | ![]() |
||||
type | Recipient | ||||
properties |
|
||||
children | MarketParticipant | ||||
annotation |
|
||||
source | <xs:element name="Recipient" type="Recipient"> <xs:annotation> <xs:documentation>Used to identify the recipient of the PIPE Functional Acknowledgement.</xs:documentation> </xs:annotation> </xs:element> |
diagram | ![]() |
||
children | MarketParticipant | ||
used by |
|
||
annotation |
|
||
source | <xs:complexType name="Recipient"> <xs:annotation> <xs:documentation>Used to identify the Market Participant receiving the PIPE document. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="MarketParticipant" type="MarketParticipant"> <xs:annotation> <xs:documentation>Contains the specific Market Participant details of the Recipient.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | ![]() |
||||
type | MarketParticipant | ||||
properties |
|
||||
children | CompanyName MarketParticipantIdentifier | ||||
annotation |
|
||||
source | <xs:element name="MarketParticipant" type="MarketParticipant"> <xs:annotation> <xs:documentation>Contains the specific Market Participant details of the Recipient.</xs:documentation> </xs:annotation> </xs:element> |
diagram | ![]() |
||
children | MarketParticipant | ||
used by |
|
||
annotation |
|
||
source | <xs:complexType name="Sender"> <xs:annotation> <xs:documentation>Used to identify the Market Participant sending the PIPE document. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="MarketParticipant" type="MarketParticipant"> <xs:annotation> <xs:documentation>Contains the specific Market Participant details of the Sender. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | ![]() |
||||
type | MarketParticipant | ||||
properties |
|
||||
children | CompanyName MarketParticipantIdentifier | ||||
annotation |
|
||||
source | <xs:element name="MarketParticipant" type="MarketParticipant"> <xs:annotation> <xs:documentation>Contains the specific Market Participant details of the Sender. </xs:documentation> </xs:annotation> </xs:element> |
type | restriction of xs:string | ||||
used by |
|
||||
facets |
|
||||
annotation |
|
||||
source | <xs:simpleType name="ReferenceNumberPIPE"> <xs:annotation> <xs:documentation>Uniquely identifies a PIPE document.</xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:maxLength value="30"/> <xs:minLength value="30"/> </xs:restriction> </xs:simpleType> |
type | restriction of xs:NMTOKEN | ||||
used by |
|
||||
facets |
|
||||
annotation |
|
||||
source | <xs:simpleType name="StatusPIPE"> <xs:annotation> <xs:documentation>Indicates the status of the PIP Transaction or PIPE Functional Acknowledgement</xs:documentation> </xs:annotation> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="Accept"/> <xs:enumeration value="Reject"/> </xs:restriction> </xs:simpleType> |
type | restriction of xs:NMTOKEN | ||||||||||||
used by |
|
||||||||||||
facets |
|
||||||||||||
annotation |
|
||||||||||||
source | <xs:simpleType name="StatusReasonPIPE"> <xs:annotation> <xs:documentation>Tag used to define the rejection or error pertaining to PIPEs.</xs:documentation> </xs:annotation> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="DuplicateDRN"/> <xs:enumeration value="DuplicateTRN"/> <xs:enumeration value="NoTradingPartnerAgreement"/> <xs:enumeration value="InvalidXMLValidation"/> <xs:enumeration value="InvalidMarketParticipantID"/> <xs:enumeration value="Successful"/> </xs:restriction> </xs:simpleType> |