Cisco BroadWorks Owner Flag In Device List To Support Webex Client .

1y ago
27 Views
2 Downloads
769.06 KB
36 Pages
Last View : 3d ago
Last Download : 4m ago
Upload by : Roy Essex
Transcription

Cisco BroadWorks Owner Flag In Device List To Support Webex Client Shared Lines Feature Description Release 25.0 Document Version 2.1 esFD-R250 Portfolio Feature Number BWKS-4860 Epic Number BWKS-5245

Copyright Notice Copyright 2022 Cisco Systems, Inc. All rights reserved. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: ks.html. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1721R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 2 OF 36

Document Revision History Version Reason for Change Date 0.1 Draft Created document. August 31, 2022 0.2 Draft Updated document with PS interface changes September 06, 2022 0.3 Draft Updated document after PS interface changes review comments September 07, 2022 0.4 Draft Updated document after XSI interface changes review comments September 09, 2022 1.0 Approved Approved Document. September 14, 2022 2.0 Approved Approved document. September 14, 2022 2.1 Prepared Document for Publishing. October 31, 2022 CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 3 OF 36

Table of Contents 1 Feature Purpose and Overview .7 Purpose .7 Overview .7 2 Use Cases .8 Webex Client successfully finds correct device profile type among many choices .8 Webex Client fails to find correct device profile type among many choices.8 3 Provisioning Description . 10 Licensing Impacts . 10 Get Primary And SCA Device List . 10 Web Impacts . 10 Help Pages Impacts . 10 CLI Impacts . 10 Public Interface Impacts . 10 4 Feature Operation . 11 Overview . 11 Xsi-Actions Response Example . 12 5 Service Interactions . 14 6 System Management . 15 Accounting . 15 Monitoring and Troubleshooting . 15 Alarms and PMs . 15 Commands and Utilities . 15 Device Management . 15 7 Restrictions and Limitations . 16 Functional Limitations . 16 Upgrade/Rollback Limitations . 16 Enterprise Migration Restrictions . 16 8 Service Patch Information . 17 Functional Differences. 17 Provisioning Differences. 17 Feature Operational Differences. 17 Service Interaction Differences . 17 System Management Differences . 17 Feature Activation Impacts. 17 Method of Activation . 17 Activatable Feature ID and Dependencies . 17 9 Provisioning Interface Impacts . 18 Centralized Configuration Data. 18 CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 4 OF 36

CLI Impacts . 18 Open Client Interface-Provisioning Impact. 18 Summary . 18 Command Impacts . 18 Deprecated Commands . 18 Reporting Impacts . 18 External Authentication Impacts . 18 Application Server Portal API Impacts . 18 Network Server Location API Impacts . 18 NSSync API Impacts . 18 Application Server Dump Impacts . 18 BroadCloud Dump Impacts. 18 Service License Reporting Impact . 18 Treatments . 18 Media Announcements (Audio and Video) . 19 BroadWorks Common Communication Transport Impacts . 19 Device Management Impacts . 19 10 Accounting Impacts. 20 Summary of Changes . 20 Generation of Accounting Records . 20 Impact to Accounting Fields (CDR) . 20 Original Called Reason and Redirection Reason . 20 Related Call ID . 20 Example . 20 11 System Management Impacts. 21 Performance Management Impacts . 21 Fault Management Impacts . 21 Scripts and Tools . 21 12 Execution/Call Processing Impacts . 22 Xtended Services Interface Impact. 22 Summary . 22 Xsi-Actions Impacts . 22 Xsi-Events Impacts . 24 Xsi-MMTel Impacts . 24 Schema Impacts . 24 SIP/MGCP Interface Impact . 26 13 Client Application Impacts . 27 OCI-P Impacts . 27 Call Control Impacts . 27 Window Impacts . 27 14 Deployment/Operational Impacts . 28 CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 5 OF 36

