Home
MATRIXX Integration
Extending MATRIXX Engine Functionality
You can 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.
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.
Update the MDC Definitions for RS Gateway
After extending an MATRIXX Data Container (MDC) definition with custom fields or upgrading the MATRIXX Engine schema, follow this procedure to update the MDC definitions for RS Gateway. This enables applications that communicate with the engine to operate on the new fields and revert to previous service provider versions, if necessary.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
- About MATRIXX Integration
  MATRIXX Integration describes the tools and tasks for integrating MATRIXX functionality in a MATRIXX environment.
- MATRIXX System MDC Definitions
  The /opt/mtx/data/mdc_config_system.xml file has all system MATRIXX Data Container (MDC) definitions, subtype definitions, and relationship definitions.
- Cloud Native Utilities
  MATRIXX 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.
- MATRIXX Event Detail Records
  MATRIXX Engine generates an _glossary/edr.html for all activities that can trigger rating, such as usage, catalog item purchases and cancelations, 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
  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, and can be input to third-party applications.
- Subscriber Data
  This section provides an overview of subscriber data relationships.
- Event Repository
  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).
- MATRIXX Notification Framework
  This section describes how the MATRIXX Engine publishes notifications to a JMS message broker and how you can customize the information included in notifications.
- Business API Gateway
  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.
- Extending MATRIXX Engine Functionality
  You can 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.
  - 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.
    - Create a Custom MDC
      You create a custom MATRIXX Data Container (MDC) to capture additional data that is used during rating or post-processing operations, such as adding fields to extend the system MtxDiamRoMsg MDC or to a MATRIXX Event File (MEF). The custom MDC can be an extension of a system MDC, an existing custom MDC, or not be based on any MDC.
    - Add a Field to a Custom MDC
      Follow this procedure to add a field to a custom (private) MATRIXX Data Container (MDC). You cannot add fields to a system MDC. Instead, create a custom MDC that extends the system MDC and add the fields to the custom MDC. All fields in the system MDC are available to the custom MDC.
    - Copy an AVP Field Value to an MDC Field
      Perform this task to copy an AVP field value to a field in the MtxDiamRoMsg MDC or any custom MDC that is based off of an MDC that exists in the Diameter dictionary.
    - Assign a Service Type to a Diameter Message
      The ServiceTypeObjectId field must be assigned a value, corresponding to the ID of a service type object in the Pricing database, in order for rating to succeed.
    - Assign a Service Type to a 5G Message
      The Mtx5GMsg.ServiceTypeObjectId field must be assigned a value, corresponding to the ID of a service type object in the Pricing database, in order for rating to succeed.
    - Update the MDC Definitions for RS Gateway
      After extending an MATRIXX Data Container (MDC) definition with custom fields or upgrading the MATRIXX Engine schema, follow this procedure to update the MDC definitions for RS Gateway. This enables applications that communicate with the engine to operate on the new fields and revert to previous service provider versions, if necessary.
    - MATRIXX Data Container Field Data Types
      MATRIXX Engine supports several data types for its network message MATRIXX Data Containers (MDCs) and database object MDCs. When you define custom MDCs and MDC fields, you must specify one of these data types for the fields.
    - Changing MDC Definitions
      Follow these rules when working with custom MATRIXX Data Containers (MDCs):
  - Extending Session Objects
    Service providers can extend charging and policy session MATRIXX Data Containers (MDCs) to contain additional fields to hold provider-specific information. Fields can be added from the network message to the session to be used as the basis of normalizations during rating and policy calculations. In addition, subscriber data and custom fields in charging session objects can be used in event field maps to map incoming fields to event type MDCs so that the fields are included in the associated Event Detail Record (EDR).
  - Adding Fields to Event Detail Records
    You can add fields to an Event Detail Record (EDR) that is generated for usage and non-usage event types. The process is different for usage and non-usage EDRs. The process includes creating a new event type, creating a custom MATRIXX Data Container (MDC) to hold the extended EDRs, and specifying the fields to map into the extended EDR.
  - Add GL Information to EDRs
    By default, General Ledger (GL) information is included in Event Detail Records (EDRs). For more information about GL information, see MATRIXX Pricing and Rating.
- Data Export
  The MATRIXX Data Export image (data-export) has 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.
- Selective Updates
  Selective updates are commands that enable the system to selectively update a MATRIXX Data Container (MDC) as it is processed. They perform basic transformations on the MDCs.
- MATRIXX Toolbox Utilities
  The MATRIXX Toolbox image has scripts and utilities to aid in the deployment and operation of cloud native MATRIXX installations.
- MATRIXX Miscellaneous Utilities
  The MATRIXX Misc image includes utilities and files to aid in the deployment and operation of cloud native MATRIXX.
- MATRIXX Third-Party Analysis Utilities
  You can use the third-party Linux tcpdump utility to capture network traffic for a MATRIXX application.
- General Ledger Records
  MATRIXX generates General Ledger (GL) information for accounts that you specify during rating. It then captures that information in MATRIXX Event Files (MEFs).
- Appendixes
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

Update the MDC Definitions for RS Gateway

After extending an MATRIXX Data Container (MDC) definition with custom fields or upgrading the MATRIXX Engine schema, follow this procedure to update the MDC definitions for RS Gateway. This enables applications that communicate with the engine to operate on the new fields and revert to previous service provider versions, if necessary.

About this task

Important: If you are performing this task after a schema upgrade, you must wait until the target cluster is in an HA STANDBY state. This ensures all MDC definitions have already been transformed into the new schema. If you are upgrading to a new version of MATRIXX, upgrade all engines before updating the MDC definitions for RS Gateway.

Procedure

Create any necessary MDC extensions.
Copy mdc_config_custom.xml to the directory in your configuration source mapped to the /opt/mtx/conf directory in the container.
For more information about configuring MATRIXX gateways and web apps, including using configuration sources and config maps instead of a configuration source, see the discussion about configuring MATRIXX gateways and web apps in MATRIXX Configuration.
Rebuild the image and upload it to your image repository.
Update values for rsgateway.configuration.container.configmap and rsgateway.sideloadImages in your Helm values file to apply the updated configuration, in this case your new MDC definitions for RS Gateway.
Apply the MDC definitions with the helm upgrade command. For example, the following command applies the contents of the configuration source specified in matrixx-webapps-gateways_values.yaml to the matrixx-webapps-gateways Kubernetes namespace:
```
helm upgrade ag1 matrixx/matrixx --namespace matrixx-webapps-gateways -f matrixx-webapps-gateways_values.yaml --version 5260
```