Welcome to the MATRIXX Software documentation, where you can find information about how to install, configure, and maintain a MATRIXX Digital Commerce environment. The following information describes how to provide documentation feedback, how to use and navigate through the MATRIXX documentation.

Release Notes provides information about new features, resolved issues, data changes, configuration changes, interface changes, upgrade paths, third-party software requirements, and known issues in MATRIXX Digital Commerce.

The following information applies to release version 5257 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration or MATRIXX Cloud Native Installation and Upgrade.

The following information applies to release version 5256.01 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and ConfigurationMATRIXX Cloud Native Installation and Upgrade.

The following information applies to release version 5256 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration or MATRIXX Cloud Native Installation and Upgrade.

The following information applies to release version 5255 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration.

The following information applies to release version 5254 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration.

The following information applies to release version 5253 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration.

The following information applies to release version 5252 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration.

The following information applies to release version 5251 of MATRIXX Digital Commerce. For a list of hardware and software requirements, see Installation and Configuration.

The following information applies to release version 5250 of the MATRIXX Digital Commerce software. For a list of hardware and software requirements, see Installation and Configuration.

Documentation for MATRIXX Digital Commerce is available online and in PDF format.

Architecture Overview provides information about the MATRIXX Digital Commerce™ functionality.

MATRIXX Digital Commerce is a real-time, transactional system designed to more efficiently support the growing volume and complexity of services that require real-time processing.

MATRIXX Digital Commerce core components receive network messages, perform event-transaction processing, archive data needed for engine high-availability or disaster-recovery purposes, and publish or store event-transaction data for use by other systems.

MATRIXX Digital Commerce is designed for deployment in public, private, or hybrid clouds as an alternative to on-premise (bare metal) hardware deployment.

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 Digital Commerce 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 Digital Commerce 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 Docker images.

MATRIXX TMF Gateway is deployed in a cloud native environment and implements the set of TMF microservice APIs supported by MATRIXX Digital Commerce.

MATRIXX Digital Commerce Business API Gateway includes the Rest Services (RS) Gateway and Gateway Proxy that translate REST and Java communication into the MDCs that the other MATRIXX components use to communicate. This gateway is implemented as a high-availability (HA) pair for reliability.

The MATRIXX Digital Commerce Traffic Routing Agents (TRAs) load-balance and route traffic among the MATRIXX Digital Commerce 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.

In a MATRIXX environment where multiple customer sub-domains are implemented, the Route Cache (a database) is required in the traffic-routing layer.

The MATRIXX Digital Commerce 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 Digital Commerce is comprised of several applications that run seamlessly on one MATRIXX Engine to provide a total solution.

The Business API SDK is a framework that includes a set of tools to manage, customize and extend RS Gateway for your business needs.

Used in environments in which the MATRIXX Event Streaming feature is enabled, or where event loading with MATRIXX Event Files (MEF) is used, the Event Streaming Framework is a gateway that connects a MATRIXX Engine cluster to external systems that consume the event streams.

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.

The MATRIXX Engine data model is object based. All objects are defined in XML, making them easily extendable and the in-memory databases highly configurable.

The MATRIXX Engine modules run on top of the MATRIXX Engine and contain the business logic for MATRIXX Telco applications.

MATRIXX Digital Commerce 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.

MATRIXX uses a combination of industry standard clustering techniques as well as a proprietary technique to achieve both high availability and high scalability within the MATRIXX Engine.

MATRIXX Digital Commerce is designed to handle a range of possible disasters, including natural, technical, and human hazards. No decision making is required during a disaster because the active engine is configured to automatically fail over to a standby engine that has the same built-in reliability and almost identical transaction data.

MATRIXX Cloud Native Architecture describes private cloud (provider-agnostic) and public cloud (Amazon EKS) reference architectures for MATRIXX Digital Commerce cloud native deployments.

A MATRIXX Digital Commerce reference configuration runs in Kubernetes clusters in a private or public cloud.

MATRIXX Digital Commerce Kubernetes pods can run on different nodes when restored after failure. For data to persist across the deployment, create and mount shared storage as needed.

Bare metal Kubernetes nodes can be connected on multiple networks: the management network plane, an NFS network, or a dedicated transaction protocol network for the processing pods in engine 1.

Use Kubernetes namespaces to install MATRIXX Digital Commerce in multiple sub-domains.

Multi-domain MATRIXX Digital Commerce deployments allow different pricing plans, MDC definitions, and RS Gateway instances for each domain.

MATRIXX Cloud Native Installation and Upgrade describes the tasks required to install MATRIXX Digital Commerce components as containers using Kubernetes and Helm.

The MATRIXX Digital Commerce software for cloud native deployments is delivered in Docker images. The Helm chart and base configuration files are delivered in TAR archives.

A containerized MATRIXX Digital Commerce deployment consists of containers installed with the MATRIXX Helm chart in a multi-node Kubernetes cluster, requiring MATRIXX Digital Commerce Docker images and MATRIXX Engine custom resource definitions and controllers.

Obtain the Docker images, Helm chart, and utility scripts from MATRIXX, and host the Docker images in an image repository so that they can be retrieved and instantiated as containers by Kubernetes.

Helm provides a mechanism for deploying Kubernetes manifest files in a controlled manner, and facilitates application upgrade, scaling, and where necessary, rollback. To use the MATRIXX Helm chart, install the Helm software, create a chart repository, and load the MATRIXX Helm chart and sub-charts into your repository.

Service accounts are created by default by the MATRIXX Helm Chart (assuming the associated components have been enabled). These service accounts are required as the related components interact with the Kubernetes API.

The user account that deploys MATRIXX Digital Commerce has specific Helm role requirements.

