.. _fac-code-management-voss:

Using VOSS Automate to Manage Forced Authorization Code (FAC)
------------------------------------------------------------------

Overview 
.........

The VOSS Automate FAC management feature and workflows push any added FAC codes to all
the clusters at that hierarchy (e.g. all clusters at a customer). This means for
deployments where consistent FAC codes are being used, these don't need to be
managed per cluster by administrators.

The same applies for the delete FAC code scenario where you have the choice to
remove it from a single cluster or all the clusters at that hierarchy level.

There is also a sync capability in the event that a new cluster is added and the
existing codes needs to be pushed to the new cluster. This mode can be used for
single cluster environments as well if needed.  

The ability to define the relevant FAC code authorization levels and provide text
naming for them helps to provide appropriate business context to the level for
administrators.

By default VOSS Automate includes all the levels for use, however you can adjust these
to your needs. For example, you can configure FAC so that only five levels are
shown and they have the correct naming convention, e.g. 6 - International. See
:ref:`forced-authorization-levels` for more details.

Use this feature to manage FAC codes:

* Add a code to all clusters - browse to the level you want the code added. Use
  the view to enter the details for the code - the list of authorization levels
  is driven by the setup above. Click **Add**. This adds the FAC code to any
  cluster at that hierarchy level - so if there are three clusters at level, the
  code will be added to all three clusters.
  
  If the hierarchy only has a single cluster or is not a multi-cluster environment,
  then the code is only added to the single cluster.
* Add a code to only a single cluster.
* Update a code - open, edit and save- this will change the code on all clusters.
* Remove a code - from a single cluster or across all clusters.


.. _add-fac:
  
Add a FAC
..........

1. Navigate to the required customer or site level.
#. From the **Forced Authorization Codes** form (default menu **Apps Management >
   CUCM FAC Management > Forced Authorization Codes**).
#. Click **Add**.
#. Complete the following mandatory settings (see form **Help notes** for
   additional information):
   
   A Provider Admin can customize the form help by cloning, editing and saving
   the help text on the **Customize Help** form to a lower hierarchy level.
   
.. tabularcolumns:: |p{3.5cm}|p{12cm}|

+--------------------------+-------------------------------------------------+
| Field Name               | Description                                     |
+==========================+=================================================+
| Name*                    | A unique name describing the FAC code, e.g.     |
|                          | Customer code + Subscriber UserID.              |
|                          |                                                 |
|                          | This name ties the authorization code to a      |
|                          | specific user or group of users; and displays   |
|                          | in the CDRs for calls that use this code.       |
|                          | 50 characters maximum.                          |
+--------------------------+-------------------------------------------------+
| Authorization Level*     | Select the authorization level in the range     |
|                          | of 0 to 255. This can include a description     |
|                          | after a delimiter, e.g. 1-international [1]_.   |
|                          |                                                 |
|                          | The drop-down contains all authorization levels |
|                          | that have been cloned to this hierarchy level.  |
|                          | If none have been cloned, then the list displays|
|                          | the default auth levels 0-255.                  |
|                          |                                                 |
|                          | To successfully route a call, the user's        |
|                          | Authorization Level must be equal to or greater |
|                          | than the Authorization Level set on the Route   |
|                          | Pattern.                                        |
+--------------------------+-------------------------------------------------+
| Code*                    | Enter a unique authorization code. The user     |
|                          | enters this code when placing a call through    |
|                          | a FAC-enabled route pattern. 16 digits maximum. |
+--------------------------+-------------------------------------------------+

.. [1] See :ref:`forced-authorization-levels`

 
5. Click **Save** and inspect the entry in the list view.


.. _delete-fac:
  
Delete a FAC
...............

When deleting FAC codes, all codes are listed for each Unified CM cluster. This
allows the deletion of a code on a single cluster, even if it was added at customer
level to multiple clusters.

1. Browse to the required customer or site hierarchy.
#. Open the **Forced Authorization Codes** form (default menu **Apps Management >
   CUCM FAC Management > Forced Authorization Codes**)
#. Select the check box next to the FAC instance you want to delete or click on
   the FAC instance you want to delete.
#. Click **Delete** and then click **Yes** to confirm deletion.  

.. note::

   All instances of a FAC can also be deleted (across all clusters) by selecting
   the instance on the list view, and then clicking **Delete All Instances** on
   the button bar.


.. _sync-fac:
  
Sync FAC Code Cross Cluster
..............................

**All codes** can be synced across **all clusters** at the customer hierarchy.

1. Browse to the required customer hierarchy.
#. Open the **Sync FAC Codes Cross Clusters** form (default menu **Apps Management > 
   CUCM FAC Management > Sync FAC Codes Cross Clusters**).
#. Choose **Confirm**. 
#. Click **Save**.