Class: ClearanceDocument
Safety document used to authorise work on conducting equipment in the field. Tagged equipment is not allowed to be operated.
classDiagram
class ClearanceDocument
SafetyDocument <|-- ClearanceDocument
ClearanceDocument : activity_record
ClearanceDocument --> ActivityRecord : activity_record
ClearanceDocument : alias_name
ClearanceDocument : approver
ClearanceDocument --> Approver : approver
ClearanceDocument : author
ClearanceDocument --> Author : author
ClearanceDocument : author_name
ClearanceDocument : clearance_action
ClearanceDocument --> ClearanceAction : clearance_action
ClearanceDocument : comment
ClearanceDocument : configuration_events
ClearanceDocument --> ConfigurationEvent : configuration_events
ClearanceDocument : created_date_time
ClearanceDocument : description
ClearanceDocument : diagram_objects
ClearanceDocument --> DiagramObject : diagram_objects
ClearanceDocument : doc_status
ClearanceDocument --> Status : doc_status
ClearanceDocument : editor
ClearanceDocument --> Editor : editor
ClearanceDocument : electronic_address
ClearanceDocument --> ElectronicAddress : electronic_address
ClearanceDocument : instance_set
ClearanceDocument --> InstanceSet : instance_set
ClearanceDocument : issued_by_supervisor
ClearanceDocument --> OperationsSafetySupervisor : issued_by_supervisor
ClearanceDocument : issued_date_time
ClearanceDocument : issued_to_supervisor
ClearanceDocument --> FieldSafetySupervisor : issued_to_supervisor
ClearanceDocument : issuer
ClearanceDocument --> Issuer : issuer
ClearanceDocument : last_modified_date_time
ClearanceDocument : m_rid
ClearanceDocument : must_be_deenergised
ClearanceDocument : must_be_grounded
ClearanceDocument : names
ClearanceDocument --> Name : names
ClearanceDocument : properties_cimdata_object
ClearanceDocument --> ChangeSetMember : properties_cimdata_object
ClearanceDocument : released_by_supervisor
ClearanceDocument --> FieldSafetySupervisor : released_by_supervisor
ClearanceDocument : released_date_time
ClearanceDocument : released_to_supervisor
ClearanceDocument --> OperationsSafetySupervisor : released_to_supervisor
ClearanceDocument : revision_number
ClearanceDocument : status
ClearanceDocument --> Status : status
ClearanceDocument : subject
ClearanceDocument : switching_plan
ClearanceDocument --> SwitchingPlan : switching_plan
ClearanceDocument : tagged_psrs
ClearanceDocument --> PowerSystemResource : tagged_psrs
ClearanceDocument : targeting_cimdata_object
ClearanceDocument --> ChangeSetMember : targeting_cimdata_object
ClearanceDocument : title
ClearanceDocument : type
Inheritance
- IdentifiedObject
- Document
- SafetyDocument
- ClearanceDocument
- SafetyDocument
- Document
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| must_be_deenergised | 0..1 Boolean |
If true, the equipment must be deenergised | direct |
| must_be_grounded | 0..1 Boolean |
If true, the equipment must be grounded | direct |
| tagged_psrs | 0..* PowerSystemResource |
All power system resources tagged through this clearance | direct |
| clearance_action | 0..1 ClearanceAction |
Clearance action associated with this clearance | direct |
| issued_date_time | 0..1 date |
Date and time this safety document has been issued | SafetyDocument |
| released_date_time | 0..1 date |
Date and time this safety document has been released | SafetyDocument |
| issued_by_supervisor | 0..1 OperationsSafetySupervisor |
Supervisor that issued this safety document | SafetyDocument |
| issued_to_supervisor | 0..1 FieldSafetySupervisor |
Supervisor to whom this safety document is issued | SafetyDocument |
| switching_plan | 0..1 SwitchingPlan |
Switching plan to which this safety document applies | SafetyDocument |
| released_to_supervisor | 0..1 OperationsSafetySupervisor |
Supervisor to which this safety document is released | SafetyDocument |
| released_by_supervisor | 0..1 FieldSafetySupervisor |
Supervisor that released this safety document | SafetyDocument |
| 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:ClearanceDocument |
| native | cim:ClearanceDocument |
LinkML Source
Direct
name: ClearanceDocument
description: Safety document used to authorise work on conducting equipment in the
field. Tagged equipment is not allowed to be operated.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: SafetyDocument
attributes:
must_be_deenergised:
name: must_be_deenergised
description: If true, the equipment must be deenergised.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.mustBeDeenergised
multivalued: false
domain_of:
- ClearanceDocument
range: boolean
required: false
must_be_grounded:
name: must_be_grounded
description: If true, the equipment must be grounded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.mustBeGrounded
multivalued: false
domain_of:
- ClearanceDocument
range: boolean
required: false
tagged_psrs:
name: tagged_psrs
description: All power system resources tagged through this clearance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.TaggedPSRs
multivalued: true
domain_of:
- ClearanceDocument
range: PowerSystemResource
required: false
clearance_action:
name: clearance_action
description: Clearance action associated with this clearance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.ClearanceAction
multivalued: false
domain_of:
- ClearanceDocument
range: ClearanceAction
required: false
class_uri: cim:ClearanceDocument
Induced
name: ClearanceDocument
description: Safety document used to authorise work on conducting equipment in the
field. Tagged equipment is not allowed to be operated.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: SafetyDocument
attributes:
must_be_deenergised:
name: must_be_deenergised
description: If true, the equipment must be deenergised.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.mustBeDeenergised
multivalued: false
alias: must_be_deenergised
owner: ClearanceDocument
domain_of:
- ClearanceDocument
range: boolean
required: false
must_be_grounded:
name: must_be_grounded
description: If true, the equipment must be grounded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.mustBeGrounded
multivalued: false
alias: must_be_grounded
owner: ClearanceDocument
domain_of:
- ClearanceDocument
range: boolean
required: false
tagged_psrs:
name: tagged_psrs
description: All power system resources tagged through this clearance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.TaggedPSRs
multivalued: true
alias: tagged_psrs
owner: ClearanceDocument
domain_of:
- ClearanceDocument
range: PowerSystemResource
required: false
clearance_action:
name: clearance_action
description: Clearance action associated with this clearance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ClearanceDocument.ClearanceAction
multivalued: false
alias: clearance_action
owner: ClearanceDocument
domain_of:
- ClearanceDocument
range: ClearanceAction
required: false
issued_date_time:
name: issued_date_time
description: Date and time this safety document has been issued.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:SafetyDocument.issuedDateTime
multivalued: false
alias: issued_date_time
owner: ClearanceDocument
domain_of:
- SwitchingAction
- SafetyDocument
range: date
required: false
released_date_time:
name: released_date_time
description: Date and time this safety document has been released.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:SafetyDocument.releasedDateTime
multivalued: false
alias: released_date_time
owner: ClearanceDocument
domain_of:
- SafetyDocument
range: date
required: false
issued_by_supervisor:
name: issued_by_supervisor
description: Supervisor that issued this safety document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:SafetyDocument.IssuedBySupervisor
multivalued: false
alias: issued_by_supervisor
owner: ClearanceDocument
domain_of:
- SafetyDocument
range: OperationsSafetySupervisor
required: false
issued_to_supervisor:
name: issued_to_supervisor
description: Supervisor to whom this safety document is issued.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:SafetyDocument.IssuedToSupervisor
multivalued: false
alias: issued_to_supervisor
owner: ClearanceDocument
domain_of:
- SafetyDocument
range: FieldSafetySupervisor
required: false
switching_plan:
name: switching_plan
description: Switching plan to which this safety document applies.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:SafetyDocument.SwitchingPlan
multivalued: false
alias: switching_plan
owner: ClearanceDocument
domain_of:
- SwitchingPlanRequest
- SwitchingOrder
- WorkTask
- SwitchingAction
- SwitchingStepGroup
- OutagePlan
- PlannedOutageNotification
- SafetyDocument
range: SwitchingPlan
required: false
released_to_supervisor:
name: released_to_supervisor
description: Supervisor to which this safety document is released.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:SafetyDocument.ReleasedToSupervisor
multivalued: false
alias: released_to_supervisor
owner: ClearanceDocument
domain_of:
- SafetyDocument
range: OperationsSafetySupervisor
required: false
released_by_supervisor:
name: released_by_supervisor
description: Supervisor that released this safety document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:SafetyDocument.ReleasedBySupervisor
multivalued: false
alias: released_by_supervisor
owner: ClearanceDocument
domain_of:
- SafetyDocument
range: FieldSafetySupervisor
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
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: ClearanceDocument
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:ClearanceDocument