Once you have installed Helm and configured a private chart repository containing the MATRIXX charts, use Helm to install MATRIXX Digital Commerce in the Kubernetes cluster.

Installing MATRIXX Digital Commerce across multiple Kubernetes namespaces allows sub-groups of components to be upgraded without affecting the operation of other components.

When adding or removing domains, identify (or remove) the domain ID in the topology section of your values.yaml file(s), and redeploy the common SBA Gateway CHF (for inbound traffic) and Traffic Routing Agent (TRA-RT/DR) instances for the deployment.

Three different methods of MATRIXX Engine management are available: Engine Controller, Engine Operator (default) and Topology Operator.

Configure MATRIXX Digital Commerce by adding values for properties from the MATRIXX Helm chart to the values.yaml file. The MATRIXX Helm chart includes component sub-charts in a hierarchy of reusable components.

The Topology Operator method of MATRIXX Engine pod management utilizes multiple custom resources (CRs) and operator pods working together to manage the installation and upgrade of multiple subdomains and engines across Kubernetes clusters, including the loading of pricing and taxation data.

MATRIXX Digital Commerce is delivered as multiple Docker images that can be deployed in different configurations.

Use Helm and Kubernetes to manually add or remove pods as necessary. You can also use Kubernetes to manage resources available to MATRIXX Engine pods.

For Call Control Framework (CCF), only the deployment of Network Enablers (NEs) in a Kubernetes cluster is different from a standard deployment.

An SSH key, used for password-less SSH login, is required to enable MATRIXX Event File (MEF) publishing in Kubernetes. A secret holds the SSH private key, and the key is specified in Helm values. The SSH key allows administrators to write to a target directory in a secure manner without having to enter a passphrase.

Cloud-native MATRIXX Digital Commerce deployments support MongoDB as an event store using the MongoDB Enterprise Operator for Kubernetes.

The Event Streaming Framework provides a connector for sending event stream data to Apache Kafka. Using 5G event streaming also requires Apache Kafka, which is not provided with MATRIXX Digital Commerce. You can use a Helm chart to install and configure Apache Kafka.

A Kubernetes Ingress exposes HTTP and HTTPS routes from outside the cluster to services within the cluster.

The MATRIXX Engine controller and MATRIXX Engine manager pods create, configure, and start the MATRIXX Engine(s) in a deployment.

You can obtain version and build information for MATRIXX Engine, while running, with Kubernetes commands.

Upgrading cloud native MATRIXX Digital Commerce has several stages.

Migrating from a bare metal MATRIXX Digital Commerce deployment to a cloud native deployment (from the same MATRIXX Digital Commerce version) requires temporarily using a hybrid platform made up of components from both deployments. This hybrid environment allows migration to the cloud native deployment without disruption of services.

Use the helm uninstall command to uninstall MATRIXX Engine components installed from the Helm chart.

MATRIXX Cloud Native Integration describes the tools and tasks for integrating MATRIXX Digital Commerce functionality in a cloud native environment.

MATRIXX Digital Commerce includes images that contain utilities to aid in the deployment, operation, and configuration of cloud native MATRIXX installations. You can run these utilities directly or scheduled as cron jobs using the MATRIXX Helm chart.

The MATRIXX Data Export image (data-export) contains the data-export.jar utility. This utility uses checkpoint files to transform database contents and MATRIXX Event Files (MEFs) to comma-separated value (CSV) files. This image also creates SQL files for creating RDBMS tables and loading the data from the CSV files.

The MATRIXX Toolbox image has scripts and utilities to aid in the deployment and operation of cloud native MATRIXX Digital Commerce installations.

The MATRIXX Misc image includes utilities and files to aid in the deployment and operation of MATRIXX Digital Commerce installations for Docker and Kubernetes.

MATRIXX Cloud Native Monitoring and Logging describes monitoring and logging for MATRIXX Digital Commerce components in a cloud native environment.

Use aggregated logging and the Prometheus and Grafana third-party products to monitor a cloud native MATRIXX Digital Commerce environment.

Diameter Event Logger listens to the Diameter Gateway through a TCP connection and logs diameter application messages to a JSON file.

The MATRIXX SBA Gateway SNMP statistics are defined in the matrixx_web_mib.txt file, using the snmp-net-utils snmpwalk command to display them.

MATRIXX Cloud Native Web App Administration describes the tasks required to install and administer MATRIXX Digital Commerce web apps as containers, using Docker and Kubernetes.

MATRIXX Digital Commerce includes the following MATRIXX Web apps:

In a cloud native MATRIXX Digital Commerce deployment, MATRIXX gateways and web apps can be configured in three ways.

This section has information to help identify and resolve web app issues.

MATRIXX Cloud Native Event Streaming describes the tasks required to create custom event streams for events received by your cloud native MATRIXX Digital Commerce environment. An event stream is sent to the Event Streaming Framework from the Event Stream Server running on MATRIXX Engine. The Event Stream Server provides the APIs, libraries, and other files needed to create custom event streams. The Event Streaming Framework provides connectors for sending event stream data to event stream platforms, such as Kafka and ActiveMQ.

Use event streaming to integrate downstream message systems with MATRIXX Digital Commerce. These message systems should be fully optimized to filter, transform, and deliver events to multiple secondary targets.

Use these steps as a summary of tasks required to implement event streaming in a MATRIXX Digital Commerce environment.

An Event Streaming Framework connector is required to stream events. The supported connectors are listed in this section. For information about setting the log level for individual connectors, see the discussion about managing Event Streaming Framework logging.

The Event Stream Server and Event Streaming Framework require administration tasks. The Event Streaming Framework administration tasks includes manually recovering events from streamed event files.

MATRIXX TM Forum Integration describes the tasks required for integrating TM Forum (TMF) APIs with MATRIXX Digital Commerce and provides overviews, recommendations, and conceptual discussions to help you understand these tasks.

