Help ELMA BPM Platform
×
Menu

Documentation tab


These settings allow you to specify, what information about the variable you want to include in the process documentation.
The Use displayed name and description for documentation option means that ELMA will use the variable display name as the title of the variable description; and as the description, ELMA will use the description given on the Common tab (Fig. 1).
Fig. 1. Property Settings. Documentation tab with the "Use displayed name and description for documentation" checkbox selected.
If you need to include an additional description of properties and objects, or add some examples to the documentation, deselect the "Use displayed name and description for documentation" checkbox. A field for specific XML tags appears. Use these tags to enter your description (Fig. 2). By default, this field contains the XML code which generates documentation when the Use displayed name and description for documentation checkbox is selected.
Fig. 2. Property Settings. Documentation tab with the "Use displayed name and description for documentation" checkbox selected deselected.

Copyright © 2006–2019 ELMA