|
KnowledgeTree provides a pre-defined collection of case-sensitive 'tokens' (allowable variables), which you may use in various combinations, including plain text strings, to create your custom numbering schemes.
Within a custom numbering scheme, the tokens must be delimited between '<' and '>'. Plain text strings are not delimited.
There are two types of Tokens:
| • | Normal tokens - define the format, and provide a descriptive reference for the document. Examples include: date (day, month, year), path to the document location, version number, KnowledgeTree document ID, and the document type. |
| • | Sequence tokens - define how the custom document ID number increments. Sequence tokens define the number sequences within a custom numbering scheme. One sequence token is used in each numbering scheme. You may specify the number of digits in a sequence (e.g, 1 - 9). Note that negative digits are not allowed. |
Note: When adding a numbering scheme, you can define whether to regenerate the document ID when documents are checked in to KnowledgeTree. New numbering schemes are validated to ensure that only supported tokens are used. If the validation fails, check the following:
| • | whether valid tokens are used |
| • | whether tokens are properly delimited, i.e. that '<' and '>' are not used outside of the token. |
Figure: Defining a custom numbering scheme
Format of the Sequence Token
Format
|
Example
|
Result
|
<TOKEN:#> or, <TOKEN>
|
<DOCTYPE_SEQ:3>
|
‘001, 002, 003…010, 011…’
|
<DOCTYPE_SEQ:2>
|
‘01, 02, 03…10, 11…’
|
<DOCTYPE_SEQ>
|
‘1, 2, 3…10, 11…’
|
Example:
Note: Tokens are case-sensitive, and are preceded by '<' and end with '>'
<DOCTYPE>-NUM-<DOCTYPE_SEQ:3>
“Invoice-NUM-001, Invoice-NUM-002, Invoice-NUM-0
03”
DOCUMENT-<DD>-<MM>-<YEAR>:<YEAR_SEQ>
“DOCUMENT-31-12-2007:1, DOCUMENT-31-12-2007:2”
|
Pre-defined Tokens
The table lists the pre-defined normal and sequence tokens for use with custom numbering schemes:
Token (Normal)
|
Description
|
Example
|
<YEAR>
|
Year (String)
|
2007
|
<MONTH>
|
Month (String)
|
June
|
<YY>
|
Year (Int)
|
99
|
<MM>
|
Month (Int)
|
08
|
<DD>
|
Day (Int)
|
31
|
<VERSION>
|
Document Version
|
0.1
|
<DOCTYPE>
|
Document Type Name
|
Invoice
|
<DOCID>
|
KnowledgeTree Document ID
Note: The Document ID and the numbering scheme must not be used interchangeably .
|
22
|
<PATH>
|
Repository document/folder path (Max 50 chars)
|
/INVOICE/2007/ABC/
|
Token (Sequence)
|
Description
|
Example
|
<DOC_TYPE_SEQ:[1-9]>
|
Store a single sequence for each document type in the system
Counter, incremented each time a document of a particular type is added to the system
|
Invoice001, Invoice002, Invoice003
|
<YEAR_SEQ:[1-9]>
|
Store a single sequence.
Counter, reset on a yearly basis. Increment the counter each time a document is added within the year.
|
Invoice2007-001,
Invoice2007-002,
Invoice2008-001
|
<YEAR_MONTH_SEQ:[1-9]>
|
Store a single sequence.
Counter, on a monthly basis, reset yearly.
Counter is incremented every time a document is added within a month.
|
Invoice2007-January-001, Invoice2007-January-002, Invoice2007-February-001
|
<DOCTYPE_YEAR_SEQ:[1-9]>
|
Store a single sequence for each document type in the system.
Incremented each time a document of a certain type is added to the system.
Counter, reset on a yearly basis.
|
Invoice2007-002, Invoice2008-001
|
<DOCTYPE_YEAR_MONTH_SEQ:[1-9]>
|
Store a single sequence for each document type in the system.
Incremented each time a document of a certain type is added to the system.
Counter, reset on a monthly basis
|
Invoice2007-January-001, Invoice2007-January-002, Invoice2007-February-001
|
|