MATRIXX TM Forum Open API Gateway (TMF Gateway) implements the set of TMF microservice APIs supported by MATRIXX Digital Commerce.

Install the TMF Party Management microservice in a cloud native environment.

TMF Gateway supports HTTP authentication through a configurable authorization URL.

The TMF party management API supported by MATRIXX Digital Commerce provides a standardized mechanism for party management for creating, updating, retrieving, and deleting individual and organization information.

TMt Forum (TMF) microservices map TMF API data to custom _glossary/mdc.html extensions, where each custom field has the exact same name and field type as the TMF API field that maps to it.

Implementing MATRIXX in a Cloud provides the tasks required to install and configure MATRIXX Digital Commerce in a cloud environment. This guide augments Installation and Configuration.

The differences between MATRIXX Digital Commerce on bare metal and on a sole-tenant Google Cloud Platform (GCP) include Google load balancers, a MATRIXX _glossary/tra-proc.html setting, and only one MATRIXX Engine publishing server. The MATRIXX on GCP network diagram provided here helps you understand the required networking components.

Installation and Configuration provides information about the requirements and steps needed to install and configure the MATRIXX Digital Commerce software suite.

MATRIXX Digital Commerce

The servers running the MATRIXX Digital Commerce software must meet specific hardware, software, operating system, and network requirements. In addition, certain third-party applications must be installed to run the MATRIXX Engine and measures must be taken to ensure the system is secure.

The MATRIXX Digital Commerce software is delivered in RPM Package Manager (RPM) files.

For production systems, the software must be installed on multiple blade servers that together form MATRIXX Engine. An environment can contain multiple engines for high availability. Installation prerequisites and instructions for installing the MATRIXX Engine software are provided below.

Install and set up the MATRIXX gateways and web apps, including a secure communications channel to MATRIXX Engine. A production system can include more than one installation of the gateways and Web apps to facilitate high availability (HA).

Topics below provide information about how to install the Traffic Routing Agent (TRA) software.

The number of Network Enablers you deploy depends on the number of engines or engine chains (if multiple customer sub-domains are implemented) in your MATRIXX environment. Network Enablers are deployed as active-active clusters and are used for routing SIGTRAN based traffic.

The Notification Server delivers notification messages to configured delivery channels and returns the notification message text and delivery ID to the Charging Server. Read on to learn how to install and set up the Notification Server.

MATRIXX Digital Commerce platform uses SBA Gateway to implement 5G network functions (NFs) and to enable 5G applications to communicate with MATRIXX. SBA Gateway requires a Kubernetes cluster. Some bare-metal deployments choose a gradual transition to 5G by installing integrating SBA Gateway with the existing bare-metal MATRIXX Digital Commerce deployment. To do this, SBA Gateway can be installed as its own Helm release, in its own namespace.

Consider the following before installing Diameter Event Logger.

You can customize the installation of MATRIXX Engine for a system that has not yet been deployed. Setup tasks include setting up business rules for MATRIXX Charging Application, MATRIXX Policy Application, and Call Control Framework (CCF). For information about changing the configuration of a running engine, see the discussion about changing the configuration of an engine.

You must configure traffic routing for a new installation of MATRIXX Digital Commerce using the Traffic Routing Agent (TRA) servers. All TRA servers should be configured as clusters (HA pairs) to provide failover capabilities.

The Gateway Proxy service facilitates communication with MATRIXX Engine and is installed with default logging behavior, connection, and security information that you can configure for your environment. You must also configure the Linux Firewall with an allow list for accessing a MATRIXX Engine.

Configuring RS Gateway includes configuring the gateway to communicate with Gateway Proxy, configuring RS Gateway security, and configuring RS Gateway to connect to the Event Repository.

MATRIXX Engine supports high availability for the Notification Framework.

To enable notification messaging, you must configure the notification-specific global configuration questions during engine configuration, configure ActiveMQ, and configure the MATRIXX Notification Server. All components are required for publishing notifications to third-party systems. If you do not configure a JMS server address, notifications are published to MATRIXX Event Files (MEFs).

In a MATRIXX Digital Commerce environment where multiple customer sub-domains are implemented in separate engine chains, you configure sub-domain routing so that traffic is directed to the correct customer sub-domain where the subscriber is homed. You must configure different components across MATRIXX Digital Commerce for sub-domain routing to work.

Call Control Framework (CCF), which provides the communication services between Intelligent Networks and a MATRIXX Engine, is installed with default connection information that you can configure for your environment.

MATRIXX Network Enabler must be configured as an HA pair to have failover capabilities.

The MATRIXX Engine can import and rate Solution42® call detail records (CDRs) and generate MATRIXX Event Detail Records (EDRs) from them. Generally, this is used only when integrating with an Oracle BRM system. Other projects should use external mediation to convert external CDRs into Diameter messages for MATRIXX processing.

You can easily extend MATRIXX Engine functionality to capture new subscriber-related data and then use the extended fields as a basis for pricing, rating, and policy decisions. You can also add new Diameter AVPs to capture information from the network and base rating and post-rating operations on this data.

If necessary, you can follow these instructions to uninstall the MATRIXX Engine software. This process will uninstall the following components: MATRIXX gateways and web apps, Traffic Routing Agent, Network Enabler, My MATRIXX, and their related files. For information about uninstalling the MATRIXX Web apps, see MATRIXX Web App Administration.

MATRIXX Digital Commerce Upgrade describes how to upgrade the MATRIXX Digital Commerce software to version 5250. During this process, you upgrade these important MATRIXX Digital Commerce components: MATRIXX Engines in multiple sub-domains, Traffic Routing Agent, Network Enabler, and MATRIXX gateways and web apps, including RS Gateway and My MATRIXX.

