CDE Self-Host NPD

NameCode

  • 1.3.1. Danh sách NameCode
  • 1.3.2. GroupCode
  • 1.3.3. NameCode
  • 1.3.4. Mô tả mã
  • 1.3.5. Khởi tạo mã tên file
  • 1.3.6. Thêm NameCode mới
  • 1.3.7. Chỉnh sửa NameCode
  • 1.3.8. Xóa NameCode
  • 1.3.9. Lưu ý khi sử dụng NameCode
  • 1.3.10. Cấu trúc tên file
  • 1.3.11. Phần thông tin tùy chọn (Option)
  • 1.3.12. Version do CDE tự động quản lý
  • 1.3.13. Ví dụ hoàn chỉnh
  • 1.3.14. Tóm tắt nguyên tắc

1.3. NameCode

(Quản lý mã đặt tên)

Chức năng NameCode dùng để quản lý các mã chuẩn được sử dụng trong quy tắc đặt tên tài liệu và Information Container trên CDE NPD.

Thay vì để người dùng tự gõ mã tùy ý khi đặt tên file, CDE lưu sẵn các mã hợp lệ theo từng nhóm. Nhờ đó tên file trong Project được tạo thống nhất, hạn chế sai chính tả, sai quy ước hoặc sử dụng mã không được dự án chấp thuận.

Có thể hiểu đơn giản:

NameCode = Thư viện các mã được phép sử dụng khi đặt tên.


1.3.1. Danh sách NameCode

Mỗi dòng trong danh sách gồm các thông tin chính:

  • GroupCode (Nhóm mã)
  • NameCode (Mã sử dụng)
  • Mô tả (Ý nghĩa của mã)

Ví dụ:

GroupCode NameCode Ý nghĩa
PROJECT PRJ_01 Mã dự án
ORIGINATOR NPD Mã đơn vị khởi tạo
VOLUME ZZ Tất cả khối tích / hệ thống
LEVEL ZZ Nhiều cao trình / vị trí
TYPE CM Mô hình phối hợp
NUMBER 01 Số thứ tự
DESCRIPTION xx Mã mô tả bổ sung
SUITABILITY S1 Trạng thái phát hành
ROLE A Kiến trúc sư
ROLE B Giám sát công trình
ROLE C Kỹ sư xây dựng

Một GroupCode có thể chứa nhiều NameCode khác nhau.

Ví dụ:

ROLE
→ A – Architect
→ B – Building Surveyor
→ C – Civil Engineer

Tương tự, TYPE, VOLUME, PROJECT và các nhóm khác có thể có nhiều mã để đáp ứng nhu cầu của từng Project.


1.3.2. GroupCode

(Nhóm mã)

GroupCode xác định mã đang thuộc thành phần nào trong cấu trúc tên file.

Trên hệ thống hiện có các nhóm như:

  • PROJECT – Mã dự án
  • ORIGINATOR – Đơn vị khởi tạo thông tin
  • VOLUME – Khối tích / hệ thống
  • LEVEL – Cao trình / vị trí
  • TYPE – Loại thông tin hoặc loại tài liệu
  • ROLE – Vai trò / bộ môn
  • NUMBER – Số thứ tự
  • DESCRIPTION – Mô tả bổ sung
  • SUITABILITY – Trạng thái phù hợp / phát hành

Các nhóm này được CDE sử dụng để tạo và kiểm tra cấu trúc tên Information Container.


1.3.3. NameCode

(Mã sử dụng)

NameCode là giá trị thực tế được đưa vào tên file.

Ví dụ:

NPD

có thể được sử dụng làm mã Originator.

Hoặc:

AR

có thể được sử dụng trong nhóm VOLUME với ý nghĩa liên quan đến Kiến trúc tùy theo thư viện mã của hệ thống.

Điểm quan trọng là người dùng không cần nhớ toàn bộ mã. CDE có thể lấy các giá trị trong thư viện NameCode để hỗ trợ lựa chọn khi tạo tên file.


1.3.4. Mô tả mã

Trường Mô tả giải thích ý nghĩa của từng NameCode.

Ví dụ:

A – Kiến trúc sư / Architect

BQ – Bảng khối lượng / Bill of Quantities

CA – Tính toán / Calculations

