[Index]

Model: relation/SubscriberPhone

Phones

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

This procedure configures phones.

Preparation for Adding Phones (CUCM)

Before adding phones in VOSS Automate, you will need to add and configure the following items on Cisco Unified Communications Manager (Unified CM), and then import these items into VOSS Automate:

• Softkey templates (Softkey templates can be set up on CUCM or in VOSS Automate)
• Phone button templates
• Service parameters and enterprise parameters for subscriber services
• Custom SIP profiles
• Service profiles for Jabber
• Phone services

View and Update Sites Defaults for Phones

When setting up VOSS Automate, default values are created when adding Providers, Customers, and Sites. For example, the Site IDs. If the site dial plan specifies Device Pool, CSS, and Partition names, these can also be selected. To identify the site-related values, see the naming conventions used in Modify Site Defaults.

The Site Defaults also populates certain default values for phones.

To view and update site defaults for phones:

1. In the VOSS Automate Admin Portal, go to (default menus) Site Management > Defaults.

2. Click the relevant site defaults doc in the list.

3. View or update phone parameter defaults for the site on the following tabs:

   • General Defaults tab

   • Device Defaults tab

     See Modify Site Defaults for details regarding the value to fill out for phone parameters such as partitions and CSSs.

   Note

   • CSS Filtering only applies to HCS dial plans.
   • If Enable CSS filtering is selected in the customer dial plan, the available calling search spaces includes only those marked as Class of Service at the site (via, default menus, Dial Plan Management > Site > Class of Service). You can add a custom CSS in a CSS field if you know the exact syntax.
   • If Enable CSS filtering checkbox is cleared, the available calling search spaces includes all CSSs configured on Unified CM.

Add a Phone

This procedure adds a phone.

1. Log in to the Admin Portal as a Provider, Customer, or Site admin.

   Note

   Only a subset of fields are available to Site admins.

2. Choose the hierarchy.

3. Go to (default menus) Subscriber Management > Phones.

4. View the list of phones on the Phones list.

   Note

   An administrator with the required access profile can click Fetch real-time phone status on the toolbar to fetch the Unified CM phone IP address and status directly from the Unified CM. Data is fetched in real-time and displays read-only values in the following columns:

   • Registration Status column (for example, "None", "UnRegistered with CUCM-11-5-IP2", "Registered with CUCM-11-5-IP2")
   • IP Address column

   Fetched data is not cached or stored in the database, and cannot be exported or filtered. Real-time data displays the latest data for the current list of phones on the Admin Portal. Prior to fetching real-time status updates, existing column values display cached values from the RIS data collector (if enabled).

   The Activate Phone Status Service setting is enabled by default and can be managed by system level administrators. See the Advanced Configuration Guide for details.

5. Click Add, then configure the phone and its associated settings on the following tabs.

   Tab	Description
   Phone	Default values are applied for some fields (such as Device Protocol, BAT Phone Template, and Device Security Profile), based on the selected product type. The Vendor Config settings are related to the selected phone type. Fields that display are based on the selected Product (device type) and the Device Protocol (such as SIP or SCCP). The supported features available for each phone type are retrieved from the related Unified CM. To override the default Phone Button Template, either choose another template, or enter a custom value. The new value is applied on the Unified CM if it allows that phone type. If you don't see a template that you are looking for in the drop-down list (for example, for Phone Button Template, Device Security Profile or SIP Profile), edit the template on Unified CM, and then sync the template into VOSS Automate to have it appear in the drop-down list. If the Product type list does not contain the phone or endpoint you want, take the following steps. In Unified CM, install a COP file for the endpoint you want. Install the COP file only once for the Unified CM instance where the endpoint is added. Then in VOSS Automate, import the phone button template from Unified CM. Follow these steps while creating a CTI Remote Device to enable Extend and Connect in VOSS Automate: Enter the Device Name. For example, CTIRD<USERID>. Choose the Product as CTI Remote Device. Choose the Owner User ID from the drop-down list. Choose the SUBSCRIBE Calling Search Space name from the drop-down list. Choose the Rerouting Calling Search Space name from the drop-down list.
   Lines	This tab serves two purposes. To show all the lines that are associated with the device To associate lines with the device. The Lines sections reflect the Lines object in Unified CM. You can add lines to this group and associate lines with the device. You can add custom lines by entering a line in the drop-down list. If Number Inventory is enabled, you can select a number from the list of available numbers.
   Speed Dials	Allows you to configure speed dials for the device. Available speed dials depend on the device's Phone Button Template. The order in which Speed Dial entries are added matches the slots that are available in Unified CM.
   Services	Used to set IP Phone services. Once you choose the IP phone service, the system retrieves the URL and a custom parameter (if any, for example, ext1 and ext2) from device/cucm/IpPhoneService, and populates the URL field.
   Busy Lamp Fields	Allows you to configure busy lamps for the device. Available busy lamp fields depend on the device's Phone Button Template.
   Blf Directed Call Parks	Allows you to configure Busy Lamp Field directed call parks for the device. Available BLF-directed call parks depend on the device's Phone Button Template. Create BLF-directed call parks in Call Routing > Directed Call Parks on Unified CM before configuring them from this tab. The available BLF-directed call parks match those created for each specific Route Partition Name.

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

   Malformed table.

   +---------------------------------+------------------------------------------------------------------------------------+
   | Tab                             | Description                                                                        |
   +=================================+====================================================================================+
   |                                 | Only applies to a Dual Mode Phone, Spark Remote                                    |
   |                                 | Device, or CTI Remote Device, and allows you to                                    |
   |                                 | enter the relevant Mobile Identity and Remote                                      |
   | Dual Mode Settings              | Destination (or CTI Remote Destination)                                            |
   |                                 | parameters for the device. These parameters                                        |
   |                                 | include Name, Destination Number, Owner User ID,                                   |
   |                                 | Dual Mode Device Name (or CTI Remote Device), and                                  |
   |                                 | Answer Too Soon and Too Late Timers.                                               |
   +---------------------------------+------------------------------------------------------------------------------------+
   |                                 | Only applies to a Dual Mode Phone, Spark Remote                                    |
   |                                 | Device, or CTI Remote Device, and allows you to                                    |
   |                                 | enter the relevant Mobile Identity and Remote                                      |
   | Certificate Authority Functions | Destination (or CTI Remote Destination)                                            |
   |                                 | parameters for the device. These parameters                                        |
   |                                 | include Name, Destination Number, Owner User ID,                                   |
   |                                 | Dual Mode Device Name (or CTI Remote Device), and                                  |
   |                                 | Answer Too Soon and Too Late Timers. See                                           |
   |                                 | Certificate Authority Functions Fields                                      |
   |                                 |                                                                                    |
   |                                 | The date-time value must be added manually as: ``CCYY:MM:DD:HH:MM``                |
   +---------------------------------+------------------------------------------------------------------------------------+
   

