Home
MATRIXX TM Forum Integration
TMF Gateway
MATRIXX TM Forum Open API Gateway (TMF Gateway) implements the set of TMF microservice APIs supported by MATRIXX.

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
- About MATRIXX TM Forum Integration
  MATRIXX TM Forum Integration describes the tasks required for integrating TM Forum (TMF) APIs with MATRIXX and provides overviews, recommendations, and conceptual discussions to help you understand these tasks.
- TMF Gateway
  MATRIXX TM Forum Open API Gateway (TMF Gateway) implements the set of TMF microservice APIs supported by MATRIXX.
  - Sub-Domain Routing
    TMF Gateway supports routing requests to specific sub-domains.
  - TMF Security
    TMF Gateway supports HTTP authentication through a configurable authorization URL.
- Installing TM Forum Microservices
  Install the TM Forum (TMF) microservices in a cloud native environment.
- Mapping TMF APIs to MDCs
  TM Forum (TMF) microservices map TMF API data to custom MATRIXX Data Container (MDC) extensions, where each custom field has the same name and field type as the TMF API field that maps to it.
- TMF632 Party Management API
  The TMF party management API supported by MATRIXX provides a standardized mechanism for party management for creating, updating, retrieving, and deleting individual and organization information.
- TMF635 Usage Management API
  The TMF635 usage management API supported by MATRIXX provides a standardized mechanism for creating, updating, retrieving, importing, and exporting a collection of usages.
- TMF640 Service Activation and Configuration API
  The TMF640 service activation and configuration API supported by MATRIXX provides a standardized mechanism for configuring and activating subscription services.
- TMF677 Usage Consumption Management API
  The TMF677 usage consumption management API supported by MATRIXX provides a standardized mechanism for retrieving usage consumption data associated with a subscription.
- TMF Customized Microservices using TMF Builder
  MATRIXX provides a continuous integration and continuous deployment (CI/CD) pipeline to deliver custom TM Forum (TMF) microservices using the MATRIXX TMF Integration Builder.
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

TMF Gateway

MATRIXX TM Forum Open API Gateway (TMF Gateway) implements the set of TMF microservice APIs supported by MATRIXX.

TMF Gateway is implemented in a cloud native environment and provides TMF microservices that have been generated using a Vert.x code generator from the TMF OpenAPI Swagger specification.

Telco operators with TMF-compliant systems can integrate with the TMF microservices, thereby helping to reduce integration costs and speed up project implementation.

MATRIXX TMF microservices include support for the following TMF Open APIs:

TMF632 Party Management API — This API provides a standardized mechanism for creating, updating, retrieving, and deleting individual and organization information. The TMF data is stored in the MATRIXX database in a custom extension to the MtxUserExtension MATRIXX Data Container (MDC).
TMF635 Usage Management API — This API provides a standardized mechanism for creating, updating, retrieving, importing, and exporting a collection of usages.
TMF640 Service Activation and Configuration API — This API provides a standardized mechanism for configuring and activating subscription services.
TMF677 Usage Consumption Management API — This API provides a standardized mechanism for retrieving usage consumption data associated with a subscription.

TMF Gateway has the following features:

Implements TMF microservices for handling inbound TMF-format requests and translation to the required MATRIXX format.
Maps requests and responses between TMF and MATRIXX formats.
Conforms to TMF standards and guidance, including:
- Domain and URI naming.
- HTTP headers, verbs, and associated resource patterns.
- Response codes, attribute selection, and filtering.
Routes traffic using the Traffic Routing Agent (TRA).

Figure 1 shows the TMF microservices architecture.

Shows the connections between TMF APIs and MATRIXX Engine — Figure 1. TMF Microservice Architecture

Customization

If required, you can customize your TMF microservice to extend the TMF data handled by the service. For information and help with TMF customization, contact your support representative.