Việc lưu cả mã và mô tả giúp người dùng dễ lựa chọn đúng giá trị mà không cần phải thuộc các bảng mã chuyên ngành.


1.3.5. Khởi tạo mã tên file

Trên thanh công cụ có chức năng:

Khởi tạo mã tên file

Chức năng này dùng để tạo hoặc chuẩn bị bộ NameCode ban đầu phục vụ cho quy tắc đặt tên file trong CDE NPD.

Đây là bước hữu ích khi triển khai Project mới, giúp hệ thống có sẵn các nhóm mã cơ bản thay vì người quản trị phải nhập từng mã từ đầu.


1.3.6. Thêm mã mới

Chọn Add để bổ sung một NameCode mới vào thư viện.

Khi thêm mã, cần xác định tối thiểu:

  • mã thuộc GroupCode nào;
  • giá trị NameCode;
  • Mô tả ý nghĩa của mã.

Không nên tạo nhiều mã khác nhau nhưng cùng một ý nghĩa nếu không có lý do nghiệp vụ rõ ràng, vì điều đó dễ làm người dùng chọn sai khi đặt tên file.


1.3.7. Chỉnh sửa mã

Chọn một dòng trong danh sách và sử dụng Edit để chỉnh sửa NameCode hoặc thông tin mô tả.

Việc sửa các mã đã được sử dụng trong Project cần thực hiện thận trọng.

Một mã đã xuất hiện trong nhiều tên file không nên tùy tiện thay đổi chỉ để “đẹp hơn”, vì có thể tạo ra sự không nhất quán giữa tài liệu cũ và tài liệu mới.


1.3.8. Xóa mã

Chức năng Del dùng để xóa một NameCode không còn được sử dụng.

Trước khi xóa, cần kiểm tra mã đó có đang được dùng trong quy tắc đặt tên hoặc trong các tài liệu hiện hữu hay không.

Với mã đã được sử dụng rộng rãi, phương án an toàn thường là ngừng sử dụng cho dữ liệu mới thay vì làm thay đổi lịch sử của các Information Container đã phát hành.


1.3.9. Save và Cancel

  • Save – Lưu các thay đổi.
  • Cancel – Hủy thao tác đang thực hiện.

Sau khi cập nhật NameCode, nên kiểm tra lại thư viện trước khi áp dụng cho việc tạo tên file.


1.3.10. Vai trò của NameCode trong CDE NPD

NameCode không chỉ là một bảng danh mục mã.

Nó là lớp dữ liệu giúp CDE chuyển từ:

“Người dùng tự đặt tên file”

sang:

“Hệ thống hỗ trợ tạo tên theo quy tắc đã được kiểm soát.”

Luồng nghiệp vụ có thể hiểu như sau:

Project Settings
NameCode
Quy tắc đặt tên
Người dùng chọn mã
CDE tạo / kiểm tra tên file
Information Container có cấu trúc thống nhất

Đây là một phần quan trọng khi triển khai quản lý thông tin theo ISO 19650, vì tên Information Container cần được hình thành từ các trường có ý nghĩa xác định chứ không phải một chuỗi ký tự đặt tùy ý.

Ghi chú

Trong CDE NPD, cấu trúc tên file hiện được xây dựng từ 7 trường bắt buộc, đồng thời có thể mở rộng thêm các trường tùy chọn khi Project có nhu cầu. Thư viện NameCode là nguồn dữ liệu để kiểm soát các giá trị được sử dụng trong những trường này.

1.3.6. Thêm NameCode mới

(Add NameCode – Thêm mã đặt tên)

Để thêm một mã mới vào thư viện NameCode:

  1. Chọn Add trên thanh công cụ.
  2. Hệ thống tạo một dòng nhập liệu mới ngay trên bảng danh sách.
  3. Nhập các thông tin:
    • GroupCode – Nhóm mã.
    • NameCode – Giá trị mã.
    • Mô tả – Ý nghĩa của mã.
  4. Chọn Save để lưu.
  5. Nếu không muốn tiếp tục, chọn Cancel để hủy thao tác.

Ví dụ

Có thể khai báo:

GroupCode: ORIGINATOR
NameCode: NPD
Mô tả: Mã đơn vị khởi tạo