Upgrading MATRIXX Digital Commerce has several stages.

Perform the following tasks before upgrading MATRIXX Digital Commerce.

You can use the following procedures to upgrade your pricing plan from an older version of My MATRIXX to the latest version.

To upgrade MATRIXX Digital Commerce you first need to upgrade and configure each of the MATRIXX gateways and web apps. During the upgrade process, the upgraded services that communicate with the MATRIXX Engines are pinned to the schema version you are upgrading from. After the services and their sub-domains have been upgraded, you reconfigure the MATRIXX gateways and web apps to use the new schema version by unpinning them from the earlier version.

You can follow the procedure below to upgrade an engine chain for a single sub-domain to the latest version of MATRIXX Digital Commerce.

Follow this procedure to install the Traffic Routing Agent (TRA) software for TRA servers configured as a TRA-RT-(SI/DR) disaster-recovery and sub-domain routing agent HA Pair. If your MATRIXX implementation uses the MATRIXX Network Enabler, use the instructions in the discussion about upgrading the Network Enabler in related links instead of this upgrade task.

After upgrading all subdomain chains and TRA-RT-(SI/DR) remove the schema version pinning in all of the MATRIXX Gateways and Web apps. See the steps for unpinning at the end of the procedures in the related links.

Upgrading the service provider schema involves a subset of the steps to perform a full MATRIXX Digital Commerce upgrade.

The tasks below are not mandatory and do not apply to all MATRIXX Digital Commerce implementations.

The information in MATRIXX Security is best-practice information and identifies MATRIXX-specific security considerations and implementations. For container-specific and Kubernetes security information, see the third-party documentation.

The examples in MATRIXX Security show how to use different types of certificates.

TLS /SSL provides secure internet connections by encrypting data sent between a browser, a website, and the website server to ensure that data is transmitted privately.

Operating system security includes firewall allow lists for communication between multiple entities.

Network zones are stacked with increasing proximity to the "open internet" or DMZ. Each zone is traversed by ingress and egress points through an application or server, with appropriate authentication and authorization for connecting system traffic.

Application security includes configuring Web applications and gateways.

The information here addresses cloud native security and includes recommendations for securing your cloud native implementation.

MATRIXX Digital Commerce supports third-party identity and access management application integration.

This information is related to the Event Repository.

MATRIXX Engine Administration describes how to monitor MATRIXX Engine components and to perform daily operations for maintaining a geographically redundant system. This includes administration for the engine, Traffic Routing Agent, MATRIXX gateways and web apps, and Notification Framework. It also provides information about recovering from a total system failure.

The topics in this section provide information about maintaining, managing, and resolving problems with a MATRIXX Engine installation.

The topics in this section describe how to perform runtime operations for MATRIXX gateways and web apps, such as restarting the Gateway Proxy, viewing the firewall logs, and restarting Web apps.

The topics in this section have information about administering Notification Framework components.

The topics in this section describe administering Traffic Routing Agent (TRA) servers, including starting and stopping Traffic Routing Agent nodes and clusters. The information in this section applies to all Traffic Routing Agent functions unless otherwise noted.

The topics in this section describe administering the Route Cache.

U.S. tax data is imported from CCH tax data, compiled in My MATRIXX, and output as compact MATRIXX Data Container (MDC) files, including an MDC file containing tax database metadata and status information. MDC files are packaged into a .zip file and loaded into the MATRIXX tax database. The data is then processed and loaded into MATRIXX Engine using the load_tax.py script.

This section has information to help identify and resolve system problems.

MATRIXX Web App Administration describes installation and configuration requirements and procedures for the MATRIXX web apps.

MATRIXX Digital Commerce includes the following MATRIXX Web apps:

You use the commands listed in this section to start, stop, and restart the MATRIXX web apps. You use the MATRIXX Digital Commerce system logs and SNMP statistics and notifications to monitor the MATRIXX Digital Commerce web-facing applications.

My MATRIXX can be deployed on the same server as other Web apps or on a remote server that communicates with MATRIXX Engine through Gateway Proxy and RS Gateway.

MATRIXX Backoffice Customer Tool can be deployed on the local host or a remote system that communicates with MATRIXX Engine through Gateway Proxy and RS Gateway.

This section has information to help identify and resolve web app issues.

MATRIXX Engine Integration provides information about the MATRIXX Engine notification functionality, MATRIXX Event File (MEF) publication, Subscriber database SQL mapping, and importing and exporting pricing data.

The /opt/mtx/data/mdc_config_system.xml file contains all system MDC definitions, subtypes definitions, and relationship definitions.

MATRIXX Engine generates an Event Detail Record (EDR) for all activities that can trigger rating, such as usage, catalog item purchases and cancellations, recurring cycle processing, or the first use of a balance. MATRIXX Engine also generates EDRs for non-rated events such as forfeitures. You configure event generation in My MATRIXX, including the events to generate and whether to add a custom container with additional mapped fields.

MATRIXX Event Files (MEFs) contain a list of usage and non-usage event types generated during transaction processing. MEFs are meant to be published to, and consumed outside of, MATRIXX Digital Commerce, and can be input to third-party applications.

MATRIXX Digital Commerce generates GL information for accounts that you specify during rating. It then captures that information in MATRIXX Event Files (MEFs) and stores it in event objects in the MATRIXX Event Repository. You then use the MATRIXX GL utilities to process the GL information and generate daily GL summary records. That GL data is then available to post to a third-party GL or Enterprise Resource Planning (ERP) system.

This section provides an overview of subscriber data relationships.

A MATRIXX Engine can optionally load EDRs (Event Detail Records) into the MATRIXX Event Repository, a database separate from the MATRIXX Engine platform that serves as a long-term event storage repository. The Event Repository is an optional component separate from MATRIXX Engine that is implemented in MongoDB (you must purchase and install MongoDB).

