Skip to content

Class: AuxiliaryAgreement

_An ad-hoc auxiliary account agreement associated with a customer agreement, not part of the customer's account, but typically subject to formal agreement between customer and supplier (utility). Typically this is used to collect revenue owed by the customer for other services or arrears accrued with the utility for other services. It is typically linked to a prepaid token purchase transaction, thus forcing the customer to make a payment towards settlement of the auxiliary account balance whenever the customer needs to purchase a prepaid token for electricity. _

The present status of the auxiliary agreement can be defined in the context of the utility's business rules, for example: enabled, disabled, pending, over recovered, under recovered, written off, etc.

URI: cim:AuxiliaryAgreement

 classDiagram
    class AuxiliaryAgreement
      Agreement <|-- AuxiliaryAgreement

      AuxiliaryAgreement : activity_record

          AuxiliaryAgreement --> ActivityRecord : activity_record

      AuxiliaryAgreement : alias_name

      AuxiliaryAgreement : approver

          AuxiliaryAgreement --> Approver : approver

      AuxiliaryAgreement : arrears_interest

          AuxiliaryAgreement --> PerCent : arrears_interest

      AuxiliaryAgreement : author

          AuxiliaryAgreement --> Author : author

      AuxiliaryAgreement : author_name

      AuxiliaryAgreement : aux_cycle

      AuxiliaryAgreement : aux_priority_code

      AuxiliaryAgreement : auxiliary_accounts

          AuxiliaryAgreement --> AuxiliaryAccount : auxiliary_accounts

      AuxiliaryAgreement : comment

      AuxiliaryAgreement : configuration_events

          AuxiliaryAgreement --> ConfigurationEvent : configuration_events

      AuxiliaryAgreement : created_date_time

      AuxiliaryAgreement : customer_agreement

          AuxiliaryAgreement --> CustomerAgreement : customer_agreement

      AuxiliaryAgreement : description

      AuxiliaryAgreement : diagram_objects

          AuxiliaryAgreement --> DiagramObject : diagram_objects

      AuxiliaryAgreement : doc_status

          AuxiliaryAgreement --> Status : doc_status

      AuxiliaryAgreement : editor

          AuxiliaryAgreement --> Editor : editor

      AuxiliaryAgreement : electronic_address

          AuxiliaryAgreement --> ElectronicAddress : electronic_address

      AuxiliaryAgreement : fixed_amount

          AuxiliaryAgreement --> Money : fixed_amount

      AuxiliaryAgreement : instance_set

          AuxiliaryAgreement --> InstanceSet : instance_set

      AuxiliaryAgreement : issuer

          AuxiliaryAgreement --> Issuer : issuer

      AuxiliaryAgreement : last_modified_date_time

      AuxiliaryAgreement : m_rid

      AuxiliaryAgreement : min_amount

          AuxiliaryAgreement --> Money : min_amount

      AuxiliaryAgreement : names

          AuxiliaryAgreement --> Name : names

      AuxiliaryAgreement : pay_cycle

      AuxiliaryAgreement : properties_cimdata_object

          AuxiliaryAgreement --> ChangeSetMember : properties_cimdata_object

      AuxiliaryAgreement : revision_number

      AuxiliaryAgreement : sign_date

      AuxiliaryAgreement : status

          AuxiliaryAgreement --> Status : status

      AuxiliaryAgreement : sub_type

      AuxiliaryAgreement : subject

      AuxiliaryAgreement : targeting_cimdata_object

          AuxiliaryAgreement --> ChangeSetMember : targeting_cimdata_object

      AuxiliaryAgreement : title

      AuxiliaryAgreement : type

      AuxiliaryAgreement : validity_interval

          AuxiliaryAgreement --> DateTimeInterval : validity_interval

      AuxiliaryAgreement : vend_portion

          AuxiliaryAgreement --> PerCent : vend_portion

      AuxiliaryAgreement : vend_portion_arrear

          AuxiliaryAgreement --> PerCent : vend_portion_arrear

Inheritance

Slots

