Class: Assignment

An assignment is given to an ErpPerson, Crew, Organisation, Equipment Item, Tool, etc. and may be used to perform Work, WorkTasks, Procedures, etc. TimeSchedules may be set up directly for Assignments or indirectly via the associated WorkTask. Note that these associations are all inherited through the recursive relationship on Document.

URI: cim:Assignment

 classDiagram
    class Assignment
      WorkDocument <|-- Assignment

      Assignment : activity_record

          Assignment --> ActivityRecord : activity_record

      Assignment : alias_name

      Assignment : approver

          Assignment --> Approver : approver

      Assignment : author

          Assignment --> Author : author

      Assignment : author_name

      Assignment : comment

      Assignment : configuration_events

          Assignment --> ConfigurationEvent : configuration_events

      Assignment : created_date_time

      Assignment : crews

          Assignment --> OldCrew : crews

      Assignment : description

      Assignment : diagram_objects

          Assignment --> DiagramObject : diagram_objects

      Assignment : doc_status

          Assignment --> Status : doc_status

      Assignment : editor

          Assignment --> Editor : editor

      Assignment : effective_period

          Assignment --> DateTimeInterval : effective_period

      Assignment : electronic_address

          Assignment --> ElectronicAddress : electronic_address

      Assignment : instance_set

          Assignment --> InstanceSet : instance_set

      Assignment : issuer

          Assignment --> Issuer : issuer

      Assignment : last_modified_date_time

      Assignment : m_rid

      Assignment : names

          Assignment --> Name : names

      Assignment : properties_cimdata_object

          Assignment --> ChangeSetMember : properties_cimdata_object

      Assignment : revision_number

      Assignment : status

          Assignment --> Status : status

      Assignment : subject

      Assignment : targeting_cimdata_object

          Assignment --> ChangeSetMember : targeting_cimdata_object

      Assignment : title

      Assignment : type

Inheritance

IdentifiedObject
- Document
  - WorkDocument
    - Assignment

Slots

Name	Cardinality and Range	Description	Inheritance
effective_period	0..1 DateTimeInterval	Period between the assignment becoming effective and its expiration	direct
crews	0..* OldCrew	All Crews having this Assignment	direct
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

used by	used in	type	used
OldCrew	assignments	range	Assignment

Identifier and Mapping Information

Schema Source

from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type	Mapped Value
self	cim:Assignment
native	cim:Assignment

LinkML Source

Direct

name: Assignment
description: An assignment is given to an ErpPerson, Crew, Organisation, Equipment
  Item, Tool, etc. and may be used to perform Work, WorkTasks, Procedures, etc. TimeSchedules
  may be set up directly for Assignments or indirectly via the associated WorkTask.
  Note that these associations are all inherited through the recursive relationship
  on Document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: WorkDocument
attributes:
  effective_period:
    name: effective_period
    description: Period between the assignment becoming effective and its expiration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Assignment.effectivePeriod
    multivalued: false
    domain_of:
    - Assignment
    range: DateTimeInterval
    required: false
  crews:
    name: crews
    description: All Crews having this Assignment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Assignment.Crews
    multivalued: true
    domain_of:
    - Location
    - WorkTask
    - CrewType
    - ShiftPattern
    - Route
    - Assignment
    range: OldCrew
    required: false
class_uri: cim:Assignment

Induced

name: Assignment
description: An assignment is given to an ErpPerson, Crew, Organisation, Equipment
  Item, Tool, etc. and may be used to perform Work, WorkTasks, Procedures, etc. TimeSchedules
  may be set up directly for Assignments or indirectly via the associated WorkTask.
  Note that these associations are all inherited through the recursive relationship
  on Document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: WorkDocument
attributes:
  effective_period:
    name: effective_period
    description: Period between the assignment becoming effective and its expiration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Assignment.effectivePeriod
    multivalued: false
    alias: effective_period
    owner: Assignment
    domain_of:
    - Assignment
    range: DateTimeInterval
    required: false
  crews:
    name: crews
    description: All Crews having this Assignment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Assignment.Crews
    multivalued: true
    alias: crews
    owner: Assignment
    domain_of:
    - Location
    - WorkTask
    - CrewType
    - ShiftPattern
    - Route
    - Assignment
    range: OldCrew
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    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: Assignment
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Assignment