CMP Custom Fields (FT-1002.008)
About this document
Scope
This document provides background information as well as a functional description of the FT-1002.008 CMP Custom Fields advanced feature. The described feature is supported from the release version 4.3.8 onward.
Note
CMP Custom Fields is an advanced feature and is enabled by Mavoco during the CSP integration and onboarding project.
This feature is part of the Account Onboarding & Provisioning functionality with number FN-1021.
Feature Availability
Feature Version | Available from | Summary of changes |
|---|---|---|
v1 | CMP Release 4.3.8 | Initial release |
Feature overview
Goals
The aim of the CMP Custom Fields feature is to allow MAVOCO, CSPs, and Accounts to define Custom Fields for all key CMP entities, such as Account or Price Plans.
Functionality of the feature
The CMP Custom Fields feature allows MAVOCO, CSPs, and Accounts to define Custom Fields for key CMP entities (Company, Account, SIM, Price Plan, etc.). Today, all Custom Fields are defined and provisioned by MAVOCO, in agreement with the CSP. Custom Fields allow to provide additional information on the respective CMP Objects.
Note that one Custom Field Type may have many look-up types depending on the Context, e.g. Account A may have different values of the same Custom Field type than Account B.
The CMP implementation of Custom Fields supports two types of Custom Fields.
System Custom Fields: Defined by MAVOCO as part of the CMP system.
CSP Custom Fields: Defined by the CSP and implemented by the CMP onboarding team for specific CSP values.
System Custom Fields are defined and delivered by MAVOCO as part of the CMP system, as part of the CMP release. System Custom Fields are required for all Custom Fields which are used in CMP code/processes, e.g. SIM Activation integration.
Display of System Custom Fields is defined through database configuration (e.g. via MAVOCO onboarding team) and not by the CSP. The following values are available for the display of System Custom Fields:
Hidden: Not displayed in any portal.
Private: Only displayed in Resource Manager/CSP Portal and/or Billing Manager (depending on the CMP Object to which the Custom Field is applied).
Public: Displayed to the Operator and Account/Customer Users in the Enterprise Portal.
By default, all System Custom Fields will be hidden.
Custom Fields have a relationship to Context, which can be used to determine which Custom Fields are available for each Account, Tenant, etc. Which System Custom Fields should be available to which context are configured during the onboarding.
Note that changes to the availability of the Custom Fields (i.e. creating/editing Custom Fields-Context relationship) are done by the MAVOCO team.