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.
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.
Miscellaneous SBA Gateway Properties
gateways/r_5g_config_misc.html#ugy_4fc_f5b__table_mrd_pxb_f5b describes miscellaneous properties for configuring SBA Gateway.

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.
      - SBA Gateway Properties
        gateways/r_5g_config_gateway.html#reference_nnf_s41_f5b__table_ims_541_f5b describes the properties for basic SBA Gateway configuration.
      - Unrated Message Handling Properties
        gateways/r_5g_config_unrated_kafka.html#reference_yhw_lpt_55b__table_o5b_spt_55b describes the properties available for sending unrated messages to a Kafka topic.
      - Security Properties
        gateways/r_5g_config_security.html#uwc_r51_f5b__table_ims_541_f5b describes the properties for SBA Gateway security configuration.
      - Groovy-Related Properties
        gateways/r_5g_config_groovy.html#php_qv1_f5b__table_ims_541_f5b describes the properties for SBA Gateway security configuration.
      - 5G 3GPP Specification and Mapping Properties
        gateways/r_5g_config_mapping.html#c2t_3y1_f5b__table_ims_541_f5b describes the properties for SBA Gateway 5G 3GPP specification and mapping configuration.
      - Prometheus Monitoring Properties
        gateways/r_5g_config_monitoring.html#kl5_mz1_f5b__table_ims_541_f5b describes the properties for configuring SBA Gateway monitoring with Prometheus.
      - External Connection Properties
        gateways/r_5g_config_external.html#t1r_w1b_f5b__table_ims_541_f5b describes the properties for configuring SBA Gateway external connections for Kafka.
      - HTTP Client Properties
        gateways/r_5g_config_httpclient.html#ojv_24b_f5b__table_ims_541_f5b describes the properties for configuring SBA Gateway HTTP Client maximums and timeouts.
      - Temporary HTTP Redirection on Error
        If MATRIXX Engine or the Traffic Routing Agent (TRA-PROC) are unavailable, an HTTP 503 (Service Unavailable) error is returned by default. The CHF can be configured to return an HTTP 307 Temporary Redirect to the client (NF), containing a location header with the address of an alternative CHF.
      - Throttling and Timeout Properties
        gateways/r_5g_config_timeout_throt.html#uxs_qsb_f5b__table_ims_541_f5b describes the properties for configuring SBA Gateway throttling and timeouts.
      - MATRIXX Engine Connection Properties
        gateways/r_5g_config_engine.html#k1n_r5b_f5b__table_ims_541_f5b describes the properties for configuring SBA Gateway connections to MATRIXX Engine.
      - SBA Gateway Variable Properties
        gateways/r_5g_config_vars.html#xpc_xwb_f5b__table_mrd_pxb_f5b describes the properties for configuring SBA Gateway variables.
      - Network Function Registration Properties
        gateways/r_5g_config_nrf.html#asv_hyb_f5b__table_mrd_pxb_f5b describes the properties for configuring SBA Gateway network function registration with a Network Repository Function (NRF).
      - Service Communication Proxy Properties
        gateways/r_5g_config_scp.html#cfy_3bc_f5b__table_mrd_pxb_f5b describes the properties for configuring SBA Gateway for use with a Service Communication Proxy (SCP) to process Converged Charging and Spending Limit Control messages.
      - Backstop Processing Properties
        gateways/r_5g_config_backstop.html#x5x_3cc_f5b__table_mrd_pxb_f5b describes the properties for configuring SBA Gateway Backstop Processing.
      - Response Generator Properties
        gateways/r_5g_response_generator.html#x5x_3cc_f5b__table_mrd_pxb_f5b describes the properties for configuring the SBA Gateway Response Generator.
      - Scaling Properties
        gateways/r_5g_config_scaling.html#ym4_w2c_f5b__table_mrd_pxb_f5b describes the properties for configuring SBA Gateway scaling.
      - Distributed Tracing Properties
        gateways/r_5g_config_tracing.html#reference_djl_bhv_q5b__table_rw4_vjv_q5b describes the properties for configuring SBA Gateway distributed tracing.
      - Miscellaneous SBA Gateway Properties
        gateways/r_5g_config_misc.html#ugy_4fc_f5b__table_mrd_pxb_f5b describes miscellaneous properties for configuring SBA Gateway.
    - 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.
    - 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

Miscellaneous SBA Gateway Properties

Miscellaneous Configuration Properties describes miscellaneous properties for configuring SBA Gateway.

Table 1. Miscellaneous Configuration Properties
Property	Description
gateway.debug.jsonPrettyPrintHttpBody	When set to `true`, JSON pretty-printing is applied to the HTTP body for debug output. The default value is `true`.
gateway.errors	The definition of application errors and the fields that make up the `ProblemDetails` message returned. For default definitions see the discussion about common CHF configuration.
gateway.redirectOnError.enabled	When `true`, an HTTP 307 is returned on an error with an alternate CHF specified in the location header. This is triggered for outage related errors by default. The default value is `false`.
gateway.redirectOnError.locationHeaderTemplate	A template for creation of the location header. The default value is the following: `https://alternative-chf${originalPath}`
gateway.redirectOnError.errors	List of errors to which a redirect to an alternate CHF is added. The default list is the following: `- SERVICE_UNAVAILABLE - NF_CONGESTION - INSUFFICIENT_RESOURCES - NF_CONGESTION_RISK`
jms.enabled	Enables Java Message Service (JMS).
notificationAlarm.errorHttpResponseCodes	The HTTP status codes that trigger logging notification. the default list is the following: `- 400 #Bad Request - 401 #Unauthorized - 403 #Forbidden - 404 #Not Found - 411 #Length Required - 413 #Payload Too Large - 429 #Too Many Requests - 500 #Internal Server Error - 503 #Service Unavailable`