Configuration File Impacts . 28 Security Impacts . 28 Scheduled Tasks . 28 Third-Party Software. 28 Server Logging Impact . 28 Client Application Impacts . 28 15 System Engineering Impacts . 29 Processing Impacts . 29 Memory Impacts . 29 Disk Usage Impacts . 29 Port Usage Impacts . 29 Hardware Impacts . 29 Client Application Messaging Impacts. 29 16 Service Patch Interface Impacts . 30 Service Patch Interface Differences . 30 Provisioning Differences. 30 Accounting Differences . 30 System Management Differences . 30 Execution/Call Processing Differences . 30 Client Application Differences . 30 Deployment/Operational Differences . 30 System Engineering Differences . 30 Upgrade and Rollback Differences . 30 Feature Activation Impacts. 30 Behavior Impacts upon Activation . 30 Provisioned Data Impacts on Activation . 30 Provisioned Data Impacts on Deactivation . 30 OCI Command Behavior Prior to Activation. 30 Acronyms and Abbreviations . 31 References . 36 CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 6 OF 36

1 Feature Purpose and Overview Applicable Telephony Application Server (TAS) Application Server (AS) Purpose This feature enhances Cisco BroadWorks to indicate whether a user owns a device i.e. it is assigned the primary lineport for a device. For example, a Webex client cannot correctly determine a matching device profile type and retrieve the device config, if there are more than one device listed to a user of the same device profile type. This feature enables to select the appropriate device which is assigned the primary lineport for a device. Overview This feature enhances Xsi-Actions command /user/ userid /profile/device and /user/ userid /profile/device/ lineport to contain a new attribute "isDeviceOwner" in the GET response. If a user is assigned the primary lineport for a device, then the "isDeviceOwner" is set to "true", otherwise "false". CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 7 OF 36

2 Use Cases In the following use cases, it is assumed that: o the “Business Communicator – PC” device profile type is for the Webex Desktop Client. o User A and User B are Webex for BroadWorks users. Webex Client successfully finds correct device profile type among many choices 1. User A is assigned a Device M with device profile type “Cisco-CP-78xx-88xx-68xx3PCC” device as its primary appearance. 2. Device X is created with device profile type “Business Communicator – PC” and assigned to User A as a shared call appearance. The lineport for that shared call appearance is the primary lineport for Device X 3. Device Y is created with device profile type “Business Communicator – PC” and assigned to User B as the primary appearance. The lineport for this appearance is the primary lineport for Device Y. 4. Device Y is assigned as a shared call appearance on User A with a lineport that is not the primary lineport. 5. User A logs into their Webex desktop client. 6. The Webex client does an XSI-Actions query to get the device list for User A http(s):// hostaddress:port /com.broadsoft.xsiactions/v2.0/user/ userid /profil e/device and receives a list indicating (not all fields shown): deviceName deviceType endpointType isOwner M Cisco-CP-78xx-88xx-68xx3PCC Primary true X Business Communicator – PC Shared Call Apperance true Y Business Communicator – PC Shared Call Apperance false 7. The Webex client looks for devices of type “Business Communicator – PC” and an isOwner flag true. It finds one device (X) that satisfies that criteria and uses the asscoated device username/password in the XSI response to retrieve the device configuration file. Webex Client fails to find correct device profile type among many choices 1. User A is assigned a Device M with device profile type “Cisco-CP-78xx-88xx-68xx3PCC” device as its primary appearance. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 8 OF 36

2. Device X is created with device profile type “Business Communicator – PC” and assigned to User A as a shared call appearance. The lineport for that shared call appearance is the primary lineport for Device X 3. Device Y is created with device profile type “Business Communicator – PC” and assigned to User B as the primary appearance. The lineport for this appearance is not the primary lineport for Device Y. 4. Device Y is assigned as a shared call appearance on User A with a lineport that is indicated as the primary lineport for the device. 5. User A logs into their Webex desktop client. 6. The Webex client does an XSI-Actions query to get the device list for User A http(s):// hostaddress:port /com.broadsoft.xsiactions/v2.0/user/ userid /prof ile/device and receives a list indicating (not all fields shown): deviceName deviceType endpointType isOwner M Cisco-CP-78xx-88xx-68xx3PCC Primary true X Business Communicator – PC Shared Call Apperance true Y Business Communicator – PC Shared Call Apperance true 7. The Webex client looks for devices of type “Business Communicator – PC” and an isOwner flag true. It finds two devices (X and Y) that satisfy the criteria and can’t reliably select the correct one to get credentials for the device configuration file. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 9 OF 36

