Home
MATRIXX Architecture
MATRIXX Engine Data Model
The MATRIXX Engine data model is object based. All objects are defined in XML, making them extendable and the in-memory databases highly configurable.
Subscription Data Relationships
The MATRIXX Engine in-memory data model is object based. All objects are defined in XML, making the objects easily extendable and the in-memory databases highly configurable. The majority of the objects associated with a subscription are contained in the subscriber database for easy lookup.
Event Data
Every event that is finalized is saved to the event database as an MtxEventObject. This includes non-usage events, such as purchase events and recurring processing events, and usage events, including those that contain aggregated usage and those that do not.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
- About MATRIXX Architecture
  MATRIXX Architecture provides a high-level overview of MATRIXX core components and functionality. It also provides reference architectures for MATRIXX deployments.
- MATRIXX Introduction
  MATRIXX is a real-time, transactional system designed to more efficiently support the growing volume and complexity of services that require real-time processing.
- MATRIXX Overview
  MATRIXX core components receive network messages, perform event-transaction processing, archive data needed for engine high availability or for disaster recovery, and publish or store event-transaction data for use by other systems.
- MATRIXX Reference Architecture
  A MATRIXX reference configuration runs in Kubernetes clusters in a private or public cloud.
- Multi-Domain Deployments
  Multi-domain MATRIXX deployments allow different pricing plans, MATRIXX Data Container (MDC) definitions, and RS Gateway instances for each domain.
- MATRIXX Engine High Availability and Scalability
  MATRIXX uses features of Kubernetes and Helm to ease high availability (HA) and scalability of components.
- MATRIXX Domain Architecture
  A customer domain is a set of subscribers that co-exist with a single homogeneous pricing configuration. It provides pricing and configuration separation from other potential MATRIXX environments in their own domains, such as in multi-tenancy or testing situations. You can build a customer domain upon one or more sub-domains. The simplest MATRIXX Engine deployment is a single engine chain implementing one customer domain (one customer sub-domain).
- MATRIXX 5G Interface (SBA Gateway)
  MATRIXX SBA Gateway provides a 5G interface for a Charging Server (OCS) and converged charging service (CCS) (including authorization and authentication) and is the consumer for Nchf_ConvergedCharging and Nchf_SpendingLimitControl for spending limit reporting. It is delivered as several images.
- MATRIXX TM Forum Gateway
  MATRIXX TM Forum Gateway (TMF Gateway) is deployed in a cloud native environment and implements the set of TMF microservice APIs supported by MATRIXX.
- MATRIXX Business API Gateway
  MATRIXX Business API Gateway includes the Rest Services (RS) Gateway and Gateway Proxy that translate REST and Java communication into the MATRIXX Data Containers (MDCs) that the other MATRIXX components use to communicate. This gateway is implemented as a high availability (HA) pair for reliability.
- MATRIXX Business API SDK
  The Business API SDK is a framework that includes a set of tools to manage, customize, and extend RS Gateway for your business needs.
- MATRIXX Traffic Routing Agent
  The MATRIXX Traffic Routing Agents (TRAs) load balance and route traffic among the MATRIXX components and provide high availability (HA) protection. Depending on their function, the TRAs can also load balance traffic and serve as a Diameter peer. In addition to HA protection, TRAs also provide a single virtual IP address point of access for BSS systems and network nodes to send network traffic to.
- MATRIXX Route Cache Controller
  In a MATRIXX environment where multiple customer sub-domains are implemented, the Route Cache (a database) is required in the traffic-routing layer.
- MATRIXX SIGTRAN Network Enabler Components
  The MATRIXX SIGTRAN Network Enabler is a MATRIXX service that load balances TCAP messages across the MATRIXX Engine processing servers, which provides charging and balance control operations. In terms of RFC4666 (M3UA), each Network Enabler acts as a signaling gateway process (SGP) and the MATRIXX services on the processing servers act as application server processes (ASPs).
- MATRIXX Applications
  MATRIXX is comprised of several applications that run seamlessly on one MATRIXX Engine to provide a total solution.
- MATRIXX Event Streaming Framework
  Used in environments in which the MATRIXX Event Streaming feature is enabled, or where event loading with MATRIXX Event File (MEF) is used, the Event Streaming Framework is a gateway that connects a MATRIXX Engine cluster to external systems that consume the event streams.
