Scripts of the type System documentation
You can export parts of the current configuration of ConSol CM into a file (see System documentation). The script of the type System documentation determines the scope of this documentation, i.e., which information is exported. In addition, the script allows to apply some formatting and to add descriptions to the items.
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
- contact groups
- workflows: scopes, activities, triggers, image of the workflow (only available after deploying the workflow)
- queues: workflow, assigned case field groups with case fields, contact groups, projects and classes of text
- resources: resource categories and resource types with resource fields
- roles: queue, contact group, resource type and global permissions, views, user functions
- views: queues, scopes, view properties
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.
You might need to adapt the system documentation script if you want to create documentation from a scene export.
Creating the script
The methods for retrieving system documentation data belong to the package com.consol.cmas.common.model.documentation. Please refer to the ConSol CM API Documentation for detailed information about the available methods.
You need to consider the following aspects when writing the system documentation script:
- Document creation:
Write the document, the example scripts use the Java class OutputStream and the Groovy class MarkupBuilder. - Content:
Determine which content should be included in the system documentation. The API allows to retrieve information about the objects listed in the introduction of this feature. The available information depends on the type of object. - Languages:
If your system has more than one language, decide whether all languages are needed and whether they should be included in the same document. - Enums:
The API retrieves technical enums in some places, e.g., for the types of data fields, workflow elements or permissions. If you want to provide a more user-friendly description for these enums, you can create a map containing a user-friendly label for each technical enum value. - Workflow images:
If you want to include workflow images in the system documentation, you need to deploy the workflows first. The image is generated during workflow deployment and is therefore not directly available after updating the ConSol CM system. - Layout:
Use HTML tags to properly structure the content of the system documentation. Typically, you would use standard HTML syntax to create headings, paragraphs, lists, and tables. A simple approach to layout the document is to define the display of the used HTML tags by creating simple CSS styles and adding them to the <head> tag of the output.