Übersicht
Der SmartSafe ist eine Anwendung zur lokalen Synchronisation von Archiven aus SV Documents.
Hauptfunktionen
Der SmartSafe bietet Ihnen folgende Möglichkeiten:
✅ Lokale Datenspeicherung: Sie können jederzeit Daten aus der Cloud herunterladen und lokal speichern
✅ Strukturierte Ablage: Die Daten werden in einer übersichtlichen Verzeichnisstruktur abgelegt
✅ Flexible Metadaten: Metadaten werden im Excel-Format oder als JSON-Datei gespeichert und können einfach weiterverarbeitet werden
✅ Excel-Arbeitsmappen: Sie können automatisch Excel-Arbeitsmappen erstellen lassen
✅ Aufräumen: Sie können nicht mehr gebrauchte Vorgänge automatisch löschen
Installation und Konfiguration
Schritt 1: Lizenzdatei ablegen
Wichtig: Sie müssen die Lizenzdatei im config-Verzeichnis des SmartSafes ablegen.
Speicherort:
[SmartSafe-Installation]/config/license.lic
Schritt 2: smartsafe.ini konfigurieren
Sie müssen die Konfigurationsdatei smartsafe.ini im config-Verzeichnis des SmartSafes ablegen.
Beispiel-Konfiguration
[SmartSafe] url = http://documents.example.com:8551/ token = bvWgGa7a5OvFLAtawsdxlQ1QfNor4s26 directory = C:/smartsafe/ archives = rechnungen, auftraege
Konfigurationsoptionen
Die INI-Datei besteht aus 4 Optionen:
Option | Pflicht | Beschreibung |
url | ✅ Ja | Die URL zu Ihrer PHOENIX Documents Installation |
token | ✅ Ja | Token eines Dienstbenutzers für die Anmeldung des SmartSafe |
directory | ✅ Ja | Verzeichnis, in dem alle vom SmartSafe erstellten Dateien abgelegt werden |
archives | ❌ Nein | Das Archiv oder die Archive, die synchronisiert werden sollen (kommagetrennt). Falls nicht angegeben, werden alle Archive synchronisiert |
Wichtiger Hinweis zu neuen Archiven
Wenn Sie ein neues Archiv anlegen:
Tragen Sie das Archiv in der
smartsafe.inieinPassen Sie die Berechtigungen an
Alternative: Kommandozeilen-Parameter
Sie können Pflichtfelder auch auf der Kommandozeile angeben (anstatt in der smartsafe.ini).
Kommandozeilen-Aufruf
Verfügbare Parameter
Sie können den SmartSafe über die Kommandozeile aufrufen. Folgende Parameter werden unterstützt:
--config
Optional. Der Speicherort der smartsafe.ini.
Standard: Falls nicht angegeben, sucht das System die smartsafe.ini im config-Verzeichnis des SmartSafe.
Beispiel:
pa_smartsafe.exe --config C:/meine-configs/smartsafe.ini
--url
Pflichtfeld, falls nicht in smartsafe.ini angegeben.
Die URL zu Ihrer PHOENIX Documents Installation.
Beispiel:
pa_smartsafe.exe --url http://documents.example.com:8551/
--token
Pflichtfeld, falls nicht in smartsafe.ini angegeben.
Token eines Dienstbenutzers für die Authentifizierung.
Beispiel:
pa_smartsafe.exe --token bvWgGa7a5OvFLAtawsdxlQ1QfNor4s26
--directory
Pflichtfeld, falls nicht in smartsafe.ini angegeben.
Das Verzeichnis, in dem alle Dateien abgelegt werden.
Beispiel:
pa_smartsafe.exe --directory C:/smartsafe/
--archive
Optional. Gibt an, welche Archive synchronisiert werden sollen.
Hinweis: Sie können diesen Parameter mehrmals wiederholen, um mehrere Archive zu synchronisieren.
Beispiel:
pa_smartsafe.exe --archive rechnungen --archive auftraege
Unterstützte Befehle
Nach Angabe der Parameter können Sie einen der folgenden drei Befehle ausführen:
1. Befehl: sync
Funktion: Synchronisiert die angegebenen Archive.
Was passiert bei der Synchronisation?
Vorgänge, die versteckt sind (z.B. alte Versionen), werden als obsolete markiert
Gelöschte Vorgänge werden ebenfalls als obsolete markiert
Der Zeitpunkt der Markierung wird festgehalten
Wichtig: Der Synchronisierungszeitpunkt ist ausschlaggebend, nicht der Zeitpunkt, wann der Vorgang erstellt oder verändert wurde.
Beispiel-Aufruf
pa_smartsafe.exe --archive rechnungen sync
Ergebnis: Das Archiv mit dem Kurznamen „rechnungen" wird synchronisiert.
2. Befehl: spreadsheets
Funktion: Erstellt Excel-Arbeitsmappen pro angegebenem Archiv.
⚠️ Wichtige Voraussetzung
Vor der Erstellung der Excel-Arbeitsmappen müssen Sie eine Synchronisation der Archive durchführen.
Optionaler Parameter: --include-old-versions
Fügen Sie diesen Parameter hinzu, damit auch Vorgänge, die als obsolete markiert wurden, in den Arbeitsmappen erscheinen.
Aufbau der Excel-Arbeitsmappen
Jede Arbeitsmappe enthält:
Ein Arbeitsblatt mit einer Tabelle
Pro Dokument eine Zeile in der Tabelle
Jede Zeile enthält:
Die Felddaten für den zugehörigen Vorgang
Einen Datei-Link zum Dokument
Vorgänge ohne Dokumente erscheinen ebenfalls einmal in der Tabelle
Zusätzliche Arbeitsmappen:
Falls das Archiv Felder mit Untertabellen hat, werden weitere Arbeitsmappen erstellt.
Beispiel-Aufrufe
Ohne obsolete Vorgänge:
pa_smartsafe.exe --archive rechnungen spreadsheets
Mit obsoleten Vorgängen:
pa_smartsafe.exe --archive rechnungen spreadsheets --include-old-versions
3. Befehl: cleanup
Funktion: Löscht alte Vorgänge inklusive angehängter Dokumente.
Was wird standardmäßig gelöscht?
Vorgänge, die als obsolete markiert sind
Für die es keine neuere Version gibt, die nicht obsolete ist
Pflichtparameter: --days
Sie müssen angeben, wie viele Tage ein Vorgang schon obsolete sein muss, damit er gelöscht wird.
Empfehlung: Wenn Sie den SmartSafe auch als Datensicherung nutzen möchten, sollten Sie hier einen Wert größer 0 angeben.
Optionaler Parameter: --delete-old-versions
Wenn Sie diesen Parameter hinzufügen, werden auch Vorgänge gelöscht, die eine Version haben, die noch nicht obsolete ist.
Beispiel-Aufruf
pa_smartsafe.exe --archive rechnungen cleanup --days 2
Ergebnis: Obsolete Vorgänge, die vor mindestens 2 Tagen markiert wurden, werden gelöscht.
Komplettes Beispiel-Szenario
Hier sehen Sie einen typischen Arbeitsablauf mit dem SmartSafe:
Schritt 1: Synchronisation durchführen
pa_smartsafe.exe --archive rechnungen sync
Ergebnis: Das Archiv „rechnungen" wird synchronisiert.
Schritt 2: Excel-Arbeitsmappe erstellen
pa_smartsafe.exe --archive rechnungen spreadsheets --include-old-versions
Ergebnis: Eine Excel-Arbeitsmappe wird erstellt, die auch obsolete Vorgänge enthält.
Schritt 3: Aufräumen (einige Tage später)
pa_smartsafe.exe --archive rechnungen cleanup --days 2
Ergebnis: Obsolete Vorgänge, die vor mindestens 2 Tagen markiert wurden, werden gelöscht.
Verzeichnisstruktur
Übersicht
Der SmartSafe legt im konfigurierten directory eine strukturierte Verzeichnishierarchie an.
Nach Ausführung des sync-Befehls
Nach der ersten Synchronisation werden zwei Hauptverzeichnisse angelegt:
1. Verzeichnis: db
Inhalt: Die Datenbank des SmartSafe
[directory]/ └── db/ └── [Datenbankdateien]
2. Verzeichnis: archives
Inhalt: Für jedes synchronisierte Archiv ein Unterverzeichnis
Struktur:
[directory]/ └── archives/ └── [Archiv-Kurzname]/ ├── Index.json └── records/ └── [Vorgänge]
Dateien und Ordner:
Element | Beschreibung |
[Archiv-Kurzname]/ | Unterverzeichnis benannt nach dem Kurznamen des Archivs |
Index.json | Datei mit Daten zum Archiv |
records/ | Unterverzeichnis mit den Vorgängen des Archivs |
Nach Ausführung des spreadsheets-Befehls
Der SmartSafe erstellt eine .xlsx-Datei mit dem Namen des angegebenen Archivs.
Beispiel:
[directory]/ └── archives/ └── rechnungen/ ├── Index.json ├── records/ └── rechnungen.xlsx
Zusammenfassung
Sie haben nun gelernt:
✅ Was der SmartSafe ist und welche Vorteile er bietet
✅ Wie Sie die Lizenzdatei und die smartsafe.ini konfigurieren
✅ Welche Kommandozeilen-Parameter verfügbar sind
✅ Wie Sie Archive mit dem sync-Befehl synchronisieren
✅ Wie Sie mit dem spreadsheets-Befehl Excel-Arbeitsmappen erstellen
✅ Wie Sie mit dem cleanup-Befehl alte Vorgänge löschen
✅ Wie die Verzeichnisstruktur des SmartSafe aufgebaut ist
Typischer Workflow
Synchronisieren:
sync- Daten aus der Cloud herunterladenExportieren:
spreadsheets- Excel-Arbeitsmappen erstellenAufräumen:
cleanup- Alte Vorgänge löschen
Bei Fragen wenden Sie sich bitte an Ihren Administrator.