Tenant Profiles

Use a tenant profile to configure the unique ID for identifying a tenant across sub-domains, and to configure optional extensions to the tenant profile.

A tenant is a subset of the subscribers within the subscriber base that use the same pricing configuration and that have the same specific set of business behaviors, such as prepaid or postpaid, or the same Mobile Virtual Network Operator (MVNO).

Each tenant resides on only one domain, and they are associated with one set of MATRIXX Data Container (MDC) definitions and one pricing domain. If the tenant has:
  • A large subscriber base, the entire domain, including all its sub-domains, may be required to host all their subscribers.
  • Only a few subscribers (for example, tens or hundreds of subscribers), the tenant may share the same domain or sub-doman with multiple other tenants.
The tenant ID is included in the following objects:
  • Subscriber
  • Group
  • Device
  • User
  • Account

You can configure normalizers and decision tables for selecting tenants during rating. You can also include tenancy information when generating events and notifications.

Tenant Profile Extensions

You can create a custom tenant profile extension MDC (using MtxTenantExtension) for holding extra information about the tenant. You set the custom field values in the tenant profile. You can base normalizations on these custom fields.

Mapping Tenant Profile Fields to Events

The root event type (ID = 0) uses the MtxPrimaryEvent MDC. It is included in all events, and provides the TenantId field to all events. To add other fields from the tenant profile to events, add event field mappings to the root event type. To add a tenant profile extension field, set the source to a field from the custom MtxTenantExtension in the MtxTenantProfile MDC, and set the destination to a field in the MtxPrimaryEvent (or custom MtxPrimaryEvent) MDC.

For more information about event types and event field mapping, see the discussions about event types and event mappings.

MtxTenantProfile MDC

Creating a tenant profile populates the MtxTenantProfile MDC with the fields listed in Parameters.
Table 1. Parameters
Name Data Type Description
TenantId string A unique Id for identifing the tenant across sub-domains. You cannot change the tenant ID after it has been used.
Description string Information about the tenant profile.
Attr MtxTenantExtension Extendable structure defined by the service provider.