Template.docx Template
The Template.docx template is designed for automatic generation of project descriptions in MS Word format using AutoDocs to insert data. The template conditionally consists of three main parts:
- Table of Contents
- Project Statistics
- Description of each process included in the project
The following tags are used in the template:
[ProcessName]— process name.[ActivityCount],[VarCount],[ArgCount],[QueueCount],[AssetCount]— parameters displaying the number of elements, variables, arguments, queues, and assets, respectively.[Tags],[Structure],[MainScheme]— additional data such as tags, structure, and process scheme.
These tags are automatically populated with data from the system, creating the final project report.
- You can safely remove the logo and table of contents from the template, as they can be restored at any stage of creating a custom template.
- Important: Do not delete or modify the boundary markers and main tags of the information block about the process (such as
[ProcessName],[Tags],[Structure], etc.). These elements are necessary for the correct formation of the document. Without them, the autodoc will not be able to process the template and will generate an error.
If the tags and boundary markers have been deleted, they can be restored by creating a group as follows:
- Open the template in MS Word and go to the Developer tab, enable Design Mode.
- Create a group for the tag block:
- Select the text containing the main tags for AutoDocs (e.g.,
[ProcessName],[ActivityCount],[VarCount],[ArgCount],[QueueCount],[AssetCount],[Tags],[Structure],[MainScheme]), and use the Group command to create a single block.
- Select the text containing the main tags for AutoDocs (e.g.,
- Check the structure:
Formed group with main tags and a table where each row displays a parameter and its corresponding tag. - Save the document for the changes to take effect.
After processing by Autodoc, this group will be copied and populated with data for each process included in the project.
This will automatically generate complete reports where the characteristics and structure of each process will be presented.
Description of tags for Template.docx
The Template.docx template includes a number of tags designed to automatically populate data about the project and processes. Each tag performs a specific function, inserting data about the project or processes.
A description of all used tags is provided below:
| Tag | Purpose |
|---|---|
| Project | |
[ProjectName] | Project name |
[ProcessCount] | Number of processes |
[ActivityCount] | Total number of elements in the project |
[VarCount] | Total number of variables in the project |
[ArgCount] | Total number of arguments in the project |
[QueueCount] | Total number of queues in the project |
[AssetCount] | Total number of resources (assets) in the project |
[LibCount] | Number of libraries |
[ProjectTags] | Project tags |
| Process | |
[ActivityCount] | Number of elements in the process |
[VarCount] | Number of variables in the process |
[ArgCount] | Number of arguments in the process |
[QueueCount] | Number of queues in the process |
[AssetCount] | Number of resources in the process |
[Tags] | Process tags |
[Structure] | Process content (structure) |
[MainScheme] | Brief process scheme |
Important: Tags must be used in the appropriate places in the template and, if necessary, enclosed in groups using boundary markers. This will allow autodoc to correctly process and populate the template.