Zum Hauptinhalt springen

Types

Version: 5.1.0

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.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/CustomerNumberFalse
Basic-2/ContactFalse
Basic-2/TimeRangeFalse
Basic-2/CommentTrue
EnergyCommunity-5/TaxProcedureCreditNoteFalse
EnergyCommunity-5/BillingTypeFalse
EnergyCommunity-5/BillingDocumentStateFalse
EnergyCommunity-5/GrossTotalFalse
Basic-2/BankAccountTrue

Outbound Associations​

Outbound NameOutbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
AssignedToZeroOrOneEnergyCommunity-5/AssignedBillingEnergyCommunity-5/Customer

Inbound Associations​

Inbound NameInbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
ChildrenNSystem-2/ParentChildEnergyCommunity-5/BillingDocumentLineItem

BillingDocumentLineItem​

Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/BillingDocumentLineItem-1

A billing document line item

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/GrossAmountFalse
EnergyCommunity-5/NetAmountFalse
EnergyCommunity-5/TaxAmountFalse
EnergyCommunity-5/TaxRateFalse
EnergyCommunity-5/UnitPriceFalse
EnergyCommunity-5/BillingTypeFalse
Basic-2/QuantityFalse
Basic-2/TimeRangeTrue
EnergyCommunity-5/IntervalCountTrue
EnergyCommunity-5/IntervalCountL1True
EnergyCommunity-5/IntervalCountL2True
EnergyCommunity-5/IntervalCountL3True
EnergyCommunity-5/IntervalCountUnknownTrue

Outbound Associations​

Outbound NameOutbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
ParentOneSystem-2/ParentChildEnergyCommunity-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.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/AllocationCutOffTimeTrue
EnergyCommunity-5/AllocationKeyTrue
System-2/DescriptionTrue

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

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
Basic.Energy-2/PartitionFactorTrue
EnergyCommunity-5/EnergyConsumptionTrue
EnergyCommunity-5/MeteringDataSourceTrue
EnergyCommunity-5/LoadProfileTrue

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

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/CustomerNumber
  • C
  • u
  • s
  • t
  • o
  • m
  • e
  • r
  • N
  • u
  • m
  • b
  • e
  • r
False
Basic-2/ContactFalse
Basic-2/CommentTrue
EnergyCommunity-5/BillingCycleFalse
Basic.Energy-2/StateFalse
Basic-2/BankAccountTrue
EnergyCommunity-5/TaxProcedureCreditNoteFalse
EnergyCommunity-5/DateOfBirthTrue

Outbound Associations​

Outbound NameOutbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
FacilitiesNEnergyCommunity-5/AssociatedFacilitiesBasic.Energy-2/OperatingFacility

Inbound Associations​

Inbound NameInbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
BillingNEnergyCommunity-5/AssignedBillingEnergyCommunity-5/BillingDocument

EnergyPrice​

Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/EnergyPrice-1

The price of Energy at a certain time

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/PriceFalse
EnergyCommunity-5/CurrencyFalse

ParticipationPeriod​

Inheritance: System-2.8.0/Entity-1 ➔ EnergyCommunity-5.1.0/ParticipationPeriod-1

The participation period with a start and end date

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
Basic-2/TimeRangeFalse

Outbound Associations​

Outbound NameOutbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
MeteringPointOneEnergyCommunity-5/ParticipationPeriodBasic.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

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
Basic.Energy-2/PartitionFactorTrue
EnergyCommunity-5/EnergyProductionCapacityTrue
EnergyCommunity-5/MeteringDataSourceTrue

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.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/SimulationResetModeFalse
EnergyCommunity-5/BackfillDaysTrue
EnergyCommunity-5/DiscardReportedTrue
EnergyCommunity-5/SimulationResetStateFalse
EnergyCommunity-5/RequestedAtFalse
EnergyCommunity-5/RequestedByTrue
EnergyCommunity-5/CompletedAtTrue
System-2/DescriptionTrue

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.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
EnergyCommunity-5/SimulationPresetFalse
EnergyCommunity-5/EffectiveFromFalse
EnergyCommunity-5/SimulationSeedTrue
EnergyCommunity-5/ConsumptionFactorTrue
EnergyCommunity-5/PvCapacityFactorTrue
EnergyCommunity-5/PvSpecificYieldTrue
EnergyCommunity-5/MemberSpreadTrue
EnergyCommunity-5/SimulationNoiseLevelTrue
EnergyCommunity-5/SimulationWeatherModeTrue
EnergyCommunity-5/MemberScaleTrue
EnergyCommunity-5/BackfillDaysTrue
EnergyCommunity-5/DailyRunTrue
EnergyCommunity-5/NearRealTimeTrue
EnergyCommunity-5/SupersededByResetTrue
System-2/DescriptionTrue