Provisioning

From MiRTA PBX documentation
Revision as of 12:29, 4 February 2021 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Provisioning of phones is phone independent, meaning MiRTA PBX has no knowledge of the various brands or models, but offers a generic framework to create a template and use some variables. Some variables are already stored in the system, but more can be added easily. Provisioning is made over HTTP and HTTPS. Obviously it is preferable to provision over HTTPS to avoid having SIP credentials to travel in clear over the Internet. Some brand of phones are quite picky about the certificate authority used for the SSL, so in case of problems, it can be good to make a test using HTTP or check the phone configuration about third party CA.

Some phone templates are provided as proof of concept, but they are not supposed to be neither complete neither accurate.

Phone Models

Several phone models can be defined. For each phone model the number of lines needs to be defined, usually with the starting and ending line number. Please refer to the phone's provisioning guide to customize or create new templates.

Phonemodes.png

A phone template can be "locked" to prevent any accidental modification. You can easily duplicate a provisioning template using the action icon on the right

For each phone you can define a generic name, an option description, the first and last account number, the mac request template, the directory request template, the remote provisioning POST message along with the credentials to use for remote provisioning. Remote provisioning is the ability of some manufacturer to deliver a phone configuration just out of the box, like Yealink RPS and Polycom ZTP.

The template may contain variables in the general format ${name|default|type|options}.

Alternatively, if you want to use | in your default value, you can use %% as separator, like ${name%%default%%type%%options}

So for example you can define the default value for the server_host variable, like:

{$server_host|demo.mirtapbx.com}

To help users in configuring their system, you can specify the editing box type, so if by default is a text type as in:

{$server_host}

Provisioning text field.png

You can use a select box as in:

{$vpk1type|0|select|Disabled=-1,Line=0,BLF=11,SpeedDial=4}

Provisioning select field.png

Or you can use a radio button as in

{$screensaver|0|radio|Disabled=0,Enabled=1}

Provisioning radio field.png

Or you can use an editable select box as in

{$vpk1description||editableselect|pickupname}

Provisioning editableselect field.png

Or you can use a multiline text box as in

{$customdata||text}

You can replace the options with three different macros:

  1. pickupextension (for picking up the extension username)
  2. pickupnumber (for picking up the extension number)
  3. pickupname (for picking up the extension name)
  4. pickupnumbername (for picking up the extension number and name)

like

{$vpk1value||select|pickupextension}

They will be expanded to the list of extensions defined in the tenant.

Provisioning select macro.png

Some variables are predefined and are read directly from the system configuration:

  • line_active – Always 1
  • displayname – Name of the Extension assigned
  • virtualdisplayname – Name of the Virtual Extension assigned
  • username – SIP username
  • authname - SIP username
  • tech - Extension Technology (SIP/PJSIP/VIRTUAL...)
  • number – Number of the Extension assigned
  • virtualnumber – Number of the Virtual Extension assigned
  • secret – Password of the Extension assigned
  • index - The position of the account starting from the first line defined
  • tenantcode - The account code for tenant
  • billingcode - The billing code for tenant
  • subscribemwi - The option configured for "Send MWI only if subscribed"
  • mailbox - The mailbox associated to the extension
  • transport - The transport used for the extension (asterisk notation: udp, tcp and tls)
  • transportY - The transport used for the extension (Yealink notation: 0 for udp, 1 for tcp and 2 for tls)
  • transportP - The transport used for the extension (Polycom notation: UDPOnly for udp, TCPOnly for tcp and TLS for tls)
  • codecs - The codecs configured for the extension (asterisk notation)
  • line – Order position of the line (usually 1, 2, 3, etc)
  • line_m1 - Order position of the line (usually 1, 2, 3, etc)
  • key - Order position of the line (usually 1, 2, 3, etc)
  • index - Order position of the line, always starting by 1
  • mac – Mac Address of the phone, without :
  • provisionpassword – Password for provisioning URL
  • stationname - The phone name
  • https_username - The username for HTTP provisioning
  • https_password - The password for HTTP provisioning
  • accept_data - The option in the phone definition
  • internalcallerid - Internal Caller ID, like "John Doe <100>"
  • now - The current date and time
  • encryption - It returns yes/no based on the encryption setting in the account
  • encryptionY - It returns 0 (no) or 2 (yes) based on the encryption setting in the account (Yealink format)