Name Cardinality and Range Description Inheritance
arrears_interest 0..1
PerCent		 The interest per annum to be charged prorata on 'AuxiliaryAccount direct
aux_cycle 0..1
String		 The frequency for automatically recurring auxiliary charges, where 'Auxiliary... direct
aux_priority_code 0..1
String		 The coded priority indicating the priority that this auxiliary agreement has ... direct
fixed_amount 0..1
Money		 The fixed amount that has to be collected from each vending transaction towar... direct
min_amount 0..1
Money		 The minimum amount that has to be paid at any transaction towards settling th... direct
pay_cycle 0..1
String		 The contractually expected payment frequency (by the customer) direct
sub_type 0..1
String		 Sub-classification of the inherited 'type' for this AuxiliaryAgreement direct
vend_portion 0..1
PerCent		 The percentage of the transaction amount that has to be collected from each v... direct
vend_portion_arrear 0..1
PerCent		 The percentage of the transaction amount that has to be collected from each v... direct
auxiliary_accounts 1..*
AuxiliaryAccount		 All auxiliary accounts regulated by this agreement direct
customer_agreement 0..1
CustomerAgreement		 Customer agreement this (non-service related) auxiliary agreement refers to direct
sign_date 0..1
date		 Date this agreement was consummated among associated persons and/or organisat... Agreement
validity_interval 0..1
DateTimeInterval		 Date and time interval this agreement is valid (from going into effect to ter... Agreement
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
CustomerAgreement auxiliary_agreements range AuxiliaryAgreement
AuxiliaryAccount auxiliary_agreement range AuxiliaryAgreement

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: AuxiliaryAgreement
description: "An ad-hoc auxiliary account agreement associated with a customer agreement,\
  \ not part of the customer's account, but typically subject to formal agreement\
  \ between customer and supplier (utility). Typically this is used to collect revenue\
  \ owed by the customer for other services or arrears accrued with the utility for\
  \ other services. It is typically linked to a prepaid token purchase transaction,\
  \ thus forcing the customer to make a payment towards settlement of the auxiliary\
  \ account balance whenever the customer needs to purchase a prepaid token for electricity.\r\
  \nThe present status of the auxiliary agreement can be defined in the context of\
  \ the utility's business rules, for example: enabled, disabled, pending, over recovered,\
  \ under recovered, written off, etc."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Agreement
attributes:
  arrears_interest:
    name: arrears_interest
    description: "The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears'\
      \ at the end of each 'payCycle'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.arrearsInterest
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: PerCent
    required: false
  aux_cycle:
    name: aux_cycle
    description: "The frequency for automatically recurring auxiliary charges, where\
      \ 'AuxiliaryAccount.initialCharge' is recursively added to 'AuxiliaryAccount.dueCurrent'\
      \ at the start of each 'auxCycle'. For example: on a specified date and time;\
      \ hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.auxCycle
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  aux_priority_code:
    name: aux_priority_code
    description: "The coded priority indicating the priority that this auxiliary agreement\
      \ has above other auxiliary agreements (associated with the same customer agreement)\
      \ when it comes to competing for settlement from a payment transaction or token\
      \ purchase.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.auxPriorityCode
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  fixed_amount:
    name: fixed_amount
    description: The fixed amount that has to be collected from each vending transaction
      towards settlement of this auxiliary agreement. Note that there may be multiple
      tokens vended per vending transaction, but this is not relevant.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.fixedAmount
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: Money
    required: false
  min_amount:
    name: min_amount
    description: The minimum amount that has to be paid at any transaction towards
      settling this auxiliary agreement or reducing the balance.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.minAmount
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: Money
    required: false
  pay_cycle:
    name: pay_cycle
    description: 'The contractually expected payment frequency (by the customer).
      Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.payCycle
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  sub_type:
    name: sub_type
    description: "Sub-classification of the inherited 'type' for this AuxiliaryAgreement.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.subType
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  vend_portion:
    name: vend_portion
    description: The percentage of the transaction amount that has to be collected
      from each vending transaction towards settlement of this auxiliary agreement
      when payments are not in arrears. Note that there may be multiple tokens vended
      per vending transaction, but this is not relevant.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.vendPortion
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: PerCent
    required: false
  vend_portion_arrear:
    name: vend_portion_arrear
    description: The percentage of the transaction amount that has to be collected
      from each vending transaction towards settlement of this auxiliary agreement
      when payments are in arrears. Note that there may be multiple tokens vended
      per vending transaction, but this is not relevant.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.vendPortionArrear
    multivalued: false
    domain_of:
    - AuxiliaryAgreement
    range: PerCent
    required: false
  auxiliary_accounts:
    name: auxiliary_accounts
    description: All auxiliary accounts regulated by this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.AuxiliaryAccounts
    multivalued: true
    domain_of:
    - AuxiliaryAgreement
    - Charge
    range: AuxiliaryAccount
    required: true
  customer_agreement:
    name: customer_agreement
    description: Customer agreement this (non-service related) auxiliary agreement
      refers to.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AuxiliaryAgreement.CustomerAgreement
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - UsagePoint
    - AuxiliaryAgreement
    - MeterReading
    range: CustomerAgreement
    required: false
class_uri: cim:AuxiliaryAgreement

Induced

name: AuxiliaryAgreement
description: "An ad-hoc auxiliary account agreement associated with a customer agreement,\
  \ not part of the customer's account, but typically subject to formal agreement\
  \ between customer and supplier (utility). Typically this is used to collect revenue\
  \ owed by the customer for other services or arrears accrued with the utility for\
  \ other services. It is typically linked to a prepaid token purchase transaction,\
  \ thus forcing the customer to make a payment towards settlement of the auxiliary\
  \ account balance whenever the customer needs to purchase a prepaid token for electricity.\r\
  \nThe present status of the auxiliary agreement can be defined in the context of\
  \ the utility's business rules, for example: enabled, disabled, pending, over recovered,\
  \ under recovered, written off, etc."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Agreement
attributes:
  arrears_interest:
    name: arrears_interest
    description: "The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears'\
      \ at the end of each 'payCycle'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.arrearsInterest
    multivalued: false
    alias: arrears_interest
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: PerCent
    required: false
  aux_cycle:
    name: aux_cycle
    description: "The frequency for automatically recurring auxiliary charges, where\
      \ 'AuxiliaryAccount.initialCharge' is recursively added to 'AuxiliaryAccount.dueCurrent'\
      \ at the start of each 'auxCycle'. For example: on a specified date and time;\
      \ hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.auxCycle
    multivalued: false
    alias: aux_cycle
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  aux_priority_code:
    name: aux_priority_code
    description: "The coded priority indicating the priority that this auxiliary agreement\
      \ has above other auxiliary agreements (associated with the same customer agreement)\
      \ when it comes to competing for settlement from a payment transaction or token\
      \ purchase.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.auxPriorityCode
    multivalued: false
    alias: aux_priority_code
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  fixed_amount:
    name: fixed_amount
    description: The fixed amount that has to be collected from each vending transaction
      towards settlement of this auxiliary agreement. Note that there may be multiple
      tokens vended per vending transaction, but this is not relevant.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.fixedAmount
    multivalued: false
    alias: fixed_amount
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: Money
    required: false
  min_amount:
    name: min_amount
    description: The minimum amount that has to be paid at any transaction towards
      settling this auxiliary agreement or reducing the balance.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.minAmount
    multivalued: false
    alias: min_amount
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: Money
    required: false
  pay_cycle:
    name: pay_cycle
    description: 'The contractually expected payment frequency (by the customer).
      Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.payCycle
    multivalued: false
    alias: pay_cycle
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  sub_type:
    name: sub_type
    description: "Sub-classification of the inherited 'type' for this AuxiliaryAgreement.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.subType
    multivalued: false
    alias: sub_type
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: string
    required: false
  vend_portion:
    name: vend_portion
    description: The percentage of the transaction amount that has to be collected
      from each vending transaction towards settlement of this auxiliary agreement
      when payments are not in arrears. Note that there may be multiple tokens vended
      per vending transaction, but this is not relevant.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.vendPortion
    multivalued: false
    alias: vend_portion
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: PerCent
    required: false
  vend_portion_arrear:
    name: vend_portion_arrear
    description: The percentage of the transaction amount that has to be collected
      from each vending transaction towards settlement of this auxiliary agreement
      when payments are in arrears. Note that there may be multiple tokens vended
      per vending transaction, but this is not relevant.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.vendPortionArrear
    multivalued: false
    alias: vend_portion_arrear
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    range: PerCent
    required: false
  auxiliary_accounts:
    name: auxiliary_accounts
    description: All auxiliary accounts regulated by this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AuxiliaryAgreement.AuxiliaryAccounts
    multivalued: true
    alias: auxiliary_accounts
    owner: AuxiliaryAgreement
    domain_of:
    - AuxiliaryAgreement
    - Charge
    range: AuxiliaryAccount
    required: true
  customer_agreement:
    name: customer_agreement
    description: Customer agreement this (non-service related) auxiliary agreement
      refers to.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AuxiliaryAgreement.CustomerAgreement
    multivalued: false
    alias: customer_agreement
    owner: AuxiliaryAgreement
    domain_of:
    - MeterReadSchedule
    - UsagePoint
    - AuxiliaryAgreement
    - MeterReading
    range: CustomerAgreement
    required: false
  sign_date:
    name: sign_date
    description: "Date this agreement was consummated among associated persons and/or\
      \ organisations.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Agreement.signDate
    multivalued: false
    alias: sign_date
    owner: AuxiliaryAgreement
    domain_of:
    - Agreement
    range: date
    required: false
  validity_interval:
    name: validity_interval
    description: Date and time interval this agreement is valid (from going into effect
      to termination).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Agreement.validityInterval
    multivalued: false
    alias: validity_interval
    owner: AuxiliaryAgreement
    domain_of:
    - Agreement
    - Capability
    - DemandResponseProgram
    - ShiftPattern
    range: DateTimeInterval
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    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: AuxiliaryAgreement
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:AuxiliaryAgreement