Home
MATRIXX 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.
Notification Overview
MATRIXX Engine generates real-time notification messages that MATRIXX Event File (MEF) files use to transfer to external systems.
Notification Status Events
Configure MATRIXX Engine to generate events that indicate if notification message delivery processing succeeded or failed. If notification status events are enabled, they are included in the MATRIXX Event File (MEF).

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.
  - Notification Overview
    MATRIXX Engine generates real-time notification messages that MATRIXX Event File (MEF) files use to transfer to external systems.
    - Configuring the Notification System
      During MATRIXX Engine configuration, system administrators can define multiple notification properties.
    - Configuring Notification Pricing
      Pricing administrators can configure multiple components when configuring pricing for notifications.
    - Notification Containers
      All MtxNotification containers that are present in a transaction are included in a MATRIXX Event File (MEF) in a NotificationList.
    - Notification Components
      Notification messaging involves multiple components that work together to publish and receive JMS messages.
    - End-to-End Notification Process
      Each MtxNotification MATRIXX Data Container (MDC) specifies one notification contact. For notifications that have multiple recipients and channels, multiple notification MDCs are generated.
    - Event Streaming Framework Notification Process
      You can select to generate MtxNotificationDoneEvent events without delivering end-user notifications. Generate notifications as events in real-time using the Event Streaming Framework, and data is recorded in the event in OpenAPI-JSON format. Events are securely streamed from the Event Streaming Framework to the Kafka Broker using TLSv1.2.
    - USSD Notification Process
      The Notification Server sends Unstructured Supplementary Service Data (USSD) notifications to the engine for processing. The USSD service library converts the notification message text to USSD format and sends the notification to the Network Enabler for delivery.
    - Notification Processing Statistics
      Statistics collected for notification messages are defined in the Management Information Base (MIB) file and are saved to the statistics database.
    - Notification Status Events
      Configure MATRIXX Engine to generate events that indicate if notification message delivery processing succeeded or failed. If notification status events are enabled, they are included in the MATRIXX Event File (MEF).
      - Decoding the NotificationContentList
        The NotificationContentList is the formatted message that was delivered to an endpoint. Each message differs depending on the template used to create it.
    - Notification Data Types
      Notification messages are delivered in XML to JMS topics by the Notification Server.
  - Notification Data Relationships
    Each notification MATRIXX Data Container (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).
  - 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 more .jar and .classes 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. 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.
- 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

Notification Status Events

Configure MATRIXX Engine to generate events that indicate if notification message delivery processing succeeded or failed. If notification status events are enabled, they are included in the MATRIXX Event File (MEF).

During MATRIXX Engine configuration, configure whether notification status events are generated for notification message delivery processing and under which circumstances they are created. The notification status event, MtxNotificationDoneEvent, includes the information listed in MtxNotificationDoneEvent Fields.

Table 1. MtxNotificationDoneEvent Fields
Name	Data Type	Flags	Description
ContactUserObjectId	object id	Optional	ID of the contact user.
ErrorCode	unsigned int32	Optional	The field will be set when NotificationStatus is FAILED. 1 - 99 is reserved by engine. 100 - 199 is reserved by notification server.
Notification	MtxNotification	Optional	If configured, copy the Notification MDC to the event.
NotificationContentFlags	unsigned int32	Optional	Flags for acknowledgement content from notification server. 1 = compressed.
NotificationContentList	list of blob	Optional	Acknowledgement content from notification server. Can be compressed.
NotificationContentType	string	Optional	MIME type of acknowledgement content from notification server.
NotificationDeliveryId	string	Optional	Notification delivery ID from notification server.
NotificationId	string	Optional	Unique identifier of the notification.
NotificationStatus	unsigned int32 (enum)	Always Present	Delivery status of the notification message. succeeded (0) failed (1) filtered (2)
NotificationType	unsigned int16 (enum)	Reserved	For MATRIXX internal use only.

You can enable the following events for notification messaging delivery:

notification_failure — Events are created if notification messaging fails. A failure occurs when the retry count for delivery is reached and the message is not acknowledged.
If a notification is deleted due to delivery failure, the notification ID is logged in the MTX application log file to easily identify it in a MEF.
notification_success — Events are generated for all acknowledged notification messages.

Note: Notification events are not generated when a notification is generated or scheduled.

For information about managing events in My MATRIXX, see the discussion about event mapping in My MATRIXX Help.