Class: Outage
_Document describing details of an active or planned outage in a part of the electrical network. _
_A non-planned outage may be created upon: _
_- a breaker trip, _
_- a fault indicator status change, _
_- a meter event indicating customer outage, _
_- a reception of one or more customer trouble calls, or _
_- an operator command, reflecting information obtained from the field crew. _
_Outage restoration may be performed using a switching plan which complements the outage information with detailed switching activities, including the relationship to the crew and work. _
_A planned outage may be created upon: _
_- a request for service, maintenance or construction work in the field, or _
- an operator-defined outage for what-if/contingency network analysis.
URI: cim:Outage
classDiagram
class Outage
Document <|-- Outage
Outage <|-- PlannedOutage
Outage <|-- UnplannedOutage
Outage : activity_record
Outage --> ActivityRecord : activity_record
Outage : actual_period
Outage --> DateTimeInterval : actual_period
Outage : alias_name
Outage : approver
Outage --> Approver : approver
Outage : author
Outage --> Author : author
Outage : author_name
Outage : comment
Outage : community_descriptor
Outage : configuration_events
Outage --> ConfigurationEvent : configuration_events
Outage : created_date_time
Outage : crew
Outage --> Crew : crew
Outage : customers_restored
Outage : de_energized_usage_point
Outage --> UsagePoint : de_energized_usage_point
Outage : description
Outage : diagram_objects
Outage --> DiagramObject : diagram_objects
Outage : doc_status
Outage --> Status : doc_status
Outage : editor
Outage --> Editor : editor
Outage : electronic_address
Outage --> ElectronicAddress : electronic_address
Outage : energized_usage_point
Outage --> UsagePoint : energized_usage_point
Outage : equipments
Outage --> Equipment : equipments
Outage : estimated_period
Outage --> DateTimeInterval : estimated_period
Outage : estimated_restoration_time
Outage --> EstimatedRestorationTime : estimated_restoration_time
Outage : faults
Outage --> Fault : faults
Outage : incident
Outage --> Incident : incident
Outage : instance_set
Outage --> InstanceSet : instance_set
Outage : issuer
Outage --> Issuer : issuer
Outage : last_modified_date_time
Outage : m_rid
Outage : meters_affected
Outage : names
Outage --> Name : names
Outage : original_customers_served
Outage : original_meters_affected
Outage : outage_area
Outage --> OutageArea : outage_area
Outage : outage_isolation_equipment
Outage --> ConductingEquipment : outage_isolation_equipment
Outage : outage_kind
Outage --> OutageStatusKind : outage_kind
Outage : planned_switch_actions
Outage --> SwitchAction : planned_switch_actions
Outage : properties_cimdata_object
Outage --> ChangeSetMember : properties_cimdata_object
Outage : revision_number
Outage : status
Outage --> Status : status
Outage : status_kind
Outage --> CrewStatusKind : status_kind
Outage : subject
Outage : summary
Outage --> ServicePointOutageSummary : summary
Outage : switching_plans
Outage --> SwitchingPlan : switching_plans
Outage : targeting_cimdata_object
Outage --> ChangeSetMember : targeting_cimdata_object
Outage : title
Outage : type
Outage : utility_disclaimer
Inheritance
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| actual_period | 0..1 DateTimeInterval |
Actual outage period; end of the period corresponds to the actual restoration... | direct |
| community_descriptor | 0..1 String |
a name to denote the community - this could be a name or a code of some kind | direct |
| customers_restored | 0..1 Integer |
number of customers that have been restored in the area | direct |
| estimated_period | 0..1 DateTimeInterval |
Estimated outage period for a planned outage | direct |
| meters_affected | 0..1 Integer |
The updated number of meters affected by the outage as reported by the OMS wi... | direct |
| original_customers_served | 1..1 Integer |
the total number of customers that are served in the area (both outaged and n... | direct |
| original_meters_affected | 0..1 Integer |
The original number of meters that were affected as reported by the OMS withi... | direct |
| outage_kind | 0..1 OutageStatusKind |
Defines if the outage has been verified or is only estimated | direct |
| status_kind | 0..1 CrewStatusKind |
defines the status of the crew as in dispatched or arrived, etc | direct |
| summary | 0..1 ServicePointOutageSummary |
Summary counts of service points (customers) affected by this outage | direct |
| utility_disclaimer | 0..1 String |
This contains an disclaimers the utility would like to place on the data prov... | direct |
| energized_usage_point | 0..* UsagePoint |
All energized usage points associated with this outage | direct |
| equipments | 0..* Equipment |
All equipments associated with this outage | direct |
| planned_switch_actions | 0..* SwitchAction |
All switch actions to apply within the scope of this planned outage | direct |
| de_energized_usage_point | 0..* UsagePoint |
all deenergized useage points associated with the outage | direct |
| faults | 0..* Fault |
All faults involved in this outage | direct |
| crew | 0..* Crew |
The crew that is assigned to the outage | direct |
| outage_isolation_equipment | 0..* ConductingEquipment |
The equipment that isolates this outage | direct |
| incident | 0..* Incident |
Incident reported in trouble call that results in this outage | direct |
| estimated_restoration_time | 0..1 EstimatedRestorationTime |
The estimated time that the power will be restored after an outage | direct |
| switching_plans | 0..* SwitchingPlan |
All switching plans that lead to supply restoration due to this outage | direct |
| outage_area | 0..* OutageArea |
The outage area where the outage occured | direct |
| author_name | 0..1 String |
Name of the author of this document | Document |
| comment | 0..1 String |
Free text comment | Document |
| created_date_time | 0..1 date |
Date and time that this document was created | Document |
| doc_status | 0..1 Status |
Status of this document | Document |
| electronic_address | 0..1 ElectronicAddress |
Electronic address | Document |
| last_modified_date_time | 0..1 date |
Date and time this document was last modified | Document |
| revision_number | 0..1 String |
Revision number for this document | Document |
| status | 0..1 Status |
Status of subject matter (e | Document |
| subject | 0..1 String |
Document subject | Document |
| title | 0..1 String |
Document title | Document |
| type | 0..1 String |
Utility-specific classification of this document, according to its corporate ... | Document |
| activity_record | 0..* ActivityRecord |
The activity record for a document | Document |
| configuration_events | 0..* ConfigurationEvent |
All configuration events created for this document | Document |
| author | 0..1 Author |
Author of this document | Document |
| editor | 0..1 Editor |
Editor of this document | Document |
| approver | 0..1 Approver |
Approver of this document | Document |
| issuer | 0..1 Issuer |
Issuer of this document | Document |
| alias_name | 0..1 String |
The aliasName is free text human readable name of the object alternative to I... | IdentifiedObject |
| description | 0..1 String |
The description is a free human readable text describing or naming the object | IdentifiedObject |
| m_rid | 0..1 String |
Master resource identifier issued by a model authority | IdentifiedObject |
| diagram_objects | 0..* DiagramObject |
The diagram objects that are associated with the domain object | IdentifiedObject |
| instance_set | 1..1 InstanceSet |
Dataset containing the data objects | IdentifiedObject |
| names | 0..* Name |
All names of this identified object | IdentifiedObject |
| properties_cimdata_object | 0..1 ChangeSetMember |
The single CIM data object in the appropriate dataset context | IdentifiedObject |
| targeting_cimdata_object | 0..* ChangeSetMember |
Data objects registered | IdentifiedObject |
Usages
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:Outage |
| native | cim:Outage |
LinkML Source
Direct
name: Outage
description: "Document describing details of an active or planned outage in a part\
\ of the electrical network.\r\nA non-planned outage may be created upon:\r\n- a\
\ breaker trip,\r\n- a fault indicator status change,\r\n- a meter event indicating\
\ customer outage,\r\n- a reception of one or more customer trouble calls, or\r\n\
- an operator command, reflecting information obtained from the field crew.\r\n\
Outage restoration may be performed using a switching plan which complements the\
\ outage information with detailed switching activities, including the relationship\
\ to the crew and work.\r\nA planned outage may be created upon:\r\n- a request\
\ for service, maintenance or construction work in the field, or\r\n- an operator-defined\
\ outage for what-if/contingency network analysis."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
actual_period:
name: actual_period
description: Actual outage period; end of the period corresponds to the actual
restoration time.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.actualPeriod
multivalued: false
domain_of:
- Outage
range: DateTimeInterval
required: false
community_descriptor:
name: community_descriptor
description: a name to denote the community - this could be a name or a code of
some kind.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.communityDescriptor
multivalued: false
domain_of:
- Outage
range: string
required: false
customers_restored:
name: customers_restored
description: number of customers that have been restored in the area.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.customersRestored
multivalued: false
domain_of:
- Outage
range: integer
required: false
estimated_period:
name: estimated_period
description: Estimated outage period for a planned outage. The start of the period
is the start of the planned outage and the end of the period corresponds to
the end of the planned outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.estimatedPeriod
multivalued: false
domain_of:
- Outage
range: DateTimeInterval
required: false
meters_affected:
name: meters_affected
description: The updated number of meters affected by the outage as reported by
the OMS within the utility. It is assumed this number will be updated repeatedly
until the full outage is resolved.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.metersAffected
multivalued: false
domain_of:
- Outage
range: integer
required: false
original_customers_served:
name: original_customers_served
description: the total number of customers that are served in the area (both outaged
and not outaged).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.originalCustomersServed
multivalued: false
domain_of:
- Outage
range: integer
required: true
original_meters_affected:
name: original_meters_affected
description: The original number of meters that were affected as reported by the
OMS within the utility. That is, this is the total number of meters that were
out at the beginning of the outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.originalMetersAffected
multivalued: false
domain_of:
- Outage
range: integer
required: false
outage_kind:
name: outage_kind
description: Defines if the outage has been verified or is only estimated
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.outageKind
multivalued: false
domain_of:
- Outage
range: OutageStatusKind
required: false
status_kind:
name: status_kind
description: defines the status of the crew as in dispatched or arrived, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.statusKind
multivalued: false
domain_of:
- BaseWork
- Outage
range: CrewStatusKind
required: false
summary:
name: summary
description: Summary counts of service points (customers) affected by this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.summary
multivalued: false
domain_of:
- Outage
range: ServicePointOutageSummary
required: false
utility_disclaimer:
name: utility_disclaimer
description: This contains an disclaimers the utility would like to place on the
data provided to any stakeholder. This may be different for different stakeholders. This
should possibly be an attribute under the Organization class but it is placed
here for now.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.utilityDisclaimer
multivalued: false
domain_of:
- Outage
range: string
required: false
energized_usage_point:
name: energized_usage_point
description: All energized usage points associated with this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.EnergizedUsagePoint
multivalued: true
domain_of:
- Outage
range: UsagePoint
required: false
equipments:
name: equipments
description: All equipments associated with this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Equipments
multivalued: true
domain_of:
- EquipmentContainer
- UsagePoint
- OperationalRestriction
- Outage
range: Equipment
required: false
planned_switch_actions:
name: planned_switch_actions
description: All switch actions to apply within the scope of this planned outage.
Each such action groups switches to which the action is to apply in order to
produce the desired network state considered as outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.PlannedSwitchActions
multivalued: true
domain_of:
- Outage
range: SwitchAction
required: false
de_energized_usage_point:
name: de_energized_usage_point
description: 'all deenergized useage points associated with the outage. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.DeEnergizedUsagePoint
multivalued: true
domain_of:
- Outage
range: UsagePoint
required: false
faults:
name: faults
description: All faults involved in this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Faults
multivalued: true
domain_of:
- Equipment
- Outage
- FaultCauseType
range: Fault
required: false
crew:
name: crew
description: The crew that is assigned to the outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Crew
multivalued: true
domain_of:
- Location
- Capability
- SwitchingAction
- FieldDispatchHistory
- Outage
- WorkAsset
- CrewMember
range: Crew
required: false
outage_isolation_equipment:
name: outage_isolation_equipment
description: The equipment that isolates this outage
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.OutageIsolationEquipment
multivalued: true
domain_of:
- Outage
range: ConductingEquipment
required: false
incident:
name: incident
description: Incident reported in trouble call that results in this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Incident
multivalued: true
domain_of:
- Asset
- Location
- TroubleOrder
- Outage
- TroubleTicket
- CustomerNotification
- UnplannedOutage
- Hazard
- IncidentHazard
range: Incident
required: false
estimated_restoration_time:
name: estimated_restoration_time
description: The estimated time that the power will be restored after an outage
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.EstimatedRestorationTime
multivalued: false
domain_of:
- Outage
range: EstimatedRestorationTime
required: false
switching_plans:
name: switching_plans
description: All switching plans that lead to supply restoration due to this outage.
Only one will be retained for execution.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.SwitchingPlans
multivalued: true
domain_of:
- Outage
range: SwitchingPlan
required: false
outage_area:
name: outage_area
description: The outage area where the outage occured.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.OutageArea
multivalued: true
domain_of:
- Outage
range: OutageArea
required: false
class_uri: cim:Outage
Induced
name: Outage
description: "Document describing details of an active or planned outage in a part\
\ of the electrical network.\r\nA non-planned outage may be created upon:\r\n- a\
\ breaker trip,\r\n- a fault indicator status change,\r\n- a meter event indicating\
\ customer outage,\r\n- a reception of one or more customer trouble calls, or\r\n\
- an operator command, reflecting information obtained from the field crew.\r\n\
Outage restoration may be performed using a switching plan which complements the\
\ outage information with detailed switching activities, including the relationship\
\ to the crew and work.\r\nA planned outage may be created upon:\r\n- a request\
\ for service, maintenance or construction work in the field, or\r\n- an operator-defined\
\ outage for what-if/contingency network analysis."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
actual_period:
name: actual_period
description: Actual outage period; end of the period corresponds to the actual
restoration time.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.actualPeriod
multivalued: false
alias: actual_period
owner: Outage
domain_of:
- Outage
range: DateTimeInterval
required: false
community_descriptor:
name: community_descriptor
description: a name to denote the community - this could be a name or a code of
some kind.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.communityDescriptor
multivalued: false
alias: community_descriptor
owner: Outage
domain_of:
- Outage
range: string
required: false
customers_restored:
name: customers_restored
description: number of customers that have been restored in the area.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.customersRestored
multivalued: false
alias: customers_restored
owner: Outage
domain_of:
- Outage
range: integer
required: false
estimated_period:
name: estimated_period
description: Estimated outage period for a planned outage. The start of the period
is the start of the planned outage and the end of the period corresponds to
the end of the planned outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.estimatedPeriod
multivalued: false
alias: estimated_period
owner: Outage
domain_of:
- Outage
range: DateTimeInterval
required: false
meters_affected:
name: meters_affected
description: The updated number of meters affected by the outage as reported by
the OMS within the utility. It is assumed this number will be updated repeatedly
until the full outage is resolved.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.metersAffected
multivalued: false
alias: meters_affected
owner: Outage
domain_of:
- Outage
range: integer
required: false
original_customers_served:
name: original_customers_served
description: the total number of customers that are served in the area (both outaged
and not outaged).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.originalCustomersServed
multivalued: false
alias: original_customers_served
owner: Outage
domain_of:
- Outage
range: integer
required: true
original_meters_affected:
name: original_meters_affected
description: The original number of meters that were affected as reported by the
OMS within the utility. That is, this is the total number of meters that were
out at the beginning of the outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.originalMetersAffected
multivalued: false
alias: original_meters_affected
owner: Outage
domain_of:
- Outage
range: integer
required: false
outage_kind:
name: outage_kind
description: Defines if the outage has been verified or is only estimated
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.outageKind
multivalued: false
alias: outage_kind
owner: Outage
domain_of:
- Outage
range: OutageStatusKind
required: false
status_kind:
name: status_kind
description: defines the status of the crew as in dispatched or arrived, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.statusKind
multivalued: false
alias: status_kind
owner: Outage
domain_of:
- BaseWork
- Outage
range: CrewStatusKind
required: false
summary:
name: summary
description: Summary counts of service points (customers) affected by this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.summary
multivalued: false
alias: summary
owner: Outage
domain_of:
- Outage
range: ServicePointOutageSummary
required: false
utility_disclaimer:
name: utility_disclaimer
description: This contains an disclaimers the utility would like to place on the
data provided to any stakeholder. This may be different for different stakeholders. This
should possibly be an attribute under the Organization class but it is placed
here for now.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.utilityDisclaimer
multivalued: false
alias: utility_disclaimer
owner: Outage
domain_of:
- Outage
range: string
required: false
energized_usage_point:
name: energized_usage_point
description: All energized usage points associated with this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.EnergizedUsagePoint
multivalued: true
alias: energized_usage_point
owner: Outage
domain_of:
- Outage
range: UsagePoint
required: false
equipments:
name: equipments
description: All equipments associated with this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Equipments
multivalued: true
alias: equipments
owner: Outage
domain_of:
- EquipmentContainer
- UsagePoint
- OperationalRestriction
- Outage
range: Equipment
required: false
planned_switch_actions:
name: planned_switch_actions
description: All switch actions to apply within the scope of this planned outage.
Each such action groups switches to which the action is to apply in order to
produce the desired network state considered as outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.PlannedSwitchActions
multivalued: true
alias: planned_switch_actions
owner: Outage
domain_of:
- Outage
range: SwitchAction
required: false
de_energized_usage_point:
name: de_energized_usage_point
description: 'all deenergized useage points associated with the outage. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.DeEnergizedUsagePoint
multivalued: true
alias: de_energized_usage_point
owner: Outage
domain_of:
- Outage
range: UsagePoint
required: false
faults:
name: faults
description: All faults involved in this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Faults
multivalued: true
alias: faults
owner: Outage
domain_of:
- Equipment
- Outage
- FaultCauseType
range: Fault
required: false
crew:
name: crew
description: The crew that is assigned to the outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Crew
multivalued: true
alias: crew
owner: Outage
domain_of:
- Location
- Capability
- SwitchingAction
- FieldDispatchHistory
- Outage
- WorkAsset
- CrewMember
range: Crew
required: false
outage_isolation_equipment:
name: outage_isolation_equipment
description: The equipment that isolates this outage
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.OutageIsolationEquipment
multivalued: true
alias: outage_isolation_equipment
owner: Outage
domain_of:
- Outage
range: ConductingEquipment
required: false
incident:
name: incident
description: Incident reported in trouble call that results in this outage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Outage.Incident
multivalued: true
alias: incident
owner: Outage
domain_of:
- Asset
- Location
- TroubleOrder
- Outage
- TroubleTicket
- CustomerNotification
- UnplannedOutage
- Hazard
- IncidentHazard
range: Incident
required: false
estimated_restoration_time:
name: estimated_restoration_time
description: The estimated time that the power will be restored after an outage
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.EstimatedRestorationTime
multivalued: false
alias: estimated_restoration_time
owner: Outage
domain_of:
- Outage
range: EstimatedRestorationTime
required: false
switching_plans:
name: switching_plans
description: All switching plans that lead to supply restoration due to this outage.
Only one will be retained for execution.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.SwitchingPlans
multivalued: true
alias: switching_plans
owner: Outage
domain_of:
- Outage
range: SwitchingPlan
required: false
outage_area:
name: outage_area
description: The outage area where the outage occured.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Outage.OutageArea
multivalued: true
alias: outage_area
owner: Outage
domain_of:
- Outage
range: OutageArea
required: false
author_name:
name: author_name
description: Name of the author of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.authorName
multivalued: false
alias: author_name
owner: Outage
domain_of:
- Document
range: string
required: false
comment:
name: comment
description: Free text comment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.comment
multivalued: false
alias: comment
owner: Outage
domain_of:
- NetworkModelProjectChangeVersion
- Document
- SwitchingPlanRequest
- SwitchingOrder
- TroubleOrder
- ReadingQuality
- TroubleTicket
- OutageOrder
range: string
required: false
created_date_time:
name: created_date_time
description: "Date and time that this document was created.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.createdDateTime
multivalued: false
alias: created_date_time
owner: Outage
domain_of:
- Document
- ActivityRecord
range: date
required: false
doc_status:
name: doc_status
description: "Status of this document. For status of subject matter this document\
\ represents (e.g., Agreement, Work), use 'status' attribute.\r\nExample values\
\ for 'docStatus.status' are draft, approved, cancelled, etc."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.docStatus
multivalued: false
alias: doc_status
owner: Outage
domain_of:
- Document
range: Status
required: false
electronic_address:
name: electronic_address
description: Electronic address.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.electronicAddress
multivalued: false
alias: electronic_address
owner: Outage
domain_of:
- Asset
- Document
- Person
- Organisation
- Location
- Cashier
range: ElectronicAddress
required: false
last_modified_date_time:
name: last_modified_date_time
description: "Date and time this document was last modified. Documents may potentially\
\ be modified many times during their lifetime.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.lastModifiedDateTime
multivalued: false
alias: last_modified_date_time
owner: Outage
domain_of:
- Document
range: date
required: false
revision_number:
name: revision_number
description: Revision number for this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.revisionNumber
multivalued: false
alias: revision_number
owner: Outage
domain_of:
- Document
- MajorChargeGroup
range: string
required: false
status:
name: status
description: Status of subject matter (e.g., Agreement, Work) this document represents.
For status of the document itself, use 'docStatus' attribute.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.status
multivalued: false
alias: status
owner: Outage
domain_of:
- Asset
- Document
- Customer
- StreetAddress
- Location
- ErpQuoteLineItem
- CostType
- ErpJournalEntry
- ErpRecLineItem
- ErpPayableLineItem
- ContractorItem
- Capability
- Craft
- OldPerson
- ErpPersonnel
- LaborItem
- DesignLocationCU
- DesignLocation
- ConditionFactor
- MiscCostItem
- CUGroup
- WorkFlowStep
- ErpTimeEntry
- OverheadCost
- PropertyUnit
- CUMaterialItem
- ErpIssueInventory
- ErpReqLineItem
- ErpRecDelvLineItem
- Role
- LandProperty
- ErpSiteLevelData
- Crew
- ActivityRecord
- ErpLedgerEntry
- ErpLedBudLineItem
- TransformerObservation
- BushingInsulationPF
- WindingInsulation
- CULaborItem
- CULaborCode
- EndDeviceGroup
- Hazard
- CUWorkEquipmentItem
- ShiftPattern
- Route
- Usage
- CUContractorItem
- CUAllowableAction
- TypeAssetCatalogue
- AssetModelCatalogue
- Market
- CRROrgRole
- MarketScheduledEvent
- MarketLedgerEntry
- MarketPerson
- MarketQualificationRequirement
- ResourceGroup
- ResourceAwardInstruction
- ExPostResourceResults
- MarketObjectStatus
- TimePoint
- ErpItemMaster
- ScheduledEvent
- ScheduledEventData
- ErpInventory
- ErpInventoryCount
- RedLine
- BusinessRole
- BidTimeSeries
range: Status
required: false
subject:
name: subject
description: Document subject.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.subject
multivalued: false
alias: subject
owner: Outage
domain_of:
- Document
range: string
required: false
title:
name: title
description: Document title.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.title
multivalued: false
alias: title
owner: Outage
domain_of:
- Document
range: string
required: false
type:
name: type
description: Utility-specific classification of this document, according to its
corporate standards, practices, and existing IT systems (e.g., for management
of assets, maintenance, work, outage, customers, etc.).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.type
multivalued: false
alias: type
owner: Outage
domain_of:
- Asset
- AcceptanceTest
- Document
- StreetDetail
- Location
- Priority
- CatalogAssetType
- Capability
- Craft
- OldPerson
- Role
- ActivityRecord
- EndDeviceEventType
- EndDeviceGroup
- DemandResponseProgram
- UsagePointGroup
- EndDeviceControlType
- Hazard
- OldCrew
- Route
- ConstraintDuration
- AceTariffType
- ControlArea
- SynchronousMachine
- ChargeProfile
- ChargeComponent
- MarketRole
- ResourceGroup
- Quantity
- ResourceCertification
- Auction
- ScheduledEvent
- PotentialTransformer
- BusinessRole
range: string
required: false
activity_record:
name: activity_record
description: The activity record for a document
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.ActivityRecord
multivalued: true
alias: activity_record
owner: Outage
domain_of:
- Document
range: ActivityRecord
required: false
configuration_events:
name: configuration_events
description: All configuration events created for this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.ConfigurationEvents
multivalued: true
alias: configuration_events
owner: Outage
domain_of:
- Asset
- Document
- PersonRole
- OrganisationRole
- Location
- UsagePoint
- ServiceCategory
range: ConfigurationEvent
required: false
author:
name: author
description: Author of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Author
multivalued: false
alias: author
owner: Outage
domain_of:
- Document
- ActivityRecord
range: Author
required: false
editor:
name: editor
description: Editor of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Editor
multivalued: false
alias: editor
owner: Outage
domain_of:
- Document
range: Editor
required: false
approver:
name: approver
description: Approver of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Approver
multivalued: false
alias: approver
owner: Outage
domain_of:
- Document
range: Approver
required: false
issuer:
name: issuer
description: Issuer of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Issuer
multivalued: false
alias: issuer
owner: Outage
domain_of:
- Document
range: Issuer
required: false
alias_name:
name: alias_name
description: "The aliasName is free text human readable name of the object alternative\
\ to IdentifiedObject.name. It may be non unique and may not correlate to a\
\ naming hierarchy.\r\nThe attribute aliasName is retained because of backwards\
\ compatibility between CIM relases. It is however recommended to replace aliasName\
\ with the Name class as aliasName is planned for retirement at a future time.\r\
\n\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.aliasName
multivalued: false
alias: alias_name
owner: Outage
domain_of:
- IdentifiedObject
range: string
required: false
description:
name: description
description: The description is a free human readable text describing or naming
the object. It may be non unique and may not correlate to a naming hierarchy.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.description
multivalued: false
alias: description
owner: Outage
domain_of:
- IdentifiedObject
- NameType
- NameTypeAuthority
- DataSet
- SwitchingStepGroup
- AreaReserveSpec
range: string
required: false
m_rid:
name: m_rid
description: "Master resource identifier issued by a model authority. The mRID\
\ is unique within an exchange context. Global uniqueness is easily achieved\
\ by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is\
\ strongly recommended.\r\nFor CIMXML data files in RDF syntax conforming to\
\ IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify\
\ CIM object elements."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.mRID
multivalued: false
alias: m_rid
owner: Outage
domain_of:
- IdentifiedObject
- DataSet
range: string
required: false
diagram_objects:
name: diagram_objects
description: The diagram objects that are associated with the domain object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.DiagramObjects
multivalued: true
alias: diagram_objects
owner: Outage
domain_of:
- IdentifiedObject
range: DiagramObject
required: false
instance_set:
name: instance_set
description: Dataset containing the data objects.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.InstanceSet
multivalued: false
alias: instance_set
owner: Outage
domain_of:
- IdentifiedObject
range: InstanceSet
required: true
names:
name: names
description: All names of this identified object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.Names
multivalued: true
alias: names
owner: Outage
domain_of:
- IdentifiedObject
- NameType
range: Name
required: false
properties_cimdata_object:
name: properties_cimdata_object
description: The single CIM data object in the appropriate dataset context.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
multivalued: false
alias: properties_cimdata_object
owner: Outage
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
targeting_cimdata_object:
name: targeting_cimdata_object
description: Data objects registered.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
multivalued: true
alias: targeting_cimdata_object
owner: Outage
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:Outage