Skip to content

Class: CustomerAgreement

Agreement between the customer and the service supplier to pay for service at a specific service location. It records certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.

URI: cim:CustomerAgreement

 classDiagram
    class CustomerAgreement
      Agreement <|-- CustomerAgreement

      CustomerAgreement : activity_record

          CustomerAgreement --> ActivityRecord : activity_record

      CustomerAgreement : alias_name

      CustomerAgreement : approver

          CustomerAgreement --> Approver : approver

      CustomerAgreement : author

          CustomerAgreement --> Author : author

      CustomerAgreement : author_name

      CustomerAgreement : auxiliary_agreements

          CustomerAgreement --> AuxiliaryAgreement : auxiliary_agreements

      CustomerAgreement : comment

      CustomerAgreement : configuration_events

          CustomerAgreement --> ConfigurationEvent : configuration_events

      CustomerAgreement : created_date_time

      CustomerAgreement : customer

          CustomerAgreement --> Customer : customer

      CustomerAgreement : customer_account

          CustomerAgreement --> CustomerAccount : customer_account

      CustomerAgreement : demand_response_programs

          CustomerAgreement --> DemandResponseProgram : demand_response_programs

      CustomerAgreement : description

      CustomerAgreement : diagram_objects

          CustomerAgreement --> DiagramObject : diagram_objects

      CustomerAgreement : doc_status

          CustomerAgreement --> Status : doc_status

      CustomerAgreement : editor

          CustomerAgreement --> Editor : editor

      CustomerAgreement : electronic_address

          CustomerAgreement --> ElectronicAddress : electronic_address

      CustomerAgreement : instance_set

          CustomerAgreement --> InstanceSet : instance_set

      CustomerAgreement : is_pre_pay

      CustomerAgreement : issuer

          CustomerAgreement --> Issuer : issuer

      CustomerAgreement : last_modified_date_time

      CustomerAgreement : load_mgmt

      CustomerAgreement : m_rid

      CustomerAgreement : meter_read_schedule

          CustomerAgreement --> MeterReadSchedule : meter_read_schedule

      CustomerAgreement : meter_readings

          CustomerAgreement --> MeterReading : meter_readings

      CustomerAgreement : names

          CustomerAgreement --> Name : names

      CustomerAgreement : pricing_structures

          CustomerAgreement --> PricingStructure : pricing_structures

      CustomerAgreement : properties_cimdata_object

          CustomerAgreement --> ChangeSetMember : properties_cimdata_object

      CustomerAgreement : revision_number

      CustomerAgreement : service_category

          CustomerAgreement --> ServiceCategory : service_category

      CustomerAgreement : service_locations

          CustomerAgreement --> ServiceLocation : service_locations

      CustomerAgreement : service_supplier

          CustomerAgreement --> ServiceSupplier : service_supplier

      CustomerAgreement : shut_off_date_time

      CustomerAgreement : sign_date

      CustomerAgreement : standard_industry_code

          CustomerAgreement --> StandardIndustryCode : standard_industry_code

      CustomerAgreement : status

          CustomerAgreement --> Status : status

      CustomerAgreement : subject

      CustomerAgreement : targeting_cimdata_object

          CustomerAgreement --> ChangeSetMember : targeting_cimdata_object

      CustomerAgreement : title

      CustomerAgreement : type

      CustomerAgreement : usage_points

          CustomerAgreement --> UsagePoint : usage_points

      CustomerAgreement : validity_interval

          CustomerAgreement --> DateTimeInterval : validity_interval

Inheritance

Slots

