CSP Portal Custom GUI Fields (FT-1021.003)
About this document
Scope
This document provides background information as well as a functional description of the CSP Portal Custom GUI Fields (FT-1021.003) advanced feature. The described feature is supported from the release version 5.0 onward.
Note
CSP Portal Custom GUI Fields is an advanced feature and can be configured by MAVOCO only. Ensure that you have agreed with Mavoco about the usage of this feature before taking it into use.
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 5.0 | Initial release |
Benefits
We understand that each CSP has different needs when managing their business and customers. At the same time, the CMP GUI needs to be as easy to use for the CSP’s employees. This is why we provide the flexibility to each CSP to choose which attributes in the GUI are meant to be pre-filled, pre-selected, or mandatory,so that they completely support the business.
Feature overview
Goals
The aim of the CSP Portal Custom GUI Fields feature is to enable the CSP Portal to enforce one or many attributes in the GUI to be mandatory, pre-filled, or pre-selected for Accounts, Companies and Price Plans.
Out of scope
Any other GUI, except CSP Portal GUI
Enforcing any CSP-Portal Customized Attributes via API
Enable CSP Portal to remove any existing (i.e., pre-defined) mandatory fields
Functionality of the feature
CSPs require certain fields at Accounts, Companies, and Price Plans to be mandatory, pre-filled, or pre-selected to support numerous integration flows, that require those fields to be populated in order, for example, to create the Account at the remote CRM system. CMP offers a system called Customized Attributes to meet this requirement.
Customized Attributes allow connecting specific additional rules to existing attributes in any screen of the CSP Portal for Account, Company and Price Plan, if required. The following customization rules are available.
Mandatory | Indicates if the field is mandatory (in case it is not already mandatory as of standard CMP implementation). |
Unique | Indicates if the field has to be unique along all records in CMP at the same resource. |
Default Value | Indicates the default value of the field, which is filled in/pre-selected on new object creation. |
Read-Only | Indicates if the field is read-only and can’t be changed by the User. |
Placeholder | Indicates the placeholder text of the field in the GUI. |
Read-Only Status | Indicates if the field is read-only at a specific resource status only (in case it is not already read-only in that status as of standard CMP implementation). |
Regular Expression | Indicates if the field validation pattern (text and numeric fields only) gets overruled by the given regular expression. |
IMPORTANT
This optional extension to existing attributes does not overrule any existing implementation on any attribute within CMP. Attributes can never be downgraded (i.e., become non-mandatory in case they are mandatory as of the standard CMP implementation) because of a Customized Attribute configuration.
For example, if CMP enforces an attribute to be mandatory (e.g., the Account Name) and this attribute would be marked as non-mandatory from the Customized Attributes, the field would still stay as mandatory.
Customized Attributes are implemented “on-top” as an additional validation on storing or modifying the related record via GUI only and have no dependency on any other trigger, process, API, or flow. Therefore, using the (exposed) API directly will not enforce any of the Customized Attribute configuration.