3 Provisioning Description Licensing Impacts There is no impact. Get Primary And SCA Device List There is no impact. Web Impacts There is no impact. Help Pages Impacts There is no impact. CLI Impacts There is no impact. Public Interface Impacts There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 10 OF 36

4 Feature Operation Overview This feature enhances the following two Xsi-Actions command to include a new attribute called isDeviceOwner. /user/ userid /profile/device /user/ userid /profile/device/ lineport An HTTP(S) GET on the XSI URI : http(s):// hostaddress:port /com.broadsoft.xsiactions/v2.0/user/ userid /profile/device returns a list of devices associated with the user with the following attributes (added attributes highlighted): deviceName deviceLevel deviceType deviceLinePort deviceTypeUrl deviceUserNamePassword version allowTermination endpointType isDeviceOwner An HTTP(S) GET on the XSI URI : http(s):// hostaddress:port /com.broadsoft.Xsiactions/v2.0/user/ userid /profile/device/ li nePort returns the following information associated with the lineport for the device (added attributes highlighted) : deviceName deviceLevel deviceType deviceLinePort deviceTypeUrl deviceUserNamePassword version endpointType (primary, Shared Call Appearance or mobility) allowTermination CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 11 OF 36

isDeviceOwner Xsi-Actions Response Example /user/ userid /profile/device If the Primary Line/Port check box is checked under Identity Device Profiles ( Resources) then "isDeviceOwner" is set to "true", otherwise set to "false". Request URL: http(s):// hostaddress:port enter.test/profile/device HTTP Request Type: GET ?xml version "1.0" encoding "ISO-8859-1"? AccessDevices xmlns "http://schema.broadsoft.com/xsi" accessDevice deviceName CC-David@callcenter.test /deviceName deviceLevel System /deviceLevel deviceType Polycom /deviceType deviceLinePort 10.2.202.18:5060 /deviceLinePort deviceTypeUrl http://10.2.202.18/dev /deviceTypeUrl deviceUserNamePassword userName CC-David@callcenter.test /userName password gfhjjkl /password /deviceUserNamePassword macAddress AAAAAAAAAAAA /macAddress version Grandstream BT100 1.0.5.23 /version endpointType Primary /endpointType isDeviceOwner false /isDeviceOwner /accessDevice accessDevice deviceName CC-David@callcenter.test /deviceName deviceLevel System /deviceLevel deviceType Polycom /deviceType deviceLinePort 10.2.202.19:5060 /deviceLinePort deviceTypeUrl http://10.2.202.18/dev /deviceTypeUrl deviceUserNamePassword userName CC-David@callcenter.test /userName password gfhjjkl /password /deviceUserNamePassword macAddress AAAAAAAAAAAA /macAddress version Grandstream BT100 1.0.5.23 /version endpointType Shared Call Appearance /endpointType isDeviceOwner true /isDeviceOwner /accessDevice /AccessDevices /user/ userid /profile/device/ lineport Request URL: http(s):// hostaddress:port com/profile/device/user1-mobile@example.com HTTP Request Type: GET ?xml version "1.0" encoding "ISO-8859-1"? AccessDevices xmlns "http://schema.broadsoft.com/xsi" accessDevice deviceName user1-mobile /deviceName deviceLevel Group /deviceLevel deviceType Business Communicator - Mobile /deviceType deviceLinePort user1-mobile@example.com /deviceLinePort deviceTypeUrl http://10.16.120.119:80 /deviceTypeUrl deviceUserNamePassword CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 12 OF 36

