Global Settings#

Overview#

Administrators (Provider level and up) may configure global settings for customizations that apply at a specific hierarchy only or across all hierarchies in the system.

This topic describes the global settings, which you can access via (default menu) Customizations > Global Settings.

On each tabbed page in Global Settings, a read-only field below the choice drop-down displays the current setting for your system. Options are:

Inherit

The service is enabled/disabled based on the setting at the hierarchy above the current one.

Yes

The service is enabled at the current hierarchy.

No

The service is disabled at the current hierarchy.

To change inherited settings, see Change Inherited Settings.

You can select the following tabs on the Global Settings page:

  • Number Inventory

  • Number Inventory Alerting

  • Webex App

  • Pexip Conference

  • Email

  • Phones

  • Voicemail

  • User

  • Flow Through Provisioning

  • Enabled Services

Number Inventory Tab#

The table describes the global settings for the Number Inventory:

Field

Description

Enforce HCS Dialplan Rules

When enabled, dial plan workflows enforce HCS Rules when provisioning Customers, Countries, Site and so on. Default = Inherit.

If your deployment uses a custom or specific dial plan that does not conform to the HCS rules, this setting should be set to No (False).

Include the Number Inventory description in all number drop-downs

Defines whether descriptions for the numbers (which can be added when the number inventory is managed via the Number Management menu), display along with the numbers in the drop-down lists. For example, let’s say you have a number and its description as follows: 1000 - CEO Internal. When this setting is enabled (Yes), both the number (1000) and its description displays in the lists (when using features such as Quick Add Subscriber).

The default is No.

Include the Number Inventory vendor in all number dropdowns

Defines whether vendor names for the numbers show in number dropdown as an option.

For example, a number 982017206 (which is from Microsoft vendor) will display as 982017206 [Microsoft] in the drop-down list.

Include the Number Inventory type in all number dropdowns

Defines whether number types for the numbers show in number drop-down as an option.

