ServiceGuarantee

A service guarantee, often imposed by a regulator, defines conditions that, if not satisfied, will result in the utility making a monetary payment to the customer. Note that guarantee's identifier is in the 'name' attribute and the status of the guarantee is in the 'Status.status' attribute. Example service requirements include: 1) If power is not restored within 24 hours, customers can claim $50 for residential customers or $100 for commercial and industrial customers. In addition for each extra period of 12 hours the customer's supply has not been activated, the customer can claim $25. 2) If a customer has a question about their electricity bill, the utility will investigate and respond to the inquiry within 15 working days. If utility fails to meet its guarantee, utility will automatically pay the customer $50.

Type

Class

URI

cim:ServiceGuarantee

CIM standard (perspective)

IEC61968 (Enterprise)

Class hierarchy

Slots

Associated classes
Figure 1. Associated classes
Name Cardinality Type Description

InstanceSet

1

InstanceSet

Dataset containing the data objects.

applicationPeriod

0..1

DateTimeInterval

Period in which this service guantee applies.

automaticPay

0..1

boolean

True if utility must autmatically pay the specified amount whenever the condition is not satisified, otherwise customer must make a claim to receive payment.

payAmount

0..1

Money

Amount to be paid by the service provider to the customer for each violation of the 'serviceRequirement'.

serviceRequirement

0..1

string

Explanation of the requirement and conditions for satisfying it.

Approver

0..1

Approver

Approver of this document.

Author

0..1

Author

Author of this document.

Editor

0..1

Editor

Editor of this document.

Issuer

0..1

Issuer

Issuer of this document.

PropertiesCIMDataObject

0..1

ChangeSetMember

The single CIM data object in the appropriate dataset context.

aliasName

0..1

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.

authorName

0..1

string

Name of the author of this document.

comment

0..1

string

Free text comment.

createdDateTime

0..1

date

Date and time that this document was created.

description

0..1

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.

docStatus

0..1

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.

electronicAddress

0..1

ElectronicAddress

Electronic address.

lastModifiedDateTime

0..1

date

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

mRID

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

name

0..1

string

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

revisionNumber

0..1

string

Revision number for this document.

status

0..1

Status

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

subject

0..1

string

Document subject.

title

0..1

string

Document title.

type

0..1

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

ActivityRecord

0..*

ActivityRecord

The activity record for a document

ConfigurationEvents

0..*

ConfigurationEvent

All configuration events created for this document.

DiagramObjects

0..*

DiagramObject

The diagram objects that are associated with the domain object.

Names

0..*

Name

All names of this identified object.

TargetingCIMDataObject

0..*

ChangeSetMember

Data objects registered.


ActivityRecord

The activity record for a document

URI

cim:Document.ActivityRecord

Cardinality

0..*

Type

ActivityRecord

Inherited from

Document

aliasName

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.

URI

cim:IdentifiedObject.aliasName

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

applicationPeriod

Period in which this service guantee applies.

URI

cim:ServiceGuarantee.applicationPeriod

Cardinality

0..1

Type

DateTimeInterval

Approver

Approver of this document.

URI

cim:Document.Approver

Cardinality

0..1

Type

Approver

Inherited from

Document

Author

Author of this document.

URI

cim:Document.Author

Cardinality

0..1

Type

Author

Inherited from

Document

authorName

Name of the author of this document.

URI

cim:Document.authorName

Cardinality

0..1

Type

string

Inherited from

Document

automaticPay

True if utility must autmatically pay the specified amount whenever the condition is not satisified, otherwise customer must make a claim to receive payment.

URI

cim:ServiceGuarantee.automaticPay

Cardinality

0..1

Type

boolean

comment

Free text comment.

URI

cim:Document.comment

Cardinality

0..1

Type

string

Inherited from

Document

ConfigurationEvents

All configuration events created for this document.

URI

cim:Document.ConfigurationEvents

Cardinality

0..*

Type

ConfigurationEvent

Inherited from

Document

createdDateTime

Date and time that this document was created.

URI

cim:Document.createdDateTime

Cardinality

0..1

Type

date

Inherited from

Document

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.

URI

cim:IdentifiedObject.description

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

DiagramObjects

The diagram objects that are associated with the domain object.

URI

cim:IdentifiedObject.DiagramObjects

Cardinality

0..*

Type

DiagramObject

Inherited from

IdentifiedObject

docStatus

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.

URI

cim:Document.docStatus

Cardinality

0..1

Type

Status

Inherited from

Document

Editor

Editor of this document.

URI

cim:Document.Editor

Cardinality

0..1

Type

Editor

Inherited from

Document

electronicAddress

Electronic address.

URI

cim:Document.electronicAddress

Cardinality

0..1

Type

ElectronicAddress

Inherited from

Document

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

Issuer

Issuer of this document.

URI

cim:Document.Issuer

Cardinality

0..1

Type

Issuer

Inherited from

Document

lastModifiedDateTime

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

URI

cim:Document.lastModifiedDateTime

Cardinality

0..1

Type

date

Inherited from

Document

mRID

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.

URI

cim:IdentifiedObject.mRID

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

name

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

URI

cim:IdentifiedObject.name

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Names

All names of this identified object.

URI

cim:IdentifiedObject.Names

Cardinality

0..*

Type

Name

Inherited from

IdentifiedObject

payAmount

Amount to be paid by the service provider to the customer for each violation of the 'serviceRequirement'.

URI

cim:ServiceGuarantee.payAmount

Cardinality

0..1

Type

Money

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

revisionNumber

Revision number for this document.

URI

cim:Document.revisionNumber

Cardinality

0..1

Type

string

Inherited from

Document

serviceRequirement

Explanation of the requirement and conditions for satisfying it.

URI

cim:ServiceGuarantee.serviceRequirement

Cardinality

0..1

Type

string

status

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

URI

cim:Document.status

Cardinality

0..1

Type

Status

Inherited from

Document

subject

Document subject.

URI

cim:Document.subject

Cardinality

0..1

Type

string

Inherited from

Document

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

title

Document title.

URI

cim:Document.title

Cardinality

0..1

Type

string

Inherited from

Document

type

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

URI

cim:Document.type

Cardinality

0..1

Type

string

Inherited from

Document