cisco.com/c/dam/en/us/td/docs/voice_ip_comm/broadworks/Technical/BW-SystemCapacityPlanner.xlsmCisco Trademarks - CiscoCiscoCisco
User Guide for CISCO models including: BroadWorks Documentation, BroadWorks, Documentation
8 ngày trước — Application Delivery Platform (ADP). Cisco BroadWorks Application Delivery ... and Playbooks User Guide. Use this document to learn about the node and ...
File Info : application/pdf, 38 Pages, 1.93MB
DocumentDocumentCisco BroadWorks Documentation Guide Release 26 First Published: 2024-11-18 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 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. All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version. Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices. 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: https://www.cisco.com/c/en/us/about/legal/trademarks.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) © 2024 Cisco Systems, Inc. All rights reserved. CONTENTS PREFACE CHAPTER 1 CHAPTER 2 CHAPTER 3 CHAPTER 4 CHAPTER 5 About this Guide v Planning and Overview 1 Release Notes 1 Design Guides 5 Product Descriptions 6 Solution Guides 6 Interface Specifications 8 Installation and Upgrade 13 Installation 13 Configuration 15 Server Configuration 15 System Configuration 16 Configuration, Localization, and Sample Data 17 Partner Configuration Guides 18 Operation and Maintenance 21 Web Interface 21 Command Line Interface 22 Maintenance 23 Operation 24 Client Documentation 24 Reference 27 Cisco BroadWorks Documentation Guide Release 26 iii Contents Technical References 27 Interworking 28 Compatibility 29 Platform Quick Reference Guides 30 Cisco BroadWorks Documentation Guide Release 26 iv About this Guide This guide lists the documentation and configuration data that is available for Release 26 of Cisco BroadWorks. Use this guide to navigate to a Cisco BroadWorks document on cisco.com. Each document title provides a link to the document on cisco.com based on the following document categories listed in the following table. Note that this guide doesn't include links to the Cisco BroadWorks Feature Description documents. Refer to the Cisco BroadWorks Feature Overview (All Releases) or Cisco BroadWorks Feature Overview (Release 25 and Later Only) to access Cisco BroadWorks Feature Descriptions. Table 1: Document Categories Document Category Configuration Design Install and Upgrade Maintain and Operate Reference Release and Compatibility Security Notices Troubleshooting Description This type of document supports configuring a system, a server, a device, or client. This section also lists available configuration data as well as CPE kits. This type of document supports preparations for installing a system. This type of document supports installing or upgrading a system. This type of document supports maintain and operate the system. This type of document supports all phases of the system lifecycle. Release: This type of document describes a software release or changes to a software release. Compatibility: This type of document/file supports device compatibility with the system. This type of document supports system security. This type of document supports troubleshooting a system. Cisco BroadWorks Documentation Guide Release 26 v About this Guide About this Guide Cisco BroadWorks Documentation Guide Release 26 vi 1 C H A P T E R Planning and Overview · Release Notes, on page 1 · Design Guides, on page 5 · Product Descriptions, on page 6 · Solution Guides, on page 6 · Interface Specifications, on page 8 Release Notes Platform Table 2: Platform Release Notes Document Title Cisco BroadWorks Application Server Release Notes Description Use this document to understand the changes to Cisco BroadWorks Application Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Application Delivery Use this document to understand the changes to Cisco Platform Release Notes BroadWorks Applications Delivery Platform from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Documentation Guide Release 26 1 Release Notes Planning and Overview Document Title Description Cisco BroadWorks Applications Release Notes Use this document to understand the changes to Cisco BroadWorks applications installed on the Application Delivery Platform in Release 24.0, except for the client applications, whose Release Notes are listed in the following table. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Database Troubleshooting Server Release Notes Use this document to understand the changes to Cisco BroadWorks Database Troubleshooting Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Execution Server Release Notes Use this document to understand the changes to Cisco BroadWorks Execution Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Media Server Release Use this document to understand the changes to Cisco Notes BroadWorks Media Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Documentation Guide Release 26 2 Planning and Overview Release Notes Document Title Cisco BroadWorks Network Database Server Release Notes Description Use this document to understand the changes to Cisco BroadWorks Network Database Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Network Function Manager Release Notes Use this document to understand the changes to Cisco BroadWorks Network Function Manager from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Network Server Release Notes Use this document to understand the changes to Cisco BroadWorks Network Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Profile Server Release Use this document to understand the changes to Cisco Notes BroadWorks Profile Server from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Documentation Guide Release 26 3 Release Notes Planning and Overview Document Title Cisco BroadWorks Service Control Function Server Release Notes Cisco BroadWorks Xtended Services Platform Release Notes Description Use this document to understand the changes to Cisco BroadWorks Service Control Function from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Use this document to understand the changes to Cisco BroadWorks Xtended Services Platform from the previous release. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Client Table 3: Client Release Notes Document Title Cisco BroadWorks Deployment Studio Release Notes Description Use this document to understand the changes to Cisco BroadWorks Deployment Studio in Release 24.0. There is no Release 25.0 version of Deployment Studio, but Release 24.0 can be used with the Release 25.0 client applications. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Documentation Guide Release 26 4 Planning and Overview Design Guides Document Title Description Cisco BroadWorks Hosted Thin Call Center Agent/Supervisor Release Notes Use this document to understand the changes to Cisco BroadWorks Hosted Thin Call Center in Release 25.0. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Hosted Thin Receptionist Release Notes Use this document to understand the changes to Cisco BroadWorks Hosted Thin Receptionist in Release 25.0. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Cisco BroadWorks Meet-Me Conferencing Use this document to understand the changes to Cisco Moderator Client Release Notes BroadWorks Meet-Me Conferencing Moderator Client in Release 25.0. Changes include: · Functions · Configuration fixes · Known limitations · Fixed issues Design Guides Table 4: Platform Design Documents Document Title Description Cisco BroadWorks Platform Dimensioning Use this document to identify the required hardware resources Guide for each Cisco BroadWorks server. Cisco BroadWorks System Capacity Planner Use this planning tool to complete a site survey as part of a planned Cisco BroadWorks deployment. The tool takes as input key usage and call mix assumptions and calculates the required hardware and system capacity. Cisco BroadWorks Documentation Guide Release 26 5 Product Descriptions Planning and Overview Document Title Description Cisco BroadWorks System Engineering Guide Use this document to engineer a Cisco BroadWorks system. The document describes how to scale the architecture along with how to plan for expected system capacity. The document also describes how to monitor system performance. Cisco BroadWorks Compatibility Matrix Use this document to identify the compatible line-up of server releases, server versions, applications, and license files for Cisco BroadWorks Release 25.0 in AS mode. Cisco BroadWorks Common Communication Transport Interface Specification and Developer's Guide Use this document to configure the interface between Cisco BroadWorks system and client applications. The document describes how This document describes how clients can communicate with Cisco BroadWorks through this interface and provides some practical examples of a client implementation. Product Descriptions Table 5: Platform Product Descriptions Document Title Description Cisco BroadWorks Media Resource Function Product Description Use this document to deploy and manage the Cisco BroadWorks Media Resource Function (MRF). Cisco BroadWorks Network Server Product Description Use this document to understand Cisco BroadWorks Network Server functionality, deploy the server, and manage it. Cisco BroadWorks E.164 Overview Guide Use this document to configure E.164 numbers according to network and server configurations. Solution Guides Table 6: Platform Solution Guides Document Title Description Cisco BroadWorks Application Server CommPilot Portal Customization and Localization Guide Use this document customize and localize the Cisco BroadWorks Application Server CommPilot Portal. Cisco BroadWorks Enhanced Call Logs Solution Guide Use this document to implement the Enhanced Call Logs on the Cisco BroadWorks platform to deploy, configure, and provision this solution. Cisco BroadWorks Enterprise Migration Use this document to migrate enterprises and service providers Solution Guide from one Application Server cluster to another. Cisco BroadWorks Documentation Guide Release 26 6 Planning and Overview Solution Guides Document Title Description Cisco BroadWorks Meet-Me Conferencing Use this document to configure and deploy the Cisco BroadWorks Guide Meet-Me Conferencing solution. Cisco BroadWorks Mobility Guide Use this document to configure and deploy the Cisco BroadWorks Mobility solution. Cisco BroadWorks SAML Authentication Use this document to implement the Cisco BroadWorks Security Integration Solution Guide Assertion Markup Language (SAML) 2.0 solution to secure access to Cisco BroadWorks user resources. Cisco BroadWorks Service License Reporting Solution Guide Use this document to implement the Cisco BroadWorks Service License Reporting and Collection solution This solution monitors the usage of the licensing model. Cisco BroadWorks SIP Trunking Solution Use this document to implement the Cisco BroadWorks SIP Guide Trunking solution. This solution integrates Cisco BroadWorks with a Private Branch Exchange (PBX) residing within an enterprise network. Cisco BroadWorks AS Mode IP Use this document to plan for Cisco BroadWorks working in AS Multimedia Subsystem Solution Guide mode into the IMS architecture. Cisco BroadWorks Voice Messaging Solutions Guide Use this document to implement the Cisco BroadWorks Voice Messaging solution. This solution configures deployments with various network configurations. Cisco BroadWorks Video Services Solution Guide Use this document to implement Cisco BroadWorks video capabilities to deploy video services. Cisco BroadWorks Service Centralization Use this document to view how Cisco BroadWorks supports and Continuity Solution Guide centralization and continuity with a variety of deployed network configurations and capabilities and to configure Cisco BroadWorks to support those various deployment options. Cisco BroadWorks Secure Onboarding Use this document to provision devices to Cisco BroadWorks Using Activation Codes Solution Guide users with secure onboarding. Cisco BroadWorks Lawful Intercept Use this document to configure and manage the Lawful Intercept Solution Guide (available upon request) solution for your organization. Table 7: Client Solution Guides Document Title Description Cisco BroadWorks Call Center Solution Use this guide to configure the Cisco BroadWorks Call Center Guide solution. Cisco BroadWorks Call Center Statistics Use this guide to view the statistics collected for the basic option Overview Guide of the Cisco BroadWorks Call Center. Cisco BroadWorks Documentation Guide Release 26 7 Interface Specifications Planning and Overview Document Title Description Cisco BroadWorks Call Settings Webview Use this document to view and modify services related to the Solution Guide call settings via a Webview from a mobile, tablet, or desktop Cisco BroadWorks UC-One application. Interface Specifications Table 8: Platform Interface Specifications Document Title Description Cisco BroadWorks Configuration System Use this document to access, modify, and maintain the integrity Interface Specification of the Cisco BroadWorks configuration and the Cisco BroadWorks Configuration System Interface. Cisco BroadWorks Computer Telephony Use this document to configure the Computer Telephony Integration Interface Specification Integration (CTI) interface with Cisco BroadWorks in AS mode. Cisco BroadWorks SIP Access Side Use this document to configure the Session Initiation Protocol Extensions Interface Specification Guide that is used to enable traditional voice applications, including but not limited to, key system emulation, executive-admin station emulation, push to talk, click-to-dial, and other remote control CTI applications. Cisco BroadWorks Application Delivery Use this document to view and configure the notifications and Platform Fault and Alarm Interface alarms generated by the Application Delivery Platform to keep Specification the server running without faults. Cisco BroadWorks Application Delivery Use this document to view and configure the performance Platform Performance Measurement measurements of the Cisco BroadWorks Application Delivery Interface Specification Platform to ensure optimal performance. Cisco BroadWorks Accounting Call Detail Use this document to configure the Call Detail Record (CDR) Record Interface Specification interface to ensure the efficient transmission of accounting data. Cisco BroadWorks Application Server Fault and Alarm Interface Specification Use this document to view and configure the notifications and alarms generated by the Application Server to keep the server running without faults. Cisco BroadWorks AS Mode ISC Interface Use this document to configure the Cisco BroadWorks Specification Application Server in IMS deployments. Cisco BroadWorks Application Server Performance Measurement Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Application Server to ensure optimal performance. Cisco BroadWorks Application Server Provisioning Interface Specification Use this document to configure the Open Client Service Provisioning (OCI-P) interface to allow third-party clients and legacy systems to inter-work with the Application Server. Cisco BroadWorks Documentation Guide Release 26 8 Planning and Overview Interface Specifications Document Title Description Cisco BroadWorks Application Server Sh Use this document to configure the interface used by Cisco Interface Specification BroadWorks Application Server to communicate with the Home Subscriber Server (HSS) over the Sh interface. Cisco BroadWorks Application Server Synchronization Interface Specification Use this document to synchronize the interface from the Application Server to another server modifying data to ensure the servers are synchronized. Cisco BroadWorks Busy Lamp Field Interface Specification Use this document to configure the Busy Lamp Field interface to support devices using SIP as the line-side access protocol. Cisco BroadWorks Calling Name Interface Use this document to configure the Calling Name interface to Specification retrieve calling name information from an external database on a per-call basis by subscription. Cisco BroadWorks Execution Server Fault Use this document to view and configure the notifications and and Alarm Interface Specification alarms generated by the Cisco BroadWorks Execution Server to keep the server running without faults. Cisco BroadWorks Execution Server Performance Measurements Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Execution Server to ensure optimal performance. Cisco BroadWorks Media Resource Interface Specification Use this document to integrate the Cisco BroadWorks Media Resource Function (MRF) into a customer's network. Cisco BroadWorks Media Server Fault and Use this document to view and configure the notifications and Alarm Interface Specification alarms generated by the Media Server to keep the server running without faults. Cisco BroadWorks Media Server Performance Measurements Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Media Server to ensure optimal performance. Cisco BroadWorks Network Database Server Fault and Alarm Interface Specification Use this document to view and configure the notifications and alarms generated by the Cisco BroadWorks Network Database Server to keep the server running without faults. Cisco BroadWorks Network Database Server Performance Measurements Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Network Database Server to ensure optimal performance. Cisco BroadWorks Network Function Interface - Interface Specification Use this document to configure the Network Function Interface (NFI) to integrate client applications to perform network function management-related actions. Cisco BroadWorks Network Function Management Fault and Alarm Interface Specification Use this document to view and configure the notifications and alarms generated by the Cisco BroadWorks Network Function Manger to keep the server running without faults. Cisco BroadWorks Documentation Guide Release 26 9 Interface Specifications Planning and Overview Document Title Description Cisco BroadWorks Network Function Manager Performance Measurements Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Network Function Manager to ensure optimal performance. Cisco BroadWorks Network Server Fault Use this document to view and configure the notifications and and Alarm Interface Specification alarms generated by the Cisco BroadWorks Network Function Manger to keep the server running without faults. Cisco BroadWorks Network Server Portal Use this document to configure the Network Server portal API API Specification interface. Cisco BroadWorks Network Server Use this document to configure the Network Server Location Location API Specification and Developer API to replace the Network Server as the user location authority Guide or perform a look up to the Network Server location database. Cisco BroadWorks Network Server Performance Measurements Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Network Server to ensure optimal performance. Cisco BroadWorks Network Server Provisioning Interface Specification Cisco BroadWorks Profile Server Fault and Alarm Interface Specification Cisco BroadWorks Rf/Ro Interface Specification Use this document to provision the Network Server with the Open Client Interface-Provisioning (OCI-P) and the Operations Support System (OSS) interface. Use this document to view and configure the notifications and alarms generated by the Cisco BroadWorks Profile Server to keep this server running without faults. Use this document to configure the interfaces used to communicate with billing servers over the Diameter protocol for offline and online charging. Cisco BroadWorks Profile Server Performance Measurements Interface Specification Cisco BroadWorks Service Control Function Fault and Alarm Interface Specification Cisco BroadWorks Service Control Function Performance Measurements Interface Specification Cisco BroadWorks Shared Call Appearance Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Profile Server to ensure optimal performance. Use this document to view and configure the notifications and alarms generated by the Cisco BroadWorks Service Control Function to keep this server running without faults. Use this document to view and configure the performance measurements of the Cisco BroadWorks Service Control Function to ensure optimal performance. Use this document to configure the interfaces used to communicate with the Home Subscriber Server (HSS) over the Sh interface. Cisco BroadWorks Sharing Server Fault Use this document to view and configure the notifications and and Alarm Interface Specification alarms generated by the Cisco BroadWorks Sharing Server to keep this server running without faults. Cisco BroadWorks Documentation Guide Release 26 10 Planning and Overview Interface Specifications Document Title Description BroadWorks XS Mode ISC Interface Specification Use this document to configure the behavior of the Cisco BroadWorks Execution Server and Network Server in IMS deployments. Cisco BroadWorks XS Mode Sh/Dh Use this document to configure the BroadWorks Execution Server Interface Specification Execution Server and Profile Server to communicate with the Home Subscriber and Profile Server Server (HSS) over the Sh/Dh interface. Cisco BroadWorks Xtended Services Platform Fault and Alarm Interface Specification Use this document to view and configure the notifications and alarms generated by the Cisco BroadWorks Xtended Services Platform to keep this server running without faults. Cisco BroadWorks Xtended Services Platform Performance Measurement Interface Specification Use this document to view and configure the performance measurements of the Cisco BroadWorks Xtended Services Platform to ensure optimal performance. Cisco BroadWorks Xtended Services Interface - Interface Specification Use this document to configure the Xtended Services Interface (Xsi) on Cisco BroadWorks. Cisco BroadWorks Lawful Intercept Provisioning Interface Specification (available upon request) Use this document to configure the Lawful Intercept Provisioning Interface on Cisco BroadWorks. Cisco BroadWorks Documentation Guide Release 26 11 Interface Specifications Planning and Overview Cisco BroadWorks Documentation Guide Release 26 12 2 C H A P T E R Installation and Upgrade · Installation, on page 13 Installation Table 9: Installation Documents Document Title Description Cisco BroadWorks Network Function Manager Software Management Guide Use this document to install, deploy, and configure the Software Management application on the Cisco BroadWorks Network Function Manager. Cisco BroadWorks Software Management Use this document to install, upgrade, or downgrade Cisco Guide BroadWorks or to install or remove software patches. Cisco BroadWorks Documentation Guide Release 26 13 Installation Installation and Upgrade Cisco BroadWorks Documentation Guide Release 26 14 3 C H A P T E R Configuration · Server Configuration, on page 15 · System Configuration, on page 16 · Configuration, Localization, and Sample Data, on page 17 · Partner Configuration Guides, on page 18 Server Configuration Table 10: Server Configuration Guides Document Title Description Cisco BroadWorks Application Delivery Use this document to configure, administer, and troubleshoot the Platform Configuration Guide Application Delivery Platform (ADP). Cisco BroadWorks External File Server Configuration Guide Use this document to manage and administer an External File Server. This document describes how to store audio and video files. Cisco BroadWorks Location Server Configuration Guide Use this document to configure, manage, and administer the Location Server in IMS deployments. Cisco BroadWorks Network Database Server Configuration Guide Use this document to choose the deployment model and configuration of the Network Database Server that suits your deployment requirements. Cisco BroadWorks Network Function Manager Configuration Guide Use this document to install, configure, and administer the Network Function Manager platform components. Cisco BroadWorks Profile Server Configuration Guide Use this document to install, configure, and administer the Profile Server. Cisco BroadWorks Service Control Function Server Configuration Guide Use this document to configure, administer, and troubleshoot the Service Control Function Server. Cisco BroadWorks Xtended Services Interface Configuration Guide Use this document to configure and deploy the Xtended Services Interface (Xsi). Cisco BroadWorks Documentation Guide Release 26 15 System Configuration Configuration Document Title Cisco BroadWorks Xtended Services Platform Configuration Guide Description Use this document to configure, administer, and troubleshoot the Xtended Services Platform (XSP). System Configuration Table 11: System Configuration Guides Document Title Description Cisco BroadWorks Call Processing Policies Guide Use this document to configure call processing policies and control call processing behavior. Cisco BroadWorks CommPilot Portal Configuration Guide Use this document to configure the various servers and applications required for the CommPilot web portal to work. Cisco BroadWorks Communication Barring Fixed Guide Use this document to configure and provision the Communication Barring Fixed solution on the Cisco BroadWorks platform. Cisco BroadWorks Container Options Guide Use this document to learn about the Container Options that you can configure. Cisco BroadWorks Device Management Use this document to integrate, deploy, and maintain access Configuration Guide devices on a network. Cisco BroadWorks Device Management Use this document to learn about the definition and provisioning Tag Reference Guide source of all tags supported in Device Management. Cisco BroadWorks Diameter, Rf, Ro, and Use this document to configure the Rf, Ro, and Sh interfaces and Sh Interfaces Configuration Guide the Diameter stack on the Application Server. Cisco BroadWorks Directory Numbers, Use this document to configure directory numbers, country codes, Country Codes, and National Destination and national destination codes for specific network and server Codes Guide configurations. Cisco BroadWorks Emergency Call Support Implementation Guide Use this document to implement and configure emergency call support. Cisco BroadWorks External Portal Integration Developer's Guide Use this document to make use of the mechanisms provided by Cisco BroadWorks, including external authentication. Cisco BroadWorks Internet Protocol Security Configuration Guide Use this document to configure an Authentication Header protocol/Encapsulating Security Payload IPsec connection between two Red Hat Enterprise Linux 5 systems. Cisco BroadWorks NNACL Translation Use this document to configure an NNACL translation file and File Configuration Guide view the description of the Cisco BroadWorks translation service. Cisco BroadWorks Simple Network-enabled Auto-Provisioning Configuration Guide Use this document to configure Cisco BroadWorks and Cisco 2400 integrated access devices (IADs) for Simple Network-enabled Auto-Provisioning (SNAP). Cisco BroadWorks Documentation Guide Release 26 16 Configuration Configuration, Localization, and Sample Data Document Title Description Cisco BroadWorks Special Call Types Routing Guide Use this document to configure BroadWorks servers for special call type routing, such as emergency calls. Cisco BroadWorks System Configuration Use this document to view configuration requirements for the Guide system core call processing servers in a non-IP Multimedia Subsystem (IMS) deployment. Cisco BroadWorks UNIX User Account Use this document as an overview of BroadWorks user Configuration Guide management and configuration. Cisco BroadWorks Virtualization Configuration Guide Use this document for the requirements and steps to configure a virtual configuration. Cisco BroadWorks XS Mode Configuration Guide Use this document for the installation, configuration, and functional behavior of Cisco BroadWorks in Execution Server (XS) mode. Cisco BroadWorks XS Mode Diameter, Use this document to configure the Sh/Dh, Rf, and Ro interfaces Sh/Dh, Rf, and Ro Interfaces Configuration on the Cisco BroadWorks Execution Server and Profile Server Guide using the CLI. Configuration, Localization, and Sample Data Table 12: Configuration Files Document Title Description CTI Client This is an utility for testing the CTI interface. It's packaged as an archive (zip file). Accounting CDR Schema Files These are the Call Detail Record (CDR) schema files packaged together in an archive (zip file). Sample CDRs These are the Cisco BroadWorks sample data files for Call Detail Records. The files ae packaged together in an archive (zip file Localization files for Application Server This zip file contains localization files for the Application Server. Use the link provided to download the zip file. OCI Schema Provisioning HTML This is the HTML (browser friendly) representation of the provisioning Open Client Interface, packaged as one archive (zip file). OCI Schema Application Server This is the schema (XSD files) of the Application Server Open Client Interface provisioning interface, packaged as one archive (zip file). Cisco BroadWorks Documentation Guide Release 26 17 Partner Configuration Guides Configuration Document Title Description OCI Schema Application Server HTML This is the HTML (browser friendly) representation of the Application Server Open Client Interface provisioning interface, packaged as one archive (zip file). OCI Schema Network Server This is the schema (XSD files) of the Network Server Open Client Interface provisioning interface, packaged as one archive (zip file). OCI Schema Network Server HTML This is the HTML (browser friendly) representation of the Network Server Open Client Interface provisioning interface, packaged as one archive (zip file). BroadWorks Configuration Schema This is the XML Schema Definition of the Cisco BroadWorks Centralized Configuration that underlines the functionality provided by the Cisco BroadWorks Configuration System, packaged as an archive (zip file). Localization Files Network Server This archive (zip file) contains localization files for the Network Server. Partner Configuration Guides Table 13: Cisco Device Configuration Guides Document Title Cisco BroadWorks Partner Configuration Guide Cisco 300/500 Series Cisco BroadWorks Partner Configuration Guide Cisco ATA 19x Cisco BroadWorks Partner Configuration Guide Cisco CP-8831-3PCC Cisco BroadWorks Partner Configuration Guide Cisco CUBE Cisco BroadWorks Partner Configuration Guide Cisco DPC/DPX NCS Cisco BroadWorks Partner Configuration Guide Cisco E20 IP Video Phone Cisco BroadWorks Partner Configuration Guide Cisco IOS Gateway Cisco BroadWorks Partner Configuration Guide Cisco IOS Trunk Cisco BroadWorks Partner Configuration Guide Cisco ISR 1K Cisco BroadWorks Partner Configuration Guide Cisco ISR 4K CUBE Cisco BroadWorks Partner Configuration Guide Cisco ISR 4K Cisco BroadWorks Partner Configuration Guide Cisco ISR-G2 Cisco BroadWorks Documentation Guide Release 26 18 Configuration Partner Configuration Guides Document Title Cisco BroadWorks Partner Configuration Guide Cisco Linksys Voice Adapters and Routers Old Models Cisco BroadWorks Partner Configuration Guide Cisco Linksys Voice Adapters and Routers Cisco BroadWorks Partner Configuration Guide Cisco Multi-Platform Phones Cisco BroadWorks Partner Configuration Guide Cisco Nano Cube Cisco BroadWorks Partner Configuration Guide Cisco RoomOS Devices Cisco BroadWorks Partner Configuration Guide Cisco SPA112-SPA122-SPA232D Cisco BroadWorks Partner Configuration Guide Cisco SPA9000 Cisco BroadWorks Partner Configuration Guide Cisco SPA-9XX Cisco BroadWorks Partner Configuration Guide Cisco SRP52x Series - ALG Cisco BroadWorks Partner Configuration Guide Cisco SRP52x Series - FXS Cisco BroadWorks Partner Configuration Guide Cisco Starent SCM Cisco BroadWorks Partner Configuration Guide Cisco TANDBERG Codian Cisco BroadWorks Partner Configuration Guide Cisco TANDBERG MXP Cisco BroadWorks Partner Configuration Guide Cisco TANDBERG Video Communication Server (VCS) Expressway Cisco BroadWorks Partner Configuration Guide Cisco Unified Communication Manager with Cisco Unified Border Element Cisco BroadWorks Partner Configuration Guide Cisco Unified Communications 500 Series Cisco BroadWorks Partner Configuration Guide Cisco Unified Communications Manager Express Cisco BroadWorks Partner Configuration Guide Cisco Unified Communications Manager Cisco BroadWorks Partner Configuration Guide Cisco Unified IP Phone Series Older Models Cisco BroadWorks Partner Configuration Guide Cisco Unified IP Phone Series Cisco BroadWorks Partner Configuration Guide Cisco WIP310 Table 14: CPE Kits CPE Kit Title Cisco-ATA-19x-11_2_3-ver001 Cisco-RoomOS-Devices-10_12-ver002 Cisco-DBS110-DBS210-0511-ver001 Cisco BroadWorks Documentation Guide Release 26 19 Partner Configuration Guides CPE Kit Title Cisco-DBS110-DBS210-0501-ver002 Cisco-DBS110-DBS210-0501-ver001 Cisco-Multi-Platform-Phones-1137-ver002 Cisco-Multi-Platform-Phones-1137-ver001 Cisco-Multi-Platform-Phones-1136-ver001 Cisco-Multi-Platform-Phones-1135-ver001 Cisco-RoomOS-Devices-10_12-ver001 Table 15: Third Party Equipment Interoperability Document Title Cisco BroadWorks Partner Equipment Interoperability Summary Configuration Cisco BroadWorks Documentation Guide Release 26 20 4 C H A P T E R Operation and Maintenance · Web Interface, on page 21 · Command Line Interface, on page 22 · Maintenance, on page 23 · Operation, on page 24 · Client Documentation, on page 24 Web Interface Application Server Table 16: Application Server Web Interface Guides Document Title Cisco BroadWorks Application Server System Provider Web Interface Administration Guide Cisco BroadWorks Application Server Service Provider Web Interface Administration Guide Cisco BroadWorks Application Server Enterprise Web Interface Administration Guide Cisco BroadWorks Application Server Group Web Interface Administration Guide - Part 1 Cisco BroadWorks Application Server Group Web Interface Administration Guide - Part 2 Description Use this document to assist you with the system administration tasks of the Application Server platform using the web interface, including authorizing services and assigning resources to client organizations as well as monitoring resource utilization in the system. Use this document to assist you with the management of all available functions of the Cisco BroadWorks Application Server. Follow the detailed instructions for each function and page of the web portal interface at the service provider level. Use this document to assist you with the management of all available functions of the Cisco BroadWorks Application Server. Follow the detailed instructions for each function and page of the web portal interface at the enterprise level. Use this document to assist you with management of all Cisco BroadWorks group and department administration functions. Use this document to assist you with performing all administration functions for Cisco BroadWorks users and virtual users (service instances of services such as Call Center). Cisco BroadWorks Documentation Guide Release 26 21 Command Line Interface Operation and Maintenance Document Title Description Cisco BroadWorks User Web Interface Administration Guide Use this document to learn about all web portal functions available to Cisco BroadWorks users. The web portal enables users to self-configure and manage their features and services in real-time. Cisco BroadWorks Getting Started Use this guide to get familiar with the Cisco BroadWorks web interface. Web Interface Administration Guide Network Server Table 17: Network Server Web Interface Guides Document Title Description Cisco BroadWorks Network Server Use this guide is to assist you with management of all Network Server Web Interface Administration management and provisioning functions available through the web Guide interface. Cisco BroadWorks Network Server Follow the procedures provided by this guide to perform routing and Enterprise Web Interface network functions for one or more groups. Administration Guide Command Line Interface Table 18: Command Line Interface Guides - All Servers Document Title Description Cisco BroadWorks Application Use this document to manage all Application Delivery Platform Delivery Platform Command Line command line interface functions. Follow the detailed instructions for Interface Administration Guide each available administrative task. Cisco BroadWorks Application Server Command Line Interface Administration Guide Use this document to manage all Application Server command line interface functions. Follow the detailed instructions for each available administrative task. Cisco BroadWorks Database Use this document to manage all Database Troubleshooting Server Troubleshooting Server Command command line interface functions. Follow the detailed instructions for Line Interface Administration each administrative task. Guide Cisco BroadWorks Execution Server Command Line Interface Administration Guide Use this guide to manage all Execution Server command line interface functions. Follow the detailed instructions for each administrative task. Cisco BroadWorks Lawful Use this document to manage all Lawful Intercept command line Intercept Command Line Interface interface functions. Follow the detailed instructions for each available Guide (available upon request) administrative task. Cisco BroadWorks Documentation Guide Release 26 22 Operation and Maintenance Maintenance Document Title Description Cisco BroadWorks Media Server Use this guide to manage all Media Server command line interface Command Line Interface functions. Follow the detailed instructions for each administrative task. Administration Guide Cisco BroadWorks Network Database Server Command Line Interface Administration Guide Use this guide to manage all Network Database Server command line interface functions. Follow the detailed instructions for each administrative task. Cisco BroadWorks Network Use this guide to manage all Network Function Manager command line Function Manager Command Line interface functions. Follow the detailed instructions for each Interface Administration Guide administrative task. Cisco BroadWorks Network Server Use this guide to manage all Network Server command line interface Command Line Interface functions. Follow the detailed instructions for each administrative task. Administration Guide Cisco BroadWorks Profile Server Use this guide to manage all Profile Server command line interface Command Line Interface functions. Follow the detailed instructions for each administrative task. Administration Guide Cisco BroadWorks Service Control Use this guide to manage all Service Control Function command line Function Command Line Interface interface functions. Follow the detailed instructions for each Administration Guide administrative task. Cisco BroadWorks Xtended Use this guide to manage all Xtended Services Platform command line Services Platform Command Line interface functions. Follow the detailed instructions for each Interface Administration Guide administrative task. Maintenance Table 19: Maintenance Document Title Description Cisco BroadWorks Maintenance Use this document to learn about the recommended routine maintenance Guide procedures for Cisco BroadWorks. Cisco BroadWorks Database and Logs Anonymization User Guide Use this document for learn how to remove all personally identifiable information (PII) from a Cisco BroadWorks database, log file, or a single value so that you can supply log files (or an entire database) to Cisco for investigation of various issues without exposing any sensitive customer data. Cisco BroadWorks Documentation Guide Release 26 23 Operation Operation and Maintenance Operation Table 20: Task Automation, License Management, and User Service Pack Migration Document Title Description Cisco BroadWorks Ansible Collections Use this document to learn how to use Cisco BroadWorks Ansible and Playbooks User Guide collections and playbooks to automate various repetitive tasks. Cisco BroadWorks Network Function Use this document to learn about the node and license management Manager Node and License Management functionality available to administer managed license files. Follow Guide the instructions of the guide to configure and deploy managed licenses. Cisco BroadWorks User Service Pack Use this document to learn how to use the automated batch process Migration User Guide to migrate users from one set of services or service packs to another. Client Documentation Administration Table 21: Administration Guides Document Title Description Cisco BroadWorks Deployment Studio Administration Guide Use this document is to assist you with the installation and maintenance of Cisco BroadWorks Deployment Studio, for the purposes of deploying Cisco BroadWorks client applications to end users. Note that the link provided here is for the Release 24.0 document as there were no changes for Release 25.0. Cisco BroadWorks Hosted Thin Use this document is to assist you with the installation, customization, Call Center Agent/Supervisor and maintenance of Cisco BroadWorks Hosted Thin Call Center. Configuration and Administration Guide Cisco BroadWorks Hosted Thin Use this document is to assist you with the installation, customization, Receptionist Agent/Supervisor and maintenance of Cisco BroadWorks Hosted Thin Receptionist. Configuration and Administration Guide User Cisco BroadWorks Documentation Guide Release 26 24 Operation and Maintenance Client Documentation Table 22: User Guides Document Title Description Cisco BroadWorks Deployment Studio User Guide Refer to this guide for general information on using Deployment Studio to customize a Cisco BroadWorks client application. In addition, for Software as a Service (SaaS) applications, such as Hosted Thin Call Center and Hosted Thin Receptionist, follow the detailed instructions on deploying customized application profiles. Note that the link provided here is for the Release 24.0 document as there were no changes for Release 25.0. Cisco BroadWorks Hosted Thin Use this document to learn about the features, interface, dialogs, and Call Center Agent/Supervisor User services provided by the Call Center client application. Follow the details Guide to use the Call Center features and services for agents and supervisors. Cisco BroadWorks Hosted Thin Receptionist User Guide Use this document to learn about the features, interface, dialogs, and services provided by the Receptionist client application. Follow the detailed procedures to use the application's features and services. Cisco BroadWorks Hosted Thin Use this document as a reminder of the steps to follow to perform the Call Center Quick Reference Guide different tasks of the Call Center client. Cisco BroadWorks Hosted Thin Receptionist Quick Reference Guide Use this document as a reminder of the steps to follow to perform the different tasks of the Receptionist client. Cisco BroadWorks Documentation Guide Release 26 25 Client Documentation Operation and Maintenance Cisco BroadWorks Documentation Guide Release 26 26 5 C H A P T E R Reference · Technical References, on page 27 · Interworking, on page 28 · Compatibility, on page 29 · Platform Quick Reference Guides, on page 30 Technical References Table 23: Technical and Product Information Document Title Description Cisco BroadWorks Feature Overview (All Releases) Use this document to view the description of all Cisco BroadWorks features. This document provides links to the individual feature description documents. Cisco BroadWorks Feature Overview (Release 25 and Later Only) Use this document to view the description of the features added to Cisco BroadWorks in Release 25. This document provides links to the individual feature description documents. Cisco BroadWorks Functional Summary Use this document to view the capabilities, features, and services added to Cisco BroadWorks in the current release including the interface changes introduced by these capabilities. Cisco BroadWorks Interface Impact Use this document as a quick reference to see how each feature in the Summary Cisco BroadWorks release affects each of the external interfaces. Cisco BroadWorks Server Security Use this document as an overview of the required protocols for Cisco Guide BroadWorks, the ports that they use, and the Server Access Control Lists (ACLs) and firewalls used to restrict access to servers so that they can only access required ports. Cisco BroadWorks System Use this document as a guide as to which measurements that should be Performance Monitoring Guide gathered to monitor the performance of a Cisco BroadWorks system. Cisco BroadWorks Redundancy Use this document to view the configuration requirements for deploying Guide a redundancy solution for Cisco BroadWorks. Cisco BroadWorks Documentation Guide Release 26 27 Interworking Reference Document Title Description Cisco BroadWorks Service Guide Use this document as an overview of all the services provided by Cisco BroadWorks. Cisco BroadWorks Service Interaction Guide Use this document to view the interactions between the different user services provided by Cisco BroadWorks. Cisco BroadWorks Network Function Manager Virtualized Network Function Lifecycle Management Guide Use this document to view how some of the VNF Manager functions are implemented by the Cisco BroadWorks Network Function Manager (NFM) and how they can be used to perform VNF lifecycle management. Interworking Table 24: Development and Interworking Guides Document Title Description Cisco BroadWorks VoiceXML and Use this document as a reference for writing VoiceXML or CCXML CCXML Developer's Guide scripts that run on a Cisco BroadWorks Media Server. Cisco BroadWorks Announcement Use this guide to configure languages and tones for Cisco BroadWorks Guide announcements. Cisco BroadWorks Application Use this document to learn about the identity-related configuration and Server Identity Guide handling on the Cisco BroadWorks Application Server. Cisco BroadWorks Application Use this document to execute call-processing simulations to better Server VTR Administration Guide understand and test various configurations using the Verify Translation and Routing (VTR) diagnostic tool. Cisco BroadWorks Call Recording Use this document to learn about and configure the Cisco BroadWorks Guide Call Recording Interface. Cisco BroadWorks Call Recording Use this document to learn about and configure the Cisco BroadWorks on XS-TAS Guide Call Recording Interface in an Execution Server Telephony Application Server (XS-TAS) deployment. . Cisco BroadWorks External Use this document to learn how to use the External Emergency Number Emergency Number SOAP Query Simple Object Access Protocol (SOAP) Query Interface to make the Interface Specification Guide Cisco BroadWorks Application Server query a third-party server to translate an emergency number, such as 911, into a routable number. Cisco BroadWorks MGCP Access Use this document to learn how to use the Media Gateway Control Interface Interworking Guide Protocol (MGCP) interface to communicate between Cisco BroadWorks Application Servers and partner MGCP access devices. Cisco BroadWorks Documentation Guide Release 26 28 Reference Compatibility Document Title Description Cisco BroadWorks SIP Access Interface Interworking Guide Use this document to learn how to use the Cisco BroadWorks Application Server access interface to communicate between the Cisco BroadWorks Application Server and partner access devices including SIP phones, SIP access gateways, SIP trunking gateways, and so on. Cisco BroadWorks SIP External Voice Mail Support Interworking Guide Use this document to view end-to-end call flow examples for typical voice messaging scenarios. This document is a supplement to the Cisco BroadWorks SIP Access Interworking Guide for partners and operators who want to interface external voice mail/messaging platforms with Cisco BroadWorks. Cisco BroadWorks SIP Network Interface Interworking Guide Use this document to learn how to use the SIP interface to communicate between Cisco BroadWorks servers and partner network elements, including Application Servers, softswitches, Network Servers, SIP proxies, and so on. Cisco BroadWorks Treatment Guide Use this document to learn about the system-default treatments used by Cisco BroadWorks and how to configure the system to modify certain aspects of these treatments to provide better feedback to callers, to enhance interoperability with other vendor equipment, or to obtain more specific information in call detail records. Cisco BroadWorks Network Function Manager Network Monitoring Guide Use this document to learn how the Network Monitoring application integrates in the Cisco BroadWorks Network Function Manager (NFM) and how it bridges the rest of the Network Function Manager functions with the Network Monitoring Console. Compatibility Table 25: Interoperability Test Plans Document Title Description Cisco BroadWorks Device Management Use this document to integrate SIP access devices with the Cisco Interoperability Test Plan BroadWorks Device Management feature. Cisco BroadWorks IMS ISC Interoperability Test Plan Use this document to validate the functional interoperability between the Cisco BroadWorks Application Server and a Serving Call Session Control Function (S-CSCF) over the IP Multimedia Subsystem (IMS) Service Control (ISC) interface by exercising a comprehensive cross section of Cisco BroadWorks features in an IMS configuration. Cisco BroadWorks Ro Interface Interoperability Test Plan Use this document to validate basic interoperability between Cisco BroadWorks and an Online Charging System (OCS) using the Diameter interface, known in IMS as the Ro reference point. Cisco BroadWorks Documentation Guide Release 26 29 Platform Quick Reference Guides Reference Document Title Cisco BroadWorks SIP Access Device Interoperability Test Plan Cisco BroadWorks SIP Phone Interoperability Test Plan Cisco BroadWorks VoLTE UE Interoperability Test Plan Description Use this document to validate SIP interoperability between Cisco BroadWorks and SIP access devices such as access gateways, IADs, SIP MTAs, ATAs, and so on. Use this document to validate SIP interoperability between Cisco BroadWorks and SIP phones or soft clients. Completion of the test plan validates the SIP interface with Cisco BroadWorks and meets a prerequisite for Cisco BroadCloud integration. Use this document to validate SIP interoperability between Cisco BroadWorks and Voice over Long Term Evolution User Equipment (VoLTE UE) via IP Multimedia Subsystem Core Network (IMS CN). This includes service invocation occurring on the IMS Service Control (ISC) interface and the Gm interface. Platform Quick Reference Guides Table 26: Quick Reference Guides Document Title Description Cisco BroadWorks Auto Attendant Use this document to learn how to plan, define, and test your automated Basic Quick Reference Guide receptionist, using the Cisco BroadWorks Auto Attendant - Basic service. Cisco BroadWorks Auto Attendant Use this document to learn how to plan, define, and test your automated Standard Quick Reference Guide receptionist, using the Cisco BroadWorks Auto Attendant - Standard service. Cisco BroadWorks Anywhere Quick Reference Guide Use this document to learn how to use the BroadWorks Anywhere service once it is set up by the office administrator. Follow the provided procedures to use the different BroadWorks Anywhere functions. Cisco BroadWorks Group Voice Portal Quick Reference Guide Use this document to get a quick overview of the Cisco BroadWorks group voice portal and learn how to set up the voice portal for your organization. Follow the step-by-step procedures to configure the greetings, set passcode rules, and customize voice portal menus. Cisco BroadWorks Login Functions Use this document to learn how to set-up your access to Cisco Quick Reference Guide BroadWorks, such as logging in and out, adding Cisco BroadWorks to your "Favorites", or auto-starting Cisco BroadWorks web portal. Cisco BroadWorks Meet-Me Conferencing Quick Reference Guide Use this document to learn how to use the Cisco BroadWorks Meet-Me Conferencing service to organize, configure, moderate, and record conferences, as well as participate in conferences organized by others. Cisco BroadWorks Paging Quick Use this document to learn how to set up a paging system for your Reference Guide organization in Cisco BroadWorks. Cisco BroadWorks Documentation Guide Release 26 30 Reference Platform Quick Reference Guides Document Title Description Cisco BroadWorks Personal Voice Use this document to learn how to use your personal voice portal to Portal Quick Reference Guide listen to your messages, leave messages to others, and record personalized greetings. Cisco BroadWorks Special Calling Use this document to view all the Cisco BroadWorks features available Features Quick Reference Guide using feature access codes (FAC). Follow the step-by-step procedures to use the features. Cisco BroadWorks Documentation Guide Release 26 31 Platform Quick Reference Guides Reference Cisco BroadWorks Documentation Guide Release 26 32