Home
MATRIXX Integration
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).

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).
  - Event Repository System Requirements
    The Event Repository has specific operating system and third-party software requirements. For information about installing software components, see the discussion about MongoDB recommendations for Event Repository.
  - MongoDB Recommendations for Event Repository
    You must set up MongoDB database processes for hosting the Event Repository.
  - Event Repository Quick Start (Non-Sharded)
    The topics in this section serve as a quick start guide for setting up Event Repository on a MongoDB deployment that does not use sharding (non-sharded). If you plan to have a sharded cluster, refer to the quick start guide for setting up Event Repository on a sharded MongoDB deployment.
  - Event Repository Quick Start (Sharded)
    The topics in this section serve as a quick start guide for setting up the Event Repository on a MongoDB sharded deployment. If you plan to have a non-sharded cluster, refer to the quick start guide for setting up the Event Repository on a non-sharded MongoDB deployment. This information describes configuring the integration points between MATRIXX Engine and your MongoDB system only. For all instructions about setting up a sharded cluster in your MongoDB system, refer to your MongoDB product documentation.
  - Administering the Event Repository
    The topics in this section describe how to monitor and maintain runtime operations for the Event Repository.
  - Querying Data in the Event Repository
    The Event REST APIs include event-query services that retrieve data from the _glossary/event_repository.html.
  - MtxEventDatabase EventCollection
    The EventCollection collection of the Event Repository (MtxEventDatabase) stores all event objects that are loaded into the Event Repository by the MATRIXX Engine. The EventCollection collection stores all MATRIXX Data Container (MDC) event object fields (which are documented apart from this reference) and a few other fields that are documented in this reference.
- 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

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).

The Event Repository is a database that serves as a long term store for EDRs.

The Event Repository is implemented in MongoDB in the database named MtxEventDatabase. MtxEventDatabase has different collection types for the following information: database configuration, MATRIXX event-object payloads, and Event Loader statuses and traces.

The Event Loader is a service that runs on the publishing server in MATRIXX Engine. The Event Loader loads the event objects into the Event Repository. The Event Loader loads event records from Streamed Event Files (SEFs) that are generated on the publishing server into the EventCollection collection.

The LoaderStatsCollection and the LoaderTraceCollection are the collections in the Event Repository that store Event Loader statistics and traces.

You can enable the Event Loader service in existing MATRIXX Engine installations. For existing installations, the Event Loader service loads event records from SEF files that are generated after the service is enabled in the engine. Event records from SEF files that were generated before the service was enabled in the engine are not loaded.

You can configure MATRIXX Engine to store event objects in the Event Repository in the following formats:

compact MDC (CMDC)
BSON
Combination of Compact MDC and BSON

If you configure MATRIXX Engine to add general ledger (GL) information to MATRIXX EDRs, you can use MATRIXX GL utilities to process that GL information from your Event Repository. For information about processing and posting GL information, see the discussion about GL records.