Subscribers#
Overview#
This topic describes the subscriber management functionality, for Cisco (CUCM) subscribers.
Related Topics
View Subscribers#
In the Admin Portal, you can view a summary list of subscribers (at the current hierarchy and down), which includes details of each subscriber’s currently provisioned services, grouped by vendor.
To view subscribers in the Admin Portal, go to (default menus):
Subscriber Management > Subscribers (single vendor environment)
Note
To view the list of multi vendor subscribers, go to (default menus) User Management > User Services > Multi Vendor Subscribers (multi vendor environment).
The table describes columns in the Subscribers summary list:
Column |
Description |
|---|---|
Username |
The username associated with the subscriber. |
First Name / Last Name |
First name and last name of the subscriber. |
Subscriber’s email address. |
|
User Type |
The type of user, either Admin, End User, or End User + Admin (associated with their user role. |
Sync type |
How the user is synced in to VOSS Automate, for example, CUCM, LDAP, Local (the source application of user data.
|
Entitlement Profile |
The name of the entitlement profile associated with the subscriber. |
Primary Extension |
The subscriber’s primary extension number, as selected from the Pattern drop-down list when adding the subscriber. For Multi Vendor only, the line extension used as the primary line (a pre-allocated administrator line, and associated E164 number). |
Phones |
Displays all phones associated with the subscriber at the current hierarchy and below. |
Services |
Graphical view of all services associated with the subscriber, one or more of the following:
|
Located At |
Displays an abbreviated version of the hierarchy showing the lowest point in the hierarchy. The hierarchy type is shown in brackets. When filtering on this column, only use text outside of brackets in the criteria. For example, “SiteName (Site)”, where (Site)= the hierarchy node type, only use the “SiteName” portion in the filter criteria. |
Note
Other subscriber details that may be available in the list view or when adding or viewing a subscriber:
Role - Subscriber role, typically a self-service user role.
Auth Method - as for User [1]
Collaboration - multi vendor subscribers only; the subscriber’s messaging services, for example, WebEx, MS Teams, Zoom
Webex App - whether the subscriber is enabled for Webex App
Contact Center - if enabled, the contact center agent’s Team and extension, if the subscriber is an agent
Device - IP address or hostname
.
Add a Subscriber#
This procedure adds a Cisco (CUCM) subscriber in VOSS Automate.
Note
If Enable CSS filtering is enabled at the customer dial plan, available calling search spaces includes only those marked as a Class of Service in (default menus) Dial Plan Management > Site > Class of Service at the particular site. If another CSS is required, you can add custom CSSs in a CSS field if you know the exact syntax.
If Enable CSS filtering is disabled, the list of available calling search spaces includes all CSSs that are configured on VOSS Automate. [2]
Log in to the Admin Portal as Customer admin or Site admin.
Note
Only a subset of the fields described in this procedure are visible for Site admins.
Go to (default menus) Subscriber Management > Subscribers.
If you’re logged in as Customer admin, choose the site where you want to add the subscriber.
On the Subscribers list view, click the Plus (+) icon.
Configure subscriber details on the components of the form (In the GUI, these components can be rendered as tabs or panels.):
User component
Phones component
Extension Mobility component
Single Number Reach component
Voicemail component
Webex component
Webex App component
Pexip Conference component
Contact Center component
Click Save.
Repeat this procedure to add another subscriber.
User Component#
The User component defines the user details of a VOSS Automate subscriber you’re adding or updating.
Note the following:
Only alphanumeric characters are allowed.
For Cisco users, available entitlement profiles are imported from Unified CM.
When choosing an existing device (phone) to associate with a user and then saving the form, the Phones component is populated with the phone details.
When adding a LDAP user as a subscriber, Password fields are hidden, and Enable Mobility is enabled by default, when any of the following is included or added:
A remote destination phone
Mobile identity for a phone
Remote destination profile (RDP)
If subscriber self-provisioning is set up (allowing subscribers to add their own smart devices, such as company or personal phones), and Enable Mobility is disabled (checkbox cleared), then the setting is enabled when subscribers add a company or personal phone via the Self-service interface.
To enable Extend and Connect in VOSS Automate:
On the Users component, select the Enable Mobility checkbox.
Add the following three groups of users:
Standard CCM End Users
Standard CTI Enabled
Standard CCM Admin User
For subscribers entitled to Webex App, you can add a standalone Webex Apps user by completing the following minimum fields on the User component, then go directly to the Webex App component: Userid, Last Name, Email Address
To provide access to EMCC (only customers configured for EMCC), select Enable EMCC.
The group you choose in BLF Presence Group (configured in Cisco Unified Administration), specifies destinations the subscriber can monitor.
Note
BLF Presence Group authorization works with BLF Presence Groups to allow or block presence requests between groups. The Busy Lamp Field default is set according to the selected number and specifies the Standard Presence Group that is configured with installation.
For Primary Extension, the pattern you choose specifies the lines available to the subscriber. Your choice displays in the Primary Line column on the Subscribers list view.
Subscriber Language and Role is set up in the Site Defaults of the subscriber’s site hierarchy. If this is not specified, hierarchy defaults apply.
Phones Component#
On the Phones component you can add or update a subscriber’s phone.
To add a phone:
On the Phones component, click Add.
Provide a device name, description, product type, device protocol, phone button template, and device security profile.
Note
Values for the following fields are dynamic, and change based on options selected in associated fields.
Product Type
Device Protocol
Phone Button Template
Device Security Profile
For example, when adding a device name with the product prefix and MAC address, a 79XX-type phone has device name ‘SEP’ prefixed, while ATA-type phones have ‘ATA’ prefixed to the MAC address. Field validation and tooltips provide guidance when you select the product type.
Note that the device names for hard phones have prefix SEP or BAP, depending on device type.
The phone type must support the protocol, or it defaults to the protocol option set up in the site defaults. Some phone types support multiple protocols (for example, Cisco 7960 with SCCP and SIP), and some phone types support only one protocol (for example, Cisco 9971 with only SIP). See Site Defaults
Click Save.
Consider the following when adding a phone:
You can override the Phone Button Template value. Either choose another option, or type in a custom value. The value is applied on Unified CM if the Unified CM allows it for the phone type.
Modify phone-specific settings, such as DND Option, Do Not Disturb, and Hot Line Device.
Note
Available phone settings depend on the selected product type (phone type), the device protocol (for example, SIP or SCCP), and the Field Display Policy (FDP) applied by the administrator.
You can choose a Mobile User ID Name from the drop-down list when a Dual-Mode Phone for Android or iPhones is selected. This associates the selected user to the Mobile Identity feature on this phone and must match the Userid added on the User component.
Advanced settings fields are updated automatically for the phone based on the phone type. The phone is automatically associated to the user and is then displayed as an associated device for the subscriber after you save.
When associating a phone that is also associated with another user, the Owner User ID defaults to the first user.
Line assignments are added in the Line section:
The Pattern field only shows lines with status Available or Used.
Pattern options in Route Partition Name are based on the selected partition selected. You can type in a custom pattern value.
Enduser - identifies the user for Presence; you can add a new User ID
Note
VOSS Automate adds the user first and then adds the User ID.
Speed dial information is added in the Speeddial section. Available options depend on the selected Phone Button Template.
Busy lamp field information is added to the Busy Lamp Field section. Options include:
Position
Label
Blf Destination
Add busy lamp field directed details in the Blf Directed Call Park section. Values depend on the values on a valid Directed Call Park on Unified CM.
Specify add on modules (if any) in Add On Module. The phone type must support the model you choose. Leave Load Name blank, unless you want to overwrite the default.
Add a valid IP phone service subscription to the phone, in the Services section:
Choose the IP phone service from the Service Name field.
Note
Subscribing a phone or a device profile to a service auto-populates the URL field in Services. To populate this field, when a service is added or updated the system retrieves the URL and a custom parameter (if any) from
device/cucm/IpPhoneService.To add the service to the device, add a number as the Uri button index to the Url Button Index field. If you don’t add a number, only the service is added.
In the Mobile Identity section, configure mobile identity details when selecting a Dual-Mode Phone.
These fields are auto-populated from the Device Name field: Name, and Dual-Mode Device.
Choose a mobility profile.
Mandatory. Specify a value for Destination Number. This option determines the destination number that is dialed when a call is made to the dual-mode phone.
In the Remote Destination section, to configure your remote destinations when a Dual Mode Phone or Cisco Spark Remote Device is selected as the Product.
Note
Remote destinations represent the mobile (or other) phones that are able to accept transfer from the desktop phone and can be used to initiate calls. Set the Pattern for the Line Association to the Route Partition name. If you enter more than one Pattern and the new Pattern is not on the system, enter the Route Partition Name manually. The Owner User Id and Dual Mode Device Name fields are auto populated.
When a CTI Remote Device is selected as the Product, a CTI Remote Destination section replaces Remote Destination. This allows you to configure your remote destinations specifically for a CTI Remote Device. The Owner User Id and CTI Remote Device fields are auto populated.
In the Vendor Config section, view and edit the configuration settings for each device. Available configuration settings depend on each product type chosen. Update the settings as required.
Note
The administrator password from the
AdminLoginDetailsin Unified CM is not stored in VOSS Automate. Data in VOSS-4UC is obtained from Unified CM.VOSS Automate cannot disable the
Override Enterprise/Common Phone Profile Settingssetting once this check box has been enabled in the Unified CM GUI. This setting may be disabled on Unified CM (if required).
Related Topics
Headset Component#
The headset can be connected to a device associated with a subscriber, so that the Connected Device Name reflects this device. The available headset details are:
Headset Serial Number
Headset Model
Connected Device Name
Connected Device Model
Headset Connection Status: for example “Connected”.
Extension Mobility Component#
The Extension Mobility component configures a subscriber’s extension mobility settings.
Consider the following:
Only one EM Profile can be added for extension mobility in VOSS Automate. If a subscriber is associated with more than one EM profile on the Unified CM, and you sync with VOSS Automate, both will be displayed:
on the subscriber’s EM component (this component)
on the Extension Mobility list view (see Add an Extension Mobility Profile).
Values for the following fields are dynamic, based on selections in associated fields:
Product
Protocol
Phone Button Template
Note
For details of configuration options on this component, see the descriptions for the Phones component. The exception is remote destination information, which is not relevant for extension mobility.
Ensure that you associate the extension mobility profile and target phone for login with the extension mobility service.
If the Enable Extension Mobility Cross Cluster (EMCC) feature is enabled on the User component, you must choose a CSS for this device from the Extension Mobility Cross Cluster CSS drop-down. The selected CSS is used as the device CSS that gets assigned to the phone when the user logs in to this remote phone. New CSS’s or existing CSS’s can be added or modified in Unified CM. Refer to the Cisco Unified Communications Manager Features and Services Guide for more details if required.
See also Add an Extension Mobility Profile to add or edit an extension mobility profile, and associate it to one or more subscriber.
Single Number Reach Component#
On the Single Number Reach component, note that you cannot add more than one Remote Destination Profile for Single Number Reach. However, you can add more than one Remote Destination Rdp.
To enable Extend and Connect in VOSS Automate, first complete the following task:
Select the Enable Extend and Connect check box.
Select the CTI remote device that you created from the CTI Remote Device Name drop-down list.
Voicemail Component#
The Voicemail component configures the subscriber’s voice mail service, provided a valid Cisco Unity Connection server is available.
When configuring voicemail:
PIN and Password can be left blank. In this case, the default credential policy on the Cisco Unity Connection is used.
If the user on Cisco Unity Connection is LDAP integrated, the Password field is visible but should be ignored.
The Voicemail Line drop-down list only shows lines with status ‘Available’ or ‘Used’ that are not already configured for Voicemail.
Note
The Cisco Unity Connection (CUC) server uses this line as a caller ID, so you should set it to the subscriber’s default line.
When adding Voicemail for a subscriber, all Call Forward To Voicemail check boxes, except Call Forward All, are enabled on the chosen Line, and the Voicemail Profile setting will be set based on the Site Default Doc setting “Default CUCM Line Voicemail Profile” (Site Management > Defaults > Line Defaults).
WebEx Component#
The WebEx component configures the subscriber’s Webex details, if a valid server is available. The mandatory fields on this component are populated with the values entered on the User component.
Note
Any updates on the User component do not update these values; values are populated only during the Add workflow.
Webex App Component#
The Webex App component adds a Webex App User and enables a subscriber’s services and roles.
Consider the following:
Webex App is only available when:
A Webex App Service has been created at the required customer level (see Cisco Webex Service)
Webex App is enabled in the Entitlement Profile associated with the Subscriber.
The following fields are read only and cannot be edited:
Login Enabled
Invite Pending
On-Prem UCM Calling Service (managed automatically by the VOSS Webex driver)
Assigned Licenses can be selected from the available licenses on the Webex App service.
Once you have successfully added the subscriber as a Webex App user, the Webex App column displays status Enabled for this subscriber.
The Subscriber e-mail address is required to enable Webex App for the Subscriber.
Pexip Conference Component#
The Pexip Conference component adds and configures the subscriber’s Pexip services.
Consider the following:
The Pexip Conference component is only available if a Pexip Conference service has been configured at the required hierarchy (via the Quick Add Subscriber Group).
Conferencing must be enabled in the entitlement profile associated with the subscriber.
Once a subscriber is successfully added as a conferencing user, you can view the service as an enabled service in the Conferencing column on the Subscribers list.
Contact Center Component#
On the Contact Center component you can add, remove, or update CCX agent capabilities for a subscriber.
See also: Contact Center
The Contact Center component displays only if these conditions are met:
CCX device has been added and is available to the hierarchy.
Contact Center Service is configured and available to the hierarchy.
Contact Center is enabled in the entitlement profile associated with the subscriber.
For the agent:
Since CCX restricts the use of special characters, these are restricted in the Alias.
Team, Resource Group and Skill names need to be set up or synced from the CCX device before they can be assigned.
Automatic Available is enabled by default.
An IPCC extension is automatically managed for the Unified CM user associated with the Contact Center Agent.
You may change the agent’s Controlled Device to one that is already associated with the subscriber.
Update a Subscriber#
This procedure modifies settings for one or more subscribers.
Perform these steps:
Log in as a Customer or Site administrator.
Note
Only a subset of fields described in this procedure are visible to Site admins.
Choose the relevant site.
Open the Subscriber summary list page:
In a single vendor environment, go to (default menus) Subscriber Management > Subscribers.
In a multi vendor environment, go to (default menus), User Management > User Services > Multi Vendor Subscribers
Click on the relevant subscriber to open the Subscriber settings.
Make the changes you require. For details, see Add a Subscriber.
Note
You can add one or more phones.
If Extension Mobility is associated with more than one subscriber, it will not be removed when removing it from one subscriber.
Phone line settings can be edited directly on the Subscriber page.
Expanding the Line section of a Phone or Extension Mobility Profile displays a link directly to the line editing form. Once you’ve saved your changes, the Subscriber edit page re-opens.
If your menu layout has more than one entry for
relation/LineRelationand associated Field Display Policy, the link for the line edit applies to the first one found (searching from top to bottom) in your menu layout (if available).
Save your changes.
Note
Filtering on the following columns on the Subscribers list view is described in more detail below:
Located At
Displays an abbreviated version of the hierarchy showing the lowest point in the hierarchy. The hierarchy type is shown in brackets. When filtering on this column, do not use text included inside the brackets in the filtering criteria. For example: “SiteName (Site)”, where (Site) = the hierarchy node type, only search using the “SiteName” portion of the field.
Device
Allows you to filter on IP Address or Host Name.
Phone
When filtering on this column, results include all phones at the current hierarchy, and below, regardless of the Phone column in which they reside.
On saving a Subscriber, workflows will execute which will synchronise the subscriber with its associated application: LDAP(top-down), Webex, UCCX, etc.
Deleting Subscribers#
Overview#
Subscribers are deleted via (default menus) Subscriber Management > Subscribers.
The system performs various actions when deleting a subscriber via Subscriber Management. These actions depend on the user type and the subscriber’s device associations.
Subscriber types
User types |
Description |
|---|---|
Non-LDAP synced users |
|
LDAP Integrated at VOSS Automate Users |
|
LDAP synchronized users |
|
Subscriber associations
Subscribers can have no device associations, or they can be associated with devices such as the following:
Phones
Extension mobility
Single Number Reach (SNR)
Voicemail
WebEx
VOSS Automate actions when deleting a subscriber
The system performs these tasks when deleting a subscriber via Subscriber Management > Subscribers, depending on the user type and whether the subscriber has associated devices:
User Type |
With Devices |
Without Devices |
|---|---|---|
Non-LDAP Synchronized Users LDAP Integrated at Cisco Unified CM Users |
Deletes all devices:
Deletes the Provisioning Status. |
Deletes the Provisioning Status. |
LDAP Synchronized Users |
Deletes all devices:
Deletes the user from Cisco Unified CM: device/cucm/User Removes the Cisco Unity Call Manager from the Provisioning Status. |
Deletes the user from Cisco Unified CM: device/cucm/User Removes the Cisco Unity Call Manager from the Provisioning Status. |
Important
You can configure VOSS Automate to retain desk phones (hard phones, prefixed SEP or BAP) associated with a subscriber you’re deleting, and to update these phones via a configuration template (CFT) once the subscriber is deleted. To do this, go to (default menus) Customizations > Global Settings, and on the Phones tab, set Retain Desk Phones when Subscriber is deleted to Yes, then select an option for applying a CFT to update the retained phone/s.
You can also configure that Webex accounts and Voicemail accounts associated with deleted CUCM subscribers will be retained (or removed) in the LDAP user sync that handles deleted CUCM subscribers. This is done via Customizations > Global Settings > Webex App tab or Voicemail tab, as applicable).
Related Topics
Delete a Subscriber#
This procedure deletes and unprovisions a subscriber.
Log in to the Admin Portal as a Customer admin or Site admin.
Note
Only a subset of fields described in this procedure are visible to Site admins.
Choose the relevant site.
Go to (default menus) Subscriber Management > Subscribers.
Select the checkbox for each subscriber you want to remove; then click Delete.
Click Yes to confirm.
The deleted subscriber is removed from the list. All elements associated with the subscriber are removed, except lines.
Note
If you have the global setting for phones configured to retain the subscriber’s hard phones, then only the soft phones are removed. See Global Settings in the Core Feature Guides (Phones tab).
For scenarios that include an LDAP-integrated CUCM, users are deleted from the LDAP directory and not from the VOSS Automate system. Set up a data sync to synchronize the removal of the user.