WorkTimeSchedule

Time schedule specific to work.

Type

Class

URI

cim:WorkTimeSchedule

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.

BaseWork

0..1

BaseWork

Time schedule for this work or work task.

ServiceRequest

0..1

ServiceRequest

The service request for which the work time schedule exists

kind

0..1

WorkTimeScheduleKind

Kind of this work schedule.

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.

MeterReadSchedule

0..1

MeterReadSchedule

Meter read schedule for which the time schedule applies

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.

disabled

0..1

boolean

True if this schedule is deactivated (disabled).

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.

offset

0..1

Seconds

The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic time points to begin. For example, for an interval meter that is set up for five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2 min would result in scheduled events to read the meter executing at 2 min, 7 min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52 min, and 57 min past each hour.

recurrencePattern

0..1

string

Interval at which the scheduled action repeats (e.g., first Monday of every month, last day of the month, etc.).

recurrencePeriod

0..1

Seconds

Duration between time points, from the beginning of one period to the beginning of the next period. Note that a device like a meter may have multiple interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60 min).

revisionNumber

0..1

string

Revision number for this document.

scheduleInterval

0..1

DateTimeInterval

Schedule date and time interval.

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.

TimePoints

0..*

TimePoint

Sequence of time points belonging to this time schedule.


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

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

BaseWork

Time schedule for this work or work task.

URI

cim:WorkTimeSchedule.BaseWork

Cardinality

0..1

Type

BaseWork

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

disabled

True if this schedule is deactivated (disabled).

URI

cim:TimeSchedule.disabled

Cardinality

0..1

Type

boolean

Inherited from

TimeSchedule

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

kind

Kind of this work schedule.

URI

cim:WorkTimeSchedule.kind

Cardinality

0..1

Type

WorkTimeScheduleKind

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

MeterReadSchedule

Meter read schedule for which the time schedule applies

URI

cim:TimeSchedule.MeterReadSchedule

Cardinality

0..1

Type

MeterReadSchedule

Inherited from

TimeSchedule

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

offset

The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic time points to begin. For example, for an interval meter that is set up for five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2 min would result in scheduled events to read the meter executing at 2 min, 7 min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52 min, and 57 min past each hour.

URI

cim:TimeSchedule.offset

Cardinality

0..1

Type

Seconds

Inherited from

TimeSchedule

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

recurrencePattern

Interval at which the scheduled action repeats (e.g., first Monday of every month, last day of the month, etc.).

URI

cim:TimeSchedule.recurrencePattern

Cardinality

0..1

Type

string

Inherited from

TimeSchedule

recurrencePeriod

Duration between time points, from the beginning of one period to the beginning of the next period. Note that a device like a meter may have multiple interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60 min).

URI

cim:TimeSchedule.recurrencePeriod

Cardinality

0..1

Type

Seconds

Inherited from

TimeSchedule

revisionNumber

Revision number for this document.

URI

cim:Document.revisionNumber

Cardinality

0..1

Type

string

Inherited from

Document

scheduleInterval

Schedule date and time interval.

URI

cim:TimeSchedule.scheduleInterval

Cardinality

0..1

Type

DateTimeInterval

Inherited from

TimeSchedule

ServiceRequest

The service request for which the work time schedule exists

URI

cim:WorkTimeSchedule.ServiceRequest

Cardinality

0..1

Type

ServiceRequest

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

TimePoints

Sequence of time points belonging to this time schedule.

URI

cim:TimeSchedule.TimePoints

Cardinality

0..*

Type

TimePoint

Inherited from

TimeSchedule

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