Name Cardinality and Range Description Inheritance
is_pre_pay 0..1
Boolean		 If true, the customer is a pre-pay customer for the specified service direct
load_mgmt 0..1
String		 Load management code direct
shut_off_date_time 0..1
date		 Final date and time the service will be billed to the previous customer direct
service_category 0..1
ServiceCategory		 Service category for this agreement direct
usage_points 0..*
UsagePoint		 All service delivery points regulated by this customer agreement direct
pricing_structures 0..*
PricingStructure		 All pricing structures applicable to this customer agreement direct
auxiliary_agreements 0..*
AuxiliaryAgreement		 All (non-service related) auxiliary agreements that refer to this customer ag... direct
standard_industry_code 0..1
StandardIndustryCode		 direct
service_locations 0..*
ServiceLocation		 All service locations regulated by this customer agreement direct
customer 1..1
Customer		 Customer for this agreement direct
customer_account 1..1
CustomerAccount		 Customer account owning this agreement direct
service_supplier 1..1
ServiceSupplier		 Service supplier for this customer agreement direct
meter_read_schedule 0..1
MeterReadSchedule		 Meter read schedule that applies to the customer agreement direct
meter_readings 0..*
MeterReading		 (could be deprecated in the future) All meter readings for this customer agre... direct
demand_response_programs 0..*
DemandResponseProgram		 All demand response programs the customer is enrolled in through this custome... 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
Customer customer_agreements range CustomerAgreement
MeterReadSchedule customer_agreement range CustomerAgreement
UsagePoint customer_agreement range CustomerAgreement
CustomerAccount customer_agreements range CustomerAgreement
ServiceCategory customer_agreements range CustomerAgreement
PricingStructure customer_agreements range CustomerAgreement
AuxiliaryAgreement customer_agreement range CustomerAgreement
MeterReading customer_agreement range CustomerAgreement
DemandResponseProgram customer_agreements range CustomerAgreement
ServiceLocation customer_agreements range CustomerAgreement
ServiceSupplier customer_agreements range CustomerAgreement
StandardIndustryCode customer_agreements range CustomerAgreement
MarketEvaluationPoint customer_agreement range CustomerAgreement

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CustomerAgreement
description: Agreement between the customer and the service supplier to pay for service
  at a specific service location. It records certain billing information about the
  type of service provided at the service location and is used during charge creation
  to determine the type of service.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Agreement
attributes:
  is_pre_pay:
    name: is_pre_pay
    description: ' If true, the customer is a pre-pay customer for the specified service.'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.isPrePay
    multivalued: false
    domain_of:
    - CustomerAgreement
    range: boolean
    required: false
  load_mgmt:
    name: load_mgmt
    description: Load management code.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.loadMgmt
    multivalued: false
    domain_of:
    - CustomerAgreement
    range: string
    required: false
  shut_off_date_time:
    name: shut_off_date_time
    description: Final date and time the service will be billed to the previous customer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.shutOffDateTime
    multivalued: false
    domain_of:
    - CustomerAgreement
    range: date
    required: false
  service_category:
    name: service_category
    description: Service category for this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.ServiceCategory
    multivalued: false
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - PricingStructure
    range: ServiceCategory
    required: false
  usage_points:
    name: usage_points
    description: All service delivery points regulated by this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.UsagePoints
    multivalued: true
    domain_of:
    - Equipment
    - CustomerAgreement
    - ServiceCategory
    - PricingStructure
    - EndDeviceControl
    - UsagePointGroup
    - ServiceLocation
    - MetrologyRequirement
    - ServiceSupplier
    - UsagePointLocation
    range: UsagePoint
    required: false
  pricing_structures:
    name: pricing_structures
    description: All pricing structures applicable to this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.PricingStructures
    multivalued: true
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - ServiceCategory
    - Tariff
    range: PricingStructure
    required: false
  auxiliary_agreements:
    name: auxiliary_agreements
    description: All (non-service related) auxiliary agreements that refer to this
      customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.AuxiliaryAgreements
    multivalued: true
    domain_of:
    - CustomerAgreement
    range: AuxiliaryAgreement
    required: false
  standard_industry_code:
    name: standard_industry_code
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.StandardIndustryCode
    multivalued: false
    domain_of:
    - CustomerAgreement
    range: StandardIndustryCode
    required: false
  service_locations:
    name: service_locations
    description: All service locations regulated by this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.ServiceLocations
    multivalued: true
    domain_of:
    - CustomerAgreement
    range: ServiceLocation
    required: false
  customer:
    name: customer
    description: Customer for this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.Customer
    multivalued: false
    domain_of:
    - Person
    - Customer
    - CustomerAgreement
    - CustomerAccount
    - EndDevice
    - ServiceRequest
    - TroubleTicket
    - CustomerNotification
    - OutagePlan
    - PlannedOutageNotification
    range: Customer
    required: true
  customer_account:
    name: customer_account
    description: Customer account owning this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.CustomerAccount
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - CustomerAgreement
    - CustomerBillingInfo
    - WorkBillingInfo
    - Transaction
    - ErpInvoice
    - AccountNotification
    range: CustomerAccount
    required: true
  service_supplier:
    name: service_supplier
    description: Service supplier for this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.ServiceSupplier
    multivalued: false
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - BankAccount
    range: ServiceSupplier
    required: true
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule that applies to the customer agreement
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.MeterReadSchedule
    multivalued: false
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
  meter_readings:
    name: meter_readings
    description: (could be deprecated in the future) All meter readings for this customer
      agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.MeterReadings
    multivalued: true
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - Reading
    - Meter
    range: MeterReading
    required: false
  demand_response_programs:
    name: demand_response_programs
    description: All demand response programs the customer is enrolled in through
      this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.DemandResponsePrograms
    multivalued: true
    domain_of:
    - CustomerAgreement
    - EndDeviceGroup
    - UsagePointGroup
    range: DemandResponseProgram
    required: false