6. Save your changes to add the phone.

Update a Phone

Note the following for updating a phone:

• The system checks that a line exists when you add it. If it doesn't exist, the line is added.
• The line edit form contains a hyperlink to the line settings that opens the Line relation details. Once you save your changes, the Phone page re-opens. Alternatively, you can use the browser Back button to return to the Phone editing page.
• If your menu layout has more than one entry for line management (relation/LineRelation) and associated Field Display Policy, then the form opened by the Link to Line hyperlink applies the first one (searching from top to bottom) found in the menu layout.
• The phone and User Remote Destination are updated.

View and Update Phone Vendor Config Settings

The Vendor Config settings will display if the Field Display Policy (FDP) allows it.

You can access the vendor configuration settings for a phone as follows:

1. In the Admin Portal, go to (default menus) Subscriber Management > Phones.

2. On the Phones list view, click on a phone to open its settings.

3. On the Phones tab, scroll down to the bottom of the page to locate the Vendor Config setting.

4. Click Vendor Config to open the configuration screen:

   Settings can be enabled or disabled. Ensure you're setting values correctly for Bulk Loaders, the API, or in custom Configuration Templates, where values must be defined as key-value pairs:

   • On Unified CM, in some cases the value 0 is "Enabled" and in other cases 0 is "Disabled".

   • It is recommended that settings on the Unified CM are configured manually on a sample phone to the value you want, before exporting the phone. Then use the example settings as the basis for your Bulk Loaders, API, or custom Configuration Templates.

   • The required value may change depending on the setting being applied, for example:

     To enable the "Web Access" for a phone, configure the following:

     • Key: webAccess
     • Value: 0

     To disable "Web Access" for a phone, configure the following:

     • Key: webAccess
     • Value: 1

     To enable "Settings Access", configure the following:

     • Key: settingsAccess
     • Value: 1

     To disable "Settings Access", configure the following:

     • Key: settingsAccess
     • Value: 0

Phone Type Management

After you make changes to any phone model specific data in Unified CM, for example by loading a new BAT file, editing phone button templates, security profiles, and so on, then in order to utilize that data in VOSS Automate, you need to do a sync of the Unified CM.

Include the following models in the data sync - depending on what you changed:

• device/cucm/PhoneType - should always be included. Note this includes the expansion modules as well as the phone types.
• device/cucm/PhoneButtonTemplate - if button templates were changed
• device/cucm/PhoneSecurityProfile - if phone security profiles were modified

If you do a full sync or full import this will make the changes available in VOSS Automate. However, between full syncs, it is best practice to create a sync setup with a model type list that includes the above model types. This allows you to run an ad-hoc sync with a very limited scope as needed - if changes are made in the Unified CM that require a sync.

If adding new phone types to the system, you may also need to edit your device groups and entitlement profiles (if used) to have them show as options to the correct users.

Enhanced INI Filtering

If the Enhanced INI Filtering feature is enabled, administrators have access to the Inventory Filter dropdown list menu for lines on the following forms:

• Phones
• Quick Add Subscriber
• Subscribers

The filter would typically be used to show a filtered, shorter dropdown list of directory numbers.

The following options are available in the Inventory Filter list:

• Default

  This filter - enabled by default - corresponds with the standard filter of Directory Numbers:

  • used and unused INI numbers above and at the current hierarchy.
  • used and unused Associated E164 numbers above and at the current hierarchy.

• Show Unused Numbers with Associated E164's (Site Only)

  • Shows unused INI numbers with Associated E164 numbers at the current site only.
  • Format is: <INI number> <E164 number>. Example: 99003 \+279990003.

• Show Unused Numbers with Associated E164's

  • Shows unused INI numbers with Associated E164 numbers above and at the current hierarchy.
  • Format is: <INI number> <E164 number>. Example: 99003 \+279990003.

• Show Used Numbers (Site Only)

  • Shows used numbers at the current site only.
  • Format is: <INI number> (used) or <INI number> (used) <E164 number>. Example: 99000 (used) \+279990000.

• Show Used Numbers

  • Shows used numbers above and at the current hierarchy.
  • Format is: <INI number> (used) or <INI number> (used) <E164 number>. Example: 99000 (used) \+279990000.

• Show Numbers belonging to this Subscriber

  • The option shows results if a subscriber is selected on the Quick Add Subscriber or Subscriber form, or is associated with the selected phone on the Phones form.
  • Format is: <INI number> (used) or <INI number> (used) <E164 number>. Example: 99000 (used) \+279990000.

Phone based relation.

Model Details: relation/SubscriberPhone