Systemdokumentation

Einführung in Systemdokumentation in ConSol CM

Die Funktion zur Systemdokumentation ermöglicht es, die Konfiguration Ihres ConSol CM-Systems in eine Datei zu exportieren. Der Umfang der Dokumentation, d. h. welche Informationen sie umfasst, und das Layout des Dokuments werden in einem Skript des Typs Systemdokumentation festgelegt.

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.

Umfang der Systemdokumentation

Die folgenden Elemente der Systemkonfiguration können in die Systemdokumentation aufgenommen werden:

• 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 exportierte Systemdokumentation kann Folgendes umfassen:

• Konfiguration des aktuellen Systems (Standardeinstellung)

• Konfiguration aus einem Szenario, das mit der Option Systemdokumentation exportiert wurde, siehe Systemdokumentation.

Erstellen einer Systemdokumentation

Gehen Sie folgendermaßen vor, um eine Systemdokumentation zu erstellen:

1. Erstellen Sie auf der Seite Skripte ein Skript des Typs Systemdokumentation, siehe Skripte des Typs Systemdokumentation, oder passen Sie das Beispieldokumentationsskript (Documentation_Generator_script_EN oder Documentation_Generator_script_DE) an Ihre Bedürfnisse an.

2. Wählen Sie das Skript auf der Seite Systemdokumentation im Feld Systemdokumentationsskript aus und geben Sie im Feld Name der Ausgabedatei einen Dateinamen mit Erweiterung an. Die Erweiterung sollte zur Art von Inhalt, die das Skript erzeugt, passen, z. B. .html für das Beispielskript.

3. Optional, nur, wenn Sie eine Dokumentation erstellen möchten, die auf einem Szenario basiert. Wählen Sie eine Szenariodatei, die die systemDocumentation.xml enthalten muss, im Upload-Bereich es Abschnitts Datenquelle aus.

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