class_uri: cim:CustomerAgreement

Induced

name: CustomerAgreement
description: Agreement between the customer and the service supplier to pay for service
  at a specific service location. It records certain billing information about the
  type of service provided at the service location and is used during charge creation
  to determine the type of service.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Agreement
attributes:
  is_pre_pay:
    name: is_pre_pay
    description: ' If true, the customer is a pre-pay customer for the specified service.'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.isPrePay
    multivalued: false
    alias: is_pre_pay
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    range: boolean
    required: false
  load_mgmt:
    name: load_mgmt
    description: Load management code.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.loadMgmt
    multivalued: false
    alias: load_mgmt
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    range: string
    required: false
  shut_off_date_time:
    name: shut_off_date_time
    description: Final date and time the service will be billed to the previous customer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.shutOffDateTime
    multivalued: false
    alias: shut_off_date_time
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    range: date
    required: false
  service_category:
    name: service_category
    description: Service category for this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.ServiceCategory
    multivalued: false
    alias: service_category
    owner: CustomerAgreement
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - PricingStructure
    range: ServiceCategory
    required: false
  usage_points:
    name: usage_points
    description: All service delivery points regulated by this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.UsagePoints
    multivalued: true
    alias: usage_points
    owner: CustomerAgreement
    domain_of:
    - Equipment
    - CustomerAgreement
    - ServiceCategory
    - PricingStructure
    - EndDeviceControl
    - UsagePointGroup
    - ServiceLocation
    - MetrologyRequirement
    - ServiceSupplier
    - UsagePointLocation
    range: UsagePoint
    required: false
  pricing_structures:
    name: pricing_structures
    description: All pricing structures applicable to this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.PricingStructures
    multivalued: true
    alias: pricing_structures
    owner: CustomerAgreement
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - ServiceCategory
    - Tariff
    range: PricingStructure
    required: false
  auxiliary_agreements:
    name: auxiliary_agreements
    description: All (non-service related) auxiliary agreements that refer to this
      customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.AuxiliaryAgreements
    multivalued: true
    alias: auxiliary_agreements
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    range: AuxiliaryAgreement
    required: false
  standard_industry_code:
    name: standard_industry_code
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.StandardIndustryCode
    multivalued: false
    alias: standard_industry_code
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    range: StandardIndustryCode
    required: false
  service_locations:
    name: service_locations
    description: All service locations regulated by this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.ServiceLocations
    multivalued: true
    alias: service_locations
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    range: ServiceLocation
    required: false
  customer:
    name: customer
    description: Customer for this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.Customer
    multivalued: false
    alias: customer
    owner: CustomerAgreement
    domain_of:
    - Person
    - Customer
    - CustomerAgreement
    - CustomerAccount
    - EndDevice
    - ServiceRequest
    - TroubleTicket
    - CustomerNotification
    - OutagePlan
    - PlannedOutageNotification
    range: Customer
    required: true
  customer_account:
    name: customer_account
    description: Customer account owning this agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.CustomerAccount
    multivalued: false
    alias: customer_account
    owner: CustomerAgreement
    domain_of:
    - MeterReadSchedule
    - CustomerAgreement
    - CustomerBillingInfo
    - WorkBillingInfo
    - Transaction
    - ErpInvoice
    - AccountNotification
    range: CustomerAccount
    required: true
  service_supplier:
    name: service_supplier
    description: Service supplier for this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.ServiceSupplier
    multivalued: false
    alias: service_supplier
    owner: CustomerAgreement
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - BankAccount
    range: ServiceSupplier
    required: true
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule that applies to the customer agreement
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.MeterReadSchedule
    multivalued: false
    alias: meter_read_schedule
    owner: CustomerAgreement
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
  meter_readings:
    name: meter_readings
    description: (could be deprecated in the future) All meter readings for this customer
      agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CustomerAgreement.MeterReadings
    multivalued: true
    alias: meter_readings
    owner: CustomerAgreement
    domain_of:
    - UsagePoint
    - CustomerAgreement
    - Reading
    - Meter
    range: MeterReading
    required: false
  demand_response_programs:
    name: demand_response_programs
    description: All demand response programs the customer is enrolled in through
      this customer agreement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CustomerAgreement.DemandResponsePrograms
    multivalued: true
    alias: demand_response_programs
    owner: CustomerAgreement
    domain_of:
    - CustomerAgreement
    - EndDeviceGroup
    - UsagePointGroup
    range: DemandResponseProgram
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    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: CustomerAgreement
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:CustomerAgreement