Sau khi lưu, mã mới sẽ được bổ sung vào thư viện và có thể được sử dụng trong các chức năng tạo hoặc kiểm tra tên Information Container.

Lưu ý

Khi nhập NameCode mới cần đảm bảo:

  • chọn đúng GroupCode;
  • mã ngắn gọn và có ý nghĩa;
  • không tạo mã trùng không cần thiết;
  • phần mô tả nên đủ rõ để người khác hiểu mã dùng cho mục đích gì.

Nếu mã được tạo để phục vụ một Project cụ thể, cần tuân theo quy ước đặt tên đã thống nhất của Project đó.


1.3.7. Chỉnh sửa NameCode

(Edit NameCode – Chỉnh sửa mã)

Để chỉnh sửa một mã đã có:

  1. Chọn dòng NameCode cần sửa.
  2. Chọn Edit.
  3. Hệ thống chuyển dòng đó sang trạng thái chỉnh sửa trực tiếp trên grid.
  4. Thay đổi thông tin cần thiết.
  5. Chọn Save để lưu hoặc Cancel để hủy.

Khi sửa mã đã được sử dụng trong các tài liệu hiện hữu, cần cân nhắc kỹ để tránh làm thư viện mã mới không còn thống nhất với tên của các Information Container cũ.


1.3.8. Xóa NameCode

(Delete NameCode – Xóa mã)

Để xóa một NameCode:

  1. Chọn dòng cần xóa.
  2. Chọn Del.
  3. Xác nhận thao tác nếu hệ thống yêu cầu.

Chỉ nên xóa các mã không còn được sử dụng hoặc được khai báo nhầm.


1.3.9. Lưu ý khi sử dụng NameCode

Không phải tất cả các trường NameCode đều có mức ràng buộc giống nhau.

1. Các trường bắt buộc phải khớp danh sách khai báo

Các trường này nên được CDE kiểm tra theo danh mục NameCode đã cấu hình:

  • ORIGINATOR (Đơn vị khởi tạo)
  • VOLUME (Khối tích / Hệ thống)
  • LEVEL (Cao trình / Vị trí)
  • TYPE (Loại thông tin / Loại tài liệu)
  • ROLE (Vai trò / Bộ môn)

Nếu người dùng nhập giá trị không tồn tại trong thư viện NameCode tương ứng, hệ thống nên xem đó là không hợp lệ.

Lý do là đây là các trường phân loại có tập giá trị được dự án quy định trước. Nếu cho nhập tự do thì thư viện NameCode gần như mất ý nghĩa.


2. Trường có quy tắc nhưng không nhất thiết lấy từ danh mục

NUMBER (Số thứ tự)

Đây là trường bắt buộc trong cấu trúc tên, nhưng bản chất là số định danh / số thứ tự của Information Container, không nên yêu cầu người dùng chọn đúng một giá trị đã khai báo sẵn trong NameCode.

NameCode ở đây chỉ nên đóng vai trò:

  • gợi ý định dạng;
  • quy định số ký tự;
  • hoặc cung cấp giá trị mẫu.

Ví dụ 01 trong danh sách không có nghĩa mọi file đều phải mang NUMBER = 01.


3. Các trường mang tính gợi ý / tùy chọn

DESCRIPTION (Mô tả bổ sung) là trường phù hợp nhất để xem như dữ liệu gợi ý.

Người dùng có thể dùng các mã mô tả đã khai báo sẵn, nhưng tùy nghiệp vụ Project có thể cần giá trị khác.

SUITABILITY (Mã trạng thái phù hợp / phát hành) cũng cần tách khỏi nhóm mã nhận diện filename cốt lõi. Đây thiên về metadata trạng thái của Information Container hơn là một thành phần nhận diện bắt buộc của tên file.

Nếu CDE hiện cho phép đưa nó vào tên thì NameCode có thể cung cấp tập giá trị chuẩn; nhưng về nghiệp vụ không nên đánh đồng nó với 7 trường định danh cốt lõi.


4. PROJECT trong NameCode có dấu hiệu dư thừa

Điểm thầy nhận xét con đồng ý.

CDE đã có:

Project → Project Code

Ví dụ:

PRJ_001

Và người dùng đang làm việc trong một Current Project xác định.

