Home
MATRIXX Web App Administration
Configuring My MATRIXX
Configure My MATRIXX by configuring properties, setting up a pricing repository, configuring authentication, and importing or exporting third-party pricing data.
Importing and Exporting Third-Party Data
This section provides information about how to import pricing data into My MATRIXX and export the data into third-party software applications.
My MATRIXX REST APIs
My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
Catalog Item REST Bindings
The REST bindings described in this section operate on catalog items in My 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
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
- About MATRIXX Web App Administration
  MATRIXX Web App Administration describes the tasks required to install and administer MATRIXX web apps as containers, using Docker and Kubernetes.
- MATRIXX Web Apps
  MATRIXX includes the following MATRIXX web apps.
- Configuring MATRIXX Gateways and Web Apps
  In a non-containerized installation of MATRIXX, configure MATRIXX gateways and web apps using files in the /opt/mtx/conf directory in the pod(s) hosting those components. In a cloud native deployment, configuration files can be provided in the /opt/mtx/conf directory of the component container(s) using the following methods:
- Configuring My MATRIXX
  Configure My MATRIXX by configuring properties, setting up a pricing repository, configuring authentication, and importing or exporting third-party pricing data.
  - Configure My MATRIXX Properties
    Perform this task to give My MATRIXX access to database schema extensions for validation purposes, define the location of the master data directory and the logging directory, and to define the number of pricing revisions to compile into a pricing XML configuration file.
  - Setting Up a Pricing Repository
    MATRIXX uses the Apache™ Subversion™ source control system to maintain all pricing files contained in a pricing repository. The pricing repository is comprised of one or more independent pricing domains, each of which contains the files that make up a pricing plan for that domain. The pricing repository holds all the versions of files from all the pricing domains managed by an instance of My MATRIXX.
  - Lock a Pricing Compilation by Default
    Pricing compilations created in My MATRIXX can be configured to be locked by default by defining the lockPriceCompilation property in the matrixx.yaml file. Locked pricing compilations cannot be deleted even if they are not in use. If the lockPriceCompilation property is not added to the matrixx.yaml file, then pricing compilations are unlocked by default.
  - Disable Schema Validation for Deployments
    Before deployment, the system and provider schema versions of pricing and tax compilations are validated against the system and provider schema versions of the engine on which these compilations are being deployed. This validation can be disabled by setting the pricingDeployment and taxDeployment properties in the matrixx.yaml file to false. Validation is enabled by default.
  - Configuring the Pricing Controller
    Before performing price compilation tasks in My MATRIXX, configure the _glossary/pricing_controller.html, which is responsible for retrieving an engine status, transmitting a pricing compilation to an engine, and loading a pricing compilation onto an engine. The configuration is done through the Pricing Controller Helm sub-chart. For more information, see MATRIXX Configuration.
  - Configure My MATRIXX Session Timeout
    You can configure the period of session inactivity after which a user is logged out of My MATRIXX.
  - Configuring the My MATRIXX Security Warning Message
    My MATRIXX administrators can enable and customize a security warning message that displays when logging into My MATRIXX by adjusting the settings in their Helm values file as follows:
  - My MATRIXX Connection Properties
    config/r_mm_config_properties.html#reference_bbm_ndg_zwb__table_wrb_fdd_mhb lists the connection properties for My MATRIXX.
  - Importing and Exporting Third-Party Data
    This section provides information about how to import pricing data into My MATRIXX and export the data into third-party software applications.
    - Supported Pricing Objects and Flows
      My MATRIXX supports many different types of MATRIXX pricing components (objects) that are stored as individual XML files in the file system. The data format stored for these objects occasionally changes. To provide a stable API, while still allowing the format to change, MATRIXX Engine uses named flows, where each flow is a set of XSLT transformations.
    - My MATRIXX REST APIs
      My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
      - List Queries
        List queries return information about service types, normalizers, product offers, price components, and rate tables.
      - Catalog Item REST Bindings
        The REST bindings described in this section operate on catalog items in My MATRIXX.
        Listing All Catalog Item Templates
        subman_apis/r_rest_catalog_items_list_templates.html#reference_gt3_n5f_jxb__table_0AD1FDE640954939816E9ED124A32491 shows the REST binding to get a list of all catalog item templates.
        Listing all Catalog Items
        subman_apis/r_rest_catalog_items_list.html#reference_pd4_x5f_jxb__table_15803C3427694E5F851E00AAAEFC7E862 shows the REST binding to get a list of catalog items. The response includes all catalog item parameters, including those that are the result of default binding.
        Getting a Catalog Item by ID and Revision
        shows the REST binding to get a specific catalog item revision using the CatalogItemId and its revision number.
        Creating a Catalog Item from a Template
        subman_apis/r_rest_catalog_items_create.html#reference_hqy_bvf_jxb__table_B9B63D699652431A9E4006B62EC60EE9 shows the REST binding to create a new catalog item from an offer or bundle template. You must specify the template ID and version number.
        Creating a New Revision of a Catalog Item
        subman_apis/r_rest_catalog_items_new_revision.html#reference_ubg_jtf_jxb__table_267147FC17EC4513970C853FF00D9513 shows the REST binding to create a new revision of a catalog item using the latest revision as the basis for the new revision.
        Creating a Revision of a Catalog Item from a Revision
        subman_apis/r_rest_catalog_items_creating_revision.html#reference_csw_svf_jxb__table_051635CBD2424B35AC1C5542147471D9 shows the REST binding to create a new revision of a catalog item from a specific revision.
        Updating a Catalog Item
        subman_apis/r_rest_catalog_items_updating.html#reference_rxj_4vf_jxb__table_F67FF0B6657A4DCD83C12F1BA157C5CB shows the REST binding to update a catalog item using the CatalogItemId and its revision number.
        Adding Eligibility Features and Rules
        You can add eligibility rules and features when creating a catalog item using the My MATRIXX APIs.
      - Matrix REST Bindings
        The Matrix REST bindings create and update rate tables.
      - Normalizer REST Bindings
        The normalizer REST bindings get, create, and update normalizers.
      - Product Offer REST Bindings
        The product offer REST bindings create new product offers, return information about existing product offers, and update existing product offers.
      - Price Component REST Bindings
        The price component REST bindings create new price components, return information about existing price components, and update existing price components. Price components are always based on usage.
      - Service Type Beats
        Use the service type REST binding to query a service type definition and the beats defined for it.
    - Price Control REST Bindings
      The HTTP Price Controller service enables the price control REST APIs. Use these APIs to automate pricing file management and loading.
- Configuring MATRIXX Backoffice Customer Tool
  MATRIXX Backoffice Customer Tool can be deployed on the local host or a remote system that communicates with MATRIXX Engine through Gateway Proxy and RS Gateway.
- Troubleshooting
  This section has information to help identify and resolve web app issues.
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

Catalog Item REST Bindings

The REST bindings described in this section operate on catalog items in My MATRIXX.

Note: When the MtxDisplay metadata attribute is set to hidden for a catalog item in My MATRIXX, queries do not return information for that catalog item.