.. _quick-add-group-functions:

Quick add group functions
--------------------------

.. _21.4-PB4|EKB-16760: 
.. _24.1-PB2|EKB-21316:

.. index:: Macro function;fn.get_qag_choices

* *fn.get_qag_choices*: Used to filter Quick Add Groups (QAGs).
  
  0, 1 or 2 parameters are available
  
  0: Return all QAGs up and down from the global setting lookup level
  (highest level configuration: Provider). Refer to the entry for
  **Quick Add Group & User Profile lookup level** in the Global Settings topic of
  the Core Feature Guide.
  
  1: specify the vendor to filter QAG's by 
  (valid options: ``cisco``, ``webexapp``, ``microsoft``)
  This parameter is applied for Quick Add Group selection in the
  portal for the following:

  * Cisco Quick User
  * WebexApp Quick User
  * Microsoft Quick User


  .. note::

     * Cisco Quick Add User can be used for adding Cisco UCM-based services, including Webex, where the 
       user requires UCM calling.
     * Webex Quick User can be used for adding Webex services where Cisco UCM calling is not required. 
       This may be free calling or Webex Calling services.



  
  2: integer value to specify the number of QAGs to return   



Examples:


.. tabularcolumns:: |p{8cm}|p{7cm}|

+--------------------------------------+-----------------------------------------------------+
|  Example                             | Output                                              |
+======================================+=====================================================+
| ::                                   | ::                                                  |
|                                      |                                                     |
|    {{ fn.get_qag_choices }}          |                                                     |
|                                      |    [{                                               |
|                                      |       "title": "IMS-integrated Mobile (Basic)",     |
|                                      |       "value": "IMS-integrated Mobile (Basic)"      |
|                                      |     },                                              |
|                                      |     {                                               |
|                                      |       "title": "default",                           |
|                                      |       "value": "default"                            |
|                                      |     },                                              |
|                                      |     {                                               |
|                                      |       "title": "Generic Single Screen Room System", |
|                                      |       "value": "Generic Single Screen Room System"  |
|                                      |     },                                              |
|                                      |    ...                                              |
+--------------------------------------+-----------------------------------------------------+
| ::                                   | ::                                                  |
|                                      |                                                     |
|    {{ fn.get_qag_choices cisco }}    |                                                     |
|                                      |    [{                                               |
|                                      |       "title": "Cisco DX80 Phone Type",             |
|                                      |       "value": "Cisco DX80 Phone Type"              |
|                                      |     },                                              |
|                                      |     {                                               |
|                                      |       "title": "Cisco E20 Phone Type",              |
|                                      |       "value": "Cisco E20 Phone Type"               |
|                                      |     },                                              |
|                                      |     {                                               |
|                                      |       "title": "Cisco 3905 Phone Type",             |
|                                      |       "value": "Cisco 3905 Phone Type"              |
|                                      |     },                                              |
|                                      |    ...                                              |
+--------------------------------------+-----------------------------------------------------+
| ::                                   | ::                                                  |
|                                      |                                                     |
|    {{ fn.get_qag_choices cisco, 1 }} |                                                     |
|                                      |    [{                                               |
|                                      |       "title": "Cisco DX80 Phone Type",             |
|                                      |       "value": "Cisco DX80 Phone Type"              |
|                                      |     }]                                              |
+--------------------------------------+-----------------------------------------------------+