[Index]

Model: data/SiteDefaultsDoc

Defaults

Site defaults provide the default values for many tasks undertaken while onboarding, and are not limited to the Subscriber Management tasks. When a site is created, a site defaults instance is created on that site with the same name as the site. Many of the attributes in this data model contain default values when this instance is created. [1]

The Site Defaults Doc is particularly useful when managing multi-site, multi-country customers. It allows a Provider Administrator or higher to set geo-specific information at a site level to allow multi-national sites to stay in sync. Geo-specific information includes CUCM user-locale and network-locale defaults as well as the CUC timezone and language defaults.

  1. Log in as provider, reseller, or customer administrator.

  2. Choose Site Management > Defaults.

  3. Click the site that you want to modify defaults for.

  4. From the General Defaults tab, click the following fields to modify their default values as required:

    System Message: ERROR/3 (<string>, line 26)

    Unknown directive type "tabularcolumns".

    .. tabularcolumns:: |p{4cm}|p{11cm}|
    
    
    Option Default Value
    Name

    Site name

    This field is mandatory. It should be 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 Group CMLocal [2]
    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 User Self Provisioning) Choose from the drop-down list.
    Default CUCM Hunt Pilot Partition Cu{CustomerId}Si{SiteId}-Feature-PT
    Default CUCM Call Pickup Partition Cu{CustomerId}Si{SiteId}-Feature-PT
    Default CUCM Call Park Partition Cu{CustomerId}Si{SiteId}-Feature-PT
    Default CUCM MeetMe Partition Cu{CustomerId}Si{SiteId}-Feature-PT
    Default CUCM Group Default value: Default
  5. From the Device Defaults tab, click the following fields to modify their default values as required. These default values are applied to the configuration template associated with adding a subscriber (SubcriberPhonePrePopulate).

    System Message: ERROR/3 (<string>, line 85)

    Unknown directive type "tabularcolumns".

    .. tabularcolumns:: |p{4cm}|p{11cm}|
    
    
    Option Default Value
    Default CUCM Phone Product Cisco 9971
    Default CUCM Phone Protocol SIP
    Default CUCM Phone Button Template Standard 9971 SIP
    Default CUCM Phone Security Profile Cisco 9971 - Standard SIP Non-Secure Profile
    Default CUCM Phone Softkey Template Standard User
    Default CUCM Phone SIP Profile Standard SIP Profile
    Default CUCM Phone Presence Group Standard Presence Group
    Default CUCM Phone Common Profile Standard Common Phone Profile
    Default CUCM Phone Line E164 Mask Enter a E164 mask value that will be 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 CSS Internal-CSS
    Default CUCM Phone Subscribe CSS Cu{CustomerId}Si{SiteId}-InternalOnly-CSS
    Default CUCM Device Profile Product Cisco 9971
    Default CUCM Device Profile Protocol SIP
    Default CUCM Device Profile Button Template Standard 9971 SIP

    System Message: ERROR/3 (<string>, line 135)

    Unknown directive type "tabularcolumns".

    .. tabularcolumns:: |p{4cm}|p{11cm}|
    
    
    Option Default Value
    Default CUCM Device Profile Line E164 Mask None. Enter a E164 mask value that will be applied as a default when devices have not been configured with static values.
    Default CUCM Device Profile EMCC CSS None
    Default CUCM Remote Destination Profile CSS None
    Default CUCM Remote Destination Profile ReRouting CSS None
    Default CUCM Remote Destination Profile Line E164 Mask None. Enter a E164 mask value that will be applied as a default when devices have not 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.

  6. From the Line Defaults tab, click the following fields to modify their default values as required. These default values are applied to the configuration template associated with adding a line (line-cft).

    System Message: ERROR/3 (<string>, line 186)

    Unknown directive type "tabularcolumns".

    .. tabularcolumns:: |p{4cm}|p{11cm}|
    
    
    Option Default Value
    Default CUCM Line BLF Presence Group Standard Presence Group
    Default CUCM Line Voicemail Profile None
    Default CUCM Line Partition  
    Default CUCM Line Alternate E164 Partition None
    Default CUCM Line CSS Cu{CustomerId}Si{SiteId}-InternalOnly-CSS
    Default CUCM Line Call Forward CSS Internal-CSS
    Default CUCM Line Call Forward No Answer CSS Internal-CSS
    Default CUCM Line Call Forward All CSS Internal-CSS
    Default CUCM Line Call Forward No Answer Internal CSS Internal-CSS
    Default CUCM Line Call Forward Busy CSS Internal-CSS

    System Message: ERROR/3 (<string>, line 221)

    Unknown directive type "tabularcolumns".

    .. tabularcolumns:: |p{4cm}|p{11cm}|
    
    
    Option Default Value
    Default CUCM Line Call Forward Busy Internal CSS Internal-CSS
    Default CUCM Line Call Forward No Coverage CSS Internal-CSS
    Default CUCM Line Call Forward No Coverage Internal CSS Internal-CSS
    Default CUCM Line Call Forward On Failure CSS Internal-CSS
    Default CUCM Line Call Forward On Failure Internal CSS Internal-CSS
    Default CUCM Line Call Forward Not Registered CSS Internal-CSS
    Default CUCM Line Call Forward Alternate Party CSS CU1-DummyBlk-CSS
    Default CUCM Line Call Forward Secondary CSS Internal-CSS
  7. From the User Defaults tab, click the following fields to modify their default values as required:

    System Message: ERROR/3 (<string>, line 257)

    Unknown directive type "tabularcolumns".

    .. tabularcolumns:: |p{4cm}|p{11cm}|
    
    
    Option Default Value
    Default System User Role {SiteName}SelfService
    Default CUCM User BLF Presence Group Standard 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).
  8. From the CUC Defaults tab, click the following fields to modify their default values as required:

    System Message: ERROR/3 (<string>, line 278)

    Unknown directive type "tabularcolumns".

    .. 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 Template 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 HTML Notification Template Default_Dynamic_Icons
    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.

    See CUC Localization for more details if required.

  9. From the HotDial Defaults tab, click the following fields to modify their default values as required:

    Option Default Value
    Default PLAR CSS None
    Default HotDial TimeZone None
  10. For information on the Overbuild Defaults tab (visible to provider and reseller administrators), see Overbuild Site Defaults.

  11. Click Save to save the modified site defaults.