userName user1@example.com /userName password password /password /deviceUserNamePassword version bc-uc - Communicator (21.5.1.5415 Android Mobile) /version endpointType Primary /endpointType allowTermination true /allowTermination isDeviceOwner true /isDeviceOwner /accessDevice /AccessDevices CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 13 OF 36

5 Service Interactions There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 14 OF 36

6 System Management Accounting There is no impact. Monitoring and Troubleshooting Alarms and PMs There is no impact. Commands and Utilities There is no impact. Device Management There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 15 OF 36

7 Restrictions and Limitations Functional Limitations There are no limitations. Upgrade/Rollback Limitations There are no limitations. Enterprise Migration Restrictions There are no restrictions. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 16 OF 36

8 Service Patch Information This feature is patched in the following: Release 23.0 (feature patching stream called Release 23.0.1075) Release 24.0 (feature patching stream called Release 24.0.944) Functional Differences Provisioning Differences There are no differences. Feature Operational Differences There are no differences. Service Interaction Differences There are no differences. System Management Differences There are no differences. Feature Activation Impacts Method of Activation There is no impact. Activatable Feature ID and Dependencies There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 17 OF 36

9 Provisioning Interface Impacts Centralized Configuration Data There is no impact. CLI Impacts There is no impact. Open Client Interface-Provisioning Impact Summary There is no impact. Command Impacts There is no impact. Deprecated Commands There are no deprecated commands. Reporting Impacts There is no impact. External Authentication Impacts There is no impact. Application Server Portal API Impacts There is no impact. Network Server Location API Impacts There is no impact. NSSync API Impacts There is no impact. Application Server Dump Impacts There is no impact. BroadCloud Dump Impacts There is no impact. Service License Reporting Impact There is no impact. Treatments There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 18 OF 36

Media Announcements (Audio and Video) There is no impact. BroadWorks Common Communication Transport Impacts There is no impact. Device Management Impacts There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 19 OF 36

10 Accounting Impacts Summary of Changes There is no impact. Generation of Accounting Records There is no impact. Impact to Accounting Fields (CDR) There is no impact. Original Called Reason and Redirection Reason Not applicable. Related Call ID Not applicable. Example Not applicable. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 20 OF 36

11 System Management Impacts Performance Management Impacts There is no impact. Fault Management Impacts There is no impact. Scripts and Tools There is no impact. CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 21 OF 36

12 Execution/Call Processing Impacts Xtended Services Interface Impact Summary The following Xsi-Actions command is modified /user/ userid /profile/device /user/ userid /profile/device/ lineport Xsi-Actions Impacts Modified Commands 12.1.2.1.1 /user/ userid /profile/device Version: 24.13 The device Get response is modified to include a new element isDeviceOwner to device attributes. The "isDeviceOwner" element is set to "true" if the user is assigned with the primary lineport for a device, otherwise set to "false". Method Description URI http(s):// hostaddress:port /com.broadsoft.xsiactions/v2.0/user/ userid /profile/device Command Category Service Management Methods GET GET Request Content No Content CISCO BROADWORKS OWNER FLAG IN DEVICE LIST TO SUPPORT WEBEX CLIENT SHARED LINES PAGE 22 OF 36

GET Response Content ?xml version "1.0" encoding "ISO-8859-1"? AccessDevices xmlns "http://schema.broadsoft.com/xsi" accessDevice deviceName CC-David@callcenter.test /deviceName deviceLevel System /deviceLevel deviceType Polycom /deviceType deviceLinePort 10.2.202.18:5060 /deviceLinePort deviceTypeUrl http://10.2.202.18/dev /deviceTypeUrl deviceUserNamePassword userName CC-David@callcenter.test /userName password gfhjjkl /password /deviceUserNamePassword macAddress AAAAAAAAAAAA /macAddress version Grandstream BT100 1.0.5.23 /version endpointType Primary /endpointType isDeviceOwner false /isDeviceOwner /accessDevice accessDevice deviceName CC-David@callcenter.test /deviceName deviceLevel System /deviceLevel deviceType Polycom /deviceType deviceLinePort 10.2.202.19:5060 /deviceLinePort deviceTypeUrl http://10.2.202.18/dev /deviceTypeUrl deviceUserNamePassword userName CC-David@callcenter.test /userName password gfhjjkl /password /deviceUserNamePassword macAddress AAAAAAAAAAAA /macAddress version Grandstream BT100 1.0.5.23 /versi

