Product type parameters

A product type parameter is a piece of information that a client provides to activate a service. For example, it can be a domain name for a shared hosting service.  The values of every parameter are sent to a processing module that identifies it by its internal name. 

Some services cannot be created unless you specify certain parameters. You can make them mandatory for customers:  

• Optional parameter — a client may not enter it. A standard value will be applied for a service.  
• Mandatory parameter — a client cannot order a service without specifying such parameters.  A processing module doesn't have a default value for it or the value must be unique.  

Configuring product type parameters

Go to Products → Product types → choose product type → Parameters → Add:

• Note:

  
  

1. Name; 
2. Internal name  — name of the parameter to identify it in the list of processing modules. Name should:
   • be unique;
   • consist of Latin characters;
   • not contain spaces, special characters (except for underscores);
   • not start with a number.
     Note:

     The internal name of the parameter must not match the built-in internal names. Verify this using the API request:

     API request

     <BILLmanager address>? billmgr? func = <internal product type name> & out = xml

     Explanations

      <BILLmanager address> — enter the address of your BILLmanager

     <internal name of product type> — specify the internal name to be checked
     

     If a verifiable internal name is found in the response to the request, use a different name.

3. Allow connecting to tariff plans — parameter activation method for every tariff plan:
   • The option is disabled — this parameter will be active for all tariff plans with this product type; 
   • The option is enabled — this parameter will be disabled for all tariff plans with this product type.  Activate it in Products → Product types → Parameters → Tariff plans. 
4. Show during order — select the checkbox to show this parameter on a service order form; 
5. Show during activation — select the checkbox to show this parameter on a service activation task if the manual processing is enabled; 
6. Show in list — select the checkbox to show this parameter in a list of services of this product type: Products/Services → <A product type name>. 
7. Read/Edit permissions — a minimum user role that a user must have to be able to read/edit this parameter:
   • client;
   • staff member;
   • superuser.
8. Call the handler when parameters are changed — when this parameter is changed in Products/Services → <A product type name> → Edit the corresponding processing module with the setparam command will be called;
9. Input field type —  if you select a "List" or "Multiple selection list", set the values in Products → Product types → Parameters → Values. For more information please refer to the article Parameter values; 
10. Required parameter — indicates that a client must enter this parameter. This field is not displayed if you have selected a "Checkbox"; 
11. Hint — a hint to a field that appears, when you hover over a question symbol in the BILLmanager interface;
12. Copyable — activate the option to display the Copy button next to the value of the field.
13. Encrypt — select the checkbox if you want to save this parameter in an encrypted way; 
14. Sort  — order of parameters on a service order/edit form;