This section describes how the MATRIXX Engine publishes notifications to a JMS message broker and how you can customize the information included in notifications.

The Business API Gateway is a development framework that includes the Business API SDK, Rest Services Gateway (RS Gateway), Gateway Proxy, and application tier. It allows custom mobile applications, Web clients, and other custom implementations to integrate with MATRIXX Digital Commerce.

The MATRIXX Network Protocol Gateway communicates with "northside" (mobile) network traffic protocols. You use Network Protocol Gateway as an entry point to communicate with network nodes, and you can rate and bill for services from those protocols. Currently, Network Protocol Gateway processes and bills for SMPP traffic by using the MATRIXX SMPP Adapter.

Call Control Framework Integration provides information about MATRIXX Call Control Framework support and configuration.

MATRIXX Digital Commerce includes an integrated GSM Service Control Function to support call control capabilities for telephony services.

Call Control Framework (CCF) can allocate incoming requests to any processing blade within a customer sub-domain.

MATRIXX Call Control Framework (CCF) provides support for message sequences using the Camel Application Part (CAP) protocol.

This chapter describes how to configure MATRIXX Network Enabler.

CAMEL Gateway is a CAMEL Application Part (CAP) server. Configure CAMEL Gateway to allow communication between MATRIXX Engine and Network Enablers through the CAP protocols.

Configuring routing preferences allows you to define how routes are prioritzed between CAMEL Gateway on each engine and Network Enablers (NEs).

Call Control Framework (CCF) supports configurable correlation ID lengths. CCF handles 10 digit correlation ID lengths by default.

Call Control Framework (CCF) provides support for processing roaming voice calls that use the CAP1 protocol.

Call Control Framework (CCF) provides support for processing and applying charging for voice calls that use the CS1 INAP protocol.

You can configure Call Control Framework (CCF) to send FCI operations at specific points during call handling. CCF sends FCI operations to instruct the Mobile Switching Center (MSC), or service switching point (SSF), to add charging information to the call data record (CDR) for a call.

When handling a mobile terminating (MT) call, Call Control Framework (CCF) can forward the call to another number if the call is not answered, or the called number is busy.

Call Control Framework (CCF) can handover (relay) incoming TCAP requests for subscribers that MATRIXX cannot find in its subscriber database to another platform for processing. For example, when migrating to the MATRIXX platform, CCF can relay incoming TCAP requests to the incumbent platform for subscribers that have not yet been migrated across. After handover, the incumbent platform processes the TCAP request without any further involvement with MATRIXX..

MATRIXX Call Control Framework (CCF) provides support for playing pre-call announcements. The following topics describe CCF pre-call announcement functionality and explain how to configure CCF to play announcements.

MATRIXX Call Control Framework (CCF) supports making Mobile Application Part (MAP) Unstructured Supplementary Service Data (USSD) call out requests to deliver USSD notifications to a subscriber. CCF also supports USSD services for queries, call back, and interactive menus using MAP-Process-UnstructuredSS-Request messages, and MAP-UnstructuredSS-Request messages.

Call Control Framework (CCF) provides support for menu driven announcements using IVRs and interactive USSD service menus that provide subscribers with options for retrieving and updating their balances and account details.

You can configure Apache FreeMarker templates for handling Call Control Framework (CCF) services such as Unstructured Supplementary Service Data (USSD) query and call back services, and menu services using announcements or interactive USSD menus.

MATRIXX Call Control Framework (CCF) provides support within the MATRIXX Charging Server for making MAP call out requests to an external platform in response to TCAP or Diameter messages that require them.

You can extend the data used in Mobile Application Part (MAP) call out requests and results to include customized private extension data in the extensionContainer parameter in MAP ATI (AnyTimeInterrogation) and MAP SRI (SendRoutingInfo) operations. This feature enables you to perform additional manipulation on the data that is sent and returned in MAP call outs, for example, to correct the digits dialed by a user when roaming.

MATRIXX Call Control Framework (CCF) provides support for making Lightweight Directory Access Protocol (LDAP) call out requests to an LDAP server in response to TCAP or Diameter messages that require them.

Call Control Framework (CCF) holds response data for Mobile Application Part (MAP) call outs and Lightweight Directory Access Protocol (LDAP) call outs for a call or a session in _glossary/mdc.html format.

MATRIXX Diameter Integration provides information about the MATRIXX Engine Diameter support and configuration.

The Diameter Gateway is a Diameter server that allows communication between the _glossary/matrixx_engine.html and a network entity requesting service through the Diameter protocol.

The External Diameter Gateway is a cloud native Diameter gateway that enables communication for the Rf and Gz Diameter interfaces. It runs as a stateless pod and converts Diameter protocol messages to MDCs that are sent to MATRIXX Engine.

MATRIXX 5G Integration provides an architectural overview of how to integrate your 5G core network with the MATRIXX Digital Commerce platform. This guide also provides descriptions for the Service-Based Architecture (SBA) Gateway and messaging. In addition, this document provides information about security configuration (secured and not secured).

Service Based Architecture (SBA) Gateway provides the framework to build 5G network function (NF) services based on 3GPP technical specifications. SBA Gateway converts incoming 5G JSON messages to and from MATRIXX Data Containers (MDCs) and forwards these requests to the Traffic Routing Agent (TRA), which routes them to the correct sub-domain on MATRIXX Engine.

SBA Gateway requires a Kubernetes cluster. Some bare-metal deployments choose a gradual transition to 5G by integrating SBA Gateway with the existing bare-metal MATRIXX Digital Commerce deployment. To do this, SBA Gateway can be installed as its own Helm release, in its own namespace.

