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.
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.
Output Parameters
To produce output parameters from the mapping, you must add a top-level element in your mapping configuration called outputParameters.

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.
  - 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.
    - Source Message
      The mapping configuration describes source message, based on the type and root message name.
    - Target Message
      The mapping configuration describes the target message, based on the type and root message name.
    - Validation
      You can configure the behavior of the validation performed by the Dynamic Message Mapper. The validation can be completely disabled, which improves system performance. Validation can also be done in an advisory fashion (using failOnIssue: false).
    - Field Mapping
      The Dynamic Message Mapper uses the fieldMappings attribute to define the mappings. Underneath this is a map representing the target message structure. For each leaf field, the Dynamic Message Mapper can specify a string value, which is a path to the source message field that is placed in this field.
    - Subtypes
      In certain scenarios it might help to use a more specific object type. For example, you can extend an existing MATRIXX Data Container (MDC) with extra attributes as needed for your deployment.
    - Field Value Mappers
      When setting values on the target message from the source message, it might be necessary to perform type conversion. Multiple included FieldValueMapper types can perform this conversion (for example, converting a string to an integer).
    - Input Parameters
      You can reference an input parameter instead of a field from the source message. If this is necessary, you can do so using the following syntax.
    - Output Parameters
      To produce output parameters from the mapping, you must add a top-level element in your mapping configuration called outputParameters.
    - Environment Variables
      The Dynamic Message Mapper can reference environment variables when setting the default values for fields or output parameters by using the #env prefix.
    - Mapping Post Processing
      The mapping works by using a single source message field value and specifying what to do with it. This approach does not work with multiple fields, such as the concatenation of two fields, or either A or B.
    - Groovy Mapping Post Processors
      One of the main goals of the Dynamic Message Mapper is to allow reconfiguration after deployment without rebuilding anything. Although the Java post processor allows you to add functionality after deployment, it requires some building.
    - Using MappingPostProcessor to Modify ResultCode Values
      You can use pricing specific denial codes returned by MATRIXX Engine after a ChargingDataRequest to alter the individual ResultCode in the multipleUnitInformation array.
  - 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

Output Parameters

To produce output parameters from the mapping, you must add a top-level element in your mapping configuration called outputParameters.

This is a map where the key is the name of the parameter and the value is the instructions for how the parameter must be populated. This structure is like how target fields are mapped. By default, they allow you to just specify the name of the source message field as a string.

This example shows a use of output parameter mappings:

outputParameters:
  firstOutputParameter: "ChargingDataRequest.multipleUnitUsage.ratingGroup"

As with the field mapping, you can also specify a more complex object, which has more attributes, such as:

Name of the field value mapper to use during type conversion.
Default value to use if the mapping does not take place.
Parameter type.

This example shows a more complex use of output parameter mappings:

outputParameters:
  firstOutputParameter: "ChargingDataRequest.multipleUnitUsage.ratingGroup"
  secondOutputParameter: {from: "ChargingDataRequest.pDUSessionChargingInformation.pduSessionInformation.ratType", fieldValueMapperName: "rattype", default: 4}
  thirdOutputParameter: {from: "ChargingDataRequest.multipleUnitUsage.ratingGroup", type: "bigdecimal", default: "0"}

Like field mappings, the default value does not go through any custom field value mapper defined. The value is mapped directly from string to the output parameter type. This is also a string, unless specified using the type attribute.