Table of Contents

How To Use Additional Properties for the Tenant Entity

Managing tenants often requires flexibility to store business-specific data that goes beyond the standard fields. The Additional Properties feature allows administrators to define, edit, and review custom metadata for each tenant without changing the core database structure.

This guide will walk you through how to define additional properties, manage them, and view them within the application.

1. Defining Metadata for Additional Properties

Before you can use additional properties for tenants, you must first define their metadata.

  1. Open the Settings menu from the navigation bar.
    • The menu option Additional Properties Metadata will only be accessible if you have the permission AdditionalProperties.
  2. In the Additional Properties Management screen, define the custom fields you want to make available for tenants.
    • You can specify the property name, type (e.g., text, number, date), and any validation rules.
    • Save your changes.

Once defined, these properties will become available in Tenant Management screens.

2. Creating or Editing a Tenant with Additional Properties

When creating or editing a tenant, you will notice an extra tab dedicated to these custom fields.

  1. Open the Create Tenant or Edit Tenant screen.
  2. If additional properties have been defined, an Additional Properties tab will appear.
  3. Select this tab to fill in values for the custom fields.
    • You can update values at any time by editing the tenant.
Note

If no additional properties are defined, this tab will remain hidden.

3. Viewing Additional Properties

Administrators and users with the appropriate access can also view additional properties in a read-only format.

  1. Open the Tenant List from the main navigation.
  2. Select a tenant to view details.
  3. If additional properties have been defined, an Additional Properties tab will be visible.
    • This tab displays all custom fields and their values in read-only mode.
Note

If no properties are defined, the tab will not appear.

Summary

The Additional Properties feature adds flexibility to the Tenant entity by allowing administrators to:

  • Define custom metadata in a dedicated management screen under Settings (requires AdditionalProperties permission).
  • Capture extra details during tenant creation and editing via the Additional Properties tab.
  • Review stored values in read-only mode from the tenant list.

This approach ensures that tenant data can be extended dynamically without modifying the underlying database model.