Anpassung Kalibrierscheine & Protokolle

In dieser Sektion wird beschrieben, wie man Anpassungen am Layout und Format des Kalibrierscheins vornehmen kann.

Quelltext

Der Quellcode zur Protokollerzeugung ist im Projekt “protocol-server” verankert. Aktuell ist das Projekt hier zu finden.

Der Protocol-Server basiert im Kern auf den Frameworks React und Chromium. React ist ein UI Framework, welches auch für das normale Web-Frontend des OLP genutzt wird. Der Protocol-Server ist an sich also auch eine Web-Applikation, d.h. der Kalibrierschein wird als Website gerendert und danach durch Chromium über programmatisches Ansprechen der “Print-to-PDF” Schnittstelle ein PDF umgewandelt.

Zum Entwickeln werden folgende Tools benötigt:

  • VS Code
  • go
  • git
  • nodejs & npm
  • Chromium

Wenn alle tools vorhanden sind, kann das Projekt mittels git clone heruntergeladen werden.

Danach müssen über die folgenden Kommandos die Abhängigkeiten heruntergeladen werden:

go mod download
cd renderer
npm ci --legacy-peer-deps
cd ..

Anpassungen am Kalibrierschein

Im Ordner renderer/src/slip/Slip.tsx ist der Quelltext für den Kalibrierschein zu finden.

Innerhalb dieser Datei kann durch simple Text-Anpassungen die rechte Sidebar (Rechtliche Informationen) und die Fußleiste (Geschäftsführer etc.) angepasst werden.

Referenz

Die Schriftart kann über die Datei renderer/src/index.css verändert werden (Zeile 4, font-family). Falls dabei eine Schriftart gewählt wird, welche nicht im System vorinstalliert ist, so muss diese manuell definiert und paketiert werden.

Weitergehende Informationne finden sich hier. Schriftarten werden typischerweise als woff oder ttf verschickt, beide Formate können problemlos eingebunden werden.

Ausrollen der Anpassungen

Im aktuellen System können Anpassungen sehr einfach ausgerollt werden. Dazu müssen die vorgenommenen Änderungen, sofern getestet und funktionierend, in git commited werden, danach muss ein Tag mit einer neuen Versionsnummer erzeugt werden.

Wenn das Tag gepusht wird, wird automatisiert aus dem Quelltext ein Container-Image gebaut. Nachdem dieser Schritt fertig gestellt wurde, kann der Benutzer im deploy-Repository in der Datei kalibri.auto.tfvars referenziert werden. Für die Protokollerzeugung muss die Variable “proto_server_version” angepasst werden.

Wenn die Änderungen aus dem deploy-repository gepusht wurden, werden sie automatisiert auf dem CTDI-System ausgerollt.