Documents modülü (documents)

src/cluster_erp/modules/documents/ içindeki documents modülü denetimli belgeleri tutar. Belgenin bir türü vardır, varlık türü ve kimliğiyle herhangi bir kayda bağlanabilir ve numaralı sürümler taşır. Aynı anda bir sürüm aktiftir; yeni bir sürüm ya hemen ya da bir onay zinciri üzerinden aktif olur. Modül ayrıca web uygulamasının metadata ile bulduğu "bu kayda bağlı belgeler" yeteneğini sağlar.

Bir bakışta¶

Modül ne yapar¶

• İş kodu, türü, başlığı, çevirileri, açıklaması ve entity_type ile entity_id üzerinden herhangi bir kayda isteğe bağlı bağlantısı olan belgeleri tutar (src/cluster_erp/modules/documents/documents/models.py:26-49).
• Belge başına numaralı sürümler tutar; her sürüm çekirdek ek deposundaki bir dosyayı gösterir (src/cluster_erp/modules/documents/documents/models.py:52-87). Depolama ekler, notlar ve depolama sayfasında anlatılır.
• Bir sürümü doğrudan veya bir onay zinciri karar verdikten sonra aktif yapar ve önceki aktif sürümü geçersiz kılınmış olarak işaretler (src/cluster_erp/modules/documents/documents/services.py:255-337).
• İzin verilen dosya uzantılarıyla belge türleri tutar ve varsayılan bir küme tohumlar (src/cluster_erp/modules/documents/settings/models.py:11-28, src/cluster_erp/modules/documents/module.py:37-46).
• Diğer modüllere yanıt verir: bir kaydın belgeleri ve bir sürümün arkasındaki dosya (src/cluster_erp/modules/documents/module.py:98-149).

Alt modüller¶

Veri modeli¶

Belge kodları document, sürüm kodları document_version dizisinden gelir (src/cluster_erp/modules/documents/documents/services.py:110-111, src/cluster_erp/modules/documents/documents/services.py:208). Yeni sürüm, en yüksek canlı sürümden sonraki numarayı alır (src/cluster_erp/modules/documents/documents/services.py:200-221).

Ekranlar ve metadata¶

get_metadata, Belgeler liste bölümü ve document_type sekmeli bir ayar bölümüyle Belgeler (İngilizce Documents) kenar çubuğu grubunu tanımlar (src/cluster_erp/modules/documents/module.py:232-265). Modül provides={"record_documents": {...}} yayımlar; böylece web istemcisi kayıt belgeleri özelliğini modül adıyla değil yetenekle bulur (src/cluster_erp/modules/documents/module.py:228-230). Kayıt belgeleri paneli ve görüntüleyici kayıtlar, belgeler, görüntüleyici ve paylaşım sayfasında anlatılır.

Durum ve aksiyonlar¶

Sürüm draft, active, superseded veya withdrawn durumundadır (src/cluster_erp/modules/documents/documents/services.py:200-337). Diyagram sürüm ve onay zincirini gösterir.

flowchart TD
 V["DocumentVersion taslak"] --> S["POST /versions/id/submit-approval"]
 S --> Q{"GetApprovalChainForAction: document_version, activate"}
 Q -->|zincir yok| ACT["DocumentVersionService.activate"]
 Q -->|zincir var| SUB["SubmitForApproval"]
 SUB --> AC["ApprovalCompleted olayı"]
 AC -->|final_status approved| ACT
 AC -->|diğer durum| STAY["sürüm taslak kalır"]
 V --> D["POST /versions/id/activate"]
 D --> ACT
 ACT --> SUP["önceki aktif sürüm: superseded"]
 ACT --> NEW["bu sürüm: active, approved_by, approved_at"]
 NEW --> W["POST /versions/id/withdraw: withdrawn"]

Düz anlatımla:

1. Sürüm taslak olarak başlar. Yalnızca taslak düzenlenebilir veya silinebilir (src/cluster_erp/modules/documents/documents/services.py:223-253).
2. Onaya Gönder, document_version kaynağı ve activate aksiyonu için GetApprovalChainForAction sorar. Zincir yoksa sürümü hemen aktif yapar. Zincir varsa SubmitForApproval çağırır ve sürüm taslak kalır (src/cluster_erp/modules/documents/documents/routes.py:302-351).
3. Auth modülü bir document_version için final_status değeri approved olan ApprovalCompleted yayımladığında işleyici karar vereni GetApprovalRequestById ile okur ve sürümü aktif yapar. Diğer son durumlar onu taslak bırakır (src/cluster_erp/modules/documents/module.py:151-204).
4. Aktif Yap, eki olan bir taslak ister. Mevcut aktif sürümü superseded yapar, yenisini onaylayan ve zamanla active yapar ve DocumentVersionSuperseded ile DocumentVersionActivated yayar (src/cluster_erp/modules/documents/documents/services.py:255-295, src/cluster_erp/modules/documents/documents/services.py:316-337).
5. Geri Çek, aktif bir sürümü withdrawn yapar (src/cluster_erp/modules/documents/documents/services.py:297-314).

Onay zincirleri onaylar ve onay zincirleri sayfasında anlatılır.

İş kuralları¶

• Eki olmayan sürüm aktif yapılamaz (src/cluster_erp/modules/documents/documents/services.py:269-274).
• Belge başına en fazla bir sürüm aktiftir; etkinleştirme öncekini geçersiz kılar (src/cluster_erp/modules/documents/documents/services.py:316-337).
• extra içindeki kiracı alanı değerleri oluşturmada doğrulanır (src/cluster_erp/modules/documents/documents/services.py:110-115). Bkz. kiracı alanları.
• GET /versions/{id}/file, sürümün dosyasını depodan akıtır; dosya yoksa bulunamadı yanıtı verir (src/cluster_erp/modules/documents/documents/routes.py:240-268).
• Belgeyi veya taslak sürümü silmek deleted_at alanını doldurur; toplu silme çekirdek yumuşak silme yardımcısını kullanır (src/cluster_erp/modules/documents/documents/services.py:150-162, src/cluster_erp/modules/documents/documents/services.py:241-253).

Olaylar ve sorgular¶

Modül 5 sözleşme tüketir ve 6 sözleşme üretir; sayım fleet modülü sayfasındaki gibi yapılmıştır. Tam liste sözleşmeler başvurusunda yer alır.

ResolveDocumentVersionFile intranet tebligat indirmesine, GetDocumentsForEntity intranet "belgelerim" listesine hizmet eder (src/cluster_erp/modules/intranet/delivery/routes.py:143-150, src/cluster_erp/modules/intranet/my_documents/services.py:17-28).

İzinler¶

Gizlilik, saklama ve geçmiş¶

privacy_handlers.py, bir kişiye karşı dosyalanan belgeleri (varlık türü party) listeler. Anonimleştirme bir operatör kararıdır (include_documents); dahil edildiğinde belgeler emekliye ayrılır, başlık ve açıklamaları değiştirilir ve sürüm dosyaları silinmek üzere bildirilir (src/cluster_erp/modules/documents/privacy_handlers.py:1-9). Bkz. gizlilik ve ilgili kişi talepleri. Modülde retention_handlers.py yoktur. Değişiklikleri değişiklik geçmişi yakalar.

Analitik olgular¶

Bu modülde analytics_facts.py yoktur.

Ayarlar ve referans verileri¶

Belge türleri referans verisidir. Modül başlarken varsayılan kümeyi DocumentTypeService.seed_defaults ile tohumlar; Varsayılanları Yükle bunu istek üzerine çalıştırır (src/cluster_erp/modules/documents/module.py:37-46, src/cluster_erp/modules/documents/settings/routes.py:52-58). seed_data.py, her biri İngilizce bir ad ve Türkçe bir çeviri taşıyan 15 varsayılan tür tutar, örneğin form, instruction, procedure ve technical_drawing (src/cluster_erp/modules/documents/settings/seed_data.py:1-113).

Testler¶

Ada göre (web-client/_e2e_doc*.mjs, web-client/_e2e_record_docs.mjs) ve tests/*.py içinde documents için grep ile bulundu.

Tutarsızlıklar¶

Tanıtılan terimler¶

İlgili sayfalar¶

• Modüller dizini
• Kayıtlar, belgeler, görüntüleyici ve paylaşım
• Ekler, notlar ve depolama
• İntranet belgelerim
• Bu modülün API başvurusu

92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.