Do đó nếu hệ thống khi tạo tên file đã tự đọc:

Current Project.ProjectCode

thì việc khai báo thêm:

GroupCode = PROJECT

trong NameCode là dữ liệu trùng lặp.

Nó còn tạo ra nguy cơ:

Project Settings: PRJ_001
nhưng NameCode lại có: PRJ_01

→ hai nguồn dữ liệu khác nhau cho cùng một khái niệm.

Theo con, nguyên tắc đúng nên là:

PROJECT không cho người dùng tự chọn và không cần quản lý bằng NameCode. CDE tự lấy Project Code từ Project hiện hành.


Tóm tắt đề xuất

Trường Bắt buộc trong tên Phải nằm trong NameCode Vai trò NameCode
PROJECT Không nên Tự lấy từ Project
ORIGINATOR Kiểm soát
VOLUME Kiểm soát
LEVEL Kiểm soát
TYPE Kiểm soát
ROLE Kiểm soát
NUMBER Không Quy tắc / gợi ý
DESCRIPTION Tùy chọn Không bắt buộc Gợi ý
SUITABILITY Metadata / tùy cấu hình Nên có danh mục chuẩn Kiểm soát trạng thái

1.3.10. Lưu ý khi sử dụng NameCode

Không phải tất cả các trường trong cấu trúc tên file đều được quản lý giống nhau. Trong CDE NPD, cần phân biệt rõ:

  • trường bắt buộc phải đúng theo danh mục đã khai báo;
  • trường được CDE tự lấy từ thông tin Project;
  • trường mang tính gợi ý;
  • trường tùy chọn;
  • và phần Version do CDE tự động quản lý.

1. Project Code

(Mã dự án)

Project Code không cần khai báo lại trong NameCode.

CDE tự động lấy mã từ thông tin của Project hiện hành.

Ví dụ Project hiện tại có:

Project Code = PRJ_001

thì phần đầu của tên file sẽ tự động sử dụng:

PRJ_001

Người dùng không cần nhập lại và cũng không nên tạo thêm một mã PROJECT khác trong NameCode.

Điều này giúp tránh tình trạng một Project có hai nguồn mã khác nhau.

Ví dụ không nên xảy ra:

Project Settings = PRJ_001

nhưng trong NameCode lại có:

PROJECT = PRJ_01

Nguyên tắc sử dụng:

Project Code chỉ có một nguồn duy nhất là thông tin Project.


2. Các trường bắt buộc phải đúng với NameCode

Các trường sau phải sử dụng đúng các mã đã được khai báo trong danh mục NameCode của Project:

  • ORIGINATOR – Đơn vị khởi tạo thông tin
  • VOLUME – Khối tích / Hệ thống
  • LEVEL – Cao trình / Vị trí
  • TYPE – Loại thông tin / Loại tài liệu
  • ROLE – Vai trò / Bộ môn

Người dùng không nên tự nhập các giá trị ngoài danh mục đã được thiết lập.

Ví dụ:

ORIGINATOR = NPD

VOLUME = ZZ

LEVEL = ZZ

TYPE = CM

ROLE = A

Các mã này phải tồn tại trong thư viện NameCode tương ứng.

Mục đích là đảm bảo tất cả Information Container trong Project sử dụng cùng một hệ thống mã thống nhất.


3. NUMBER

(Số thứ tự)

NUMBER là thành phần bắt buộc trong tên file nhưng không phải là một danh mục mã cố định.

Ví dụ:

01

02

03

Giá trị này dùng để phân biệt các Information Container có cùng các trường nhận diện phía trước.

NameCode có thể đưa ra giá trị mẫu hoặc quy tắc định dạng, nhưng người dùng không phải chọn một NUMBER cố định từ danh sách NameCode.


4. DESCRIPTION

(Mô tả bổ sung)

DESCRIPTION là trường tùy chọn và mang tính mô tả thêm.

Ví dụ:

NMD

Mã này có thể dùng để bổ sung thông tin giúp người dùng nhận biết rõ hơn nội dung file.

DESCRIPTION có thể được chuẩn hóa thành danh mục gợi ý, nhưng không cần kiểm soát cứng như các trường ORIGINATOR, VOLUME, LEVEL, TYPE và ROLE.


5. SUITABILITY

