Dem ci li ci biir

Anatomy of a module

Which files an app brings along – using Tasks and Notes as examples.

An app plugs into the platform through small files with fixed names. The core apps discover them automatically.

File Purpose
schema_init.py Create or extend tables in the tenant schema, plus RLS_POLICIES – see Architecture and tenant isolation.
menu.py MENU_ITEMS: side menu entries with key, icon, German/English name, url_name, required app and permission, sort order.
permissions.py Baseline permissions every active company member gets without a group (for Notes notes.access, notes.share).
dashboard_kacheln.py Dashboard tiles with selection and count.
link_registry.py / links.py Which records the app can link and how they are displayed (task ↔ contact, note ↔ project …).
i18n.py Texts for the app's JavaScript, per request in the user's language.
urls.py, views.py, templates/, static/ the actual interface.

Plus the settings app (tasks_settings) with user and company settings as well as categories and statuses.

Example: menu entry

# notes/menu.py
MENU_ITEMS = [{
    "key": "notizen", "parent_key": None, "level": 0,
    "icon": "journal-text",
    "name_de": "Notizen", "name_en": "Notes",
    "url_name": "notes:index",
    "required_app": "notes", "required_permission": "",
    "is_system": False, "is_enabled": True, "sort_order": 7.85,
}]

required_app hides the entry as long as the company has not booked the module. Administrators can only show, hide and reorder entries, not move them – see Customise the menu.

Permissions of an app

The keys are listed centrally in the catalogue customers/permissions_config.py (e.g. tasks.access, tasks.view_all, tasks.manage_settings). Unknown keys are never allowed. How they are resolved: The permission model.

Ndimbal & Jappale

Gisoo li ngay seet? Platform bi ak bérebu ndimbal bi, benn bësub rekk la.