.. _pbr_flowcharts:

.. .. rst-class:: chapter-with-expand


Phone Based Registration
-------------------------------------


High level flow
...............

.. uml::
 
   @startuml
   !include style.iuml

   :[[../src/user/reference-pbr-flowchart.html#pbr-installation PBR Installation]];
   :[[../src/user/reference-pbr-flowchart.html#pbr-voss-setup PBR Setup]];
   :[[../src/user/reference-pbr-flowchart.html#pbr-voss-configure PBR Config (per customer)]];
   :[[../src/user/reference-pbr-flowchart.html#pbr-register-phone Register a Phone]];
   note right
     On the device
   end note
   @enduml


|menu_book32x24.png| Documentation: :ref:`intro-PBR`


.. _pbr-installation:

PBR Installation
........................

.. uml::
 
   @startuml
   !include style.iuml
   start
   :Check install and start;
   note right
     Check with **app status**:
     ""phone-based-registration"" service should be running.
     Otherwise, read Install Web Service document.
   end note
   :Network Connectivity;
   note right
     Ports: auto-registered phones connect to
     VOSS-4-UC Proxy and Unified nodes
   end note
   :Certificates for HTTPS;
   note right
     Details in Pre-Requisites documentation
   end note
   :Menu Layouts and Access Profiles;
   note right
     Details in documentation
   end note
   :Restricted API admin user and role;
   note right
     * User: **pbr_api_user**
     * Role: **PBR_RestrictedAPIAccess**
     * Details in documentation
   end note
   @enduml


|menu_book32x24.png| Documentation: 

* :ref:`prereq-PBR`
* :ref:`install-web-service-PBR`
* :ref:`expose-access-PBR`
* :ref:`create-restricted-API-role-user`
* :ref:`PBR-menu-layout-access-profiles`



.. _pbr-voss-setup:

PBR Setup
........................

.. uml::
 
   @startuml
   !include style.iuml
   start
   if (Autoreg already configured on Unified CM?) then (No)
    :PBR Setup on VOSS-4-UC;
     note left
       VOSS recommends the initial
       autoreg config on Unified CM
       be with PBR Setup
     end note
   else (Yes)
    :Customize autoreg config on Unified CM;
   endif
   if (Configure PBR for a customer?) then (Yes)
    :[[../src/user/reference-pbr-flowchart.html#pbr-voss-configure PBR Config (per customer)]];
   else (No)
   endif
   stop
   @enduml


|menu_book32x24.png| Documentation: :ref:`setup-CUCM-for-PBR`

* When customizing Auto Registration on Unified CM, also refer :ref:`setup-CUCM-for-PBR`.

|youtube.png| `PBR Setup <https://www.youtube.com/embed/NgcPvBTS7pw>`_

.. raw:: html

   <iframe width="560" height="315" src="//www.youtube.com/embed/NgcPvBTS7pw" frameborder="0" allowfullscreen></iframe>


.. _pbr-voss-configure:

PBR Config (per customer)
..........................

.. uml::
 
   @startuml
   !include style.iuml
   start

   :Default config at provider hierarchy;
   note right
     The **config at the provider level** enables
     the PBR web service to make
     the initial connection to VOSS-4-UC API.
   end note
   :PBR Config at customer hierarchy;   
   note right
     The **config at customer level** defines
     the specific connection parameters
     for that customer.
   end note
   :BAT Prefix Required;
   note right
     Recommended so as not to replace a phone
     that is in active use.
   end note
   :Consider - PBR Device Record Required;
   :Consider - Pin Required;
   note right
    If a single PIN per site is required or not
   end note
   :Complete the portal, hierarchy and IP options;
   note right
    * **Auto Provision PBR** device record should not be selected.
    * **Default PIN** should not be selected.
    * **BAT DeviceName Format** should be left to default.
   end note
   stop
   @enduml


|menu_book32x24.png| Documentation: :ref:`configure-PBR-add-on`

|youtube.png| `PBR Configuration <https://www.youtube.com/embed/69g0MP9YbEU>`_

.. raw:: html

   <iframe width="560" height="315" src="//www.youtube.com/embed/69g0MP9YbEU" frameborder="0" allowfullscreen></iframe>



.. _pbr-register-phone:

Register a Phone
....................


.. uml::
 
   @startuml
   !include style.iuml
   start
   :Access the Phone Services Menu;
   note right
     On the device
   end note
   :Select Register Phone menu;
   :Enter extension and PIN (if required);
   :Submit request;
   stop
   @enduml


|menu_book32x24.png| Documentation: :ref:`detail-PBR-steps`

|youtube.png| `Register a Phone <https://www.youtube.com/embed/JcrCgsjP9VM>`_

.. raw:: html

   <iframe width="560" height="315" src="//www.youtube.com/embed/JcrCgsjP9VM" frameborder="0" allowfullscreen></iframe>



.. |menu_book32x24.png| image:: /src/images/menu_book32x24.png
.. |playcircle24x23.png| image:: /src/images/playcircle24x23.png
.. |youtube.png| image:: /src/images/youtube.png