[Index]

Model: view/ReplacePhone_VIEW

Replace Phone Overview

Note

The Replace Phone feature is typically used when you want to choose a new phone for a user or when a phone type is no longer supported.

The feature provides an easy way to replace an existing (old) phone with a different phone model, while retaining as much of the old phone's configuration as possible. It performs the following:

Note

If you need a customized Phone Template, a default template can be cloned, renamed and modified from Customizations > Configuration Templates. This customization is then available in the Phone Button Template drop-down of the Replace Phone feature.

See "Configuration Templates" for more details if required.

Using Replace Phone

The Replace Phone feature is only available at a site hierarchy node.

  1. Log in as Site administrator or higher.

  2. Choose Subscriber Management > Replace Phone. A pop-up window opens to navigate to the site at which the phone is to be replaced.

  3. On the Existing Phone tab:

    1. Choose the Device Name of the phone that you want to replace.

      The Product, Device Protocol, Phone Button Template, and other values are shown automatically as read-only values.

  4. On the Replacement Phone tab:

    Note

    If you choose a Phone (Configuration) Template, all other fields available on the Replacement Phone tab are redundant. Even if certain fields are populated, the Phone Template values override them.

    1. Enter the Device Name of the replacement phone (mandatory).
    2. Choose a Phone Template (optional) for the replacement phone if you want to override the attributes copied from the original phone and the manual settings below.
    3. Choose the Product (phone model) of the replacement phone (mandatory). Note that if the existing phone was associated with an entitlement profile, then the replacement Product drop-down only displays phone types that are allowed by the entitlement profile.
    4. Choose the Device Protocol (mandatory).
    5. Choose a Phone Button Template value for the replacement phone, if one is available (optional).
    6. Choose the Security Profile for the replacement phone (mandatory).
    7. Enter a Description for the phone (optional).
  1. Click Save.

Model Details

Title Description Details
Existing Phone Group Assigned by FDP
  • Field Name: Existing Phone
  • Type: Object
Device Name Existing device which will be cloned
  • Field Name: Existing Phone.existing_phone
  • Type: String
Product Model type of existing device
  • Field Name: Existing Phone.existing_phone_type
  • Type: String
Device Protocol Protocol used by existing device
  • Field Name: Existing Phone.existing_phone_protocol
  • Type: String
Phone Button Template Phone Button Template used by existing device
  • Field Name: Existing Phone.existing_phone_pbt
  • Type: String
Line 1 First DN on the existing device
  • Field Name: Existing Phone.existing_phone_line
  • Type: String
Username User that is currently associated with this existing device
  • Field Name: Existing Phone.username
  • Type: String
Entitlement Profile Entitlement Profile of the currently associated user (if any)
  • Field Name: Existing Phone.entitlement_profile
  • Type: String
Replacement Phone Group Assigned by FDP
  • Field Name: Replacement Phone
  • Type: Object
Device Name New name to be given to target replacement device
  • Field Name: Replacement Phone.replacement_phone
  • Type: String
Phone Template (optional) Phone CFT can be selected here. If specified, then it will be used for parameter over-ride.
  • Field Name: Replacement Phone.cft
  • Type: String
_Trigger This _trigger field is for future use (improvements in upcoming iterations)
  • Field Name: Replacement Phone._trigger
  • Type: String
Product Model-type of replacement device
  • Field Name: Replacement Phone.replacement_model
  • Type: String
Phone fields below are hidden when a Phone CFT is specified Default: The above CFT will be used to supply replacement values for the phone fields.
  • Field Name: Replacement Phone._message
  • Type: String
  • Default: The above CFT will be used to supply replacement values for the phone fields.
Device Protocol Protocol to use for target replacement device
  • Field Name: Replacement Phone.protocol
  • Type: String
Phone Button Template Phone Button Template to use for target replacement device
  • Field Name: Replacement Phone.pbt
  • Type: String
Security Profile Security Profile to use for target replacement device
  • Field Name: Replacement Phone.security_profile
  • Type: String
Description Description string to use for target replacement device
  • Field Name: Replacement Phone.replacement_description
  • Type: String
API reference for view/ReplacePhone_VIEW