[1]For Provider deployments, when a Cisco HCS site dial plan is created, the site defaults on that site are updated. The updated defaults are dial plan-related attributes that are affected by the site dial plan that was deployed. If these specific site defaults attributes already had values before the site dial plan was deployed, they are overwritten. When the site dial plan is removed, these same attributes are reset (set to empty string) in the site defaults.
[2]For Provider deployments, choose from the drop-down list.

CUC Localization

Provider administrators or higher can manage multi-site, multi-country customers by setting geo-specific information using the Site Defaults Doc. Using this information, administrators can use custom Configuration Templates (as in the Quick Add Group for Quick Add Subscriber), to set this information on a per-site level.

Timezones and languages in VOSS-4-UC are populated with the required CUC timezones and languages. These are typically selected from the relevant drop-down lists as described under Modify Site Defaults.

Note

You must only add timezone and language codes in VOSS-4-UC that match the installed timezones and languages on the associated CUC Server. The names entered must uniquely describe the timezone and code.

See also:

Add a CUC TimeZone

To add a custom Cisco Unity Connection timezone filter:

  1. Log in as provider administrator or higher.
  2. Choose Services > Cisco Unity Connection Localization > TimeZone Filters to see a list of timezone filters currently in VOSS-4-UC.
  3. Click Add.
  4. Enter the following:
    1. TimeZone Code - this is a mandatory field, and must match a timezone code installed on the associated Cisco Unity Connection Server.
    2. TimeZone Name - this is a mandatory field, and must be a unique description for the timezone code above.
  5. Click Save.

Add a CUC Language

To add a custom Cisco Unity Connection language filter:

  1. Log in as provider administrator or higher.
  2. Choose Services > Cisco Unity Connection Localization > Language Filters to see a list of language filters currently in VOSS-4-UC.
  3. Click Add.
  4. Enter the following:
    1. Installed Language Code - this is a mandatory field, and must match a language code installed on the associated Cisco Unity Connection Server.
    2. Language Name - this is a mandatory field, and must be a unique description for the language code above.
  5. Click Save.

Authorization Defaults for Overbuild

The Customer administrator can set up authorization details for users on the Site Defaults at a site that will apply during the Overbuild process.

