hochfrequenz / ahbesser Goto Github PK

By adding a git tag or creating a release the deployment on stage and prod should get triggered.

The table header should still be visible even if the user scrolled down.

https://github.com/Hochfrequenz/AHahnB/pull/366

• find a good criteria on when to display a link (e.g. not for amodel mark like 'X'/'Muss'... alone but 'X [203]')
• the ahahnb base url should be configurable
• provide the query parameters format, format_version and expression as query params

and make it also searchable.

The user would like to see also the name of the Prüfidentifikator, e.g. 55044 - Anmeldung MSB instead of only 55044.

The user would also like to search for the name of the Prüfidentifikator.
The search should also have the forward typing kind of search.
If the user starts typing Anmeldung than all prüfis which starts or contain this word should be visible.

Maybe we need than to discuss a new architecture setup to achieve this goal.

The goal is to establish an automatic update process starting from the edu-energy-mirror repository.

A GH Action should run and upload the latest version of the scraped documents in the azure blob storage.

In the azure blob storage we want to keep the following directory structure:

|- FV2304
|- FV2310
    |- ...
    |- REQOTE
    |- UTILMD
        |- csv
        |- flatahb
        |- xlsx
    |- ...
|- FV2404

Steps

• Create Resource Group in Azure with pulumi
• Add Azure Blob Storage to this Resource Group with pulumi
• Setup a GH Action in edi-energy-mirror which uploads the results of kohlrahbi into this Azure Blob Storage, see https://github.com/Hochfrequenz/edi_energy_mirror/blob/master/.github/workflows/kohlrahbi.yml
• Add "an azure resource" to run a Docker container

When

• I select the prüfi from the dropdown
• or I typed 5 digits

it should directly submit the form an open the respective prüfidentifikator.

right now i need an additional enter or click although my intentions are clear. legacy ahbesser had this feature, too ;)

The README should contain the following

• the current architecture
• a short manual how to start the application

Create an api endpoint to provide all known format version.

This information can be taken from the azure blob storage.
Each format version is a directory which contains all "Formate" (e.g. INVOIC).

This issue needs a design review first.

We want to connect the solutions AHB Tabellen and Bedingungsbaum with each other.

So the user should be able to click on a condition and gets on the Bedingungsbaum page.
The condition like X [931][494] and the format version should already inserted on the page.

The search bar should move into the top.

The users are mostly interested in some segment groups if they are looking for something in the AHB documents.

Therefore we want the rows to be collapsable.

All the rows which have the same Segmentgruppe and Segmentname should collapse into one row.
This one row should only display the information from the first line.

At the beginning of the collapsed row should be an icon which indicates if the row is collapsed.
The user can also toggle the rows to collapse by clicking this icon.

Only the first row should contain the Segmentname. If this is tricky to solve in the frontend, we can also update the json files.

The format information like UTILMD, INVOICE, REMADV should be visible to the user.

You can take this information either from the directory where we load the prüfi json or you can read it from the first two digits of a Prüfidentifikator, e.g. 13 - MSONC, 11/44/55 UTILMD

similar to #97

• csv
• json

we have to decide how to handle the button situation (i guess we dont want 3 separate buttons for each file format). my suggestions:

• split dropdown menu; something like this (rotated by 180°)
  

• dropdown with toggle switch: allows to download multiple file formats at once
  

im leaning towards the second approach

We got a feature request from Lukas (one of our Prosumers).

He would like to have two buttons to quickly go to the next or previous Prüfi.

Annika M. made already an UI design for this feature.

The columns Segmentgruppe and Segmentname should switch places in the table

happens when attempting to navigate between two /ahb/{FV}/{PrüefID} pages. the browser app will crash eventually.

During the docker-compose start up a small script should fill the blob storage with the files from the machine readable ahbs repository.

So the endpoints for the format versions and prüfidentifikatoren can get developed.

The entries in the column Bedingung / Hinweis / Format should not like

[902] Format: Möglicher Wert: ≥ 0 [937] Format: keine Nachkommastelle

instead the user would like to see

[902] Format: Möglicher Wert: ≥ 0
[937] Format: keine Nachkommastelle

example: https://ahb-tabellen.stage.hochfrequenz.de/ahb/FV2410/55001

Diese Änderungsvorschläge kommen von Annika S.

The user wants to quickly see which format the current selected Prüfi is from.

The first two digits of a Prüfidentifikator defines its format.

