Weitere Anpassung und Erweiterung

• Weitere Anpassung und Erweiterung
  • Logos
  • Links und Texte
  • Textvorschläge
  • Backend

Tiefgreifendere Anpassungen benötigen aktuell noch das Anpassen von Komponenten im Quellcode von SecDoc. Neue oder verbesserte Funktionen können auf diese Art ebenfalls realisiert werden, wenn in der Umgebung spezielle Wünsche bestehen. Sollten vorgenommene Anpassungen oder Erweiterungen möglicherweise auch für andere Nutzer von Interesse sein, können diese gerne mit Hilfe eines Merge Requests eingereicht werden.

Sollten viele Änderungen am Quellcode vorgenommen werden, bietet es sich eventuell an, einen Fork des Repositories anzulegen und die eigenen Anpassungen dort vorzunehmen und zu committen. Aktualisierungen in der öffenntlichen Version können mit Git regelmäßig in die eigene Version integriert werden. Weitere Informationen zum Vorgehen können beispielsweise hier gefunden werden: Forking Workflow.

Zur weiteren Anpassung des Systems sollten die Dokumentationen der JS- und PHP-Skripte eingesehen werden. Die Dokumentation des JS-Codes ist zu finden in JSDoc und die des PHP-Backends in phpDoc.

Logos

Die beiden Logos oben in den Ecken sowie das Favicon können einfach durch Austausch der Dateien unter /assets/img/ geändert werden.

Links und Texte

Hierfür können die HTML-Dateien bearbeitet werden. Der Grundaufbau ist in der index.html Datei zu finden. Die verschiedenen Unterseiten, die je nach Modus geladen werden, und die Templates für die Datenschutzerklärung bzw. die Titelseite des VVTs können im Ordner /assets/html/ gefunden und angepasst werden.

Zukünftig sollen einige Texte und Verlinkungen über den Installationswizard angepasst werden können.

Textvorschläge

Für einige Eingabefelder stellt das Tool Vorschläge für den Nutzer zur Verfügung.

Für generelle Felder der Dokumentation werden standardmäßige Vorschläge mitgeliefert, um dem Nutzer das Ausfüllen zu vereinfachen. Diese Vorschläge sind in der Tabelle suggestions in der lokalen Datenbank gespeichert und können natürlich bei Bedarf ergänzt oder verändert werden. Die Standardvorschläge können in der Datei /assets/sql/Default_Suggestions.sql gefunden werden. Dies kann auch als Ausgangspunkt für eine eigene Liste dienen. Vorschläge für neue Eingabehilfen nehmen wir auch gerne entgegen!

Eingabefelder, die die Auswhal von Gruppen oder Nutzern zulassen, zeigen Vorschläge aus dem AD/LDAP oder der lokalen Datenbank an. Dies kann in den Einstellungen zu "Datenquellen" verwaltet werden.

Eingabefelder für Organisationseinheiten, IVVen oder CPE-Einträge werden aktuell separat gehandhabt und müssen lokal angepasst werden. Dafür sind die Tabellen organisationseinheiten, ivven und cpe in der Datenbank vorhanden. Für CPE-Einträge existiert ein Update-Skript unter /assets/php/cpe-update.php. Für eine vorgefüllte CPE-Tabelle kann die Demo-Datenbank verwendet werden.

Backend

Für Anpassungen im Backend, die über die möglichen Konfigurationen in der secdoc.conf.php Datei hinausgehen, können die PHP Dateien direkt angepasst werden. Hier sind vor allem die folgenden Dateien interessant:

• verwaltung.php - Beantwortet alle API Aufrufe der SecDoc Oberfläche; zuständig für E-Mail Versand und PDF-Generierung
• Utils.class.php - Enthält diverse Funktionen für verschiedene Abfragen (z.B. AD/LDAP)
• DBCon.class.php - Verwaltet die Datenbank-Aufrufe zur internen SQLite Datenbank
• Unter /assets/ajax/auth/ befinden sich die Implementierungen der Authentifzierungsmethoden
• Unter /assets/ajax/docmgmt/ befinden sich die Implementierungen für die Dokumentenverwaltung