Skripte des Typs Systemdokumentation

Sie können Teile der aktuellen Konfiguration von ConSol CM in eine Datei exportieren (siehe Systemdokumentation). Im Skript des Typs Systemdokumentation wird der Umfang der Dokumentation bestimmt, d. h. welche Informationen exportiert werden. Zusätzlich können im Skript Formatierungen angewendet und Beschreibungen zu den Elementen hinzugefügt werden.

Die folgenden Elemente der Systemkonfiguration können in der Systemdokumentation enthalten sein:

• eingehende und ausgehende E-Mail-Verbindung
• Kontaktdatenmodelle: Kontaktobjekte und Kontaktfelder
• Kontaktgruppen
• Workflows: Bereiche, Aktivitäten, Trigger, Bild des Workflows (erst nach Installation des Workflows verfügbar)
• Queues: Workflow, zugewiesene Vorgangsfeldgruppen mit Vorgangsfeldern, Kontaktgruppen, Projekte und Textklassen
• Ressourcen: Ressourcenkategorien und Ressourcentypen mit Ressourcenfeldern
• Rollen: Queue-, Kontaktgruppen- und Ressourcenberechtigungen, allgemeine Berechtigungen, Sichten und Benutzerfunktionen
• Sichten: Queues, Bereiche, Sichtenmerkmale

Die ConSol CM-Distribution enthält die beiden Beispielskripte Documentation_Generator_script_EN und Documentation_Generator_script_DE, mit denen eine Systemdokumentation im HTML-Format in Englisch und Deutsch erstellt werden kann.

Möglicherweise muss das Systemdokumentationsskript für die Erstellung einer Dokumentation aus einem Szenarioexport angepasst werden.

Erstellen des Skripts

Die Methoden zum Abrufen der Daten für die Systemdokumentation gehören zum Paket com.consol.cmas.common.model.documentation. Detaillierte Informationen über die verfügbaren Methoden finden Sie in der ConSol CM API-Dokumentation.

Beachten Sie die folgenden Aspekte, wenn Sie ein Systemdokumentationsskript schreiben:

1. Dokumenterstellung:
   Schreiben Sie das Dokument. Die Beispiel-Skripte verwenden die Java-Klasse OutputStream und die Groovy-Klasse MarkupBuilder.
2. Inhalt:
   Bestimmen Sie, welchen Inhalt die Systemdokumentation haben soll. Über die API können Sie Informationen über die Objekte abrufen, die in der Einführung dieser Funktion aufgeführt sind. Die verfügbaren Informationen hängen vom Typ des Objekts ab.
3. Sprachen:
   Wenn Ihr System mehr als eine Sprache hat, entscheiden Sie, ob alle Sprachen benötigt werden und ob sie im selben Dokument enthalten sein sollen.
4. Enums:
   Die API ruft an einigen Stellen technische Enums ab, z. B. für Datenfeldtypen, Workflow-Elemente oder Berechtigungen. Wenn Sie eine benutzerfreundlichere Beschreibung für dieses Enum zur Verfügung stellen wollen, können Sie eine Map erstellen, die eine benutzerfreundliche Bezeichnung für jeden technischen Wert eines Enums enthält.
5. Workflow-Bilder:
   Wenn die Systemdokumentation Bilder der Workflows enthalten soll, müssen Sie die Workflows zuerst installieren. Das Bild wird bei der Installation eines Workflows erzeugt und ist daher nach einem Update des ConSol CM-Systems nicht direkt vorhanden.
6. Layout:
   Mithilfe von HTML-Tags können Sie den Inhalt der Systemdokumentation ordentlich strukturieren. Typischerweise erstellen Sie dazu Überschriften, Absätze, Listen und Tabellen in Standard-HTML-Syntax. Ein einfacher Ansatz, um dem Dokument ein Layout zu geben, ist es, die Darstellung der verwendeten HTML-Tags über einfache CSS-Stile zu definieren. Diese können Sie zum Tag head der Ausgabe hinzufügen.