hochfrequenz/bo4e-dotnet

C# / .NET Core implementation of Business Objects for Energy (BO4E). Full Docs: https://hochfrequenz.github.io/bo4e-livedocs/api/BO4E.BO.html

bo4e-dotnet's Issues

com.Steuerbetrag: statt BasiswertVorausgezahlt braucht edifact Kommunikation BruttowertVorausgezahlt

com.Steuerbetrag enthält das nicht BO4E Standard Feld BasiswertVorausgezahlt. In der EDIFACT Kommunikation wird jedoch nur der Bruttowert und nicht der Nettowert übermittelt.

Get Version from Git Tag instead of Hardcoding it in .csproj

BO4E-dotnet/BO4E/BO4E.csproj

Line 32 in a7ab322

<PackageVersion>0.2.6</PackageVersion>

Ensure Stable Serialization in both Newtonsoft and System.Text

BO4E-dotnet/BO4E/BO/Energiemenge.cs

Line 58 in a71f590

[JsonPropertyName("lokationsTyp")]

By

• adding JsonPropertyOrder to all BOs and COM Properties
• adding the newtonsoft Order=... attribute arguemtn to those BOs (the new ones) that miss it.

Remove the hardcoded `project_path` from the `generate-json-schemas`

there is hardcoded project_path in generate-json-schema files can be replaced with a OS pathfinder or 3. argument:

BO4E-dotnet/SchemaGenerator/generate-json-schemas.sh

Line 59 in 05abfd3

project_path="C:/github/BO4E-dotnet2/SchemaGenerator/SchemaGenerator.csproj"

BO4E-dotnet/SchemaGenerator/generate-json-schemas.ps1

Line 59 in 05abfd3

$project_path = "C:/github/BO4E-dotnet/SchemaGenerator/SchemaGenerator.csproj"

Typo in enum Messwertstatus.

There is a Typo in the enum Messwertstatus:

BO4E-dotnet/BO4E/ENUM/Messwertstatus.cs

Line 22 in 4db8bc6

VOLAEUFIGERWERT,

Generalize HasFlagSet and SetFlag to all Classes implementing IUserProperties

BO4E-dotnet/BO4E-dotnet/BO/BusinessObject.cs

Line 190 in 2dcdb03

public bool HasFlagSet(string flagKey)

BO4E-dotnet/BO4E-dotnet/BO/BusinessObject.cs

Line 214 in 2dcdb03

public bool SetFlag<TBusinessObject>(string flagKey, bool? flagValue = true) where TBusinessObject : BusinessObject, IUserProperties

Vertrag->Vertragstatus should be nullable

Otherwise it defaults to IN_ARBEIT, even if it's not activly set.

BO4E-dotnet/BO4E/BO/Vertrag.cs

Line 69 in ebde13c

public Vertragstatus Vertragstatus { get; set; } // ToDo: shouldn't this be vertragsstatus with "ss"?

Check Serialisation of BO Objects (Vertrag - Vertragskondition)

Especially in the Vertrag Object (Vertragskonditionen) we stubled upon an issue, that using Newtonsoft JsonConvert the serialized-deserialized-serialized Json does not equal the serialized Json.

Todo: Write corresponding UnitTest in BO4E project and check.

Port Bilanzierung to BO4E-python

• Port our own (Hochfrequenz) Business Object Bilanzierung to Python.
• Add tests (to the python implementation) as usual
• Put focus on a well documented data model (docstrings) Ask for help if necessary.
• If the CI passes let someone from the Hochfrequenz team review it
• Do not merge it to bo4e/BO4E-Python yet! We want to use th BO Bilanzierung to establish a git based workflow to enhance the official BO4E standard (meaning: someone from another company with functional knowledge should review it)

fyi @hf-krechan

Zaehlwerk➡`Zaehlzeiten` is singular but has plural name

BO4E-dotnet/BO4E/COM/Zaehlwerk.cs

Line 172 in e214f27

public Zaehlzeit? Zaehlzeiten { get; set; }

Property Name is `Netznutzungsvertragsart` but is serialized as `netznutzungsvertrag`

BO4E-dotnet/BO4E/COM/Vertragskonditionen.cs

Line 135 in d0a3d63

[JsonPropertyName("netznutzungsvertrag")]

Port BO Avis to BO4E-python

• Port our own (Hochfrequenz) Business Object Avis to Python.
  • create an avis.py in bo4e-python: https://github.com/bo4e/BO4E-python/tree/main/src/bo4e/bo
  • run tox and create dev environment (see python template repository)
  • port all the properties from the c# avis class (link above) to the new class in bo4e-python
    • create missing coms and enums in BO4E-python
