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

Welcome
Release Notes
Architecture Overview
MATRIXX Cloud Native Installation and Configuration
MATRIXX Cloud Native Integration
Implementing MATRIXX in a Cloud
Installation and Configuration
MATRIXX Digital Commerce Upgrade
MATRIXX Security
MATRIXX Engine Administration
MATRIXX Web App Administration
MATRIXX Engine Integration
- About MATRIXX Engine Integration
  MATRIXX Engine Integration provides information about the MATRIXX Engine notification functionality, MATRIXX Event File (MEF) publication, Subscriber database SQL mapping, and importing and exporting pricing data.
- MATRIXX System MDC Definitions
  The /opt/mtx/data/mdc_config_system.xml file contains all system MDC definitions, subtypes definitions, and relationship definitions.
- MATRIXX Event Detail Records (EDRs)
  The MATRIXX Engine generates EDRs for all activities that can trigger rating, such as usage, catalog item purchases and cancellations, 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 (MEFs)
  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 Digital Commerce, and can be input to third-party applications.
- General Ledger (GL) Records
  A General Ledger is a record of a company's financial transactions. Once configured, MATRIXX Digital Commerce generates GL information for accounts that you specify during rating. It then captures that information in MATRIXX Event Files (MEFs) and stores it in event objects in the MATRIXX Event Repository. You then use the MATRIXX GL utilities to process the GL information and generate daily GL summary records. That GL data is then available to post to a third-party General Ledger or enterprise resource planning (ERP) system.
- Subscriber Data
  This section provides an overview of subscriber data relationships.
- Event Repository
  A MATRIXX Engine can optionally load MATRIXX event details records (EDRs) 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 separately).
- 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.
  - Notification Overview
    MATRIXX Engine generates real-time notification messages that MEFv1s use to transfer to external systems. Charging Server generates a notification for each contact regardless of the <NotificationPreference> field value.
  - Notification Data Relationships
    Each notification MDC derives information from its base MDC and can be related to other MDCs based on their contained fields.
  - Configuring Notification Messaging
    To enable notification messaging, you must configure the notification-specific global configuration questions during engine configuration, configure ActiveMQ, and configure the MATRIXX Notification Server. All components are required for publishing notifications to third-party systems. If you do not configure a JMS server address, notifications are published to MATRIXX Event Files (MEFs).
  - Starting the Notification Framework
    This topic describes the process for starting the individual components in the Notification Framework.
  - Extending the Notification Framework
    You can extend the Notification Framework to include custom logic to enhance notification messages and to deliver messages to additional endpoints (such as an ActiveMQ queue) by adding additional .jar and .class files on startup.
  - Managing Notification Templates
    The Notification Server uses Apache Camel FreeMarker templates to format notification messages. For information about working with Apache FreeMarker templates, see the Apache FreeMarker documentation.
  - Notifications for Object Modification
    Primary objects include subscriptions, groups, devices, and users. Primary objects have a system assigned object identifier (OID) that uniquely identifies the object and is the primary way to specify the object instance. Primary objects can also have an optional ExternalId value. When you modify a primary object, MATRIXX Engine generates an object modification notification.
  - Support for Push Notifications
    Out-of-box support for sending push notifications is included in MATRIXX Digital Commerce. The Notification Server provides support for sending push notifications by way of Apple Push Notification Service (APNs) and Firebase Cloud Messaging (FCM).
  - Sample Code and Example Camel Configuration for Notification Integrations
    The notification message payload is configurable in JSON and XML to enable external integration of notification delivery for JMS queue and REST API. This section provides sample code and example Camel configurations for common notification integrations.
  - Filter out MTX-specific Headers from HTTP Headers
    By default all Camel Exchange headers are copied to the outgoing HTTP headers. To prevent leakage of non-standard headers, you can filter out MTX-specific headers. In this task, you add and define a new bean to filter out the MTX-specific headers phonenumber, subject, emailid, and language.
  - Add a Cleanup Thread to Manage Connection Pool
    To help manage the connection pool, add a cleanup thread that periodically trims off expired and invalid connections in the connection pool. Add the new class com.matrixx.camelNotifier.gateway.MtxPoolingHttpClientConnectionManager to extend PoolingHttpClientConnectionManager.
  - Sample Code to Route to Another Instance of ActiveMQ
    The notification message payload is configurable in JSON and XML to enable external integration of notification delivery for JMS queue and REST API.
  - Override a Notification Type Handler
    The Notification Framework allows you to override a notification type handler for a specific message.
- 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 Digital Commerce.
- Network Protocol Gateway
  The MATRIXX Network Protocol Gateway communicates with "northside" (mobile) network traffic protocols. You use Network Protocol Gateway as an entry point to communicate with network nodes, and you can rate and bill for services from those protocols. Currently, Network Protocol Gateway processes and bills for SMPP traffic by using the MATRIXX SMPP Adapter.
- Appendixes
Call Control Framework Integration
MATRIXX Diameter Integration
MATRIXX 5G Integration
MATRIXX Monitoring and Logging
Pricing and Rating
MATRIXX Pay Now
MATRIXX Policy
MATRIXX Event Streaming
Subscriber Management
Subscriber Management (SubMan) API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

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.

Intended Audience

This chapter is for developers who configure clients to subscribe to MATRIXX Engine notifications contained in MEFs. For information about installing and configuring the Notification Framework, see Installation and Configuration.