OutageScenario

Type: object
No Additional Properties

ActivityRecord_PointerArray

Type: array

Pointers to ActivityRecord objects

No Additional Items

Each item of this array must be:

ActivityRecord_Pointer

Type: object

Pointer to ActivityRecord object

ActivityRecordPointer

Type: string

Pointer to ActivityRecord object

EnvironmentalEventPointer

Type: string

Pointer to EnvironmentalEvent object

Equipment_PointerArray

Type: array of string

Pointers to Equipment objects

No Additional Items

Each item of this array must be:

EquipmentPointer

Type: string

Pointer to Equipment object

status

Type: Status

Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.

comment

Type: string

Free text comment.

docStatus

Type: Status

Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute.
Example values for 'docStatus.status' are draft, approved, cancelled, etc.

cimObjectType

Type: enum (of string)

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Must be one of:

  • "OutageScenario"

electronicAddress

Type: ElectronicAddress

Electronic address.

description

Type: string

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.

authorName

Type: string

Name of the author of this document.

statusKind

Type: CrewStatusKind

defines the status of the crew as in dispatched or arrived, etc.

anticipatedStartDay

Type: string

nan

anticipatedStartHour

Type: integer

nan

anticipatedDuration

Type: string

nan

loadFractionTotal

Type: PerCent

nan

loadFractionCritical

Type: PerCent

nan

utilityDisclaimer

Type: string

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.

weight

Type: number

nan

type

Type: string

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.).

title

Type: string

Document title.

communityDescriptor

Type: string

a name to denote the community - this could be a name or a code of some kind.

revisionNumber

Type: string

Revision number for this document.

originalCustomersServed

Type: integer

the total number of customers that are served in the area (both outaged and not outaged).

estimatedPeriod

Type: DateTimeInterval

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.

customersRestored

Type: integer

number of customers that have been restored in the area.

createdDateTime

Type: string

Date and time that this document was created.

originalMetersAffected

Type: integer

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.

subject

Type: string

Document subject.

lastModifiedDateTime

Type: string

Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.

summary

Type: ServicePointOutageSummary

Summary counts of service points (customers) affected by this outage.

metersAffected

Type: integer

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.

actualPeriod

Type: DateTimeInterval

Actual outage period; end of the period corresponds to the actual restoration time.

outageKind

Type: OutageStatusKind

Defines if the outage has been verified or is only estimated

aliasName

Type: string

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.
The 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.

mRID

Type: 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, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

name

Type: string

The name is any free human readable and possibly non unique text naming the object.