What are the components of a file name?
As described in the article on Content Controls, DokuMate can use some or all of the data identified by the following tags to produce standardized file names: docId, docTypeAndNumber, docTitle, docDate, docRevisionNumber, docAuthor, and docStatus.
What does a DokuMate-generated file name look like?
For example, for a document with:
- docId “R01-30-100”,
- docTypeAndNumber “Appendix 1”,
- docTitle “Applications”,
- docDate “22.05.2018” (or culture-specific variants),
- docRevisionNumber “1.0”,
- docAuthor “ABC”, and
- docStatus “RFP”,
DokuMate would render the following file name (if you chose to include all possible tag values in the file name):
R01-30-100_Appendix 1 (Applications)_2018-05-22_v1.0_@ABC_[RFP].pdf
The following rules are applied:
- docId is the first file name component and is written as-is. However, for DokuMate to recognize a docId, it must follow specific guidelines.
- docTypeAndNumber is written as-is.
- docTitle is written (a) in parentheses when docTypeAndNumber is defined or (b) as-is when docTypeAndNumber is not defined.
- docDate is written in the ISO standard form with hyphens, e.g., 2018-05-22.
- docRevisionNumber is prefixed with a lowercase “v” (but DokuMate will accept an uppercase “V”).
- docAuthor is prefixed with an “@”.
- docStatus must be included in square brackets (“[” and “]”).
DokuMate separates file name components with an underscore (“_”). However, it also recognizes spaces (” “) as a component separator when parsing a file name.
While DokuMate always renders the file name components in the order defined in the example above, it recognizes components in a different order (except for the docId) as long as you follow the component syntax rules. Those were designed so human beings would not have to be fully and utterly disciplined – but certainly somewhat – when manually naming files that DokuMate could still parse.