[Index]

Model: view/UserPhoneMoveUsers_VIEW

Move Subscriber

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

A Customer administrator (or higher) can move a subscriber from:

When moving a subscriber:

Move Subscriber Configuration

You can move subscribers via (default menus) Subscriber Management > Move Subscriber, then configure options on the following tabs:

Subscriber Configuration Tab

On this tab you choose the subscriber you're moving and their target hierarchy.

The table describes configuration options on the Subscriber Configuration tab:

Field Description
Subscriber The subscriber you're moving.
Move from Hierarchy Auto-populated, based on the subscriber you choose. The hierarchy the subscriber is moving from.
Move to Hierarchy Mandatory. Choose a target hierarchy for the move.
New Role Optional. Choose the subscriber's role at the target hierarchy.
Use Default Device Pool Choose whether to use the default device pool (the site default at the target hierarchy).
Device Pool Displays only when Use Default Device Pool is not selected. Allows you to choose a device pool at the target hierarchy, if you're not using the default.
Caution Read only warning field, for example, to alert you when you're moving a subscriber to a new CUCM cluster.
New CUC User Template Mandatory when moving a subscriber to a different CUCM cluster.
User Template

Optional template (MoveUpdateUserCustom_CFT) for custom subscriber updates on CUCM.

You can clone and customize this template, if required. Available user templates are listed on the Configuration Templates page at (default menus) Customizations > Configuration Templates.

Desk Phone Configuration Tab

This tab configures the desk phones of the subscriber you're moving.

Note

By default, existing desk phones are moved with the subscriber. However, desk phones can either remain at the old site or move with the subscriber. Existing softphone devices, such as Jabber or Dual Mode devices, are always moved.

The table describes configuration options on the Desk Phone Configuration tab:

Field Description
Move Desk Phones

Enabled by default. Defines whether to move the subscriber's (SEP prefix) desk phones to the target hierarchy. Phones that aren't moved remain at the origin hierarchy.

When unchecked (disabled), the moved subscriber is disassociated from their existing desk phones.

Existing (non-SEP prefix) softphone devices (such as Jabber or Dual Mode devices) are always moved, but can be configured via the Jabber/Dual Mode configuration templates. See Jabber/Dual-Mode Device Configuration.

Create New Phone

Choose this option to create new phones for the subscriber at the target hierarchy. When enabled, configure the following fields on this tab:

  • Use existing phone configuration (yes/no)
  • Desk phone profile
  • Desk phone feature template
  • Phone name
Use Existing Phone Configuration

Displays when Create New Phone is enabled.

Defines whether to use the existing phone configuration as a template to create the new phone. When enabled, configure the following fields on the tab:

  • Phone configuration source
  • Desk phone profile
  • Phone name
Phone Configuration Source

Displays only when Use Existing Phone Configuration is enabled.

Choose from a list of the subscriber's existing phones to create the new phone using the configuration of the existing phone.

Desk Phone Profile

Displays when Create New Phone is enabled.

Defines the phone type (and associated configuration).

Desk Phone Feature Template

Displays when Create New Phone is enabled and Use Existing Phone Configuration is disabled.

Optional configuration template. Choose a template from the the first Phone Mapping Configuration found up the hierarchy tree.

The Move Subscriber process applies the newly created phone with the desk phone profile and then on top of it the details from the chosen desk phone feature template.

Phone Name

Displays when Create New Phone is enabled.

Choose a phone name from the drop-down, which displays options from the Phone Configuration Mapping page (Customizations > Phone Configuration Mapping).

Default phone configuration mappings are available per hierarchy and are used at the selected hierarchy and below. See "Configuration Mapping Files" in the Core Feature Guide for details.

Jabber/Dual-Mode Device Configuration Tab

This tab configures Jabber and dual mode devices that are, by default, moved with the subscriber.

The device configuration is derived from the device profile selected in the associated Profile drop-down (i.e. Android, CSF, Tablet, iPhone, Carrier Integrated Mobile and CTI Remote Device).

The default device profiles are found on the Phone Mapping [Default] page (default menus: Customizations > Phone Configuration Mapping).

You can clone and save a profile if required, and customize the relevant settings, for example, Basic Phone CFT, in order to apply different settings to the device.

See "Configuration Mapping Files" in the Core Feature Guide for more details.

Line Configuration Tab

This tab configures options for moving lines and/or creating lines when moving a subscriber.

When moving a subscriber, the system performs a validation check to ensure that the first line across all devices is common.

