Home
MATRIXX Integration
Appendixes
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.

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.
  - 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

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.

Syntax

add_custom_field_to_export.py inputConfigFile updatedConfigFile

Command Line Options

inputConfigFile: The name of the input configuration file, either one of the sample configuration files provided with the product (under /opt/mtx/data) or one you created.

updatedConfigFile: The name of the generated configuration file with the added custom fields and their required functions, which will be added by the script. Use this generated file as the input for the data_export.jar program.

Important: Specify two different file names for inputConfigFile and updatedConfigFile. Do not re-use the input file for output.

Results From Running add_custom_field_to_export.py

Given a YAML file, the add_custom_field_to_export.py Python script looks up specific fields that are not lists, arrays, or structs. It adds entries for the fields that it finds to a new YAML file that it generates for use as input to the data_export.jar program. All other entries are copied over from the input YAML file to the new YAML file without any changes.

Configuration Properties

The entries in the YAML file that is used to control the behavior of the data_export.jar program have a defined set of parameter values used to describe MTX objects. Three sample configuration YAML files are provided when you install the product, under the opt/mtx/data directory. You can use these sample YAML files as they are, customize them, or create your own YAML files, using the appropriate parameter values for the MTX objects and the optional configuration file parameters.