Factorizer/Cluster ERP WikiCluster ERP Türkçe
Home / Business modules

Reference

Intranet my documents

Reference for the my_documents sub-module of intranet, a read-only list of the documents attached to the signed-in employee's own party card.

This page describes the my_documents sub-module in src/cluster_erp/modules/intranet/my_documents/. It lists the documents that the documents module links to the signed-in employee's own party card. It keeps no state and no copy; opening a row opens the document in the documents app (src/cluster_erp/modules/intranet/my_documents/services.py:10-15).

Scope and source

  • Defined in: my_documents/services.py (MyDocumentsService), my_documents/routes.py, and my_documents/metadata.py.
  • Count: no table, 1 route, no ActionMeta.

How it works

Step What happens Source
1 GET /my-documents/ reads the current user from the session; the client does not supply a party src/cluster_erp/modules/intranet/my_documents/routes.py:15-25
2 The user is resolved to a party through GetPartyForEmployee; without a party the list is empty src/cluster_erp/modules/intranet/my_documents/services.py:17-20, src/cluster_erp/modules/intranet/context.py:20-30
3 GetDocumentsForEntity asks the documents module for documents of entity type party and that party id src/cluster_erp/modules/intranet/my_documents/services.py:21-28
4 The route returns the items with a total, without paging src/cluster_erp/modules/intranet/my_documents/routes.py:26-27

The contract GetDocumentsForEntity carries a default limit of 200 (src/cluster_erp/core/contracts.py:2365-2372). The route has no require_permission; the docstring states that any authenticated user may read their own documents (src/cluster_erp/modules/intranet/my_documents/routes.py:15-24).

Screens and metadata

The metadata entity intranet_my_document is labelled My Documents (Turkish Belgelerim) and lists from GET /my-documents/ (src/cluster_erp/modules/intranet/my_documents/metadata.py:21-25). The sidebar section My Documents is hidden from the bar (src/cluster_erp/modules/intranet/module.py:476-485).

Constraints and validation

  • The list is read-only; the sub-module has no write route (src/cluster_erp/modules/intranet/my_documents/routes.py:15-27).
  • The documents module answers the query; how it filters is described on documents module.

Terms introduced

Term Code identifier Definition Turkish term Source
my documents MyDocumentsService The read-only list of documents linked to the employee's own party card. Belgelerim src/cluster_erp/modules/intranet/my_documents/services.py:10

Verified against commit 92f8051 on 2026-11-13.

Verified against commit 92f8051 · 2026-11-13