Intro & Document Types
At Muze we have various type of documents. Each type must have its own running document number. Currently we have moved some of these number generation into our system. Each type has its own prefix/format and its Auto Running Number policy. Please consult following table for more details.
Document Type | Prefix Format | Auto Running Policy | Example |
---|---|---|---|
memo | departmentCode?-date(yyyy-MM) | 0-padded 3 digits, reset every month. | DEV-2023-04-003 |
The ?
sign after attribute refers to optional attribute
Available Attributes
Attribute | Description |
---|---|
departmentCode | Department Code that has been assigned to each employee. Any employee without deparment code will be resolved as empty string. |
date(yyyy-MM) | Formatted Date tokens. Possible formats: Luxon's Tokens. |
Interact with Managed Document Numbers
- /issue-doc-no To issue a new document number.
- /cancel-doc-no In case you need to cancel the document.
Report
By Design, the Doc Running Number that has been controlled by this sub-system is considered MZIC as Source of Truth. To view the report of outstanding records of the Document Number. You can simply visit the related tab on the Spreadsheet. Every document number are automatically generated the output to Google Sheet Files
- Production Sheet
- (for Devlopment) Staging Sheet
Each type of document will be generated to the sheet with following name format:
type_<documentType>
For example type_memo
- is the records issued in memo type.
In case of the report is out-of-sync with the MZIC data source. You can simply replace report file with fresh copy of the document from the MZIC server. Call the following API
curl -XPOST '{{MZIC_HOST}}/document/v1/discorded/export/:documentType/'