(Mã trạng thái phù hợp / phát hành)

SUITABILITY thể hiện trạng thái sử dụng hoặc mức độ phù hợp của Information Container.

Ví dụ:

S1

Giá trị này nên được sử dụng theo danh mục trạng thái đã được Project quy định.

Trong cấu trúc tên file của CDE NPD, SUITABILITY có thể được đặt trong phần thông tin tùy chọn.


1.3.11. Cấu trúc tên file

Cấu trúc cơ bản của tên file trong CDE NPD gồm các trường bắt buộc:

PROJECT-ORIGINATOR-VOLUME-LEVEL-TYPE-ROLE-NUMBER

Ví dụ:

PRJ_001-NPD-ZZ-ZZ-CM-A-01.rvt

Trong đó:

Thành phần Giá trị Ý nghĩa
PROJECT PRJ_001 Mã dự án
ORIGINATOR NPD Đơn vị khởi tạo
VOLUME ZZ Toàn bộ khối tích / hệ thống
LEVEL ZZ Nhiều cao trình / vị trí
TYPE CM Mô hình phối hợp
ROLE A Kiến trúc
NUMBER 01 Số thứ tự

1.3.12. Phần thông tin tùy chọn

(Option)

Ngoài các trường bắt buộc, CDE NPD cho phép bổ sung phần thông tin tùy chọn ở cuối tên file.

Phần Option được đặt trong dấu ngoặc đơn:

_(...)

Ví dụ:

_(NMD-S1)

Khi đó tên file đầy đủ có thể là:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1).rvt

Trong ví dụ này:

  • NMD là thông tin mô tả bổ sung;
  • S1 là mã Suitability.

Các Option được sử dụng theo quy ước đã thống nhất của CDE NPD.

Phần Option chỉ bổ sung thông tin cần thiết, không thay thế các trường bắt buộc trong cấu trúc tên file.


1.3.13. Version do CDE tự động quản lý

Người dùng không tự đặt Version trong tên file khi tạo hoặc đồng bộ tài liệu lên CDE.

Ví dụ tên file gốc:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1).rvt

Khi tài liệu được quản lý trong CDE, hệ thống tự tạo và quản lý Version.

Version đầu tiên có thể được quản lý thành:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1)_001.rvt

Các Version tiếp theo:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1)_002.rvt

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1)_003.rvt

và tiếp tục tăng theo chuỗi Version của Document.

Nguyên tắc:

Tên Information Container do người dùng xác định. Version do CDE xác định và quản lý.

Người dùng không cần:

  • đổi tên file để tăng Version;
  • thêm _001, _002, _003 bằng tay;
  • tạo file mới chỉ để biểu diễn một Version mới.

CDE chịu trách nhiệm quản lý toàn bộ lịch sử Version.


1.3.14. Ví dụ hoàn chỉnh

Giả sử Project có:

Project Code: PRJ_001

và người dùng lựa chọn:

Originator: NPD
Volume: ZZ
Level: ZZ
Type: CM
Role: A
Number: 01

Option:

Description: NMD
Suitability: S1

Tên file do người dùng sử dụng:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1).rvt

Sau khi được CDE quản lý với Version đầu tiên:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1)_001.rvt

Version tiếp theo:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1)_002.rvt

Version thứ ba:

PRJ_001-NPD-ZZ-ZZ-CM-A-01_(NMD-S1)_003.rvt

Như vậy, người dùng luôn làm việc với một Information Container, còn CDE tự quản lý lịch sử thay đổi của Information Container đó.


Tóm tắt nguyên tắc

Thành phần Cách quản lý
PROJECT CDE tự lấy từ Project hiện hành
ORIGINATOR Bắt buộc đúng NameCode
VOLUME Bắt buộc đúng NameCode
LEVEL Bắt buộc đúng NameCode
TYPE Bắt buộc đúng NameCode
ROLE Bắt buộc đúng NameCode
NUMBER Bắt buộc nhưng không cần danh mục cố định
DESCRIPTION Tùy chọn / gợi ý
SUITABILITY Tùy chọn theo quy ước Project
VERSION CDE tự động tạo và quản lý

Nguyên tắc cốt lõi

Người dùng chọn đúng mã. Project cung cấp mã Project. CDE quản lý Version.