Accounting Differences There are no differences. System Management Differences There are no differences. Execution/Call Processing Differences There are no differences. Client Application Differences There are no differences. Deployment/Operational Differences There are no differences. System Engineering Differences There are no differences.

Related Documents:

Cisco ASA 5505 Cisco ASA 5505SP Cisco ASA 5510 Cisco ASA 5510SP Cisco ASA 5520 Cisco ASA 5520 VPN Cisco ASA 5540 Cisco ASA 5540 VPN Premium Cisco ASA 5540 VPN Cisco ASA 5550 Cisco ASA 5580-20 Cisco ASA 5580-40 Cisco ASA 5585-X Cisco ASA w/ AIP-SSM Cisco ASA w/ CSC-SSM Cisco C7600 Ser

The SIP Server is the name of our BroadWorks Server, "as.iop1.broadworks.net". Because the server name is used, at least one valid DNS IP address entry must be made on the Network tab. DNS entry is not required if using the IP address of the BroadWorks server. The Register check box is checked, to instruct the VIP device to

In this document, BroadWorks Assistant -Enterprise is interchangeably referred to as BroadWorks Assistant and Assistant-Enterprise. 1.3 Accessing Assistant-Enterprise BroadWorks Assistant is an add-in to Microsoft Internet Explorer, Outlook, and Mozilla Firefox, and provides new toolbars to access BroadWorks Service and Call Management

In this document, BroadWorks Assistant -Enterprise is interchangeably referred to as BroadWorks Assistant and Assistant-Enterprise. 1.3 Accessing Assistant-Enterprise BroadWorks Assistant is an add-in to Microsoft Internet Explorer, Outlook, and Mozilla Firefox, and provides new toolbars to access BroadWorks Service and Call Management

Supported Devices - Cisco SiSi NetFlow supported Cisco devices Cisco Catalyst 3560 Cisco 800 Cisco 7200 Cisco Catalyst 3750 Cisco 1800 Cisco 7600 Cisco Catalyst 4500 Cisco 1900 Cisco 12000 Cisco Catalyst 6500 Cisco 2800 Cisco ASR se

Cisco Nexus 1000V Cisco Nexus 1010 Cisco Nexus 4000 Cisco MDS 9100 Series Cisco Nexus 5000 Cisco Nexus 2000 Cisco Nexus 6000 Cisco MDS 9250i Multiservice Switch Cisco MDS 9700 Series Cisco Nexus 7000/7700 Cisco Nexus 3500 and 3000 CISCO NX-OS: From Hypervisor to Core CISCO DCNM: Single

Cisco Nexus 7706 Cisco ASR1001 . Cisco ISR 4431 Cisco Firepower 1010 Cisco Firepower 1140 Cisco Firepower 2110 Cisco Firepower 2130 Cisco FMC 1600 Cisco MDS 91485 Cisco Catalyst 3750X Cisco Catalyst 3850 Cisco Catalyst 4507 Cisco 5500 Wireless Controllers Cisco Aironet Access Points .

Sep 11, 2017 · Note: Refer to the Getting Started with Cisco Commerce User Guide for detailed information on how to use common utilities for a record in Cisco Commerce. See Cisco Commerce Estimates and Configurations User Guide for more information.File Size: 664KBPage Count: 5Explore furtherSolved: Cisco Serial Number Lookups - Cisco Communitycommunity.cisco.comHow to view and/or update your CCO profilewww.cisco.comSolved: How do I associate a contract to my Cisco.com .community.cisco.comHow do I find my Cisco Contract Number? - Ciscowww.cisco.comPower calculator tool - Cisco Communitycommunity.cisco.comRecommended to you b