Document Tracker Configurations
This page provides information on how to use the document tracker.
 |
From Codebeamer 21.09, additional licensing is required to enable the Document Management module. For more information on how to obtain the license, contact the sales team.
|
Application Configuration
For document tracker-related application configuration settings, see the "documentManagement" section of the Application Configuration.
Create a Document Type Tracker
Document trackers combine the functionality of the traditional document management functionality with the flexibility of trackers. To get started, a new tracker must be created with document type.
The default configuration contains built-in fields and their configuration cannot be modified. The built-in fields are as follows:
• Document name (Text): Contains the file name by default, but can be renamed. It must be unique in a folder.
• Document (Choice): Achoice field that stores the file of the item. Can be used to upload new versions.
• Document modified at (Date): The last modification time of the Document field.
• Document modified by (Members): The user that uploaded the last file.
• Size (Text): The size of the file in a human-readable format.
• Major version (Integer): The major version of the underlying file. Set to 0 for newly uploaded files. Can be configured to increase based on the workflow. For more information, see Configure the Approval Function.
• Document version (Integer): The minor version of the underlying file. Set to 1 for newly uploaded files and automatically increased by 1 at each update of the file.
• Revision (Text, computed): computed as: Major version. Document version, or example, 0.1.
Additionally, the default configuration contains the following optional fields:
• Confidentiality level (Choice): The default options are internal and external.
• Approved by (Member): Can be configured to store the user who first or last approved the document.
• Locked by (Member): Can be used for storing the user who is locking the document.
• Document ID (Text): To store the public identifier of the document.
Configure the Approval Function
It can additionally be extended to increase the major version of the document. To do so, add two Update item properties actions to the Approve and Complete state transitions follows:
• Document version: Set to Value 0
• Major version: Increased by Value 1