Home
MATRIXX Integration
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.
MEF Publishing
Publish MATRIXX Event File (MEF) files to off-engine locations automatically or manually. Configure automatic, periodic publishing using answers to the MATRIXX Engine create_config.info file. Configure manual publishing using the create_event_files_from_transaction_logs program.
Prevent Duplicate MEF Events
In certain circumstances the MATRIXX Engine may allow you to process MATRIXX Event Files (MEFs) that result in duplicate events. To compensate for this, you may implement your own code to check for duplicate events outside of MEF publishing and processing. To ensure duplicate events are not processed, confirm that the MEF progress file is in sync with the published MEFs.

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.
  - MEF Publishing
    Publish MATRIXX Event File (MEF) files to off-engine locations automatically or manually. Configure automatic, periodic publishing using answers to the MATRIXX Engine create_config.info file. Configure manual publishing using the create_event_files_from_transaction_logs program.
    - MEF Automatic Publishing
      After you generate MATRIXX Event Files (MEFs), they are intended to be published to an off-engine location for archiving and failover. You use the MEF publishing parameters explained here to configure automatic MEF publication. The automatic MEF publishing process ensures that no data is lost during MEF publication if the active engine fails.
    - MEF Automatic Publishing Frequency
      After you generate a MATRIXX Event File (MEF), it is published to an off-engine location for archiving and failover.
    - MEF Automatic Publishing Error Interval
      By default, MATRIXX returns an error message if the publishing pod is publishing MATRIXX Event Files (MEFs), but has paused for 600000 milliseconds (600 seconds) or more. This time period is configurable by adding a SED command to the /opt/mtx/custom/mtx_config_base_xml_sed.extra file.
    - MEF Manual Publishing
      You would manually publish MATRIXX Event Files (MEFs) if the MEF automatic publishing failed, SEFs or MEFs were deleted, or if during event streaming a SEF file was purged and must be recreated. You manually publish MEFs from SEF files for MATRIXX transaction log files using the create_event_files_from_txn_logs script. By default this script recovers events from transaction log files. However, if the transaction log files are no longer available, you can use the -k option to recover directly from SEF files. This might also be faster.
    - Publish MEFs for Failover
      The MATRIXX Event File (MEF) publishing process for failover ensures that no data is lost during MEF publication if the active engine fails. If the automatic MEF recovery fails, run the create_event_files_from_txn_logs script to recover any lost events. For details see the discussion about manual MEF publishing.
    - Daily MEF Publishing Report
      A daily report file is published for MATRIXX Event Files (MEFs) including event counts and Global Transaction Counters (GTCs).
    - Recover MEF Events
      Use the create_event_files_from_txn_logs recovery tool to create an output file containing events from a given Global Transaction Counter (GTC) range for MATRIXX Event File (MEF) compact MDC or MEF XML files.
    - Prevent Duplicate MEF Events
      In certain circumstances the MATRIXX Engine may allow you to process MATRIXX Event Files (MEFs) that result in duplicate events. To compensate for this, you may implement your own code to check for duplicate events outside of MEF publishing and processing. To ensure duplicate events are not processed, confirm that the MEF progress file is in sync with the published MEFs.
    - Transition from MEFv1 Publishing
      If you are using MEFv1, you must perform certain steps to transition to the latest default format.
  - MEF Processing
    MATRIXX Event Files (MEFs) are created from MATRIXX Streamed Event Files (SEFs) on a MATRIXX Engine publishing server.
  - MEF Identification
    A MATRIXX Event File (MEF) is identified by its filename and header and footer information.
  - MEF Filtering
    To configure filtering, you set up rules to process MATRIXX Event Files (MEFs) in the event-file-filter-service.properties file that can be based on any event or sub event types. Filtering can generate output files in XML, JSON, or compact MDC (CMDC) format. Output files include primary events and any associated secondary events.
  - MEF Balance Update Rounding
    For each event in a MATRIXX Event File (MEF), balance update records are rounded to the precision defined in balance and meter templates. For more information about balance and meter precision, see the discussion about balance and meter precision in MATRIXX Pricing and Rating.
  - Composite Meter Event Reporting
    A composite meter defines both aggregate and component views in a single meter definition and can produce a daily component value for each day. Composite meter balance updates, including aggregation grouping and daily component values, and composite meter close events generated during transaction processing are reported in MATRIXX Event Files (MEFs).
  - MEF Examples
    This section contains example MATRIXX Event File (MEF) components and formats.
- 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
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

Prevent Duplicate MEF Events

In certain circumstances the MATRIXX Engine may allow you to process MATRIXX Event Files (MEFs) that result in duplicate events. To compensate for this, you may implement your own code to check for duplicate events outside of MEF publishing and processing. To ensure duplicate events are not processed, confirm that the MEF progress file is in sync with the published MEFs.

Creating Your Own Code to Avoid Duplicate Events

If a MATRIXX Engine fails over, the MEF progress file might become out of sync with the published MEFs. Processing MEFs in this condition (immediately after a failover) might cause your MEF processing code to give you duplicate events. If preventing duplicate events from being processed is crucial to your MATRIXX environment, create your own logic to confirm that each EventId value is unique within a certain time.

Understanding the MEF Progress File

MEF progress files are stored in the same directory as the MEFs and have this naming syntax:

PublishProgress.engine_engine_id

Where engine_id identifies the MATRIXX Engine creating the MEFs. For example PublishProgress.engine_3.

Preventing Duplicates in MEF Processing after a Failover

To avoid processing duplicate events immediately after a MATRIXX Engine failover, perform these steps for each engine in your MATRIXX environment before restarting it:

On the MATRIXX Engine, find and record the MaxGtc value in the MEF progress file.
Search for and do not process MEF files whose names contain a MinGtc that is equal to or higher than progress file MaxGtc value from Step 1. You may process any that do not match this criteria. For details on MEF filenames, see the discussion about MEF identification.