diff --git a/CHANGELOG.md b/CHANGELOG.md index 6c94267..9881e00 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,40 @@ Alle relevanten Änderungen an diesem Projekt werden hier dokumentiert. +## [0.1.1] - Dokumentation - 2026-05-31 + +### Hinzugefügt + +- Technische Projektdokumentation unter docs/ ergänzt +- Dokument zur Analyse der Implantbibliotheken erstellt +- Dokumentation des Installationsablaufs ergänzt +- Dokumentation der verwendeten Hersteller-Installationsskripte ergänzt +- Dokumentation der Bibliotheksstruktur ergänzt +- Dokumentation der Dateikopie nach Romexis ergänzt +- Backup-Konzept dokumentiert +- Kompatibilität zum Projekt „Backup & Restore“ dokumentiert +- Verzeichnis für Screenshots vorbereitet + +### README + +- Projektbeschreibung erweitert +- Dokumentationsstruktur ergänzt +- Hinweise auf technische Dokumentation ergänzt +- Projektaufbau ausführlicher beschrieben + +### Interne Dokumentation + +- Aufbau der ZIP-Dateien dokumentiert +- SQL-Importprozess dokumentiert +- Verzeichnisstruktur der Bibliotheken dokumentiert +- Hintergrundinformationen zur Backup-Logik ergänzt +- Speicherorte der Romexis-Daten dokumentiert + +### Geändert + +- Dokumentationsstruktur für zukünftige Erweiterungen vorbereitet +- Projektunterlagen in separates docs-Verzeichnis ausgelagert + ## [0.1.0] - 2026-05-31 ### Hinzugefügt diff --git a/README.md b/README.md index 30a594e..a027f59 100644 --- a/README.md +++ b/README.md @@ -19,74 +19,19 @@ Das Tool liest die öffentliche Planmeca Implant Library Webseite aus, zeigt die - Aufruf der originalen `Install_implant.bat` / `Install_script.bat` - Hashprüfung der bekannten Installerskripte -## Voraussetzungen +## Dokumentation -- Windows -- PowerShell 5.1 oder neuer -- Installiertes Planmeca Romexis -- Ausführung am Romexis-Server dringend empfohlen -- SQL Server Command Line Tools (`sqlcmd`) für Backup und SQL-Zugriff -- Schreibrechte auf: - - `C:\ProgramData\RomexisImplantLibraryCache` - - `C:\Program Files\Planmeca\Romexis\geometries` -- Administrative Rechte werden je nach Umgebung benötigt +Weitere technische Informationen befinden sich im Verzeichnis docs. -## Verwendung - -PowerShell als Administrator starten und das Skript ausführen: - -```powershell -Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -.\RomexisImplantInstaller.ps1 -``` - -Danach: - -1. Bibliotheksliste wird automatisch geladen. -2. Gewünschte Bibliotheken auswählen. -3. Optional Backup aktiviert lassen. -4. Entweder nur herunterladen oder herunterladen und installieren. - -## Cache - -Die heruntergeladenen ZIP-Dateien werden standardmäßig unter folgendem Pfad abgelegt: - -```text -C:\ProgramData\RomexisImplantLibraryCache -``` - -Neben jeder ZIP-Datei wird eine `.meta.json` gespeichert. Darin stehen unter anderem: - -- URL -- ETag -- Last-Modified -- Content-Length -- Downloadzeitpunkt -- SHA256 - -Wenn sich eine Datei online geändert hat, wird sie erneut heruntergeladen. - -## Backup - -Vor der Installation kann automatisch ein SQL-Backup der Romexis-Datenbank erstellt werden. Das Backup ist nur als Sicherheitsnetz vor Bibliotheksänderungen gedacht und ersetzt kein reguläres Backupkonzept. -Die Logik ist an das Format vom Backup & Restore SCript von Tobias Bauer angeleht und kann damit ggf. wieder eingelesen werden +- [installer-analysis.md](docs/installer-analysis.md) +- [backup-concept.md](docs/backup-concept.md) +- [screenshots/](docs/screenshots) ## Hinweise -Dieses Projekt ist kein offizielles Planmeca-Tool. Es ruft die von Planmeca bzw. den Herstellern mitgelieferten Installationsskripte auf, statt die SQL-Logik vollständig nachzubauen. +Dieses Projekt ersetzt keine reguläre Datensicherung. -Die Nutzung erfolgt auf eigene Verantwortung. Vor produktivem Einsatz sollte ein vollständiges Backup vorhanden sein. - -## Projektstruktur - -```text -. -├── RomexisImplantInstaller.ps1 -├── README.md -├── CHANGELOG.md -├── LICENSE -└── .gitignore -``` +Vor Änderungen an produktiven Systemen sollten zusätzliche Backups vorhanden sein. ## Lizenz diff --git a/docs/backup-concept.md b/docs/backup-concept.md new file mode 100644 index 0000000..5a7f071 --- /dev/null +++ b/docs/backup-concept.md @@ -0,0 +1,67 @@ +# Backup-Konzept + +## Hintergrund + +Vor Änderungen an der Romexis-Datenbank kann automatisch ein Datenbankbackup erstellt werden. + +Das Ziel ist nicht die Bereitstellung einer vollständigen Backup-Lösung, sondern eine zusätzliche Sicherheitsmaßnahme vor Bibliotheksinstallationen. + +## Herkunft der Backup-Logik + +Die verwendete Backup-Logik wurde nicht neu entwickelt. + +Sie basiert auf dem bereits vorhandenen Projekt von Tobias Bauer: + +```text +Backup & Restore +``` + +Die Ermittlung von SQL-Server, Datenbank, Romexis-Version und Image-Verzeichnis orientiert sich an der dort verwendeten Vorgehensweise. + +## Kompatibilität + +Ein wichtiges Ziel war die vollständige Kompatibilität mit den bereits vorhandenen Sicherungen. + +Die mit diesem Installer erzeugten Backups können daher direkt mit dem bestehenden Projekt „Backup & Restore“ wiederhergestellt werden. + +Es werden keine projektspezifischen Änderungen am Format vorgenommen. + +## Speicherort + +Backups werden im Romexis Images im "Backup" Verzeichnis gespeichert. + +Beispiel: + +```text +C:\Romexis_Images\Backup +``` + +## Dateiname + +Format: + +```text +YYYYMMDDHHMMSS#Datenbank#Version#.BAK +``` + +Beispiel: + +```text +20260531163206#Romexis_db#65#.BAK +``` + +## SQL-Zugriff + +Die Verbindungsinformationen werden aus der vorhandenen Romexis-Konfiguration gelesen: + +```text +\sconfig\romexis_server.properties +``` + +Dadurch sind normalerweise keine manuellen Angaben erforderlich. + +## Einschränkungen + +Die Backup-Funktion ersetzt keine reguläre Datensicherung. + +Für produktive Umgebungen werden weiterhin vollständige Backup- und Restore-Konzepte empfohlen. diff --git a/docs/installer-analysis.md b/docs/installer-analysis.md new file mode 100644 index 0000000..0367800 --- /dev/null +++ b/docs/installer-analysis.md @@ -0,0 +1,95 @@ +# Analyse der Implantbibliotheken + +## Ziel dieser Analyse + +Dieses Dokument beschreibt den Aufbau der von Planmeca bereitgestellten Implantbibliotheken sowie den Installationsablauf innerhalb des Projekts. + +## Herkunft der Bibliotheken + +Die Bibliotheken werden über die offizielle Planmeca Implant Library Webseite bereitgestellt. + +Die Anwendung lädt die Seite herunter, analysiert die verfügbaren Downloadlinks und stellt diese dem Benutzer zur Auswahl bereit. + +## Aufbau der ZIP-Dateien + +Typischer Aufbau: + +```text +Hersteller_installer.zip +└── Implant_library_files + └── Hersteller + ├── implants + │ ├── files + │ └── scripts + └── sleeves + ├── files + └── scripts +``` + +## Implantatdateien + +Quelle: + +```text +Implant_library_files\Hersteller\implants\files +``` + +Ziel: + +```text +\geometries\implants\Hersteller +``` + +## Sleeve-Dateien + +Quelle: + +```text +Implant_library_files\Hersteller\sleeves\files +``` + +Ziel: + +```text +\geometries\sleeves\Hersteller +``` + +## SQL-Dateien + +Typische Dateien: + +```text +RX_Hersteller_implantssqlsrv.sql +RX_Hersteller_sleevessqlsrv.sql +``` + +Diese werden nicht direkt durch das Projekt ausgeführt. + +Stattdessen werden die vom Hersteller gelieferten Installationsskripte verwendet. + +## Installationsskripte + +Typische Dateien: + +```text +Install_implant.bat +Install_script.bat +``` + +Die Nutzung der Originalskripte reduziert den Pflegeaufwand erheblich und erhöht die Kompatibilität bei zukünftigen Bibliotheksupdates. + +## Hash-Prüfung + +Zur Erkennung größerer Änderungen können bekannte SHA256-Hashes überprüft werden. + +Dies dient als zusätzliche Sicherheitsmaßnahme und soll auffällige Änderungen an den Installationsskripten sichtbar machen. + +## Ablauf + +1. Bibliotheksliste laden +2. ZIP-Datei herunterladen +3. ZIP-Datei entpacken +4. Dateien nach Romexis kopieren +5. SQL-Dateien ermitteln +6. Originalinstaller ausführen +7. Ergebnis protokollieren diff --git a/docs/screenshots/main.png b/docs/screenshots/main.png new file mode 100644 index 0000000..79a3d97 Binary files /dev/null and b/docs/screenshots/main.png differ