You can find the matching in the Python package maus: https://github.com/Hochfrequenz/mig_ahb_utility_stack/blob/e09d9b82ddaca899d31fd279d68c8b54816602c3/src/maus/edifact.py#L47-L68

The format information should be listed below the sender/receiver info

Lukas G. hat uns das Feedback gegeben, dass die Datenelemente und Segmente schwer zu unterscheiden sind.

Für die Anwender ist es hilfreich, wenn es eine visuelle Unterstützung gibt um die Trennungen zwischen Datenelementen und Segmenten deutlicher zu Kennzeichnen.

Als Inspiration kann man sich hier an den AHBs selbst orientieren.

Create an endpoint in the backend to serve the list of all available prüfis for a provided format version e.g. FV2310.

One idea in the workshop was to create an extra file for each format version during the upload of all files.

As a user I would like to share a link which already contains the information format version, pruefidentifikator and my search.

This makes it easy to provide needed information for others, e.g. in a ticket.

Claudia and Lukas (our prosumers) want to see more of the AHB table.
Especially on small laptop screens, the current design takes too much space.

So the meta information below the top bar should scroll away when the user scrolls down.

Here two images to visualise the goal.

Opening the new table

Scrolling down

the mockup looks like this:

but the live version looks like this:

currently, however, we receive Sender/Empfänger from the AHB.json meta data direction: https://github.com/Hochfrequenz/machine-readable_anwendungshandbuecher/blob/20000e7c8725c2f320f505fca1841e81b3685543/FV2404/UTILMD/flatahb/44001.json#L3464

@hf-krechan should we split Sender/Empfänger in ahbesser or should we implement this directly in KohlrAHBi to have two direction information in the json meta data?

In the tab you can see the name of the web site.
This is at the moment Ahbesser but it should be AHB Tabellen

Add a type ahead field in the header section of the page.

This issue needs #8 to work.

Add format version field in the header section.
It should be a dropdown field.

The values for this field will come from the endpoint /format-versions

Issue #7 is required.

Wie kurz besprochen:
Zur Formatumstellung 2410 gibt es kaum aktualisierte Dokumente, namentlich (Filter 01.10.24 auf edi@energy):

AcknowledgementDocument AWT 1.0e
AcknowledgementDocument AWT - informatorische Lesefassung 1.0e
AcknowledgementDocument FB 1.0e
AcknowledgementDocument XSD 1.0e
ActivationDocument AWT 1.1c
ActivationDocument AWT - informatorische Lesefassung 1.1c
ActivationDocument FB 1.1c
ActivationDocument XSD 1.1c
Codeliste der Lokationsbündelstrukturen 1.0
Codeliste der Lokationsbündelstrukturen 1.0 Konsolidierte Lesefassung mit Fehlerkorrekturen Stand: 12.12.2023
Codeliste der Lokationsbündelstrukturen - informatorische Lesefassung 1.0
Codeliste der Lokationsbündelstrukturen - informatorische Lesefassung 1.0 Konsolidierte Lesefassung mit Fehlerkorrekturen Stand: 12.12.2023
Kostenblatt AWT 1.0c
Kostenblatt AWT - informatorische Lesefassung 1.0c
Kostenblatt FB 1.0c
Kostenblatt XSD 1.0c
NetworkConstraintDocument AWT 1.1a
NetworkConstraintDocument AWT - informatorische Lesefassung 1.1a
NetworkConstraintDocument FB 1.1a
NetworkConstraintDocument XSD 1.1a
PlannedResourceScheduleDocument AWT 1.0d
PlannedResourceScheduleDocument AWT 1.0d Konsolidierte Lesefassung mit Fehlerkorrekturen Stand: 10.06.2024
PlannedResourceScheduleDocument AWT - informatorische Lesefassung 1.0d
PlannedResourceScheduleDocument AWT - informatorische Lesefassung 1.0d Konsolidierte Lesefassung mit Fehlerkorrekturen Stand: 10.06.2024
PlannedResourceScheduleDocument FB 1.0d
PlannedResourceScheduleDocument XSD 1.0d
Regelungen zum Übertragungsweg 1.8
Regelungen zum Übertragungsweg für AS4 2.2
Stammdaten AWT 1.4
Stammdaten AWT - informatorische Lesefassung 1.4
Stammdaten FB 1.4
Stammdaten XSD 1.4
Unavailability_MarketDocument AWT 1.1a
Unavailability_MarketDocument AWT - informatorische Lesefassung 1.1a
Unavailability_MarketDocument FB 1.1a
Unavailability_MarketDocument XSD 1.1a

