Home
MATRIXX Integration
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.
Customizing Non-Usage Events
You can map any operation (such as a recurring charge or grant) for an object (subscriber, group, device) to an event (such as a custom MyStatusChangeEvent) and define the fields to be included in the Event Detail Record (EDR).
Customize Non-Usage Events
You can create custom MATRIXX Data Containers (MDCs) to extend non-usage events to include the custom MDC field values in Event Detail Records (EDRs).

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.
  - EDR Contents
    Event Detail Record (EDR) content is derived from multiple MATRIXX Data Containers (MDCs), including MtxEvent, MtxPrimaryEvent, and MtxSecondaryEvent MDCs.
  - EDRs for Usage
    Usage event Event Detail Records (EDRs) contain information about the quantities used for charging. A network message received for usage can include several usage quantity types; all are recorded in the EDR for the usage event. The information is listed in the MtxUsageEvent EDR in a list field called UsageQuantityList. Each element of this list is a MtxEventUsageQuantity MATRIXX Data Container (MDC).
  - EDRs for Purchases and Cancelations
    Purchase and cancelation events include a record of offer information (OfferInfoArray) and bundle information (MtxBundleInfoArray) when an offer or bundle is purchased or canceled.
  - EDRs for Session End Events
    When the session_end event type is defined in the pricing configuration file and it references the MtxSessionEndEvent MATRIXX Data Container (MDC), a session termination event can be generated when a session is terminated (a CC STOP message is received).
  - EDRs for Object Modification
    Primary objects include subscriptions, groups, devices, and users. Primary objects have a system assigned object identifier (OID) that uniquely identifies the object and is the primary way to specify the object instance. Primary objects can also have an optional ExternalId value. When you modify a primary object, MATRIXX Engine generates an object modification Event Detail Records (EDRs).
  - Customizing Non-Usage Events
    You can map any operation (such as a recurring charge or grant) for an object (subscriber, group, device) to an event (such as a custom MyStatusChangeEvent) and define the fields to be included in the Event Detail Record (EDR).
    - Customize Non-Usage Events
      You can create custom MATRIXX Data Containers (MDCs) to extend non-usage events to include the custom MDC field values in Event Detail Records (EDRs).
    - Operation Types
      Use operation types to customize non-usage events. The operation type in an event mapping must match an event type. For example, the recurring_subscriber operation can only correspond to a recurring event, such as SubscriberCustomRecurringEvent.
  - Event Fields
    The following sections describe the event 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.
- 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

Customize Non-Usage Events

You can create custom MATRIXX Data Containers (MDCs) to extend non-usage events to include the custom MDC field values in Event Detail Records (EDRs).

Procedure

During engine configuration, create one or more custom MDCs that extend a non-usage MDC.
For more information about creating custom MDCs, see the discussion about adding a custom MDC.
In My MATRIXX do the following:
1. In Event Types, create an event type using the event_type container values that reference the custom MDC(s) that you created in Step 1.
2. In Field Mappings, create a field mapping for each field that you want to include in an EDR.
In My MATRIXX in Event Mappings, create a new event mapping for each event that you created in Step 2.
For more information about creating event mappings, see the discussion about event mapping in My MATRIXX Help.