[Index]

Model: relation/GS_FAC_REL

Forced Authorization Codes

Full HTML Help

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 Customize Authorization Levels for more details.

Use this feature to manage FAC codes:

Add a FAC

  1. Navigate to the required customer or site level.

  2. From the Forced Authorization Codes form (default menu Apps Management > CUCM FAC Management > Forced Authorization Codes).

  3. Click Add.

  4. 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.

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 Customize Authorization Levels
  1. Click Save and inspect the entry in the list view.

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.
  2. Open the Forced Authorization Codes form (default menu Apps Management > CUCM FAC Management > Forced Authorization Codes)
  3. Select the check box next to the FAC instance you want to delete or click on the FAC instance you want to delete.
  4. 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 Code Cross Cluster

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

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

Model Details: relation/GS_FAC_REL

Title Description Details
Authorization Level *
  • Field Name: authorizationLevel
  • Type: Integer
  • Cardinality: [1..1]
Code *
  • Field Name: code
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 16
Name *
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
Fac Data Model
  • Field Name: facDataModel
  • Type: Object
Authorization Level
  • Field Name: facDataModel.authorizationLevel
  • Type: String
Code Code can be from 1 to 16 digits in length.
  • Field Name: facDataModel.code
  • Type: String
  • Pattern: ^[0-9]*$
Name
  • Field Name: facDataModel.name
  • Type: String
Fac Help Model
  • Field Name: facHelpModel
  • Type: Object
Name Default: default
  • Field Name: facHelpModel.name
  • Type: String
  • Default: default
Help Text
  • Field Name: facHelpModel.helpText
  • Type: String