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.
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.
Event Type and Service Type Association
Event types and service types are defined during pricing configuration. The event type definition identifies the container to use for the Event Detail Record (EDR) and fields to map to the EDR. The service type definition identifies an associated event type and the fields to map to the EDR.
Mapping MtxPrimaryEvent Fields
You can extend the MtxPrimaryEvent MATRIXX Data Container (MDC) with a custom MtxPrimaryEventExtension which can be the target of event field mappings.

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.
  - 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.
    - Event Type and Service Type Association
      Event types and service types are defined during pricing configuration. The event type definition identifies the container to use for the Event Detail Record (EDR) and fields to map to the EDR. The service type definition identifies an associated event type and the fields to map to the EDR.
      - Mapping MtxPrimaryEvent Fields
        You can extend the MtxPrimaryEvent MATRIXX Data Container (MDC) with a custom MtxPrimaryEventExtension which can be the target of event field mappings.
    - Custom MDC and MDC Field Creation
      Adding a field to an Event Detail Record (EDR) requires you to create a new EDR, because you cannot add fields to system MATRIXX Data Containers (MDCs). This involves editing the MATRIXX configuration information file, create_config.info, to either remove or change the answers to the questions about adding custom MDCs and running the create_config.py script.
    - Compile a Pricing Plan from the Command Line
      Perform this task to compile a pricing plan from the command line so you can deploy the pricing plan to the pricing database. The compiler validates the pricing schema during compilation time and returns any errors that occur.
    - 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.
    - Load a Compiled Pricing File
      The load_pricing.py script loads a compiled pricing XML configuration file into the pricing database on a processing pod and then, if successful, loads it synchronously onto all other pods in the engine. The pricing XML file can be loaded directly or as part of a pricing ZIP file. If MATRIXX Engine has multiple sub-domains, each sub-domain must have the same base pricing loaded or a version of the same base pricing.
  - 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

Mapping MtxPrimaryEvent Fields

You can extend the MtxPrimaryEvent MATRIXX Data Container (MDC) with a custom MtxPrimaryEventExtension which can be the target of event field mappings.

To extend the MtxPrimaryEvent you create a custom MATRIXX Data Container (MDC) from MtxPrimaryEventExtension. Then you can map event fields to the new MDC and fields. When a field is populated for any event derived from MtxPrimaryEvent, it is included in the derived event.

For example, you can use a group tier to select a group source field for mapping. Assume there is a BillingAccount group tier with external ID Main for a custom MyGroup MDC. You can map the external ID of that group and set it in a custom MtxPrimaryEventExtension object. Data is populated for every group, subscription and device event (such as create, modify, delete, purchase, cancel, usage, and so forth) which is linked to a group tier BillingAccount.

To create a custom MDC based on MtxPrimaryEventExtension, answer the following create_config.py questions specific to your custom MDC:

Added MDC:00028:What is the container's name?MyPrimaryEventExtension
Added MDC:00028:What is the container's key?-28
Added MDC:00028:What is the name of the base container (if any)?MtxPrimaryEventExtension
Added MDC:00028:What is the created schema version?3
Added MDC:00028:What is the deleted schema version?0

New MyPrimaryEventExtension field:How many fields do you want to add?1
New MyPrimaryEventExtension field:00001:What is the field's name?CustomerAccount
New MyPrimaryEventExtension field:00001:What is the field's type?string
New MyPrimaryEventExtension field:00001:What is the field's max-size?0
New MyPrimaryEventExtension field:00001:Is this field a list (y/n)?n
New MyPrimaryEventExtension field:00001:Is this field an array (y/n)?n
New MyPrimaryEventExtension field:00001:What is the created schema version?3
New MyPrimaryEventExtension field:00001:What is the deleted schema version?0

In My MATRIXX, edit the Edit Event Type undefined - root (ID=0) event field mapping in the Event Type editor with the following information:

Source Container: MyGroup
Source Field: ExternalId
Tier: BillingAccount
Destination Container: MtxPrimaryEvent
Destination Field: MtxPrimaryEvent.MyPrimaryEventExtension:CustomerAccount

For more information about creating custom MDCs, see the discussion about adding fields to EDRs in MATRIXX Configuration.