.. _modify_site_defaults:
Site Defaults
--------------
.. _18.2|VOSSSOL-7876:
.. _12.5(1)|VOSSSOL-7876:
.. _18.1-Patch-Bundle-3|VOSSSOL-7876:
.. _18.1-Patch-Bundle-3|EKB-944:
.. _19.2.1|VOSS-637:
.. _20.1.1|VOSS-670|EKB-4062:
.. _19.3.4|VOSS-696:
.. _21.1|VOSS-847:
.. _21.3|EKB-11022:
.. _21.3|VOSS-962|EKB-11138:
.. _21.3|EKB-11892:
.. _21.3-PB1|VOSS-1072|EKB-12869:
.. _21.3-PB1|VOSS-1072|EKB-12954:
.. _21.3-PB1|EKB-12904:
.. _21.3-PB3|EKB-13017:
Overview
..........
Site defaults provide the default values for several of the tasks performed during onboarding. When
creating a site, a site defaults instance is created on the site, having the same name as the
new site, and pre-populated with several default values.
For Provider deployments, when creating a Cisco HCS site dial plan, the site
defaults on the site are updated with dial-plan-related attributes that are
affected by the deployed site dial plan. Any related existing values are overwritten.
When the site dial plan is removed, these values are reset (set to empty) in the site
defaults.
The Site Defaults Doc (SDD) is useful for managing multi-site, multi-country
customers. A SDD allows a Provider administrator (or higher) to define geo-specific
information at a site level, allowing multinational sites to stay in sync.
Geo-specific information includes CUCM user-locale and network-locale defaults,
as well as the CUC time zone and language defaults.
Site defaults may also be used to include a site for the overbuild, a VOSS Automate process that
syncs in users, and which may include moving users to sites (based on model filter criteria chosen
for the site defaults), and assigning services to subscribers at the sites (when flow through
provisioning is enabled).
Edit Site Defaults
.......................
This procedure displays and updates site defaults.
**Perform these steps**:
1. Log in to VOSS Automate (Admin Portal or Business Admin Portal),
as Provider, Reseller, or Customer administrator.
2. Choose an option:
* From the Business Admin Portal, go to (default menus) **Site Management > Site Defaults**; then,
select the relevant site to open the **Site Defaults[site name]** page.
* From the Admin Portal, go to (default menus) **Site Management > Defaults** to open the **Defaults**
page; then, select the relevant site to open the **Defaults[site name]** page.
3. Click through the tabs to modify site default values:
* General Defaults
* Device Defaults
* Line Defaults
* User Defaults
* CUC Defaults
* HotDial Defaults
* Overbuild Defaults
* Move Filter Criteria
* MS Teams
4. Save your changes.
.. note::
* Field descriptions for the tabs on this screen are documented below.
* Note that the SDD also contains ten custom string fields and ten custom boolean fields,
which are, by default, untitled and hidden:
* ``custom_string_1`` to ``custom_string_10``
* ``custom_boolean_1`` to ``custom_boolean_10``
To enable and use these fields, higher-level administrators can modify the field display
policy (FDP) for the SDD (at a specific hierarchy). Once the fields are available,
designers can reference the fields in custom configuration templates and workflows.
.. rubric:: Related Topics
*
.. raw:: latex
Site Defaults Doc Templates in the Core Feature Guide.
.. raw:: html
Site Defaults Doc Templates
Defaults Page
...............
On the Defaults page (**Site Management > Defaults**) you can view and edit a site's default settings (the site
defaults document, or SDD).
You can select the following tabs on this page:
* General Defaults
* Device Defaults
* Line Defaults
* User Defaults
* CUC Defaults
* HotDial Defaults
* Overbuild Defaults
* Move Filter Criteria
* MS Teams
General Defaults Tab
''''''''''''''''''''''
.. tabularcolumns:: |p{4cm}|p{11cm}|
+---------------------------+---------------------------------------------+
| Option | Default Value |
+===========================+=============================================+
| Name | Mandatory. The same name as the site. |
| | |
| | Only one instance of site defaults exists |
| | for a site. |
+---------------------------+---------------------------------------------+
| Default CUCM Device Pool | Cu{CustomerId}Si{SiteId}-DevicePool |
| | |
+---------------------------+---------------------------------------------+
| Default CUCM Location | Cu{CustomerId}Si{SiteId}-Location |
+---------------------------+---------------------------------------------+
| Default CUCM Region | Cu{CustomerId}Si{SiteId}-Region |
+---------------------------+---------------------------------------------+
| Default CUCM Date/Time | CMLocal |
| Group | |
| | For Provider deployments, choose from the |
| | drop-down list. |
+---------------------------+---------------------------------------------+
| Default User Locale | The user locale identifies a set of |
| | detailed information to support users at |
| | the specific location, including language |
| | and font. Choose the required user locale |
| | from the drop-down list, which contains all |
| | user locales available on the CUCM at the |
| | selected location. |
+---------------------------+---------------------------------------------+
| Default Network Locale | The network locale contains a definition of |
| | the tones and cadences that the phones and |
| | gateways use at the specific location. |
| | Choose the required network locale from the |
| | drop-down list, which contains all network |
| | locales available on the CUCM at the |
| | selected location. |
+---------------------------+---------------------------------------------+
| Default User Profile (for | Choose from the drop-down list. |
| User Self Provisioning) | |
+---------------------------+---------------------------------------------+
| Default CUCM Hunt Pilot | Cu{CustomerId}Si{SiteId}-Feature-PT |
| Partition | |
+---------------------------+---------------------------------------------+
| Default CUCM Call Pickup | Cu{CustomerId}Si{SiteId}-Feature-PT |
| Partition | |
+---------------------------+---------------------------------------------+
| Default CUCM Call Park | Cu{CustomerId}Si{SiteId}-Feature-PT |
| Partition | |
+---------------------------+---------------------------------------------+
| Default CUCM MeetMe | Cu{CustomerId}Si{SiteId}-Feature-PT |
| Partition | |
+---------------------------+---------------------------------------------+
| Default CUCM Group | Defined via a macro in the |
| | CUSTOMER_TEMPLATE and the algorithm chosen |
| | for CUCM Group selection, either *Least |
| | Utilized* or *Default*. |
| | |
| | See CUCM Group Selection in the Core |
| | Feature Guide for details. |
+---------------------------+---------------------------------------------+
.. rubric:: Related Topics
*
.. raw:: latex
CUCM Group Selection in the Core Feature Guide.
.. raw:: html
CUCM Group Selection
*
.. raw:: latex
Configure CUCM Groups in the Provider HCS Dial Plan Management Support Guide.
.. raw:: html
Configure CUCM Groups
Device Defaults Tab
''''''''''''''''''''
Values on the **Device Defaults** tab are applied to the configuration template
associated with adding a subscriber (SubcriberPhonePrePopulate).
.. tabularcolumns:: |p{4cm}|p{11cm}|
+------------------------------+---------------------------------------------+
| Option | Default Value |
+==============================+=============================================+
| Default CUCM Phone Product | Cisco 9971 |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Protocol | SIP |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Button | Standard 9971 SIP |
| Template | |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Security | Cisco 9971 - Standard SIP Non-Secure |
| Profile | Profile |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Softkey | Standard User |
| Template | |
+------------------------------+---------------------------------------------+
| Default CUCM Phone SIP | Standard SIP Profile |
| Profile | |
+------------------------------+---------------------------------------------+
| Default CUCM Phone | Standard Presence Group |
| Presence Group | |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Common | Standard Common Phone Profile |
| Profile | |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Line E164 | Enter a E164 mask value that will be |
| Mask | applied as a default when devices have not |
| | been configured with static values. |
+------------------------------+---------------------------------------------+
| Default CUCM Device CSS | Cu{CustomerId}Si{SiteId}-{countryIsoCode}- |
| | DP-Emer-CSS |
+------------------------------+---------------------------------------------+
| Default CUCM User Subscribe | Internal-CSS |
| CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Phone Subscribe | Cu{CustomerId}Si{SiteId}-InternalOnly-CSS |
| CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Device Profile | Cisco 9971 |
| Product | |
+------------------------------+---------------------------------------------+
| Default CUCM Device Profile | SIP |
| Protocol | |
| | |
| | When adding a phone (or when choosing a |
| | phone for a subscriber), the phone type you |
| | choose must support the protocol you wish |
| | to use (SIP or SCCP). |
| | If the phone type does not support |
| | the protocol, the protocol defaults to the |
| | protocol value set up in the site defaults |
| | (if the phone type supports the default |
| | protocol). |
+------------------------------+---------------------------------------------+
| Default CUCM Device Profile | Standard 9971 SIP |
| Button Template | |
+------------------------------+---------------------------------------------+
.. tabularcolumns:: |p{4cm}|p{11cm}|
+------------------------------+---------------------------------------------+
| Option | Default Value |
+==============================+=============================================+
| Default CUCM Device Profile | None. Enter a E164 mask value that will be |
| Line E164 Mask | applied as a default when devices have not |
| | been configured with static values. |
+------------------------------+---------------------------------------------+
| Default CUCM Device Profile | None |
| EMCC CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Remote | None |
| Destination Profile CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Remote | None |
| Destination Profile | |
| ReRouting CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Remote | None. Enter a E164 mask value that will be |
| Destination Profile Line | applied as a default when devices have not |
| E164 Mask | been configured with static values. |
+------------------------------+---------------------------------------------+
| Use National Mask Format | When this check box is selected, the E164 |
| | Mask will use the National format of the |
| | associated E164 Number. |
| | |
| | For example, if the E164 Number has been |
| | added in the format +44 1234 5000, and this |
| | check box is selected, the E164 Mask on the |
| | device will have the International Dialing |
| | Code prefix removed e.g. +44, and a '0' will|
| | be prefixed to the number e.g. 012345000. |
| | |
| | Note: |
| | |
| | For Quick Add Subscriber, set the following |
| | value in the **E164 Mask** field of the |
| | relevant phone, device profile and remote |
| | destination profile configuration template |
| | {{ macro.SDD_QAS_E164Number_MCR }}. See the |
| | "Reference CUCM Phone Template" CFT for |
| | an example configuration. |
+------------------------------+---------------------------------------------+
Line Defaults Tab
''''''''''''''''''
Values on the **Line Defaults** tab are applied to the configuration template
associated with adding a line (line-cft).
.. tabularcolumns:: |p{4cm}|p{11cm}|
+------------------------------+---------------------------------------------+
| Option | Default Value |
+==============================+=============================================+
| Default CUCM Line BLF | Standard Presence Group |
| Presence Group | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Voicemail | None |
| Profile | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Partition | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Alternate | None |
| E164 Partition | |
+------------------------------+---------------------------------------------+
| Default CUCM Line CSS | Cu{CustomerId}Si{SiteId}-InternalOnly-CSS |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward No Answer CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward All CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward No Answer Internal | |
| CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward Busy CSS | |
+------------------------------+---------------------------------------------+
.. tabularcolumns:: |p{4cm}|p{11cm}|
+------------------------------+---------------------------------------------+
| Option | Default Value |
+==============================+=============================================+
| Default CUCM Line Call | Internal-CSS |
| Forward Busy Internal CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward No Coverage CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward No Coverage Internal | |
| CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward On Failure CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward On Failure Internal | |
| CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward Not Registered CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | CU1-DummyBlk-CSS |
| Forward Alternate Party CSS | |
+------------------------------+---------------------------------------------+
| Default CUCM Line Call | Internal-CSS |
| Forward Secondary CSS | |
+------------------------------+---------------------------------------------+
User Defaults Tab
''''''''''''''''''''
.. tabularcolumns:: |p{4cm}|p{11cm}|
+---------------------------------------+---------------------------------------+
| Option | Default Value |
+=======================================+=======================================+
| Default System User Role | {SiteName}SelfService |
+---------------------------------------+---------------------------------------+
| Default CUCM User BLF | Standard Presence group |
| Presence Group | |
+---------------------------------------+---------------------------------------+
| Default CUCM Service Profile | None |
+---------------------------------------+---------------------------------------+
| Default Self-service Language | Choose from the drop-down list |
| | of installed Self-service languages. |
| | Default is English (en-us). |
+---------------------------------------+---------------------------------------+
| Webex App - Use Organization's Domain | Displays only when: |
| | |
| | * The entitlement profile allows |
| | the Webex App service |
| | * A Webex App server is configured |
| | * The subscriber and Webex App user |
| | have the same email address |
| | * Subscriber does not already have |
| | Jabber clients |
| | * CUCM calling behavior is not yet |
| | configured for the Webex App user |
| | |
| | |
| | Enabling this option hides the |
| | following field: **Webex App - UC |
| | Manager Profile** |
| | |
| | Default (when displayed) is |
| | unchecked (clear). |
| | |
| | When enabled, Webex App provisioning |
| | via QAS refers to values generated |
| | via the following named macros in the |
| | **device/spark/User** configuration |
| | template (CFT): |
| | |
| | * SDD_WtCallBehaviourUcManagerProfile |
| | * SDD_WtUseOrgDomain |
| | |
| | When the CFT with these macros is |
| | chosen for the QAS, the QAS uses site |
| | default values to provision Webex App |
| | (the macros allow QAS to determine |
| | whether the user has a Jabber |
| | client and whether CUCM calling |
| | behavior is configured). |
+---------------------------------------+---------------------------------------+
| Webex App - UC Manager Profile | Displays only when the following |
| | checkbox is clear (not selected): |
| | **Webex App - Use Organization's |
| | Domain** |
| | |
| | Choose the UC Manager profile from |
| | the drop-down. |
| | |
| | Options in the drop-down are the UC |
| | manager profiles added via |
| | **Services > Webex App > Customer |
| | Access** |
+---------------------------------------+---------------------------------------+
CUC Defaults Tab
''''''''''''''''''
For more information about the settings on this tab, see:
.. raw:: latex
Cisco Unity Connection Localization in the Core Feature Guide.
.. raw:: html
Cisco Unity Connection Localization
.. tabularcolumns:: |p{4cm}|p{11cm}|
+---------------------------+----------------------------------------------+
| Option | Default Value |
+===========================+==============================================+
| Default CUC Phone System | This field is populated by the Voice Mail |
| | workflow when a Voice Mail pilot number is |
| | associated with a site. Likewise, the field |
| | is reset (Empty) when the Voice Mail pilot |
| | number is disassociated from a site. |
+---------------------------+----------------------------------------------+
| Default CUC Subscriber | This field is populated by the Voice Mail |
| Template | workflow when a Voice Mail pilot number is |
| | associated with a site. Likewise, the field |
| | is reset (Empty) when the Voice Mail pilot |
| | number is disassociated from a site. |
+---------------------------+----------------------------------------------+
| Default CUC HTML | Default\_Dynamic\_Icons |
| Notification Template | |
+---------------------------+----------------------------------------------+
| Default CUC SMPP Provider | None |
+---------------------------+----------------------------------------------+
| Default CUC TimeZone | None. Choose from the drop-down list, for |
| | example: GMT-05:00-America-New_York. The |
| | timezones available in this drop-down are |
| | those added in **Services > CUC Localization |
| | > CUC TimeZone Filters** (see cross |
| | reference below). |
| | |
| | You can also manually enter a valid |
| | timezone index value in this field, for |
| | example 035 for (GMT-05:00) Eastern Time |
| | (US and Canada). Note that the code entered |
| | must already be installed on the CUC server |
| | associated to this site. |
+---------------------------+----------------------------------------------+
| Default CUC Language | None. Choose from the drop-down list, for |
| | example: English-US. The languages available |
| | in this drop-down are those in **Services > |
| | CUC Localization > CUC Language Filters** |
| | (see cross reference below). |
| | |
| | You can also manually enter a valid Locale |
| | ID (LCID) value for the language in this |
| | field, for example 1036 for French - France. |
| | Note that the code entered must already be |
| | installed on the CUC server associated to |
| | this site. |
+---------------------------+----------------------------------------------+
| Default Language That | None. Choose from the drop-down list: |
| Callers Hear | |
| | * Inherit Language From Caller |
| | * Use System Default Language |
| | * [Use the User Language] e.g. English |
| | (United States). See "Default CUC Language"|
| | above. |
| | * [Choice of Languages] e.g. Spanish (Spain |
| | Traditional). See "Default CUC Language" |
| | above). |
+---------------------------+----------------------------------------------+
HotDial Defaults Tab
''''''''''''''''''''''
+---------------------------+---------------------+
| Option | Default Value |
+===========================+=====================+
| Default PLAR CSS | None |
+---------------------------+---------------------+
| Default HotDial TimeZone | None |
+---------------------------+---------------------+
Overbuild Defaults Tab
''''''''''''''''''''''''''
The Overbuild Defaults tab is visible only to Provider and Reseller administrators.
Settings on this tab:
* Include Site for Overbuild (yes/no)
* Create Internal Number Inventory at CustomerId (yes/no)
* Overbuild Device Control (e.g., Move All Devices, Limit Moved Devices)
* Add additional device pools
For more information about the settings on this tab, see:
.. raw:: latex
Overbuild Site Defaults: Overview in the Core Feature Guide.
.. raw:: html
Overbuild Site Defaults: Overview
Move Filter Criteria Tab
''''''''''''''''''''''''''
This tab defines the rules the system uses to match users to sites when syncing in users, and to
determine whether users should be moved directly to the site as subscribers.
The model filter criteria you can choose (depending on the user type you're syncing in, for
example, Microsoft, LDAP, or CUCM), is configured in the Admin Portal, via (default menus):
* Customizations > Model Filter Criteria, or in:
* Flow Through Provisioning Configuration > Model Filter Criteria
.. rubric:: Related Topics
*
.. raw:: latex
Flow Through Provisioning in the Core Feature Guide
.. raw:: html
Flow Through Provisioning
*
.. raw:: latex
Model Filter Criteria in the Core Feature Guide
.. raw:: html
Model Filter Criteria
MS Teams Tab
''''''''''''''
The table describes settings on this tab:
.. tabularcolumns:: |p{4cm}|p{11cm}|
+-----------------------------------------+----------------------------------------------+
| Option | Description |
+=========================================+==============================================+
| Manage Licenses and Allow User Staging | This checkbox defines whether Voss Automate |
| | may update the MSOL (Microsoft 365) user, |
| | typically, the licensing component. |
| | |
| | When disabled (unchecked), VOSS Automate |
| | will never attempt to update a user's |
| | license, and in this case, it won't be |
| | possible to use Quick Subscriber to license |
| | a user and to provide them with baseline |
| | MS Teams configuration. The user must be |
| | properly licensed through the Microsoft |
| | online portal to allow VOSS Automate to |
| | provide accurate MS Teams configuration. |
| | |
| | Additionally, disabling this setting hides |
| | the **Line URI** field in Quick Subscriber |
| | when: |
| | |
| | * The user is not licensed for Microsoft |
| | Teams |
| | * The user's license includes feature group |
| | *PhoneSystem* |
| | |
| | Enable this setting to allow users to be |
| | staged, licensed, and provisioned from Quick |
| | Subscriber. |
+-----------------------------------------+----------------------------------------------+
| Auto Delete VOSS4UC User | Defines whether to delete the user in VOSS |
| | Automate when the MS Azure AD online user is |
| | deleted. |
| | |
| | This only applies to users located at the |
| | Site level. Users at Customer level will |
| | not be automatically deleted. |
+-----------------------------------------+----------------------------------------------+
| Default Tenant Dial Plan | Defines the default tenant dial plan for the |
| | site. For details, see *Configure Microsoft |
| | Tenant Dialplan* in the Core Feature Guide. |
+-----------------------------------------+----------------------------------------------+
| MS Teams Policies | Policies are synced in to VOSS Automate |
| | from MS Teams and are available in the SDD |
| | as defaults. You can choose a default |
| | policy for a site in the site defaults to |
| | automatically assign to |
| | subscribers at the site. When creating a |
| | subscriber via Quick Subscriber, the site |
| | default is used, but you can also edit |
| | the configuration template for the Quick Add |
| | Group (QAG) to use a policy different to the |
| | site defaults, or you can edit a subscriber |
| | directly to choose a different policy for |
| | that subscriber. |
| | |
| | See *Introduction to |
| | Microsoft Teams Policies* in the Core |
| | Feature Guide |
+-----------------------------------------+----------------------------------------------+
| Default Usage Location | The country for default usage. |
+-----------------------------------------+----------------------------------------------+
.. rubric:: Related Topics
* .. raw:: latex
Configure Microsoft Tenant Dialplan in the Core Feature Guide.
.. raw:: html
Configure Microsoft Tenant Dialplan
*
.. raw:: latex
Introduction to Microsoft Teams Policies in the Core Feature Guide.
.. raw:: html
Introduction to Microsoft Teams Policies
*
.. raw:: latex
Quick Subscriber for Microsoft Users in the Core Feature Guide.
.. raw:: html
Quick Subscriber for Microsoft Users
*
.. raw:: latex
Microsoft Licenses in the Core Feature Guide
.. raw:: html
Microsoft Licenses