Home
MATRIXX 5G Integration
MATRIXX SBA Gateway
This section describes the Service Based Architecture (SBA) Gateway, which provides the framework to build 5G network function (NF) services based on 3GPP technical specifications.
Configuring SBA Gateway
SBA Gateway is configured as 5G network functions in several ways.
Response Generator
Response Generator is functionality used by Backstop Processing and Rating Bypass functionality to generate a custom response.
Extracting Fields
Each Response Generator handler defines the fields that it extracts from the incoming message. The values of these fields, either the raw value and type or a conversion, are used to examine the message. This conversion is performed by the FieldValueMapper of the dynamic message mapper.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
- About MATRIXX 5G Integration
  MATRIXX 5G Integration describes how to implement the Service-Based Architecture (SBA) Gateway and messaging. In addition, this document provides information about security configuration (secured and not secured).
- MATRIXX SBA Gateway
  This section describes the Service Based Architecture (SBA) Gateway, which provides the framework to build 5G network function (NF) services based on 3GPP technical specifications.
  - MATRIXX SBA Gateway Overview
    SBA Gateway converts incoming 5G JSON messages to MATRIXX Data Containers (MDCs) and forwards these requests to the Traffic Routing Agent (TRA), which routes them to the correct sub-domain on MATRIXX Engine. Outgoing messages are converted from MDCs to 5G JSON messages.
  - Installing SBA Gateway
    This section describes installing SBA Gateway in hybrid deployments and installing CHF within an Istio service mesh.
  - Upgrading SBA Gateway
    When upgrading to a new version of SBA Gateway, there are several things you must consider to ensure the upgrade is successful and the correct configuration is applied.
  - Viewing the SBA Gateway Version
    You can use version, revision, and timestamp data to check which version of SBA Gateway is running.
  - Configuring SBA Gateway
    SBA Gateway is configured as 5G network functions in several ways.
    - Creating a CHF Configuration Source
      The Charging Function (CHF) configuration source template has files that can be used to create an image for configuring the CHF network function as a docker type configuration source.
    - Defining the Common SBA Gateway Configuration
      The common SBA Gateway configuration, provided by the SBA library, defines a default configuration that is shared by every network function.
    - Configuring SBA Gateway Properties
      SBA Gateway network functions are configured using environment variables or by editing the configuration in the nf.yaml file for the network function.
    - Configuring CHF
      The CHF configuration overrides some properties defined in gateway.yaml but only for this particular network function (CHF).
    - Configure an SBA Gateway HTTP/2 Connection to Traffic Routing Agent
      Configure an HTTP/2 connection with Traffic Routing Agent (TRA-RT/DR) using the SBA Gateway sub-chart of the main MATRIXX Helm chart.
    - MDC Handlers
      CHF configuration supports the definition of MATRIXX Data Container (MDC) handlers that process the messages received by one or more network function endpoints. These handlers convert JSON messages to MDCs before sending them to MATRIXX Engine. The response is converted from MDC format back to JSON and returned to the endpoint.
    - Configuring Multiple Sub-Domains
      In an environment with multiple sub-domains, incoming traffic is directed to the correct sub-domain by the Traffic Routing Agent (TRA) positioned in the topology between the SBA Gateway (CHF) and MATRIXX Engine.
    - Mapping JSON Messages to MDCs
      SBA Gateway uses OpenAPI (Swagger) specifications to check the format of incoming JSON requests. After validation, these JSON messages are mapped to _glossary/mdc.html structures using the Dynamic Message Mapper. This uses Mapping configuration files to map fields in the incoming JSON request to and from MDCs before sending them to and from MATRIXX Engine.
    - Routing SBA 5G Requests
      The TRA-RT requires that any MATRIXX Data Containers (MDCs) submitted have sub-domain routing information provided in the MtxMsg.TrafficRouteData field.
    - Network Function Endpoints
      Network function endpoints define the URLs and HTTP methods that they accept. Optionally, they can also check HTTP headers, path variables, or query parameters.
    - NRF Client Load and Capacity Reporting
      The NRF Client can report load and capacity values to the NRF.
    - Overriding nfProfile Fields
      A common requirement is having a common nfProfile for all environments where a few values can be overridden for each environment. This can be achieved using the global variables section of the common configuration.
    - Backstop Processing
      Backstop Processing is functionality that returns a positive message when downstream components are not available.
    - Rating Bypass
      You can configure business logic in the SBA Gateway Charging Function (CHF) to filter charging requests and spending limit requests that should not be sent to the Charging Server for rating.
    - Response Generator
      Response Generator is functionality used by Backstop Processing and Rating Bypass functionality to generate a custom response.
      - Network Function Endpoint Handlers
        Charging Function (CHF) implementations define multiple network function endpoints to associate with one or more handlers. To use Response Generator, a Response Generator handler must be defined and associated with one or more endpoints. This allows the URLs that use Response Generator to be configurable. This also means that different Response Generator configurations are applied to different URLs. Only one Response Generator can be associated with a single endpoint.
      - Extracting Fields
        Each Response Generator handler defines the fields that it extracts from the incoming message. The values of these fields, either the raw value and type or a conversion, are used to examine the message. This conversion is performed by the FieldValueMapper of the dynamic message mapper.
      - Field Mapping
      - Rule Sets
        Extracted fields are evaluated according to rules. Each set of rules is a target profile that is used if a match is found. Only the profile of the first matching rule set is used. You can rank rule sets to control the order in which they are tested if multiple matches are found. Higher ranked rule sets are executed first.
      - Profiles
        A profile references multiple structures and the positions at which they are applied in the response message. A maximum of one profile is selected and applied to each message.
      - Structures
        A structure is a static JSON object whose values are applied to the response message at a given point. A profile defines one or more structures to apply. They are defined outside of the handlers section, allowing them to be reused by multiple Response Generator handlers.
      - Response Generator Example Configuration
        This example configuration shows one Response Generator handler. The Response Generator configuration is also shown to show that the handler name matches:
    - Spending Limit Notification Error Processing
      When MATRIXX Engine receives an unsuccessful Mtx5GSpendingLimitResponse, the session is retained or ended based on a configuration table in mtx_config.xml.
    - ActiveMQ Gateway Configuration
      MATRIXX Engine uses ActiveMQ to produce outbound 5G Notify requests for SBA Gateway and to consume their inbound responses.
    - Customize 5G Messages
      In MATRIXX, you can extend the 5G request and response messages beyond the options specified in the 3GPP specification.
  - Monitoring and Logging
    You administer the SBA Gateway by configuring its logging and monitoring features. For more information about monitoring SBA Gateway administration tasks, see the discussions about monitoring SBA Gateway and configuring the SNMP Prometheus adapter in MATRIXX Monitoring and Logging.
  - Creating a Mapping Configuration
    The following documentation provides information about how to create a mapping configuration. For a list of 5G message mappings from MATRIXX Data Container (MDCs) to OpenAPI supported by MATRIXX, see the discussion about MATRIXX 5G message mapping.
  - Security
    SBA Gateway supports HTTP BASIC authentication and TLS Mutual Authentication.
  - API for 5G Integration
    The URI, mapping, and OpenAPI specification are configurable, and only the HTTP method and mapping filename are not.
  - Throttling
    SBA Gateway can be throttled to protect the platform from overload conditions.
  - Connecting to Multiple Networks with Multus
    Depending on requirements, SBA Gateway might require a dedicated connection to the 5G network separate from its connection to other MATRIXX components.
  - MATRIXX 5G Message Mapping
    The following sections describe the default configuration for SBA Gateway-supported 5G message mapping. Topics in the following sections describe the mappings from MATRIXX Data Container (MDC) format to OpenAPI format for each 3GPP 5G version.
