[Index]

Model: view/UserPhoneMoveUsers_VIEW

Move Subscriber

This feature provides a customer administrator (or higher) with the ability to move a subscriber from customer level to a site, as well as from one site to a different site under the same customer. Moving the subscriber from one site to another site on a different Unified CM cluster and CUCxn cluster is also supported.

This is done on the Move Subscriber screen accessed via the Subscriber Management > Move Subscriber (default menu option).

Subscriber Data

When moving a subscriber, the subscriber, phones, device profiles, SNR, voicemail and VOSS-4-UC data are processed. The subscriber will be updated with a new primary extension where appropriate.

The subscriber role at the destination hierarchy is selectable and an optional configuration template MoveUpdateUserCustom_CFT is available to make custom subscriber updates.

A device pool at the destination hierarchy is mandatory. You can select either the default device pool at the destination hierarchy or choose a different device pool from a drop-down list.

Phone Data

Desk phones can either remain at the old site or move with the subscriber. Other softphone devices, e.g. Jabber devices are always moved.

The default operation is to move all phones to the destination hierarchy, i.e. Move Desk Phones to Destination Hierarchy check box = Selected.

If the desk phones are not moved, i.e. check box = Cleared, desk phones remain at the original site and are disassociated from the subscriber.

An option is provided to create a new desk phone at the destination hierarchy. An existing phone is used as a template, and the model and phone button template can be selected from drop-down lists. An optional configuration template MoveUpdatePhoneCustom_CFT for the new phone can be chosen to make custom device settings available.

Line Data

Lines can be moved to the destination hierarchy if the move is on the same cluster. To enable moving of lines to the destination hierarchy, the UserMove_AllowLineMove_MCR macro must be cloned to the applicable hierarchy level and the value set to {{ fn.true }}.

Note that moving lines may not be supported by the customer dial plan; SLC based dial plans (types 1, 2 and 3) do not support moving of lines between sites. Make sure that the customer dial plan supports moving of lines between sites before attempting to move the line.

When moving to another Unified CM cluster, new lines must be defined. The CSS's for the new lines can be defined and a configuration template MoveUpdateLineCustom_CFT is available to make custom line updates.

Note that a check is performed to ensure that the first line across devices is common. This first line is used for SNR and voicemail. If the move is determined to be between sites hosted on the same Unified CM cluster, the subscriber data is moved to the new hierarchy and updated as above. It is assumed that the CUCxn (if used) will remain.

If the move is between different Unified CM clusters, the data defined above is re-provisioned on the new cluster and deleted on the original cluster, except for the Unified CM subscriber. When the Unified CM subscriber is local, the old subscriber is removed.

In the case of an LDAP user, the VOSS-4-UC subscriber is purged. The user is removed from the device/cucm/User model of the source Unified CM in VOSS-4-UC. The home cluster flag is maintained such that it is only set to true on the Unified CM cluster hosting the subscriber, even if the subscriber exists on other Unified CM clusters.

When moving between clusters, the CUCxn server can be retained. In this case, the model instances are moved. In the case that the CUCxn server changes, a new CUCxn subscriber is created against a chosen subscriber template. This will not copy custom settings for the CUCxn subscriber or any recorded prompts and messages.

Existing Services

Existing services associated to the subscriber such as phones and lines, device profiles, single number reach and Voicemail, which will be moved with the subscriber, are displayed on this tab.

Caveats

Model Details

Title Description Details
Subscriber Name of individual Subscriber who will be moved.
  • Field Name: one_username
  • Type: String
  • Choices: [" "]
Move From Hierarchy The name of the hierarchy node from which the Subscriber will be moved from if the conditions are satisfied.
  • Field Name: move_from_hn
  • Type: String
Move To Hierarchy The name of the hierarchy node to which the Subscriber will be moved to if the conditions are satisfied.
  • Field Name: move_to_hn
  • Type: String
  • Choices: [" "]
Role at Destination Hierarchy The user role to use at the destination hierarchy
  • Field Name: move_to_role
  • Type: String
Configuration Template for Subscriber Update Optional Template for Subscriber update on CUCM
  • Field Name: new_user_cft
  • Type: String
