Intranet module (intranet)

The intranet module in src/cluster_erp/modules/intranet/ is the communication hub between a company and its employees. It covers posts and policies with mandatory-read acknowledgement, company events, leave and request self-service, official document delivery with a signed receipt, an in-app notification inbox, an employee directory, recognition, quick links, and emergency alerts (src/cluster_erp/modules/intranet/module.py:1-11). This page is the overview; each sub-topic has its own page.

At a glance¶

What the module does¶

• Publishes posts, pages, policies, and alerts in spaces, with review, approval, versioned publication, and acknowledgement of mandatory reads (src/cluster_erp/modules/intranet/content/services.py:1-12). See content and feed.
• Merges posts, events, and recognition into one timeline (src/cluster_erp/modules/intranet/feed/services.py:1-5).
• Runs company events with invitations, RSVPs, capacity, and a change log (src/cluster_erp/modules/intranet/events/lifecycle.py:1-21). See events.
• Handles leave types, balances, and leave requests with approval (src/cluster_erp/modules/intranet/leave/services.py:1-7). See leave.
• Handles configurable employee requests such as advances and equipment (src/cluster_erp/modules/intranet/requests/services.py:1-2). See requests.
• Delivers official documents to employees with a receipt (src/cluster_erp/modules/intranet/delivery/services.py:1-4). See notifications and delivery.
• Shows a live directory and org chart read from the employee and party records (src/cluster_erp/modules/intranet/directory/services.py:1-8). See directory.
• Keeps recognition, quick links, and emergency alerts (src/cluster_erp/modules/intranet/engagement/services.py:1-6). See engagement.
• Lists the documents attached to the employee's own party card (src/cluster_erp/modules/intranet/my_documents/services.py:10-15). See my documents.

Sub-modules¶

All 21 routers are included in one module router with the prefix /api/v1/intranet (src/cluster_erp/modules/intranet/module.py:133-197). Access, audience, and retention rules are on access, audience, and retention.

Data model¶

All 30 tables are declared in src/cluster_erp/modules/intranet/models.py. Each sub-module page lists its fields. The model docstring states the binding decisions: access grants and audience segments are separate axes, content is a state machine, acknowledgement is an audit record kept apart from analytics, analytics is aggregate-only with a minimum group size, and employee data is never stored here (src/cluster_erp/modules/intranet/models.py:6-33). The closed vocabularies for statuses, channels, and categories are tuples at the top of the file (src/cluster_erp/modules/intranet/models.py:64-147). Leave day counts are Numeric so that half days are exact (src/cluster_erp/modules/intranet/models.py:734-771).

Screens and metadata¶

get_metadata declares a sidebar group Intranet (Turkish İntranet) (src/cluster_erp/modules/intranet/module.py:398-537). Five sections form the experience: Feed, Events, People, Me, and Manage. Feed, Events, Me, and Manage are custom widgets; People is a list over intranet_employee_projection. Manage needs intranet_settings.update (src/cluster_erp/modules/intranet/module.py:405-442). Ten more sections carry hidden_from_bar=True and remain reachable from search and deep links: Posts, Event records, Leave, Requests, My Documents, Official Deliveries, Notifications, Recognition, Emergency alerts, and Settings (src/cluster_erp/modules/intranet/module.py:443-536). The settings view has six tabs: spaces, segments, leave types, request types, quick links, and intranet settings (src/cluster_erp/modules/intranet/module.py:521-536). The web bundle maps the custom widget keys to its renderers (gated_apps/intranet/app.js:1407); see gated app bundles.

Status and actions¶

Each sub-module page lists its statuses and actions. All lifecycles move through action routes; the update paths do not change the status (src/cluster_erp/modules/intranet/content/services.py:794-806). Decision actions need an elevated permission on top of .update: intranet_content.publish for editorial actions, intranet_leave_request.approve and intranet_request.approve for approvals (src/cluster_erp/modules/intranet/content/routes.py:255-257, src/cluster_erp/modules/intranet/leave/routes.py:274-276, src/cluster_erp/modules/intranet/requests/routes.py:197-199).

Business rules¶

• A personal record (leave, request, delivery) may name only a party that is an active employee (src/cluster_erp/modules/intranet/access.py:124-144).
• The acting person is resolved from the signed-in user's employee link through GetPartyForEmployee; a login without an employee link has no party (src/cluster_erp/modules/intranet/context.py:20-30).
• Business keys come from house sequences, for example intranet_official_delivery (src/cluster_erp/modules/intranet/delivery/services.py:137).
• A blank string in a form payload counts as no value (src/cluster_erp/modules/intranet/validation.py:1-25).

Events and queries¶

The module consumes 6 contracts and produces 18, counted as on the fleet module page with multi-line calls included. The full list is on the contracts reference.

Permissions¶

The row-level tiers built on these keys are on access, audience, and retention.

Privacy, retention, and history¶

privacy_handlers.py answers data-subject requests for twelve intranet record classes, from comments to official deliveries. Anonymisation follows the operator's decision on employment records (src/cluster_erp/modules/intranet/privacy_handlers.py:1-11); see privacy and data-subject requests. retention_handlers.py deletes analytics events past the tenant's window on each retention sweep (src/cluster_erp/modules/intranet/retention_handlers.py:1-55). Other deletes set deleted_at, for example on posts (src/cluster_erp/modules/intranet/content/routes.py:287-301). Changes are captured by change history.

Analytics facts¶

This module has no analytics_facts.py. Read analytics of a post live inside the module with a minimum group size; see access, audience, and retention.

Settings and reference data¶

• One settings row per tenant database holds the minimum group size (default 5), the review interval, the analytics retention window (default 730 days), the emergency banner, the home layout, and the welcome message (src/cluster_erp/modules/intranet/models.py:155-200). The row is created on start (src/cluster_erp/modules/intranet/module.py:55-64).
• Leave types and request types are seeded on start when their codes are missing; the organisation extends both lists (src/cluster_erp/modules/intranet/module.py:66-131, src/cluster_erp/modules/intranet/leave/seeds.py:1-12, src/cluster_erp/modules/intranet/requests/seeds.py:8-36).
• The module tells the tenant field screen that the party field manager_party_id is a soft dependency, and gender a hard one while a gender-restricted leave type exists (src/cluster_erp/modules/intranet/module.py:238-289). See tenant fields.

Tests¶

Found by name (web-client/_e2e_intranet*.mjs) and by a grep for intranet in tests/*.py.

Discrepancies¶

Terms introduced¶

Related pages¶

• Modules index
• Content and feed
• Events
• Leave
• Requests
• Directory
• Notifications and delivery
• Engagement
• My documents
• Access, audience, and retention
• API reference for this module

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