Profile Documentation

Profile namespace: http://iec.ch/TC57/2014/FROutages#

Concrete Classes

Outage

Operations

Native Members

mRID

1..1

string

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.

For CIMXML data files in RDF syntax conforming to IEC 61970-552 Edition 1, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

cause

0..1

string

The cause of this outage. This is the cause that is used to present to external entities. That is, the cause is weather, equipment failure, etc.

Note: At present, this is a free text; could be replaced with a separate associated class in case we have multiple causes (e.g. OutageCauseType, inheriting from IdentifiedObject).

causeKind

0..1

OutageCauseKind

communityDescriptor

0..1

string

customersRestored

0..1

integer

metersAffected

0..1

integer

originalCustomersServed

0..1

integer

originalMetersAffected

0..1

integer

outageKind

0..1

OutageStatusKind

Defines if the outage has been verified or is only estimated.

reportedStartTime

0..1

dateTime

The earliest start time of the Outage - as reported by some system or individual

statusKind

0..1

CrewStatusKind

utilityDisclaimer

0..1

string

actualPeriod

0..1

DateTimeInterval

estimatedPeriod

0..1

DateTimeInterval

EstimatedRestorationTime

0..1

EstimatedRestorationTime

Incident

0..unbounded

Incident

Incident reported in trouble call that results in this outage.

Names

1..unbounded

Name

All names of this identified object.

OutageArea

0..unbounded

OutageArea

Abstract Classes

CoordinateSystem

Common

Coordinate reference system.

Native Members

crsUrn

1..1

string

A Uniform Resource Name (URN) for the coordinate reference system (crs) used to define 'Location.PositionPoints'.

An example would be the European Petroleum Survey Group (EPSG) code for a coordinate reference system, defined in URN under the Open Geospatial Consortium (OGC) namespace as: urn:ogc:def:uom:EPSG::XXXX, where XXXX is an EPSG code (a full list of codes can be found at the EPSG Registry web site http://www.epsg-registry.org/). To define the coordinate system as being WGS84 (latitude, longitude) using an EPSG OGC, this attribute would be urn:ogc:def:uom:EPSG::4236.

A profile should limit this code to a set of allowed URNs agreed to by all sending and receiving parties.

EstimatedRestorationTime

Operations

The Estimated Restoration Time for a single outage

Native Members

confidenceKind

1..1

ERTConfidenceKind

provides the confidence level that this ERT can be accomplished. This may be changed/updated as needed.

ert

1..1

dateTime

estimated time the outage will be restored

ertSource

1..1

string

defines the source that provided the ERT value.

Incident

Operations

Description of a problem in the field that may be reported in a trouble ticket or come from another source. It may have to do with an outage.

Native Members

cause

1..1

string

Cause of this incident.

Location

1..1

Location

Location of this incident.

Location

Common

The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more postition points (coordinates) in a given coordinate system.

Native Members

direction

1..1

string

(if applicable) Direction that allows field crews to quickly find a given asset. For a given location, such as a street address, this is the relative direction in which to find the asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site, or a usage point may be located on the second floor of an apartment building.

geoInfoReference

1..1

string

(if applicable) Reference to geographical information source, often external to the utility.

kind

0..1

ZoneKind

Kind of this zone.

type

1..1

string

Classification by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).

CoordinateSystem

1..1

CoordinateSystem

Coordinate system used to describe position points of this location.

PositionPoints

1..unbounded

PositionPoint

Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.

Name

Core

The Name class provides the means to define any number of human readable names for an object. A name is <b>not</b> to be used for defining inter-object relationships. For inter-object relationships instead use the object identification 'mRID'.

Native Members

name

1..1

string

Any free text that name the object.

This is the utility ID that can be assigned by the Utility of some outside entity.

NameType

0..1

NameType

Type of this name.

NameType

Core

Type of name. Possible values for attribute 'name' are implementation dependent but standard profiles may specify types. An enterprise may have multiple IT systems each having its own local name for the same object, e.g. a planning system may have different names from an EMS. An object may also have different names within the same IT system, e.g. localName as defined in CIM version 14. The definition from CIM14 is:

The localName is a human readable name of the object. It is a free text name local to a node in a naming hierarchy similar to a file directory structure. A power system related naming hierarchy may be: Substation, VoltageLevel, Equipment etc. Children of the same parent in such a hierarchy have names that typically are unique among them.

Native Members

description

0..1

string

Description of the name type.

The source of the Name.name attribute -- that is the Utility, EIA, NERC, or some other entity.

name

0..1

string

Name of the name type.

The source of the Name.name attribute -- that is the Utility, EIA, NERC, or some other entity.

NameTypeAuthority

0..1

NameTypeAuthority

Authority responsible for managing names of this type.

NameTypeAuthority

Core

Authority responsible for creation and management of names of a given type; typically an organization or an enterprise system.

Native Members

description

0..1

string

Description of the name type authority.

A description of the entity that assigns and maintains the Name.name

name

0..1

string

Name of the name type authority.

This is the name of the entity that maintains and uses the Name.name identifier - normally this would be the Utility

OutageArea

Operations

This defines the area covered by the Outage.

Native Members

earliestReportedTime

1..1

dateTime

This is the reported time of the first outage report

metersServed

1..1

integer

defines the number of meters served in the defined area.

outageAreaKind

1..1

AreaKind

defines the type of area that has the outage - county, state, zipcode, etc.

PositionPoint

Common

Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to desribe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).

Native Members

sequenceNumber

1..1

integer

Zero-relative sequence number of this point within a series of points.

xPosition

1..1

string

X axis position.

For this purpose of this message the is defined as the Latitude

yPosition

1..1

string

Y axis position.

For this message this is the Longitude

zPosition

1..1

string

(if applicable) Z axis position.

Enumerations

AreaKind

Operations

Enumeration for the type of area defined; e.g., county, state, parish, zipcode, etc.

borough

county

parish

serviceArea

state

township

ward

zipcode

CrewStatusKind

Common

the enumerated values for the dispatch status

arrived

Indicates that one or more crews have arrived at the work site

assigned

Indicates that one or more crews have been assigned to the work

awaitingCrewAssignment

Indicates that the work is awaiting one or more crews to be assigned

enroute

Indicates that one or more crews are traveling to the work site(s)

fieldComplete

Indicates that the work at one or more work sites has been completed

ERTConfidenceKind

Operations

The estimated time of restoration can have a confidence factor applied such as high or low confidence that the ERT will be accomplished. This confidence factor may be updated as needed during the outage period - just as the actual ERT can be updated.

high

there is a high confidence that the ERT will be accomplished

low

there is a low confidence that the ERT will be accomplished.

OutageCauseKind

Operations

This enumeration describes the primary cause of the outage - planned, unplanned, etc.

animal

This outage was caused by an animal is was unplanned. As such it is treated as a forced outage and is probably classified as "trouble" with a Trouble Ticket as well as a work/service order. The primary difference between this and an unplanned outage is the reason for the outage. If an animal caused this and perished as a result, the utility may have other actions that are required to be taken by the EPA or other groups with whom the utility has an agreement.

lightingStrike

lineDown

poleDown

treeDown

Compound Types

DateTimeInterval

Domain

Interval between two date and time points.

Members

end

1..1

dateTime

End date and time of this interval.

start

1..1

dateTime

Start date and time of this interval.

Datatypes