When upgrading to a new version of SBA Gateway, there are several things you must consider to ensure the upgrade is successful and the correct configuration is applied.

You can use version, revision, and timestamp data to check which version of SBA Gateway is running.

SBA Gateway is configured as 5G network functions in serveral ways.

SBA Gateway can stream HTTP requests and MATRIXX Engine HTTP responses to a Kafka broker. The 5G event streaming applications convert the received JSON objects to the ASN.1 binary format for export to Kafka applications, and can optionally aggregate and route based on content.

You administer the SBA Gateway by configuring its logging and monitoring features. For more information about monitoring SBA Gateway administration tasks, see the discussions about monitoring SBA Gateway and configuring the SNMP Prometheus adapter in MATRIXX Monitoring and Logging.

The following documentation provides information about how to create a mapping configuration. For a list of MATRIXX-supported 5G messages mappings from MDC to OpenAPI, see the discussion about MATRIXX 5G message mapping.

SBA Gateway supports HTTP BASIC authentication and TLS Mutual Authentication.

The URI, mapping, and OpenAPI specification are configurable, and only the HTTP method and mapping filename are not.

SBA Gateway can be throttled to protect the platform from overload conditions.

MATRIXX Monitoring and Logging provides the tasks required to monitor the various MATRIXX Digital Commerce components. It identifies where information is logged and provides recommendations on what you should monitor regularly.

Follow the procedures in this section to change the default rsyslog behavior and the log level for a MATRIXX Digital Commerce business application or component.

You can set trace counters on multiple objects and all results are logged to mtx_debug.log.

Business API Gateway SNMP statistics are defined in the matrixx_web_mib.txt file and you display them using the snmp-net-utils snmpwalk command.

The topics in this section provide information about monitoring Call Control Framework (CCF) components, including Network Enabler and CAMEL Gateway.

Diameter Event Logger listens to the Diameter Gateway through a TCP connection and logs diameter application messages to a JSON file.

Use SNMP to monitor a MATRIXX Digital Commerce environment to confirm that the MATRIXX Engines are functioning properly in an active-standby HA configuration and that during an engine failover, the switch-over operation is working as designed. MATRIXX Digital Commerce also offers statistics for other components that indicate those components are running correctly, and assist in diagnosing problems.

Enable and configure the Event Loader purge task for an Event Repository by answering the event purge expired events-related questions when running the create_config.py script.

Event streaming errors are logged in the Event Streaming Framework mtx_event_streamer.log file. Event Streaming Framework uses Log4j 2.x to log error, debugging, and informational messages

Monitor the Route Cache by reading watermark log messages for each Route Cache table, and Route Cache SNMP statistics. The SNMP statistics are defined in the matrixx_rc_mib.txt MIB file and returned by the print_snmp_stats.py script. They include statistics on subscriber and session data, statistics on insert, fetch, erase, and iterator operations, general statistics on subscriber records, and garbage collection.

Payment service logs messages to the payment-service.log.

By default, the SNMP Agent running on a MATRIXX Engine monitors the status and health of all the servers and clusters it has. It collects statistics to aid in identifying potential processing issues.

Traffic Routing Agent SNMP statistics are defined in the matrixx_tra_mib.txt MIB file and are returned by the print_snmp_stats.py script when run on any of the Traffic Routing Agent servers. They include categories such as TCP traffic, UDP traffic, Diameter Gateway traffic, and MDC Gateway traffic.

Use the MATRIXX Digital Commerce system logs and SNMP statistics and notifications to monitor the MATRIXX Digital Commerce Web-facing applications, such as RS Gateway, Gateway Proxy, and My MATRIXX.

MATRIXX Kafka CDR Consumer provides information about how to install, configure, and extend Kafka CDR Consumer and its out-of-the-box extensions.

Kafka CDR Consumer is a cloud native Apache Kafka Consumer microservice that consumes charging data records (CDRs) that are injected into Kafka topics by external systems or from MATRIXX CDRs that generate the events. The offline Kafka CDR Consumer retrieves the events from the Kafka topics and injects them intoMATRIXX Engine for usage rating and charging.

Deploying Kafka CDR Consumer and extensions involves installing and configuring the Kafka CDR Consumer and extension Helm charts. This chapter explains how to install and modify the Helm charts and the properties you configure. For information about the Helm properties, see the discussions about Kafka CDR Consumer properties and each extension.

The TAP3 JSON Kafka CDR Consumer is an out-of-the-box extension that consumes JSON-mapped TAP3 messages from Apache Kafka topics and maps them to MtxDiamRoMsg messages for MATRIXX Engine rating.

The Diameter CDR Kafka CDR Consumer is an out-of-the-box extension that consumes plain MtxDiamRoMsg protocol buffer binary files and maps them to MtxDiamRoMsg charging messages for MATRIXX Engine rating.

The Diameter CDR Kafka CDR Consumer is an out-of-the-box extension that consumes plain Mtx5GMsg compact MDCs (CMDCs) and maps them to Mtx5GMsg charging messages for MATRIXX Engine rating.

You can create your own custom Kafka CDR Consumer extensions for charging implementations that are not covered by out-of-the-box extensions delivered with the Kafka CDR Consumer.

Pricing and Rating provides an introduction to MATRIXX pricing and rating functionality and describes how to define the catalog components necessary for rating and policy selection. It also provides an overview of the MATRIXX rating process and an introduction to My MATRIXX, a Web-based user interface application you use to create and manage product catalogs.

MATRIXX Charging Application can perform both online and offline rating in support of next-generation networks and legacy systems. It can also handle hybrid sets of convergent, prepaid, and postpaid services, enabling service providers to have a diverse subscriber base.

The MATRIXX pricing model is highly flexible and enables you to create innovative service offerings and tailor pricing to subscriber needs. It is compatible with the Telemanagement Forum Shared Information/Data (SID) model.