Subscriber users that are then created on VOSS-4-UC would then be authenticated by the method selected in here.

When LDAP or SSO authorization methods are chosen, the SSO IDP and LDAP Server are mandatory in the Site Defaults Doc.

The table below shows the available authorization options:

Auth Method Description
Standard A default password can be set for standard system user.
LDAP An LDAP Server can be selected for LDAP users
SSO An SSO Identity Provider can be specified for SSO user authentication.

doc

Model Details

Title Description Details
General Defaults Group Assigned by FDP
  • Field Name: General Defaults
  • Type: Object
Name *
  • Field Name: General Defaults.name
  • Type: String
Default CUCM Device Pool
  • Field Name: General Defaults.defaultDP
  • Type: String
Default CUCM Location
  • Field Name: General Defaults.defaultLOC
  • Type: String
Default CUCM Region
  • Field Name: General Defaults.defaultREG
  • Type: String
Default CUCM Date/Time Group
  • Field Name: General Defaults.defaultDTG
  • Type: String
Default User Locale
  • Field Name: General Defaults.defaultUL
  • Type: String
Default Network Locale
  • Field Name: General Defaults.defaultNL
  • Type: String
Default User Profile (for User Self Provisioning)
  • Field Name: General Defaults.defaultuserprofile
  • Type: String
Default CUCM Hunt Pilot Partition
  • Field Name: General Defaults.defaulthppt
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSitePartitions.SitePT
  • Choices: ["y"]
Default CUCM Call Pickup Partition
  • Field Name: General Defaults.defaultcpupt
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSitePartitions
  • Choices: ["y"]
Default CUCM Call Park Partition
  • Field Name: General Defaults.defaultcppt
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSitePartitions
  • Choices: ["y"]
Default CUCM MeetMe Partition
  • Field Name: General Defaults.defaultmmpt
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSitePartitions
  • Choices: ["y"]
Default CUCM Group
  • Field Name: General Defaults.defaultcucmgroup
  • Type: String
Device Defaults Group Assigned by FDP
  • Field Name: Device Defaults
  • Type: Object
Default CUCM Phone Product
  • Field Name: Device Defaults.default_cucm_phone_product
  • Type: String
  • Target: device/cucm/PhoneType
  • Target attr: PhoneType
  • Format: uri
Default CUCM Phone Protocol
  • Field Name: Device Defaults.default_cucm_phone_protocol
  • Type: String
Default CUCM Phone Button Template
  • Field Name: Device Defaults.default_cucm_phone_template
  • Type: String
Default CUCM Phone Security Profile
  • Field Name: Device Defaults.default_cucm_phone_securityprofile
  • Type: String
Default CUCM Phone Softkey Template
  • Field Name: Device Defaults.default_cucm_phone_softkey
  • Type: String
Default CUCM Phone SIP Profile
  • Field Name: Device Defaults.default_cucm_phone_sipprofile
  • Type: String
Default CUCM Phone Presence Group
  • Field Name: Device Defaults.default_cucm_phone_presencegroup
  • Type: String
Default CUCM Phone Common Profile
  • Field Name: Device Defaults.default_cucm_phone_commondeviceconfig
  • Type: String
Default CUCM Phone Line E164 Mask
  • Field Name: Device Defaults.default_cucm_phone_e164_mask
  • Type: String
Default CUCM Device CSS
  • Field Name: Device Defaults.defaultdevicecss
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSiteCSS
  • Choices: ["y"]
Default CUCM User Subscribe CSS
  • Field Name: Device Defaults.default_user_subscriber_css
  • Type: String
Default CUCM Phone Subscribe CSS
  • Field Name: Device Defaults.default_phone_subscriber_css
  • Type: String
Default CUCM Device Profile Product
  • Field Name: Device Defaults.default_cucm_dp_product
  • Type: String
Default CUCM Device Profile Protocol
  • Field Name: Device Defaults.default_cucm_dp_protocol
  • Type: String
Default CUCM Device Profile Button Template
  • Field Name: Device Defaults.default_cucm_dp_template
  • Type: String
Default CUCM Device Profile Line E164 Mask
  • Field Name: Device Defaults.default_cucm_dp_e164_mask
  • Type: String
Default CUCM Device Profile EMCC CSS
  • Field Name: Device Defaults.default_dp_emcc_css
  • Type: String
