Tenancy

End-user documentation

Tenancy

Main-tenant administration for tenant provisioning, tenant status, users, database stats, migrations, seeders, modules, cron, audit logs, billing, and backups.

Purpose and What Problem This Solves

The Tenancy module gives main-tenant administrators a control center for tenant lifecycle operations. It helps teams provision, inspect, migrate, seed, configure, back up, bill, and audit tenant environments without mixing those controls into ordinary client screens.

Who normally uses this module

What You Can Do Here

• Create and provision new tenant environments.
• Monitor tenant database stats, module settings, status, users, and cron behavior.
• Run tenant migrations or seeders through controlled admin surfaces.
• Review audit logs, backups, and billing information.
• Separate main-tenant deployment operations from tenant user workflows.

Core Concepts and Terms

Learn these words first. Most user mistakes happen when a beginner opens a form without knowing what the record represents.

Beginner Quick Start

Use this first-run path in a training database or with a supervised account before handling live records.

1. Confirm you are operating from the main tenant and have tenancy administration permission.
2. Create a tenant record with accurate company, slug, database, and contact details.
3. Run provisioning and check status, database stats, users, and enabled modules.
4. Apply required migrations and seeders through the approved workflow.
5. Set backup, billing, and audit monitoring routines before handoff.

Standard Operating Procedures

These SOPs describe the routine operating pattern. Your company policy may add approvals, attachments, or segregation-of-duties controls.

Provision a tenant

1. Validate tenant name, slug, contact, plan, database naming, and required modules.
2. Run setup/provisioning from the Tenancy control center.
3. Review database status, default admin/user access, and module enablement.
4. Record handoff notes and send onboarding details through approved channels.

Run tenant migrations

1. Confirm target tenant scope and backup requirements.
2. Review pending migrations and expected module impact.
3. Run migrations through the tenancy migration workflow.
4. Check logs, schema status, and smoke-test affected modules.

Review tenant health

1. Check tenant status, database stats, cron, backups, billing, and recent audit logs.
2. Flag failed jobs, stale backups, billing issues, or abnormal database growth.
3. Coordinate remediation with support or finance.
4. Document follow-up actions and close only after verification.

Industry Notes and Good Practice

• Tenancy operations are high-impact. A mistaken tenant scope can affect the wrong company, so verify target and environment before acting.
• Separate core multi-tenancy mechanics from tenant management screens. The module manages tenant operations; core still performs runtime switching.
• Backups and audit logs are operational controls, not optional admin clutter.
• Use main-tenant-only access for sensitive deployment tasks.

Controls, Data Quality, and Review Checklist

Use this checklist during onboarding, monthly review, and process audits.

• Tenant slug, database, and company identity are reviewed before provisioning.
• Migrations are run with the intended tenant scope and recorded result.
• Backups are current before risky operations.
• Tenant module changes are documented when they affect billing or access.

Related ERPat areas

FAQ and Troubleshooting

Why can I not see Tenancy menus in a tenant?

Tenancy management is main-tenant-only by design.

Can I run migrations for all tenants?

Only through the approved workflow and after checking backup and release guidance.

What should I check after provisioning?

Database connection, module settings, admin access, default data, cron, backups, and tenant status.

Is tenant switching implemented here?

The core tenancy hook and helpers handle runtime switching; this module manages the admin surfaces.

ERPat Tenancy user guide. This static HTML page is documentation-only and does not change module routing, permissions, or runtime behavior.