It is possible to define loops in the template using the {line_loop} and {/line_loop} keywords. Each variable used needs to be defined in the “Variables” menu. In case a variable is not defined, an alert message will be shown.

It is possible to define simple {if ...} {else} {/if} condition, even using variables, like:

{if {$line}==1}Main Line{else}Secondary Line{/if}

Any variable can be used.

Some phones, usually softphones, allow the provisioning over a QR Code. You can enter the configuration template as usual and enable the QR Code generation. A new icon will appear in the action column allowing the download/display of the QR code.

Phone Directory (Phone Books)

it is possible to create a template also for provisioning the directory on the phone, pushing one (or more) phone books data to the phone. The phone book template needs to use an {item_loop} and the values from the phonebook are returned to the phone when it asks for one of the following files:

  • MAC-directory.xml
  • MACphonebook.xml
  • (more file name types can be added)

This is an example phone directory template:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!-- $Revision: 1.2 $  $Date: 2004/12/21 18:28:05 $ -->
<directory>
        <item_list>
                {item_loop}
                <item>
                        <ln>{$LASTNAME}</ln>
                        <fn>{$FIRSTNAME}</fn>
                        <ct>{$PHONE1}</ct>
                        <sd></sd>
                        <lb>{$NAME}</lb>
                        <rt></rt>
                        <dc></dc>
                        <ad></ad>
                        <ar></ar>
                        <bw></bw>
                        <bb></bb>
                </item>
                {/item_loop}
        </item_list>
</directory>

You can use the following variables:

  • NAME - Name
  • FIRSTNAME - First Name
  • LASTNAME - Last Name
  • COMPANY - Company
  • PHONE1 - Phone
  • PHONE2 - Mobile Phone
  • PHONE3 - Additional Phone 1
  • PHONE4 - Additional Phone 2
  • PHONE5 - Additional Phone 3
  • PHONE6 - Additional Phone 4
  • PHONE7 - Additional Phone 5
  • EMAIL - Email
  • SIPADDRESS - SIP Address
  • XMPPADDRESS - XMPP Address
  • ACCOUNTNUMBER - Account Number
  • FAX - Fax

You can add more variables to use editing the table pi_phonebookitems and then enabling them in your phone book

There are some special variables:

  • {$INDEX} that contains the sequential id of your entry, so for example, starting from 0, then 1, 2, 3, 4 ...
  • {$ITEMCOUNT} returning the number of items in the phone book
  • {$MAXINDEX} containing the max INDEX reached
  • {$PHONEBOOKNAME} returning the Phone book name

You can also use {$PEID} containing the id of the Phone entry

Button layouts

It is possible to create special loops for defining button layouts. A button layout needs to be defined in the Configuration/Provisioning/Button Layouts and then referenced in the template.

Memkey1def.png

In this case a memory key with code "memkey1" has been created to match the {loop_memkey1} defined in the template

{loop_memkey1}
memorykey.{$key}.type = {$type}
memorykey.{$key}.line = {$account}
memorykey.{$key}.value = {$extension}
memorykey.{$key}.pickup_value = {$parameter}
{/loop_memkey1}

For each button layout there are some variables you can use:

  • type
  • account
  • extension
  • label
  • parameter

You are free to use any of these variables to match your phone provisioning structure or add new variables in Admin/Provisioning/Variables

Using a Button Layout template

A button layout template is a way to make it easier for the user to fill the values needed to define the button layout autoprovision values

Definebuttonlayout.png

Only the variables referenced in the template will be used (but the order is the one defined by the autoprovision variable order) and their editing can be customized using the controls already described in the phone template