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).
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.
Add Indexes for TTL to Stats and Trace Collections
Add MongoDB indexes for TTL to the collections of the MATRIXX Event Repository that contain event-loading statuses and traces.

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.
    - Install MongoDB for Event Repository
      A quick start guide for installing and configuring MongoDB for the Event Repository.
    - Install the PyMongo Driver
      The MATRIXX Event Repository requires that you obtain and install the PyMongo driver on each MATRIXX Engine server that runs the Event Repository. The instructions for doing this depend on whether your servers have a working internet connection.
    - Set Configuration Options for MongDB Instances
      Set configuration options for MongoDB instances in your non-sharded or sharded MongoDB deployment. This section offers an abbreviated quick start guide for configuring settings in MongoDB configuration files when setting up your Event Repository. For complete information about MongoDB runtime database configuration, refer to the MongoDB documentation.
    - Initiate Each Shard Replica Set
      Initiate the shard mongod instances (shard replica set) that will host subsets of the MATRIXX event-object data set in your MongoDB sharded deployment.
    - Initiate the Config-Server Replica Set
      Initiate the config-server mongod instances (three-member replica set) that will host the configuration data of your sharded MongoDB deployment.
    - Create MongoDB Users for a Shard Replica Set
      Create MongoDB users for each shard replica set in your sharded MongoDB deployment for the Event Repository.
    - Initiate the Sharded Cluster
      Initiate the sharded cluster of your sharded MongoDB deployment that will host the MATRIXX event-object data set in your MongoDB system.
    - Create MongoDB Users for a Sharded Cluster
      Create MongoDB sharded cluster users for the Event Repository.
    - Setup for Event Repository Administration Scripts
      Event Repository administration scripts enable you to verify the Event Repository configuration and monitor its status (displaying server status and event-loading statistics). The administration scripts can be run from any machine that has a connection to the machine on which a mongod instance runs. After the event store is set up and you are logged on to a machine where the MATRIXX Engine software is installed, you can run the scripts with no further setup. To run the administration scripts on a machine where the MATRIXX Engine software is not installed, use the following setup tasks.
    - Add Partition Configuration and Index Definitions
      Add index definitions for the indexes to be created in your MongoDB system for the Event Repository and specify whether to use no partitions to use one event collection (EventCollection) for storing event objects, or specify to use multiple event collections for storing event objects. Using no partition or multiple partitions is controlled by the event-collection partitioning method you configure. Indexes are added to the event collections of the Event Repository (MtxEventDatabase) based on your index definitions and partitioning method configuration.
    - Reset Partitioning Method Configuration
      If you set the event collection partitioning method configuration to one collection (0) during configuration, you can optionally change the value to multiple collections (1, 2, 3, or 4) even after the Event Loader has loaded event objects into the Event Repository.
    - Add Indexes for TTL to Stats and Trace Collections
      Add MongoDB indexes for TTL to the collections of the MATRIXX Event Repository that contain event-loading statuses and traces.
    - Add Indexes and Create Collections
      Add indexes according to the index definitions saved in your MongoDB database, and create collections (that include the indexes) based on the partition-method configuration saved to your MongoDB database.
    - Verify Loading of Event Objects into MATRIXX Event Repository
      Verify that event objects are loaded into the Event Repository.
    - MongoDB Configuration File Templates
      The configuration templates include basic recommended settings for MongoDB configuration files for mongod instances, mongos instances (sharded clusters only), and config servers (sharded clusters only) for the initial setup of the Event Repository. Refer to the reference material MongoDB Configuration File Options in your MongoDB product documentation for descriptions of these options and other MongoDB configuration file options.
    - Event Repository Configuration
      You can use the configuration parameters in create_config.py to configure the Event Repository implementation.
    - Set MongoDB Connection String for Event Loader
      Set the connection string that the Event Loader uses to connect to the Event Repository of your MongoDB system.
  - 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

Add Indexes for TTL to Stats and Trace Collections

Add MongoDB indexes for TTL to the collections of the MATRIXX Event Repository that contain event-loading statuses and traces.

About this task

This is an optional index for the Event Repository. MongoDB indexes can be added to your MongoDB system at any time, but perform this task as part of your initial setup of the Event Repository before you run the create_event_repository_partitions.py script.

Procedure

Do one of the following:
- For a non-sharded MongoDB deployment:
  Connect to the primary mongod of the replica set using the MongoDB mongo shell CLI.
  
  mongo
- For a sharded MongoDB deployment:
  Start a mongo shell and connect to the mongos.
  mongo
Enter the following commands to add TTL-related indexes to the Event Repository event collection of your MongoDB system and to remove trace and stats data (MEF-loading information) from the collection after 30 days. If you do not add the TTL-related indexes to these collections, you must purge the records periodically, for example, monthly, to achieve optimal performance.
use MtxEventDatabase

db.LoaderTraceCollection.createIndex( { "Time": 1 }, { expireAfterSeconds: 2592000 } )

db.LoaderStatsCollection.createIndex( { "Time": 1 }, { expireAfterSeconds: 2592000 } )

Note: expireAfterSeconds is the number of seconds after which MEF-loading information is purged (in this example, it is purged after 30 days). MEF-loading information can be useful during MEF recovery (to find out what is missing) so do not purge it too quickly.

What to do next

After adding any index definitions manually, run the check_event_repository_configuration.py script to view all index definitions.