Home
MATRIXX Integration
Appendixes
Event Repository Administration Scripts
Use the Event Repository administration scripts to display the Event Repository configuration, check the status of the Event Loader service that loads events into the Event Repository, and check the status of the database application running the Event Repository.
event_repository_purge
You can purge the Event Repository using the event_repository_purge standalone application. The application produces output including the collection being examined and when the collection is finished. If the debug option is enabled, more details are included in mtx_debug.log file.

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).
- 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
  - Event Repository Administration Scripts
    Use the Event Repository administration scripts to display the Event Repository configuration, check the status of the Event Loader service that loads events into the Event Repository, and check the status of the database application running the Event Repository.
    - configure_event_repository.py
      The configure_event_repository.py script creates the partition-method configuration that specifies how many collections to generate in your MongoDB system to store event objects in the Event Repository. The configure_event_repository.py script also saves index definitions to the MtxEventDatabase of your MongoDB system for indexes to be used for the Event Repository.
    - create_event_repository_partitions.py
      The create_event_repository_partitions.py script creates the indexes for collections that are to be generated in your MongoDB system to store event objects in the Event Repository. If you plan to load event objects into only one collection (no partitioning), run this script only once. If you plan to load event objects into multiple collections (partitioning is used), run this script at regular intervals (such as a cron job) so that new partitions are created. This script is also run in the Event Loader every 30 days using a --daysAhead value of 60.
    - check_event_repository_configuration.py
      The check_event_repository_configuration.py script displays Event Repository configuration information, such as the host information for each mongod in your replica set in which mongod is the primary and secondary, and a listing of the event database indexes.
    - print_event_repository_stats.py
      The print_event_repository_stats.py script displays the Event Store event database statistics, such as the event count and the data and index storage sizes.
    - print_event_repository_status.py
      The print_event_repository_status.py script displays the statuses of the mongod servers in the Event Repository replica set and displays the available data storage sizes.
    - print_event_repository_loader_stats.py
      The print_event_repository_loader_stats.py script displays the Event Repository Event Loader statistics for a running Event Loader.
    - print_event_repository_loader_status.py
      The print_event_repository_loader_status.py script displays the statuses of the Event Repository Event Loader services running on the publishing server in a MATRIXX Engine.
    - print_event_repository_loader_trace.py
      The print_event_repository_loader_trace.py script displays the status of an Event Loader service that is running on the publishing server, and the traces of its MATRIXX Event File (MEF) processing and associated statuses.
    - print_event_repository_event.py
      Use the print_event_repository_event.py script to print Event Repository events.
    - partition_events.py
      Use the partition_events.py script to migrate your event repositories from single collections to multiple collections. Reconfigure the event collection partitioning value to multiple collections (1, 2, 3, or 4), and then run the partition_events.py script. For details, see the discussion about resetting the partitioning method configuration.
    - upgrade_event_repository.py
      The upgrade_event_repository.py script adds the indexes to the Event Repository that are required by the Event Repository purge utility.
    - event_repository_purge
      You can purge the Event Repository using the event_repository_purge standalone application. The application produces output including the collection being examined and when the collection is finished. If the debug option is enabled, more details are included in mtx_debug.log file.
  - Failover Scripts
    Use these scripts to publish MATRIXX and clean up orphaned transaction log files after an engine failover.
  - Failover Scripts
    Use these scripts to publish MEF and SEF files from transaction log files.
  - add_custom_field_to_export.py
    The add_custom_field_to_export.py script is used to add custom MDC fields to a configuration YAML file that is used by the data_export.jar program.
  - data_export.jar
    The data_export.jar program generates the Java classes that are used to extract data from a database checkpoint or MEF and export the data to comma-separated values (CSV) files.
  - JavaApiGenerator.jar
    The JavaApiGenerator.jar program generates the Java classes that can be used by Java applications to communicate with MATRIXX Engine.
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_purge

You can purge the Event Repository using the event_repository_purge standalone application. The application produces output including the collection being examined and when the collection is finished. If the debug option is enabled, more details are included in mtx_debug.log file.

Syntax

event_repository_purge [ -h ] { -i instanceId ] [ -g config-file ] [ -t ] [ -d ] [--timeSlice queryTimeSlice] [--percentUpdate percentUpdateInterval] [--showUnmappedCodes] [--dryrun] [numThreads number-of-threads]

Options

The event_repository_purge standalone app has the following options.

-h, --help: Show help about the application options.

-i, --instance-id instance-id: The instance ID of the collection. The default is 1.

-g, --config-file config-file: The location of the configuration file. The default is ./mtx_config.xml.

-t, --trace: Turns on trace logging. The default setting is off.

-d, --debug: Debug flag. If this option is specified, extra messages are printed to help with debugging this application. The default setting is off.

--timeSlice: The query time slice in seconds. The default is 3600.

Note: This option overrides the Purge Query Time in Seconds specified in the create_config.info file.
--percentUpdate: The completion percentage interval at which to post status updates. The default is 1 for every 1% change.

Note: This option overrides the Percentage Interval for Purge Status Updates specified in the create_config.info file.
--showUnmappedCodes: Shows unmapped deletion codes.
--dryrun: Performs a "dry run" without removing any events or empty collections and updating the Event Repository.
--numThreads: Specifies the number of concurrent MongoDB connections. You can increase this value to allow the task to finish faster by putting more load on the Event Repository. The default is 1.

Note: This option overrides the Number of Purge Query Threads specified in the create_config.info file.