• Add tests (to the python implementation) as usual
• Put focus on a well documented data model (docstrings). Ask for help if necessary.
• If the CI passes let someone from the Hochfrequenz team review it
• Do not merge it to bo4e/BO4E-Python yet! We want to use th BO Avis to establish a git based workflow to enhance the official BO4E standard (meaning: someone from another company with functional knowledge should review it)

fyi @hf-krechan

Move from Newtonsoft.Json to System.Text.Json

long term task

What is the difference between `Profiltyp` and `Profilart`

Hm, gute Frage, aber ich war mir nicht sicher, ob es genau das gleiche beschreibt, weil es auch im EDIFACT verschiedene Enums dazu gibt.

Originally posted by @hf-aschloegl in #179 (comment)

Port COM Lastprofil to BO4E-Python

• Port our own (Hochfrequenz) COMponent Lastprofil to Python.
• Add tests (to the python implementation) as usual
• Put focus on a well documented data model (docstrings) Ask for help if necessary.
• If the CI passes let someone from the Hochfrequenz team review it
• Do not merge it to bo4e/BO4E-Python yet! We want to use the COM Lastprofil to establish a git based workflow to enhance the official BO4E standard (meaning: someone from another company with functional knowledge should review it)

fyi @hf-krechan

`Verarbeitunszeitraum` uses PascalCase instead of lowerCamelCase

BO4E-dotnet/BO4E/COM/Preisposition.cs

Line 145 in e214f27

[JsonProperty(PropertyName = "Verarbeitungszeitraum", Required = Required.Default, Order = 25)]

relates to Hochfrequenz/go-bo4e#142

Fix the Doc Build

Also:

1. Es gibt in diesem Repo einen Workflow: https://github.com/Hochfrequenz/BO4E-dotnet/blob/main/.github/workflows/trigger_doc_build.yml
2. Der ruft per webhook dieses Repo auf: https://github.com/Hochfrequenz/bo4e-doc/blob/d817afa32f1e693f999ae1949a2af76965520811/.github/workflows/build_docs.yml#L4
3. der workflow aus 2 buildet dann mittels docfx die doku die in https://github.com/Hochfrequenz/bo4e-livedocs liegt. und das letzte repo ist ein github pages repo, dass rechts in der sidebar dieses repos verlinkt ist: https://hochfrequenz.github.io/bo4e-livedocs/api/BO4E.BO.html

Mindestes ein glied dieser workflow kette ist aktuell defekt.
Wahrscheilich geht das alles einfacher.

Aber so war mal der plan

Originally posted by @hf-kklein in #120 (comment)

Use a proper Equals Method, not this quircky workaround

BO4E-dotnet/BO4E/BO/BusinessObject.cs

Line 196 in 098adf6

return JsonConvert.SerializeObject(this) == JsonConvert.SerializeObject(b);

it causes problems on so many levels, especially in assertions

Discussion: Model Validation

Hi there!
Am I the only one who would appreciate the models to implement some kine of model validation options?
Stumbled upon IValidatableObject - wouldn't it be nice to have that?

I stumbled upon an issues in our system where a Marktlokation contained a Messlokation with a different Sparte than the Marktlokation itself. Such logical restrictions could easily be enforced with such an universal validation mechanis as provided with the IValidatableObject interface.

Let me know what you think!

BR
Gabriel

Enumify Flags in HasFlag/SetFlag Extension Methods

BO4E-dotnet/BO4E-dotnet/BO/BusinessObject.cs

Line 205 in 8bba8b1

public bool HasFlagSet(string flagKey)

In an ideal world, the methods for setting/nulling/reading flags should only accept Enum-Values (bonus: only those with an Flags-Attribute).
ToDo: Make the public method generic enough to consume only enums, not strings. The internal/private methods might still use strings because, as the flags are stored in a Dictionary<string,JToken> (constraint by JSON.Net), the keys are ultimately stored as strings in the UserProperties.

WertMengeArt vs Messwertstatus

The non-official Enum WertMengeArt corresponds to the official Messwertstatus except the value ANGABE_FUER_LIEFERSCHEIN is missing.
The library should incorporate the offical enum.

Vertragsstatus vs. Vertragstatus

In Python: beides doppel s
https://github.com/bo4e/BO4E-python/blob/2f292953f5101b468d4d8b8436ef29e7e1fa05da/src/bo4e/bo/vertrag.py#L50

In C#: beides einfaches s

