Skip to content

Class: OrganisationRole

_Identifies a way in which an organisation may participate in the utility enterprise (e.g., customer, manufacturer, etc). _

__

URI: cim:OrganisationRole

 classDiagram
    class OrganisationRole
      IdentifiedObject <|-- OrganisationRole


      OrganisationRole <|-- Customer
      OrganisationRole <|-- PersonOrganisationRole
      OrganisationRole <|-- PropertyOrganisationRole
      OrganisationRole <|-- Manufacturer
      OrganisationRole <|-- ServiceSupplier
      OrganisationRole <|-- Bank
      OrganisationRole <|-- CRROrgRole
      OrganisationRole <|-- MarketRole
      OrganisationRole <|-- EnvironmentalDataAuthority
      OrganisationRole <|-- EnvironmentalDataProvider
      OrganisationRole <|-- AssetOrganisationRole
      OrganisationRole <|-- DocumentOrganisationRole
      OrganisationRole <|-- OrgOrgRole
      OrganisationRole <|-- BusinessRole


      OrganisationRole : alias_name

      OrganisationRole : configuration_events

          OrganisationRole --> ConfigurationEvent : configuration_events

      OrganisationRole : description

      OrganisationRole : diagram_objects

          OrganisationRole --> DiagramObject : diagram_objects

      OrganisationRole : instance_set

          OrganisationRole --> InstanceSet : instance_set

      OrganisationRole : m_rid

      OrganisationRole : names

          OrganisationRole --> Name : names

      OrganisationRole : organisation

          OrganisationRole --> Organisation : organisation

      OrganisationRole : properties_cimdata_object

          OrganisationRole --> ChangeSetMember : properties_cimdata_object

      OrganisationRole : targeting_cimdata_object

          OrganisationRole --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
organisation 0..1
Organisation
Organisation having this role direct
configuration_events 0..*
ConfigurationEvent
All configuration events created for this organisation role direct
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
Organisation roles range OrganisationRole
ConfigurationEvent changed_organisation_role range OrganisationRole
RTO roles range OrganisationRole
MarketParticipant roles range OrganisationRole
TransmissionProvider roles range OrganisationRole
ControlAreaOperator roles range OrganisationRole
CustomerConsumer roles range OrganisationRole
SchedulingCoordinator roles range OrganisationRole
Marketer roles range OrganisationRole
GenerationProvider roles range OrganisationRole
ParentOrganization roles range OrganisationRole

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: OrganisationRole
description: "Identifies a way in which an organisation may participate in the utility\
  \ enterprise (e.g., customer, manufacturer, etc).\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  organisation:
    name: organisation
    description: Organisation having this role.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:OrganisationRole.Organisation
    multivalued: false
    domain_of:
    - OrganisationRole
    - ParentOrganization
    range: Organisation
    required: false
  configuration_events:
    name: configuration_events
    description: All configuration events created for this organisation role.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:OrganisationRole.ConfigurationEvents
    multivalued: true
    domain_of:
    - Asset
    - Document
    - PersonRole
    - OrganisationRole
    - Location
    - UsagePoint
    - ServiceCategory
    range: ConfigurationEvent
    required: false
class_uri: cim:OrganisationRole

Induced

name: OrganisationRole
description: "Identifies a way in which an organisation may participate in the utility\
  \ enterprise (e.g., customer, manufacturer, etc).\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  organisation:
    name: organisation
    description: Organisation having this role.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:OrganisationRole.Organisation
    multivalued: false
    alias: organisation
    owner: OrganisationRole
    domain_of:
    - OrganisationRole
    - ParentOrganization
    range: Organisation
    required: false
  configuration_events:
    name: configuration_events
    description: All configuration events created for this organisation role.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:OrganisationRole.ConfigurationEvents
    multivalued: true
    alias: configuration_events
    owner: OrganisationRole
    domain_of:
    - Asset
    - Document
    - PersonRole
    - OrganisationRole
    - Location
    - UsagePoint
    - ServiceCategory
    range: ConfigurationEvent
    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: OrganisationRole
    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: OrganisationRole
    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: OrganisationRole
    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: OrganisationRole
    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: OrganisationRole
    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: OrganisationRole
    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: OrganisationRole
    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: OrganisationRole
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:OrganisationRole