Home
MATRIXX Integration
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.
Selective Update Operations
Operations are listed after all selection key clauses and determine what to do with the result of the action and method: copy the MDC field value, set it, modify it, or delete it. The operations are performed in the order they are specified.
Decode Operations
Decode operations decode input field values and set the decoded output field values. For example, an encoded MccMnc value can be decoded as two separate field values, Mcc and Mnc.

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.
  - Selection Keys
    Selection keys are composed of one or more clauses that define the operation to perform in a selective update.
  - Optional Masks
    Optional masks can be used in addition to a method. The mask is added to the specified method as an and operation and the mask result is used in the operation. If an optional mask is not specified, the field_value element is used as-is.
  - Selective Update Operations
    Operations are listed after all selection key clauses and determine what to do with the result of the action and method: copy the MDC field value, set it, modify it, or delete it. The operations are performed in the order they are specified.
    - Calculate Field Operations
      Calculate field operations use simple equations to do mathematical functions on one or more fields.
    - Concatenate Field Operations
      Concatenate field operations concatenate a STRING or BLOB field value to another STRING or BLOB field.
    - Copy Field Operations
      Copy field operations copy one field value to a different field.
    - Delete Field Operations
      Delete field operations delete an MDC field.
    - Hash Operations
      Hash operations convert free-form ASCII string or blob fields to a fixed length data chunk, which can be saved in any one of the numerical fields: [U]INT 8, 16, 32, or 64. The length of the hash output depends on the destination field.
    - Modify Field Operations
      Modify field operations modify a field value using regular expressions.
    - Set Field Operations
      Set field operations set a field to a specific value. If the field is a list, the operation appends the specified value to the end of the list.
    - Decode Operations
      Decode operations decode input field values and set the decoded output field values. For example, an encoded MccMnc value can be decoded as two separate field values, Mcc and Mnc.
      - decode_3gpp_access_network_info
        The decode_3gpp_access_network_info operation decodes the Access-Network-Information AVP value as defined in RFC-7315 and 3GPP TS 24.229.
      - decode_3gpp_mcc_mnc
        The decode_3gpp_mcc_mnc operation decodes MCC-MNC encoded data as defined in the 29.060 3GPP specification.
      - decode_3gpp_user_location_info
        Two decode operations decode User-Location-Info encoded data.
      - decode_ascii_string
        The decode_ascii_string operation decodes the field's value as a base 10 number encoded as an ASCII string and stores the result in the specified field.
      - decode_bcd_string
        The decode_bcd_string operations decodes the field's value as a binary-encoded-decimal number and stores the result in the specified field.
      - decode_bcd_nro_string
        The decode_bcd_nro_string operation decodes the field's value as a binary-encoded-decimal (nibbles are in reverse order) number and stores the result in the specified field.
      - decode_hex_string
        The decode_hex_string operation decodes the field's value as a base 16 number encoded as a string of hex digits and stores the result in the specified field.
      - decode_hex_ascii_string
        The decode_hex_ascii_string operation decodes the field's value as a base 16 number encoded as an ASCII string and stores the result in the specified field.
      - decode_diameter_address
        The decode_diameter_address operation decodes the Diameter Address data type as defined in RFC 6733.
      - decode_octet_string
        The decode_octet_string operation decodes a STRING or a BLOB field into other values based upon different encoding schemes.
      - decode_tbcd_string
        The decode_tbcd_string operation decodes the field's value as a base 10 number encoded as an telephony binary-encoded-decimal and stores the result in the specified field. The telephony binary-encoded-decimal is defined according to 3GPP TS 09.20 or ETSI TS 100 974.
    - Encode Operations
      Encode operations set a string or blob field from a numeric field and encode it as the specified decimal or hexadecimal value. For example, the string 1234 can be encoded as the binary coded decimal value 0x1234.
  - Specifying MDC Field Keys
    Several pricing configuration items have definitions that include MATRIXX Data Containers (MDCs) and MDC field names, such as normalizer template fields, event field mappings, and so forth. When specifying an MDC name in the edit field for any of these configuration items, you can begin typing an MDC name or MDC field name and a drop-down menu of all valid MDC containers available to the component that you are creating appears. After specifying an MDC name, you can specify an MDC field name in the drop-down menu in the field value field. Available fields are determined by the selected MDC.
  - Selective Update Examples
    The following examples demonstrate selective update configuration values set when running the system configuration script create_config.py.
  - Test Selective Updates
    Use the selective_update_test_app utility to test your selective updates.
- 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

Decode Operations

Decode operations decode input field values and set the decoded output field values. For example, an encoded MccMnc value can be decoded as two separate field values, Mcc and Mnc.

Decode operations must be specified using a MATRIXX Data Container (MDC) field with a specific input suffix. The output fields are created by replacing the input suffix with corresponding predefined output suffixes. The details are described in each decode operation.

When invalid or unexpected AVP values are received, the following apply:

The event never fails.
The decoder attempts to decode the fields which can result in all, some, or no fields being decoded. The result depends on the AVP data that is received.