System documentation

Introduction to system documentation in ConSol CM

The system documentation feature allows you to export the configuration of your ConSol CM system into a file. The scope of the documentation, i.e., which information is included, and the layout of the document are determined by a script of the type System documentation.

The ConSol CM distribution contains the two example scripts Documentation_Generator_script_EN and Documentation_Generator_script_DE for generating system documentation in HTML format in English and German.

Scope of the system documentation

The following items of the system configuration can be included in the system documentation:

• incoming and outgoing email connection

• contact data models: contact objects and contact fields

• customer groups

• workflows: scopes, activities, triggers, image of the workflow (only available after deploying the workflow)

• queues: workflow, assigned case field groups with case fields, customer groups, projects and text classes

• resources: resource categories and resource types with resource fields

• roles: queue, customer group, resource type and global permissions, views, user functions

• views: queues, scopes, view criteria

The exported system documentation can cover the following:

• Configuration of the current system (default)

• Configuration contained in a scene, which was exported with the option System documentation, see System documentation.

Creating a system documentation

Proceed as follows to create a system documentation:

1. Create a script of the type System documentation on the Scripts page, see Scripts of the type System documentation, or adapt the example documentation script (Documentation_Generator_script_EN or Documentation_Generator_script_DE) to your needs.

2. Select the script on the System documentation page in the System documentation script field and enter a name with extension for the output file in the Output file name field. The extension should match the type of content generated by the script, e.g. .html for the example script.

3. Optional, only if you want to create a documentation based on a scene. Select the scene file, which must contain the systemDocumentation.xml, in the upload area in the Data source section.

   You might need to adapt the system documentation script if you want to create documentation from a scene export.