Tenant Details
Overview
The Tenant Details page lets you view and edit the full information of a single business tenant, control its runtime status, and trace its complete change history. Click the Name link of a tenant in the Tenant Management list to access it.
The details page does three main things:
- Edit tenant information: Modify fields such as name, description, and enabled state.
- Control the lifecycle: Start, stop, disable, or delete a tenant.
- Trace changes: View the complete record of every field and status change since the tenant was created.
Page Layout
The details page is divided into three sections: the top action bar, the form area, and the change history area.
Top Action Bar
The action buttons in the upper-right corner of the page change dynamically based on the tenant's current status, showing only the valid actions available at that moment:
| Button | When Visible | Purpose |
|---|---|---|
| Start | Tenant is "Stopped" or "Pending" and in Enabled state | Starts the tenant. Status transitions to "Starting" then to "Running". |
| Stop | Tenant is "Running", "Starting", or "Pending" | Pauses the tenant. All users are immediately unable to log in. (Recoverable.) |
| Delete | Always visible, but only clickable when "Enabled State = Disabled" | Permanently deletes the tenant and all its data. (Irreversible.) |
| Cancel | Available when the form has unsaved changes | Discards all unsaved changes and restores original values |
| Save | Available when the form has unsaved changes | Submits the current changes |
The Delete button is always visible but greyed out by default. It only becomes clickable after the tenant's "Enabled State" is switched to Disabled and saved. This is a safety gate to prevent accidental deletion of a running business tenant.
Form Area
The form area displays and allows editing of the tenant's basic information.
Field Reference
| Field | Editable | Business Meaning | When to Use |
|---|---|---|---|
| Status | Read-only | The tenant's current runtime status (Running / Stopped, etc.). Toggled via the "Start / Stop" buttons at the top. | Check when reviewing tenant runtime status |
| Enabled State | Only editable when "Stopped" | Whether the tenant is allowed to start. Toggling the switch to "Disabled" and saving prevents the tenant from being started again, and this is a prerequisite for deletion. | Must disable before permanent decommission |
| Name | Editable (not when "Pending") | The tenant's display name, 1–100 characters | Modify when a customer renames or ownership changes |
| Tenant ID | Read-only | The tenant's unique identifier. Auto-generated by the system; cannot be changed after creation. | Used to locate the tenant in the URL |
| Description | Editable | Notes on the tenant's purpose or ownership. Up to 500 characters. | Supplement or correct the tenant's description |
| Access URL | Read-only | The login URL for this tenant, composed of the platform domain + tenant ID | Deliver to the tenant's actual users after creation |
| Created At | Read-only | When this tenant was created | Reference for auditing / troubleshooting |
The Enabled State toggle can only be operated when the tenant is in the "Stopped" state — this is because a "Running" tenant must be stopped first before it can be disabled; you cannot directly disable a running business. If your goal is to disable a "Running" tenant, first click Stop, then toggle the enabled state.
Change History Area
Below the form is the Change History table, which shows every modification record for this tenant in reverse chronological order:
| Column | Description |
|---|---|
| Change Time | When this change occurred |
| Change Type | Create (green) / Update (blue), displayed as a colored label |
| Change Details | Exactly which field changed from what value to what value, formatted as "field name: old value → new value" |
| Operator | The platform operations account that performed this change |
For common table operations such as column management and pagination, see Common Data Table Operations.
Lifecycle Management
A tenant has a complete state machine, and the buttons at the top of the details page are the "manual switches" for this state machine. Understanding the state transitions is the key to using this page correctly:
Start a Tenant
Applicable scenario: The tenant is "Pending" or "Stopped" with an enabled state of "Enabled", and you need to bring it into normal operation.
Steps:
- Confirm that the Start button is visible at the top (if not, the current status does not allow starting — check the "Enabled State" first).
- Click Start. The tenant status changes to "Starting".
- After a few seconds to tens of seconds, the status automatically refreshes to "Running".
- The tenant's users can now log in and use the system normally.
The startup process involves background initialization, and "Starting" is an intermediate transitional state. You do not need to leave the page — the tenant information will refresh automatically. If it remains in "Starting" for an extended period, click Refresh in the toolbar or re-enter the details page to check.
Stop a Tenant
Applicable scenario: Temporarily take a tenant offline (e.g., customer non-payment, temporary maintenance, suspected compromise) with the possibility of resuming later.
Steps:
- Click the Stop button.
- Confirm in the confirmation dialog (which warns: "After stopping, all tenant users will be unable to log in").
- After confirmation, the tenant status changes to "Stopped". All of the tenant's users are immediately forced offline and can no longer log in.
- Stopping is recoverable — click Start on the details page later to resume.
Stop causes all of the tenant's users to be immediately unable to log in. Existing logged-in sessions are also invalidated. Before stopping, we recommend notifying the tenant's administrator so they can prepare accordingly.
Disable and Delete a Tenant
Applicable scenario: A tenant is confirmed for permanent decommission and all its data needs to be permanently erased.
Steps (irreversible — follow this exact order):
- Stop the tenant first: If the tenant is "Running" or "Starting", click Stop to transition it to "Stopped".
- Toggle Enabled State: While in the "Stopped" state, switch the Enabled State toggle to "Disabled".
- Save: Click Save to submit this enabled state change.
- Click Delete: After saving successfully, the Delete button changes from greyed-out to clickable. Click Delete and confirm in the confirmation dialog.
- After successful deletion, the page automatically redirects back to the Tenant Management list.
Delete permanently erases the tenant's: all configuration item data, user accounts, roles and permissions, collection configurations, dashboards, and all other business data. This cannot be undone. Before deleting, please confirm:
- Whether you need to export and back up the tenant's critical data.
- Whether all of the tenant's users have been notified.
- Whether the tenant is truly no longer needed.