Files
govoplan-organizations/README.md

51 lines
1.6 KiB
Markdown

# GovOPlaN Organizations
`govoplan-organizations` is the canonical organizational model module for
GovOPlaN.
It owns organization unit types, organization structures, concrete units,
functions, and identity-held function assignments. These facts exist
independently of authentication and authorization. Identity links people to
accounts, and Access projects organization facts into roles and rights.
## Boundary
Organizations owns:
- tenant-local organization unit types
- tenant-local concrete organization units
- parallel organization structures and relation types
- functions in organization units
- whether a function may be delegated or used for acting in place
- identity-held function assignments, optionally constrained to one account
- whether an assignment applies only to one unit or also to subunits
Organizations does not own:
- login accounts, identity lifecycle, or account linking
- role and permission evaluation
- postboxes, workflows, portals, files, or cases
- external IDM connector internals
The WebUI exposed by this repository is a normal module UI at
`/organizations`. Admin-only controls are contributed by this module through the
platform `admin.sections` WebUI capability, so the admin shell can show them
when the organizations module is active.
## Module Contract
The module registers the `organizations.directory` capability from
`govoplan_core.core.organizations`.
Feature modules should consume the capability instead of importing
organization ORM models.
## Development Install
From the core checkout:
```bash
cd /mnt/DATA/git/govoplan-core
./.venv/bin/python -m pip install -e ../govoplan-organizations
```