ores.iam.tenant_type
Table of Contents
Reference data table defining valid tenant type classifications. Examples: 'organisation', 'platform', 'sandbox'.
Tenant types are managed by the system tenant and are used to categorise tenants for different purposes.
1. Flags
2. Columns
2.1. type
Unique type code.
Examples: 'organisation', 'platform'.
2.2. name
Human-readable name for the type.
std::string(faker::word::adjective()) + " Tenant"
2.3. description
Detailed description of the tenant type.
std::string(faker::lorem::sentence())
2.4. display_order
Order for UI display purposes.
faker::number::integer(1, 100)
2.5. badge_code
The badge this type is painted with.
Soft FK to ores_dq_badge_definitions_tbl.code. The badge supplies the
colours and the severity; the type's own name is the label inside the pill,
so the vocabulary a person reads is this row's and not the badge catalogue's.
The roster reads it to tell test infrastructure from real tenants at a glance.
Nullable on purpose: a type nobody has painted is written plainly rather than hidden, and a pill with no colours is worse than the value itself.
std::string{}
3. SQL
3.1. Flags
3.2. Extra drops
drop function if exists ores_iam_validate_tenant_type_fn;
4. Validation function
5. Insert trigger
5.1. Validations
| column | validation_function |
|---|---|
| change_reason_code | ores_dq_validate_change_reason_fn |
6. C++
6.1. Flags
6.2. Repository
6.3. Domain includes
#include <string>
6.4. Entity includes
#include <string>
6.5. Conventions
6.6. Table display
| column | header |
|---|---|
| type | Type |
| name | Name |
| description | Description |
| display_order | Order |
| badge_code | Badge |
| modified_by | Modified By |
| version | Version |
6.7. Presentation
6.7.1. Detail fields
| field | label | widget | type | is_key | is_required | placeholder |
|---|---|---|---|---|---|---|
| type | Type | codeEdit | line_edit | true | true | Enter tenant type code |
| name | Name | nameEdit | line_edit | true | Enter display name | |
| description | Description | descriptionEdit | text_edit | Enter a description | ||
| badge_code | Badge | badgeEdit | line_edit | Select a badge |
6.7.2. Columns
| enum_name | field | header | type | width |
|---|---|---|---|---|
| Type | type | Type | string | 120 |
| Name | name | Name | string | 200 |
| Description | description | Description | string | 300 |
| DisplayOrder | display_order | Order | int | 80 |
| Badge | badge_code | Badge | string | 120 |
| Version | version | Version | int | 80 |
| ModifiedBy | modified_by | Modified By | string | 120 |
| RecordedAt | recorded_at | Recorded At | timestamp | 150 |
6.8. Custom repository methods
7. See also
- ores.iam — component group overview.