Default CUCM Remote Destination Profile CSS
  • Field Name: Device Defaults.default_rdp_css
  • Type: String
Default CUCM Remote Destination Profile ReRouting CSS
  • Field Name: Device Defaults.default_rdp_rr_css
  • Type: String
Default CUCM Remote Destination Profile Line E164 Mask
  • Field Name: Device Defaults.default_cucm_rdp_e164_mask
  • Type: String
Use National Mask Format
  • Field Name: Device Defaults.useNationalMaskFormat
  • Type: Boolean
Line Defaults Group Assigned by FDP
  • Field Name: Line Defaults
  • Type: Object
Default CUCM Line Presence Group
  • Field Name: Line Defaults.default_cucm_line_presencegroup
  • Type: String
Default CUCM Line Voicemail Profile
  • Field Name: Line Defaults.default_cucm_line_vmprofile
  • Type: String
Default CUCM Line Partition
  • Field Name: Line Defaults.defaultlinept
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSitePartitions.SitePT
  • Choices: ["y"]
Default CUCM Line Alternate E164 Partition
  • Field Name: Line Defaults.default_alternate_e164_pt
  • Type: String
Default CUCM Line CSS
  • Field Name: Line Defaults.defaultlinecss
  • Type: String
  • Target: data/DialPlan
  • Target attr: AddSiteCSS
  • Choices: ["y"]
Default CUCM Line Call Forward CSS
  • Field Name: Line Defaults.default_callforward_css
  • Type: String
Default CUCM Line Call Forward No Answer CSS
  • Field Name: Line Defaults.defaultlinecfnacss
  • Type: String
Default CUCM Line Call Forward All CSS
  • Field Name: Line Defaults.defaultlinecfacss
  • Type: String
Default CUCM Line Call Forward No Answer Internal CSS
  • Field Name: Line Defaults.defaultlinecfnaicss
  • Type: String
Default CUCM Line Call Forward Busy CSS
  • Field Name: Line Defaults.defaultlinecfbcss
  • Type: String
Default CUCM Line Call Forward Busy Internal CSS
  • Field Name: Line Defaults.defaultlinecfbicss
  • Type: String
Default CUCM Line Call Forward No Coverage CSS
  • Field Name: Line Defaults.defaultlinecfnccss
  • Type: String
Default CUCM Line Call Forward No Coverage Internal CSS
  • Field Name: Line Defaults.defaultlinecfncicss
  • Type: String
Default CUCM Line Call Forward On Failure CSS
  • Field Name: Line Defaults.defaultlinecfofcss
  • Type: String
Default CUCM Line Call Forward On Failure Internal CSS
  • Field Name: Line Defaults.defaultlinecfnricss
  • Type: String
Default CUCM Line Call Forward Not Registered CSS
  • Field Name: Line Defaults.defaultlinecfnrcss
  • Type: String
Default CUCM Line Call Forward Alternate Party CSS
  • Field Name: Line Defaults.defaultlinecfapcss
  • Type: String
Default CUCM Line Call Forward Secondary CSS
  • Field Name: Line Defaults.defaultlineseccss
  • Type: String
User Defaults Group Assigned by FDP
  • Field Name: User Defaults
  • Type: Object
Default System User Role Default: selfservice
  • Field Name: User Defaults.defaultuserrole
  • Type: String
  • Target: data/Role
  • Target attr: name
  • Default: selfservice
  • Format: uri
Default CUCM User Presence Group
  • Field Name: User Defaults.default_cucm_user_presencegroup
  • Type: String
Default CUCM Service Profile
  • Field Name: User Defaults.default_cucm_user_serviceprofile
  • Type: String
Default Self-service Language
  • Field Name: User Defaults.default_self_service_language
  • Type: String
CUC Defaults Group Assigned by FDP
  • Field Name: CUC Defaults
  • Type: Object
Default CUC Phone System
  • Field Name: CUC Defaults.defaultcucphonesystem
  • Type: String
Default CUC Subscriber Template
  • Field Name: CUC Defaults.defaultcucsubscribertemplate
  • Type: String
Default CUC HTML Notification Template
  • Field Name: CUC Defaults.defaultcuchtmlnotificationtemplate
  • Type: String