- MATRIXX Engine Software Topology
  The MATRIXX Real-Time Engine software consists of a set of core software servers and one or more business modules. This is called a MATRIXX server.
- MATRIXX Engine Data Model
  The MATRIXX Engine data model is object based. All objects are defined in XML, making them extendable and the in-memory databases highly configurable.
  - MATRIXX Data Containers
    MATRIXX Data Containers (MDCs) are the fundamental data structures used by MATRIXX. They hold objects in the in-memory databases and carry messages through the system. The messages are for incoming network events, subscriber care activities, pricing updates, and any activity that must be handled transactionally.
  - Subscription Data Relationships
    The MATRIXX Engine in-memory data model is object based. All objects are defined in XML, making the objects easily extendable and the in-memory databases highly configurable. The majority of the objects associated with a subscription are contained in the subscriber database for easy lookup.
    - Balance Data
      The balance amounts from the balances and meters in subscriber and group wallets are stored in the balance set database.
    - Activity Data
      Data about all recent activities performed by a subscriber or customer care representative are stored in activity objects in the activity database.
    - Event Data
      Every event that is finalized is saved to the event database as an MtxEventObject. This includes non-usage events, such as purchase events and recurring processing events, and usage events, including those that contain aggregated usage and those that do not.
    - Pricing Data
      The MATRIXX Engine pricing data model is compatible with the Shared Information/Data (SID) standard, as defined by the TM Forum (TMF).
    - Scheduled Data
      The schedule database has subscriber-related tasks to be performed, such as scheduled catalog item cancelations, expired product offer removals, expired balance removals, and recurring processing.
    - Alert Data
      The alert database has information about Call Control Framework (CCF) operations that require prompt attention. The alerts are a backup mechanism to handle cases when the SSP fails to perform an operation based on a request sent by MATRIXX Engine, such as releasing a phone connection when the reported time allotment has expired.
- MATRIXX Engine Modules
  The MATRIXX Engine modules run on top of MATRIXX Engine and contain the business logic for MATRIXX Telco applications.
- MATRIXX Security
  MATRIXX should be deployed within a secure area of a carrier's network. Servers should have limited access points for event processing, business support systems, maintenance and monitoring, and local access.
- CAMEL Gateway
  In a MATRIXX environment in which Call Control Framework (CCF) is enabled, you can deploy multiple CAMEL Gateway servers in separate pods outside MATRIXX Engine.
- MATRIXX Traffic Routing Agent DR Features
  MATRIXX Traffic Routing Agent (TRA) provides an isolation layer between the network and the MATRIXX Engines configured as a Disaster Recovery (DR) group. It is installed on a pod located between the network and the MATRIXX Engine DR group and provides a single virtual IP address to which the network sends traffic independent of which engine is active at any given time.
- Transaction Replay
  Transactions are replayed first from all MATRIXX Engine processing pods in an engine to the active publishing pod in that engine. This creates the first redundant set of transaction events.
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Event Data

Every event that is finalized is saved to the event database as an MtxEventObject. This includes non-usage events, such as purchase events and recurring processing events, and usage events, including those that contain aggregated usage and those that do not.

The only operations that occur on the event database are insertions and deletions. After an event is saved to the event database, it is not changed. The events are stored as Event Detail Records (EDRs) and can be queried by the SubMan APIs while in memory so that the records can be viewed before they are added to a MATRIXX Event File (MEF) and published. As part of task processing, the Task Manager scans the event database at a configured interval and deletes the old events after a specified amount of time.

Service providers can enable compression for the event database, which aims to compress the memory required by each event object by a ratio of 2:1. This feature can be useful to service providers who want to keep more events in memory at a given point in time, for example, to perform queries and analysis. Although compressing the event database decreases memory requirements, it increases CPU usage because each event must be uncompressed for queries and read-and-write operations and then must be re-compressed. This extra processing step decreases performance. MATRIXX suggests testing the compression functionality on a test suite before using it in a production environment to determine whether the tradeoff is desirable. To view compression statistics, including the percentage of memory saved and the compression ratios, run the print_blade_stats.py script.

Enable event database compression by running the create_config.py script. Running this script requires you to also change several other configuration values related to event database sizing. For information about how to configure database compression, see the discussion about advanced database configuration in MATRIXX Configuration.