Adding Custom Service Parameters to Service Templates
You can add a custom service parameter to a service template. In this case, Billing will display this service parameter (if you configure it as active and visible, see below) during the order placement process when the customer chooses a service plan based on this service template.
To add a custom service parameter to a service template:
- In the control panel, go to Product > Service Plans and switch to the Service Templates tab. The list of existing service templates is displayed.
- Click the name of the service template for which you want to create custom service parameters. The template General information is displayed.
- Switch to the Service Parameters tab and click Add New Parameter.
- Complete the fields:
- Parameter ID: Specify the identifier of the parameter.
- Name: Enter the parameter name, which will be displayed to the customer in UX1 for Customers or UX1 Marketplace during the order placement process.
Description: Enter a short description of the parameter.
Note: Description is not displayed during the order placement process for custom enumerated service parameters.
Value Type: Choose a data type from the drop-down list of data types. For information on how to create a custom enumerated data type, see Creating or Editing Custom Enumerated Data Types.
Note: The drop-down list contains both out-of-the-box and custom data types. For the list of custom data types only, go to System > Settings > Operations > Custom Data Types.
Validator: Using POSIX Extended Syntax, enter a regular expression to check the parameter value. For example:
Large | Medium-sized | Small
.Note: Validator is usually used for out-of-the-box service parameters only because there is no need to validate drop-down list values of a custom enumerated service parameter.
- Input Hint: Enter a text that will be shown as a hint to the customer in UX1 for Customers or UX1 Marketplace to help the customer to complete the parameter value correctly.
- Required: Select the checkbox if you want to make the parameter mandatory.
- Ask on Order placement: Select the checkbox if you want Billing to display this service parameter to the customer and ask the customer to specify its value in UX1 for Customers or UX1 Marketplace during the order placement process.
- Editable: Select the checkbox to make the parameter editable after a subscription creation.
- Click Save. You have added a custom service parameter to a service template.