[Index]

Model: view/ReplacePhone_VIEW

Replace Phones

Full HTML Help

Note

This software release currently only fully supports the replacement of an existing desk phone type with any other desk phone type.

Overview

You will need to replace a phone when choosing 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.

Phone replace does the following:

Note

If you need a customized Phone Template, a default template can be cloned, renamed, and modified via (default menus) Customizations > Configuration Templates. The new customized template is then available in the Phone Button Template drop-down of the Replace Phone feature.

The Replace Phone Template Variable template is available to allow for the option of manual input of the following fields:

Note

When using this template, only these fields are configured by the template.

See "Configuration Templates" for more details if required.

Replace a Phone

To replace a phone:

  1. Log in as Site administrator or higher.

  2. Go to (default menus) Subscriber Management > Replace Phone.

  3. Choose the relevant site (where you want to replace a phone).

    Note

    You can only replace a phone at the Site level.

  4. On the Existing Phone tab:

    1. At Device Name, select the phone you wish to replace.

      Note

      • Other fields on this form are read-only.
      • When choosing a phone name, you can configure (via the Phones tab in the Global Settings), how phone names display in this field. For example, the drop-down may list phones by their description only (default) or by first line only, or by description plus first line. At this drop-down, you can search for the phone using relevant criteria, for example, first letters of a description or line numbers (depending on the Global Setting for phone display).

  5. On the Replacement Phone tab:

    1. Enter the Device Name of the replacement phone (mandatory).

    2. Optionally, choose a Phone Template for the replacement phone.

      Note

      Values in the phone configuration template you choose will override attributes copied from the original phone, and any additional, manually applied settings in the rest of the fields on this tab.

    3. Choose the Product (phone model) of the replacement phone (mandatory).

      Note

      If the existing phone was associated with an entitlement profile, 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. View transaction progress and details in the Transaction Logs. See Transaction Logging and Audit

Related Topics

Global Settings in the Core Feature Guide.

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: view/ReplacePhone_VIEW

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
  • Pattern: ^([sS][eE][pP]|[B][O][T]|[T][A][B]|[T][C][T]|[C][S][F]|[aA][tT][aA])[0-9a-fA-F]{12}$
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
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.
Product Model-type of replacement device
  • Field Name: Replacement Phone.replacement_model
  • Type: String
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