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).
Administering the Event Repository
The topics in this section describe how to monitor and maintain runtime operations for the Event Repository.
Managing Event Repository Passwords
Manage Event Repository user passwords.
Reset the MongoDB Password Used by Event Loader
You set the MongoDB username and password that Event Loader uses to connect to the MongoDB servers when you run the create_config.py script. You can reset this password if needed by performing a configuration update.

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.
    - Display Event Repository Configuration Information
      Display Event Repository configuration information.
    - Display Event Repository Database Application Status and Statistics
      Display Event Repository application status and statistics.
    - Display Event Loader Status and Statistics
      Display the Event Repository Event Loader status and statistics.
    - Handling Event Repository Loading Issues
      This topic provides information about troubleshooting and handling issues when loading event objects into the Event Repository.
    - Managing Event Repository Passwords
      Manage Event Repository user passwords.
      - Reset the MongoDB Password Used by Event Loader
        You set the MongoDB username and password that Event Loader uses to connect to the MongoDB servers when you run the create_config.py script. You can reset this password if needed by performing a configuration update.
      - Set User Credentials for Event Repository Administration Scripts
        Set user credentials for running Event Repository administration scripts. When authorization is enabled on your MongoDB system, every connection to a mongod server requires a username and a password with the appropriate access privileges.
      - URL Encoding for Special Characters in MongoDB User Names and Passwords
        If you use special characters in a MongoDB username or password, such as a colon (:) or an at-sign (@), you must encode each special character to URL encoded format (percent encoding) when you set the username and password in MATRIXX configurations.
    - MongoDB Database Backup Methods
      A list of data backup methods, including advantages and disadvantages of each method, for backing up the data in the Event Repository. Refer to your MongoDB product documentation for detailed information about MongoDB backup methods.
    - Purging Events from the Event Repository
      To purge events from the Event Repository after a configurable amount of time, configure the Event Loader purge task when running the create_config.py script.
  - 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

Reset the MongoDB Password Used by Event Loader

You set the MongoDB username and password that Event Loader uses to connect to the MongoDB servers when you run the create_config.py script. You can reset this password if needed by performing a configuration update.

About this task

Perform this task from the publishing server in the standby engine.

Note: Do not deploy new pricing configuration changes during the configuration update. This must be done after the engine configuration is complete.

To reset the password that Event Loader uses to connect to the MongoDB servers:

For more information about the MATRIXX environment variables, see the discussion about container directories and environment variables in MATRIXX Installation and Upgrade.

Procedure

Using a secure connection, for example ssh, log in to the publishing server as user mtx.
Go to the ${MTX_CUSTOM_DIR} directory.
cd_custom_dir
Copy the create_config.info file to a backup file.
cp create_config.info create_config.info.bak
Edit the create_config.info file to delete this question: EventLoader:What is the password for external database? and save the file.
Enter the following command to run the create_config.py script and when prompted with the question you removed (from the create_config.info file), enter the reset password.
create_config.py

After the script finishes you have reset the password on the local server. You are now ready to update the reset-password configuration on each server in the engine.
Enter the following command to copy the local reset-password configuration (propagate the password change) to all servers in the engine.
configure_engine.py

After the configuration changes are complete, the script updates the configuration on each server by synchronizing the ${MTX_CUSTOM_DIR} directories, then running the configuration script locally on each server.
Restart the publishing server in the standby engine(s).
Restart the publishing server on the active engine.

Results

The password is reset in both the create_config.info file and the mtx_config.xml file in encrypted form. Event Loader services that are connected to MongoDB continue to be connected using the previously set password; when they are restarted, they use the reset password for connecting.