All new lines created (or existing lines moved) in the move, are assigned to SNR. For example, if a subscriber with three lines and a Phone, SoftPhone, DeviceProfile, and SNR is moved, all these services will be associated with the three lines. The only exception to this is for Voicemail, where the first line is always selected as the Voicemail line.

At the target hierarchy, the line label updates to FirstName, LastName, and extension.

Creating Lines

When moving a subscriber to another CUCM cluster, you must create new lines (in this case, the option to move lines is hidden).

When creating a new line:

Moving Lines

Important

Lines are exposed and supported by VOSS Automate (if the required conditions already specified in this doc are met).

Existing Services Tab

This read-only tab displays the existing services of a subscriber you're moving.

Model Details: view/UserPhoneMoveUsers_VIEW

Title Description Details
Subscriber Name of individual Subscriber who will be moved.
  • Field Name: 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: [" "]
New Role The user role to use at the destination hierarchy
  • Field Name: move_to_role
  • Type: String
User Template Optional Template for Subscriber update on CUCM
  • Field Name: new_user_cft
  • Type: String
Move Lines 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
  • Field Name: AllowLineMove
  • Type: Boolean
Create New Line 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
Line Template Line template to use for configuration settings.
  • Field Name: lines.[n].template_name
  • Type: String
Inventory Filter Default: default
  • Field Name: lines.[n].line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Directory Number * Directory Number of line to assign.
  • Field Name: lines.[n].directory_number
  • Type: String
Label Label to use for this line.
  • Field Name: lines.[n].label
  • Type: String
Display Display to use for this line.
  • Field Name: lines.[n].display
  • Type: String
Line Template Optional Configuration Template name for Line parameter override
  • Field Name: new_line_cft
  • Type: String
Line Configuration Mapping Line Configuration Mapping
  • Field Name: line_profile
  • Type: String
Android Profile Android profile to be applied.
  • Field Name: android_profile
  • Type: String
CSF Profile CSF profile to be applied.
  • Field Name: csf_profile
  • Type: String
Tablet Profile Tablet profile to be applied.
  • Field Name: tablet_profile
  • Type: String
iPhone Profile iPhone profile to be applied.
  • Field Name: iphone_profile
  • Type: String
Carrier Integrated Mobile Profile Carrier Integrated Mobile profile to be applied.
  • Field Name: cim_profile
  • Type: String
CTI Remote Device Profile CTI Remote Device profile to be applied.
  • Field Name: ctird_profile
  • Type: String
Move Desk Phones 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 Create New Phone at Destination Hierarchy
  • Field Name: new_phone
  • Type: Boolean
Use Existing Phone Configuration Toggle to select an existing Phone for configuration. Default: false
  • Field Name: new_phone_from_source
  • Type: Boolean
  • Default: false
Desk Phone Profile Select the required Desk Phone Profile specified in Phone Configuration Mapping
  • Field Name: phone_type
  • Type: String
Phone Protocol
  • Field Name: new_phone_protocol
  • Type: String
Phone Name 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: name
  • Type: String
Phone Configuration Source Copy configuration from associated phone
  • Field Name: new_phone_config_source
  • Type: String
Phone Type to Copy Configuration from
  • Field Name: new_phone_config_source_product
  • Type: String
Phone Configuration Mapping Phone Configuration Mapping
  • Field Name: phone_profile
  • Type: String
Device Profile Configuration Mapping Device Profile Configuration Mapping
  • Field Name: dp_profile
  • Type: String
Desk Phone Feature Template Optional Configuration Template name for phone parameter override
  • Field Name: new_phone_cft
  • Type: String
Phone Button Template
  • Field Name: new_phone_pbt
  • Type: String
Phone Security Profile
  • Field Name: new_phone_securityprofile
  • Type: String
Use Default CSS Use the CSS defined as the site default at the destination hierarchy
  • Field Name: default_css
  • Type: Boolean
Line CSS Specify a specific CSS to be used at the destination hierarchy
  • Field Name: line_css
  • Type: String
Call Forward CSS Specify a specific CSS to be used at the destination hierarchy
  • Field Name: cfwd_css
  • Type: String
Use Default Device Pool 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 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
Phones
  • Field Name: existingPhones
  • Type: String
Extension Mobility
  • Field Name: existingDeviceProfiles
  • Type: String
Single Number Reach
  • Field Name: existingSnr
  • Type: String
Voicemail
  • Field Name: existingVoicemail
  • Type: String
Webex Meetings
  • Field Name: existingWebex
  • Type: String
Webex App
  • Field Name: existingWebexTeams
  • Type: String
Pexip Conferencing
  • Field Name: existingPexip
  • Type: String
Contact Center
  • Field Name: existingContactCenter
  • Type: String