Deploying a pricing plan involves compiling the pricing plan into a configuration file and loading the configuration file into the pricing database. During compilation, the pricing schema is validated and any errors that occur are displayed.

MATRIXX Pay Now describes the tasks required to configure MATRIXX Pay Now and the MATRIXX Payment Service that enables Pay Now and provides overviews, recommendations, and conceptual discussions to help you understand these tasks.

MATRIXX Pay Now enables the Charging Server to request immediate payment for product offer and bundle purchases, postpaid balance payments, and prepaid balance recharges from a Payment Gateway Provider. Subscribers can make quick and secure purchases using payment methods such as credit and debit cards.

System administrators must configure the Payment Service to enable communication between Apache ActiveMQ, a MATRIXX Engine, and the Payment Service. In addition, they must configure the Payment Service third-party Payment Gateway Provider properties file location.

This procedure describes how to run the Payment Service as a service.

Each Payment Gateway Adapter can support multiple features, operations, and payment methods.

Each client that communicates with the Payment Service will have different requirements based on the payment gateways which it supports. Client developers should contact MATRIXX support for information specific to their client implementation.

MATRIXX Policy describes the tasks that must be completed to configure MATRIXX Policy Application functionality and provides overviews, recommendations, and conceptual discussions to help you understand these tasks. In addition, it describes the supported Diameter policy AVPs and MATRIXX Policy Application SubMan APIs.

The 5G MATRIXX Policy Application provides the business logic and integration into a third-party policy control function (PCF) to support real-time policy decisions and rules. It enables your PCF to deliver flexible policy and charging control rules to your 5G network.

The 3G/4G MATRIXX Policy Application runs on top of the Application module and provides the business logic to support real-time policy decisions and rules. It allows charging and network quality of service (QoS) to be flexibly and dynamically linked to customer, service, and network parameters.

Policy configuration in My MATRIXX includes both session management and spending limit configuration.

The SubMan APIs include session query, session validation, and session delete APIs for charging and policy sessions.

The Sy policy counter APIs include MtxRequestDeviceEvaluatePolicyCounterSet and MtxRequestDeviceQuerySession.

A MATRIXX Policy failover can be due to a hard failure or can be planned.

During policy profile selection, product offers are evaluated in descending order from highest to lowest priority and policy profiles collected for Sy and N28 policy counters, Gx command-level QoS, and N40 TIME_LIMIT and VOLUME_LIMIT usage triggers.

You can configure a product offer so that policy components are only applied when quota is authorized. In this case, the SNR/Nchf_SpendingLimitControl_Notify message is sent when an offer is used to make the reservation and is not based on balance amounts reserved or consumed by a reservation. This process differs from the process described in the discussion about spending limit policy sessions.

MATRIXX Engine supports the Sy and Gx interfaces for policy control.

MATRIXX Event Streaming describes the tasks required to create custom event streams for events received by your MATRIXX Digital Commerce environment.

Use event streaming to integrate downstream message systems with MATRIXX Digital Commerce. These message systems should be fully optimized to filter, transform, and deliver events to multiple secondary targets.

Use these steps as a summary of tasks required to implement event streaming in a MATRIXX Digital Commerce environment.

An Event Streaming Framework connector is required to stream events. The supported connectors are listed in this section. For information about creating a custom connector, see the discussion about creating a custom connector. For information about setting the log level for individual connectors, see the discussion about managing Event Streaming Framework logging.

The Event Stream Server and Event Streaming Framework require administration tasks. The Event Streaming Framework administration tasks include starting and stopping the event stream, managing logging, troubleshooting problems, reconfiguring during runtime, and resetting the event stream.

Subscriber Management provides an overview of subscriber-related data, including users, groups, subscriptions, devices, balances, and notifications. You can capture any attribute of a subscription and base rating on it, enforce subscription and group spending limits across all services and networks, and notify users associated with subscriptions and groups when the subscriptions and groups are nearing spending limits.

MATRIXX Engine supports service authorization and cut-offs to ensure subscriber usage is valid and revenue loss does not occur.

You can associate a _glossary/subscription.html with a user in a many-many relationship using the user APIs.

When a network message is received, the device information is used to guide the service usage to the subscription. As a result, a subscription can have any number of associated devices.

Managing subscriptions includes adding subscriptions to groups, removing subscriptions from groups, setting the status of subscription objects, and associating users with subscriptions. You can perform these operations by using MATRIXX Backoffice Customer Tool and any custom applications that call the SubMan APIs.

You can create, provision, and delete devices by calling the SubMan APIs and scheduling automated tasks.

Managing users includes creating and deleting users, associating users with subscriptions, and assigning users roles. You can perform these operations by using MATRIXX Backoffice Customer Tool and any custom applications that call the SubMan APIs.

Managing product offers includes purchasing and canceling product offers, and removing expired product offers. You can purchase and cancel product offers by using MATRIXX Backoffice Customer Tool and any custom applications that call the SubMan APIs. Expired product offers are removed from _glossary/subscription.html and group wallets automatically after a configured amount of time.

Use purchase packages to dynamically group catalog items and package them so they can be purchased as a single unit. Purchased items can be added to or removed from a purchase package through the purchase package APIs without requiring pricing changes, providing a single entity for promotional and business operations.

Rehoming is the process of moving a user, group, device, or subscription from one sub-domain to a different sub-domain in a multi-domain platform.

Subscriber Management (SubMan) API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.

The Subscriber Management (SubMan) API defines a set of programming interfaces to the MATRIXX in-memory database. In addition, the Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and event database for subscriptions and groups. The SubMan API can be used to manage the various in-memory objects in a defined manner, allowing an exchange of subscriber and group data between external applications and MATRIXX Engine.

