iso interface specification - california iso · iso interface specification ... cause codes that...
TRANSCRIPT
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 1 of 112
ISO Interface Specification
Outage Management System Document Version: 1.7
Date Created: 12/27/2013
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 2 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Location of Document
<Add Documentum path or URL here>
Revision History
Date Version Description Author
12/27/2013 0.1 Document creation Sean Crimmins
01/08/2014 1.0 Initial document with Generation submit/retrieve
Sean Crimmins
1/27/2014 1.1 Updated with Transmission submit/retrieve
Sean Crimmins
2/7/2014 1.2 Added common services and facility outage definition
Sean Crimmins
2/7/2014 1.2 Added outage status update Sean Crimmins
4/7/2014 1.2 Updated WSDLs and sample XSDs to reflect latest XSD modifications
Sunil Nallagangu
4/15/2014 1.2 Updated spec to accommodate changes in ResourceOutageResults_v1.xsd
Sunil Nallagangu
5/29/2014 1.3 Updated spec to accommodate latest changes in XSDs
Sunil Nallagangu
7/21/2014 1.4 Added SOAP Header and MTOM attachment Info
Sunil Nallagangu
08/01/2014 1.4 Updated spec to reflect latest XSDs Sunil Nallagangu
08/28/2014 1.5 1.Updated spec to reflect latest XSDs TransmissionOutage: Relaxed length restriction Equipment MRID from 32 to 40 chars Relaxed length restriction Equipment Name from 32 to 80 chars Added Enumeration for Equipment NameType
ResourceOutage: Relaxed Resource(Generator/Intertie/Load) name from 32 to 40 chars.
Sunil Nallagangu
10/10/2014 1.6 Updated retrieve resource outage , retrieve transmission outage, retrieve availability and retrieve facility outage definition sections to include tables that describe how the different request
Yinka Ajede
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 3 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Date Version Description Author
criteria can be used.
11/10/2014 1.6 TransmissionOutageResults (B2B) - Adding enumerations (CONFORMLOAD, NONCONFORMLOAD and STATICVARCOMPENSATOR) to equipment type.
FacilityOutageDefinitionResults (B2B) - Adding only “STATICVARCOMPENSATOR” enumeration to equipment type (already has ConformLoad and NonConformLoad in the enumerations)
Sunil Nallagangu
11/11/2014 1.6 Added list of primary and secondary cause codes that are required for forced transmission outages
Yinka Ajede
11/11/2014 1.6 RequestFacilityOutageDefinition updated to enable search by Participant market organisation
Sunil Nallagangu
11/17/2014 1.7 Added enumerations to be used for primary and secondary codes that are required for forced transmission outages
Yinka Ajede
Versioning should be as follows:
1. Draft – When a document is still in its developing stages and is not ready for review and sign off. 2. V 0.n – When changes are made before the document is ready for initial review. 3. V 1.0 – When a document is ready for review and sign off. It remains as v 1.0 after sign off if no
changes are made. 4. V 1.n – When changes are made after the initial review. “n” represents the number of iterations of
changes until the official signoff. 5. V 2.0 – When additional changes are requested after initial sign off and Change Request is
approved. The Change Request that initiated the revision must be referenced in the Revision History Description.
6. V2.n – When changes are made after the second sign off where the changes do not affect downstream/related documents or system code (i.e.: grammar changes, etc.)
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 4 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Table of Contents 1. INTRODUCTION................................................................................................................................................... 9
1.1 PURPOSE .............................................................................................................................................................. 9 1.2 CONTACT INFORMATION ....................................................................................................................................... 9 1.3 RELATED DOCUMENTS ......................................................................................................................................... 9 1.4 RELEASE NOTES ..................................................................................................................................................10 1.5 API TRANSITION SUPPORT ...................................................................................................................................10 1.6 MTOM ATTACHMENTS .......................................................................................................................................10 1.7 DATE TIME DATA TYPE ELEMENTS .....................................................................................................................11
2. SOAP HEADER ELEMENTS & MTOM ATTACHMENTS ...........................................................................11
2.1 IDENTITY OF MESSAGE PRODUCER ......................................................................................................................11 2.1.1 Identity .......................................................................................................................................................11 2.1.2 Timestamp ..................................................................................................................................................12 2.1.3 Message Freshness ....................................................................................................................................12
2.2 MTOM ATTACHMENTS .......................................................................................................................................12
3. STANDARD XSDS ................................................................................................................................................14
3.1 STANDARD ATTACHMENT INFORMATION ............................................................................................................14 1.1.1 Element table .............................................................................................................................................14 3.1.1 Schema (StandardAttachmentInfor.xsd) ....................................................................................................15 1.1.2 Example XML File (StandardAttachmentInfor.xml) ..................................................................................15
3.2 FAULT RETURN ....................................................................................................................................................16 3.2.1 Element Table ............................................................................................................................................16 3.2.2 Schema (StandardOutput.xsd) ...................................................................................................................17 3.2.3 Example XML File (StandardOutput.xml) .................................................................................................17
4. SUBMIT RESOURCE OUTAGE {CHANGE REQUESTS} BUSINESS SCENARIO ...................................18
4.1 OVERVIEW ...........................................................................................................................................................18 4.2 SERVICE LEVEL AGREEMENT ...............................................................................................................................18 4.3 USE MODEL .........................................................................................................................................................18
4.3.1 Submit New Outage ...................................................................................................................................18 4.3.2 Submit Change to Existing Outage ............................................................................................................19
4.4 OPERATIONAL DETAILS .......................................................................................................................................19 4.4.1 Submit Resource Outage............................................................................................................................19 4.4.2 Submit Resource Outage Change Request .................................................................................................19
4.5 WSDL .................................................................................................................................................................19 4.5.1 submitResourceOutage_v1.wsdl / submitResourceOutage_v1_DocAttach.wsdl .......................................19 4.5.2 submitResourceOutageChangeRequest_v1.wsdl /
submitResourceOutageChangeRequest_v1_DocAttach.wsdl ..................................................................................19 4.6 SUBMIT RESOURCE OUTAGE {CHANGE REQUEST} ..............................................................................................20
4.6.1 Element Table ............................................................................................................................................20 4.6.2 Schema (ResourceOutageData_v1.xsd) .....................................................................................................27 4.6.3 Example XML File (SubmitResourceOutageData_v1.xml) .......................................................................27 4.6.4 Example XML File (SubmitResourceOutageChangeRequest_v1.xml) ......................................................30
4.7 SUBMIT RESOURCE OUTAGE {CHANGE REQUEST} RESPONSE .............................................................................32 4.7.1 Element Table ............................................................................................................................................32 4.7.2 Schema (OutageStandardOutput_v1.xsd) ..................................................................................................33
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 5 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
4.7.3 Example XML File (ResourceOutageStandardOutput.xml) ......................................................................33
5. RETRIEVE OUTAGE/CHANGE REQUESTS BUSINESS SCENARIO........................................................37
5.1 OVERVIEW ...........................................................................................................................................................37 5.2 SERVICE LEVEL AGREEMENT ...............................................................................................................................37 5.3 USE MODEL .........................................................................................................................................................37
5.3.1 Retrieve Generation Outages ....................................................................................................................37 5.3.2 Retrieve Resource Outage Change Requests .............................................................................................38
5.4 OPERATIONAL DETAILS .......................................................................................................................................38 5.4.1 Retrieve Resource Outage .........................................................................................................................38 5.4.2 Retrieve Resource Outage Change Request ..............................................................................................38
5.5 WSDL .................................................................................................................................................................38 5.5.1 retrieveResourceOutage_v1.wsdl / retrieveResourceOutage_v1_DocAttach.wsdl ...................................38 5.5.2 retrieveResourceOutageChangeRequest_v1.wsdl /
retrieveResourceOutageChangeRequest_v1_DocAttach.wsdl .................................................................................39 5.6 RETRIEVE RESOURCE OUTAGE {CHANGE REQUEST} ..........................................................................................39
5.6.1 Element Table ............................................................................................................................................39 5.6.2 Schema (RequestResourceOutage_v1.xsd) ................................................................................................40 5.6.3 Example XML File (RequestResourceOutage_v1.xml) ..............................................................................40 5.6.4 Example XML file (RequestResourceOutageChangeRequest.xml) ............................................................41
5.7 RETRIEVE RESOURCE OUTAGE {CHANGE REQUEST} RESPONSE .........................................................................41 5.7.1 Element Table ............................................................................................................................................41 5.7.2 Schema (ResourceOutageResults_v1.xsd) .................................................................................................50 5.7.3 Example XML File (ResourceOutageResults_v1.xml) ...............................................................................50 5.7.4 Example XML file (ResourceOutageChangeRequestResults_v1.xml) .......................................................53
5.8 FAULT RETURN ....................................................................................................................................................57
6. SUBMIT TRANSMISSION OUTAGE {CHANGE REQUESTS} BUSINESS SCENARIO ..........................58
6.1 OVERVIEW ...........................................................................................................................................................58 6.2 SERVICE LEVEL AGREEMENT ...............................................................................................................................58 6.3 USE MODEL .........................................................................................................................................................58
6.3.1 Submit New Transmission Outage .............................................................................................................58 6.3.2 Submit Change to Existing Transmission Outage .....................................................................................59
6.4 OPERATIONAL DETAILS .......................................................................................................................................59 6.4.1 Submit Transmission Outage .....................................................................................................................59 6.4.2 Submit Transmission Outage Change Request ..........................................................................................59
6.5 WSDL .................................................................................................................................................................59 6.5.1 SubmitTransmissionOutage_v1.wsdl / SubmitTransmissionOutage_v1_DocAttach.wsdl .........................59 6.5.2 SubmitTransmissionOutageChangeRequest_v1.wsdl/
SubmitTransmissionOutageChangeRequest_v1_DocAttach.wsdl ...........................................................................60 6.6 SUBMIT TRANSMISSION OUTAGE {CHANGE REQUEST} .......................................................................................60
6.6.1 Element Table ............................................................................................................................................61 6.6.2 Schema (TransmissionOutageData_v1.xsd) ..............................................................................................64 6.6.3 Example XML File (SubmitTransmissionOutageData_v1.xml) .................................................................64 6.6.4 Example XML File (SubmitTransmissionOutageChangeRequest_v1.xml) ................................................66
6.7 SUBMIT TRANSMISSIONOUTAGE {CHANGE REQUEST} RESPONSE .......................................................................68 6.7.1 Element Table ............................................................................................................................................68 6.7.2 Schema (OutageStandardOutput_v1.xsd) ..................................................................................................70 6.7.3 Example XML File (TransmissionOutageStandardOutput_v1.xml) ..........................................................70
7. RETRIEVE TRANSMISSION OUTAGE/CHANGE REQUESTS ..................................................................72
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 6 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
7.1 OVERVIEW ...........................................................................................................................................................72 7.2 SERVICE LEVEL AGREEMENT ...............................................................................................................................72 7.3 USE MODEL .........................................................................................................................................................72
7.3.1 Retrieve Transmission Outages .................................................................................................................72 7.3.2 Retrieve Transmission Outage Change Requests ......................................................................................73
7.4 OPERATIONAL DETAILS .......................................................................................................................................73 7.4.1 Retrieve Transmission Outage ...................................................................................................................73 7.4.2 Retrieve Transmission Outage Change Request ........................................................................................73
7.5 WSDL .................................................................................................................................................................73 7.5.1 retrieveTransmissionOutage_v1.wsdl / retrieveTransmissionOutage_v1_DocAttach.wsdl ......................73 7.5.2 retrieveTransmissionOutageChangeRequest_v1.wsdl /
retrieveTransmissionOutageChangeRequest_v1_DocAttach.wsdl ..........................................................................74 7.6 RETRIEVE TRANSMISSION OUTAGE {CHANGE REQUEST}....................................................................................74
7.6.1 Element Table ............................................................................................................................................74 7.6.2 Schema (RequestTransmissionOutage_v1.xsd) .........................................................................................75 7.6.3 Example XML File (RequestTransmissionOutage_v1.xml) .......................................................................75 7.6.4 Example XML file (RequestTransmissionOutageChangeRequest_v1.xml) ...............................................76
7.7 RETRIEVE TRANSMISSION OUTAGE {CHANGE REQUEST} RESPONSE ..................................................................77 7.7.1 Element Table ............................................................................................................................................77 7.7.2 Schema (TransmissionOutageResults_v1.xsd) ..........................................................................................81 7.7.3 Example XML File (TransmissionOutageResults_v1.xml) ........................................................................81 7.7.4 Example XML file (TransmissionOutageResultsChangeRequests_v1.xml) ...............................................84
7.8 FAULT RETURN ....................................................................................................................................................88
8. RETRIEVE AVAILABILITY ..............................................................................................................................89
8.1 OVERVIEW ...........................................................................................................................................................89 8.2 SERVICE LEVEL AGREEMENT ...............................................................................................................................89 8.3 USE MODEL .........................................................................................................................................................89
8.3.1 Retrieve Availability ..................................................................................................................................89 8.4 OPERATIONAL DETAILS .......................................................................................................................................90
8.4.1 Retrieve Availability ..................................................................................................................................90 8.5 WSDL .................................................................................................................................................................90
8.5.1 retrieveAvailability_v1.wsdl / retrieveAvailability_v1_DocAttach.wsdl ...................................................90 8.6 RETRIEVE AVAILABILITY .....................................................................................................................................90
8.6.1 Element Table ............................................................................................................................................90 8.6.2 Schema (RequestAvailability_v1.xsd) ........................................................................................................91 8.6.3 Example XML File (RequestAvailability_v1.xml) ......................................................................................91
8.7 REQUEST AVAILABILITY RESPONSE .....................................................................................................................92 8.7.1 Element Table ............................................................................................................................................92 8.7.2 Schema (AvailabilityResults_v1.xsd) .........................................................................................................92 8.7.3 Example XML File (AvailabilityResults_v1.xml) .......................................................................................93
8.8 FAULT RETURN ....................................................................................................................................................94
9. RETRIEVE FACILITY OUTAGE DEFINITION .............................................................................................95
9.1 OVERVIEW ...........................................................................................................................................................95 9.2 SERVICE LEVEL AGREEMENT ...............................................................................................................................95 9.3 USE MODEL .........................................................................................................................................................95
9.3.1 Retrieve Facility Outage Definition ...........................................................................................................95 9.4 OPERATIONAL DETAILS .......................................................................................................................................96
9.4.1 Retrieve Facility Outage Definition ...........................................................................................................96 9.5 WSDL .................................................................................................................................................................96
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 7 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
9.5.1 retrieveFacilityOutageDefinition_v1.wsdl / retrieveFacilityOutageDefinition_v1_DocAttach.wsdl ........96 9.6 RETRIEVE FACILITY OUTAGE DEFINITION ...........................................................................................................96
9.6.1 Element Table ............................................................................................................................................96 9.6.2 Schema (requestFacilityOutageDefinition_v1.xsd) ...................................................................................97 9.6.3 Example XML File (requestFacilityOutageDefinition_v1.xml) .................................................................97
9.7 REQUEST FACILITY OUTAGE RESPONSE ..............................................................................................................98 9.7.1 Element Table ............................................................................................................................................98 9.7.2 Schema (FacilityOutageDefinitionResults_v1.xsd) ...................................................................................99 9.7.3 Example XML File (FacilityOutageDefinitionResults_v1.xml) .................................................................99
9.8 FAULT RETURN ..................................................................................................................................................100
10. WITHDRAW OUTAGE CHANGE REQUEST ...............................................................................................101
10.1 OVERVIEW ....................................................................................................................................................101 10.2 SERVICE LEVEL AGREEMENT ........................................................................................................................101 10.3 USE MODEL ..................................................................................................................................................101
10.3.1 Retrieve Facility Outage Definition ....................................................................................................101 10.4 OPERATIONAL DETAILS ................................................................................................................................102
10.4.1 Retrieve Facility Outage Definition ....................................................................................................102 10.5 WSDL...........................................................................................................................................................102
10.5.1 withdrawOutageChangeRequest_v1.wsdl / withdrawOutageChangeRequest_v1_DocAttach.wsdl ...102 10.6 WITHDRAW OUTAGE CHANGEREQUEST .......................................................................................................102
10.6.1 Element Table .....................................................................................................................................102 10.6.2 Schema (WithdrawOutageChangeRequest_v1.xsd) ............................................................................102 10.6.3 Example XML File (WithdrawOutageChangeRequest_v1.xml) ..........................................................102
10.7 WITHDRAW OUTAGE CHANGE REQUEST STANDARD OUTPUT ......................................................................103 10.7.1 Element Table .....................................................................................................................................103 10.7.2 Schema (StandardOutput_v1.xsd) .......................................................................................................103 10.7.3 Example XML File (WithdrawOutageChangeRequestStandardOutput_v1.xml) ................................103
10.8 FAULT RETURN .............................................................................................................................................104
11. ACKNOWLEDGE OUTAGE WARNING .......................................................................................................105
11.1 OVERVIEW ....................................................................................................................................................105 11.2 SERVICE LEVEL AGREEMENT ........................................................................................................................105 11.3 USE MODEL ..................................................................................................................................................105
11.3.1 Acknowledge Outage Warning............................................................................................................105 11.4 OPERATIONAL DETAILS ................................................................................................................................106
11.4.1 Retrieve Facility Outage Definition ....................................................................................................106 11.5 WSDL...........................................................................................................................................................106
11.5.1 AcknowledgeOutageWarning_v1.wsdl / AcknowledgeOutageWarning_v1_DocAttach.wsdl .............106 11.6 ACKNOWLEDGE OUTAGE WARNING .............................................................................................................106
11.6.1 Element Table .....................................................................................................................................106 11.6.2 Schema (AcknowledgeOutageWarning_v1.xsd)..................................................................................106 11.6.3 Example XML File (AcknowledgeOutageWarning_v1.xml) ...............................................................106
11.7 ACKNOWLEDGE OUTAGE WARNING STANDARD OUTPUT .............................................................................107 11.7.1 Element Table .....................................................................................................................................107 11.7.2 Schema (StandardOutput_v1.xsd) .......................................................................................................107 11.7.3 Example XML File (AcknowledgeOutageWarningStandardOutput_v1.xml) ......................................107
12. OUTAGE STATUS UPDATE ............................................................................................................................109
12.1 OVERVIEW ....................................................................................................................................................109 12.2 SERVICE LEVEL AGREEMENT ........................................................................................................................109
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 8 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
12.3 USE MODEL ..................................................................................................................................................109 12.3.1 Acknowledge Outage Warning............................................................................................................109
12.4 OPERATIONAL DETAILS ................................................................................................................................110 12.4.1 Outage Status Update .........................................................................................................................110
12.5 WSDL...........................................................................................................................................................110 12.5.1 OutageStatusUpdate_v1.wsdl / OutageStatusUpdate_v1_DocAttach.wsdl ........................................110
12.6 OUTAGE STATUS UPDATE .............................................................................................................................110 12.6.1 Element Table .....................................................................................................................................110 12.6.2 Schema (OutageStatusUpdate_v1.xsd) ...............................................................................................111 12.6.3 Example XML File (OutageStatusUpdate_v1.xml) .............................................................................111
12.7 OUTAGE STATUS UPDATE .............................................................................................................................112 12.7.1 Element Table .....................................................................................................................................112 12.7.2 Schema (StandardOutput_v1.xsd) .......................................................................................................112 12.7.3 Example XML File ..............................................................................................................................112
12.8 FAULT RETURN .............................................................................................................................................112
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 9 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
1. Introduction
1.1 Purpose
This document describes the Market Participant interface to CAISO’s Outage Management System (OMS) web services. It provides the WSDL, XSD, and XML information required by application programmers to create and send messages and to process response messages.
1.2 Contact Information
For any questions regarding this document or technical questions related to integrating applications with
CAISO’s Outage Management System web services, please send email to [email protected]
1.3 Related Documents
CAISO’s ISO MARKET program has produced a set of documents describing its web services architecture and associated interfaces to the Bidding, Market Results, Trades, Outage Management and Sandbox services. CASIO’s ISO MARKET Web Services Architecture & Integration Specification is the top-level document in this set; Market Participants and their application programmers should read this document to gain an overall understanding of CASIO’s web services architecture prior to reading any of the detailed documents shown below.
Figure 1 – ISO MARKET Web Services Interface Specification Document Set
The ISO MARKET Web Services Interface Specification Document Set is available online at the locations
indicated below.
Doc. No. Document Name Location
B2B Security Specification (CAISO ISS)
CAISO’s Web Services Architecture & Integration Specification
Client Public/Private Key Instructions (CAISO ISS)
Interface Specification for Bidding Services
Interface Specification for Inter-SC Trade Services
Interface Specification for Market Result Services
Interface Specification for Outage Management Services
Sandbox Services & Test Client Guide
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 10 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Doc. No. Document Name Location
1
ISO MARKET B2B Security
Specification
https://portal.caiso.com
(you must have access to the Market Participant
Portal)
2 Client Public/Private Key
Instructions
ClientPublic_PrivateKeyGuidelines.pdf
3
ISO MARKET Interface
Specification for Bidding Services
http://www.caiso.com/participate/Pages/ApplicationAccess/Default.aspx
4
ISO MARKET Interface
Specification for Inter-SC Trade
Services
http://www.caiso.com/participate/Pages/ApplicationAccess/Default.aspx
5
ISO MARKET Interface
Specification for Market Results
Services
http://www.caiso.com/participate/Pages/ApplicationAccess/Default.aspx
6
ISO Interface Specification for
Outage Management Services
http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
7 ISO Acceptable Use Guidelines http://www.caiso.com/Documents/ISO_Servi
cesAcceptableUseGuidelinesApr9_2013.pdf
1.4 Release Notes
This document release 1.0 will be the first release for the new ISO Outage Management System (OMS), to be released in the Fall of 2014 with the Energy Imbalance Market (EIM). All SLIC web services will be replaced by the services in this document.
1.5 API Transition Support
Due to the extensive changes in required fields and implementing technology the ISO will not support the existing services after go-live. All clients will need to transition to the new services.
1.6 MTOM & Doc style Attachments
All services support both MTOM/XOP style attachments and document literal with an attachment (doc-attach). Doc style attachments are supported by WSDLs that have suffix _DocAttach in their name, this Doc style attachment is mainly intended for .Net clients. Example:
1. submitResourceOutage_v1.wsdl supports MTOM style attachments 2. submitResourceOutage_v1_DocAttach.wsdl supports Doc style attachments.
Attachments will still be zipped and Base64 encoded. The previous style of rpc literal will not be supported.
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 11 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
1.7 Date Time Data Type Elements
The dateTime data type is used to specify a date and a time. The dateTime is specified in the following form: "YYYY-MM-DDThh:mm:ss" where: YYYY indicates the year MM indicates the month DD indicates the day T indicates the start of the required time section hh indicates the hour mm indicates the minute ss indicates the second Note: All components are required. To specify a time zone, you must enter a dateTime in Universal Time Coordinate (UTC) time by adding a "Z" behind the time, for example: <startdate>2002-05-30T07:00:00Z</startdate>
2. SOAP Header Elements & MTOM Attachments
This section specifies how the identity of the message producer and the message signature is specified in the SOAP message header section.
2.1 Identity of Message Producer
Identify of the message producer is specified in CAISO custom element <CAISOUsernameToken > encapsulated in <CAISOWSHeader>. The following fragment illustrates the use of this element
2.1.1 Identity
<ns1:CAISOWSHeader
xmlns:ns1="http://www.caiso.com/soa/2006-09-30/CAISOWSHeader.xsd">
<ns1:CAISOUsernameToken>
<ns1:Username>LNP Tester40</ns1:Username>
<Nonce>3433lfff23</Nonce>
<Created>2014-04-22T16:30:45.0 PDT</Created>
</ns1:CAISOUsernameToken>
</ns1:CAISOWSHeader>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 12 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Identity of the message producer is specified by the <Username> element, which allows any string that does not contain line feeds, carriage returns, tabs, leading or trailing spaces, or multiple spaces.
2.1.2 Timestamp
The Security Timestamp is encapsulated via the <created> element in the <CAISOUsernameToken> and indicates when the token was created .
2.1.3 Message Freshness
This specification uses a Nonce as a measure to thwart replay attacks. The Nonce is a unique, randomly generated number. The nonce is encapsulated via the <wsse:nonce> element in the <cwsh:CAISOUsernameToken>
2.2 MTOM Attachments
All large messages are sent in MTOM style attachments or as document literal with an attachment (doc-attach). The previous style of rpc literal will not be supported. Attachments will still be zipped and Base64 encoded=. The attachment hash value is is encapsulated in <attchmentHash> element that goes in to SOAP header section as illustrated below: The content-id(cid) of the MTOM attachment is referred in attachmentData1 element encapsulated by AttachmentInfor. This section goes in SOAP Body as shown below: Here is a complete example of SOAP message.
<ns1:attachmentHash xmlns:ns1="http://www.caiso.com/mrtu/soa/schemas/2005/09/attachmenthash">
<hashValue>ErPtrFX6a288DMBy+jG61jpbfAY=</hashValue>
</ns1:attachmentHash>
<att:AttachmentInfor>
<att:attachmentData1>cid:255629815578</att:attachmentData1>
</att:AttachmentInfor>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 13 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:stan="http://www.caiso.com/soa/2006-06-13/StandardAttachmentInfor.xsd" xmlns:att="http://www.caiso.com/soa/AttachmentInfor_v1.xsd"> <soapenv:Header> <ns1:CAISOWSHeader xmlns:ns1="http://www.caiso.com/soa/2006-09-30/CAISOWSHeader.xsd"> <ns1:CAISOUsernameToken> <ns1:Username>LNP Tester40</ns1:Username> <Nonce>3433lfff23</Nonce> <Created>2014-04-22T16:30:45.0 PDT</Created> </ns1:CAISOUsernameToken> </ns1:CAISOWSHeader> <ns1:attachmentHash xmlns:ns1="http://www.caiso.com/mrtu/soa/schemas/2005/09/attachmenthash"> <hashValue>ErPtrFX6a288DMBy+jG61jpbfAY=</hashValue> </ns1:attachmentHash> <!-- this is optional --> <stan:standardAttachmentInfor> <stan:Attachment> <stan:id>?</stan:id> <stan:name>?</stan:name> <stan:description>?</stan:description> <stan:version>?</stan:version> <stan:sequenceNumber>?</stan:sequenceNumber> <stan:type>?</stan:type> <stan:size>?</stan:size> <stan:source>?</stan:source> <stan:tool>?</stan:tool> <stan:creationTime>?</stan:creationTime> <stan:compressFlag>?</stan:compressFlag> <stan:compressMethod>?</stan:compressMethod> <stan:AttributeList> <stan:Value>?</stan:Value> </stan:AttributeList> </stan:Attachment> </stan:standardAttachmentInfor> </soapenv:Header> <soapenv:Body> <att:AttachmentInfor>
<att:attachmentData1><inc:Include href="cid:255629815578" xmlns:inc="http://www.w3.org/2004/08/xop/include"/>
</att:attachmentData1> </att:AttachmentInfor> </soapenv:Body> </soapenv:Envelope>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 14 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
In above example content-id cid:255629815578 refers to actual attachment data in binary format that follows above SOAP message.
3. Standard XSDs
3.1 Standard Attachment Information
The attachment information schema, StandardAttachmentInfor.xsd, is used to provide general information for a SOAP attachment. The root element in the schema is standardAttachmentInfor, which can contain one or more attachment elements.
1.1.1 Element table
Content-Type: application/octet-stream Content-Transfer-Encoding: binary Content-ID: <255629815578> Content-Disposition: attachment; name="2e132f20-6499-4714-808b-55b9f7a08fbf.uue" H4sIAAAAAAAAAL1W30/jOBB+7v4VVe+5dcICCyhkhQq3VwnaqgmLeFqZZNr6SOyc7bTw3+84P9o
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 15 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type Req’d
id Globally unique identifier. string No
name Attachment filename. string No
description Description of attachment. string No
version Version ID of attachment file string No
sequenceNumber Sequence number if there are multiple attachments.
string No
type Attachments file type, zip string No
size Size of attachment file. string No
source Source of attachment file. string No
tool Tool used to generate attachment. string No
creationTime Time attachment file was created. dateTime No
compressFlag Indicates whether or not attachment has been compressed (YES or NO).
string No
compressMethod Compress method used (if attachment file compressed).
string No
AttributeList.Sequence Attribute list sequence number. string No
AttributeList.Name Name of an attribute string No
AttributeList.Value Value of an attribute string No
3.1.1 Schema (StandardAttachmentInfor.xsd)
Each service bundle will contain the same StandardAttachmentInfor.xsd
1.1.2 Example XML File (StandardAttachmentInfor.xml)
<?xml version="1.0" encoding="UTF-8" ?>
<!--
Sample XML file generated by XMLSpy v2006 U (http://www.altova.com)
-->
<standardAttachmentInfor xmlns="http://www.caiso.com/soa/2006-06-
13/StandardAttachmentInfor.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xsi:schemaLocation="http://www.caiso.com/soa/2006-06-
13/StandardAttachmentInfor.xsd">
<Attachment>
<id>123456789</id>
<name>Out1</name>
<description>OUTAGE_ATTACHEMENT</description>
<version>1.1</version>
<sequenceNumber>12</sequenceNumber>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 16 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<type>ZIP</type>
<size>180</size>
<source>GWED</source>
<tool>GZIP</tool>
<creationTime>2006-06-17T09:30:47.0Z</creationTime>
<compressFlag>yes</compressFlag>
<compressMethod>ZIP</compressMethod>
<AttributeList>
<Sequence>2</Sequence>
<Name>GWED</Name>
<Value>1</Value>
</AttributeList>
</Attachment>
</standardAttachmentInfor>
3.2 Fault Return
Any error in consuming the service will result in the fault return of the standardOutput. This section is applicable to all services.
3.2.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
OutputDataType.EventLog
id Event log identifier. string No
name Event log name. string No
description Event log description. string No
type Event log type. string No
creationTime Event log creation time. date No
collectionType Event log collection type. string No
collectionQuantity Event log collection quantity. string No
Event.result Event result. string No
Event.id Event identifier. string No
Event.name Event name. string No
Event.description Event description. string No
Event.creationTime Event creation time. dateTime No
Event.severity Event severity. string No
Event.priority Event priority. string No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 17 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
Event.sequence Number Event sequence number. string No
Event.eventType Event type. string No
Service.id Service identifier. string No
Service.name Service name. string No
Service.description Service description. string No
Service.comments Service comments. string No
3.2.2 Schema (StandardOutput.xsd)
Each service bundle will have the same StandardOutput.xsd file.
3.2.3 Example XML File (StandardOutput.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 rel. 2 sp2 (http://www.altova.com)--> <m:outputDataType xsi:schemaLocation="http://www.caiso.com/soa/2006-06-13/StandardOutput.xsd StandardOutput.xsd" xmlns:m="http://www.caiso.com/soa/2006-06-13/StandardOutput.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <m:EventLog> <m:id>Event-123</m:id> <m:name>Event Name</m:name> <m:description>The Event Description</m:description> <m:type>Error Event</m:type> <m:creationTime>2014-01-03T11:00:00Z</m:creationTime> <m:collectionType>Submit Generator Outage</m:collectionType> <m:collectionQuantity>1</m:collectionQuantity> <m:Event> <m:result>Invalid Value Found in Field XX</m:result> <m:id>1234</m:id> <m:name>Error Event 1234</m:name> <m:description>An invalid data value was presented</m:description> <m:creationTime>2014-01-03T11:00:00Z</m:creationTime> <m:severity>High</m:severity> <m:priority>High</m:priority> <m:sequenceNumber>1</m:sequenceNumber> <m:eventType>Initiated by OMS API</m:eventType> </m:Event> <m:Service> <m:id>1234567</m:id> <m:name>Submit Intertie Update</m:name> <m:description>Having problems - Invalid data has been presented</m:description> <m:comments>Some one needs to fix the data and resubmit</m:comments> </m:Service> </m:EventLog>
</m:outputDataType>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 18 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
4. Submit Resource Outage {Change Requests} Business Scenario
4.1 Overview
Outage coordinators can submit outages or changes to previously submitted outages (Outage Change Requests) for affiliated generators.
4.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable Outage Coordinators can call the ISO directly with critical near-term outages.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable (.1 sec – 30 sec)
4.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
4.3.1 Submit New Outage
sd Submit Outage
Outage Coordinator
OMS
SubmitGenerationOutage()
SubmitGenerationOutageResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 19 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
4.3.2 Submit Change to Existing Outage
4.4 Operational Details
4.4.1 Submit Resource Outage
The service has one operation with three message types.
Operation Message
Types
Message WSDL XSD
submitResourceOu
tage
Input submitResourceOu
tage
submitResourceOutage_v1.ws
dl/
submitResourceOutage_v1_D
ocAttach.wsdl/
submitResourceOutage_v1.xsd
Output submitResourceOu
tageResponse
OutageStandardOutput_v1.xsd
Fault faultReturnType StandardOutput.xsd
4.4.2 Submit Resource Outage Change Request
Operation Message
Types
Message WSDL XSD
submitResourceO
utageChangeRequ
est
Input submitResourceO
utageChangeRequ
est
submitResourceOutageChang
eRequest_v1.wsdl/
submitResourceOutageChang
eRequest_v1_DocAttach.wsd
l
submitResourceOutageChange
Request_v1.xsd
Output submitResourceO
utageChangeRequ
estResponse
OutageStandardOutput_v1.xsd
Fault faultReturnType StandardOutput.xsd
4.5 WSDL
4.5.1 submitResourceOutage_v1.wsdl / submitResourceOutage_v1_DocAttach.wsdl
4.5.2 submitResourceOutageChangeRequest_v1.wsdl / submitResourceOutageChangeRequest_v1_DocAttach.wsdl
sd Submit Outage Change Request
Outage Coordinator
OMS
submitOutageChangeRequest()
submitGenerationOutageChangeRequestResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 20 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
4.6 Submit Resource Outage {Change Request}
4.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.RegsiteredResourceOutage Yes
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String No
Description Participant’s description of the Outage/Change Request
String Yes
Comment Participant’s comment for the Outage/Change Request
String No
affectsRASSPS Participant indicates if this outage affects a RAS or SPS. Yes/No
String No
discoveryDateTime DateTime when the outage was discovered. dateTime No
emergencyReturnTime Time to restore the outage if needed by the ISO. Integer No
emergencyReturnTimeType
Type of emergency return time. DAYS, HOURS, MINUTES
String Yes
mktOrgOutageID Reference ID assigned to the outage by the participant.
String Yes
outageCoordinationLongTermPlanning
This indicates the outage is part of your quarterly outage plan and allows the outage request to remain scheduled until it is evaluated approximately one month before its start date. See CAISO Operating Procedure T-113 for more information on quarterly outage plans. Yes/No
String No
RIMSProjectCommisionDate
Commission date of the the related RIMS project dateTime No
RIMSProjectCompletion Completion date of the related RIMS project dateTime No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 21 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
RIMSProjectID RIMS id of the related RIMS project String No
RIMSProjectPhase RIMS phase that this outage will complete String No
Actual Period Actual start and end times of the outage, in UTC dateTime No
Estimated Period Planned start and end time of the outage, in UTC. dateTime Yes
OutageCause.code Participant list of cause code for their reference String No
isOffPeakOpportunityOutage
Participant indicates if the submission if for an off peak opportunity outage. Yes/No
String Yes
isShortNoticeOpportunityOutage
Participant indicates if the submission if for a short notice opportunity outage. Yes/No
String Yes
Work Kind of work codes. String Yes
MessagePayload.RegsiteredResourceOutage.MktOrganisation Yes
mRID Participant short name String Yes
MessagePayload.RegsiteredResourceOutage.MktOrganisation.MarketPerson No
firstName First name of the contact at the participant. String Yes
lastName Last name of the contact at the participant. String Yes
landlinePhone Phone number of the contact at the participant. Complex Yes
MessagePayload.RegsiteredResourceOutage.OutageChangeRequest No
action Type of change request. If present indicates that his is a change request to an existing outage. UPDATE or CANCEL
String Yes
actionReason Reason for change String No
actionSubType Type of action subtype String No
MessagePayload.RegsiteredResourceOutage.RegisteredGenerator(Choice1)
mRID The resource id for the RegisteredGenerator. mrid minLen=1
maxLen=32
No
name An alternate name from the Participant name minLen=1
maxLen=40
No
RegisteredGenerator.LogicalConfiguration No
RegisteredGenerator.LogicalConfiguration.Configuration Yes
mRID The resource id for an MSG RegisteredGenerator’s Configuration.
mrid minLen=1
maxLen=32
No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 22 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
name An alternate name from the Participant. name minLen=1
maxLen=40
No
RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource Yes
RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource.Availability
No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time Yes/No No
returnToNetDependableCapacity
Indicates no derate at this time Float No
Pmaxvalue Indicates Pmax value of Unit Float No
RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource.PMinimum
Yes
activePeriod.start Start date and time during which this restriction is applied
dateTime Yes
restrictedValue The new pmin value for this interval. Float Yes
RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource.RampRateSegment
Yes
restrictedValue The new Ramp Rate for this segment Float Yes
segmentNumber The number of this segment Integer Yes
segmentValue The MW value that identifies the right hand side of the segment.
Float Yes
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource Yes
timeToStartUp The time the resource needs to start after the outage has completed.
Float No
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.ASAvailability No
availableValue The new MW value for this interval. Float Yes
MarketProduct.marketProductType
Type of AS that is restricted. Enumeration
Yes
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
PmaxValue.vlaue Indicates Pmax value Float Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 23 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.Availability.OutagedRegister
edResource.RegisteredResource.RegisteredResourceOutage No
RegisteredResource.RegisteredResourceOutage Yes
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String Yes
RegisteredGenerator.OutagedRegisteredResource.LoadMaximum(Choice1)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this point. Float Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
RegisteredGenerator.OutagedRegisteredResource.LoadMinimum(Choice2)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this interval. Float Yes
RegisteredGenerator.OutagedRegisteredResource.MaximumEnergyLimit (Choice3)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new maximum energy limit (WH) for this interval.
Float Yes
RegisteredGenerator.OutagedRegisteredResource.MinimumEnergyLimit (Choice4)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new minimum energy limit (WH) for this interval.
Float Yes
RegisteredGenerator.OutagedRegisteredResource.PMinimum(Choice5)
activePeriod.start The time of this pmin rerate point in UTC dateTime Yes
restrictedValue The new minimum output of this resource/configuration for this interval
Float Yes
RegisteredGenerator.OutagedRegisteredResource.UseLimit(Choice6)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new use Limit for the resource in this interval. Float Yes
RegisteredGenerator.OutagedRegisteredResource.RampRateSegment (Choice7)
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 24 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
restrictedValue The new ramp rate (MW/min) for this segment in this interval.
Float Yes
segmentNumber The identifier for this segment Integer Yes
segmentValue The right hand side (MW) of this segment. Float Yes
MessagePayload.RegisteredResourceOutage.RegisteredIntertie(Choice2)
mRID The resource id for the RegisteredIntertie. mrid minLen=1
maxLen=32
Yes
name An alternate name from the Participant name minLen=1
maxLen=40
Yes
RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource Yes
timeToStartUp The time the resource needs to start after the outage has completed.
Float No
RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.ASAvailability No
availableValue The new MW value for this interval. Float Yes
MarketProduct.marketProductType
Type of AS that is restricted. Enumeration
Yes
RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
PmaxValue.vlaue Indicates Pmax value Float Yes
RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.Availability.OutagedRegistered
Resource.RegisteredResource.RegisteredResourceOutage No
RegisteredResource.RegisteredResourceOutage Yes
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String Yes
RegisteredIntertie.OutagedRegisteredResource.LoadMaximum(Choice1)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this point. Float Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 25 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
RegisteredIntertie.OutagedRegisteredResource.LoadMinimum(Choice2)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this interval. Float Yes
RegisteredIntertie.OutagedRegisteredResource.MaximumEnergyLimit (Choice3)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new maximum energy limit (WH) for this interval.
Float Yes
RegisteredIntertie.OutagedRegisteredResource.MinimumEnergyLimit (Choice4)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new minimum energy limit (WH) for this interval.
Float Yes
RegisteredIntertie.OutagedRegisteredResource.PMinimum(Choice5)
activePeriod.start The time of this pmin rerate point in UTC dateTime Yes
restrictedValue The new minimum output of this resource/configuration for this interval
Float Yes
RegisteredIntertie.OutagedRegisteredResource.UseLimit(Choice6)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new use Limit for the resource in this interval. Float Yes
RegisteredIntertie.OutagedRegisteredResource.RampRateSegment (Choice7)
restrictedValue The new ramp rate (MW/min) for this segment in this interval.
Float Yes
segmentNumber The identifier for this segment Integer Yes
segmentValue The right hand side (MW) of this segment. Float Yes
For detailed list of elements under OutageRegisterdResource click on link here.
MessagePayload.RegisteredResourceOutage.RegisteredLoad(Choice3)
mRID The resource id for the RegisteredLoad. mrid minLen=1
maxLen=32
Yes
Name An alternate name from the Participant name minLen=1
maxLen=40
Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 26 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource Yes
timeToStartUp The time the resource needs to start after the outage has completed.
Float No
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.ASAvailability No
availableValue The new MW value for this interval. Float Yes
MarketProduct.marketProductType
Type of AS that is restricted. Enumeration
Yes
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
PmaxValue.vlaue Indicates Pmax value Float Yes
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.Availability.OutagedRegisteredRe
source.RegisteredResource.RegisteredResourceOutage No
RegisteredResource.RegisteredResourceOutage Yes
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String Yes
RegisteredLoad.OutagedRegisteredResource.LoadMaximum(Choice1)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this point. Float Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
RegisteredLoad.OutagedRegisteredResource.LoadMinimum(Choice2)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this interval. Float Yes
RegisteredLoad.OutagedRegisteredResource.MaximumEnergyLimit (Choice3)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new maximum energy limit (WH) for this interval.
Float Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 27 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
RegisteredLoad.OutagedRegisteredResource.MinimumEnergyLimit (Choice4)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new minimum energy limit (WH) for this interval.
Float Yes
RegisteredLoad.OutagedRegisteredResource.PMinimum(Choice5)
activePeriod.start The time of this pmin rerate point in UTC dateTime Yes
restrictedValue The new minimum output of this resource/configuration for this interval
Float Yes
RegisteredLoad.OutagedRegisteredResource.UseLimit(Choice6)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new use Limit for the resource in this interval. Float Yes
RegisteredLoad.OutagedRegisteredResource.RampRateSegment (Choice7)
restrictedValue The new ramp rate (MW/min) for this segment in this interval.
Float Yes
segmentNumber The identifier for this segment Integer Yes
segmentValue The right hand side (MW) of this segment. Float Yes
4.6.2 Schema (ResourceOutageData_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
4.6.3 Example XML File (SubmitResourceOutageData_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <m:ResourceOutageData xmlns:m="http://www.caiso.com/soa/ResourceOutageData_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/ResourceOutageData_v1.xsd# ResourceOutageData_v1.xsd "> <m:MessageHeader> <m:TimeDate>2001-12-31T12:00:00</m:TimeDate> <m:Source>CompanyA</m:Source> <m:Version>v20141001</m:Version> </m:MessageHeader> <m:MessagePayload> <m:RegisteredResourceOutage> <m:description>New Generator (MSG) Outage</m:description> <m:comment>Example</m:comment> <m:affectsRASSPS>YES</m:affectsRASSPS>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 28 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:discoveryDateTime>2014-01-17T17:00:00Z</m:discoveryDateTime> <m:emergencyReturnTime>1</m:emergencyReturnTime> <m:emergencyReturnTimeType>HOURS</m:emergencyReturnTimeType> <m:mktOrgOutageID>9690</m:mktOrgOutageID> <m:outageCoordinationLongTermPlanning>NO</m:outageCoordinationLongTermPlanning> <m:estimatedPeriod> <m:end>2014-01-17T17:00:00Z</m:end> <m:start>2014-01-17T13:00:00Z</m:start> </m:estimatedPeriod> <m:MktOrganisation> <m:mRID>SCID1</m:mRID> <m:MarketPerson> <m:firstName>John</m:firstName> <m:lastName>Smith</m:lastName> <m:landlinePhone> <m:areaCode>916</m:areaCode> <m:extension>555</m:extension> <m:localNumber>1234</m:localNumber> </m:landlinePhone> </m:MarketPerson> </m:MktOrganisation> <m:OutageCause> <m:code>9690</m:code> </m:OutageCause> <m:Work> <m:kind>PLANT_MAINTENANCE</m:kind> </m:Work> <m:isOffPeakOpportunityOutage>NO</m:isOffPeakOpportunityOutage> <m:isShortNoticeOpportunityOutage>NO</m:isShortNoticeOpportunityOutage> <m:RegisteredGenerator> <m:mRID>ResourceA</m:mRID> <m:name>Resource Alpha</m:name> <m:LogicalConfiguration> <m:Configuration> <m:mRID>ResA1x1</m:mRID> <m:name>Resource Alpha 1x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>80</m:value> </m:PmaxValue> </m:Availability> <m:Availability> <m:dateTimePoint>2014-01-17T17:00:00Z</m:dateTimePoint>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 29 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>100</m:value> </m:PmaxValue> </m:Availability> </m:OutagedRegisteredResource> </m:Configuration> <m:Configuration> <m:mRID>ResA2x1</m:mRID> <m:name>Resource Alpha 2x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>160</m:value> </m:PmaxValue> </m:Availability> <m:Availability> <m:dateTimePoint>2014-01-17T17:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>200</m:value> </m:PmaxValue> </m:Availability> <m:PMinimum> <m:activePeriod> <m:start>2014-01-17T13:00:00Z</m:start> </m:activePeriod> <m:restrictedValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>81</m:value> </m:restrictedValue> </m:PMinimum> <m:PMinimum> <m:activePeriod> <m:start>2014-01-17T17:00:00Z</m:start> </m:activePeriod> <m:restrictedValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>200</m:value> </m:restrictedValue> </m:PMinimum>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 30 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
</m:OutagedRegisteredResource> </m:Configuration> </m:LogicalConfiguration> <m:OutagedRegisteredResource> <m:ASAvailability> <m:availableValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>0</m:value> </m:availableValue> <m:MarketProduct> <m:marketProductType>SR</m:marketProductType> </m:MarketProduct> </m:ASAvailability> </m:OutagedRegisteredResource> </m:RegisteredGenerator> </m:RegisteredResourceOutage> </m:MessagePayload> </m:ResourceOutageData>
4.6.4 Example XML File (SubmitResourceOutageChangeRequest_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <m:ResourceOutageData xmlns:m="http://www.caiso.com/soa/ResourceOutageData_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/ResourceOutageData_v1.xsd# ResourceOutageData_v1.xsd "> <m:MessageHeader> <m:TimeDate>2014-01-04T09:00:00Z</m:TimeDate> <m:Source>CompanyA</m:Source> <m:Version>v20141001</m:Version> </m:MessageHeader> <m:MessagePayload> <m:RegisteredResourceOutage> <m:mRID>123456789</m:mRID> <m:description>New generator (MSG) Outage</m:description> <m:comment>Example</m:comment> <m:affectsRASSPS>YES</m:affectsRASSPS> <m:discoveryDateTime>2014-01-04T09:00:00Z</m:discoveryDateTime> <m:emergencyReturnTime>1</m:emergencyReturnTime> <m:emergencyReturnTimeType>HOURS</m:emergencyReturnTimeType> <m:mktOrgOutageID>9690</m:mktOrgOutageID> <m:outageCoordinationLongTermPlanning>NO</m:outageCoordinationLongTermPlanning> <m:estimatedPeriod> <m:end>2014-01-17T18:00:00Z</m:end> <m:start>2014-01-17T13:00:00Z</m:start>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 31 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
</m:estimatedPeriod> <m:MktOrganisation> <m:mRID>SCID1</m:mRID> <m:MarketPerson> <m:firstName>John</m:firstName> <m:lastName>Smith</m:lastName> <m:landlinePhone> <m:areaCode>916</m:areaCode> <m:extension>555</m:extension> <m:localNumber>1234</m:localNumber> </m:landlinePhone> </m:MarketPerson> </m:MktOrganisation> <m:OutageCause> <m:code>9690</m:code> </m:OutageCause> <m:OutageChangeRequest> <m:action>UPDATE</m:action> <m:actionReason>WORK_RESCHEDULED_TO_LATER_DATE_SC</m:actionReason> </m:OutageChangeRequest> <m:Work> <m:kind>PLANT_MAINTENANCE</m:kind> </m:Work> <m:isOffPeakOpportunityOutage>NO</m:isOffPeakOpportunityOutage> <m:isShortNoticeOpportunityOutage>NO</m:isShortNoticeOpportunityOutage> <m:RegisteredGenerator> <m:mRID>ResourceA</m:mRID> <m:name>Resource Alpha</m:name> <m:LogicalConfiguration> <m:Configuration> <m:mRID>ResA1x1</m:mRID> <m:name>Resource Alpha 1x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:OutagedRegisteredResource> <m:RegisteredResource> <m:RegisteredResourceOutage> <m:mRID>Outage1234</m:mRID> </m:RegisteredResourceOutage> </m:RegisteredResource> </m:OutagedRegisteredResource> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>100</m:value> </m:PmaxValue>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 32 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
</m:Availability> </m:OutagedRegisteredResource> </m:Configuration> </m:LogicalConfiguration> <m:OutagedRegisteredResource> <m:timeToStartUp>COLD</m:timeToStartUp> <m:ASAvailability> <m:availableValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>0</m:value> </m:availableValue> <m:MarketProduct> <m:marketProductType>SR</m:marketProductType> </m:MarketProduct> </m:ASAvailability> </m:OutagedRegisteredResource> </m:RegisteredGenerator> </m:RegisteredResourceOutage> </m:MessagePayload> </m:ResourceOutageData>
4.7 Submit Resource Outage {Change Request} Response
4.7.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.EventLog Yes
MessagePayload.EventLog.Event Yes
result Event result. string Yes
id Event identifier. string Yes
description Event description. string No
creationDateTime Event creation time. dateTime No
MessagePayload.EventLog.Service Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 33 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
id Service identifier. string Yes
name Name of a service. string Yes
MessagePayload.EventLog.Outage No
mrid ID assigned to the outage by the ISO String No
mktOrgOutageID Reference ID assigned to the outage by the external User
String Yes
MessagePayload.EventLog.Outage.OutageChangeRequest No
mrid ID assigned to the outage change request by the ISO
String Yes
MessagePayload.EventLog.Outage.OutageGroup No
mRID ID assigned to the outage Group by the ISO String Yes
MessagePayload.EventLog.Outage.OutageValidation Yes
submitStatus Indicates whether the outage was accepted or rejected: ACCEPTED, REJECTED
String Yes
MessagePayload.EventLog.Outage.OutageValidation.OutageResult Yes
mrID ID assigned to the result by the ISO String Yes
type Type of result: ERROR, INFO, WARNING String Yes
description Description of result returned String Yes
status Status of the result: ACKNOWLEDGED. UNACKNOWLEDGED. This is applicable only to warnings.
String No
4.7.2 Schema (OutageStandardOutput_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
4.7.3 Example XML File (ResourceOutageStandardOutput.xml)
4.7.3.1 Example XML File for Submit Resource Outage Response
<?xml version="1.0" encoding="UTF-8"?> <OutageStandardOutput xmlns="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd# OutageStandardOutput_v1.xsd "> <MessageHeader>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 34 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<TimeDate>2014-01-03T11:00:00Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EventLog> <Event> <id>1</id> <result>Success</result> </Event> <Outage> <mRID>123456789</mRID> <mktOrgOutageID>MarketOutageId-1234</mktOrgOutageID> <OutageValidation> <submitStatus>ACCEPTED</submitStatus> <OutageResult> <mRID>1</mRID> <description>Validated</description> <status>ACKNOWLEDGED</status> <type>INFO</type> </OutageResult> </OutageValidation> </Outage> <Service> <id>12345</id> <name>submitResourceOutage_v1</name> </Service> </EventLog> </MessagePayload> </OutageStandardOutput>
4.7.3.2 Example XML File for Submit Resource Outage Change Request Response
<?xml version="1.0" encoding="UTF-8"?> <m:ResourceOutageData xmlns:m="http://www.caiso.com/soa/ResourceOutageData_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/ResourceOutageData_v1.xsd# ResourceOutageData_v1.xsd "> <m:MessageHeader> <m:TimeDate>2014-01-04T09:00:00Z</m:TimeDate> <m:Source>CompanyA</m:Source> <m:Version>v20141001</m:Version> </m:MessageHeader> <m:MessagePayload> <m:RegisteredResourceOutage> <m:mRID>123456789</m:mRID> <m:description>New generator (MSG) Outage</m:description>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 35 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:comment>Example</m:comment> <m:affectsRASSPS>YES</m:affectsRASSPS> <m:discoveryDateTime>2014-01-04T09:00:00Z</m:discoveryDateTime> <m:emergencyReturnTime>1</m:emergencyReturnTime> <m:emergencyReturnTimeType>HOURS</m:emergencyReturnTimeType> <m:mktOrgOutageID>9690</m:mktOrgOutageID> <m:outageCoordinationLongTermPlanning>NO</m:outageCoordinationLongTermPlanning> <m:estimatedPeriod> <m:end>2014-01-17T18:00:00Z</m:end> <m:start>2014-01-17T13:00:00Z</m:start> </m:estimatedPeriod> <m:MktOrganisation> <m:mRID>SCID1</m:mRID> <m:MarketPerson> <m:firstName>John</m:firstName> <m:lastName>Smith</m:lastName> <m:landlinePhone> <m:areaCode>916</m:areaCode> <m:extension>555</m:extension> <m:localNumber>1234</m:localNumber> </m:landlinePhone> </m:MarketPerson> </m:MktOrganisation> <m:OutageCause> <m:code>9690</m:code> </m:OutageCause> <m:OutageChangeRequest> <m:action>UPDATE</m:action> <m:actionReason>WORK_RESCHEDULED_TO_LATER_DATE_SC</m:actionReason> </m:OutageChangeRequest> <m:Work> <m:kind>PLANT_MAINTENANCE</m:kind> </m:Work> <m:isOffPeakOpportunityOutage>NO</m:isOffPeakOpportunityOutage> <m:isShortNoticeOpportunityOutage>NO</m:isShortNoticeOpportunityOutage> <m:transmissionInduced>YES</m:transmissionInduced> <m:RegisteredGenerator> <m:mRID>ResourceA</m:mRID> <m:name>Resource Alpha</m:name> <m:LogicalConfiguration> <m:Configuration> <m:mRID>ResA1x1</m:mRID> <m:name>Resource Alpha 1x1</m:name> <m:OutagedRegisteredResource>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 36 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:OutagedRegisteredResource> <m:RegisteredResource> <m:RegisteredResourceOutage> <m:mRID>Outage1234</m:mRID> </m:RegisteredResourceOutage> </m:RegisteredResource> </m:OutagedRegisteredResource> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>100</m:value> </m:PmaxValue> </m:Availability> </m:OutagedRegisteredResource> </m:Configuration> </m:LogicalConfiguration> <m:OutagedRegisteredResource> <m:timeToStartUp>COLD</m:timeToStartUp> <m:ASAvailability> <m:availableValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>0</m:value> </m:availableValue> <m:MarketProduct> <m:marketProductType>SR</m:marketProductType> </m:MarketProduct> </m:ASAvailability> </m:OutagedRegisteredResource> </m:RegisteredGenerator> </m:RegisteredResourceOutage> </m:MessagePayload> </m:ResourceOutageData>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 37 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
5. Retrieve Outage/Change Requests Business Scenario
5.1 Overview
Outage Coordinators can retrieve resource outages or outage change requests for affiliated generators.
5.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable Outage Coordinators can call the ISO for status on near-term outages and Change Requests.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
5.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
5.3.1 Retrieve Generation Outages
sd retriev eGenerationOutage
Outage Coordinator
OMS
retrieveGenerationOutage()
retrieveGenerationOutageResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 38 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
5.3.2 Retrieve Resource Outage Change Requests
5.4 Operational Details
Each service has one operation with three message types.
5.4.1 Retrieve Resource Outage
Operation Message
Types
Message WSDL XSD
retrieveResource
Outage
Input retrieveResource
Outage
retrieveResourceOutage_v1.
wsdl/
retrieveResourceOutage_v1_
DocAttach.wsdl
requestResourceOutage_v1.x
sd
Output retrieveResource
OutageResponse
ResourceOutageResults_v1.x
sd
Fault faultReturnType StandardOutput.xsd
5.4.2 Retrieve Resource Outage Change Request
Operation Message
Types
Message WSDL XSD
retrieveResource
OutageChangeRe
quests
Input retrieveResourceO
utageChangeReque
sts
retrieveResourceOutageChan
geRequest_v1.wsdl/
retrieveResourceOutageChan
geRequest_v1_DocAttach.ws
dl
requestResourceOutage_v1.x
sd
Output retrieveResourceO
utageChangeReque
stResponse
ResourceOutageResults_v1.x
sd
Fault faultReturnType StandardOutput.xsd
5.5 WSDL
5.5.1 retrieveResourceOutage_v1.wsdl / retrieveResourceOutage_v1_DocAttach.wsdl
sd retriev eGenerationOutageChangeRequests
Outage Coordinator
OMS
retrieveGenerationOutageChangeRequests()
retrieveGenerationOutageResponseChangeRequests()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 39 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
5.5.2 retrieveResourceOutageChangeRequest_v1.wsdl / retrieveResourceOutageChangeRequest_v1_DocAttach.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
5.6 Retrieve Resource Outage {Change Request}
Request Criteria Input Parameters Results Outage WebOMS outage id or
Participant’s outage id The outage specified
Outage Range Range start and end date and Outage Status (optional)
All outages for all resources that the requester has access to for the date range specified optionally filtered by outage status if specified
Participant MktOrganization mrid and Range start and end date and Outage Status(optional)
All outages for all resources associated with the specified MktOrganization mrid that the requester has access to for the date range specified optionally filtered by outage status if specified
Resource RegisteredGenerator mrid and Range start and end date and Outage Status(optional)
All outages for the resource(s) specified and for the date range specified optionally filtered by outage status if specified
Outage Change Request Outage Change Request mrid The outage change request specified
5.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.Outage No
mRID The Primary identifier the ISO has given to an outage String No
mktOrgOutageId Reference ID assigned to the Outage by the external user
String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 40 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
MessagePayload.OutageChangeRequest No
mRID The Primary identifier the ISO has given to an outage change request
String Yes
MessagePayload.Participant No
rangePeriod Start and end date of the period being requested dateTime No
MessagePayload.Participant.MktOrganization Yes
mrID Participant Short Name of the requestor or affiliate String Yes
MessagePayload.Participant.Outage No
outageStatus Request all outages or change requests in this status String No
MessagePayload.Resource No
rangePeriod Start and end date of the period being requested dateTime No
MessagePayload.Resource.RegisteredGenerator(Choice1)
mrID The resource id for the RegisteredGenerator. String Yes
MessagePayload.Resource.RegisteredIntertie(Choice2)
mrID The resource id for the RegisteredGenerator. String Yes
MessagePayload.Resource.RegisteredLoad(Choice3)
mrID The resource id for the RegisteredGenerator. String Yes
MessagePayload.Resource.Outage No
Status Request all outages or change requests in this status String No
MessagePayload.OutageRange No
rangePeriod Start and end date of the period being requested dateTime No
MessagePayload.OutageRange.Outage No
outageStatus Request all outages or change requests in this status String No
5.6.2 Schema (RequestResourceOutage_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
5.6.3 Example XML File (RequestResourceOutage_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <RequestResourceOutage xmlns="http://www.caiso.com/soa/RequestResourceOutage_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/RequestResourceOutage_v1.xsd# RequestResourceOutage_v1.xsd ">
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 41 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<MessageHeader> <TimeDate>2014-01-03T11:00:00Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <Resource> <Outage> <outageStatus>APPROVED</outageStatus> </Outage> <rangePeriod> <end>2001-12-31T12:00:00</end> <start>2001-12-31T12:00:00</start> </rangePeriod> <RegisteredGenerator> <mRID>ResourceA</mRID> </RegisteredGenerator> </Resource> </MessagePayload> </RequestResourceOutage>
5.6.4 Example XML file (RequestResourceOutageChangeRequest.xml)
<?xml version="1.0" encoding="UTF-8"?> <RequestResourceOutage xmlns="http://www.caiso.com/soa/RequestResourceOutage_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/RequestResourceOutage_v1.xsd# RequestResourceOutage_v1.xsd "> <MessageHeader> <TimeDate>2014-01-03T11:00:00Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <Outage> <mRID>123456789</mRID> </Outage> <OutageChangeRequest> <mRID>912345677</mRID> </OutageChangeRequest> </MessagePayload> </RequestResourceOutage>
5.7 Retrieve Resource Outage {Change Request} Response
5.7.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 42 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.RegisteredResourceOutage Yes
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String Yes
Description Participant’s description of the Outage/Change Request
String Yes
Comment Participant’s comment for the Outage/Change Request
String No
createDateTime Time this outage/change request was created dateTime Yes
createdBy The person that created the outage/change request
String Yes
lastModifiedDateTime Time this outage/change request was last modified
dateTime Yes
lastUpdatedBy The person that last updated the the outage/change request
Yes
affectsRASSPS Participant indicates if this outage affects a RAS or SPS. Yes/No
String No
discoveryDateTime DateTime when the outage was discovered. dateTime No
emergencyReturnTime Time to restore the outage if needed by the ISO. Integer No
emergencyReturnTimeType Type of emergency return time. DAYS, HOURS, MINUTES
String Yes
isFinalApprovalReq The ISO determines if final approval is required before the outage can start
String Yes
mktOrgOutageID Reference ID assigned to the outage by the participant.
String No
outageCoordinationLongTermPlanning
This indicates the outage is part of your quarterly outage plan and allows the outage request to remain scheduled until it is evaluated approximately one month before its start date. See CAISO Operating Procedure T-113 for more information on quarterly outage plans. Yes/No
String No
OutageStatus The current status of the outage String Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 43 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
OutageStatusReason The reason for moving the outage to this status String No
RIMSProjectCommisionDate
Commission date of the the related RIMS project
dateTime No
RIMSProjectCompletion Completion date of the related RIMS project dateTime No
RIMSProjectID RIMS id of the related RIMS project String No
RIMSProjectPhase RIMS phase that this outage will complete String No
versionID Version of this Outage String Yes
actualPeriod Actual start and end time of the outage, in UTC. dateTime No
Estimated Period Planned start and end time of the outage, in UTC.
dateTime Yes
OutageCause.code Participant list of cause code for their reference String No
isOffPeakOpportunityOutage
Participant indicates if the submission if for an off peak opportunity outage. Yes/No
String Yes
isShortNoticeOpportunityOutage
Participant indicates if the submission if for a short notice opportunity outage. Yes/No
String Yes
isSCPExempt Indicates whether or not the outage is exempt from SCP penalties. Yes./No
String Yes
Work Nature of work codes. String(Enumeration)
Yes
RADesignation Identifies this resource as an RA resource during the period of the outage.
String Yes
RAReplacementDecision.id Decision made on whether or not RA Replacement required: Yes/No
String No
MessagePayload.RegisteredResourceOutage.OutageGroup No
MRID The primary identifier of the Group String Yes
Description The description of the group String Yes
createdDateTime Time the group was created dateTime Yes
CreatedBy The person that created the group String Yes
lastModifiedDateTime Time the group was last modified dateTime Yes
LastModifiedBy The person that last updated the group String Yes
MessagePayload.RegisteredResourceOutage.MktOrganisation Yes
mRID Participant short name String Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 44 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
MessagePayload.RegisteredResourceOutage.MktOrganisation.MarketPerson No
firstName First name of the contact at the participant. String Yes
lastName Last name of the contact at the participant. String Yes
landlinePhone Phone number of the contact at the participant. Complex Yes
MessagePayload.RegisteredResourceOutage.OutageChangeRequest No
mrID ID assigned to the outage change request by the ISO
String Yes
Action Type of change request. If present indicates that his is a change request to an existing outage. UPDATE or CANCEL
String Yes
actionReason Reason for changes. String No
Status Status of the outage change request: PENDING, ACCEPTED, DENIED
String Yes
Status Reason Reason for status. Required when the outage change request is denied
String No
MessagePayload.RegisteredResourceOutage.Outage.OutageValidation.OutageResult No
mrID ID assigned to the result by the ISO String Yes
Type Type of result: ERROR, INFO, WARNING String Yes
Description Description of result returned String Yes
Status Status of the result: ACKNOWLEDGED. UNACKNOWLEDGED. This is applicable only to warnings.
String No
MessagePayload.RegisteredResourceOutage.RegisteredGenerator(Choice1)
mRID The resource id for the RegisteredGenerator. mrid minLen=1
maxLen=32
Yes
Name An alternate name from the Participant name minLen=1
maxLen=40
Yes
RegisteredResourceOutage.RegisteredGenerator.LogicalConfiguration No
RegisteredResourceOutage.RegisteredGenerator.LogicalConfiguration.Configuration Yes
mRID The resource id for an MSG RegisteredGenerator’s Configuration.
mrid minLen=1
maxLen=32
No
Name An alternate name from the Participant. name minLen=1
maxLen=40
No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 45 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource Yes
LogicalConfiguration.Configuration.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time Yes/No No
returnToNetDependableCapacity
Indicates no derate at this time Float No
Pmaxvalue Indicates Pmax value of Unit Float No
LogicalConfiguration.Configuration.OutagedRegisteredResource.PMinimum Yes
activePeriod.start Start date and time during which this restriction is applied
dateTime Yes
restrictedValue The new pmin value for this interval. Float Yes
LogicalConfiguration.Configuration.OutagedRegisteredResource.RampRateSegment Yes
restrictedValue The new Ramp Rate for this segment Float Yes
SegmentNumber The number of this segment Integer Yes
segmentValue The MW value that identifies the right hand side of the segment.
Float Yes
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource Yes
timeToStartUp The time the resource needs to start after the outage has completed.
Float No
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.ASAvailability No
availableValue The new MW value for this interval. Float Yes
MarketProduct.marketProductType
Type of AS that is restricted. Enumeration
Yes
RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
PmaxValue.vlaue Indicates Pmax value Float Yes
RegisteredGenerator.OutagedRegisteredResource.LoadMaximum(Choice1)
activePeriod.start Start date and time of this interval dateTime Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 46 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
restrictedValue The new MW value for this point. Float Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
RegisteredGenerator.OutagedRegisteredResource.LoadMinimum(Choice2)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this interval. Float Yes
RegisteredGenerator.OutagedRegisteredResource.MaximumEnergyLimit (Choice3)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new maximum energy limit (WH) for this interval.
Float Yes
RegisteredGenerator.OutagedRegisteredResource.MinimumEergyLimit (Choice4)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new minimum energy limit (WH) for this interval.
Float Yes
RegisteredGenerator.OutagedRegisteredResource.PMinimum(Choice5)
activePeriod.start The time of this pmin rerate point in UTC dateTime Yes
restrictedValue The new minimum output of this resource/configuration for this interval
Float Yes
RegisteredGenerator.OutagedRegisteredResource.PMaxCurtailment (Choice6)
activePeriod.start The time of this PMax curtailment point in UTC dateTime Yes
restrictedValue The new PMax curtailment value of this resource/configuration for this interval
Float Yes
RegisteredGenerator.OutagedRegisteredResource.UseLimit(Choice7)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new use Limit for the resource in this interval. Float Yes
RegisteredGenerator.OutagedRegisteredResource.RampRateSegment (Choice8)
restrictedValue The new ramp rate (MW/min) for this segment in this interval.
Float Yes
segmentNumber The identifier for this segment Integer Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 47 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
segmentValue The right hand side (MW) of this segment. Float Yes
MessagePayload.RegisteredResourceOutage.RegisteredIntertie(Choice2)
mRID The resource id for the RegisteredIntertie. mrid minLen=1
maxLen=32
Yes
Name An alternate name from the Participant name minLen=1
maxLen=40
Yes
RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource Yes
timeToStartUp The time the resource needs to start after the outage has completed.
Float No
RegisteredResourceOutage. RegisteredIntertie.OutagedRegisteredResource.ASAvailability No
availableValue The new MW value for this interval. Float Yes
MarketProduct.marketProductType
Type of AS that is restricted. Enumeration
Yes
RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
PmaxValue.vlaue Indicates Pmax value Float Yes
RegisteredIntertie.OutagedRegisteredResource.LoadMaximum(Choice1)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this point. Float Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
RegisteredIntertie.OutagedRegisteredResource.LoadMinimum(Choice2)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this interval. Float Yes
RegisteredIntertie.OutagedRegisteredResource.MaximumEnergyLimit (Choice3)
activePeriod.start Start date and time of this interval dateTime Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 48 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
restrictedValue The new maximum energy limit (WH) for this interval.
Float Yes
RegisteredIntertie.OutagedRegisteredResource.MinimumEergyLimit (Choice4)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new minimum energy limit (WH) for this interval.
Float Yes
RegisteredIntertie.OutagedRegisteredResource.PMinimum(Choice5)
activePeriod.start The time of this pmin rerate point in UTC dateTime Yes
restrictedValue The new minimum output of this resource/configuration for this interval
Float Yes
RegisteredIntertie.OutagedRegisteredResource.PMaxCurtailment (Choice6)
activePeriod.start The time of this PMax curtailment point in UTC dateTime Yes
restrictedValue The new PMax curtailment value of this resource/configuration for this interval
Float Yes
RegisteredIntertie.OutagedRegisteredResource.UseLimit(Choice7)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new use Limit for the resource in this interval. Float Yes
RegisteredIntertie.OutagedRegisteredResource.RampRateSegment (Choice8)
restrictedValue The new ramp rate (MW/min) for this segment in this interval.
Float Yes
segmentNumber The identifier for this segment Integer Yes
segmentValue The right hand side (MW) of this segment. Float Yes
MessagePayload.RegisteredResourceOutage.RegisteredLoad(Choice3)
mRID The resource id for the RegisteredLoad. mrid minLen=1
maxLen=32
Yes
Name An alternate name from the Participant name minLen=1
maxLen=40
Yes
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource Yes
timeToStartUp The time the resource needs to start after the outage has completed.
Float No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 49 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.ASAvailability No
availableValue The new MW value for this interval. Float Yes
MarketProduct.marketProductType
Type of AS that is restricted. Enumeration
Yes
RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.Availability No
dateTimePoint The time of this availability point in UTC. dateTime Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
PmaxValue.vlaue Indicates Pmax value Float Yes
RegisteredLoad.OutagedRegisteredResource.LoadMaximum(Choice1)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this point. Float Yes
outOfService Unit has avail 0 starting at this time. Yes/No No
returnToNetdependablecapacity
Indicates no derate starting at this time. Yes/No No
RegisteredLoad.OutagedRegisteredResource.LoadMinimum(Choice2)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new MW value for this interval. Float Yes
RegisteredLoad.OutagedRegisteredResource.MaximumEnergyLimit (Choice3)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new maximum energy limit (WH) for this interval.
Float Yes
RegisteredLoad.OutagedRegisteredResource.MinimumEergyLimit (Choice4)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new minimum energy limit (WH) for this interval.
Float Yes
RegisteredLoad.OutagedRegisteredResource.PMinimum(Choice5)
activePeriod.start The time of this pmin rerate point in UTC dateTime Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 50 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
restrictedValue The new minimum output of this resource/configuration for this interval
Float Yes
RegisteredLoad.OutagedRegisteredResource.PMaxCurtailment (Choice6)
activePeriod.start The time of this PMax curtailment point in UTC dateTime Yes
restrictedValue The new PMax curtailment value of this resource/configuration for this interval
Float Yes
RegisteredLoad.OutagedRegisteredResource.UseLimit(Choice7)
activePeriod.start Start date and time of this interval dateTime Yes
restrictedValue The new use Limit for the resource in this interval. Float Yes
RegisteredLoad.OutagedRegisteredResource.RampRateSegment (Choice8)
restrictedValue The new ramp rate (MW/min) for this segment in this interval.
Float Yes
segmentNumber The identifier for this segment Integer Yes
segmentValue The right hand side (MW) of this segment. Float Yes
5.7.2 Schema (ResourceOutageResults_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
5.7.3 Example XML File (ResourceOutageResults_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <m:ResourceOutageResults xmlns:m="http://www.caiso.com/soa/ResourceOutageResults_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/ResourceOutageResults_v1.xsd# ResourceOutageResults_v1.xsd "> <m:MessageHeader> <m:TimeDate>2001-12-31T12:00:00</m:TimeDate> <m:Source>CompanyA</m:Source> <m:Version>v20141001</m:Version> </m:MessageHeader> <m:MessagePayload> <m:RegisteredResourceOutage> <m:mRID>123456789</m:mRID> <m:description>New Generator (MSG) Outage</m:description> <m:comment>Example</m:comment> <m:createdBy>John Smith</m:createdBy> <m:createdDateTime>2014-01-03T11:00:04Z</m:createdDateTime>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 51 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:lastModifiedDateTime>2014-01-03T11:00:04Z</m:lastModifiedDateTime> <m:lastUpdatedBy>John Smith</m:lastUpdatedBy> <m:affectsRASSPS>YES</m:affectsRASSPS> <m:discoveryDateTime>2014-01-03T11:00:00Z</m:discoveryDateTime> <m:emergencyReturnTime>1</m:emergencyReturnTime> <m:emergencyReturnTimeType>HOURS</m:emergencyReturnTimeType> <m:isFinalApprovalReq>YES</m:isFinalApprovalReq> <m:mktOrgOutageID>9690</m:mktOrgOutageID> <m:outageCoordinationLongTermPlanning>NO</m:outageCoordinationLongTermPlanning> <m:outageStatus>RECEIVED</m:outageStatus> <m:outageStatusReason>AUTO</m:outageStatusReason> <m:outageType>PLANNED</m:outageType> <m:versionID>1</m:versionID> <m:estimatedPeriod> <m:end>2014-01-17T17:00:00Z</m:end> <m:start>2014-01-17T13:00:00Z</m:start> </m:estimatedPeriod> <m:MktOrganisation> <m:mRID>SCID1</m:mRID> <m:MarketPerson> <m:firstName>John</m:firstName> <m:lastName>Smith</m:lastName> <m:landlinePhone> <m:areaCode>916</m:areaCode> <m:extension>555</m:extension> <m:localNumber>1234</m:localNumber> </m:landlinePhone> </m:MarketPerson> </m:MktOrganisation> <m:OutageCause> <m:code>9690</m:code> </m:OutageCause> <m:OutageChangeRequest> <m:mRID>912345677</m:mRID> <m:action>UPDATE</m:action> <m:actionReason>CANCELLED_BY_CREW_PTO</m:actionReason> <m:status>REJECTED</m:status> </m:OutageChangeRequest> <m:OutageChangeRequest> <m:mRID>912345678</m:mRID> <m:action>UPDATE</m:action> <m:actionReason>WORK_RESCHEDULED_TO_LATER_DATE_SC</m:actionReason> <m:status>ACCEPTED</m:status> </m:OutageChangeRequest> <m:OutageValidation> <m:OutageResult> <m:mRID>1</m:mRID> <m:description>Validated</m:description> <m:status>ACKNOWLEDGED</m:status> <m:type>INFO</m:type> </m:OutageResult>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 52 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
</m:OutageValidation> <m:Work> <m:kind>PLANT_MAINTENANCE</m:kind> </m:Work> <m:isOffPeakOpportunityOutage>NO</m:isOffPeakOpportunityOutage> <m:isSCPExempt>NO</m:isSCPExempt> <m:isShortNoticeOpportunityOutage>NO</m:isShortNoticeOpportunityOutage> <m:RegisteredGenerator> <m:mRID>ResourceA</m:mRID> <m:name>Resource Alpha</m:name> <m:LogicalConfiguration> <m:Configuration> <m:mRID>ResA1x1</m:mRID> <m:name>Resource Alpha 1x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>80</m:value> </m:PmaxValue> </m:Availability> <m:Availability> <m:dateTimePoint>2014-01-17T17:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>100</m:value> </m:PmaxValue> </m:Availability> </m:OutagedRegisteredResource> </m:Configuration> <m:Configuration> <m:mRID>ResA2x1</m:mRID> <m:name>Resource Alpha 2x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>160</m:value> </m:PmaxValue> </m:Availability> <m:Availability> <m:dateTimePoint>2014-01-17T17:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:PmaxValue>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 53 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>200</m:value> </m:PmaxValue> </m:Availability> <m:PMinimum> <m:activePeriod> <m:start>2014-01-17T13:00:00Z</m:start> </m:activePeriod> <m:restrictedValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>81</m:value> </m:restrictedValue> </m:PMinimum> <m:PMinimum> <m:activePeriod> <m:start>2014-01-17T17:00:00Z</m:start> </m:activePeriod> <m:restrictedValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>200</m:value> </m:restrictedValue> </m:PMinimum> </m:OutagedRegisteredResource> </m:Configuration> </m:LogicalConfiguration> <m:OutagedRegisteredResource> <m:ASAvailability> <m:availableValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>0</m:value> </m:availableValue> <m:MarketProduct> <m:marketProductType>SR</m:marketProductType> </m:MarketProduct> </m:ASAvailability> </m:OutagedRegisteredResource> </m:RegisteredGenerator> </m:RegisteredResourceOutage> </m:MessagePayload> </m:ResourceOutageResults>
5.7.4 Example XML file (ResourceOutageChangeRequestResults_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <m:ResourceOutageResults xmlns:m="http://www.caiso.com/soa/ResourceOutageResults_v1.xsd#"
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 54 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/ResourceOutageResults_v1.xsd# ResourceOutageResults_v1.xsd "> <m:MessageHeader> <m:TimeDate>2001-12-31T12:00:00</m:TimeDate> <m:Source>CompanyA</m:Source> <m:Version>v20141001</m:Version> </m:MessageHeader> <m:MessagePayload> <m:RegisteredResourceOutage> <m:mRID>123456789</m:mRID> <m:description>New Generator (MSG) Outage</m:description> <m:comment>Example</m:comment> <m:createdBy>John Smith</m:createdBy> <m:createdDateTime>2014-01-03T11:00:04Z</m:createdDateTime> <m:lastModifiedDateTime>2014-01-03T11:00:04Z</m:lastModifiedDateTime> <m:lastUpdatedBy>John Smith</m:lastUpdatedBy> <m:affectsRASSPS>YES</m:affectsRASSPS> <m:discoveryDateTime>2014-01-03T11:00:00Z</m:discoveryDateTime> <m:emergencyReturnTime>1</m:emergencyReturnTime> <m:emergencyReturnTimeType>HOURS</m:emergencyReturnTimeType> <m:isFinalApprovalReq>YES</m:isFinalApprovalReq> <m:mktOrgOutageID>9690</m:mktOrgOutageID> <m:outageCoordinationLongTermPlanning>NO</m:outageCoordinationLongTermPlanning> <m:outageStatus>RECEIVED</m:outageStatus> <m:outageStatusReason>AUTO</m:outageStatusReason> <m:outageType>PLANNED</m:outageType> <m:versionID>1</m:versionID> <m:estimatedPeriod> <m:end>2014-01-17T17:00:00Z</m:end> <m:start>2014-01-17T13:00:00Z</m:start> </m:estimatedPeriod> <m:MktOrganisation> <m:mRID>SCID1</m:mRID> <m:MarketPerson> <m:firstName>John</m:firstName> <m:lastName>Smith</m:lastName> <m:landlinePhone> <m:areaCode>916</m:areaCode> <m:extension>555</m:extension> <m:localNumber>1234</m:localNumber> </m:landlinePhone> </m:MarketPerson> </m:MktOrganisation> <m:OutageCause> <m:code>9690</m:code> </m:OutageCause> <m:OutageChangeRequest> <m:mRID>912345677</m:mRID>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 55 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:action>UPDATE</m:action> <m:actionReason>WORK_RESCHEDULED_TO_LATER_DATE_SC</m:actionReason> <m:status>ACCEPTED</m:status> </m:OutageChangeRequest> <m:OutageValidation> <m:OutageResult> <m:mRID>1</m:mRID> <m:description>Validated</m:description> <m:status>ACKNOWLEDGED</m:status> <m:type>INFO</m:type> </m:OutageResult> </m:OutageValidation> <m:Work> <m:kind>PLANT_MAINTENANCE</m:kind> </m:Work> <m:isOffPeakOpportunityOutage>NO</m:isOffPeakOpportunityOutage> <m:isSCPExempt>NO</m:isSCPExempt> <m:isShortNoticeOpportunityOutage>NO</m:isShortNoticeOpportunityOutage> <m:RegisteredGenerator> <m:mRID>ResourceA</m:mRID> <m:name>Resource Alpha</m:name> <m:LogicalConfiguration> <m:Configuration> <m:mRID>ResA1x1</m:mRID> <m:name>Resource Alpha 1x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>80</m:value> </m:PmaxValue> </m:Availability> <m:Availability> <m:dateTimePoint>2014-01-17T17:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>100</m:value> </m:PmaxValue> </m:Availability> </m:OutagedRegisteredResource> </m:Configuration>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 56 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<m:Configuration> <m:mRID>ResA2x1</m:mRID> <m:name>Resource Alpha 2x1</m:name> <m:OutagedRegisteredResource> <m:Availability> <m:dateTimePoint>2014-01-17T13:00:00Z</m:dateTimePoint> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>160</m:value> </m:PmaxValue> </m:Availability> <m:Availability> <m:dateTimePoint>2014-01-17T17:00:00Z</m:dateTimePoint> <m:returnToNetDependableCapacity>YES</m:returnToNetDependableCapacity> <m:PmaxValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>200</m:value> </m:PmaxValue> </m:Availability> <m:PMinimum> <m:activePeriod> <m:start>2014-01-17T13:00:00Z</m:start> </m:activePeriod> <m:restrictedValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>81</m:value> </m:restrictedValue> </m:PMinimum> <m:PMinimum> <m:activePeriod> <m:start>2014-01-17T17:00:00Z</m:start> </m:activePeriod> <m:restrictedValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>200</m:value> </m:restrictedValue> </m:PMinimum> </m:OutagedRegisteredResource> </m:Configuration>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 57 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
</m:LogicalConfiguration> <m:OutagedRegisteredResource> <m:ASAvailability> <m:availableValue> <m:multiplier>M</m:multiplier> <m:unit>W</m:unit> <m:value>0</m:value> </m:availableValue> <m:MarketProduct> <m:marketProductType>SR</m:marketProductType> </m:MarketProduct> </m:ASAvailability> </m:OutagedRegisteredResource> </m:RegisteredGenerator> </m:RegisteredResourceOutage> </m:MessagePayload> </m:ResourceOutageResults>
5.8 Fault Return
For Fault return see section Fault Return
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 58 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
6. Submit Transmission Outage {Change Requests} Business Scenario
6.1 Overview
Outage coordinators can submit transmission outages or changes to previously submitted outages (Outage Change Requests) for affiliated equipment.
6.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable Outage Coordinators can call the ISO directly with critical near-term outages.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable (.1 sec – 30 sec)
6.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
6.3.1 Submit New Transmission Outage
sd Submit Transmission Outage
Outage Coordinator
OMS
SubmitTransmissionOutage()
SubmitTransmissionOutageResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 59 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
6.3.2 Submit Change to Existing Transmission Outage
6.4 Operational Details
6.4.1 Submit Transmission Outage
The service has one operation with three message types.
Operation Message
Types
Message WSDL XSD
SubmitTransmissi
onOutage
Input submitTransmission
Outage
submitTransmissionOutage
_v1.wsdl/
submitTransmissionOutage
_v1_DocAttach.wsdl
TransmissionOutageData_v1.x
sd
Output submitTransmission
OutageResponse
OutageStandardOutput_v1.xsd
Fault faultReturnType StandardOutput.xsd
6.4.2 Submit Transmission Outage Change Request
Operation Message
Types
Message WSDL XSD
SubmitTransmissi
onOutageChange
Request
Input submitTransmissi
onOutageChange
Request
submitTransmissionOutageC
hangeRequest_v1.wsdl/
submitTransmissionOutageC
hangeRequest_v1_DocAttach
.wsdl
TransmissionOutageData_v1.x
sd
Output submitTransmissi
onOutageChange
RequestResponse
OutageStandardOutput_v1.xsd
Fault faultReturnType StandardOutput.xsd
6.5 WSDL
6.5.1 submitTransmissionOutage_v1.wsdl / submitTransmissionOutage_v1_DocAttach.wsdl
sd SubmitTransmissionOutageChangeRequest
Outage Coordinator
OMS
SubmitTransmissionOutageChangeRequest()
SubmitTransmissionOutageChangeRequestResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 60 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
6.5.2 SubmitTransmissionOutageChangeRequest_v1.wsdl/ SubmitTransmissionOutageChangeRequest_v1_DocAttach.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
6.6 Submit Transmission Outage {Change Request}
Note: Outage cause codes are mandatory for forced transmission outages. At least one primary and one secondary cause code enumeration must be provided upon outage submission. The cause codes may be modified upon submission of an outage change request. The list of valid primary cause codes are: Aircraft (P), Animal Contact (P), Circuit Breakers/Circuit
Switches Trouble (P), Contamination (P), System Disturbance (P), Fire (P), Generation Maintenance/Trouble
(P), Late Notification (P), Line Equipment Trouble (P), Lightning (P), Natural Disasters (P), Operation Error
(P), Other (P), Protection (P), Scheduled Outage (P) Other Substation Equipment Trouble (P), Utility Contact
(P), Unknown (P), Vegetation (P), Vehicles (P), Weather (P)
Primary Cause Code Name Primary Cause Code Enumeration
Aircraft (P) AIRCRAFT_P
Animal Contact (P) ANIMAL_CONTACT_P
Circuit Breakers/Circuit Switches
Trouble (P)
CIRCUIT_BREAKERS_OR_CIRCUIT_SWITCHES_TROUBLE_P
Contamination (P) CONTAMINATION_P
System Disturbance (P) SYSTEM_DISTURBANCE_P
Fire (P) FIRE_P
Generation Maintenance/Trouble (P) GENERATION_MAINTENANCE_OR_TROUBLE_P
Late Notification (P) LATE_NOTIFICATION_P
Line Equipment Trouble (P) LINE_EQUIPMENT_TROUBLE_P
Lightning (P) LIGHTNING_P
Natural Disasters (P) NATURAL_DISASTERS_P
Operation Error (P) OPERATION_ERROR_P
Other (P) OTHER_P
Protection (P) PROTECTION_P
Scheduled Outage (P) SCHEDULED_OUTAGE_P
Other Substation Equipment Trouble (P) OTHER_SUBSTATION_EQUIPMENT_TROUBLE_P
Utility Contact (P) UTILITY_CONTACT_P
Unknown (P) UNKNOWN_P
Vegetation (P) VEGETATION_P
Vehicles (P) VEHICLES_P
Weather (P) WEATHER_P
The list of valid secondary cause codes are: Arrestors (S), Station Auxiliary Equipment (S), Battery
Systems (S),Bushings (S), COMM Facilities Not 100% Dedicated to Control (S), Conductor, Shield Wire, and
Splices (S), Direct Current Transmission Components (S), Disconnects (S), Encroachments/Unauthorized
Attachments (S), Guys and Anchors (S), Hardware, Fittings and Accessories (S), Insulators (S), Line
Switches (S), None (S) , Work Procedure/Human Error (S), Reactive Devices (S), Regulator (S), Control and
Relay System (S), Structures/Foundations (S), Underground Transmission Components (S), Circuit
Breakers/Circuit Switches (S), Other (S)
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 61 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Secondary Cause Code Name Secondary Cause Code Enumeration Arrestors (S) ARRESTORS_S
Station Auxiliary Equipment (S) STATION_AUXILIARY_EQUIPMENT_S
Battery Systems (S) BATTERY_SYSTEMS_S
Bushings (S) BUSHINGS_S
COMM Facilities Not 100%
Dedicated to Control (S) COMM_FACILITIES_NOT_100_PERCENT_DEDICATED_TO_CONTR
OL_S
Conductor, Shield Wire, and
Splices (S) CONDUCTOR_SHIELD_WIRE_AND_SPLICES_S
Direct Current Transmission
Components (S) DIRECT_CURRENT_TRANSMISSION_COMPONENTS_S
Disconnects (S) DISCONNECTS_S
Encroachments/Unauthorized
Attachments (S) ENCROACHMENTS_OR_UNAUTHORIZED_ATTACHMENTS_S
Guys and Anchors (S) GUYS_AND_ANCHORS_S
Hardware, Fittings and
Accessories (S) HARDWARE_FITTINGS_AND_ACCESSORIES_S
Insulators (S) INSULATORS_S
Line Switches (S) LINE_SWITCHES_S
None (S) NONE_S
Work Procedure/Human Error
(S) WORK_PROCEDURE_OR_HUMAN_ERROR_S
Reactive Devices (S) REACTIVE_DEVICES_S
Regulator (S) REGULATOR_S
Control and Relay System (S), CONTROL_AND_RELAY_SYSTEM_S
Structures/Foundations (S), STRUCTURES_OR_FOUNDATIONS_S
Underground Transmission
Components (S), UNDERGROUND_TRANSMISSION_EQUIPMENT_S
Circuit Breakers/Circuit Switches
(S), CIRCUIT_BREAKERS_OR_CIRCUIT_SWITCHES_S
Other (S) OTHER_S
6.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.TransmissionOutage
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 62 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String No
Description Participant’s description of the Outage/Change Request
String Yes
Comment Participant’s comment for the Outage/Change Request
String No
affectsRASSPS Participant indicates if this outage affects a RAS or SPS. Yes/No
String No
discoveryDateTime DateTime when the outage was discovered. dateTime No
emergencyReturnTime Time to restore the outage if needed by the ISO. Integer No
emergencyReturnTimeType
Type of emergency return time. DAYS, HOURS, MINUTES
String Yes
mktOrgOutageID Reference ID assigned to the outage by the participant.
String Yes
outageCoordinationLongTermPlanning
Indicates Outage is part of your Quarterly Outage Yes/No No
Actual Period Actual start and end times of the outage, in UTC dateTime No
Estimated Period Planned start and end time of the outage, in UTC. dateTime Yes
RIMSProjectCommissionDate
RIMS project commission date dateTime No
RIMSProjectCompletion RIMS project completion Yes/No No
RIMSProjectID RIMS project ID. String No
RIMSProjectPhase RIMS project phase. String No
OutageCause.code Reason code for Outage String No
Work.kind Kind of work String Yes
trumpFlag Indicates Outage trumps existing conflicting Outages
Yes/No No
congestionRevenueRightsDesignation
Indicates Outage affects the CRR auction Yes/No String No.
isNewEquipmentEnergized
Participant indicates that new equipment will be energized when the outage is complete. Yes/No
String No.
MessagePayload.TransmissionOutage.OperatingParticipant Yes
mRID Participant short name String Yes
MessagePayload.TransmissionOutage.OperatingParticipant.Person No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 63 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
firstName First name of the contact at the participant. String No
lastName Last name of the contact at the participant. String No
landlinePhone Phone number of the contact at the participant. Complex No
MessagePayload.TransmissionOutage.OutageChangeRequest No
action Type of change request. If present indicates that this is a change request to an existing outage. UPDATE or CANCEL
String Yes
actionReason Reason for changes. String No
actionSubType For Update, define type of Update IN_OK, IN_SERVICE , OUT, OUT_OK
String No
MessagePayload.TransmissionOutage.Equipments Yes
mRID The ISO RDFID for the Equipment. mrid minLen=1
maxLen=40
No
Names.name The Participant ID from Transmission Register (TR) for the equipment. Can be used instead of the ISO RDFID. Set the name type to PARTICIPANTID.
String Yes
Names.NameType Type of this name, PARTICIPANTID, PARTICIPANTNAME
String Yes
MessagePayload.TransmissionOutage.Equipments.AdjustedOperationalRating No
Active Period Interval during which Equipment has this restricted value. Must be the same or a subset of the outage range.
dateTime Yes
normalRestrictedValue New normal rating for this period : Unit of measure, value and multiplier
FloatQuantity
No
isRecurring Repeats the section of the day defined by start and end
each day for the duration of the outage. Yes/No String No
emergencyRestrictedValue
New Emergency rating for this period : Unit of measure, value and multiplier
FloatQuantity
No
MessagePayload.TransmissionOutage.Equipments.OutagedEquipment Yes
switchModelingComplete
Indicates that the switch modeling is not complete yet. Allows Out Of Service outages to be submitted before the full switching plan is available. Analysis is delayed until switch model is complete. Yes/No
String No
useFacilityOutageDefinition
For this equipment Out Of Service use the ISO generated list of switches and positions. Yes/No
String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 64 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
MessagePayload.TransmissionOutage.Equipments.VoltageLevel No
BaseVoltage The base Voltage used for all equipment within voltage level
Voltage Complex No
MessagePayload.TransmissionOutage.Equipments.OutagedEquipment.Switch No
mRID RDFID of Switch. ISO’s unique identifier. mrid minLen=1
maxLen=40
No
Names.name The Participant ID from Transmission Register (TR) for the switch. Can be used instead of the ISO RDFID. Set the name type to PARTICIPANTID.
String Yes
Names.NameType Type of this name, PARTICIPANTID, PARTICIPANTNAME
String Yes
MessagePayload.TransmissionOutage.Equipments.OutagedEquipment.Switch.SwitchingOperations Yes
newState New status of the switch for the newStatePeriod. Open/Close.
SwitchState Complex Type
Yes
newStatePeriod Start/End period for which the new state (open or close) is active
dateTime Yes
6.6.2 Schema (TransmissionOutageData_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
6.6.3 Example XML File (SubmitTransmissionOutageData_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <TransmissionOutageData xsi:schemaLocation="http://www.caiso.com/soa/TransmissionOutageData_v1.xsd# TransmissionOutageData_v1.xsd" xmlns="http://www.caiso.com/soa/TransmissionOutageData_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <TransmissionOutage> <description>New Transmission Outage</description> <comment>Sample</comment> <affectsRASSPS>NO</affectsRASSPS>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 65 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<discoveryDateTime>2001-12-17T09:30:47Z</discoveryDateTime> <emergencyReturnTime>1</emergencyReturnTime> <emergencyReturnTimeType>HOURS</emergencyReturnTimeType> <mktOrgOutageID>ref_id_1000</mktOrgOutageID> <RIMSProjectCommissionDate>2001-12-17T09:30:47Z</RIMSProjectCommissionDate> <RIMSProjectCompletion>NO</RIMSProjectCompletion> <RIMSProjectID>rims_project_id_1000</RIMSProjectID> <RIMSProjectPhase>Planning</RIMSProjectPhase> <actualPeriod> <end>2001-12-17T09:30:47Z</end> <start>2001-12-17T09:30:47Z</start> </actualPeriod> <Equipments> <mRID>Unique Equipment Name</mRID> <Names> <name>Participant Equipment A name</name> <NameType> <name>name</name> </NameType> </Names> <AdjustedOperationalRating> <activePeriod> <end>2001-12-17T09:30:47Z</end> <start>2001-12-17T12:30:47Z</start> </activePeriod> <normalRestrictedValue> <multiplier>M</multiplier> <unit>W</unit> <value>80</value> </normalRestrictedValue> <isRecurring>NO</isRecurring> <emergencyRestrictedValue> <multiplier>M</multiplier> <unit>W</unit> <value>40</value> </emergencyRestrictedValue> </AdjustedOperationalRating> <OutagedEquipment> <switchModelingComplete>NO</switchModelingComplete> <useFacilityOutageDefinition>NO</useFacilityOutageDefinition> <Switch> <SwitchingOperations> <newState>close</newState> <newStatePeriod> <end>2001-12-31T12:00:00</end> <start>2001-12-31T12:00:00</start> </newStatePeriod> </SwitchingOperations> </Switch> </OutagedEquipment> <VoltageLevel>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 66 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<BaseVoltage> <nominalVoltage> <multiplier>k</multiplier> <unit>V</unit> <value>0.0</value> </nominalVoltage> </BaseVoltage> </VoltageLevel> </Equipments> <estimatedPeriod> <end>2001-12-17T09:30:47Z</end> <start>2001-12-17T09:30:47Z</start> </estimatedPeriod> <OperatingParticipant> <mRID>PTO1</mRID> <Person> <firstName>John</firstName> <lastName>Smith</lastName> <landlinePhone> <areaCode>916</areaCode> <extension>555</extension> <localNumber>1234</localNumber> </landlinePhone> </Person> </OperatingParticipant> <Work> <kind>EQUIPMENT_DERATE</kind> </Work> <isNewEquipmentEnergized>NO</isNewEquipmentEnergized> </TransmissionOutage> </MessagePayload> </TransmissionOutageData>
6.6.4 Example XML File (SubmitTransmissionOutageChangeRequest_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <TransmissionOutageData xsi:schemaLocation="http://www.caiso.com/soa/TransmissionOutageData_v1.xsd# TransmissionOutageData_v1.xsd" xmlns="http://www.caiso.com/soa/TransmissionOutageData_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <TransmissionOutage> <mRID>123456789</mRID> <description>New Transmission Outage</description>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 67 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<comment>Sample</comment> <affectsRASSPS>NO</affectsRASSPS> <discoveryDateTime>2014-01-20T13:00:00Z</discoveryDateTime> <emergencyReturnTime>1</emergencyReturnTime> <emergencyReturnTimeType>HOURS</emergencyReturnTimeType> <mktOrgOutageID>ref_id_1000</mktOrgOutageID> <RIMSProjectCommissionDate>2001-12-17T09:30:47Z</RIMSProjectCommissionDate> <RIMSProjectCompletion>NO</RIMSProjectCompletion> <RIMSProjectID>rims_project_id_1000</RIMSProjectID> <RIMSProjectPhase>Planning</RIMSProjectPhase> <actualPeriod> <start>2014-01-23T13:30:00Z</start> </actualPeriod> <Equipments> <mRID>Unique Equipment Name</mRID> <Names> <name>Participant Equipment A name</name> <NameType> <name>name</name> </NameType> </Names> <AdjustedOperationalRating> <activePeriod> <end>2014-01-31T13:30:00Z</end> <start>2014-01-23T13:00:00Z</start> </activePeriod> <normalRestrictedValue> <multiplier>M</multiplier> <unit>W</unit> <value>60</value> </normalRestrictedValue> <isRecurring>NO</isRecurring> <emergencyRestrictedValue> <multiplier>M</multiplier> <unit>W</unit> <value>20</value> </emergencyRestrictedValue> </AdjustedOperationalRating> <OutagedEquipment> <switchModelingComplete>NO</switchModelingComplete> <useFacilityOutageDefinition>NO</useFacilityOutageDefinition> <Switch> <SwitchingOperations> <newState>close</newState> <newStatePeriod> <end>2001-12-31T12:00:00</end> <start>2001-12-31T12:00:00</start> </newStatePeriod> </SwitchingOperations> </Switch> </OutagedEquipment>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 68 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<VoltageLevel> <BaseVoltage> <nominalVoltage> <multiplier>k</multiplier> <unit>V</unit> <value>0.0</value> </nominalVoltage> </BaseVoltage> </VoltageLevel> </Equipments> <estimatedPeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:00:00Z</start> </estimatedPeriod> <OperatingParticipant> <mRID>PTO1</mRID> <Person> <firstName>John</firstName> <lastName>Smith</lastName> <landlinePhone> <areaCode>916</areaCode> <extension>555</extension> <localNumber>1234</localNumber> </landlinePhone> </Person> </OperatingParticipant> <OutageChangeRequest> <action>UPDATE</action> </OutageChangeRequest> <Work> <kind>EQUIPMENT_DERATE</kind> </Work> <isNewEquipmentEnergized>NO</isNewEquipmentEnergized> </TransmissionOutage> </MessagePayload> </TransmissionOutageData>
6.7 Submit TransmissionOutage {Change Request} Response
6.7.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 69 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.EventLog Yes
MessagePayload.EventLog.Event Yes
result Event result. string Yes
id Event identifier. string Yes
description Event description. string No
creationDateTime Event creation time. dateTime No
MessagePayload.EventLog.Service Yes
id Service identifier. string Yes
name Name of a service. string Yes
MessagePayload.EventLog.Outage No
mrid ID assigned to the outage by the ISO String No
mktOrgOutageID Reference ID assigned to the outage by the external User
String Yes
MessagePayload.EventLog.Outage.OutageChangeRequest No
mrid ID assigned to the outage change request by the ISO
String Yes
MessagePayload.EventLog.Outage.OutageGroup No
mRID ID assigned to the outage Group by the ISO String Yes
MessagePayload.EventLog.Outage.OutageValidation Yes
submitStatus Indicates whether the outage was accepted or rejected: ACCEPTED, REJECTED
String Yes
MessagePayload.EventLog.Outage.OutageValidation.OutageResult Yes
mrID ID assigned to the result by the ISO String Yes
type Type of result: ERROR, INFO, WARNING String Yes
description Description of result returned String Yes
status Status of the result: ACKNOWLEDGED. UNACKNOWLEDGED. This is applicable only to warnings.
String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 70 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
6.7.2 Schema (OutageStandardOutput_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
6.7.3 Example XML File (TransmissionOutageStandardOutput_v1.xml)
6.7.3.1 Example XML File for Submit Transmission Outage Response
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <OutageStandardOutput xsi:schemaLocation="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd# OutageStandardOutput_v1.xsd" xmlns="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>OMS</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EventLog> <Event> <id>1000</id> <result>Success</result> </Event> <Outage> <mRID>123456789</mRID> <mktOrgOutageID>ref_id_1000</mktOrgOutageID> <OutageValidation> <submitStatus>ACCEPTED</submitStatus> <OutageResult> <mRID>1</mRID> <description>Validated</description> <type>INFO</type> </OutageResult> </OutageValidation> </Outage> <Service> <id>12345</id> <name>submitTransmissionOutage_v1</name> </Service> </EventLog> </MessagePayload> </OutageStandardOutput>
6.7.3.2 Example XML File for Submit Transmission Outage Change Request Response
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 71 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <OutageStandardOutput xsi:schemaLocation="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd# OutageStandardOutput_v1.xsd" xmlns="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>OMS</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EventLog> <Event> <id>1</id> <result>Success</result> </Event> <Outage> <mRID>123456789</mRID> <mktOrgOutageID>ref_id_1000</mktOrgOutageID> <OutageChangeRequest> <mRID>987654321</mRID> </OutageChangeRequest> <OutageValidation> <submitStatus>ACCEPTED</submitStatus> <OutageResult> <mRID>1</mRID> <description>Validated</description> <type>INFO</type> </OutageResult> </OutageValidation> </Outage> <Service> <id>12345</id> <name>submitTransmissionOutageChangeRequest_v1</name> </Service> </EventLog> </MessagePayload> </OutageStandardOutput>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 72 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
7. Retrieve Transmission Outage/Change Requests
7.1 Overview
Outage Coordinators can retrieve transmission outages or outage change requests for affiliated generators.
7.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable Outage Coordinators can call the ISO for status on near-term outages and Change Requests.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
7.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
7.3.1 Retrieve Transmission Outages
sd retriev eTransmissionOutage
Outage Coordinator
OMS
retrieveTransmissionOutage()
retrieveTransmissionOutageResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 73 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
7.3.2 Retrieve Transmission Outage Change Requests
7.4 Operational Details
Each service has one operation with three message types.
7.4.1 Retrieve Transmission Outage
Operation Message
Types
Message WSDL XSD
retrieveTransmissi
onOutage
Input retrieveTransmissi
onOutage
retrieveTransmissionOutage_
v1.wsdl/
retrieveTransmissionOutage_
v1_DocAttach.wsdl
requestTransmissionOutage_
v1.xsd
Output retrieveTransmsis
sionOutageRespo
nse
TransmissionOutageResults_
v1.xsd
Fault faultReturnType StandardOutput.xsd
7.4.2 Retrieve Transmission Outage Change Request
Operation Message
Types
Message WSDL XSD
retrieveTransmissi
onOutageChange
Request
Input retrieveTransmissi
onOutageChangeR
equest
retrieveTransmissionOutage
ChangeRequest_v1.wsdl/
retrieveTransmissionOutage
ChangeRequest_v1_DocAtta
ch.wsdl
requestTransmissionOutage_
v1.xsd
Output retrieveTransmissi
onOutageChangeR
equestResponse
TransmissionOutageResults_
v1.xsd
Fault faultReturnType StandardOutput.xsd
7.5 WSDL
7.5.1 retrieveTransmissionOutage_v1.wsdl / retrieveTransmissionOutage_v1_DocAttach.wsdl
sd retriev eTransmissionOutageChangeRequest
Outage Coordinator
OMS
retrieveTransmissionOutageChangeRequest()
retrieveTransmissionOutageChangeRequestResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 74 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
7.5.2 retrieveTransmissionOutageChangeRequest_v1.wsdl / retrieveTransmissionOutageChangeRequest_v1_DocAttach.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
7.6 Retrieve Transmission Outage {Change Request}
Request Criteria Input Parameters Results
Outage WebOMS outage id or Participant’s outage id
The outage specified
Outage Range Range start and end date and Outage Status (optional)
All outages for all resources that the requester has access to for the date range specified optionally filtered by outage status if specified
Participant MktOrganization mrid and Range start and end date and Outage Status(optional)
All outages for all resources associated with the specified MktOrganization mrid that the requester has access to for the date range specified optionally filtered by outage status if specified
Equipment Resource (Equipment mrid or Equipment Names.name and Equipment Names.NameType.name = PARTICIPANTID) and Range start and end date and Outage Status(optional)
All outages for the equipment specified and for the date range specified optionally filtered by outage status if specified
Outage Change Request Outage Change Request mrid The outage change request specified
7.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.Outage No
mRID The Primary identifier the ISO has given to an outage String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 75 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
mktOrgOutageID Reference ID assigned to the outage by the external user
String No
MessagePayload.OutageChangeRequest No
mRID The Primary identifier the ISO has given to an outage change request
String No
MessagePayload.Participant No
rangePeriod Start and end date of the period being requested dateTime No
MessagePayload.Participant.MktOrganization Yes
mrID Participant Short Name of the requestor String No
MessagePayload.Participant.Outage No
outageStatus Request all outages or change requests in this status String No
MessagePayload.Participant.rangePeriod Yes
rangePeriod Start and end date of the period being requested String Yes
MessagePayload.EquipmentResource
rangePeriod Start and end date of the period being requested dateTime No
MessagePayload.EquipmentResource.Equipment Yes
mRID Master resource identifier issues by Model Authority String No
name Equipment Name, it may not be unique String No
Names All Names of this equipment Name Complex Type
No
MessagePayload.EquipmentResource.Outage No
outageStatus Request all outages or change requests in this status String No
MessagePayload.OutageRange No
rangePeriod Start and end date of the period being requested dateTime Yes
MessagePayload.OutageRange.Outage
outageStatus Request all outages or change requests in this status String No
7.6.2 Schema (RequestTransmissionOutage_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
7.6.3 Example XML File (RequestTransmissionOutage_v1.xml)
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 76 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <RequestTransmissionOutage xsi:schemaLocation="http://www.caiso.com/soa/RequestTransmissionOutage_v1.xsd# RequestTransmissionOutage_v1.xsd" xmlns="http://www.caiso.com/soa/RequestTransmissionOutage_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EquipmentResource> <Equipment> <mRID>1234</mRID> <name>ISONameLineB</name> </Equipment> <Outage> <outageStatus>APPROVED</outageStatus> </Outage> <rangePeriod> <end>2014-02-01T00:00:00Z</end> <start>2014-01-01T00:00:00Z</start> </rangePeriod> </EquipmentResource> </MessagePayload> </RequestTransmissionOutage>
7.6.4 Example XML file (RequestTransmissionOutageChangeRequest_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <RequestTransmissionOutage xsi:schemaLocation="http://www.caiso.com/soa/RequestTransmissionOutage_v1.xsd# RequestTransmissionOutage_v1.xsd" xmlns="http://www.caiso.com/soa/RequestTransmissionOutage_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>String</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EquipmentResource> <Equipment> <mRID>1234</mRID> <name>ISONameLineB</name> </Equipment> <rangePeriod> <end>2014-02-01T00:00:00Z</end>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 77 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<start>2014-01-01T00:00:00Z</start> </rangePeriod> </EquipmentResource> </MessagePayload> </RequestTransmissionOutage>
7.7 Retrieve Transmission Outage {Change Request} Response
7.7.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.TransmissionOutage Yes
mRID ID for the Outage, Not required for new outage, required when submitting a change request.
String No
Description Participant’s description of the Outage/Change Request
String Yes
Comment Participant’s comment for the Outage/Change Request
String No
createDateTime Time this outage/change request was created dateTime Yes
createdBy The person that created the outage/change request
String Yes
lastModifiedDateTime Time this outage/change request was last modified dateTime Yes
lastUpdatedBy The person that last updated the the outage/change request
dateTime Yes
affectsRASSPS Participant indicates if this outage affects a RAS or SPS. Yes/No
String No
discoveryDateTime DateTime when the outage was discovered. dateTime No
emergencyReturnTime Time to restore the outage if needed by the ISO. Integer No
emergencyReturnTimeType
Type of emergency return time. DAYS, HOURS, MINUTES
String Yes
isFinalApprovalReq Flag to indicate if final approval is required. Yes/No String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 78 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
mktOrgOutageID Reference ID assigned to the outage by the participant.
String No
outageCoordinationLongTermPlanning
Indicates the outage is part of your quarterly outage plan
Yes/No No
OutageStatus The current status of the outage String Yes
OutageStatusReason The reason for moving the outage to this status String No
OutageType The type of outage: PLANNED, FORCED OutageKind
Yes
RIMSProjectCommisionDate
Commission date of the the related RIMS project dateTime No
RIMSProjectCompletion Completion date of the related RIMS project dateTime No
RIMSProjectID RIMS id of the related RIMS project String No
RIMSProjectPhase RIMS phase that this outage will complete String No
versionID Version of this Outage String Yes
congestionRevenueRightsDesignation
Indicates that an Outage affects the Congestion Revenue Rights (CRR) auction.
Yes/No No
isNewEquipmentEnergized
Participant indicates that new equipment will be energized when the outage is complete. Yes/No
String No
Actual Period Actual start and end times of the outage, in UTC dateTime No
Estimated Period Planned start and end time of the outage, in UTC. dateTime Yes
Work.kind Kind of work String Yes
trumpFlag Indicates Outage trumps existing conflicting Outages
Yes/No No
MessagePayload.TransmissionOutage.OutageGroup No
MRID The primary identifier of the Group String Yes
Description The description of the group String Yes
createdDateTime Time the group was created dateTime Yes
CreatedBy The person that created the group String Yes
lastModifiedDateTime Time the group was last modified dateTime Yes
LastModifiedBy The person that last updated the group String Yes
MessagePayload.TransmissionOutage.OperatingParticipant Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 79 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
mRID Participant short name String Yes
MessagePayload.TransmissionOutage.OperatingParticipant.Person No
firstName First name of the contact at the participant. String Yes
lastName Last name of the contact at the participant. String Yes
landlinePhone Phone number of the contact at the participant. Complex Yes
MessagePayload.TransmissionOutage.OutageChangeRequest No
mrID ID assigned to the outage change request by the ISO
String Yes
action Type of change request. UPDATE or CANCEL String Yes
actionReason Reason for Change String No
actionSubType Forupdate, define the type of Update String No
status Status of the outage change request: PENDING, ACCEPTED, DENIED
String Yes
statusReason Reason for status. Required when the outage change request is denied
String No
MessagePayload.TransmissionOutage.Equipments Yes
mRID The RDF id for the Equipment. mrid minLen=1
maxLen=40
Yes
name ISO name of Equipment name minLen=1
maxLen=80
Yes
Names.name ISO names of Equipment. Max number of names :2. When the equipment can be matched to a TR registration contains the
TR ID (nameType=PARTICIPANTID) and the
TR Name (nameType=PARTICIPANTNAME)
String No
Names.NameType Type of this name. PARTICIPANTID, PARTICIPANTNAME
String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 80 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
PSR Type Type of power system resource
ACLINESEGMENT, BREAKER, BUSBARSECTION, CONFORMLOAD, DCLINESEGMENT, DISCONNECT, ENERGYCONSUMER, LINE, NONCONFORMLOAD, POWERTRANSFORMER, STATICVARCOMPENSATOR, SUBSTATION, SWITCH
Enumeration
Yes
MessagePayload.TransmissionOutage.Equipments.AdjustedOperationalRating No
Active Period Interval during which Equipment has this restricted value
dateTime Yes
normalRestrictedValue New normal rating for this period : Unit of measure, value and multiplier
FloatQuantity
No
isRecurring Repeats the section of the day defined by start and end
each day for the duration of the outage. Yes/No String No
emergencyRestrictedValue
New Emergency rating for this period : Unit of measure, value and multiplier
FloatQuantity
No
MessagePayload.TransmissionOutage.Equipments.OutagedEquipment Yes
switchModelingComplete
Indicates that the switch modeling is not complete yet. Allows Out Of Service outages to be submitted before the full switching plan is available. Analysis is delayed until switch model is complete. Yes/No
String No
useFacilityOutageDefinition
For this equipment Out Of Service use the ISO generated list of switches and positions. Yes/No
String No
MessagePayload.TransmissionOutage.Equipments.VoltageLevel No
BaseVoltage The base Voltage used for all equipment within voltage level
Voltage Complex No
MessagePayload.TransmissionOutage.Equipments.OutagedEquipment.Switch(Required=No)
mRID ISO RDFID of the Switch mrid minLen=1
maxLen=40
Yes
name ISO name of Equipment name minLen=1
maxLen=80
Yes
Names.name ISO names of Equipment. Max number of names :2 When the switch can be matched to a TR registration contains the
TR ID (nameType=PARTICIPANTID) and the
TR Name (nameType=PARTICIPANTNAME)
String No
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 81 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
Names.NameType Type of this name, PARTICIPANTID, PARTICIPANTNAME
String No
MessagePayload.TransmissionOutage.Equipments.OutagedEquipment.Switch.SwitchingOperations Yes
newState New status of the switch for the newStatePeriod. Open/Close
SwitchState Complex Type
Yes
newStatePeriod Start/End period for which the new state (open or close) is active
dateTime Yes
7.7.2 Schema (TransmissionOutageResults_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
7.7.3 Example XML File (TransmissionOutageResults_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <TransmissionOutageResults xsi:schemaLocation="http://www.caiso.com/soa/TransmissionOutageResults_v1.xsd# TransmissionOutageResults_v1.xsd" xmlns="http://www.caiso.com/soa/TransmissionOutageResults_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2014-01-27T13:30:00Z</TimeDate> <Source>OMS</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <TransmissionOutage> <mRID>123456789</mRID> <description>Line work to install new equipment.</description> <comment>Out for Maintenance</comment> <createdBy>John Smith</createdBy> <createdDateTime>2014-01-20T16:30:00Z</createdDateTime> <lastModifiedDateTime>2014-01-23T13:30:00Z</lastModifiedDateTime> <lastUpdatedBy>John Smith</lastUpdatedBy> <affectsRASSPS>NO</affectsRASSPS> <discoveryDateTime>2014-01-20T16:15:00Z</discoveryDateTime> <emergencyReturnTime>2</emergencyReturnTime> <emergencyReturnTimeType>HOURS</emergencyReturnTimeType> <isFinalApprovalReq>YES</isFinalApprovalReq> <mktOrgOutageID>P123456789</mktOrgOutageID> <outageStatus>OUT_OK</outageStatus> <outageStatusReason>Outage Started</outageStatusReason> <outageType>FORCED</outageType>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 82 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<RIMSProjectCommissionDate>2014-01-31T13:30:00Z</RIMSProjectCommissionDate> <RIMSProjectCompletion>YES</RIMSProjectCompletion> <RIMSProjectID>RIMS001</RIMSProjectID> <RIMSProjectPhase>Phase 3</RIMSProjectPhase> <versionID>2</versionID> <actualPeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </actualPeriod> <Equipments> <mRID>Conductor_1234</mRID> <name>ISONameLineA_seg1</name> <Names> <name>ParticipantNameLineA</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <PSRType> <type>ACLINESEGMENT</type> </PSRType> <OutagedEquipment> <switchModelingComplete>NO</switchModelingComplete> <useFacilityOutageDefinition>NO</useFacilityOutageDefinition> <Switch> <mRID>Switch_1234</mRID> <name>ISONameSwitch1</name> <Names> <name>ParticipantNameSwitch1</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> <Switch> <mRID>Switch_2345</mRID> <name>ISONameSwitch2</name> <Names> <name>ParticipantNameSwitch2</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 83 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> </OutagedEquipment> </Equipments> <Equipments> <mRID>Conductor_1235</mRID> <name>ISONameLineA_seg2</name> <Names> <name>ParticipantNameLineA</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <PSRType> <type>ACLINESEGMENT</type> </PSRType> <OutagedEquipment> <switchModelingComplete>NO</switchModelingComplete> <useFacilityOutageDefinition>NO</useFacilityOutageDefinition> <Switch> <mRID>Switch_3234</mRID> <name>ISONameSwitch3</name> <Names> <name>ParticipantNameSwitch3</name> <NameType> <name>PARTICIPANTNAME</name> </NameType> </Names> <SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> <Switch> <mRID>Switch_4345</mRID> <name>ISONameSwitch4</name> <Names> <name>ParticipantNameSwitch4</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 84 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> </OutagedEquipment> </Equipments> <estimatedPeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:00:00Z</start> </estimatedPeriod> <OperatingParticipant> <mRID>PTCP</mRID> <Person> <firstName>Joanne</firstName> <lastName>Jones</lastName> <landlinePhone> <areaCode>916</areaCode> <localNumber>5551234</localNumber> </landlinePhone> </Person> </OperatingParticipant> <OutageGroup> <mRID>Group1</mRID> <description>Group for trumped outages</description> <createdDateTime>2014-01-20T16:30:00Z</createdDateTime> <lastModifiedDateTime>2014-01-20T16:30:00Z</lastModifiedDateTime> <createdBy>ISO OC1</createdBy> <lastModifiedBy>ISO OC1</lastModifiedBy> </OutageGroup> <Work> <kind>OUT_OF_SERVICE</kind> </Work> <isNewEquipmentEnergized>YES</isNewEquipmentEnergized> </TransmissionOutage> </MessagePayload> </TransmissionOutageResults>
7.7.4 Example XML file (TransmissionOutageResultsChangeRequests_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <TransmissionOutageResults xsi:schemaLocation="http://www.caiso.com/soa/TransmissionOutageResults_v1.xsd# TransmissionOutageResults_v1.xsd"
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 85 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
xmlns="http://www.caiso.com/soa/TransmissionOutageResults_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>String</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <TransmissionOutage> <mRID>123456789</mRID> <description>Line work to install new equipment.</description> <comment>Out for Maintenance</comment> <createdBy>John Smith</createdBy> <createdDateTime>2014-01-20T16:30:00Z</createdDateTime> <lastModifiedDateTime>2014-01-23T13:30:00Z</lastModifiedDateTime> <lastUpdatedBy>John Smith</lastUpdatedBy> <affectsRASSPS>NO</affectsRASSPS> <discoveryDateTime>2014-01-20T16:15:00Z</discoveryDateTime> <emergencyReturnTime>2</emergencyReturnTime> <emergencyReturnTimeType>HOURS</emergencyReturnTimeType> <isFinalApprovalReq>YES</isFinalApprovalReq> <mktOrgOutageID>P123456789</mktOrgOutageID> <outageStatus>OUT_OK</outageStatus> <outageStatusReason>Outage Started</outageStatusReason> <outageType>FORCED</outageType> <RIMSProjectCommissionDate>2014-01-31T13:30:00Z</RIMSProjectCommissionDate> <RIMSProjectCompletion>YES</RIMSProjectCompletion> <RIMSProjectID>RIMS001</RIMSProjectID> <RIMSProjectPhase>Phase 3</RIMSProjectPhase> <versionID>2</versionID> <actualPeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </actualPeriod> <Equipments> <mRID>Conductor_1234</mRID> <name>ISONameLineA_seg1</name> <Names> <name>ParticipantNameLineA</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <PSRType> <type>ACLINESEGMENT</type> </PSRType> <OutagedEquipment> <switchModelingComplete>NO</switchModelingComplete> <useFacilityOutageDefinition>NO</useFacilityOutageDefinition> <Switch>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 86 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<mRID>Switch_1234</mRID> <name>ISONameSwitch1</name> <Names> <name>ParticipantNameSwitch1</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> <Switch> <mRID>Switch_1234</mRID> <name>ISONameSwitch1</name> <Names> <name>ParticipantNameSwitch1</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> </OutagedEquipment> </Equipments> <Equipments> <mRID>Conductor_1235</mRID> <name>ISONameLineA_seg2</name> <Names> <name>ParticipantNameLineA</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <PSRType> <type>ACLINESEGMENT</type> </PSRType> <OutagedEquipment> <switchModelingComplete>NO</switchModelingComplete> <useFacilityOutageDefinition>NO</useFacilityOutageDefinition> <Switch>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 87 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<mRID>Switch_3234</mRID> <name>ISONameSwitch3</name> <Names> <name>ParticipantNameSwitch3</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> <Switch> <mRID>Switch_4345</mRID> <name>ISONameSwitch4</name> <Names> <name>ParticipantNameSwitch4</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> <SwitchingOperations> <newState>open</newState> <newStatePeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:30:00Z</start> </newStatePeriod> </SwitchingOperations> </Switch> </OutagedEquipment> </Equipments> <estimatedPeriod> <end>2014-01-31T13:00:00Z</end> <start>2014-01-23T13:00:00Z</start> </estimatedPeriod> <OperatingParticipant> <mRID>PTCP</mRID> <Person> <firstName>Joanne</firstName> <lastName>Jones</lastName> <landlinePhone> <areaCode>916</areaCode> <localNumber>5551234</localNumber> </landlinePhone> </Person> </OperatingParticipant> <OutageChangeRequest> <mRID>912345678</mRID>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 88 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<action>UPDATE</action> <status>ACCEPTED</status> <statusReason>APPROVED</statusReason> </OutageChangeRequest> <OutageGroup> <mRID>Group1</mRID> <description>Group for trumped outages</description> <createdDateTime>2014-01-20T16:30:00Z</createdDateTime> <lastModifiedDateTime>2014-01-20T16:30:00Z</lastModifiedDateTime> <createdBy>ISO OC1</createdBy> <lastModifiedBy>ISO OC1</lastModifiedBy> </OutageGroup> <Work> <kind>OUT_OF_SERVICE</kind> </Work> <isNewEquipmentEnergized>YES</isNewEquipmentEnergized> </TransmissionOutage> </MessagePayload> </TransmissionOutageResults>
7.8 Fault Return
For Fault return see section Fault Return
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 89 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
8. Retrieve Availability
8.1 Overview
Outage Coordinators can retrieve the availability profile of a generating resource.
8.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable The availability profile will be viewable in the OMS user interface.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
8.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
8.3.1 Retrieve Availability
sd retriev e Av ailability
Participant
OMS
retrieveAvailabil ity()
retrieveAvailabil ityResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 90 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
8.4 Operational Details
Each service has one operation with three message types.
8.4.1 Retrieve Availability
Operation Message
Types
Message WSDL XSD
retrieveAvailability Input retrieveAvailability retrieveAvailability_v1.
wsdl/
retrieveAvailability_v1
_DocAttach.wsdl
requestAvailability_v1.xsd
Output retrieveAvailability
Response
AvailabilityResults_v1.xsd
Fault faultReturnType StandardOutput.xsd
8.5 WSDL
8.5.1 retrieveAvailability_v1.wsdl / retrieveAvailability_v1_DocAttach.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
8.6 Retrieve Availability
Request Criteria Input Parameters Results Date Range Range start and end date and
Effective Date (optional) Availability points for all resources that the requester has access to for the date range specified with optional availability effective date
Participant MktOrganization mrid and Range start and end date and and Effective Date (optional)
Availability points for all resources associated with the specified MktOrganization mrid that the requester has access to for the date range specified with optional availability effective date
Resource RegisteredGenerator mrid and Range start and end date and and Effective Date (optional)
Availability points for the resource(s) specified and for the date range specified with optional availability effective date
8.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 91 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.Resource Yes
effectiveDateTime Provides an optional method for viewing data as of a specific time
dateTime No
rangePeriod Start and end date of the period being requested dateTime Yes
Choice of RegisteredGenerator or RegisteredIntertie or RegisteredLoad
mrid Unique Identifier of the resource being requested String Yes
8.6.2 Schema (RequestAvailability_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
8.6.3 Example XML File (RequestAvailability_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <RequestAvailability xsi:schemaLocation="http://www.caiso.com/soa/RequestAvailability_v1.xsd# RequestAvailability_v1.xsd" xmlns="http://www.caiso.com/soa/RequestAvailability_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2014-04-01T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <Resource> <effectiveDateTime>2014-03-15T09:00:00Z</effectiveDateTime> <rangePeriod> <end>2014-04-01T00:00:00Z</end> <start>2014-03-01T00:00:00Z</start> </rangePeriod> <RegisteredGenerator> <mRID>ResourceA</mRID> </RegisteredGenerator> </Resource> <Resource> <rangePeriod> <end>2014-04-01T00:00:00Z</end> <start>2014-03-01T00:00:00Z</start> </rangePeriod> <RegisteredGenerator>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 92 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<mRID>ResourceA</mRID> </RegisteredGenerator> </Resource> </MessagePayload> </RequestAvailability>
8.7 Request Availability Response
8.7.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.RegisteredGenerator No
mRID The resource id for the RegisteredGenerator. String No
Name An alternate name from the Participant String No
MessagePayload.RegisteredGenerator.LogicalConfiguration No
MessagePayload.RegisteredGenerator.LogicalConfiguration.Configuration Yes
mRID The resource id for an MSG RegisteredGenerator’s Configuration.
String No
Name An alternate name from the Participant. String No
MessagePayload.RegisteredGenerator.Logicalconfiguration.Configuration.OutagedRegisteredResource(
Required=Yes)
MessagePayload.RegisteredGenerator.Logicalconfiguration.Configuration.OutagedRegisteredResource
.Availability Yes
dateTimePoint The time of this availability point in UTC. dateTime Yes
PmaxValue.vlaue Indicates Pmax value Float Yes
MessagePayload.RegisteredGenerator.OutagedRegisteredResource Yes
MessagePayload.RegisteredGenerator.OutagedRegisteredResource.Availability Yes
8.7.2 Schema (AvailabilityResults_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 93 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
8.7.3 Example XML File (AvailabilityResults_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <AvailabilityResults xmlns="http://www.caiso.com/soa/AvailabilityResults_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/AvailabilityResults_v1.xsd# AvailabilityResults_v1.xsd "> <MessageHeader> <TimeDate>2014-04-01T09:31:00Z</TimeDate> <Source>String</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <RegisteredGenerator> <mRID>ResourceA</mRID> <name>Resource Alpha</name> <LogicalConfiguration> <Configuration> <mRID>ResA1x1</mRID> <name>Resource Alpha 1x1</name> <OutagedRegisteredResource> <Availability> <dateTimePoint>2014-01-17T13:00:00Z</dateTimePoint> <OutagedRegisteredResource> <RegisteredResource> <RegisteredResourceOutage> <mRID>12345</mRID> <PMaxCurtailment> <activePeriod> <start>2014-01-17T10:00:00Z</start> </activePeriod> <restrictedValue> <multiplier>M</multiplier> <unit>W</unit> <value>50</value> </restrictedValue> </PMaxCurtailment> </RegisteredResourceOutage> </RegisteredResource> </OutagedRegisteredResource> <PmaxValue> <multiplier>M</multiplier> <unit>W</unit> <value>100</value> </PmaxValue> </Availability> </OutagedRegisteredResource> </Configuration> </LogicalConfiguration> <OutagedRegisteredResource> <Availability> <dateTimePoint>2001-12-31T12:00:00</dateTimePoint>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 94 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<OutagedRegisteredResource> <RegisteredResource> <RegisteredResourceOutage> <mRID>12345</mRID> <PMaxCurtailment> <activePeriod> <start>2001-12-31T12:00:00</start> </activePeriod> <restrictedValue> <multiplier>M</multiplier> <unit>W</unit> <value>30</value> </restrictedValue> </PMaxCurtailment> </RegisteredResourceOutage> </RegisteredResource> </OutagedRegisteredResource> <PmaxValue> <multiplier>M</multiplier> <unit>W</unit> <value>100</value> </PmaxValue> </Availability> </OutagedRegisteredResource> </RegisteredGenerator> </MessagePayload> </AvailabilityResults>
8.8 Fault Return
For Fault return see section Fault Return
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 95 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
9. Retrieve Facility Outage Definition
9.1 Overview
Outage Coordinators can retrieve the pre-agreed switch positions for out of service equipment.
9.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable The Outage coordinator will not be able to access the pre-canned facility outage definition. The definitions are constant across network model updates.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
9.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
9.3.1 Retrieve Facility Outage Definition
sd retriev e Facility Outage Definition
Outage Coordinator
OMS
retrieveFacilityOutageDefinition()
retrieveFacilityOutageDefinitionResponse()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 96 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
9.4 Operational Details
Each service has one operation with three message types.
9.4.1 Retrieve Facility Outage Definition
Operation Message
Types
Message WSDL XSD
retrieveFacilityouta
geDefinition
Input retrieveFacilityOutag
eDefinition
retrieveFacilityoutage
Definition_v1.wsdl/
retrieveFacilityoutage
Definition_v1_DocAtt
ach.wsdl
requestFacilityoutageDefinition_
v1.xsd
Output retrieveFacilityOutag
eDefinitionResponse
FacilityOutageDefinitionResults
_v1.xsd
Fault faultReturnType StandardOutput.xsd
9.5 WSDL
9.5.1 retrieveFacilityOutageDefinition_v1.wsdl / retrieveFacilityOutageDefinition_v1_DocAttach.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
9.6 Retrieve Facility Outage Definition
Request Criteria Input Parameters Results
Participant MktOrganization mrid
The facility outage definitions for all equipment associated with the specified MktOrganization mrid that the requester has access
Equipment Equipment mrid or (Equipment Names.name and Equipment Names.NameType.name = PARTICIPANTID)
The facility outage definition for the equipment specified
9.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 97 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
MessagePayload.Facility.Equipment No
mRID The resource id for the Equipment. String No
Names.name ISO Name for the equipment. ISO or Participant name is required.
String No
Names.NameType.name
Name of the name type.
PARTICIPANTID
Enumeration
No
MessagePayload.Participant.MktOrganisation No
mRID Market Oragnisation ID String No
9.6.2 Schema (requestFacilityOutageDefinition_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
9.6.3 Example XML File (RequestFacilityOutageDefinition_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <RequestFacilityOutageDefinition xsi:schemaLocation="http://www.caiso.com/soa/RequestFacilityOutageDefinition_v1.xsd# RequestFacilityOutageDefinition_v1.xsd" xmlns="http://www.caiso.com/soa/RequestFacilityOutageDefinition_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2014-01-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <Participant> <MktOrganisation> <mRID>PCG2</mRID> </MktOrganisation> </Participant> <Facility> <Equipment> <mRID>12345</mRID> <Names> <name>LINE-A</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> </Equipment> <Equipment> <mRID>54321</mRID>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 98 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<Names> <name>LINE-B</name> <NameType> <name>PARTICIPANTID</name> </NameType> </Names> </Equipment> </Facility> </MessagePayload> </RequestFacilityOutageDefinition>
9.7 Request Facility Outage Response
9.7.1 Element Table
Element Data Description Type/ Length
Format/
Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published
dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.Contingency Yes
mRID Contingency Identifier String Yes
definitionEndDateTime End date/time of this definition DateTime No
definitionStartDateTime Start date/time of this definition DateTime No
MessagePayload.Contingency.ContingencyElement Yes
switchStatus Status of associated Switching Element String Yes
MessagePayload.Contingency.ContingencyElement.Equipment Yes
mRID The resource id for the Equipment. String Yes
name ISO Name for the equipment. ISO or Participant name is required.
String Yes
Names All Names of this identified Object Name(Complex Type)
No
MessagePayload.Contingency.Equipment No
mRID The resource id for the Equipment. String Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 99 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/
Length
Req’d
name ISO Name for the equipment. ISO or Participant name is required.
String Yes
Names All Names of this identified Object Name(Complex Type)
No
PSRType Custom classification for this power system String Yes
MessagePayload.Contingency.EquipmentContainer No
mRID The resource id for the Equipment. String Yes
name ISO Name for the equipment. ISO or Participant name is required.
String Yes
Names All Names of this identified Object Name(Complex Type)
No
PSRType Custom classification for this power system
ACLINESEGMENT, BUSBARSECTION, CONFORMLOAD, DCLINESEGMENT, ENERGYCONSUMER, NONCONFORMLOAD, POWERTRANSFORMER, SERIESCOMPENSATOR, SHUNTCOMPENSATOR, STATICVARCOMPENSATOR
Enumeration
Yes
9.7.2 Schema (FacilityOutageDefinitionResults_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
9.7.3 Example XML File (FacilityOutageDefinitionResults_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <FacilityOutageDefinitionResults xmlns="http://www.caiso.com/soa/FacilityOutageDefinitionResults_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.caiso.com/soa/FacilityOutageDefinitionResults_v1.xsd# FacilityOutageDefinitionResults_v1.xsd "> <MessageHeader> <TimeDate>2014-01-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <Contingency> <mRID>ContingnecyId: 1234</mRID> <definitionEndDateTime>2014-12-31T12:00:00</definitionEndDateTime>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 100 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<definitionStartDateTime>2015-12-31T12:00:00</definitionStartDateTime> <ContingencyElement> <switchStatus>Closed</switchStatus> <Equipment> <mRID>12345</mRID> <name>LineA</name> <Names> <name>AlternativeName for LineA</name> <NameType> <name>name</name> </NameType> </Names> </Equipment> </ContingencyElement> <Equipment> <mRID>54321</mRID> <name>LineB</name> <Names> <name>Alternative Name for Line-B</name> <NameType> <name>name</name> </NameType> </Names> <PSRType> <type>ACLINESEGMENT</type> </PSRType> </Equipment> </Contingency> </MessagePayload> </FacilityOutageDefinitionResults>
9.8 Fault Return
For Fault return see section Fault Return
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 101 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
10. Withdraw Outage Change Request
10.1 Overview
Outage Coordinators can withdraw a previously submitted but not yet approved change request for generator and transmission outage.
10.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable The Outage coordinator can use the user interface or call the ISO directly to withdraw the change request.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
10.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
10.3.1 Retrieve Facility Outage Definition
sd Withdraw Outage Change Request
Outage Coordinator
OMS
withdrawOutageChangeRequest()
withdrawOutagechagneRequestStandardOutput()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 102 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
10.4 Operational Details
Each service has one operation with three message types.
10.4.1 Retrieve Facility Outage Definition
Operation Message
Types
Message WSDL XSD
withdrawOutageCh
angeRequest
Input withdrawOutageChan
geRequest
withdrawOutageChan
geRequest_v1.wsdl
withdrawOutageChangeRequest
_v1.xsd
Output withdrawOutageChan
geRequestResponse
OutageStandardOutput_v1.xsd
Fault faultReturnType StandardOutput.xsd
10.5 WSDL
10.5.1 withdrawOutageChangeRequest_v1.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
10.6 Withdraw Outage ChangeRequest
10.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.OutageChangeRequest Yes
mRID ISO identifier for the change request. String Yes
10.6.2 Schema (WithdrawOutageChangeRequest_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
10.6.3 Example XML File (WithdrawOutageChangeRequest_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <WithdrawOutageChangeRequest xsi:schemaLocation="http://www.caiso.com/soa/WithdrawOutageChangeRequest_v1.xsd# WithdrawOutageChangeRequest_v1.xsd"
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 103 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
xmlns="http://www.caiso.com/soa/WithdrawOutageChangeRequest_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <OutageChangeRequest> <mRID>912345677</mRID> </OutageChangeRequest> <OutageChangeRequest> <mRID>912345679</mRID> </OutageChangeRequest> </MessagePayload>
</WithdrawOutageChangeRequest>
10.7 Withdraw Outage Change Request Standard Output
10.7.1 Element Table
See OutageStandardOutput
10.7.2 Schema (StandardOutput_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
10.7.3 Example XML File (WithdrawOutageChangeRequestStandardOutput_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <OutageStandardOutput xsi:schemaLocation="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd# OutageStandardOutput_v1.xsd" xmlns="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2014-01-03T11:00:00Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EventLog> <Event> <id>1</id> <result>Success</result> </Event> <Outage> <mRID>123456789</mRID> <mktOrgOutageID>MarketOutageId-1234</mktOrgOutageID> <OutageValidation> <submitStatus>ACCEPTED</submitStatus> <OutageResult>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 104 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<mRID>1</mRID> <description>Validated</description> <status>ACKNOWLEDGED</status> <type>INFO</type> </OutageResult> </OutageValidation> </Outage> <Service> <id>12345</id> <name>withdrawOutagechangeRequest_v1</name> </Service> </EventLog> </MessagePayload> </OutageStandardOutput>
10.8 Fault Return
For Fault return see section Fault Return
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 105 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
11. Acknowledge Outage Warning
11.1 Overview
Outage Coordinators must acknowledge review of warnings associated with outages. For example, when a transmission outage trumps a previously submitted outage.
11.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable No impact, not time critical.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
11.3 Use Model
The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications).
11.3.1 Acknowledge Outage Warning
sd Acknowledge Outage Warning
Outage Coordinator
OMS
AcknowledgeOutageWarning()
AcknowledgeOutageWarningStandardOutput()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 106 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
11.4 Operational Details
Each service has one operation with three message types.
11.4.1 Retrieve Facility Outage Definition
Operation Message
Types
Message WSDL XSD
AcknowledgeOu
tageWarning
Input AcknowledgeOutageW
arning
acknowledgeOutageW
arning_v1.wsdl
AcknowledgeOutageWarning_v
1.xsd
Output AcknowledgeOutageW
arningStandardOutput
OutageStandardOutput_v1.xsd
Fault faultReturnType StandardOutput.xsd
11.5 WSDL
AcknowledgeOutageWarning_v1.wsdl
11.5.1 Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
11.6 Acknowledge Outage Warning
11.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.OutageResult Yes
mRID ISO identifier for the outage warning. String Yes
11.6.2 Schema (AcknowledgeOutageWarning_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
11.6.3 Example XML File (AcknowledgeOutageWarning_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <AcknowledgeOutageWarning xsi:schemaLocation="http://www.caiso.com/soa/AcknowledgeOutageWarning_v1.xsd#
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 107 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
AcknowledgeOutageWarning_v1.xsd" xmlns="http://www.caiso.com/soa/AcknowledgeOutageWarning_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2001-12-17T09:30:47Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <OutageResult> <mRID>Outage_Result_Id_1</mRID> </OutageResult> <OutageResult> <mRID>Outage_Result_Id_2</mRID> </OutageResult> </MessagePayload>
</AcknowledgeOutageWarning>
11.7 Acknowledge Outage Warning Standard Output
11.7.1 Element Table
See OutageStandardOutput
11.7.2 Schema (StandardOutput_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
11.7.3 Example XML File (AcknowledgeOutageWarningStandardOutput_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <OutageStandardOutput xsi:schemaLocation="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd# OutageStandardOutput_v1.xsd" xmlns="http://www.caiso.com/soa/OutageStandardOutput_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2014-01-03T11:00:00Z</TimeDate> <Source>CompanyA</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <EventLog> <Event> <id>1</id> <result>Success</result> </Event> <Outage> <mRID>123456789</mRID> <mktOrgOutageID>MarketOutageId-1234</mktOrgOutageID> <OutageValidation> <submitStatus>ACCEPTED</submitStatus>
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 108 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
<OutageResult> <mRID>1</mRID> <description>Validated</description> <status>ACKNOWLEDGED</status> <type>INFO</type> </OutageResult> </OutageValidation> </Outage> <Service> <id>12345</id> <name>acknowledgeOutageWarning_v1</name> </Service> </EventLog> </MessagePayload> </OutageStandardOutput> For Fault return see section Fault Return
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 109 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
12. Outage Status Update
12.1 Overview
Outage Coordinators, after registering their endpoint, can receive a message when an outage status changes.
12.2 Service Level Agreement
Service availability Service level goal is 99.9%.
Expected size of payload (average and maximum)
Variable (1KB to 1MB+)
Expected frequency (average and maximum)
On demand (50/day – 200/day).
Longest time the service can be unavailable before business is impacted
30 minutes
Business impact if is unavailable Messages will be sent as soon as service is restored.
Expected response time for the service Variable (.1 sec – 30 sec)
Expected time to exchange Variable
12.3 Use Model
The sequence diagram below describes the service level interactions between the ISO Outage Management System (OMS) and the Outage Coordinator systems. These messages are sent from the OMS so the security model is different than the regular B2B services. These messages use one way authentication between the OMS hosting service and the participant’s servers.
12.3.1 Acknowledge Outage Warning
sd Outage Status Update
OMS
Outage Coordinator
OutageStatusUpdate()
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 110 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
12.4 Operational Details
Each service has one operation with three message types.
12.4.1 Outage Status Update
Operation Message
Types
Message WSDL XSD
OutageStatusUp
date
Input OutageStatusUpdate OutageStatusUpdate_v
1.wsdl
OutageStatusUpdate _v1.xsd
Output OutageStatusUpdateRe
sponse
StandardOutput.xsd
Fault faultReturnType StandardOutput.xsd
12.5 WSDL
12.5.1 OutageStatusUpdate_v1.wsdl
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
12.6 Outage Status Update
12.6.1 Element Table
Element Data Description Type/ Length
Format/ Length
Req’d
Message Header No
TimeDate The dateTime, in UTC, when the payload is published dateTime Yes
Source The source of the data String Yes
Version Subversion of the XSD:
Initial version will be v20141001
String Yes
MessagePayload.Outage Yes
mRID ISO identifier for the outage. String Yes
isFinalApprovalReq Notification of Final Approval Required Yes/No Yes
mktOrgOutageID The participant’s identifier for the outage String No
outageStatus The new status of the outage String Yes
outageStatusReason The reason for the change in status String No
MessagePayload.Outage.OutageChangeRequest No
mRID Identifier for the change request String Yes
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 111 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
Element Data Description Type/ Length
Format/ Length
Req’d
Action Original action for the change request String Yes
ActionReason Reason For change OutageChangeRequestActionReason ( Enumeration fo string values)
No
ActionSubType For update, define the type of update. OutageChangeRequestActionSubType ( Enumeration fo string values)
No
Status Status of the change request String Yes
MessagePayload.Outage.OutageGroup No
mRID Identifier for a group the outage belongs to String Yes
MessagePayload.Outage.OutageValidation No
MessagePayload.Outage.OutageValidation.OutageResult Yes
mRID ID assigned to the result by the ISO String Yes
description Description of result returned String Yes
status Status of the result: ACKNOWLEDGED. UNACKNOWLEDGED. This is applicable only to warnings.
String Yes
Type Type of result: ERROR, INFO, WARNING String Yes
12.6.2 Schema (OutageStatusUpdate_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
12.6.3 Example XML File (OutageStatusUpdate_v1.xml)
<?xml version="1.0" encoding="UTF-8"?> <!--Sample XML file generated by XMLSpy v2013 (http://www.altova.com)--> <OutageStatusUpdate xsi:schemaLocation="http://www.caiso.com/soa/OutageStatusUpdate_v1.xsd#
cczxxz
Owner: Nallagangu, Sunil Program Office
ISO Public
Doc ID: GNFDMDEHU6BB-46-46 Page 112 of 112
Technology
Template Version: 1.4
Document
Version: 1.7
Outage Management System ISO Interface Specification Date Created: 12/27/2013
OutageStatusUpdate_v1.xsd" xmlns="http://www.caiso.com/soa/OutageStatusUpdate_v1.xsd#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MessageHeader> <TimeDate>2014-02-17T09:30:47Z</TimeDate> <Source>OMS</Source> <Version>v20141001</Version> </MessageHeader> <MessagePayload> <Outage> <mRID>123456789</mRID> <isFinalApprovalReq>NO</isFinalApprovalReq> <mktOrgOutageID>P123456789</mktOrgOutageID> <outageStatus>CANCELLED</outageStatus> <outageStatusReason>Cancelled by Participant</outageStatusReason> <OutageChangeRequest> <mRID>987654321</mRID> <action>CANCEL</action> <status>ACCEPTED</status> </OutageChangeRequest> </Outage> </MessagePayload> </OutageStatusUpdate>
12.7 Outage Status Update
12.7.1 Element Table
See StandardOutput
12.7.2 Schema (StandardOutput_v1.xsd)
Location: http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx
12.7.3 Example XML File
The ISO would look for any successful response code.
12.8 Fault Return
For Fault return see section Fault Return