Default CUC SMPP Provider
  • Field Name: CUC Defaults.defaultcucsmppprovider
  • Type: String
Default CUC Timezone
  • Field Name: CUC Defaults.defaultcuctimezone
  • Type: String
Default CUC Language
  • Field Name: CUC Defaults.defaultcuclanguage
  • Type: String
HotDial Defaults Group Assigned by FDP
  • Field Name: HotDial Defaults
  • Type: Object
Default PLAR CSS
  • Field Name: HotDial Defaults.defaultplarcss
  • Type: String
  • Target: device/cucm/Css
  • Target attr: name
  • Choices: ["y"]
Default HotDial Time Zone
  • Field Name: HotDial Defaults.hotdial_time_zone
  • Type: String
Overbuild Defaults Group Assigned by FDP
  • Field Name: Overbuild Defaults
  • Type: Object
Include Site for Overbuild Mark this site as to be included for Overbuild
  • Field Name: Overbuild Defaults.includeOverbuild
  • Type: Boolean
Create Internal Number Inventory at Customer Creates Internal Number Inventory at Customer level when selected, else creates INIs at Site level Default: false
  • Field Name: Overbuild Defaults.customer_ini
  • Type: Boolean
  • Default: false
Additional Device Pools Choose the Device Pools to include for the move.
  • Field Name: additionalDevicePools.[n]
  • Type: Array
Device Pool Name Device Pool to be used during Overbuild for this site.
  • Field Name: Overbuild Defaults.additionalDevicePools.[n].dpName
  • Type: String
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Format: uri
Replace With Default Device Pool Replace the Device Pool with the site default Device Pool
  • Field Name: Overbuild Defaults.additionalDevicePools.[n].dpReplace
  • Type: Boolean
Overbuild Device Control Select the method of device selection Default: all
  • Field Name: Overbuild Defaults.deviceLimitYN
  • Type: String
  • Default: all
  • Choices: ["Move All Devices", "Limit Moved Devices"]
Phones Move all phones that match search-criteria, to destination site.
  • Field Name: Overbuild Defaults.includePhone
  • Type: Boolean
Dual-mode Remote Destinations Remote Destinations associated to Dual-Mode Phones
  • Field Name: Overbuild Defaults.includePRD
  • Type: Boolean
Users Move Users down to associated phones
  • Field Name: Overbuild Defaults.includeUser
  • Type: Boolean
Device Profiles Move User Device Profiles down to associated User
  • Field Name: Overbuild Defaults.includeDP
  • Type: Boolean
Remote Destination Profiles Move Remote Destination Profiles that match search-criteria, to destination site.
  • Field Name: Overbuild Defaults.includeRDP
  • Type: Boolean
Remote Destinations Remote Destinations associated to RDP's
  • Field Name: Overbuild Defaults.includeRD
  • Type: Boolean
Lines Lines associated to 1) phones, 2) device profiles, 3) RDP's.
  • Field Name: Overbuild Defaults.includeLine
  • Type: Boolean
CUC Users Unity Connect Users associated to phones
  • Field Name: Overbuild Defaults.includeCUCUser
  • Type: Boolean
Webex Teams Users Webex Teams Users that have a User at Site level with same email address.
  • Field Name: Overbuild Defaults.includeWebexTeamsUser
  • Type: Boolean
Contact Center Agents Contact Center Agents that have a User at Site level with same user ID.
  • Field Name: Overbuild Defaults.includeContactCenterAgent
  • Type: Boolean
Authorization Defaults Group Assigned by FDP
  • Field Name: Authorization Defaults
  • Type: Object
Auth Method The type of authorization that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user.
  • Field Name: Authorization Defaults.auth_method
  • Type: String
  • Choices: ["", "Standard", "LDAP", "SSO"]
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: Authorization Defaults.ldap_server
  • Type: String
  • Target: data/Ldap
  • Format: uri
SSO Identity Provider The entity id of the SSO Identity Provider.
  • Field Name: Authorization Defaults.sso_idp
  • Type: String
  • Target: data/SsoIdentityProvider
  • Target attr: entity_id
  • Format: uri
Default User Password The default password to assign to a data user.
  • Field Name: Authorization Defaults.default_data_user_password
  • Type: String
  • Pattern: ^$|.{8,}
API reference for data/SiteDefaultsDoc