1.2.7-Document Version
## 2.7. Document Version
(Quản lý Phiên bản)
2.7.1. Mục đích
2.7.2. Quan hệ giữa Document và DocumentVersion
2.7.3. Cửa sổ Document Versions
2.7.4. Các cột trong danh sách Version
2.7.5. Version Number
(Số Phiên bản)
2.7.6. Current Version
(Phiên bản hiện hành)
2.7.7. Zone
(Vùng CDE)
2.7.8. State
(Trạng thái)
2.7.9. Document Properties
(Thuộc tính Tài liệu)
2.7.10. Thông tin Document
(Thông tin Tài liệu)
2.7.11. DocumentCode
(Mã Tài liệu)
2.7.12. DocumentTitle
(Tiêu đề Tài liệu)
2.7.13. Metadata của Document
2.7.14. Phiên bản hiện hành
(Current DocumentVersion)
2.7.15. VersionNumber
2.7.16. Status của DocumentVersion
2.7.17. IsCurrent
2.7.18. FileName
2.7.19. RelativePath
(Đường dẫn tương đối)
2.7.20. FileSizeBytes
(Dung lượng file)
2.7.21. RevisionNote
(Ghi chú chỉnh sửa)
2.7.22. Comments
(Ghi chú)
2.7.23. UploadedBy
(Người Upload)
2.7.24. UploadDate
(Ngày Upload)
2.7.25. Review & Approval
(Kiểm tra & Phê duyệt)
2.7.26. Version là đối tượng được Review / Approval
2.7.27. System & Tracking
(Hệ thống & Truy vết)
2.7.28. Move to Recycle Bin
(Đưa Version vào Thùng rác)
2.7.29. Không xóa trực tiếp Version
2.7.30. Version Recycle Bin
(Thùng rác Phiên bản)
2.7.31. WIP Revit Version Retention
(Giữ số Phiên bản Revit WIP)
2.7.32. PDF không thuộc WIP Revit Version Retention
2.7.33. Version RVT và PDF được quản lý độc lập
2.7.34. Version và tên file
2.7.35. Lưu ý khi quản lý Version
## 2.7. Document Version
(Quản lý Phiên bản)
### 2.7.1. Mục đích
Document Version dùng để quản lý toàn bộ lịch sử thay đổi của một Document trong CDE NPD.
Một Document có thể có nhiều Version theo thời gian, nhưng vẫn được xem là cùng một Information Container.
Ví dụ:
Document:
PRJ_001-NPD-ZZ-ZZ-CM-D-03
có thể lần lượt có:
Version 027
Version 028
Version 029
Version 030
...
CDE quản lý từng Version riêng biệt để có thể:
- truy vết lịch sử;
- xác định Current Version;
- biết ai tạo Version;
- biết thời điểm tạo;
- quản lý file vật lý của từng Version;
- quản lý Review và Approval;
- đưa Version cũ vào Recycle Bin khi cần.
--------------------------------------------------
### 2.7.2. Quan hệ giữa Document và DocumentVersion
Cần phân biệt rõ hai khái niệm:
Document
→ Information Container logic, tồn tại ổn định trong Project.
DocumentVersion
→ một lần cập nhật nội dung của Document.
Ví dụ:
DocumentCode:
PRJ_001-NPD-ZZ-ZZ-CM-D-03
Current Version:
029
Tên file Version tương ứng:
PRJ_001-NPD-ZZ-ZZ-CM-D-03-029.rvt
Version 029 không phải là một Document mới.
Đó là Version 029 của Document:
PRJ_001-NPD-ZZ-ZZ-CM-D-03
Nguyên tắc:
Một Document
→ có nhiều DocumentVersion.
Tại một thời điểm:
→ có một Current Version hiện hành.
--------------------------------------------------
### 2.7.3. Cửa sổ Document Versions
Chọn một Document rồi nhấn Versions để mở cửa sổ Document Versions.
Cửa sổ này hiển thị lịch sử các Version thuộc Document đang chọn.
Phần đầu cửa sổ cho biết:
- Document.
- Title.
- Zone.
- State.
Ví dụ:
Document:
PRJ_001-NPD-ZZ-ZZ-CM-D-03
Zone:
WIP
State:
INTERNAL
Bên dưới là danh sách toàn bộ Version của Document.
--------------------------------------------------
### 2.7.4. Các cột trong danh sách Version
Danh sách Document Versions hiện gồm:
- Ver
- Zone
- State
- File
- By
- At
- Current
Ý nghĩa:
Ver
→ số Version.
Zone
→ vùng CDE của Version.
State
→ trạng thái nghiệp vụ của Version.
File
→ tên file vật lý tương ứng với Version.
By
→ người tạo hoặc Upload Version.
At
→ thời điểm Version được tạo.
Current
→ xác định Version có đang là phiên bản hiện hành hay không.
--------------------------------------------------
### 2.7.5. Version Number
(Số Phiên bản)
Mỗi Version có một số thứ tự riêng.
Ví dụ:
027
028
029
030
...
Version Number do CDE tự quản lý.
Người dùng không nên tự tăng Version bằng cách đổi tên file thủ công.
Khi có nội dung mới của cùng Document, CDE tạo Version tiếp theo trong chuỗi Version tương ứng.
--------------------------------------------------
### 2.7.6. Current Version
(Phiên bản hiện hành)
Current Version là Version hiện đang được CDE sử dụng làm phiên bản chính của Document.
Trong danh sách Version:
Current = true
→ Version hiện hành.
Current = false
→ Version lịch sử.
Một Document có thể có nhiều Version nhưng tại một thời điểm chỉ nên có một Current Version hợp lệ cho cùng chuỗi dữ liệu tương ứng.
Các module khác của CDE khi cần sử dụng Document thường phải tham chiếu đúng Current Version.
--------------------------------------------------
### 2.7.7. Zone
(Vùng CDE)
Mỗi DocumentVersion có thông tin Zone.
Ví dụ:
WIP
Zone cho biết Version đang thuộc vùng nghiệp vụ nào của CDE.
Các vùng có thể gồm:
- WIP.
- Shared.
- Published.
- Archive.
Zone là thuộc tính của Version vì cùng một Document có thể đi qua nhiều trạng thái và vùng dữ liệu khác nhau trong vòng đời của nó.
--------------------------------------------------
### 2.7.8. State
(Trạng thái)
State biểu thị trạng thái nghiệp vụ của Version.
Ví dụ trong WIP:
WIP
hoặc ở cấp Document có thể thấy:
INTERNAL.
State hỗ trợ CDE xác định Version hiện đang ở bước nào trong Workflow thông tin.
Không nên nhầm:
Zone
với
State.
Zone
→ vùng dữ liệu CDE.
State
→ trạng thái nghiệp vụ của Information Container hoặc Version.
--------------------------------------------------
### 2.7.9. Document Properties
(Thuộc tính Tài liệu)
Khi chọn một Document trong danh sách, CDE hiển thị panel Document Properties ở bên phải.
Panel này được chia thành các nhóm chính:
1. Thông tin tài liệu.
2. Phiên bản hiện hành.
3. Review & Approval.
4. System & Tracking.
Điểm quan trọng:
Document Properties không chỉ hiển thị thông tin của file.
Nó đồng thời cho thấy:
Document
+
Current DocumentVersion.
--------------------------------------------------
### 2.7.10. Thông tin Document
(Thông tin Tài liệu)
Nhóm Thông tin tài liệu hiện gồm các trường:
DocumentCode
→ Mã Document.
DocumentTitle
→ Tiêu đề / tên Document.
Type
→ Loại file.
Status
→ Trạng thái Document.
SuitabilityCode
→ Mã Suitability.
Discipline
→ Bộ môn.
Originator
→ Đơn vị khởi tạo.
RoleCode
→ Mã vai trò / bộ môn.
ContainerNumber
→ Số Information Container.
ProjectCode
→ Mã Project.
Zone
→ vùng CDE.
Các thông tin này thuộc cấp Document và dùng để nhận diện Information Container trong Project.
--------------------------------------------------
### 2.7.11. DocumentCode
(Mã Tài liệu)
DocumentCode là mã nhận diện logic của Document.
Ví dụ:
PRJ_001-NPD-ZZ-ZZ-CM-D-03
DocumentCode không chứa Version.
Điều này giúp Document giữ một Identity ổn định dù có nhiều Version khác nhau.
--------------------------------------------------
### 2.7.12. DocumentTitle
(Tiêu đề Tài liệu)
DocumentTitle là tên hoặc tiêu đề của Document.
Ví dụ:
PRJ_001-NPD-ZZ-ZZ-CM-D-03.rvt
DocumentTitle giúp người dùng nhận diện tài liệu ở cấp Document.
Tên file vật lý của từng Version có thể chứa thêm Version Number.
--------------------------------------------------
### 2.7.13. Metadata của Document
Các trường:
- SuitabilityCode.
- Discipline.
- Originator.
- RoleCode.
- ContainerNumber.
- ProjectCode.
được CDE sử dụng như metadata để phân loại và quản lý Information Container.
Các giá trị này liên quan trực tiếp đến Naming Convention của Project.
Ví dụ:
ProjectCode:
PRJ_001
Originator:
NPD
RoleCode:
D
ContainerNumber:
03
Các metadata này giúp hệ thống hiểu cấu trúc của Document thay vì chỉ lưu một chuỗi tên file.
--------------------------------------------------
### 2.7.14. Phiên bản hiện hành
(Current DocumentVersion)
Nhóm Phiên bản hiện hành hiển thị thông tin của Current DocumentVersion.
Các trường hiện có:
- VersionNumber
- Status
- IsCurrent
- FileName
- RelativePath
- FileSizeBytes
- RevisionNote
- Comments
- UploadedBy
- UploadDate
Đây là dữ liệu của Version hiện hành, không phải toàn bộ Document.
--------------------------------------------------
### 2.7.15. VersionNumber
VersionNumber là số Version hiện hành.
Ví dụ:
029
Giá trị này được CDE tự động quản lý.
--------------------------------------------------
### 2.7.16. Status của DocumentVersion
Status cho biết trạng thái hiện tại của Version.
Ví dụ:
WIP
Status của Version có thể thay đổi theo Workflow và vùng dữ liệu.
--------------------------------------------------
### 2.7.17. IsCurrent
IsCurrent xác định Version có phải Current Version hay không.
Ví dụ:
Yes
có nghĩa đây là Version hiện hành đang được Document sử dụng.
--------------------------------------------------
### 2.7.18. FileName
FileName là tên file vật lý của Version hiện hành.
Ví dụ:
PRJ_001-NPD-ZZ-ZZ-CM-D-03-029.rvt
Có thể hiểu:
DocumentCode
+
VersionNumber
→ FileName của Version.
--------------------------------------------------
### 2.7.19. RelativePath
(Đường dẫn tương đối)
RelativePath cho biết vị trí lưu của Version trong cấu trúc Folder của Project.
Ví dụ:
0_Revit_Project/1_Components
Thông tin này giúp CDE xác định vị trí file trong cấu trúc dữ liệu của Project.
--------------------------------------------------
### 2.7.20. FileSizeBytes
(Dung lượng file)
FileSizeBytes lưu kích thước file thực tế theo Byte.
Thông tin này được sử dụng để:
- theo dõi dung lượng;
- quản lý Version;
- kiểm soát storage;
- hỗ trợ cơ chế Version Retention.
--------------------------------------------------
### 2.7.21. RevisionNote
(Ghi chú chỉnh sửa)
RevisionNote dùng để ghi lại nội dung hoặc lý do thay đổi của Version.
Ví dụ có thể ghi:
- cập nhật kiến trúc tầng 2;
- sửa vị trí cửa;
- cập nhật theo RFI;
- sửa theo Review.
Việc sử dụng RevisionNote giúp người dùng hiểu Version mới khác Version trước ở điểm nào.
--------------------------------------------------
### 2.7.22. Comments
(Ghi chú)
Comments dùng để lưu các ghi chú bổ sung liên quan đến Version.
Trường này có thể được sử dụng cho thông tin nội bộ hoặc các ghi chú nghiệp vụ cần thiết.
--------------------------------------------------
### 2.7.23. UploadedBy
(Người Upload)
UploadedBy cho biết User đã đưa Version lên CDE.
Thông tin này giúp truy vết nguồn phát sinh Version.
--------------------------------------------------
### 2.7.24. UploadDate
(Ngày Upload)
UploadDate cho biết thời điểm Version được đưa vào hệ thống.
Thông tin này hỗ trợ theo dõi lịch sử phát triển của Document.
--------------------------------------------------
### 2.7.25. Review & Approval
(Kiểm tra & Phê duyệt)
Nhóm Review & Approval lưu thông tin liên quan đến quá trình kiểm tra và phê duyệt Version.
Các trường hiện có:
- ReviewDate
- IsApproved
- ApprovedByName
- ApprovedAt
Ý nghĩa:
ReviewDate
→ thời điểm Version được Review.
IsApproved
→ xác định Version đã được Approved hay chưa.
ApprovedByName
→ người thực hiện Approval.
ApprovedAt
→ thời điểm Approval.
Các thông tin này giúp CDE truy vết lịch sử Review và Approval của Version.
--------------------------------------------------
### 2.7.26. Version là đối tượng được Review / Approval
Review và Approval cần gắn với Version cụ thể.
Lý do:
Cùng một Document có thể có:
Version 028
→ chưa đạt.
Version 029
→ đã sửa.
Version 030
→ được Approved.
Nếu chỉ lưu trạng thái Review ở cấp Document thì sẽ không biết chính xác Version nào đã được kiểm tra hoặc phê duyệt.
Do đó:
Document
→ Identity ổn định.
DocumentVersion
→ nội dung cụ thể được Review và Approval.
--------------------------------------------------
### 2.7.27. System & Tracking
(Hệ thống & Truy vết)
Phần System & Tracking hiển thị các thông tin hệ thống phục vụ Audit và truy vết.
Ví dụ:
Created
→ người tạo và thời điểm tạo.
Updated
→ người cập nhật và thời điểm cập nhật.
Thông tin này không phải metadata nghiệp vụ do người dùng nhập.
Đây là dữ liệu hệ thống tự ghi nhận để phục vụ lịch sử và kiểm tra thay đổi.
--------------------------------------------------
### 2.7.28. Move to Recycle Bin
(Đưa Version vào Thùng rác)
Trong cửa sổ Document Versions, người dùng có thể chọn một Version và sử dụng:
Move to Recycle Bin.
Chức năng này dùng để loại riêng một Version khỏi danh sách Version hoạt động mà không xóa toàn bộ Document.
Có thể hiểu:
Document
→ vẫn tồn tại.
Version được chọn
→ chuyển vào Version Recycle Bin.
Các Version khác
→ vẫn được giữ nguyên.
--------------------------------------------------
### 2.7.29. Không xóa trực tiếp Version
Khi cần loại bỏ một Version, CDE sử dụng cơ chế:
Move to Recycle Bin
thay vì xóa vật lý ngay.
Điều này giúp:
- tránh mất dữ liệu do thao tác nhầm;
- cho phép Restore;
- bảo toàn lịch sử trước khi Purge.
Nguyên tắc:
Delete Version
→ Version Recycle Bin
→ Restore hoặc Purge.
--------------------------------------------------
### 2.7.30. Version Recycle Bin
(Thùng rác Phiên bản)
Version Recycle Bin quản lý riêng các Version đã bị loại khỏi chuỗi Version hoạt động.
Cần phân biệt:
Project Recycle Bin
→ Document / Folder.
Version Recycle Bin
→ từng DocumentVersion.
Hai cơ chế hoạt động ở hai cấp dữ liệu khác nhau.
--------------------------------------------------
### 2.7.31. WIP Revit Version Retention
(Giữ số Phiên bản Revit WIP)
Đối với file Revit trong WIP, CDE có cơ chế tự động giới hạn số Version hoạt động được giữ lại.
Thiết lập tại:
Project Settings
→ Keep WIP Revit Versions.
Ví dụ:
Keep WIP Revit Versions = 5
CDE giữ:
5 Version Revit WIP gần nhất.
Khi có Version mới vượt quá giới hạn:
Version Revit cũ nhất
→ Version Recycle Bin.
Giới hạn hiện tại:
Tối thiểu: 1
Mặc định: 5
Tối đa: 20
--------------------------------------------------
### 2.7.32. PDF không thuộc WIP Revit Version Retention
Cơ chế Keep WIP Revit Versions chỉ áp dụng cho file RVT.
PDF không bị tự động đưa vào Version Recycle Bin bởi cơ chế này.
Điều này nhằm tránh mất lịch sử PDF, đặc biệt các PDF có thể liên quan đến:
- Review;
- Technical Review;
- Annotation;
- phát hành hồ sơ.
--------------------------------------------------
### 2.7.33. Version RVT và PDF được quản lý độc lập
Nếu cùng một Document hoặc nghiệp vụ có cả RVT và PDF, chuỗi Version được quản lý riêng theo FileType.
Ví dụ:
RVT:
001
002
003
004
PDF:
001
002
003
Không lấy Version RVT để tăng tiếp Version PDF và ngược lại.
Nguyên tắc:
Document + FileType
→ một chuỗi Version riêng.
Điều này giúp các loại file phát triển độc lập nhưng vẫn giữ được quan hệ nghiệp vụ với cùng Information Container.
--------------------------------------------------
### 2.7.34. Version và tên file
Người dùng không tự thêm Version vào tên file gốc trước khi đưa tài liệu vào CDE.
Ví dụ Information Container:
PRJ_001-NPD-ZZ-ZZ-CM-D-03.rvt
CDE quản lý Version thành:
PRJ_001-NPD-ZZ-ZZ-CM-D-03-001.rvt
PRJ_001-NPD-ZZ-ZZ-CM-D-03-002.rvt
PRJ_001-NPD-ZZ-ZZ-CM-D-03-003.rvt
Version Number do hệ thống quản lý.
--------------------------------------------------
### 2.7.35. Lưu ý khi quản lý Version
Khi làm việc với Version cần lưu ý:
- không tạo Document mới chỉ để biểu diễn một lần cập nhật;
- không tự tăng Version bằng cách đổi tên file;
- luôn kiểm tra Current Version trước khi sử dụng;
- Review và Approval phải gắn với Version cụ thể;
- không xóa Version trực tiếp;
- sử dụng Move to Recycle Bin khi cần loại Version;
- RVT và PDF có chuỗi Version riêng;
- WIP Revit Version Retention chỉ áp dụng cho RVT;
- PDF không bị Purge bởi cơ chế retention của Revit;
- sử dụng RevisionNote để ghi rõ nội dung thay đổi khi cần.
Nguyên tắc cốt lõi:
Document
→ giữ Identity.
DocumentVersion
→ giữ lịch sử nội dung.
Current Version
→ phiên bản hiện hành.
CDE
→ quản lý toàn bộ vòng đời Version.