Repository navigation
DocFlowEngine-1.0.0
·
57 commits
to main
since this release
DocFlowEngine v1.0.0 – Erstes Release
Überblick
DocFlowEngine ist ein PowerShell-basiertes Werkzeug zur automatisierten Überwachung von
Quellordnern, Erkennung neuer Dokumente, regelbasierten Umbenennung und Kopie in
Zielordner. Es wurde primär für die Sortierung von Schülermaterial aus SharePoint
entwickelt, ist aber generisch über die Konfiguration anpassbar.
Features
- Quellordner-Überwachung mit konfigurierbaren Include-/Exclude-Dateimustern
(*.pdf,*.docx,*.xlsx,*.java,*.zip,*.py,*.txt,*.md,*.csv,
*.pptx,*.png,*.jpg,*.jpegu. a.) und optional rekursiver Suche - Regelbasierte Umbenennung über konfigurierbare
namingConventionsmit
Regex-Match/Rename-Templates ({date},{timestamp},{originalName}u. a.),
inkl. Unterstützung optionaler Regex-Gruppen (Platzhalter werden bei fehlendem
Treffer durch leeren String ersetzt) - Aufgaben-Routing: Dateien nach dem Schema
<initialen>[_v<version>]_<praefix>_<suffix>_<aufgabennummer>werden automatisch
nach<aufgabenRoot>/<Präfix>/<Suffix>/einsortiert; optionale Versionsangabe
erlaubt mehrere Abgaben derselben Aufgabe ohne gegenseitiges Überschreiben - Namenskonventions-Hinweis: Dateien, die keinem Schema entsprechen, werden nicht
kopiert – stattdessen wird eine konfigurierbare Hinweis-Textdatei im Quellordner
abgelegt, die zur korrekten Umbenennung auffordert - Projekt-Registry (
config/project-routes.txt): neu erkannte Präfixe/Suffixe
werden automatisch dokumentiert und nachvollziehbar festgehalten - Zustandsverwaltung (
.docflow-state.json): bereits verarbeitete Dateien werden
nicht erneut kopiert; bereits sortierte Dateien unterhalb vontargets/aufgabenRoot
werden beim Scannen automatisch ausgeschlossen - DryRun-Modus (
-DryRun) zur risikofreien Vorschau aller geplanten Aktionen - Logging mit konfigurierbarem Level und Ziel-Logdatei
- Keine externen Abhängigkeiten: Konfiguration liegt als PowerShell-Data-Datei
(.psd1) vor, gelesen über das eingebauteImport-PowerShellDataFile– kein
Install-Modulenötig
Plattform & Kompatibilität
- Gleichwertige Unterstützung für PowerShell 7+ und Windows PowerShell 5.1
(vorinstalliert unter Windows) - Läuft unter Windows, macOS und Linux (PowerShell 7+); Windows PowerShell 5.1 nur
unter Windows - Keine Admin-Rechte erforderlich –
-ExecutionPolicy Bypassgilt nur für den
jeweiligen Prozess, nicht systemweit - Benötigt lediglich Lesezugriff auf Quellordner und Schreibzugriff auf Zielordner
Enthaltene Dateien
config/docflow-config.psd1– Konfiguration (Quellen, Ziele, Umbenennungsregeln)config/project-routes.txt– Registry bekannter Präfixe/Suffixescripts/DocFlowEngine.ps1– Skript-Wrapper zum Aufruf des Modulsscripts/DocFlowEngine.psm1– Kernlogik als PowerShell-ModulLICENSE– MIT-Lizenz inkl. Nutzungs-DisclaimerREADME.md– Projektübersicht, Einstieg, Beispiel-Workflow, Troubleshooting
Erste Schritte
# 1. Vorschau (DryRun)
pwsh -NoProfile -ExecutionPolicy Bypass -File ./scripts/DocFlowEngine.ps1 -DryRun
# 2. Tatsächliche Ausführung
pwsh -NoProfile -ExecutionPolicy Bypass -File ./scripts/DocFlowEngine.ps1