- Charging Function
  This section describes the Charging Function components and how to deploy and configure them.
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

Extracting Fields

Each Response Generator handler defines the fields that it extracts from the incoming message. The values of these fields, either the raw value and type or a conversion, are used to examine the message. This conversion is performed by the FieldValueMapper of the dynamic message mapper.

Field Extraction Properties describes the configuration properties available when extracting fields:

Table 1. Field Extraction Properties
Properties	Description	Example Value
responseGenerator.handlers.`handler_name`.fields.`field_name`.path	The path at which the field value is read, in the format as used by the dynamic message mapper field mappings. Important: This path must represent a single value in the message. It must not be a part of a repeating structure where more than one value might be extracted.	`ChargingDataRequest. sMSChargingInformation.userEquipmentInfo`
responseGenerator.handlers.`handler_name`.fields.`field_name`.type	The data type to map to, such as integer. By default, all values are mapped to strings. Both fully qualified java types and aliases are supported.	integer
responseGenerator.handlers.`handler_name`.fields.`field_name`.mapperName	The name of a preconfigured `FieldValueMapper`. Note: The `mapperName` and `mapperClass` properties are mutually exclusive.	`dayOfWeek`
responseGenerator.handlers.`handler_name`.fields.`field_name`.mapperClass	The fully qualified class name of a `FieldValueMapper`. Note: The `mapperName` and `mapperClass` properties are mutually exclusive.	`com.matrixx.mapping.field. RegexMapBasedFieldValueMapper`
responseGenerator.handlers.`handler_name`.fields.`field_name`.mapperParameters	Parameters used when initializing the `mapperClass`. These typically represent setters on this class of type string. The exception to this is for the map and regex map. Note: Only specify the `mapperParamters` property when the `mapperClass` property is set.	`mapperParameters: "^ABC[0-9]{3}$": Consumer "^XYZ[0-9]{3}$": IOT "^[a-z,A-Z,0-9]*$": Unknown`

Data Types and Aliases list the data types and corresponding aliases that can be specified with the responseGenerator.handlers.handler_name.fields.field_name.type property:

Table 2. Data Types and Aliases
DataType	Alias(es)
`java.lang.String`	`string`
`java.lang.Integer`	`int` or `integer`
`java.lang.Long`	`long`
`java.lang.Float`	`float`
`java.lang.Double`	`double`
`java.time.instant`	`instant`
`java.util.Date`	`date`
`java.lang.Boolean`	`bool` or `boolean`