Home
MATRIXX Business API SDK
Creating Extensions
You create extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
Creating Multi-Request REST Services
This section describes how to create new services that are an orderly set of atomic SubMan multi-requests.
Creating Code Generation Tags
To enable the code generation for multi-requests, you must copy the request fields into the request array and configure these requests so that they contain the correct values in each field. The following sections describe how to enable the code generation.
Defining optional_field_mappings Tags
The <optional_field_mappings/> tags include all optional fields in a request that require special handling.

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
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
- About MATRIXX Business API SDK
  MATRIXX Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.
- Business API SDK Overview
  The Business API SDK is a flexible framework that includes a set of tools to manage, customize and extend Rest Services Gateway (RS Gateway) for customer-specific business needs. Using the SDK, you can extend existing projects or create entirely new projects to add, replace, or modify services that leverage existing functionality.
- 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.
- Creating Extensions
  You create extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
  - Installing and Initializing the SDK
    Before beginning RS Gateway extension development, you must install the MATRIXX dependencies in the local Maven repository. Use the provided installation script or do it manually.
  - Creating a Project
    After you install the SDK dependencies, create a project using the MATRIXX Extension Maven archetype.
  - Defining the Extension
    Creating an extension involves multiple steps, including defining custom MATRIXX Data Containers (MDCs) from MATRIXX Engine and RS Gateway in the Extensions module MDC files, defining the REST APIs, and defining the routing rules.
  - Testing Extensions
    During extension development, test your code at different stages.
  - Deploying the Extension
    Each extension module described in the discussion about creating an extension has a JAR file which you deploy to the RS Gateway pod.
  - Creating Multi-Request REST Services
    This section describes how to create new services that are an orderly set of atomic SubMan multi-requests.
    - Defining Multi-Request Array Slots
      Each atomic operation in a multi-request service creates an object, sets a value, or appends a value in a specific slot in the multi-request array.
    - Defining Mapping Tags
      The <mapping/> tag handles multi-requests and includes an attribute id whose value represents a slot within an MtxRequestMulti object RequestList field where the mapping operation is performed.
    - Using Multi-Request Service Helpers
      Helpers are functions that create objects, set values, or append values in a specific slot in the multi-request array.
    - Defining the Request and Response MDCs
      The <request/> within a multi-request service should be the name of a custom MATRIXX Data Container (MDC) that holds all input for the multi-request. The <response/> within a multi-request service should be the name of acustom MATRIXX Data Container (MDC) that holds all output for the multi-request.
    - Creating Code Generation Tags
      To enable the code generation for multi-requests, you must copy the request fields into the request array and configure these requests so that they contain the correct values in each field. The following sections describe how to enable the code generation.
      - Defining multi_request Tags
        The <multi_request/> code generation tag groups together all processing for handling multi-request and multi-response services.
      - Defining missing_fields Tags
        The <missing_fields>...</missing_fields> tags define the error codes and result text that are returned if any of the required fields are missing in the request _glossary/mdc.html.
      - Defining request_copy Tags
        The <request_copy>...</request_copy> tags cause the subscriber field from the request object to be copied into the MultiRequest message RequestList field.
      - Defining request_create Tags
        The <request_create>...</request_create> tags create new instances of defined MATRIXX Data Containers (MDCs).
      - Defining response_copy Tags
        The <response_copy>...</response_copy> tags copy the specified slot of the MtxResponseMulti.ResponseList field into the specified field of the response message for this service.
      - Defining optional_field_mappings Tags
        The <optional_field_mappings/> tags include all optional fields in a request that require special handling.
    - Example Custom Multi-Request REST Service
      This example shows a custom multi-request service with a request and response. It creates a user, a subscription, and a device and purchases offers atomically. Additionally, it can provision group tiers.
  - Example Offer Purchase Extension Project
    This section describes a project that creates a custom RS Gateway call that enhances offer purchasing. The project defines a custom offer purchase URL with a custom payload which returns balance impacts.
  - Example REST Tax Service
    This section describes a project that implements a tax service.
- Creating Custom Filters
  You can create a custom filter by creating a named filter or a filter class. A named filter is useful for simple filters while a filter class should be used for complex filters (for example, when the returned results must be modified).
- Upgrading the Business API SDK
  When you upgrade the MATRIXX software, you must upgrade the Business API SDK as it is possible that files have changed or have been deprecated. Use the manage_integration_project.py script to remove the current release from your project directory structure and upgrade to the latest release. You should do this even if your files are not checked into Subversion.
- Appendixes
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Defining optional_field_mappings Tags

The <optional_field_mappings/> tags include all optional fields in a request that require special handling.

Each combination of optional fields is added in the <fields_present/> tags. Each <fields_present id="x">...</fields_present> set of tags represents mutually exclusive cases of fields that are present. The attribute that holds the list of fields is id="x". The x value is a set of defined field names (for example, GroupBA GroupRA SubscriberOfferPurchase are field names in the request MATRIXX Data Container (MDC).

This tag checks if the set of fields specified by the id attribute exist. If all fields listed in this attribute exist, then the code generation within these tags is performed and option field mapping code generation ends.

Replace x with the set of field names from the request MDC that trigger the selection of the steps listed within the <fields_present/> tags.

The order of the statements is the order in which the conditions are evaluated.