Skip to content

Class: Settlement

_Specifies a settlement run. _

__

URI: cim:Settlement

 classDiagram
    class Settlement
      Document <|-- Settlement

      Settlement : activity_record

          Settlement --> ActivityRecord : activity_record

      Settlement : alias_name

      Settlement : approver

          Settlement --> Approver : approver

      Settlement : author

          Settlement --> Author : author

      Settlement : author_name

      Settlement : comment

      Settlement : configuration_events

          Settlement --> ConfigurationEvent : configuration_events

      Settlement : created_date_time

      Settlement : description

      Settlement : diagram_objects

          Settlement --> DiagramObject : diagram_objects

      Settlement : doc_status

          Settlement --> Status : doc_status

      Settlement : editor

          Settlement --> Editor : editor

      Settlement : electronic_address

          Settlement --> ElectronicAddress : electronic_address

      Settlement : energy_market

          Settlement --> EnergyMarket : energy_market

      Settlement : instance_set

          Settlement --> InstanceSet : instance_set

      Settlement : issuer

          Settlement --> Issuer : issuer

      Settlement : last_modified_date_time

      Settlement : m_rid

      Settlement : major_charge_group

          Settlement --> MajorChargeGroup : major_charge_group

      Settlement : market_invoice_line_item

          Settlement --> MarketInvoiceLineItem : market_invoice_line_item

      Settlement : market_ledger_entry

          Settlement --> MarketLedgerEntry : market_ledger_entry

      Settlement : names

          Settlement --> Name : names

      Settlement : properties_cimdata_object

          Settlement --> ChangeSetMember : properties_cimdata_object

      Settlement : revision_number

      Settlement : status

          Settlement --> Status : status

      Settlement : subject

      Settlement : targeting_cimdata_object

          Settlement --> ChangeSetMember : targeting_cimdata_object

      Settlement : title

      Settlement : trade_date

      Settlement : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
trade_date 0..1
date		 The trade date on which the settlement is run direct
energy_market 0..1
EnergyMarket		 direct
major_charge_group 1..*
MajorChargeGroup		 direct
market_invoice_line_item 0..*
MarketInvoiceLineItem		 direct
market_ledger_entry 0..*
MarketLedgerEntry		 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
EnergyMarket settlements range Settlement
MajorChargeGroup settlement range Settlement
MarketInvoiceLineItem settlement range Settlement
MarketLedgerEntry settlement range Settlement

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Settlement
description: "Specifies a settlement run.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  trade_date:
    name: trade_date
    description: "The trade date on which the settlement is run. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.tradeDate
    multivalued: false
    domain_of:
    - Settlement
    - PassThroughBill
    - MarketStatement
    range: date
    required: false
  energy_market:
    name: energy_market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Settlement.EnergyMarket
    multivalued: false
    domain_of:
    - Bid
    - MarketResults
    - Settlement
    range: EnergyMarket
    required: false
  major_charge_group:
    name: major_charge_group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.MajorChargeGroup
    multivalued: true
    domain_of:
    - Settlement
    - MarketInvoice
    - MarketScheduledEvent
    - ChargeType
    range: MajorChargeGroup
    required: true
  market_invoice_line_item:
    name: market_invoice_line_item
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.MarketInvoiceLineItem
    multivalued: true
    domain_of:
    - Settlement
    range: MarketInvoiceLineItem
    required: false
  market_ledger_entry:
    name: market_ledger_entry
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.MarketLedgerEntry
    multivalued: true
    domain_of:
    - Settlement
    range: MarketLedgerEntry
    required: false
class_uri: cim:Settlement

Induced

name: Settlement
description: "Specifies a settlement run.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  trade_date:
    name: trade_date
    description: "The trade date on which the settlement is run. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.tradeDate
    multivalued: false
    alias: trade_date
    owner: Settlement
    domain_of:
    - Settlement
    - PassThroughBill
    - MarketStatement
    range: date
    required: false
  energy_market:
    name: energy_market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Settlement.EnergyMarket
    multivalued: false
    alias: energy_market
    owner: Settlement
    domain_of:
    - Bid
    - MarketResults
    - Settlement
    range: EnergyMarket
    required: false
  major_charge_group:
    name: major_charge_group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.MajorChargeGroup
    multivalued: true
    alias: major_charge_group
    owner: Settlement
    domain_of:
    - Settlement
    - MarketInvoice
    - MarketScheduledEvent
    - ChargeType
    range: MajorChargeGroup
    required: true
  market_invoice_line_item:
    name: market_invoice_line_item
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.MarketInvoiceLineItem
    multivalued: true
    alias: market_invoice_line_item
    owner: Settlement
    domain_of:
    - Settlement
    range: MarketInvoiceLineItem
    required: false
  market_ledger_entry:
    name: market_ledger_entry
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Settlement.MarketLedgerEntry
    multivalued: true
    alias: market_ledger_entry
    owner: Settlement
    domain_of:
    - Settlement
    range: MarketLedgerEntry
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    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: Settlement
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Settlement