Folgende Dokumente sind erst ab 04.04.2025 gültig (Filter 04.04.25 auf edi@energy):
Allgemeine Festlegungen 6.1a
Allgemeine Festlegungen - informatorische Lesefassung 6.1a
Anwendungsübersicht der Prüfidentifikatoren 3.0
Anwendungsübersicht der Prüfidentifikatoren - informatorische Lesefassung 3.0
APERAK / CONTRL AHB 2.4
APERAK / CONTRL AHB - informatorische Lesefassung 2.4
APERAK MIG 2.1i
APERAK MIG - informatorische Lesefassung 2.1i
API-Guideline 1.0
API-Guideline - informatorische Lesefassung 1.0
API-Webdienste zur Ermittlung der MaLo-ID der Marktlokation 1.0.0
Codeliste der Konfigurationen 1.3
Codeliste der Konfigurationen - informatorische Lesefassung 1.3
COMDIS AHB 1.0f
COMDIS AHB - informatorische Lesefassung 1.0f
COMDIS MIG 1.0e
COMDIS MIG - informatorische Lesefassung 1.0e
Entscheidungsbaum-Diagramme und Codelisten 4.0a
Entscheidungsbaum-Diagramme und Codelisten - informatorische Lesefassung 4.0a
IFTSTA AHB 2.0f
IFTSTA AHB - informatorische Lesefassung 2.0f
IFTSTA MIG 2.0f
IFTSTA MIG - informatorische Lesefassung 2.0f
INVOIC / REMADV AHB 2.5d
INVOIC / REMADV AHB - informatorische Lesefassung 2.5d
INVOIC MIG 2.8d
INVOIC MIG - informatorische Lesefassung 2.8d
MSCONS AHB 3.1e
MSCONS AHB - informatorische Lesefassung 3.1e
MSCONS MIG 2.4d
MSCONS MIG - informatorische Lesefassung 2.4d
ORDCHG AHB 1.0
ORDCHG AHB - informatorische Lesefassung 1.0
ORDERS AHB 1.0
ORDERS AHB - informatorische Lesefassung 1.0
ORDERS MIG 1.4
ORDERS MIG - informatorische Lesefassung 1.4
ORDRSP AHB 1.0
ORDRSP AHB - informatorische Lesefassung 1.0
ORDRSP MIG 1.4
ORDRSP MIG - informatorische Lesefassung 1.4
PRICAT AHB 2.0e
PRICAT AHB - informatorische Lesefassung 2.0e
PRICAT MIG 2.0d
PRICAT MIG - informatorische Lesefassung 2.0d
QUOTES AHB 1.0
QUOTES AHB - informatorische Lesefassung 1.0
QUOTES MIG 1.3a
QUOTES MIG - informatorische Lesefassung 1.3a
Regelungen zum Übertragungsweg für API-Webdienste 1.0
REQOTE AHB 1.0
REQOTE AHB - informatorische Lesefassung 1.0
REQOTE MIG 1.3a
REQOTE MIG - informatorische Lesefassung 1.3a
UTILMD AHB Strom 2.0
UTILMD AHB Strom - informatorische Lesefassung 2.0
UTILMD MIG Strom S2.0
UTILMD MIG Strom - informatorische Lesefassung S2.0
UTILTS AHB Berechnungsformel 1.0g
UTILTS AHB Berechnungsformel - informatorische Lesefassung 1.0g
UTILTS AHB Definitionen 1.1b
UTILTS AHB Definitionen - informatorische Lesefassung 1.1b
UTILTS MIG 1.1d
UTILTS MIG - informatorische Lesefassung 1.1d

The download button is at the moment not working.

Please add a function and link it to the download button to download the excel file for a AHB document.

Die Website ist zwar öffentltich. Trotzdem wollen wir ein bisschen Werbung machen, dafür, dass man unsere Dienste als Hochfrequenz auch kaufen kann, also professionelle Beratung oder Support in MaKo-Fragen. Kriegen wir da einen schönen Text hin? Idealerweise mit verweis auf die landing page

example: you make a typo and end up on the "loading..." ahb/{formatversion}/{pruefid} endpoint, you cannot select a valid PruefID anymore, since the dropdown seems to be disabled. you are still able to manually enter a valid PruefID into the input field, but thats pure luck ;)

instead of bare metal FV2404 it'd be nice to have something like April 2024 (FV2404) or so in the UI dropdown