Skip to content

Class: MarketAgreement

_An identification or eventually the contents of an agreement between two or more parties. _

__

URI: cim:MarketAgreement

 classDiagram
    class MarketAgreement
      MarketDocument <|-- MarketAgreement

      MarketAgreement : ace_tariff_type

          MarketAgreement --> AceTariffType : ace_tariff_type

      MarketAgreement : activity_record

          MarketAgreement --> ActivityRecord : activity_record

      MarketAgreement : alias_name

      MarketAgreement : approver

          MarketAgreement --> Approver : approver

      MarketAgreement : attribute_instance_component

          MarketAgreement --> AttributeInstanceComponent : attribute_instance_component

      MarketAgreement : author

          MarketAgreement --> Author : author

      MarketAgreement : author_name

      MarketAgreement : comment

      MarketAgreement : configuration_events

          MarketAgreement --> ConfigurationEvent : configuration_events

      MarketAgreement : created_date_time

      MarketAgreement : date_and_or_time

          MarketAgreement --> DateAndOrTime : date_and_or_time

      MarketAgreement : description

      MarketAgreement : diagram_objects

          MarketAgreement --> DiagramObject : diagram_objects

      MarketAgreement : doc_status

          MarketAgreement --> Status : doc_status

      MarketAgreement : domain

          MarketAgreement --> Domain : domain

      MarketAgreement : editor

          MarketAgreement --> Editor : editor

      MarketAgreement : electronic_address

          MarketAgreement --> ElectronicAddress : electronic_address

      MarketAgreement : instance_set

          MarketAgreement --> InstanceSet : instance_set

      MarketAgreement : issuer

          MarketAgreement --> Issuer : issuer

      MarketAgreement : last_modified_date_time

      MarketAgreement : m_rid

      MarketAgreement : market_document

          MarketAgreement --> MarketDocument : market_document

      MarketAgreement : market_participant

          MarketAgreement --> MarketParticipant : market_participant

      MarketAgreement : names

          MarketAgreement --> Name : names

      MarketAgreement : period

          MarketAgreement --> Period : period

      MarketAgreement : process

          MarketAgreement --> Process : process

      MarketAgreement : properties_cimdata_object

          MarketAgreement --> ChangeSetMember : properties_cimdata_object

      MarketAgreement : reason

          MarketAgreement --> Reason : reason

      MarketAgreement : revision_number

      MarketAgreement : self_market_document

          MarketAgreement --> MarketDocument : self_market_document

      MarketAgreement : status

          MarketAgreement --> Status : status

      MarketAgreement : subject

      MarketAgreement : targeting_cimdata_object

          MarketAgreement --> ChangeSetMember : targeting_cimdata_object

      MarketAgreement : time_series

          MarketAgreement --> TimeSeries : time_series

      MarketAgreement : title

      MarketAgreement : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
period 0..*
Period
MarketDocument
self_market_document 0..*
MarketDocument
MarketDocument
attribute_instance_component 0..*
AttributeInstanceComponent
MarketDocument
domain 0..*
Domain
MarketDocument
process 0..*
Process
MarketDocument
ace_tariff_type 0..*
AceTariffType
MarketDocument
market_participant 0..*
MarketParticipant
MarketDocument
market_document 0..*
MarketDocument
MarketDocument
time_series 0..*
TimeSeries
MarketDocument
reason 0..*
Reason
MarketDocument
date_and_or_time 0..*
DateAndOrTime
MarketDocument
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

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MarketAgreement
description: "An identification  or eventually the contents of an agreement between\
  \ two or more parties.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MarketDocument
class_uri: cim:MarketAgreement

Induced

name: MarketAgreement
description: "An identification  or eventually the contents of an agreement between\
  \ two or more parties.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MarketDocument
attributes:
  period:
    name: period
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.Period
    multivalued: true
    alias: period
    owner: MarketAgreement
    domain_of:
    - TimeSeries
    - MarketDocument
    - Point
    - Reason
    range: Period
    required: false
  self_market_document:
    name: self_market_document
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketDocument.SelfMarketDocument
    multivalued: true
    alias: self_market_document
    owner: MarketAgreement
    domain_of:
    - MarketDocument
    range: MarketDocument
    required: false
  attribute_instance_component:
    name: attribute_instance_component
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.AttributeInstanceComponent
    multivalued: true
    alias: attribute_instance_component
    owner: MarketAgreement
    domain_of:
    - TimeSeries
    - MarketDocument
    range: AttributeInstanceComponent
    required: false
  domain:
    name: domain
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.Domain
    multivalued: true
    alias: domain
    owner: MarketAgreement
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    - TimeSeries
    - MarketDocument
    - RegisteredResource
    - Quantity
    - Price
    range: Domain
    required: false
  process:
    name: process
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketDocument.Process
    multivalued: true
    alias: process
    owner: MarketAgreement
    domain_of:
    - MarketDocument
    range: Process
    required: false
  ace_tariff_type:
    name: ace_tariff_type
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketDocument.AceTariffType
    multivalued: true
    alias: ace_tariff_type
    owner: MarketAgreement
    domain_of:
    - MarketDocument
    - Point
    - Unit
    range: AceTariffType
    required: false
  market_participant:
    name: market_participant
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.MarketParticipant
    multivalued: true
    alias: market_participant
    owner: MarketAgreement
    domain_of:
    - TimeSeries
    - MarketDocument
    - RegisteredResource
    - Bid
    - SchedulingCoordinator
    - MarketRole
    - MarketPerson
    range: MarketParticipant
    required: false
  market_document:
    name: market_document
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.MarketDocument
    multivalued: true
    alias: market_document
    owner: MarketAgreement
    domain_of:
    - TimeSeries
    - AttributeInstanceComponent
    - MarketDocument
    - Process
    - AceTariffType
    - Reason
    - MarketParticipant
    - Domain
    - Period
    - DateAndOrTime
    range: MarketDocument
    required: false
  time_series:
    name: time_series
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.TimeSeries
    multivalued: true
    alias: time_series
    owner: MarketAgreement
    domain_of:
    - EnvironmentalMonitoringStation
    - ConstraintDuration
    - AttributeInstanceComponent
    - MarketDocument
    - Point
    - Reason
    - RegisteredResource
    - MarketParticipant
    - Domain
    - Quantity
    - Price
    - MarketObjectStatus
    - Period
    - FlowDirection
    - Unit
    - DateAndOrTime
    - Auction
    - MktPSRType
    - MarketEvaluationPoint
    range: TimeSeries
    required: false
  reason:
    name: reason
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.Reason
    multivalued: true
    alias: reason
    owner: MarketAgreement
    domain_of:
    - Status
    - PlannedOutage
    - ActivityRecord
    - AccountMovement
    - Reading
    - EndDeviceControl
    - MetrologyRequirement
    - TimeSeries
    - MarketDocument
    - Point
    - RegisteredResource
    - EnergyTransaction
    - Period
    range: Reason
    required: false
  date_and_or_time:
    name: date_and_or_time
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketDocument.DateAndOrTime
    multivalued: true
    alias: date_and_or_time
    owner: MarketAgreement
    domain_of:
    - TimeSeries
    - MarketDocument
    range: DateAndOrTime
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    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: MarketAgreement
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MarketAgreement