Cisco Telepresence Management Suite (TMS) Integration with WXP Collaboration

Prev Next

Introduction

The Cisco TelePresence Management Suite (TMS) integration with the WXP Collaboration application is important because it allows organizations to collect data directly from the TMS SQL database. By setting up a read-only service account and adding a TMS Connector, administrators can monitor system usage, view scheduling information, and analyze performance. This integration helps ensure data accuracy, improves troubleshooting, and supports long-term planning for collaboration environments.

The integration requires creating a read-only service account in the TMS SQL database and then adding a TMS Connector in the Admin Portal of WXP Collaboration. Complete the steps below in order.

Integration Steps

Step 1: Setting up a Service Account for Cisco TMS SQL Server Database

The service account must be added to the TMS SQL Database with read-only privileges. First, determine whether the TMS SQL Server Database is located on the TMS appliance or on a separate SQL Server. After identifying the location, you need administrator access to the server to add the required service account. You may need help from a SQL Server Administrator to provide access or to add the account manually.

If the TMS SQL databases are hosted on a separate SQL Server, consult with your organization’s SQL Server DBA to create the required read-only account.

There are two ways to identify where your TMS database is located:

  1. RDP to the TMS server as an administrator and run the TMS Tools application configuration utility from Start > Programs > Cisco TelePresence Management Suite. This is the recommended option because it also shows the connection port.

  2. Log in to the TMS Web UI as an administrator and go to Administrative Tools > TMS Server Maintenance. Select Database Files and Size Info to view the database server in use. If the database server is “(local)\SQLTMS” then your database resides on the TMS server. The server name may also include the actual server name, for example “TMSPROD\SQLTMS”. If the server name matches your TMS server, then the database resides on the TMS server.

The read-only database account must be named vyopta_svc. It must have the db_datareader and public roles, as well as access to the tmsng database. If the SQL database resides on the TMS server (less common), contact Support for help with the TMS Preparation Installer.

Note: You must obtain the assigned password and the appropriate TCP/IP port for database access. The default port is 1433, but other ports may be configured.

Step 2: Adding a TMS Connector

Before adding a TMS connector, complete these prerequisites:

  1. Confirm access to the FQDN or IP address of the server hosting the SQL Database from the WXP Collaboration Data Collector.

  2. Obtain credentials for the Microsoft SQL Server Database read-only account.

  3. Identify whether a static or dynamic SQL port is used. If dynamic, record the dynamic port value in Microsoft SQL Configuration Manager.

  4. Verify that TCP/IP is enabled for the SQL Server in SQL Configuration Manager.

  5. Enter the infrastructure name and description of TMS. This will be the name displayed for the video device in WXP Collaboration. It can include the device type, location, and other unique identifiers.

    Note: We recommend using the hostname rather than the IP address, as IP addresses can change. It is also helpful to use a friendly name that is easy to understand.

  6. Enter the Database Server Address (hostname or IP address). If the SQL Server Instance Name is not MSSQLSERVER (default value), add it as a suffix to the hostname or IP address, or specify the instance name in the appropriate field. For example, <Device Hostname>\<SQL Server Instance Name>

  7. Enter the username and password created on the SQL Server.

  8. Leave the Database Server Port Number and Name blank to use the default values. If the default port or database is not used, enter the custom port number or database name.

  9. For Authentication, select either Database or Windows.

  10. Select Validate to check connectivity to the video device.

  11. If the connection succeeded, select Save.

Cisco TelePresence Management Suite (TMS) Reference Table

Category

Details

Version

TMS version 13.2 or above

Device Access

Server IP or FQDN that hosts the SQL tmsng database.
Note: While the TMS application server can host the SQL database, this is not typical in enterprise environments. Consult with your organization’s DBA for details.

User/Service Account

Local DBA read-only user account that has access to the tmsng database.

TCP Ports

WXP Collaboration Data Collector outbound to the SQL databases – TCP 1433.
Note: Your SQL DBA may configure a different TCP port. Consult with your DBA for more information.