Class: TypeMaterial

name: TypeMaterial
description: "Documentation for a generic material item that may be used for design,\
  \ work and other purposes. Any number of MaterialItems manufactured by various vendors\
  \ may be used to perform this TypeMaterial.\r\nNote that class analagous to \"AssetModel\"\
  \ is not used for material items. This is because in some cases, for example, a\
  \ utility sets up a Master material record for a 3 inch long half inch diameter\
  \ steel bolt and they do not necessarily care what specific supplier is providing\
  \ the material item. As different vendors are used to supply the part, the Stock\
  \ Code of the material item can stay the same. In other cases, each time the vendor\
  \ changes, a new stock code is set up so they can track material used by vendor.\
  \ Therefore a Material Item \"Model\" is not typically needed.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: WorkDocument
attributes:
  cost_type:
    name: cost_type
    description: "The type of cost to which this Material Item belongs.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.costType
    multivalued: false
    domain_of:
    - FinancialInfo
    - CompatibleUnit
    - WorkCostDetail
    - MiscCostItem
    - TypeMaterial
    range: string
    required: false
  est_unit_cost:
    name: est_unit_cost
    description: The estimated unit cost of this type of material, either for a unit
      cost or cost per unit length. Cost is for material or asset only and does not
      include labor to install/construct or configure it.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TypeMaterial.estUnitCost
    multivalued: false
    domain_of:
    - TypeMaterial
    range: Money
    required: false
  quantity:
    name: quantity
    description: The value, unit of measure, and multiplier for the quantity.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.quantity
    multivalued: false
    domain_of:
    - FinancialInfo
    - CatalogAssetType
    - CompatibleUnit
    - MiscCostItem
    - CUMaterialItem
    - TypeMaterial
    - MaterialItem
    - ErpReqLineItem
    - TimeSeries
    - Point
    - CRRSegment
    - PassThroughBill
    - Domain
    - Quantity
    range: string
    required: false
  stock_item:
    name: stock_item
    description: True if item is a stock item (default).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.stockItem
    multivalued: false
    domain_of:
    - CatalogAssetType
    - TypeMaterial
    range: boolean
    required: false
  material_items:
    name: material_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.MaterialItems
    multivalued: true
    domain_of:
    - WorkTask
    - TypeMaterial
    range: MaterialItem
    required: false
  erp_req_line_items:
    name: erp_req_line_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.ErpReqLineItems
    multivalued: true
    domain_of:
    - CatalogAssetType
    - TypeMaterial
    - ErpRequisition
    range: ErpReqLineItem
    required: false
  erp_issue_inventories:
    name: erp_issue_inventories
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TypeMaterial.ErpIssueInventories
    multivalued: true
    domain_of:
    - TypeMaterial
    range: ErpIssueInventory
    required: false
  cumaterial_items:
    name: cumaterial_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.CUMaterialItems
    multivalued: true
    domain_of:
    - CompatibleUnit
    - PropertyUnit
    - TypeMaterial
    range: CUMaterialItem
    required: false
class_uri: cim:TypeMaterial

name: TypeMaterial
description: "Documentation for a generic material item that may be used for design,\
  \ work and other purposes. Any number of MaterialItems manufactured by various vendors\
  \ may be used to perform this TypeMaterial.\r\nNote that class analagous to \"AssetModel\"\
  \ is not used for material items. This is because in some cases, for example, a\
  \ utility sets up a Master material record for a 3 inch long half inch diameter\
  \ steel bolt and they do not necessarily care what specific supplier is providing\
  \ the material item. As different vendors are used to supply the part, the Stock\
  \ Code of the material item can stay the same. In other cases, each time the vendor\
  \ changes, a new stock code is set up so they can track material used by vendor.\
  \ Therefore a Material Item \"Model\" is not typically needed.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: WorkDocument
attributes:
  cost_type:
    name: cost_type
    description: "The type of cost to which this Material Item belongs.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.costType
    multivalued: false
    alias: cost_type
    owner: TypeMaterial
    domain_of:
    - FinancialInfo
    - CompatibleUnit
    - WorkCostDetail
    - MiscCostItem
    - TypeMaterial
    range: string
    required: false
  est_unit_cost:
    name: est_unit_cost
    description: The estimated unit cost of this type of material, either for a unit
      cost or cost per unit length. Cost is for material or asset only and does not
      include labor to install/construct or configure it.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TypeMaterial.estUnitCost
    multivalued: false
    alias: est_unit_cost
    owner: TypeMaterial
    domain_of:
    - TypeMaterial
    range: Money
    required: false
  quantity:
    name: quantity
    description: The value, unit of measure, and multiplier for the quantity.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.quantity
    multivalued: false
    alias: quantity
    owner: TypeMaterial
    domain_of:
    - FinancialInfo
    - CatalogAssetType
    - CompatibleUnit
    - MiscCostItem
    - CUMaterialItem
    - TypeMaterial
    - MaterialItem
    - ErpReqLineItem
    - TimeSeries
    - Point
    - CRRSegment
    - PassThroughBill
    - Domain
    - Quantity
    range: string
    required: false
  stock_item:
    name: stock_item
    description: True if item is a stock item (default).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.stockItem
    multivalued: false
    alias: stock_item
    owner: TypeMaterial
    domain_of:
    - CatalogAssetType
    - TypeMaterial
    range: boolean
    required: false
  material_items:
    name: material_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.MaterialItems
    multivalued: true
    alias: material_items
    owner: TypeMaterial
    domain_of:
    - WorkTask
    - TypeMaterial
    range: MaterialItem
    required: false
  erp_req_line_items:
    name: erp_req_line_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.ErpReqLineItems
    multivalued: true
    alias: erp_req_line_items
    owner: TypeMaterial
    domain_of:
    - CatalogAssetType
    - TypeMaterial
    - ErpRequisition
    range: ErpReqLineItem
    required: false
  erp_issue_inventories:
    name: erp_issue_inventories
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TypeMaterial.ErpIssueInventories
    multivalued: true
    alias: erp_issue_inventories
    owner: TypeMaterial
    domain_of:
    - TypeMaterial
    range: ErpIssueInventory
    required: false
  cumaterial_items:
    name: cumaterial_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TypeMaterial.CUMaterialItems
    multivalued: true
    alias: cumaterial_items
    owner: TypeMaterial
    domain_of:
    - CompatibleUnit
    - PropertyUnit
    - TypeMaterial
    range: CUMaterialItem
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    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: TypeMaterial
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:TypeMaterial