Home
MATRIXX Integration
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).
Cloud Native GL Processor
You can send GL information to a PostgreSQL database in cloud native MATRIXX deployments when you do not want to use a MongoDB database for the Event Repository.
MATRIXX REST APIs for PostgreSQL Partitioning
Use the REST APIs described in this section to manage table partitioning for a PostgreSQL database.

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).
  - General Ledger Event Contents
    The MATRIXX Charging Server generates specific financial information in events that can be loaded by a third-party General Ledger (GL) or Enterprise Resource Planning (ERP) system.
  - Recognizing Revenue
    The MATRIXX Charging Server collects General Ledger (GL) information from the data gathered for generating charge records as Event Detail Records (EDRs). This data includes a balance instance, a product offer, and an impact type (charge, discount, grant, or adjustment).
  - Configuring General Ledger Records
    By default, General Ledger (GL) information is not included in MATRIXX Event Detail Records (EDRs). You must configure the MATRIXX Engine to use GL, and then use My MATRIXX to create the GL account and transaction types, transaction profiles, transaction profile selectors, and GL account selectors that MATRIXX uses to generate the GL information that is included in EDRs.
  - Associating Revenue with a Line of Business
    You can associate revenue with a specific line of business by creating a business unit ID, such as mobile_division, and assigning it to a subscriber or group in the optional GlCenter field using SubMan APIs. The GlCenter is stored in subscriber and group wallets and is added to events.
  - GL Normalizers
    General Ledger (GL) transaction profiles and GL account selectors can contain normalizer tables.
  - General Ledger Example Configuration
    These General Ledger (GL) examples assist in understanding how to configure and use MATRIXX with the GL system. They are intended as models for understanding the GL configuration steps required to achieve the GL journal entries that your GL system requires.
  - Importing GL Account Selectors
    General Ledger (GL) account selectors accept a GL transaction profile as input, and use decision tables that you create to apply the profile parameters to specific subscriber accounts. You can import and export account selectors in My MATRIXX in CSV format.
  - Exporting General Ledger Information
    You can load General Ledger (GL) information into an external database, and then post it to a third-party GL system.
  - Processing and Posting General Ledger Information
    Processing and posting General Ledger (GL) information is different depending on which GL processor and accompanying database you use to persist your GL info. The GL processor uses the Event Repository and processing and posting utilities while cn-gl-processor with an integrated PostgreSQL database uses APIs.
  - General Ledger for Multi-Tenancy
    The General Ledger (GL) utilities support multi-tenancy by processing and posting events in specific tenant instances of the Event Repository. If you are not using multi-tenancy, the GL utilities process and post events in the base Event Repository.
  - Cloud Native GL Processor
    You can send GL information to a PostgreSQL database in cloud native MATRIXX deployments when you do not want to use a MongoDB database for the Event Repository.
    - PostgreSQL GL Posting Configuration
      Configure the PostgreSQL GL posting properties in a Helm values file for the cn-gl-processor Helm chart to process General Ledger (GL) summary data in the PostgreSQL database, aggregate summary records for a given GL date range, and generate GL posting data.
    - Generate General Ledger Daily Summary Records using the GL REST APIs
      If you are using a PostgreSQL database with Cloud Native GL Processor, call the GET {HOST:URL}/gl/summary/{dateString}/{walletOwnerId} API to generate daily General Ledger (GL) summary records. The records show revenues that can be recognized on the specified GL date and show charge records for revenue that can be deferred (as defined by revenue recognition types defined in the MATRIXX Charging Application) on the specified GL date. The consumption quantity of liability assets (aggregated by balance template ID) is recorded.
    - Generate General Ledger Posting Data using the GL REST APIs
      If you are using a PostgreSQL database with Cloud Native GL Processor, call the POST GL REST API to load General Ledger (GL) posting data.
    - GL REST APIs
      Use these GL REST APIs to process General Ledger (GL) information and produce GL posting entries.
    - MATRIXX REST APIs for PostgreSQL Partitioning
      Use the REST APIs described in this section to manage table partitioning for a PostgreSQL database.
      - PUT {HOST:URL}/gl/setupPartitions
        This API sets up the initial table partition.
      - GET {HOST:URL}/gl/showPartition
        This API gets information about existing partitions.
      - PUT {HOST:URL}/gl/createPartition/{dateString}
        This API creates a new partition using the dateString URL parameter.
      - PUT {HOST:URL}/gl/createNextPartition
        This API creates a partition for the next month for the partitioned schema.
      - PUT {HOST:URL}/gl/dropPartition/{dateString}
        This API purges data for the partition specified by the dateString URL parameter.
  - Install the Cloud Native GL Processor Helm Chart
    After you have installed Helm and configured a private chart repository containing the MATRIXX charts, install the cn-gl-processor Helm chart.
- 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

MATRIXX REST APIs for PostgreSQL Partitioning

Use the REST APIs described in this section to manage table partitioning for a PostgreSQL database.

A PostgreSQL table is partitioned into ranges defined by a key column (date range), with no overlap between the ranges of values assigned to different partitions. Each range's bounds are inclusive at the lower end and exclusive at the upper end. For example, if one partition's range is from 1 to 10, and the next partition's range is from 10 to 20, then value 10 belongs to the second partition not the first.

Data is segregated by months so that each month a new partition is created for new data. Partition the ranges based on your specific environment.

A CronJob triggers the creation of partitions using the following APIs:

setupPartition — Sets up initial partitioning if automatic partitioning fails after deployment.
showPartition — Shows all partitions for partitioned tables and displays the size in bytes of each partition.
dropPartition — Purges a partition using the specified date.
createPartition — Creates a partition using the specified date.
createNextPartition — Creates the next partition (for example, for the next month).