Creating an attribute

To create a custom attribute:

  1. Go to Attributes (see Navigation). The list of custom attributes is displayed (see Viewing the list of attributes).
  2. Click Create. The New Attribute page is displayed.



  3. In the Name field, enter the name of the custom attribute.
  4. In the Value type list, select the type of the custom attribute:
    • String — a single-line text input.
    • Text — a multi-line text input.
    • Checkbox.
    • Date — a calendar to pick a date.
    • Password — a single-line text input that masks the content.
    • List — a dropdown list with the predefined options. 

      After selecting the List value type, the Name and the Key fields are displayed.


      To add predefined values:

      1. In the Name field, enter the predefined value name.
      2. In the Key field, enter the predefined value key.
      3. Click . The predefined value is added.
      4. Create all required predefined values.

      The list of the predefined values is displayed under the Name and the Key fields. In the dropdown list, the predefined values are shown in the same order they were created.



      To change the order of predefined values, use and buttons.

      To delete a predefined value, use the button.

      The default value can be set only for optional custom attributes.

      To set the default value:

      1. Move a predefined value to the first position in the list.
      2. Turn On the First element as default value switch.
  5. Optionally, in the Format field, enter a regular expression to validate the input values.

    The Format field is not displayed for the List type.

  6. Optionally, in the Default field, enter the predefined value of the custom attribute.

  7. In the Applied to list, select the entity type to which the attribute is applied:
    • For an Account attribute, in the Account types group, additionally select one or several account types (see Account types).
    • If an attribute is added via the account type details page, the Applied to parameter is automatically set to Account, and in the Account types group, the current account type is automatically selected. In this case, the Applied to and Account types parameters are read-only.
    • A Reseller attribute will be added to downstream resellers only. To add a new Reseller attribute to the current reseller, create it on the upstream level.
    • Account.

    • User.

    • Plan.

    • Manager.

    • Reseller.

    • Resource

  8. To make the custom attribute required, turn Off the Optional switch. By default, the Optional switch is On, and the custom attribute is optional.
  9. To make the custom attribute read-only in the Customer Control Panel after initially specifying its value, turn On the Read only for client switch.
  10. To make the custom attribute read-only in the Operator Control Panel after initially specifying its value, turn On the Read only for admin switch. In this case, an account attribute is not displayed during the account creation in the Operator Control Panel (see Creating an account) and the Customer Control Panel (see Full registration).
  11. To make the custom attribute visible only to managers in the Operator Control Panel in which this attribute was created, turn Off the Public switch. By default, the Public switch is On, and the attribute is visible to managers and accounts of the current and all downstream resellers.
  12. To allow only unique values for the custom attribute, turn On the  switch. For an account attribute, the values will be unique within every selected account type.
  13. In the Key field, enter the key used to refer to the custom attribute by API or a placeholder (see Managing event handlers).
  14. Optionally, in the Weight field, enter the number that defines the position of the custom attribute on a page. The higher is the number, the lower is the position on the page.
  15. Optionally, in the Description field, enter any additional information about the custom attribute.
  16. Optionally, in the Category list, select a category for the custom attribute (see Managing categories of attributes). 
  17. Click Create. The new custom attribute is created and displayed in the list.