Document templates
Document templates are Microsoft Excel or Word files in which you can use fields from Planfix tasks and data tags. To do this, special variables are inserted into the document template.
When a document is created from a template, the corresponding values from the current task are automatically substituted in these variables. As a result, you get a completed document with the required data that is immediately attached to the task.
The following types of document templates are supported:
- Word
- Excel
- Text files, for example: txt, xml, html, mmd and others.
Please note:
- The document template must not exceed 15 MB.
Creating document templates
- To create and edit Excel or Word document templates we recommend using the corresponding software packages or the free LibreOffice suite.
- Important: using other editors, for example online editors such as Google Docs, does not guarantee the resulting template will work correctly.
- A list of variables can contain data from tasks, data tags, or other Planfix entities. A list of variables that can be used in templates is available in Documents — Document templates section.
- To start using document templates, upload a template to Planfix. You can do this in Documents — Document templates — New template.
Using document templates
- You can use templates to create documents that contain data from a task and easily attach the documents to the task. Documents are created from templates in the interface for adding files to tasks:
or in the script interface:
When creating a document from a template, you can:
- select the format of the final file that will be attached to the task;
- change the document number (it automatically increases by 1 with each new document, but you may want to skip to a different number);
- change the document date (if necessary)
Naming documents created with templates
A variety of variables can be used in the name of a document created using a template. Click this icon to open a list of variables that can be used:
- These variables can be used to give files names with any level of complexity.
- When the document is created, the actual values of the specified variables will be substituted in place of the variables in the name of the file.
Specifying file type
- A default file type can be set for files created from a template:
- Once a default has been set, the documents created will be the specified type, as long as another type isn't manually specified:
Useful tricks when creating templates
- Variables in document templates
- Functions in document templates
- Tables in document templates
- Fonts in document templates
- Seals and signatures in document templates
- Using images in document templates
- Inserting all task files into a document
- Limitations when using document templates
- Access to document templates