Move Lines to Destination Hierarchy Tick to move any lines associated with the user to the destination hierarchy. If lines are moved, they will remain on the devices. Lines that are not moved may be retained on devices, or may be replaced Default: true
  • Field Name: move_line
  • Type: Boolean
  • Default: true
Allow Move of Lines to Destination Hierarchy
  • Field Name: AllowLineMove
  • Type: Boolean
Replace Line with New Line at Destination Hierarchy Create new line at the destination hierarchy. Use existing line if not ticked, even if line is not moved to the new hierarchy ( i.e shared line ). This applies to line 1 only. Subsequent lines must be modified if required after the move is complete.
  • Field Name: new_line
  • Type: Boolean
New Lines
  • Field Name: lines.[n]
  • Type: Array
Pattern
  • Field Name: lines.[n].line
  • Type: String
Configuration Template for New Line Optional Configuration Template name for Line parameter override
  • Field Name: new_line_cft
  • Type: String
Move Desk Phones to Destination Hierarchy Tick to move any desk phones(SEP prefix) associated with the user to the new hierarchy. Disassociate Subscriber from existing desk phones if not checked. Jabber/Soft Clients etc (non SEP prefix devices) are always moved. Default: true
  • Field Name: move_phone
  • Type: Boolean
  • Default: true
Create New Phone at Destination Hierarchy Create New Phone at Destination Hierarchy
  • Field Name: new_phone
  • Type: Boolean
New Phone Type
  • Field Name: new_phone_product
  • Type: String
New Phone Protocol
  • Field Name: new_phone_protocol
  • Type: String
Device Name for New Phone e.g. SEP123412341234. Leave blank for auto generated MAC if you use phone based registration, select from list of free phones or provide a new phone name
  • Field Name: new_phone_mac
  • Type: String
New Phone Configuration Source Copy configuration from specified old phone
  • Field Name: new_phone_config_source
  • Type: String
Phone Type to Copy Configuration from
  • Field Name: new_phone_config_source_product
  • Type: String
New Phone Configuration Template Optional Configuration Template name for phone parameter override
  • Field Name: new_phone_cft
  • Type: String
New Phone Button Template
  • Field Name: new_phone_pbt
  • Type: String
New Phone Security Profile
  • Field Name: new_phone_securityprofile
  • Type: String
Use Default CSS at Destination Hierarchy Use the CSS defined as the site default at the destination hierarchy
  • Field Name: default_css
  • Type: Boolean
Line Calling Search Space at Destination Hierarchy Specify a specific CSS to be used at the destination hierarchy
  • Field Name: line_css
  • Type: String
Call Forward Calling Search Space at Destination Hierarchy Specify a specific CSS to be used at the destination hierarchy
  • Field Name: cfwd_css
  • Type: String
Use Default Device Pool at Destination Hierarchy Use the Default Device Pool defined as the site default at the destination hierarchy Default: true
  • Field Name: default_dp
  • Type: Boolean
  • Default: true
Device Pool at Destination Hierarchy Specify a specific device pool to be used at the destination hierarchy
  • Field Name: device_pool
  • Type: String
Source CUCM
  • Field Name: guiSourceCucmBkey
  • Type: String
Target CUCM
  • Field Name: guiTargetCucmBkey
  • Type: String
Target CUCM PKID
  • Field Name: guiTargetCucmPkid
  • Type: String
Source CUC
  • Field Name: guiSourceCucBkey
  • Type: String
Target CUC
  • Field Name: guiTargetCucBkey
  • Type: String
CUCM changes
  • Field Name: guiNewCucm
  • Type: Boolean
CUC Changes
  • Field Name: guiNewCuc
  • Type: Boolean
Caution
  • Field Name: CrossClusterMessage
  • Type: String
New Cuc User Template
  • Field Name: newCucUserTemplate
  • Type: String
Existing Phones
  • Field Name: existingPhones
  • Type: String
Existing Device Profiles
  • Field Name: existingDeviceProfiles
  • Type: String
Existing Single Number Reach
  • Field Name: existingSnr
  • Type: String
Existing Voicemail
  • Field Name: existingVoicemail
  • Type: String
API reference for view/UserPhoneMoveUsers_VIEW