BO4E-dotnet/BO4E/BO/Vertrag.cs

Line 77 in aabf9db

public Vertragstatus? Vertragstatus { get; set; } // ToDo: shouldn't this be vertragsstatus with "ss"?

nasty

Implement IValidatableObject instead of homebrew "IsValid" method

BO4E-dotnet/BO4E-dotnet/BO/BusinessObject.cs

Line 450 in 33a3dd8

public virtual bool IsValid()

The current implementation of IsValid simply tries to serialize the respective BusinessObject or COMponent. While this is inherently consistent with the Newtonsoft.Json attributes there is a more .NET-Standard way to do it: By implementing IValidatableObject

Create a Nuget Package only from the protobuf_v2_legacy_branch

• add a .yml file to the workflows folder based/copied from the feature branch github action
• edit the workflow to only be triggered by pushed to the new protobuf_v2_legacy branch (see trigger section)

• BO4E-dotnet/.github/workflows/feature_branches.yml

  Line 30 in a7ab322

  run: dotnet pack --configuration Release --version-suffix "${{github.sha}}"

  maybe add a protobuf-v2-suffix instead of/additional to the github.sha suffix

push the changes directly to this branch

Add Z92: Übermittlung an das HKNR

BO4E-dotnet/BO4E/ENUM/Verwendungszweck.cs

Line 17 in 1bc5ccc

}

Add `HAENDLER` (98) to Enum Rollencodetyp

Ich wusste nur nicht, ob das überhaupt in die Kategorie fällt. Aber kannst du gerne anspassen, wenn du willst ;)

Originally posted by @hf-aschloegl in #179 (comment)

Sollte das nicht eigentlich in eine Extension-Klasse? Gehört nicht zu dem PR, aber sollten wir vielleicht mal aus der Klasse rauslösen

Sollte das nicht eigentlich in eine Extension-Klasse? Gehört nicht zu dem PR, aber sollten wir vielleicht mal aus der Klasse rauslösen

Originally posted by @JoschaMetze in #20

Turnusrechnung should only be used in NNRechnungstyp, not Rechnungstyp

BO4E-dotnet/BO4E/ENUM/Rechnungstyp.cs

Line 10 in f7a57db

TURNUSRECHNUNG,

see bo4e/BO4E-python#357

Write CI action to Check that `json-schema-files` and actual C# code are in sync

We need a check, that the files in json-schema-files are in sync with the actual c# code base managed in this repository. We don't want to do manual re-generations like in #414 .
This is relevant to have our .ts package in sync: https://github.com/Hochfrequenz/bo4e-dotnet-ts-models (as of today this sync happens more or less manually: some one updates the json schemas, this triggers an update of the .ts package).

See e.g. the bo4e-python tooling (ask @lord-haffi), where the comparison happens.

The comparison shhuld be semantic, not string based.

Therefore:

• understand the test

  BO4E-dotnet/BO4ETestProject/TestJsonSchemaGeneration.cs

  Line 46 in 1c67c18

  public void TestJSchemaFileGenerationBo(int offset)

• encapsulate the logic from the test so far, that it can be run from the CI
• build a github action that checks the consistency

Implement Missing Business Objects

see official list: https://www.bo4e.de/dokumentation

• Angebot
• Ansprechpartner
• Ausschreibung
• Buendelvertrag
• Energiemenge
• Fremdkosten
• Geschaeftsobjekt
• Geschaeftspartner
• Kosten
• Marktlokation
• Marktteilnehmer
• Messlokation
• Netznutzungsrechnung
• Preisblatt
• PreisblattDienstleistung
• PreisblattHardware
• PreisblattKonzessionsabgabe
• PreisblattMessung
• PreisblattNetznutzung
• Rechnung
• Region
• Regionaltarif
• Standorteigenschaften
• Tarif
• Tarifinfo
• Tarifkosten
• Tarifpreisblatt
• Vertrag
• Zaehler

Remove duplicate instances of the JsonProperty attribute

Many properties are currently annotated with two or three JsonProperty attributes, such as JsonPropertyOrder and JsonPropertyName. These additional annotations can be removed.

fehlt in BO4E.ENUM.Verbrauchsart

in enercity document steht dieser Enum fielden in BO4E.ENUM.Verbrauchsart :

Z64: Kraft/Licht
Z65: Wärme
Z66: Kraft/Licht/Wärme
E87: E-Mobilitätsladesäule
ZA8: Straßenbeleuchung
ZB3: Steuerung Wärmeabgabe

dass es mit unserem Enum nicht gleich ist.