Types
BillingDocument
Inheritance: System-2.8.0/Entity-1 ➔ Basic-2.7.0/Document-1 ➔ EnergyCommunity-5.1.0/BillingDocument-1
A billing document entity that contains accounting information.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/CustomerNumber | False | ||
| Basic-2/Contact | False | ||
| Basic-2/TimeRange | False | ||
| Basic-2/Comment | True | ||
| EnergyCommunity-5/TaxProcedureCreditNote | False | ||
| EnergyCommunity-5/BillingType | False | ||
| EnergyCommunity-5/BillingDocumentState | False | ||
| EnergyCommunity-5/GrossTotal | False | ||
| Basic-2/BankAccount | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| AssignedTo | ZeroOrOne | EnergyCommunity-5/AssignedBilling | EnergyCommunity-5/Customer |
Inbound Associations
| Inbound Name | Inbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Children | N | System-2/ParentChild | EnergyCommunity-5/BillingDocumentLineItem |
BillingDocumentLineItem
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/BillingDocumentLineItem-1
A billing document line item
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/GrossAmount | False | ||
| EnergyCommunity-5/NetAmount | False | ||
| EnergyCommunity-5/TaxAmount | False | ||
| EnergyCommunity-5/TaxRate | False | ||
| EnergyCommunity-5/UnitPrice | False | ||
| EnergyCommunity-5/BillingType | False | ||
| Basic-2/Quantity | False | ||
| Basic-2/TimeRange | True | ||
| EnergyCommunity-5/IntervalCount | True | ||
| EnergyCommunity-5/IntervalCountL1 | True | ||
| EnergyCommunity-5/IntervalCountL2 | True | ||
| EnergyCommunity-5/IntervalCountL3 | True | ||
| EnergyCommunity-5/IntervalCountUnknown | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Parent | One | System-2/ParentChild | EnergyCommunity-5/BillingDocument |
CommunitySettings
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/CommunitySettings-1
Product settings of the energy community as a whole (one entity per tenant; real and simulated communities alike). Readers take the first entity and fall back to the documented defaults when none exists or a value is empty.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/AllocationCutOffTime | True | ||
| EnergyCommunity-5/AllocationKey | True | ||
| System-2/Description | True |
Consumer
Inheritance: System-2.8.0/Entity-1 ➔ Basic-2.7.0/NamedEntity-1 ➔ Basic.Energy-2.1.0/MeteringPoint-1 ➔ Basic.Energy-2.1.0/Consumer-1 ➔ EnergyCommunity-5.1.0/Consumer-1
A consumer metering point participating in an energy community
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| Basic.Energy-2/PartitionFactor | True | ||
| EnergyCommunity-5/EnergyConsumption | True | ||
| EnergyCommunity-5/MeteringDataSource | True | ||
| EnergyCommunity-5/LoadProfile | True |
Implements: System/Describable-1, System/Named-1
Customer
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/Customer-1
Represents a customer of an energy community
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/CustomerNumber |
| False | |
| Basic-2/Contact | False | ||
| Basic-2/Comment | True | ||
| EnergyCommunity-5/BillingCycle | False | ||
| Basic.Energy-2/State | False | ||
| Basic-2/BankAccount | True | ||
| EnergyCommunity-5/TaxProcedureCreditNote | False | ||
| EnergyCommunity-5/DateOfBirth | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Facilities | N | EnergyCommunity-5/AssociatedFacilities | Basic.Energy-2/OperatingFacility |
Inbound Associations
| Inbound Name | Inbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Billing | N | EnergyCommunity-5/AssignedBilling | EnergyCommunity-5/BillingDocument |
EnergyPrice
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/EnergyPrice-1
The price of Energy at a certain time
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/Price | False | ||
| EnergyCommunity-5/Currency | False |
ParticipationPeriod
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/ParticipationPeriod-1
The participation period with a start and end date
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| Basic-2/TimeRange | False |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| MeteringPoint | One | EnergyCommunity-5/ParticipationPeriod | Basic.Energy-2/MeteringPoint |
Producer
Inheritance: System-2.8.0/Entity-1 ➔ Basic-2.7.0/NamedEntity-1 ➔ Basic.Energy-2.1.0/MeteringPoint-1 ➔ Basic.Energy-2.1.0/Producer-1 ➔ EnergyCommunity-5.1.0/Producer-1
A producer metering point participating in an energy community
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| Basic.Energy-2/PartitionFactor | True | ||
| EnergyCommunity-5/EnergyProductionCapacity | True | ||
| EnergyCommunity-5/MeteringDataSource | True |
Implements: System/Describable-1, System/Named-1
SimulationResetRequest
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/SimulationResetRequest-1
A request to reset the simulated data of the energy community. The request is only recorded here; an operator tool executes it and writes state and report back.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/SimulationResetMode | False | ||
| EnergyCommunity-5/BackfillDays | True | ||
| EnergyCommunity-5/DiscardReported | True | ||
| EnergyCommunity-5/SimulationResetState | False | ||
| EnergyCommunity-5/RequestedAt | False | ||
| EnergyCommunity-5/RequestedBy | True | ||
| EnergyCommunity-5/CompletedAt | True | ||
| System-2/Description | True |
SimulationSettings
Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/SimulationSettings-1
One revision of the simulation settings of an energy community. For a day D the non-superseded revision with the greatest effective date <= D applies; the effective date is max(EffectiveFrom, creation date), except for the base revision written by a reset. Unset values fall back to the simulation defaults.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| EnergyCommunity-5/SimulationPreset | False | ||
| EnergyCommunity-5/EffectiveFrom | False | ||
| EnergyCommunity-5/SimulationSeed | True | ||
| EnergyCommunity-5/ConsumptionFactor | True | ||
| EnergyCommunity-5/PvCapacityFactor | True | ||
| EnergyCommunity-5/PvSpecificYield | True | ||
| EnergyCommunity-5/MemberSpread | True | ||
| EnergyCommunity-5/SimulationNoiseLevel | True | ||
| EnergyCommunity-5/SimulationWeatherMode | True | ||
| EnergyCommunity-5/MemberScale | True | ||
| EnergyCommunity-5/BackfillDays | True | ||
| EnergyCommunity-5/DailyRun | True | ||
| EnergyCommunity-5/NearRealTime | True | ||
| EnergyCommunity-5/SupersededByReset | True | ||
| System-2/Description | True |