Home
MATRIXX Engine Integration
Event Repository
A MATRIXX Engine can optionally load MATRIXX event details records (EDRs) 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 separately).

Welcome
Release Notes
Architecture Overview
MATRIXX Cloud Native Installation and Configuration
MATRIXX Cloud Native Integration
Implementing MATRIXX in a Cloud
Installation and Configuration
MATRIXX Digital Commerce Upgrade
MATRIXX Security
MATRIXX Engine Administration
MATRIXX Web App Administration
MATRIXX Engine Integration
- About MATRIXX Engine Integration
  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.
- MATRIXX System MDC Definitions
  The /opt/mtx/data/mdc_config_system.xml file contains all system MDC definitions, subtypes definitions, and relationship definitions.
- MATRIXX Event Detail Records (EDRs)
  The MATRIXX Engine generates EDRs 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)
  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.
- General Ledger (GL) Records
  A General Ledger is a record of a company's financial transactions. Once configured, 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 General Ledger or enterprise resource planning (ERP) system.
- Subscriber Data
  This section provides an overview of subscriber data relationships.
- Event Repository
  A MATRIXX Engine can optionally load MATRIXX event details records (EDRs) 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 separately).
  - Event Repository System Requirements
    The Event Repository has specific operating system and third-party software requirements. For information about installing software components, see the related task about MongoDB recommendations for Event Repository setup.
  - 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 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 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 Event Repository.
  - 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 MDC-event-object fields (which are documented separately from this reference) as well as a few additional fields which are documented in this reference.
  - Event Repository Administration Scripts
    Use the Event Repository administration scripts to display the Event Repository configuration, to check the status of the Event Loader service that loads events into the Event Repository, and to check the status of the database application running the Event Repository.
- 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 Digital Commerce.
- Network Protocol Gateway
  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.
- Appendixes
Call Control Framework Integration
MATRIXX Diameter Integration
MATRIXX 5G Integration
MATRIXX Monitoring and Logging
Pricing and Rating
MATRIXX Pay Now
MATRIXX Policy
MATRIXX Event Streaming
Subscriber Management
Subscriber Management (SubMan) API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

Event Repository

A MATRIXX Engine can optionally load MATRIXX event details records (EDRs) 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 separately).

The Event Repository is a database that serves as a long term store for MATRIXX Event Detail Record (EDR).

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 blade in a 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 blade 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:

CMDC (compact MDC)
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.