FM Patch Studio
ServerBridgeXML-VorgabenHilfe

Hilfe

Die wichtigsten Themen rund um FM Patch Studio – vom Import des Save-as-XML bis zum angewendeten Patch – plus die offizielle Dokumentation von Claris zum App Upgrade Tool.

Grundvoraussetzungen

Diese Punkte müssen einmalig erfüllt sein, bevor Patches erzeugt und angewendet werden können.

FileMaker Server & OttoFMS
  • FileMaker Server 19.6 oder neuer, laufend und mit gültigem Zertifikat (HTTPS), da OttoFMS-Aufrufe über TLS gehen.
  • OttoFMS ab Version 4.9 auf dem Server installiert (ältere Versionen können kein „Save as XML“ über die API).
  • In OttoFMS ein API-Key (beginnt mit ak_) mit Rechten für Dev-Tools/Deployments erzeugt – dieser wird unter „Server“ hinterlegt.
  • Die Zieldatei ist auf dem Server gehostet und wird in „Live Databases“ bzw. „FMS Databases“ gefunden.
  • Ein FileMaker-Konto mit [Full Access] in der Zieldatei für Patch und XML-Export (wird nur pro Vorgang eingegeben, nicht gespeichert).
Ports & Netzwerk
  • 443 (HTTPS) eingehend: FileMaker Data API, OData und die OttoFMS-Weboberfläche/API.
  • 3030 eingehend: OttoFMS-Standardport, falls nicht über den Reverse-Proxy auf 443 geroutet wird.
  • 5003 eingehend: FileMaker Pro Clients zur gehosteten Datei (für manuelle Prüfung und fmp://-Links).
  • 80 eingehend: nur für Zertifikatsverlängerung (Let’s Encrypt) nötig, sonst schließbar.
  • Ausgehend 443 vom Server: OttoFMS-Lizenzprüfung und Updates.
  • Firewall/Proxy darf länger laufende Requests nicht abschneiden – XML-Export und Patch können mehrere Minuten dauern.
Lokaler Arbeitsplatz
  • Claris FileMaker Pro 2023 (20.x) oder neuer für „Datei > Speichern unter XML“.
  • Claris App Upgrade Tool (FMUpgradeTool) lokal installiert; Pfad zur ausführbaren Datei in der Bridge hinterlegt (macOS: im Programmordner, Windows: z. B. C:\Program Files\Claris\FMUpgradeTool\).
  • Die lokale Quelldatei heißt exakt wie im Save-as-XML, sonst weist das Upgrade Tool den Patch ab.
  • Für die Aktionen delete und replace einmalig FMUpgradeTool --generateGUIDs auf der Quelldatei ausführen (Button in der Bridge).
  • FM Patch Bridge (macOS/Windows) installiert, mit App-URL https://fmbuddy.nordend.app und projektspezifischem Bridge-Token konfiguriert.
Einstellungen in der FileMaker-Datei
  • In FileMaker Server unter Verbindungen: FileMaker Data API und OData aktiviert – OttoFMS nutzt diese Schnittstellen.
  • Im Berechtigungssatz des verwendeten Kontos die erweiterte Berechtigung fmrest (Data API) und fmodata (OData) aktiviert.
  • Konto mit [Full Access] bzw. Vollzugriff auf Schema, sonst schlägt der Patch mit Rechtefehler fehl.
  • Datei nicht mit einem Verschlüsselungspasswort (EAR) versehen, oder das Passwort steht bereit – verschlüsselte Dateien brauchen es beim Patchen.
  • Ausreichend freier Speicherplatz und ein aktuelles Backup: OttoFMS legt vor dem Patch eine Sicherung an.

Workflow

1. Save as XML importieren
Exportiere die Quelldatei in FileMaker Pro über Datei > Speichern unter XML oder hole das XML direkt über einen hinterlegten OttoFMS-Server. Danach werden Tabellen, Felder, Layouts, Skripte, Tabellenauftreten und Wertelisten ausgelesen und in der Kerndaten-Übersicht angezeigt.
2. Patch mit KI beschreiben
Beschreibe im Patch-Editor in normaler Sprache, was geändert werden soll. Mit @ fügst du Tabellen-, Feld- oder Skriptnamen exakt aus dem Schema ein. Die KI übernimmt Namenskonventionen aus dem Original-XML bzw. aus deinem hinterlegten Standards-Dokument.
3. Vorschau und Prüfung
Die Patch-Vorschau vergleicht den erzeugten Patch mit dem aktuellen XML: Namenskollisionen, unbekannte Tabellen, doppelte Field-Keys und UUID-Konflikte werden vor dem Anwenden gemeldet. Erst freigeben, wenn keine blockierenden Konflikte übrig sind.
4a. Anwenden über die Bridge
Die Desktop-Bridge (macOS/Windows) lädt freigegebene Patches herunter und startet das lokal installierte Claris App Upgrade Tool. Sie erzeugt eine Kopie mit Zeitstempel und liefert einen fmp://-Link zum direkten Öffnen.
4b. Anwenden über OttoFMS
Für gehostete Dateien wählst du Server und Zieldatei aus, gibst das FileMaker-Konto an und startest den Patch. Der Fortschritt, der OttoFMS-Prozessstatus und das Process Log werden live angezeigt; erfolgreiche Patches werden automatisch als erledigt markiert.
5. Changelog
Jeder Patch wird mit Beschreibung, Status, Zeitpunkt und Ergebnis im Projekt-Changelog geführt. Verworfene Patches lassen sich löschen, erfolgreiche bleiben als Historie erhalten.

Häufige Fragen & Fehlermeldungen

Claris-Dokumentation

Claris FileMaker Upgrade Tool GuideEinstieg und Überblick über das gesamte ToolTypischer WorkflowVom Save as XML bis zur aktualisierten DateiAufbau einer PatchdateiStruktur, Katalog-Elemente und AktionenPatchdatei erstellenSchrittweise Erzeugung eines PatchesBeispiele für BefehlsaufrufePraxisnahe CLI-BeispieleKommandozeilenparameterAlle Subcommands und Parameter im DetailUpgrade und Patchdateien absichernSicherheitsempfehlungen von ClarisUnverschlüsselte PatchdateienPlaintext-Patches: Aufbau und GrenzenVerschlüsselte PatchdateienVerschlüsselte Patches erzeugen und anwendenBeispiel für ReplaceActionBestehende Objekte gezielt ersetzen

Releasenotes
aktuell 1.7.0

Versionsschema MAJOR.MINOR.PATCH – MAJOR bei Änderungen am Patch-Format oder an der Bridge-Schnittstelle, MINOR bei neuen Funktionen, PATCH bei Korrekturen. Die vollständige Liste wird im Repository in RELEASE_NOTES.md geführt.

v1.7.02026-08-27
neueste
  • Releasenotes eingeführt und in der Hilfeseite sichtbar gemacht.
v1.6.22026-08-26
  • Sicherheit: Server-Zugangsdaten (API-Key, FileMaker-Passwort, Encryption-Key) sind für Browser-Clients nicht mehr lesbar.
  • Schutz gegen Anfragen an interne bzw. private Netzwerkadressen (SSRF) bei OttoFMS-Verbindungen.
  • Zugriff auf Changelog, Vorschläge und Registry-Tabellen streng auf Eigentümer bzw. Admins begrenzt.
  • Abhängigkeiten aktualisiert (TanStack Start/Router) inklusive Text-Lockfile.
v1.6.02026-08-25
  • XML-Import vom Server korrigiert: Felder werden der richtigen Tabelle zugeordnet.
  • Kerndaten zeigen immer nur den gewählten Import, keine kumulierten Daten mehr.
  • Neuer Schema-Diff: zwei XML-Importe strukturell vergleichen.
v1.5.02026-08-24
  • Vorab-Validierung jedes Patches über --validatePatch in der Bridge (v1.0.3); Abbruch mit Originalfehlermeldung.
  • Speicherschonender XML-Streaming-Reducer für sehr große Save-as-XML-Dateien.
  • Feld-IDs werden fortlaufend und kollisionsfrei pro Tabelle vergeben.
v1.4.02026-08-22
  • Selbstheilende Patch-Reparatur: Versionskonflikte, unbekannte Begriffe und UUID/ID-Konflikte werden automatisch korrigiert.
  • Gehärtete Layout-Erzeugung und -Validierung für FMSaveAsXML 2.3.0.0.
  • Global editierbare Registry für XML-Begriffe und Layout-Regeln inklusive Admin-Oberfläche.
v1.3.02026-08-21
  • Patch-Editor: Prompt-Vorlagen speichern und projektübergreifend wiederverwenden.
  • Patch-Revisionen für iterative Korrekturen.
  • XML-Snippets (z. B. kopierte Skripte) direkt als Kontext im Prompt nutzbar.
  • XML-Editor mit Live-Validierung vor dem Upload.
v1.2.02026-08-20
  • Mehrere OttoFMS-Server mit Zugangsdaten hinterlegen und pro Projekt auswählen.
  • Zieldatei aus der Liste der gehosteten Dateien wählen.
  • Save-as-XML direkt über die OttoFMS-API abholen.
  • Detaillierte Prozessanzeige inklusive OttoFMS Process Log.
  • Kerndaten-Übersicht mit Tabellen, Feldern, Layouts, Skripten, Tabellenauftreten und Wertelisten.
  • @-Erwähnungen im Patch-Editor für Tabellen-, Feld- und Skriptnamen.
  • Hilfeseite mit Workflow, Grundvoraussetzungen und FAQ.
v1.1.02026-08-19
  • Patch-Vorschau mit Gegenprüfung gegen das aktuelle XML (Namenskollisionen, doppelte Field-Keys, UUID-Konflikte).
  • Layout-Vorschau für bestehende und neu erzeugte Layouts.
  • Unterstützung für Tabellenauftreten, Beziehungen, Layouts und Skripte im Patch.
  • Neue Versionen erhalten einen Zeitstempel im Dateinamen und einen fmp://-Link zum direkten Öffnen.
  • --generateGUIDs direkt aus der Bridge ausführbar.
  • Patches können verworfen und gelöscht werden.
v1.0.02026-08-18
  • Import von Save-as-XML per Datei oder Ordner und Auslesen der Kerndaten.
  • KI-gestützte Patch-Generierung mit Übernahme bestehender Namenskonventionen.
  • Projektverwaltung mit Changelog über alle Patches.
  • FM Patch Bridge für macOS und Windows zur lokalen Ausführung des Claris App Upgrade Tool.