MATRIXX Engine maintains transactional subscriber data that enables you to act in real-time to subscriber needs and service usage. The MATRIXX subscriber model is flexible and supports any type of subscriber base, such as retail, wholesale, and mobile virtual network operator (MVNO).

The following sections introduce how the various in-memory objects are managed.

The Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and Event database for subscribers and groups. The RS Gateway must be configured to connect to the Event Repository.

This section explains how to use the REST API bindings to interface with MATRIXX Engine.

This chapter describes the SubMan REST APIs.

The SubMan API reference includes SubMan API and MDC descriptions.

The MtxRequestSubscriberEstimateRecurringCharge SubMan API estimates balance impacts from recurring processing of currently failing recurring cycles and upcoming recurring cycles (active purchased items cycles, balance cycles and billing cycles).

This section provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.

MATRIXX Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.

The Business API SDK is a flexible framework that includes a set of tools to manage, customize and extend the REST Services Gateway (RS Gateway) for customer-specific business needs. Using the SDK, you can extend existing projects or create entirely new projects to add, replace, or modify services that leverage existing functionality.

The Business API Gateway is a development framework that includes the Business API SDK, Rest Services Gateway (RS Gateway), Gateway Proxy, and application tier. It allows custom mobile applications, Web clients, and other custom implementations to integrate with MATRIXX Digital Commerce.

You create JAR file extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.

You can create a custom filter by creating a named filter or a filter class. A named filter is useful for simple filters while a filter class should be used for complex filters (for example, when the returned results must be modified).

When you upgrade the MATRIXX Digital Commerce software, you must upgrade the Business API SDK as it is possible that files have changed or have been deprecated. Use the manage_integration_project.py script to remove the current release from your project directory structure and upgrade to the latest release. You should do this even if your files are not checked into Subversion.

My MATRIXX Help provides information about My MATRIXX, a Web application that offers a central location for creating pricing plans and configuring MATRIXX Digital Commerce charging and rating behaviors. My MATRIXX is intended for pricing administrators who are responsible for creating and maintaining pricing plans and for IT administrators or developers who configure the rating and charging behavior of the online charging system.

My MATRIXX is a Web application you use to create pricing plans and configure features of MATRIXX Digital Commerce that drive runtime charging and policy behavior.

You use My MATRIXX to validate and compile the pricing configuration file, compile pricing, and set up and manage user roles and domains; create and manage catalog items and catalogs, manage eligibility features and rules, and manage the Normalizers interface; create and manage balances, pricing, offers and bundles, general components, and application-related components; and policies for charging and rating. Use General Configurations to create components that support pricing items and charging functionality such as announcements pricing components, attribute definitions, denial codes, products, decision tables, Final Unit Indication (FUI) profiles and generators, general ledger transaction types, notification profiles, normalizer templates, and subscriber information query actions, profiles and generators.

Use the Home menu to perform the following tasks:

Catalog Configuration contains the Catalog Items interface that you use to create, change, or delete catalog items; the Eligibility interface to manage eligibility features and rules to determine whether a subscriber, group, or device is eligible for a catalog item; and the Normalizers interface you use to edit normalizers.

Charging Configuration contains interfaces you use to create and manage balance, pricing, offer and bundle, general, and application-related components.

Policy configuration components are used by MATRIXX Charging Application and MATRIXX Policy Application for charging and rating.

MATRIXX Backoffice Customer Tool Help describes how to use MATRIXX Backoffice Customer Tool to view and manage subscription and group account information, including purchased offers, services, and balance amounts. MATRIXX Backoffice Customer Tool users are granted privileges (including managing subscriptions and groups) based on the user role they are assigned. For information about what roles MATRIXX Backoffice Customer Tool supports, see MATRIXX Backoffice Customer Tool Help.

Log in to MATRIXX Backoffice Customer Tool.

When you log in to MATRIXX Backoffice Customer Tool, the Home page opens.

If enabled, use the debug mode to retrieve information about the MATRIXX Backoffice Customer Tool deployment for debugging issues. For more information, see the discussion about enabling debug mode in MATRIXX Backoffice Customer Tool in either MATRIXX Web App Administration or MATRIXX Cloud Native Web App Administration depending on your environment.

You can perform a general search for users, devices, groups, or subscriptions. In addition, you can search for an object by defining certain criteria. The search criteria available are dependent on the object type.

Use the User Summary page to display information for a _glossary/user.html. Users have a many:many relationship with subscriptions and groups. If assigned the Admin _glossary/user_role.html, the user is the recipient of group notifications.

Use the Subscription Summary page to display information for a _glossary/subscription.html.

MATRIXX Backoffice Customer Tool allows you to assign devices to users and search for devices by Access Number, IMSI, Object ID, or External ID. If Login devices are enabled, you can search for devices by Login ID.

A group is a collection of one or more subscriptions, users, other groups, or a combination of those. A group can belong to one other group only, but a subscription or user can belong to any number of groups. Each group can have one or more optional administrators (a subscription or user with an Admin _glossary/user_role.html). If an administrator is added, it must be an existing subscription or user but does not have to be a group member. Use the Search screen to display information for a group.

To view all the current offers in the MATRIXX Backoffice Customer Tool database, click View Offers on the Home page or click the Offers tab in the header on any page other than the main page.

To use a CSV file to add/modify subscriptions, groups, device, and users directly, click Bulk Operations on the Home page or click the Bulk Operations tab in the header on any page other than the main page.

MATRIXX Third-Party/Open Source Licenses lists the third-party and open source software licenses that protect the third-party and open source software programs that MATRIXX Digital Commerce uses.

This document lists the third-party and open source software programs shipped with MATRIXX Digital Commerce. Except where noted, all software programs are integrated in code without modification.