Create a Template for a Custom Phone Model

For unsupported phone models from Yeastar-supported vendors, you can upload custom templates and custom the model name. This topic describes how to upload a template for a custom phone model.

A custom phone model can be set up and associated with a custom template using one of the following methods:

Set up a model based on a NovoOne built-in vendor

Prerequisites
Prepare a configuration file for your phone model.
Note:
  • The file size can NOT exceed 5 MB.
  • To correctly apply basic information of the tenant user to the model, set the following variables as the values for the corresponding fields in the configuration file.
    • {{.AccountLabel}}: The account label of the tenant user.
    • {{.AccountDisplayName}}: The full name of the tenant user.
    • {{.AccountRegistrationName}}: The registration name of the tenant user.
    • {{.AccountRegistrationExtNumber}}: The extension number of the tenant user.
    • {{.AccountRegistrationPassword}}: The registration password of the tenant user.
Procedure
  1. Log in to NovoOne Platform portal, go to Inventory > IP Phones > Resource Repository > Custom Templates.
  2. Click Add.
  3. In the Basic section, set basic information.

    Settings Instruction
    Name Enter a name to help you identify the model.
    Type Select Custom.
    Vendor Select a vendor.
    Model Enter the custom model name.

    The system will automatically add a suffix _CUST to this name to indicate it is a custom phone model.
    Source Default Template Select a template for the phone model of the same vendor.

    The system will recognize the vendor and retrieve general settings from the selected source template, ensuring your custom model inherits standard configurations.
    Configuration File Click , then select your configuration file to upload.
    Remark Optional. Enter a remark for future reference.
  4. Optional: In the Assign section, assign the resource to your tenants and your resellers.
    • Assign the resource to your tenants to enable their tenant administrators to use it.

      1. In the Assign to drop-down list, select My Tenant.
      2. Specify the tenants as needed.
        • To assign to all tenants, select All.
        • To assign to specified tenants, select Specific and select desired tenants in the Assigned Tenant drop-down list.
    • Assign the resource to your resellers to enable the resellers to use it and assign it to their tenants.
      1. In the Assign to drop-down list, select Reseller.
      2. Specify the resellers using one of the following methods.
        Method Instruction
        Assign to all resellers except selected

        1. Select All.
        2. Optional: To prevent specific resellers from using the resource, select the resellers in the Excluded Resellers drop-down list.
        3. Optional: To specify tenants whose tenant administrators can use this resource, click Add, select a reseller in the Reseller drop-down list and select the reseller's tenants in the Tenant list.

          To add more, repeat this step.
        Assign to selected resellers only

        1. Select Specific.
        2. Click Add.
        3. Select a reseller in the Reseller drop-down list.
        4. Optional: To specify tenants whose tenant administrators can use this resource, select the desired tenants in the Tenant list.

          To add more, repeat i-iv .
  5. Click Save.

Set up a model based on a custom vendor

Prerequisites
Prepare a configuration file for your phone model.
Note: The file MUST be in .zip format and can NOT exceed 5 MB. You can contact Yeastar Technical Support to obtained the configuration template.
Procedure
  1. Log in to NovoOne Platform portal, go to Inventory > IP Phones > Resource Repository > Custom Templates.
  2. Click Add.
  3. In the Basic section, set basic information.

    Settings Instruction
    Name Enter a name to help you identify the model.
    Type Select Custom.
    Vendor At the bottom of the drop-down list, enter a vendor name in the field and click Add.

    The custom vender will be automatically populated in this setting.
    Model Enter the custom model name.
    Template File Click , then select your template file to upload.
    Remark Optional. Enter a remark for future reference.
  4. In the Configuration section, customize the settings provided by the source default template as needed.
    Setting group Instruction
    Preference Modify the preference settings.
    Distinctive Ringtone Add distinctive ringtones for different incoming calls based on Alert-Info keyword.
    Codecs

    Modify codecs settings.
    LDAP Directory Modify LDAP directory settings.
    VLAN Modify VLAN settings.
  5. In the Customize Configuration Parameters in Text section, add additional parameters that are not provided by the source default template.
    Note: The variables that starts with {{. and ends with }} are associated with the settings that can be configured on Configuration sections and function key configuration page for tenant user on the NovoOne Tenant portal. Please do not edit these variables in the below boxes if you still want to use the corresponding features.
    1. In the first text box, add your configuration parameters.
      Note: Contact your vendor to make sure that the parameters are supported for the device model.
    2. In the second text box, select which function keys to be applied according to the phone model.

      You can also add your function key parameters in the second text box.

  6. Optional: In the Assign section, assign the resource to your tenants and your resellers.
    • Assign the resource to your tenants to enable their tenant administrators to use it.

      1. In the Assign to drop-down list, select My Tenant.
      2. Specify the tenants as needed.
        • To assign to all tenants, select All.
        • To assign to specified tenants, select Specific and select desired tenants in the Assigned Tenant drop-down list.
    • Assign the resource to your resellers to enable the resellers to use it and assign it to their tenants.
      1. In the Assign to drop-down list, select Reseller.
      2. Specify the resellers using one of the following methods.
        Method Instruction
        Assign to all resellers except selected

        1. Select All.
        2. Optional: To prevent specific resellers from using the resource, select the resellers in the Excluded Resellers drop-down list.
        3. Optional: To specify tenants whose tenant administrators can use this resource, click Add, select a reseller in the Reseller drop-down list and select the reseller's tenants in the Tenant list.

          To add more, repeat this step.
        Assign to selected resellers only

        1. Select Specific.
        2. Click Add.
        3. Select a reseller in the Reseller drop-down list.
        4. Optional: To specify tenants whose tenant administrators can use this resource, select the desired tenants in the Tenant list.

          To add more, repeat i-iv .
  7. Click Save.

Result

  • The custom auto provisioning template is displayed on the Custom Template list.

    You can auto provision IP phones of the corresponding models to any tenant owned by you or your resellers using the custom template. For more information about provisioning IP phones, see Auto Provision an IP Phone.

  • If you assigned the custom template to your tenants, the administrators for these tenants can auto provision IP phones of the corresponding models using the custom template.
  • If you assigned the custom template to your resellers' tenants, the template is displayed on the Custom Templates list on the resellers' NovoOne Platform portal. They can reassign and use the template as needed.