For example, a number 982017206 (which is from Microsoft vendor and is of type OperatorConnect will display as 982017206 [OperatorConnect] in the drop-down list.

Enable Number Inventory Cooling

Defines the availability of numbers in the system when a phone, subscriber, or service associated with the number is deleted, and the number is no longer associated with these entities. Options are:

  • Inherit:

    When set to True, number inventory cooling is enabled or disabled based on the setting defined for number inventory cooling at a higher level in the hierarchy.

  • Yes (True)

    Enabled at the current hierarchy. Numbers associated with deleted entities are kept in a cooled state for a specified number of days (based on the value defined in the Number Inventory Cooling Duration (Days) field.

    Numbers in a cooled state are unavailable in the system until the cooling period end date is reached, unless they are manually released before the “end cooling period” end date.

  • False (No)

    Default. Number inventory cooling is disabled by default.

Number Inventory Cooling Duration (Days)

When number inventory cooling is enabled (Yes/True), this field defines the period (number of days) the number is kept in a cooled state and unavailable for association with a phone user, or service.

The default is 30 days.

Related Topics

Number Inventory Alerting Tab#

This tab configures the global settings for number inventory alerting, which defines how alerts may be raised once the number inventory is running low.

The table describes the settings on this tab:

Field

Description

Enable Alert on Available Numbers

By default, this setting is set to Inherit. However, it will not inherit the setting from higher up the tree unless it is explicitly set to Yes or No. Inherit in this instance just means it is not configured. Change to Yes to enable alerting.

Alert Aggregate Level

Choose a hierarchy level at which the aggregate of available numbers should be calculated (Provider, Reseller, Customer, Site), and displayed in the body of the alert.

The shown data in the body for this hierarchy level is:

  • Hierarchy node name

  • Hierarchy node type

  • Hierarchy full path

  • Total numbers available

  • Total numbers

  • Total percent available

Data is also included for lower hierarchies (as tables and in CSV format). For details, see the following topics:

  • Email in the Core Feature Guide

  • Number Inventory Alerts in the Core Feature Guide

Availability Threshold Percentage

Select or enter a percentage available of the total numbers at which point alerts will be raised. Sample percentages are available to choose from. If available numbers drop below this percentage, alerts will be raised.

Enable Email Group

Set to Yes to send email alert notifications to an email group. The email group needs to be available or should be set up.

Alert Email Group

If Enable Email Group is set to Yes, select the email group.

Ignore Hierarchies With No Numbers

If set to Yes, hierarchy levels with no numbers are excluded from reports.

Note

The email alert message also includes an attachment file NumberThreshold.csv, which contains the alert report in CSV format. See: Email HTML Templates.

Related Topics

Webex App Tab#

This tab configures the global settings for Webex App.

The table describes the fields on this tab:

Field

Description

Retain a Webex App User when a Subscriber is deleted

Defines whether to delete Webex App user when a subscriber is deleted. Default is No.

Send notification when the Webex App Refresh Token expires

Defines whether a notification is sent when the Webex App refresh token expires for a specified customer. A SNMP trap and Webex App message is sent to recipients configured in the email group.

Webex App Refresh Token expires threshold (in seconds)

The max threshold (in seconds) for when to send a SNMP trap to the SNMP (if Send SNMP trap message when the Webex App Refresh Token expires is enabled). The default is 172800 seconds, which is two days.

Automatically apply default calling behavior on Webex App user data sync

Whether to apply default calling behavior (set up in Customer settings), to new Webex App users synced in to VOSS Automate. Default is No.

Generate and send Webex App User CSV file via Webex App message

Whether to generate a CSV file on create/update of Webex App user. Default is No. If enabled (Yes), the CSV file is sent via Webex App to a predefined list of recipients.

Email group containing recipients of the generated Webex App user CSV file

The group of recipients of the Webex App message with the generated CSV file. The email group is set up on the Email Groups menu.

Send manual Webex App Workspace configuration steps via Webex App message

Whether manual configuration steps (on Webex App Control Hub) are to be sent on create/update of a Webex App workspace. Default is No. If enabled, the steps are sent via a Webex App message.

Email group containing recipients of the manual Control Hub steps

Email group recipients of the Webex App message containing the manual configuration steps.

Quick Add Group for Hybrid Calling Workspace Unified CM users

The Quick Add Group to use when creating dummy CUCM users with line and device for Webex App workspace hybrid calling.

Related Topics

Pexip Conference#

This tab configures the global settings for Pexip Conference.

The table describes the settings on this page:

Field

Description

Retain a Pexip Conference when a Subscriber is deleted

Defines whether the Pexip conference set up from the subscriber interface is to be removed when the subscriber is deleted. By default the setting is inherited from the hierarchy level directly above the current one.

Email Tab#

This tab configures the global settings for Email.

The table describes the settings on this page:

Field

Description

Allow welcome email to be sent to user after Quick Add Subscriber

Defines whether an email is sent to a user when added via Quick Add Subscriber. The default is No.

When set to Yes, and a SMTP server is set up (via the Apps Management menu), then selecting the option to send an email when using Quick Add Subscriber, a welcome email is sent to the new subscriber.

Related Topics

Phones Tab#

This tab configures the global settings of phones for a site.

Note

These settings only apply to phones within the same site; both the re-added phone and the existing phone must be on the same site.

The table describes the phone global settings on this tab:

Field

Description

Delete existing Unassigned Phone when re-adding an identical phone

Defines whether to delete an existing, unassigned phone (a phone without an owner), when re-adding a phone with the same name and product type (duplicate phone).

Default is Inherit (No, inherited from the hierarchy above), which triggers a transaction failure if you try adding a duplicate phone, for example, in a QuickAddSubscriber bulk load or when updating a subscriber.

When set to Yes, a system check verifies whether the phone exists and/or if it is already assigned (whether ownerUserName field is populated):

  • If the phone exists and is assigned to a different subscriber, the transaction fails.

  • If the phone exists and is unassigned, the existing phone is deleted, the phone is re-added, and is assigned to the subscriber you’re adding or updating.

  • If the phone exists and is already assigned to the subscriber you’re working with. The system performs an update.

Retain Desk Phones when Subscriber is deleted

Defines whether a subscriber’s associated desk (hard) phones (phones prefixed with SEP or BAP) are deleted or retained when that subscriber is deleted.

When set to Yes:

  • The deleted subscriber’s hard phones are retained.

  • The deleted subscriber’s soft phones (such as Jabber devices) are deleted.

  • An additional field displays (Update the Retained Desk Phone with Configuration Template), which allows you to define whether retained phones are updated via a CFT once the subscriber is deleted.

Default is Inherit (set to No).

This setting defines hard phone delete/retain behavior for any method of deleting a subscriber, for example, delete subscriber via the Subscribers list view, or delete subscriber in LDAP import, purge or sync (where delete or purge mode is automatic).

You can view the hard phones associated with the subscriber on the Phones tab in Subscriber settings.

Update the Retained Desk Phone with Configuration Template

This field displays only when Retain Desk Phones when Subscriber is deleted is set to Yes (True).

Defines whether to update retained hard phones via a configuration template (CFT) when the associated subscriber is deleted.

This feature ships with a default CFT (RemoveOwnerFromPhoneCFT), which clears the phone’s Owner User ID if the phone is retained when deleting the associated subscriber. You can choose a different CFT for the update step, if required.

Field

Description

Include additional information in Phone dropdowns

Options are Yes, No, Inherit. Default is Inherit (inherited from the hierarchy above)

Set to Yes to enable. You will need to save this update then refresh the tab to display an additional configuration field (Additional information in Phone dropdowns).

Additional information in Phone dropdowns

Options are Yes, No, Inherit. Default is Inherit.

Additional information options are Description, First Line, and Description + First Line.

The default, Description, means that the phone description (if defined) displays in the phone selection drop-downs on the Replace Phone configuration screen (Existing Phone tab, Device Name drop-down), and on the Quick Add Subscriber screen, allowing you to search by phone description when choosing a phone from the drop-down.

In the same way, when the additional information option is set to either First Line or Description + First Line, you can search for or choose phones based on this criteria.

Related Topics

Voicemail Tab#

This tab configures the global settings for voicemail.

The table describes the settings on this tab:

Field

Description

Retain a (Cisco) Voicemail Account when a Subscriber is deleted.

Defines whether to retain a Cisco (CUCM) subscriber’s voicemail account when the subscriber is deleted. Default is Yes (true). When set to Yes, the CUCM user’s voicemail account is retained when the user is deleted and user sync is executed.

User Tab#

This tab configures the global settings for users.

Note

When a user is either synced into or added manually on VOSS Automate, these settings apply by default. The settings can however be modified when adding a user from the User Management menu.

The table describes the settings on this tab:

Field

Description

User Default Auth Method

The default authentication method to use when a user is synced in or added manually.

The default is Local (inherited).

Map UPN from CUCM User Identity

Maps the Microsoft Azure UserPrincipalName (UPN) attribute to CUCM userIdentity attribute - used in Cisco-Microsoft hybrid configurations where the same user ID is on every user account (MS Teams, CUCM, etc.).

If enabled, the CUCM user’s userIdentity attribute is used for the import of MS teams CsOnlineUser and MS 365 Msol user instances.

The default is No (inherited).

Update Username during datasync

Defines whether to update the existing VOSS username when a new associated user is imported via a sync.

Disallowed CUCM User Groups

Defines the user groups (one or more) that admins will not be allowed to assign to subscribers.

This is to prevent subscribers being incorrectly assigned elevated permissions to system resources that are reserved for users in the groups you specify here.

Fill out the user group names in a colon-separated format, for example, Standard CUCM SuperUser:MyGroupName

Related Topics

Flow Through Provisioning Tab#

This tab defines global settings for sync with flow through provisioning.

The table describes the settings on this tab:

Field

Description

Enable Move & Flow Through Provisioning

Defines whether move and flow through provisioning is enabled. The default is No.

Enable Move & Provisioning after Add Sync

Defines whether move and flow through provisioning on add sync is enabled. The default is No.

Flow Through Provisioning Criteria

Defines the default flow through provisioning criteria applied to a user to create the subscriber at the site and to assign services.

Related Topics

Enabled Services Tab#

This tab defines the global settings for enabling/disabling services for different vendors, such as Cisco or Microsoft. Options are Inherit, or Yes/No (True/False).

When provisioning services from two or more vendors, the global setting is the first of a number of system verification checks. For example, when the Enable Cisco CUCM global setting is set to Yes (enabled), the administrator can provision a subscriber with new CUCM services (such as a Cisco phone, Jabber, and extension mobility), only if the CUCM device check (server installed), entitlement profile check, and field display policy check all pass the verification check. In the same way, if for example, the Enable Microsoft global setting is set to No (disabled), and all other checks are set to enabled, existing Microsoft services can be viewed but new Microsoft services cannot be provisioned.

Note

By default, for new installs, the global setting for the following services are inherited from higher levels in the hierarchy (Inherit set to True/enabled):

  • Cisco CUCM

  • Cisco CUCX

  • Cisco WebEx

  • Cisco Webex App

  • Cisco CCX

When upgrading to a version of the system that allows multi vendor and hybrid subscribers, the default setting for services other than these 5 services is Inherit (False).

To provision services to new subscribers (added after an upgrade), you will need to enable the vendor service in global settings.

The table describes services that can be enabled/disabled on this tab:

Setting

Description

Enable Cisco CUCM

Enables/disables Cisco CUCM services. The default is Yes.

When set to Yes, allows an admin user to provision a subscriber with new CUCM services, such as a Cisco phone, Jabber, and Extension Mobility, provided the server is installed, and the entitlement profile and field display policy pass a verification check.

Enable Cisco CUCX

Enables Cisco CUCX (Unity) services. The default is Yes.

Enable Cisco WebEx

Enables/disables Cisco WebEx services. The default is No.

Enable Cisco Webex App (Teams)

Enables/disables Cisco WebEx App (Teams) services. The default is No.

Enable Cisco UCCX

Enables/disables Cisco UCCX (Contact Center Express) services. The default is No.

Enable Cisco Broadworks

Enables/disables Cisco Broadworks services. The default is No.

Enable Microsoft

When enabled, allows provisioning of Microsoft services. The default is No.

Enable Avaya

Enables/disables Avaya services. The default is No.

Enable Pexip

Enables/disables Pexip services. The default is No.

Enable Zoom

Enables/disables Zoom services. The default is No.

Enable Cisco/Microsoft Hybrid

Enables/disables Cisco/Microsoft hybrid services. The default is No.

When enabled, VOSS Automate allows for provisioning users and services from both Cisco and Microsoft devices, and makes available an admin user parent menu called Hybrid Cisco-Microsoft Management, and associated access profiles. For details, see Hybrid Cisco-Microsoft Management in the Core Feature Guide.

Enable Avaya/Microsoft Hybrid

Enables/disables Avaya/Microsoft hybrid services. The default is No.

Enable Cisco Webex Contact Center

Enables/disables Cisco Webex Contact Center services. The default is No.

Enable Cisco UCCE

Enables/disables Cisco UCCE services. The default is No.

Enable VOSS Phones

Enables/disables VOSS phones services. The default is No.

Enable Session Border Controller

Enables/disables Session Border Controller services. The default is No.

Related Topics

General Settings Tab#

This tab defines general global settings to manage system behavior.

The table describes services that can be enabled/disabled on this tab:

Setting

Description

Quick Add Group lookup level

Specifies the hierarchy level up to which Quick Add Groups will be searched for. The default is Provider level. (sys and hcs levels are not available.)

When a lookup level is set, selections of available QAGs will be restricted upwards to this lookup level.

Change Inherited Settings#

  • For numeric inherited values, for example, for “Number Inventory Cooling Duration (Days)” or “Webex App Refresh Token expires threshold (in seconds)”), you can overwrite the word “Inherit” with the required value, for example, 45, and save your changes. If the inherited value is already overwritten, for example, the value is already 45, then overwrite this value with the new value.

  • For inherited values that are Yes/No (True/False), select an alternative from the drop-down (either Yes, No, or Inherit). This may change the current value.