Skip to content

Slot: doc_status

_Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute. _

Example values for 'docStatus.status' are draft, approved, cancelled, etc.

URI: cim:Document.docStatus

Applicable Classes

Name Description Modifies Slot
MeterReadSchedule no
ErpChartOfAccounts Accounting structure of a business no
MPMClearing Model of results of Market Power tests, and possible mitigation no
TransactionBidClearing Contains the intervals relavent for the associated TransactionBidResults no
AuxiliaryAccount Variable and dynamic part of auxiliary agreement, generally representing the ... no
InstructionClearingDOP Model of market clearing, related to Dispatch Operating Point no
WorkCostDetail A collection of all of the individual cost items collected from multiple sour... no
ExPostMarketRegion Model of ex-post calculation of cleared MW on a regional basis no
ErpLedgerBudget Information for utility Ledger Budgets no
CommitmentClearing Models results of market clearing which call for commitment of units no
CompatibleUnit A pre-planned job model containing labor, material, and accounting requiremen... no
ServiceGuarantee A service guarantee, often imposed by a regulator, defines conditions that, i... no
ErpTimeSheet Time sheet for employees and contractors no
InspectionDataSet Documents the result of one inspection, for a given attribute of an asset no
MarketDocument Electronic document containing the information necessary to satisfy a given b... no
OperationalTag Operational tag placed on a power system resource or asset in the context of ... no
ErpSalesOrder General purpose Sales Order is used for utility service orders, etc no
CustomerAccount Assignment of a group of products and services purchased by the customer thro... no
ExternalCustomerAgreement A type of customer agreement involving an external agency no
AssetGroup A grouping of assets created for a purpose such as fleet analytics, inventory... no
ErpPurchaseOrder A document that communicates an order to purchase goods from a buyer to a sup... no
UnplannedOutage Document describing the consequence of an unplanned outage in a part of the e... no
ErpPayable A transaction that represents an invoice from a supplier no
ExPostResource Model of ex-post pricing of resources no
InstructionClearing Model of market clearing, relating to commitment instructions no
NonStandardItem This document provides information for non-standard items like customer contr... no
TransactionBid Bilateral or scheduled transactions for energy and ancillary services conside... no
InstructionClearingDOT Model of market clearing, related to Dispatch Operating Target (model of anti... no
BaseWork Common representation for work and work tasks no
ErpReceivable Transaction representing an invoice, credit memo or debit memo to a customer no
Tariff Document, approved by the responsible regulatory agency, listing the terms an... no
ErpDocument Shadow class for Document, to isolate subclassing from this package no
Work Document used to request, initiate, track and record work no
WorkTimeSchedule Time schedule specific to work no
StandardIndustryCode The Standard Industrial Classification (SIC) are the codes that identify the ... no
TestDataSet Test results, usually obtained by a lab or other independent organisation no
ResourceClearing Model of market results, including cleaing result of resources no
MaintenanceWorkTask Maintenance work task no
ProcedureDataSet A data set recorded each time a procedure is executed no
RepairWorkTask Work task for asset repair no
MarketCaseClearing Market case clearing results are posted for a given settlement period no
ExPostPricing Model of ex-post pricing of nodes no
LabTestDataSet Results of testing done by a lab no
Incident Description of a problem in the field that may be reported in a trouble ticke... no
OldWorkTask A set of tasks is required to implement a design no
ErpInvoice A roll up of invoice line items no
MitigatedBidClearing Model of market power mitigation through reference or mitigated bids no
BillDeterminant Models various charges to support billing and settlement no
Skill Proficiency level of a craft, which is required to operate or maintain a part... no
OneCallRequest A request for other utilities to mark their underground facilities prior to c... no
CongestionRevenueRight Congestion Revenue Rights (CRR) class that is inherited from a Document class no
AccessPermit A permit is sometimes needed to provide legal access to land or equipment no
Document Parent class for different groupings of information collected and managed as ... no
ErpQuote Document describing the prices of goods or services provided by a supplier no
FTR Financial Transmission Rights (FTR) regarding transmission capacity at a flow... no
OutagePlan Document containing the definition of planned outages of equipment and/or usa... no
AuxiliaryAgreement An ad-hoc auxiliary account agreement associated with a customer agreement, n... no
AreaLoadBid AreaLoadBid is not submitted by a market participant into the Markets no
TypeMaterial Documentation for a generic material item that may be used for design, work a... no
WorkTask A task within a set of work no
Analytic An algorithm or calculation for making an assessment about an asset or asset ... no
RMROperatorInput RMR Operator's entry of the RMR requirement per market interval no
ErpReceiveDelivery Transaction for an Organisation receiving goods or services that may be used ... no
ErpPayment Payment infromation and status for any individual line item of an ErpInvoice ... no
ServiceOrder no
WorkBillingInfo Billing information for work performed for the customer no
Design A design for consideration by customers, potential customers, or internal wor... no
Outage Document describing details of an active or planned outage in a part of the e... no
Project A collection of related work no
Specification Specification can be used for various purposes relative to an asset, a logica... no
MarketFactors Aggregation of market information relative for a specific time interval no
SafetyDocument Document restricting or authorising works on electrical equipment (for exampl... no
EnergyProduct An EnergyProduct is offered commercially as a ContractOrTariff no
InterTieClearing Model of market clearing related to results at the inter-ties no
AncillaryServiceClearing Model of results of market clearing with respect to Ancillary Service produc... no
CustomerBillingInfo The creation of the monthly customer billing statements is the method employe... no
MarketStatement A statement is a roll up of statement line items no
MerchantAgreement A formal controlling contractual agreement between supplier and merchant, in ... no
InterTieBid This class represents the inter tie bid no
LoadBid Offer to supply energy/ancillary services from a load resource (participating... no
CustomerAgreement Agreement between the customer and the service supplier to pay for service at... no
MaintenanceOrder no
ResourceBid Energy bid for generation, load, or virtual type for the whole of the market-... no
ErpBOM Information that generally describes the Bill of Material Structure and its c... no
BusinessPlan A BusinessPlan is an organized sequence of predetermined actions required to ... no
ErpProjectAccounting Utility Project Accounting information, used by ERP applications to enable al... no
PnodeClearing Pricing node clearing results posted for a given settlement period no
WorkRequest Document used to plan or initiate work no
LocationGrant A grant provides a right, as defined by type, for a parcel of land no
OperationalRestriction A document that can be associated with equipment to describe any sort of rest... no
OutageOrder Transmits an outage plan to a crew in order for the planned outage to be exec... no
Settlement Specifies a settlement run no
DiagnosisDataSet The result of a problem (typically an asset failure) diagnosis no
ServiceRequest no
MeterWorkTask Work task involving meters no
SecurityConstraintSum Typically provided by RTO systems, constraints identified in both base case a... no
AssetModelCatalogueItem Provides pricing and other relevant information about a specific manufacturer... no
SwitchingPlanRequest A document used to request that a switching plan be created for a particular ... no
ErpRequisition General information that applies to a utility requisition that is a request f... no
TroubleTicket no
WorkDocument Shadow class for Document, to isolate subclassing from this package no
MarketAgreement An identification or eventually the contents of an agreement between two or ... no
IntermittentResourceEligibility Indicates whether unit is eligible for treatment as a intermittent variable r... no
Agreement Formal agreement between two parties defining the terms and conditions for a ... no
PassThroughBill Pass Through Bill is used for:
no
MaintenanceDataSet The result of a maintenance activity, a type of Procedure, for a given attrib... no
OpenAccessProduct Contracts for services offered commercially no
SecurityConstraintsClearing Binding security constrained clearing results posted for a given settlement p... no
Bid Represents both bids to purchase and offers to sell energy or ancillary servi... no
ErpLedger In accounting transactions, a ledger is a book containing accounts to which d... no
ClearanceDocument Safety document used to authorise work on conducting equipment in the field no
ChargeType Charge Type is the basic level configuration for settlement to process specif... no
GeneratingBid Offer to supply energy/ancillary services from a generating unit or resource no
DefaultBid DefaultBid is a generic class to hold Default Energy Bid, Default Startup Bid... no
TroubleOrder Trouble order sends an incident to a crew to initiate a response to an unplan... no
WorkCostSummary A roll up by cost type for the entire cost of a work order no
MerchantAccount The operating account controlled by merchant agreement, against which the ven... no
PlannedOutageNotification This class will be used to generate call ahead lists for customers who will b... no
ResourceAwardClearing Models details of bid and offer market clearing no
SwitchingOrder Transmits a switching plan to a crew in order for the plan to be executed no
IntSchedAgreement A type of agreement that provides the default method by which interchange sch... no
ErpInvoiceLineItem An individual line item on an invoice no
WorkOrder no
RightOfWay A right-of-way (ROW) is for land where it is lawful to use for a public road... no
MarketSkill Proficiency level of a craft, which is required to operate or maintain a part... no
BankAccount Bank account no
Regulation Special requirements and/or regulations may pertain to certain types of asset... no
InfoQuestion Questions and answers associated with a type of document for purposes of clar... no
PowerQualityPricing Pricing can be based on power quality no
ErpEngChangeOrder General Utility Engineering Change Order information no
ExPostLoss Model of ex-post calcultion of MW losses no
Procedure Documented procedure for various types of work or work tasks on assets no
ErpBankAccount Relationship under a particular name, usually evidenced by a deposit against ... no
ConstraintClearing Groups all items associated with Binding Constraints and Constraint Violation... no
LossSensitivity Loss sensitivity applied to a ConnectivityNode for a given time interval no
PlannedOutage no
BusinessCase Business justification for capital expenditures, usually addressing operation... no
PricingStructure Grouping of pricing components and prices used in the creation of customer ch... no
SwitchingPlan A sequence of grouped or atomic steps intended to:
no
ErpPOLineItem Of an ErpPurchaseOrder, this is an individually ordered item or product along... no
OperationalUpdatedRating Lowered capability because of deterioration or inadequacy (sometimes referred... no
GeneralClearing Model of clearing result of the market run at the market level no
ErpJournal Book for recording accounting transactions as they occur no
TariffProfile A schedule of charges; structure associated with Tariff that allows the defin... no
Assignment An assignment is given to an ErpPerson, Crew, Organisation, Equipment Item, T... no
EnergyTransaction Specifies the schedule for energy transfers between interchange areas that ar... no
LossClearing RT only and is published on 5 minute intervals for the previous RT time inter... no
TimeSchedule Description of anything that changes through time no

Properties

Identifier and Mapping Information

Schema Source

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

LinkML Source

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: Document
domain_of:
- Document
range: Status
required: false