System Documentation

The navigation item Documentation Generator in the navigation group System allows to export parts of the current configuration of ConSol CM 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 following items of the system configuration can be included in the system documentation:

• incoming and outgoing email connection
• customer data models: customer objects and customer fields
• customer groups
• workflows: scopes, activities, triggers, image of the workflow (only available after deploying the workflow)
• queues: workflow, assigned ticket field groups with ticket fields, customer groups, projects and classes of text
• resources: resource categories and resource types with resource fields
• roles: queue, customer group, resource type and global permissions, views, engineer functions
• views: queues, scopes, view criteria

Please proceed as follows to create a system documentation:

1. In the navigation item Scripts and Templates:
   • Create a script of the type System documentation (see Scripts of Type System Documentation).

     OR

   • Adapt the default documentation script included in the ConSol CM distribution to your needs (see Scripts of Type System Documentation).
2. In the navigation item Documentation Generator:
   1. Click the file explorer icon next to the Output file field and select the path where you want to save the documentation. Enter a file name with the desired file extension.
   2. Select the script of the type System documentation in the Script drop-down list.
   3. Optional. Select the checkbox Input export file and provide the path to the scene export for which the system documentation should be generated. The scene needs to contain the systemDocumentation.xml file which is created when enabling the checkbox System documentation in the scene export configuration (see Deployment (Import/Export)).

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

3. The document containing the system documentation is created and saved at the provided path. If a scene export file is selected, the system documentation is generated for this scene. Otherwise, it is generated for the current scene in the Admin Tool.

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.