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 a Project
After you install the SDK dependencies, create a project using the MATRIXX Extension Maven archetype.
Create a Project Manually
Use native Maven commands to create a project using the Maven archetype.

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.
    - Create a Project Using a Script
      After installing the dependencies, you must create the extension project using the Maven archetype.
    - Create a Project Manually
      Use native Maven commands to create a project using the 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.
  - 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

Create a Project Manually

Use native Maven commands to create a project using the Maven archetype.

About this task

Only complete this task if you did not create the project using the management script as described in the previous task.

Procedure

Create a project using the following command, where matrixx_release_version is the MATRIXX release version and project_name is the name of your project.

mvn archetype:generate -DarchetypeGroupId=com.matrixx.java -DarchetypeArtifactId=extension-archetype -DarchetypeVersion=matrixx_release_version -DartifactId=project_name

For example:

mvn archetype:generate -DarchetypeGroupId=com.matrixx.java -DarchetypeArtifactId=extension-archetype -DarchetypeVersion=5120 -DartifactId=MyProject

When prompted, answer the following questions.
- Please enter the Matrixx release version [versionNumber]:
- Define value for property 'groupId':
- Define value for property 'version' 1.0-SNAPSHOT:
The versionNumber is the MATRIXX release version. The groupId uniquely identifies your project across all projects. A group ID should follow Java's package name rules. See the Maven documentation for more information. The version is a unique version number used to identify the project for distribution purposes. Accept the default or use a value other than 1.

Results

When project creation completes, you should see a "BUILD SUCCESS" notification.

A new project named project is created in the /projects directory in the directory where you ran the command. In addition, the /projects includes directories for the Extensions module (/extensions) and the RS Gateway Extension module (/rsgwextension).