Outage Creation
Outage Creation
The request message for outage creation or update would use the following message fields:
Message Element | Value |
---|---|
Header/Verb | create |
Header/Noun | OutageSet |
Header/Source | Market participant ID |
Header/UserID | ID of user |
Payload | OutageSet |
The corresponding response messages would use the following message fields:
Message Element | Value |
---|---|
Header/Verb | reply |
Header/Noun | OutageSet |
Header/Source | ERCOT |
Reply/ReplyCode | Reply code, success=OK, error=ERROR or FATAL |
Reply/Error | Error message, if error encountered |
Payload | OutageSet |
An Outage Scheduler mRID is constructed and returned in the payload of the response (included in ResourceOutage or Equipment Outage) as part of the OutageSet structure in the following format
*mRID:<QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>*
OutageIdent is assigned by Outage Scheduler Application.
The structure of the OutageSet payload is described by the following diagram. This leverages the structure of an Outage defined later in this section:
The high-level structure of an Outage record is described by the following diagram:
Within the OutageInfo substructure, the outage type, and state, status, and nature of work are identified.
Valid outage type codes include:
-
FR - Forced Outage
-
M1 - Maintenance Level 1
-
M2 - Maintenance Level 2
-
M3 - Maintenance Level 3
-
OP - Planned Outage Non-Reliability with Opportunity
-
PL - Planned Outage Reliability
-
RS - Forced Outage with Remedial Switching Action
-
SM - Simple Transmission Outage
-
UE - Forced Outage with Unavoidable Extension
-
FE - Forced Outage with Forced Extension
-
RO - Rescheduled Outage
The valid state codes include:
-
ENYS : Entered Not Yet Submitted
-
Recvd: Received at ERCOT
-
Study : Study
-
Rejct : Rejected
-
Accpt: Accepted
-
Apprv: Approved
-
Active: Active
-
AExt: Active Extension
-
PotOp: Potential Opportunity
-
Withd: Withdrawn
-
Cancl : Canceled
-
PComp: Pending Completion
-
ExpOp: Expired Opportunity
-
CompEd: Completed - Editable
-
CompNE: Completed - Not Editable
The valid status codes include:
-
ENYS: Entered Not Yet Submitted
-
RatE: Received at ERCOT
-
Accpt: Accepted
-
Apprv: Approved
-
Rejct: Rejected
-
Study: Selected for Study
-
Withd: Withdrawn
-
ExpOp: ExpiredOpportunity
-
Cancl: Canceled
The valid Nature of Work codes for Resource Outages include:
-
BS : Black Start Test
-
BO : Boroscope
-
CI : Combustion Inspection and Repair
-
CW : Cooling Water Problems/Repairs
-
EX : Exhaust Problems/Repairs
-
FW : Feedwater Problems/Repairs
-
FL : Fuel Limitation/Lack of Fuel Availability
-
FP : Fuel Problems/Repairs
-
GW : Gas Company Pipeline Work
-
IP : Inlet Air Problems/Repairs
-
LS : Lack of Steam Load Availability
-
MO : Mothballed
-
NE : New Equipment Energization
-
OT : Other
-
OV : Overhaul
-
OE : Retirement of Old Equipment
-
SE : Seasonal Resource
-
TW : Steam Turbine Limited/Unavailable Due to CT/GT Work
-
TL : Tube Leak
-
VR : Turbine/Generator Vibration/Repair
-
UN : Unknown
The valid Nature of Work codes for Transmission Outages include:
-
AO : Associated Equipment Outage
-
BM : Breaker Maintenance
-
BR : Breaker Repair/Replace
-
LM : Line Maintenance
-
LR : Line Rebuild/Upgrade
-
NE : New Equipment Energization
-
OT : Other
-
RW : Relay Work - See Notes
-
HS : Repair Hot Spot
-
DR : Repair/Replace Damaged Equipment
-
RE : Replace Equipment
-
OE : Retirement of Old Equipment
-
SM : Switch Maintenance
-
SR : Switch Repair/Replace
-
TC : Telcom Work
-
PR : Third Party Request
-
TM : Transformer Maintenance
-
TR : Transformer Repair/Replace
-
TT : Transformer Testing
-
UN : Unknown
As shown by the sub-structures, details are provided to reflect a resource outage or a transmission outage. For each resource, a name and resource type must be supplied. The resource is identified by its short name, and the resource type is one of ‘UN’, ‘LR’, ‘DGR’ or ‘DESR’. For each transmission equipment, a name and a transmission type must be supplied. The equipment is identified by its short name and the equipment type is one of ‘LN’, ‘DCLN’, ‘DSC’, ‘CB’, ‘XF’, ‘CP’, ‘SR’, ‘SVC’, ‘LD’, ‘SC’, ‘SCM’.
As shown by the sub-structures, details are provided to reflect a resource outage or a transmission outage. For each resource, a name and resource type must be supplied. The resource is identified by its short name, and the resource type is one of ‘UN’, ‘LR’, ‘DGR’, ‘DESR’ or ‘ESR’. For each transmission equipment, a name and a transmission type must be supplied. The equipment is identified by its short name and the equipment type is one of ‘LN’, ‘DCLN’, ‘DSC’, ‘CB’, ‘XF’, ‘CP’, ‘SR’, ‘SVC’, ‘LD’, ‘SC’, ‘SCM’.
Notes provided may be types as ‘General’, ‘Supporting’ or ‘RASPS’.
On submission, the following table describes the items used for an Outage creation:
Element Req? Data type Description Values OutageInfo/
outageTypeY string Type of Outage FR,M1,M2,M3,OP,PL, RS,SM,UE,FE, RO OutageInfo/
participantN string Outage Participant OutageInfo/
versionIdN string It is automatically generated by the system, it is used for keeping an audit trail of all changes made to an Outage. OutageInfo/
stateY string The State of the Outage, taken from ENYS, Recvd, Study, Rejct, Accpt, Apprv, Active, FExt, UExt, Withd, Cancl, ExpOp, CompEd, CompNE, PComp ENSYS,Recvd,Study,Rejctd Accptd,Active,FExt,UExt,Withdr Cancld,PComp,ExpOp,CompEd CompNE OutageInfo/
statusN string The Status of the Outage, taken from ENYS, RetE, Study, Rejct, Apprv, Accpt, Withd, Cancl, ExpOp. ENYS,RatE,Accpt,Apprv,Rejct, Study,Withd,Cancl,Pendg,Compl OutageInfo/
previousStateN string The previous value of the Outage State, used by the State Machine. ENSYS,Recvd,Study,Rejctd Accptd,Active,FExt,UExt,Withdr Cancld,PComp, ExpOp ,CompEd CompNE OutageInfo/
previousStatusN string The previous value of the Outage Status, used by the State Machine. ENYS,RatE,Accpt,Apprv,Rejct, Study,Withd,Cancl,Pendg,Compl OutageInfo/
lastModifiedByN string Creator or responsible for last update OutageInfo/
warningFlagN Boolean Warning Exists true/false OutageInfo/
warningAcknowledgeN Boolean Warning Acknowledge true/false OutageInfo/
warningMessageN string Warnings are part of the xml response. The message indicates the issue to be resolved, they are fixed messages with integrated variables for customizing the message for the Outage. The free-form text of the message. OutageInfo/
highImpactOutageN boolean A Boolean indicating if the Outage includes equipment on the High Impact Transmission Elements (HITE) list. Output only; Returned for single outages. For Group outages, see Group/GroupTransmissionOutage below. OutageInfo/
greater90DaysN boolean A Boolean indicating if the Outage is greater than 90 days in advance. Output only; Returned for single outages. For Group outages, see Group/GroupTransmissionOutage below. OutageInfo/
Requestor/
nameN string Contact name OutageInfo/
Requestor/
userFullNameY string Full name of requestor UserFullName is required on a Submit, Update and Cancel. Note: the element is defined as optional in the XSD. OutageInfo/
Requestor/
primaryContactN string Primary Contact phone no. OutageInfo/
Requestor/
SecondaryContactN string Secondary Contact Phone No. OutageInfo/
Requestor/
tertiaryContactN string Tertiary Contact Phone No. OutageInfo/
requestDateN date Request Date OutageInfo/
DisclaimerY String Outage disclaimer Free-form text OutageInfo/
disclaimerAckY Boolean Outage disclaimer acknowledge flag true/false Group/
groupIdN string This is the ability to group outages. A group outage has a Group ID. Each outage is still a separate outage with an outage ID as well. The Requestor can add to a group when creating the outage request. Once the outages have been submitted they can be removed from the group, creating an independent outage. Once the group has been submitted the requestor can’t add to it. The grouping will be used in the EMS-Outage Evaluation tool. Outage grouping name An Outage may be a member of an Outage Group. An Outage Group must have at least one and can have more than one Outage. groupId Pattern groupId will conform to the following three token pattern: <ShortName>.OTG.<groupId> groupId Example For example, the XML document may contain the following groupId value: <ns1:groupId>ShortName.OTG.1930</ns1:groupId> Cancel Outage Reference In this example, “1930” is the portion of the groupId token set that should be used when referring to this grouped outage in a cancel or get request. Group/
nameY string Outage Group Name Group/
ResourceOutage/
operatingCompanyY string Group Resource Outage Operating Company Name Group/
ResourceOutage/
stationY string Group Resource Outage Station Name Group/
ResourceOutage/
equipmentNameY string This is the name of a Resource that is a Designated Resource for this Opportunity Outage. Group/
ResourceOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: {123AE789-4477-4A1B-8D09-E41615AF38EC} Group/
ResourceOutage/
resourceTypeY string This is the type of a Resource that is a Designated Resource for this Opportunity Outage UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR) Group/
ResourceOutage/
HSLY Decimal Group Outage Resource HSL Group/
ResourceOutage/
LSLY Decimal Group Outage Resource LSL Group/
ResourceOutage/
mRIDN string Unique identifier for an outage. mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> Group/
ResourceOutage/
natureOfWorkY string This is a description of the nature of the work to be performed during the Outage. The allowable values for this field are stated above. Group/
GroupTransmissionOutage/
OperatingCompanyY string Group/
GroupTransmissionOutage/
equipmentNameY string Group/
GroupTransmissionOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: Group/
GroupTransmissionOutage/
transmissionTypeY string This is the type of Equipment subject to removal from service as a consequence of the Outage: e.g. CB, LINE, etc. Group/
GroupTransmissionOutage/
fromStationY string The name of the “From” Station in which an Equipment resides for all lines. Group/
GroupTransmissionOutage/
toStationN string The name of the “To” Station in which an Equipment resides for all lines. Group/
GroupTransmissionOutage/
highImpactOutageN boolean A Boolean indicating if the Outage includes equipment on the High Impact Transmission Elements (HITE) list. Output only; Returned for group outages. For single outages, see OutageInfo above. Group/
GroupTransmissionOutage/
greater90DaysN boolean A Boolean indicating if the Outage is greater than 90 days in advance. Output only; Returned for group outages. For single outages, see OutageInfo above. Group/
GroupTransmissionOutage/
normalStateN string Equipment Normal State Output only Group/
GroupTransmissionOutage/
outageStateN string This field, which is pertinent (and required) only for switching devices, contains the state of the device when taken out of service: OPEN or CLOSED. This field is the opposite of the Normal State of the Equipment entity. “C’,”O” or “” Group/
GroupTransmissionOutage/
voltageN Decimal Equipment Outage Voltage Group/
GroupTransmissionOutage/
projectNameN string Equipment Outage NOMCR Group/
GroupTransmissionOutage/
emergencyRestorationTimeY string Eq. Outage Emer Restoration Time Group/
GroupTransmissionOutage/
mRIDN string Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> Group/
GroupTransmissionOutage/
natureOfWorkY string Eq. Outage Nature of Work Group/
Opportunity/
opportunityDuration/
daysN unsigned Byte For Opportunity Outages, the outage no. of days. Positive no. Group/
Opportunity/
opportunityDuration/
hoursN unsigned Byte For Opportunity Outages, the outage no. of hours Positive no. Group/
Opportunity/
endY DateTime For Opportunity Outages, the outage end time Date Time Group/
Opportunity/
designatedResource/
equipmentNameY string This is the Resource name of a Resource that has been designated to an Opportunity Group/
Opportunity/
designatedResource/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: {123AE789-4477-4A1B-8D09-E41615AF38EC} Group/
Opportunity/
designatedResource/
resourceTypeY string This is the Resource type of a Resource that has been designated to an Opportunity UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR) Group/
Opportunity/
designatedResource/
stationY string This is the station name of a Resource that has been designated to an Opportunity Group/
Opportunity/
designatedResource/
HSLY Decimal Group/
Opportunity/
desgOutageIdentN string Designated Resource Outage Identifier corresponding to a valid TOO ( Transmission Opportunity Outage). Not required for outage create transaction. Outage Schedule will populate this field in OS query response Group/
Opportunity/
desgOutageStartN DateTime Designated Resource outage start dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response Group/
Opportunity/
desgOutageEndN DateTime Designated Resource outage End dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response ResourceOutage/
operatingCompanyY string ResourceOutage/
stationY string This is the station name of a Resource that is a Designated Resource for this Outage. ResourceOutage/
equipmentNameY string This is the name of a Resource that is a Designated Resource for this Outage. ResourceOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: ResourceOutage/
resourceTypeN string This is the type of a Resource that is a Designated Resource for this Outage. UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR) ResourceOutage/
HSLY Decimal Resource Outage HSL ResourceOutage/
LSLY Decimal Resource Outage LSL ResourceOutage/
mRIDN string Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> ResourceOutage/
natureOfWorkY string Resource Outage Nature of Work. . The allowable values for this field are stated above. TransmissionOutage/
operatingCompanyY string TransmissionOutage/
equipmentTypeN string Allowed values for Transmission equipment types as stated above. TransmissionOutage/
equipmentNameY string The name of the Equipment that can be the subject of an Outage. TransmissionOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: _{123AE789-4477-4A1B-8D09-E41615AF38EC} TransmissionOutage/
transmissionTypeY string The Type of the Transmission Equipment that can be the subject of an Outage. TransmissionOutage/
fromStationY string This is the name of the Station in which an Equipment resides for all equipment types other than lines. For lines this refers to the “From” station TransmissionOutage/
toStationN string This is the name of the “To” Station in which an Equipment resides for all lines. TransmissionOutage/
normalStateN string This field, which is pertinent only for switching devices, contains the normal state of the device: OPEN or CLOSED. This field is the same as the Normal State of the Equipment entity. Output only TransmissionOutage/
outageStateN string This field, which is pertinent (and required) only for switching devices, contains the state of the device when taken out of service: OPEN or CLOSED. This field is the opposite of the Normal State of the Equipment entity. “C’,”O” or “” TransmissionOutage/
voltageN Decimal The voltage level at which the Equipment resides. For transformers it is the high side voltage level. TransmissionOutage/
projectNameN String TransmissionOutage/
emergencyRestorationTimeY positiveInteger This is the time in hours necessary to terminate the Outage and return the Equipment to service. TransmissionOutage/
mRIDN string Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> TransmissionOutage/
natureOfWorkY string TransmissionOutage/
Opportunity/
opportunityDuration/
daysN unsigned Byte For Opportunity Outages, the outage no. of days. Positive no. TransmissionOutage/
Opportunity/
opportunityDuration/
hoursN unsigned Byte For Opportunity Outages, the outage no. of hours Positive no. TransmissionOutage/
Opportunity/
opportunityEndY DateTime For Opportunity Outages, the outage end time Date Time TransmissionOutage/
Opportunity/
designatedResource/
equipmentNameY string This is the Resource name of a Resource that has been designated to an Opportunity TransmissionOutage/
Opportunity/
designatedResource/
equipmentIdentifierY String TransmissionOutage/
Opportunity/
designatedResource/
resourceTypeY String This is the Resource type of a Resource that has been designated to an Opportunity UN (Unit) or LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR) TransmissionOutage/
Opportunity/
designatedResource/
stationY String TransmissionOutage/
Opportunity/
designatedResource/
HSLY Decimal TransmissionOutage/
Opportunity/
designatedResource/
desgOutageIdentN String Designated Resource Outage Identifier corresponding to a valid TOO ( Transmission Opportunity Outage). Not required for outage create transaction. Outage Schedule will populate this field in OS query response TransmissionOutage/
Opportunity/
designatedResource/
desgOutageStartN dateTime Designated Resource outage start dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response TransmissionOutage/
Opportunity/
designatedResource/
desgOutageEndN dateTime Designated Resource outage End dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response Schedule/
plannedSartN dateTime This is the date/time at which the Outage is planned to start.
- Forced (Transmission and Resource) - Forced outages don’t have a Planned Start when created
- Transmission Opportunity outages (TOO). TOO’s doesn’t have a Planned Start or a Planned End when created
Schedule/
plannedEndN dateTime This is the date/time at which the Outage is planned to end. Schedule/
earliestStartN dateTime This is the earliest date/time at which the Outage may start. Schedule/
latestEndN dateTime This is the latest date/time at which the Outage may end. Schedule/
actualStartN dateTime This is the actual date/time at which the Outage started. Schedule/
actualEndN dateTime This is the actual date/time at which the Outage ended. Schedule/
new_plannedStartN dateTime This is the proposed date/time at which an Unavoidable Extension may start. Schedule/
new_plannedEndN dateTime This is the proposed date/time at which an Unavoidable Extension may end. Schedule/
new_earliestStartN dateTime This is the proposed earliest date/time at which a Resource Opportunity Outage may start. Schedule/
new_latestEndN dateTime This is the proposed latest date/time at which a Resource Opportunity Outage may end. Recurrence/
datesList/
dates/
mRIDN String Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> Recurrence/
datesList/
dates/
plannedStartY Date Planned start date of outage recurrence Recurrence/
datesList/
dates/
plannedEndY Date Planned End date of outage recurrence Recurrence/
datesList/
dates/
earliestStartY Date Earliest start date of outage recurrence Recurrence/
datesList/
dates/
latestEndY Date Latest Planned End date of outage recurrence OSNotes/
RequestorNotes/
Note/
createdTimeY string There are three sections that the requestor can enter notes, Requestor Notes, Supporting Information, and Remedial Action or Special Protection System notes. Notes are required for some outage types but not all. They are not required when the outage is submitted but are required for some outages to be completed. There is another section for reviewer notes. This is for ERCOT to enter notes and the MP can only read them. OSNotes/
RequestorNotes/
Note/
createdByY string OSNotes/
RequestorNotes/
Note/
companyY string OSNotes/
RequestorNotes/
Note/
commentY string OSNotes/
ReviewerNotes/
Note/
createdTimeY string OSNotes/
ReviewerNotes/
Note/
createdByY string OSNotes/
ReviewerNotes/
Note/
companyY string OSNotes/
ReviewerNotes/
Note/
commentY string OSNotes/
SupportingNotes/
Note/
createdTimeY string OSNotes/
SupportingNotes/
Note/
createdByY string OSNotes/
SupportingNotes/
Note/
companyY string OSNotes/
SupportingNotes/
Note/
commentY string OSNotes/
RASPSNotes/
Note/
createdTimeY string OSNotes/
RASPSNotes/
Note/
createdByY string OSNotes/
RASPSNotes/
Note/
companyY string OSNotes/
RASPSNotes/
Note/
commentY string Error/
severityN string Severity of Error Generated Error/
areaN string Area of generated error Error/
intervalN string Error/
textY string Error Text
Element Req? Data type Description Values OutageInfo/
outageTypeY string Type of Outage FR,M1,M2,M3,OP,PL, RS,SM,UE,FE, RO OutageInfo/
participantN string Outage Participant OutageInfo/
versionIdN string It is automatically generated by the system, it is used for keeping an audit trail of all changes made to an Outage. OutageInfo/
stateY string The State of the Outage, taken from ENYS, Recvd, Study, Rejct, Accpt, Apprv, Active, FExt, UExt, Withd, Cancl, ExpOp, CompEd, CompNE, PComp ENSYS,Recvd,Study,Rejctd Accptd,Active,FExt,UExt,Withdr Cancld,PComp,ExpOp,CompEd CompNE OutageInfo/
statusN string The Status of the Outage, taken from ENYS, RetE, Study, Rejct, Apprv, Accpt, Withd, Cancl, ExpOp. ENYS,RatE,Accpt,Apprv,Rejct, Study,Withd,Cancl,Pendg,Compl OutageInfo/
previousStateN string The previous value of the Outage State, used by the State Machine. ENSYS,Recvd,Study,Rejctd Accptd,Active,FExt,UExt,Withdr Cancld,PComp, ExpOp ,CompEd CompNE OutageInfo/
previousStatusN string The previous value of the Outage Status, used by the State Machine. ENYS,RatE,Accpt,Apprv,Rejct, Study,Withd,Cancl,Pendg,Compl OutageInfo/
lastModifiedByN string Creator or responsible for last update OutageInfo/
warningFlagN Boolean Warning Exists true/false OutageInfo/
warningAcknowledgeN Boolean Warning Acknowledge true/false OutageInfo/
warningMessageN string Warnings are part of the xml response. The message indicates the issue to be resolved, they are fixed messages with integrated variables for customizing the message for the Outage. The free-form text of the message. OutageInfo/
highImpactOutageN boolean A Boolean indicating if the Outage includes equipment on the High Impact Transmission Elements (HITE) list. Output only; Returned for single outages. For Group outages, see Group/GroupTransmissionOutage below. OutageInfo/
greater90DaysN boolean A Boolean indicating if the Outage is greater than 90 days in advance. Output only; Returned for single outages. For Group outages, see Group/GroupTransmissionOutage below. OutageInfo/
Requestor/
nameN string Contact name OutageInfo/
Requestor/
userFullNameY string Full name of requestor UserFullName is required on a Submit, Update and Cancel. Note: the element is defined as optional in the XSD. OutageInfo/
Requestor/
primaryContactN string Primary Contact phone no. OutageInfo/
Requestor/
SecondaryContactN string Secondary Contact Phone No. OutageInfo/
Requestor/
tertiaryContactN string Tertiary Contact Phone No. OutageInfo/
requestDateN date Request Date OutageInfo/
DisclaimerY String Outage disclaimer Free-form text OutageInfo/
disclaimerAckY Boolean Outage disclaimer acknowledge flag true/false Group/
groupIdN string This is the ability to group outages. A group outage has a Group ID. Each outage is still a separate outage with an outage ID as well. The Requestor can add to a group when creating the outage request. Once the outages have been submitted they can be removed from the group, creating an independent outage. Once the group has been submitted the requestor can’t add to it. The grouping will be used in the EMS-Outage Evaluation tool. Outage grouping name An Outage may be a member of an Outage Group. An Outage Group must have at least one and can have more than one Outage. groupId Pattern groupId will conform to the following three token pattern: <ShortName>.OTG.<groupId> groupId Example For example, the XML document may contain the following groupId value: <ns1:groupId>ShortName.OTG.1930</ns1:groupId> Cancel Outage Reference In this example, “1930” is the portion of the groupId token set that should be used when referring to this grouped outage in a cancel or get request. Group/
nameY string Outage Group Name Group/
ResourceOutage/
operatingCompanyY string Group Resource Outage Operating Company Name Group/
ResourceOutage/
stationY string Group Resource Outage Station Name Group/
ResourceOutage/
equipmentNameY string This is the name of a Resource that is a Designated Resource for this Opportunity Outage. Group/
ResourceOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: {123AE789-4477-4A1B-8D09-E41615AF38EC} Group/
ResourceOutage/
resourceTypeY string This is the type of a Resource that is a Designated Resource for this Opportunity Outage UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR), Energy Storage Resource (ESR) Group/
ResourceOutage/
HSLY Decimal Group Outage Resource HSL Group/
ResourceOutage/
LSLY Decimal Group Outage Resource LSL Group/
ResourceOutage/
mRIDN string Unique identifier for an outage. mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> Group/
ResourceOutage/
natureOfWorkY string This is a description of the nature of the work to be performed during the Outage. The allowable values for this field are stated above. Group/
GroupTransmissionOutage/
OperatingCompanyY string Group/
GroupTransmissionOutage/
equipmentNameY string Group/
GroupTransmissionOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: Group/
GroupTransmissionOutage/
transmissionTypeY string This is the type of Equipment subject to removal from service as a consequence of the Outage: e.g. CB, LINE, etc. Group/
GroupTransmissionOutage/
fromStationY string The name of the “From” Station in which an Equipment resides for all lines. Group/
GroupTransmissionOutage/
toStationN string The name of the “To” Station in which an Equipment resides for all lines. Group/
GroupTransmissionOutage/
highImpactOutageN boolean A Boolean indicating if the Outage includes equipment on the High Impact Transmission Elements (HITE) list. Output only; Returned for group outages. For single outages, see OutageInfo above. Group/
GroupTransmissionOutage/
greater90DaysN boolean A Boolean indicating if the Outage is greater than 90 days in advance. Output only; Returned for group outages. For single outages, see OutageInfo above. Group/
GroupTransmissionOutage/
normalStateN string Equipment Normal State Output only Group/
GroupTransmissionOutage/
outageStateN string This field, which is pertinent (and required) only for switching devices, contains the state of the device when taken out of service: OPEN or CLOSED. This field is the opposite of the Normal State of the Equipment entity. “C’,”O” or “” Group/
GroupTransmissionOutage/
voltageN Decimal Equipment Outage Voltage Group/
GroupTransmissionOutage/
projectNameN string Equipment Outage NOMCR Group/
GroupTransmissionOutage/
emergencyRestorationTimeY string Eq. Outage Emer Restoration Time Group/
GroupTransmissionOutage/
mRIDN string Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> Group/
GroupTransmissionOutage/
natureOfWorkY string Eq. Outage Nature of Work Group/
Opportunity/
opportunityDuration/
daysN unsigned Byte For Opportunity Outages, the outage no. of days. Positive no. Group/
Opportunity/
opportunityDuration/
hoursN unsigned Byte For Opportunity Outages, the outage no. of hours Positive no. Group/
Opportunity/
endY DateTime For Opportunity Outages, the outage end time Date Time Group/
Opportunity/
designatedResource/
equipmentNameY string This is the Resource name of a Resource that has been designated to an Opportunity Group/
Opportunity/
designatedResource/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: {123AE789-4477-4A1B-8D09-E41615AF38EC} Group/
Opportunity/
designatedResource/
resourceTypeY string This is the Resource type of a Resource that has been designated to an Opportunity UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR), Energy Storage Resource (ESR) Group/
Opportunity/
designatedResource/
stationY string This is the station name of a Resource that has been designated to an Opportunity Group/
Opportunity/
designatedResource/
HSLY Decimal Group/
Opportunity/
desgOutageIdentN string Designated Resource Outage Identifier corresponding to a valid TOO ( Transmission Opportunity Outage). Not required for outage create transaction. Outage Schedule will populate this field in OS query response Group/
Opportunity/
desgOutageStartN DateTime Designated Resource outage start dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response Group/
Opportunity/
desgOutageEndN DateTime Designated Resource outage End dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response ResourceOutage/
operatingCompanyY string ResourceOutage/
stationY string This is the station name of a Resource that is a Designated Resource for this Outage. ResourceOutage/
equipmentNameY string This is the name of a Resource that is a Designated Resource for this Outage. ResourceOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: ResourceOutage/
resourceTypeN string This is the type of a Resource that is a Designated Resource for this Outage. UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR), Energy Storage Resource (ESR) ResourceOutage/
HSLY Decimal Resource Outage HSL ResourceOutage/
LSLY Decimal Resource Outage LSL ResourceOutage/
mRIDN string Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> ResourceOutage/
natureOfWorkY string Resource Outage Nature of Work. . The allowable values for this field are stated above. TransmissionOutage/
operatingCompanyY string TransmissionOutage/
equipmentTypeN string Allowed values for Transmission equipment types as stated above. TransmissionOutage/
equipmentNameY string The name of the Equipment that can be the subject of an Outage. TransmissionOutage/
equipmentIdentifierY string RDFID used for uniquely identifying equipment Example: _{123AE789-4477-4A1B-8D09-E41615AF38EC} TransmissionOutage/
transmissionTypeY string The Type of the Transmission Equipment that can be the subject of an Outage. TransmissionOutage/
fromStationY string This is the name of the Station in which an Equipment resides for all equipment types other than lines. For lines this refers to the “From” station TransmissionOutage/
toStationN string This is the name of the “To” Station in which an Equipment resides for all lines. TransmissionOutage/
normalStateN string This field, which is pertinent only for switching devices, contains the normal state of the device: OPEN or CLOSED. This field is the same as the Normal State of the Equipment entity. Output only TransmissionOutage/
outageStateN string This field, which is pertinent (and required) only for switching devices, contains the state of the device when taken out of service: OPEN or CLOSED. This field is the opposite of the Normal State of the Equipment entity. “C’,”O” or “” TransmissionOutage/
voltageN Decimal The voltage level at which the Equipment resides. For transformers it is the high side voltage level. TransmissionOutage/
projectNameN String TransmissionOutage/
emergencyRestorationTimeY positiveInteger This is the time in hours necessary to terminate the Outage and return the Equipment to service. TransmissionOutage/
mRIDN string Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> TransmissionOutage/
natureOfWorkY string TransmissionOutage/
Opportunity/
opportunityDuration/
daysN unsigned Byte For Opportunity Outages, the outage no. of days. Positive no. TransmissionOutage/
Opportunity/
opportunityDuration/
hoursN unsigned Byte For Opportunity Outages, the outage no. of hours Positive no. TransmissionOutage/
Opportunity/
opportunityEndY DateTime For Opportunity Outages, the outage end time Date Time TransmissionOutage/
Opportunity/
designatedResource/
equipmentNameY string This is the Resource name of a Resource that has been designated to an Opportunity TransmissionOutage/
Opportunity/
designatedResource/
equipmentIdentifierY String TransmissionOutage/
Opportunity/
designatedResource/
resourceTypeY String This is the Resource type of a Resource that has been designated to an Opportunity UN (Unit) or LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR), Energy Storage Resource (ESR) TransmissionOutage/
Opportunity/
designatedResource/
stationY String TransmissionOutage/
Opportunity/
designatedResource/
HSLY Decimal TransmissionOutage/
Opportunity/
designatedResource/
desgOutageIdentN String Designated Resource Outage Identifier corresponding to a valid TOO ( Transmission Opportunity Outage). Not required for outage create transaction. Outage Schedule will populate this field in OS query response TransmissionOutage/
Opportunity/
designatedResource/
desgOutageStartN dateTime Designated Resource outage start dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response TransmissionOutage/
Opportunity/
designatedResource/
desgOutageEndN dateTime Designated Resource outage End dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response Schedule/
plannedSartN dateTime This is the date/time at which the Outage is planned to start.
- Forced (Transmission and Resource) - Forced outages don’t have a Planned Start when created
- Transmission Opportunity outages (TOO). TOO’s doesn’t have a Planned Start or a Planned End when created
Schedule/
plannedEndN dateTime This is the date/time at which the Outage is planned to end. Schedule/
earliestStartN dateTime This is the earliest date/time at which the Outage may start. Schedule/
latestEndN dateTime This is the latest date/time at which the Outage may end. Schedule/
actualStartN dateTime This is the actual date/time at which the Outage started. Schedule/
actualEndN dateTime This is the actual date/time at which the Outage ended. Schedule/
new_plannedStartN dateTime This is the proposed date/time at which an Unavoidable Extension may start. Schedule/
new_plannedEndN dateTime This is the proposed date/time at which an Unavoidable Extension may end. Schedule/
new_earliestStartN dateTime This is the proposed earliest date/time at which a Resource Opportunity Outage may start. Schedule/
new_latestEndN dateTime This is the proposed latest date/time at which a Resource Opportunity Outage may end. Recurrence/
datesList/
dates/
mRIDN String Outage Identity mRID is in the format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent> Recurrence/
datesList/
dates/
plannedStartY Date Planned start date of outage recurrence Recurrence/
datesList/
dates/
plannedEndY Date Planned End date of outage recurrence Recurrence/
datesList/
dates/
earliestStartY Date Earliest start date of outage recurrence Recurrence/
datesList/
dates/
latestEndY Date Latest Planned End date of outage recurrence OSNotes/
RequestorNotes/
Note/
createdTimeY string There are three sections that the requestor can enter notes, Requestor Notes, Supporting Information, and Remedial Action or Special Protection System notes. Notes are required for some outage types but not all. They are not required when the outage is submitted but are required for some outages to be completed. There is another section for reviewer notes. This is for ERCOT to enter notes and the MP can only read them. OSNotes/
RequestorNotes/
Note/
createdByY string OSNotes/
RequestorNotes/
Note/
companyY string OSNotes/
RequestorNotes/
Note/
commentY string OSNotes/
ReviewerNotes/
Note/
createdTimeY string OSNotes/
ReviewerNotes/
Note/
createdByY string OSNotes/
ReviewerNotes/
Note/
companyY string OSNotes/
ReviewerNotes/
Note/
commentY string OSNotes/
SupportingNotes/
Note/
createdTimeY string OSNotes/
SupportingNotes/
Note/
createdByY string OSNotes/
SupportingNotes/
Note/
companyY string OSNotes/
SupportingNotes/
Note/
commentY string OSNotes/
RASPSNotes/
Note/
createdTimeY string OSNotes/
RASPSNotes/
Note/
createdByY string OSNotes/
RASPSNotes/
Note/
companyY string OSNotes/
RASPSNotes/
Note/
commentY string Error/
severityN string Severity of Error Generated Error/
areaN string Area of generated error Error/
intervalN string Error/
textY string Error Text
The following is an example of an OutageSet submission by a Market Participant:
<ns2:OutageSet xmlns="http://www.ercot.com/schema/2007-06/nodal/ews" xmlns:ns2="http://www.ercot.com/schema/2007-06/nodal/ews">
<ns2:Outage>
<ns2:OutageInfo>
<ns2:outageType>PL</ns2:outageType>
<ns2:participant>TABC</ns2:participant>
<ns2:lastModified>2016-08-03T14:08:00-05:00</ns2:lastModified>
<ns2:lastModifiedBy>USER1</ns2:lastModifiedBy>
<ns2:Requestor>
<ns2:name>USER1</ns2:name>
<ns2:userFullName>Alex Smith</ns2:userFullName>
<ns2:primaryContact>512-555-5555</ns2:primaryContact>
<ns2:secondaryContact>512-555-5556</ns2:secondaryContact>
<ns2:tertiaryContact>512-555-5557</ns2:tertiaryContact>
</ns2:Requestor>
<ns2:requestDate>2016-08-03T14:09:00-05:00</ns2:requestDate>
<ns2:Disclaimer>temp disclaimer</ns2:Disclaimer>
<ns2:disclaimerAck>true</ns2:disclaimerAck>
</ns2:OutageInfo>
<ns2:TransmissionOutage>
<ns2:operatingCompany>TABC</ns2:operatingCompany>
<ns2:equipmentName>ABC_123</ns2:equipmentName>
<ns2:equipmentIdentifier>_{123AE789-4477-4A1B-8D09-E41615AF38EC}</ns2:equipmentIdentifier>
<ns2:transmissionType>LN</ns2:transmissionType>
<ns2:fromStation>STATION1</ns2:fromStation>
<ns2:normalState>C</ns2:normalState>
<ns2:outageState>O</ns2:outageState>
<ns2:voltage>6.9</ns2:voltage>
<ns2:projectName>project123</ns2:projectName>
<ns2:emergencyRestorationTime>1</ns2:emergencyRestorationTime>
<ns2:natureOfWork>OE</ns2:natureOfWork>
</ns2:TransmissionOutage>
<ns2:Schedule>
<ns2:plannedStart>2016-08-16T10:00:00</ns2:plannedStart>
<ns2:plannedEnd>2016-08-16T12:00:00</ns2:plannedEnd>
<ns2:earliestStart>2016-08-16T10:00:00</ns2:earliestStart>
<ns2:latestEnd>2016-08-16T14:00:00</ns2:latestEnd>
</ns2:Schedule>
<ns2:OSNotes>
<ns2:RequestorNotes>
<ns2:Note>
<ns2:createdTime>2016-04-11T11:00:00</ns2:createdTime>
<ns2:createdBy>ASmith</ns2:createdBy>
<ns2:company>TABC</ns2:company>
<ns2:comment>temp comment</ns2:comment>
</ns2:Note>
</ns2:RequestorNotes>
</ns2:OSNotes>
</ns2:Outage>
</ns2:OutageSet>
The following is an example response message for the above request:
<ns1:OutageSet xmlns:ns0="http://www.ercot.com/schema/2007-05/nodal/eip/il"
xmlns:ns1="http://www.ercot.com/schema/2007-06/nodal/ews">
<ns1:Outage>
<ns1:OutageInfo>
<ns1:outageType>PL</ns1:outageType>
<ns1:participant>TABC</ns1:participant>
<ns1:versionId>1</ns1:versionId>
<ns1:state>Recvd</ns1:state>
<ns1:status>RatE</ns1:status>
<ns1:previousState>ENYS</ns1:previousState>
<ns1:highImpactOutage>true</ns1:highImpactOutage>
<ns1:greater90Days>false</ns1:greater90Days>
<ns1:Requestor>
<ns1:name>USER1</ns1:name>
<ns1:userFullName>Alex Smith</ns1:userFullName>
<ns1:primaryContact/>
<ns1:secondaryContact/>
<ns1:tertiaryContact>512-555-5557</ns1:tertiaryContact>
</ns1:Requestor>
<ns1:requestDate>2016-08-03T14:33:00-05:00</ns1:requestDate>
</ns1:OutageInfo>
<ns1:TransmissionOutage>
<ns1:operatingCompany>TABC</ns1:operatingCompany>
<ns1:equipmentType>LN</ns1:equipmentType>
<ns1:equipmentName> ABC_123</ns1:equipmentName>
<ns1:equipmentIdentifier>_{123AE789-4477-4A1B-8D09-E41615AF38EC}</ns1:equipmentIdentifier>
<ns1:transmissionType>LN</ns1:transmissionType>
<ns1:fromStation>STATION1</ns1:fromStation>
<ns1:toStation>STATION2</ns1:toStation>
<ns1:outageState>O</ns1:outageState>
<ns1:projectName>project123</ns1:projectName>
<ns1:emergencyRestorationTime>1</ns1:emergencyRestorationTime>
<ns1:mRID>TABC.OTG.PL.Transmission.ABC00118301</ns1:mRID>
<ns1:natureOfWork>OE</ns1:natureOfWork>
</ns1:TransmissionOutage>
<ns1:Schedule>
<ns1:plannedStart>2016-08-16T10:00:00-05:00</ns1:plannedStart>
<ns1:plannedEnd>2016-08-16T12:00:00-05:00</ns1:plannedEnd>
<ns1:earliestStart>2016-08-16T10:00:00-05:00</ns1:earliestStart>
<ns1:latestEnd>2016-08-16T14:00:00-05:00</ns1:latestEnd>
</ns1:Schedule>
<ns1:OSNotes>
<ns1:RequestorNotes>
<ns1:Note>
<ns1:createdTime>2016-04-11T11:00:00-05:00</ns1:createdTime>
<ns1:createdBy>ASmith</ns1:createdBy>
<ns1:company>TABC</ns1:company>
<ns1:comment>temp comment</ns1:comment>
</ns1:Note>
</ns1:RequestorNotes>
<ns1:ReviewerNotes/>
<ns1:SupportingNotes/>
<ns1:RASPSNotes/>
</ns1:OSNotes>
</ns1:Outage>
</ns1:OutageSet>
The following is an example of a Group OutageSet Submission by a Market Participant:
<OutageSet xmlns="http://www.ercot.com/schema/2007-06/nodal/ews"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ercot.com/schema/2007-06/nodal/ews">
<Outage>
<OutageInfo>
<outageType>PL</outageType>
<participant>TABC</participant>
<lastModified>2016-08-04T15:24:00-05:00</lastModified>
<lastModifiedBy>asmith</lastModifiedBy>
<Requestor>
<name>2241</name>
<userFullName>Alex Smith</userFullName>
<tertiaryContact>512-555-1234</tertiaryContact>
</Requestor>
<requestDate>2016-08-04T15:24:00-05:00</requestDate>
<Disclaimer>Temp Disclaimer</Disclaimer>
<disclaimerAck>true</disclaimerAck>
</OutageInfo>
<Group>
<name>Grp2</name>
<GroupTransmissionOutage>
<operatingCompany>TABC</operatingCompany>
<equipmentName>ABC_1234</equipmentName>
<equipmentIdentifier>_{123AB3F7-11A4-4F87-A2C0-125F79F221B4}</equipmentIdentifier>
<transmissionType>DSC</transmissionType>
<fromStation>Station1</fromStation>
<normalState>C</normalState>
<outageState>O</outageState>
<voltage>69</voltage>
<projectName>Project2</projectName>
<emergencyRestorationTime>1</emergencyRestorationTime>
<natureOfWork>RE</natureOfWork>
</GroupTransmissionOutage>
<GroupTransmissionOutage>
<operatingCompany>TABC</operatingCompany>
<equipmentName>ABC_2345</equipmentName>
<equipmentIdentifier>_{A12BCD24-5968-45F3-9471-728032982EE3}</equipmentIdentifier>
<transmissionType>DSC</transmissionType>
<fromStation>Station1</fromStation>
<normalState>C</normalState>
<outageState>O</outageState>
<voltage>138</voltage>
<projectName>Project3</projectName>
<emergencyRestorationTime>1</emergencyRestorationTime>
<natureOfWork>RE</natureOfWork>
</GroupTransmissionOutage>
</Group>
<Schedule>
<plannedStart>2016-08-12T08:00:00-05:00</plannedStart>
<plannedEnd>2016-08-12T12:00:00-05:00</plannedEnd>
<earliestStart>2016-08-12T08:00:00-05:00</earliestStart>
<latestEnd>2016-08-12T13:00:00-05:00</latestEnd>
</Schedule>
</Outage>
</OutageSet>
The following is an example response message for the above request:
<ns1:OutageSet xmlns:ns0="http://www.ercot.com/schema/2007-05/nodal/eip/il" xmlns:ns1="http://www.ercot.com/schema/2007-06/nodal/ews">
<ns1:Outage>
<ns1:OutageInfo>
<ns1:outageType>PL</ns1:outageType>
<ns1:participant>TABC</ns1:participant>
<ns1:versionId>1</ns1:versionId>
<ns1:state>ENYS</ns1:state>
<ns1:status>RatE</ns1:status>
<ns1:previousState>ENYS</ns1:previousState>
<ns1:Requestor>
<ns1:name>2241</ns1:name>
<ns1:userFullName>Alex Smith</ns1:userFullName>
<ns1:primaryContact/>
<ns1:secondaryContact/>
<ns1:tertiaryContact>512-555-1234</ns1:tertiaryContact>
</ns1:Requestor>
<ns1:requestDate>2017-08-04T15:24:06-05:00</ns1:requestDate>
</ns1:OutageInfo>
<ns1:Group>
<ns1:groupId>TABC.OTG.167432</ns1:groupId>
<ns1:name>Grp2</ns1:name>
<ns1:GroupTransmissionOutage>
<ns1:operatingCompany>TABC</ns1:operatingCompany>
<ns1:equipmentName>ABC_1234</ns1:equipmentName>
<ns1:equipmentIdentifier>_{123AB3F7-11A4-4F87-A2C0-125F79F221B4}</ns1:equipmentIdentifier>
<ns1:transmissionType>DSC</ns1:transmissionType>
<ns1:fromStation>Station1</ns1:fromStation>
<ns1:toStation>Station2</ns1:toStation>
<ns1:highImpactOutage>true</ns1:highImpactOutage>
<ns1:greater90Days>false</ns1:greater90Days>
<ns1:normalState>C</ns1:normalState>
<ns1:outageState>O</ns1:outageState>
<ns1:voltage>69</ns1:voltage>
<ns1:projectName>Project2</ns1:projectName>
<ns1:emergencyRestorationTime>1</ns1:emergencyRestorationTime>
<ns1:mRID>TABC.OTG.PL.Transmission.ABC00012345</ns1:mRID>
<ns1:natureOfWork>RE</ns1:natureOfWork>
</ns1:GroupTransmissionOutage>
<ns1:GroupTransmissionOutage>
<ns1:operatingCompany>TABC</ns1:operatingCompany>
<ns1:equipmentName>ABC_2345</ns1:equipmentName>
<ns1:equipmentIdentifier>_{A12BCD24-5968-45F3-9471-728032982EE3}</ns1:equipmentIdentifier>
<ns1:transmissionType>DSC</ns1:transmissionType>
<ns1:fromStation>Station1</ns1:fromStation>
<ns1:toStation>Station2</ns1:toStation>
<ns1:highImpactOutage>true</ns1:highImpactOutage>
<ns1:greater90Days>false</ns1:greater90Days>
<ns1:normalState>C</ns1:normalState>
<ns1:outageState>O</ns1:outageState>
<ns1:voltage>138</ns1:voltage>
<ns1:projectName>Project3</ns1:projectName>
<ns1:emergencyRestorationTime>1</ns1:emergencyRestorationTime>
<ns1:mRID>TABC.OTG.PL.Transmission.ABC00023456</ns1:mRID>
<ns1:natureOfWork>RE</ns1:natureOfWork>
</ns1:GroupTransmissionOutage>
</ns1:Group>
<ns1:Schedule>
<ns1:plannedStart>2016-08-12T08:00:00-05:00</ns1:plannedStart>
<ns1:plannedEnd>2016-08-12T12:00:00-05:00</ns1:plannedEnd>
<ns1:earliestStart>2016-08-12T08:00:00-05:00</ns1:earliestStart>
<ns1:latestEnd>2016-08-12T13:00:00-05:00</ns1:latestEnd>
</ns1:Schedule>
<ns1:OSNotes>
<ns1:RequestorNotes/>
<ns1:ReviewerNotes/>
<ns1:SupportingNotes/>
<ns1:RASPSNotes/>
</ns1:OSNotes>
</ns1:Outage>
</ns1:OutageSet>