Installation and Configuration Guide for Cisco Unified Communications for RTX Release 8.6
Configuring RTX Server
Downloads: This chapterpdf (PDF - 241.0KB) The complete bookPDF (PDF - 1.54MB) | Feedback

Configuring RTX Server

Table Of Contents

Configuring RTX Server

Configuring the Basics on the RTX Server

How to Enable LDAP Synchronization and Authentication

Overview of LDAP Synchronization and Authentication

Overview of Manager for Cisco UC for RTX

Installing Manager for Cisco UC for RTX

Adding RTX Server Information

Specifying LDAP Synchronization Settings

Selecting Synchronization and Authentication Types

Synchronizing and Authenticating Users

(Optional) Restoring RTX Users

How to Configure Cisco UC for RTX Features

Adding Roles According to Your Needs on RTX Server

Adding RTX Users to Roles

Specifying Feature Settings Using Manager for Cisco UC for RTX

Deploying Feature Settings to Client Computer

About Registry Settings

Location of Registry Settings

TFTP, CTIManager, and CCMCIP Server Registry Settings

Cisco WebEx Site Registry Settings

Voicemail and Visual Voicemail Registry Settings

Video Registry Settings

Account Credential Synchronization Registry Settings

Microsoft Office Integration Settings

Other Registry Settings


Configuring RTX Server


Revised: February 18, 2013

Configuring the Basics on the RTX Server

How to Enable LDAP Synchronization and Authentication

How to Configure Cisco UC for RTX Features

About Registry Settings

Configuring the Basics on the RTX Server

You perform basic configurations on the RTX server before you synchronize users from an LDAP server.

For information on how to configure RTX server, see the RTX Administrator's Manual at

http://rtx.tencent.com/rtx/support/index.shtml

What to Do Next

How to Enable LDAP Synchronization and Authentication

Related Topics

How to Configure Cisco Unified Communications Manager Server

How to Enable LDAP Synchronization and Authentication

Overview of LDAP Synchronization and Authentication

It is recommended that the usernames and directory numbers match in the following servers:

RTX server

Cisco Unified Communications Manager server

To achieve this goal, you enable LDAP synchronization when you configure Cisco Unified Communications Manager in the Enabling LDAP Synchronization, page 2-8. When this task is completed, you enable LDAP synchronization on the RTX server to import the same source data on which you build the Cisco Unified Communications Manager user database.

If you synchronize the RTX server with an LDAP server, you may also want to enable LDAP authentication. If you enable LDAP authentication on the RTX server, an LDAP server provides authentication services to the RTX server by proxy. For example, the RTX server can forward authentication requests from RTX clients to an LDAP server, and the LDAP server responds to the request.

It is recommended that you synchronize the office phone number and the mobile phone number of a contact during the LDAP synchronization. When the synchronization is completed, neither you nor users need to make any changes to these phone numbers.

Figure 3-1 shows LDAP synchronization and authentication between Manager for Cisco UC for RTX and the LDAP server.

Figure 3-1 LDAP Synchronization and Authentication

Overview of Manager for Cisco UC for RTX

Manager for Cisco UC for RTX allows you to

enable LDAP synchronization and authentication on the RTX server

configure Cisco UC for RTX features

You can download Manager for Cisco UC for RTX from Cisco.com. You must install the Manager for Cisco UC for RTX on the RTX server.

For information on how to configure Cisco UC for RTX features, see the "How to Configure Cisco UC for RTX Features" section.

To enable LDAP synchronization and authentication, you must perform the following tasks:

1. Installing Manager for Cisco UC for RTX

2. Adding RTX Server Information

3. Specifying LDAP Synchronization Settings

4. Selecting Synchronization and Authentication Types

5. Synchronizing and Authenticating Users

Installing Manager for Cisco UC for RTX

Procedure


Step 1 Download Manager for Cisco UC for RTX installation package from Cisco.com and save it locally on RTX server.


Note See the Release Notes for Cisco Unified Communications for RTX Release 8.6 for the download URL of Cisco UC for RTX.


Step 2 Run cucrtxManager.exe in the zip file and accept any warning that you see.

Step 3 Follow the installation wizard to complete the installation.


Adding RTX Server Information

Procedure


Step 1 Open Manager for Cisco UC for RTX.

Step 2 Select Service Status in the left navigation pane.

Step 3 Select Stop All Services if any service is running.

Step 4 Select RTX Server under Service Settings.

Step 5 Enter the IP address or the fully qualified domain name of the RTX server in the IP Address field.


Note You must stop all services before you apply changes to the IP address or the fully qualified domain name of the RTX server.


Step 6 Enter the port number in the APP Port field.

Step 7 Enter the port number in the SDK Port field.

Step 8 Select Apply.


Specifying LDAP Synchronization Settings

Procedure


Step 1 Open Manager for Cisco UC for RTX.

Step 2 Select LDAP Sync. and Auth. under Service Settings in the left navigation pane.

Step 3 Select Add on the upper right to add a new LDAP server.

Step 4 Enter a setting ID for the LDAP server setting.

Step 5 Select the LDAP server type.

Step 6 Enter the IP address and the port number of the LDAP server.

Step 7 Select the LDAP protocol version.

Step 8 Check the SSL check box if you use an SSL connection to the LDAP server.

Step 9 Enter LDAP manager distinguished name and password.

For example, as the username, enter CN=Administrator,CN=Users,DC=children1,DC=CUCRTX_AD_1,DC=com.

Step 10 Enter the organization unit which you synchronize as a department in the "Synchronizing and Authenticating Users" section.

For example, as the organization unit, enter OU=ou22,DC=children1,DC=CUCRTX_AD_1,DC=com.

Step 11 Enter the department name that you want to display at the top level in the RTX company structure. Then select Next.

Wait while the Manager for Cisco UC for RTX retrieves data from the LDAP server.


Note Users that you synchronize from the LDAP server are listed under the top-level department on the RTX server.


Step 12 Expand the domain name or the organization unit.

Step 13 Check the check box of the departments or the users that you want to synchronize from the LDAP server. Then select Next.

Step 14 Enter the name of the LDAP OU attribute that you want to map to the RTX department name.

Step 15 Enter the name of LDAP server user fields to specify how they are mapped to RTX server user fields. Then select OK.

Step 16 If you have multiple LDAP servers, repeat Step 3 to Step 15.


Selecting Synchronization and Authentication Types

Procedure


Step 1 Open Manager for Cisco UC for RTX.

Step 2 Select LDAP Sync. and Auth. under Service Settings in the left navigation pane.

Step 3 Select one of the following two synchronization types:

Overwrite—Replaces all the existing users on the RTX server with selected users on the LDAP server.

Incremental—Adds all of the selected users on the LDAP server to the RTX server. The synchronization updates users (with same usernames) on the RTX server with information on the LDAP server.

Step 4 Check if you want to perform just one synchronization. If not, specify a synchronization interval (no less than 6 hours) and the next synchronization time.

Step 5 Select either of the following two authentication types:

Local—The RTX server authenticates RTX users.

LDAP Authentication—The LDAP server authenticates RTX users.

Step 6 Select Apply.


Synchronizing and Authenticating Users

Procedure


Step 1 Open Manager for Cisco UC for RTX.

Step 2 Select Server Status in the left navigation pane.

Step 3 Right-click the service, LDAP_Synchronization, and select Start Service.


Note Before Manager for Cisco UC for RTX performs the LDAP synchronization, it automatically does a backup for the existing RTX users on the RTX server. For information on how to restore the RTX users, see the "(Optional) Restoring RTX Users" section.



Note To view the latest department structure on the RTX server after the synchronization, restart RTX Server Manager.


Step 4 Right-click the service, LDAP_Authentication, and select Start Service.


Related Topics

Configuring the Basics on the RTX Server

How to Configure Cisco Unified Communications Manager Server

(Optional) Restoring RTX Users

Procedure


Step 1 Stop all the services in Manager for Cisco UC for RTX.

Step 2 Select File > Restore > RTX Users.

Step 3 Select the backup file to which you want to restore the RTX users for the RTX server.


Note The maximum number of saved backup files is twenty. Manager for Cisco UC for RTX automatically removes old backup files when you have more than twenty saved backup files.


Step 4 Select Restore.


How to Configure Cisco UC for RTX Features

You can use the Manager for Cisco UC for RTX to configure features (for example, visual voicemail) on user computers.

When a user starts Cisco UC for RTX, Cisco UC for RTX automatically copies these settings to local disk and applies these settings.

To configure Cisco UC for RTX Features, perform the following tasks:

Adding Roles According to Your Needs on RTX Server

Adding RTX Users to Roles

Specifying Feature Settings Using Manager for Cisco UC for RTX

Deploying Feature Settings to Client Computer


Note If you do not want to use Manager for Cisco UC for RTX to configure features, you can use batch files. Run a batch file on each client computer to specify all the registry settings before users start Cisco UC for RTX. You create the batch file to meet your feature requirements based on the template that is available on Cisco.com. For detailed information on registry settings, see the "About Registry Settings" section.


Adding Roles According to Your Needs on RTX Server

Administrators add roles with different privilege levels on the RTX server. The default role is user. Users that you have synchronized from the LDAP server or manually added on the RTX server, have the default role of the user.

Manager for Cisco UC for RTX imports these roles from RTX server. You can configure Cisco UC for RTX features for each role. See the following three scenarios, which describe circumstances in which you need different user roles.

Scenario 1

Your company is geographically scattered. Users in Shanghai and Beijing are managed by different Cisco Unified Communications Managers.

Add two roles for users in Shanghai and Beijing respectively, for example, BJ_User, and SH_User. Then for each role, you specify the IP address of Cisco Unified Communications Manager in the Manager for Cisco UC for RTX.

Scenario 2

Your deploy the Cisco UC for RTX in a department or a division.

Add one role for Cisco UC for RTX users, for example, UC_User. Then for this role, you enable and configure Cisco UC for RTX features.

Scenario 3

Cisco UC for RTX features are distributed differently among executives, managers, and individual contributors.

Add one role for each type of employee. Configure Cisco UC for RTX features for each role. For example, you can specify that executives and managers are allowed to make video calls.

For information on how to add a role, see the RTX Administrator's Manual at

http://rtx.tencent.com/rtx/support/index.shtml

Adding RTX Users to Roles

You add roles in the "Adding Roles According to Your Needs on RTX Server" section. You must add users to each role.

Scenario 1

Add RTX users in Beijing site to the BJ_User role. Add users in Shanghai site to the SH_User role.

Scenario 2

Add RTX users that are Cisco UC for RTX users to the UC_User role.

Scenario 3

Add RTX users who are executives to the UC_Executives role. Add RTX users who are managers to the UC_Manager role. Add RTX users who are individual contributors to the UC_Contributor role.

For information on how to add users to a role, see the RTX Administrator's Manual at

http://rtx.tencent.com/rtx/support/index.shtml

Specifying Feature Settings Using Manager for Cisco UC for RTX

Procedure


Step 1 Open Manager for Cisco UC for RTX.

Step 2 Select Cisco UC for RTX Feature Settings under Server Settings in the left navigation pane.

Step 3 Select the role for which you specify the Cisco UC for RTX feature settings in the middle pane.

For example, if you deploy Cisco UC for RTX to all the employees, select the default role, user. If you deploy Cisco UC for RTX to a department or a division, select the UC_User role that you added in previous Scenario 2.


Note You define roles on the RTX server. The default role is user. To synchronize roles from the RTX server on Manager for Cisco UC for RTX, select the plus symbol of All Role to collapse the role list. Then select the symbol again to expand it.


Step 4 Check Enable Cisco UC for RTX features for this role.


Note If a RTX user has two or more roles for which administrators specified different Cisco UC for RTX feature settings, the feature settings of the role that appears at the lowest level of the role list take effect.


Step 5 Enter the IP address or fully qualified domain name of the primary TFTP server in your Cisco Unified Communications system in the TFTP Server 1 field.

Step 6 (Optional) Enter the IP address or fully qualified domain name of any other TFTP servers.

Step 7 Enter the IP address or fully qualified domain name of the primary CCMCIP server in the CCMCIP Server 1 field.

Step 8 (Optional) Enter the IP address or fully qualified domain name of any other CCMCIP servers.

Step 9 (Optional) Enter the IP address or fully qualified domain name of the primary CTIManager server in the CTI Server field.


Note Leave CTI Server blank if users do not use Cisco UC for RTX to control their desk phones.


Step 10 (Optional) Enter the IP address or fully qualified domain name of any other CTIManager servers.

Step 11 Enter the voicemail pilot number.

Step 12 (Optional) Check the check box if you want users to use Cisco UC for RTX username and password as credentials for visual voicemail in the Visual Voicemail area.

Step 13 Enter the IP address or fully qualified domain name of the Cisco Unity Connection server in the Server Address field.

Step 14 Select the connection protocol of the Cisco Unity Connection server.


Note To allow users to listen to secure voice messages, select TLS as the connection protocol.


Step 15 Enter the port.

Step 16 Enter the Inbox Name of voice messages on the Cisco Unity Connection server.

Step 17 Enter the Trash Name of voice messages on the Cisco Unity Connection server.

Step 18 Check the Enable video calls check box to allow users to make video calls.

Step 19 Check the Enable users to select whether to show their video automatically check box to allow users to select whether they do so.

Step 20 Check the Enable users to optimize video quality for their computers check box to allow users to optimize their video quality.

Step 21 This step depends on your preference. Check the check box to allow users to use their Cisco UC for RTX username and password as credentials for meeting in the Meeting area. If you have applied an account on Cisco WebEx Meetings Server site, uncheck the check box to allow users to manually set up their credentials for meeting in the Meeting area.

Step 22 Enter the Cisco WebEx site name or the Cisco WebEx Meetings Server address.

Step 23 Check the Microsoft Office integration check box to enable the integration.

Step 24 Select Apply.

Step 25 Repeat Step 3 to Step 24 if you want to configure Cisco UC for RTX features for more than one role.


Deploying Feature Settings to Client Computer

Procedure


Step 1 Open Manager for Cisco UC for RTX.

Step 2 Select Server Status.

Step 3 Right-click the third service, Feature_Deployment, and select Start Service.


About Registry Settings

Location of Registry Settings

TFTP, CTIManager, and CCMCIP Server Registry Settings

Cisco WebEx Site Registry Settings

Voicemail and Visual Voicemail Registry Settings

Video Registry Settings

Account Credential Synchronization Registry Settings

Microsoft Office Integration Settings

Other Registry Settings

Location of Registry Settings

You specify the configuration for Client Services Framework in the following registry key:

HKEY_CURRENT_USER\Software\Cisco Systems, Inc.\Unified Communications\cucrtx

TFTP, CTIManager, and CCMCIP Server Registry Settings

Table 3-1 lists the registry subkeys that you must use to specify the TFTP, CCMCIP, and CTIManager server configurations.

Table 3-1 TFTP, CCMCIP, and CTIManager Server Registry Subkeys 

Subkey Names
Description

TftpServer1,
TftpServer2,
TftpServer3

Enter the IP address or fully qualified domain name of the primary TFTP server in your Cisco Unified Communications system, and any other TFTP servers. If you are using certificates, the certificate common name must match the network identifier that is used to access the server (for example, IP address or hostname).

CtiServer1,
CtiServer2

Enter the IP address or fully qualified domain name of the primary CTIManager server in your Cisco Unified Communications system, and the secondary CTIManager server, if present. If you are using certificates, the certificate common name must match the network identifier that is used to access the server (for example, IP address or hostname).

CcmcipServer1, CcmcipServer2

Enter the IP address or fully qualified domain name of the primary CCMCIP server in your Cisco Unified Communications system, and the secondary CCMCIP server, if present. If you are using certificates, the certificate common name must match the network identifier that is used to access the server (for example, IP address or hostname).


Cisco WebEx Site Registry Settings

Table 3-2 lists the registry subkeys that you must use to specify the meeting center configuration.

Table 3-2 Meeting Center Registry Subkeys 

Subkey Names
Description

WebConfServer

Enter the Cisco WebEx site name in your Cisco Unified Communications system.


Voicemail and Visual Voicemail Registry Settings

Table 3-3 lists the registry subkeys that you must use to specify the voicemail and visual voicemail configuration.

Table 3-3 Voicemail and Visual Voicemail Registry Subkeys 

Subkey Names
Description

VoicemailPilotNumber

Enter the number of the voice message service in your Cisco Unified Communications system. This value applies only when users use a desk phone to access their voice messages. If users access voice messages using the phone on their computers, the pilot number comes from the voicemail pilot number that is associated with the voicemail profile that is configured on the Client Services Framework device.

VVM_Mailstore_Server_0

Enter the hostname for the Cisco Unity Connection server.

VVM_Mailstore_ImapPort_0

Enter the port number to use for IMAP for visual voicemail. The IMAP port number is usually 143. Enter 7993 for this value name if you want to implement secure messages on a Cisco Unity Connection server.

VVM_Mailstore_ImapProtocol_0

Enter the protocol to use for IMAP for visual voicemail. Enter TCP for this value name. If you want to implement secure messages on a Cisco Unity Connection server, enter TLS.

If you use secure transport protocols like TLS and HTTPS, the certificate presented by the server must be a trusted certificate, signed by a trusted authority. If you use a local authority or a self-signed certificate, you must add these to the Client Services Framework keystore and mark them as trusted.

VVM_Mailstore_InboxFolderName

Enter INBOX as the name of your voicemail message inbox on the voicemail server.

VVM_Mailstore_TrashFolderName

Enter the name of the folder to which deleted voice messages are moved on the Cisco Unity Connection server. For example, Deleted Items. This value is not required for Cisco Unity Connection servers.


Video Registry Settings

Table 3-4 lists the registry subkeys that you must use to specify video values.

Table 3-4 Video Registry Subkeys

Subkey Names
Description

SetVideoEnablePref

This value determines whether the user option to show video is displayed in the Cisco UC Settings in Cisco UC for RTX. To hide this option from users, set this value to False. To show this option to users, set this value to True.

SetVideoStaticThrottlingPref

This value determines whether the user option to optimize video is displayed in the Cisco UC Settings in Cisco UC for RTX. If users select this option, it enables static video throttling. To hide this option from users, set this value to False. To show this option to users, set this value to True.

VideoEnabled

This value determines whether the user can place and receive video calls. To enable users to place and receive video calls, set this value to True. If you do not want users to be able to place and receive video calls, set this value to False for the users.

If you do not set a value for this subkey name, the user can place and receive video calls.


Account Credential Synchronization Registry Settings

Client Services Framework includes settings that enable you to manage the credentials of Cisco Unified Communications back-end services. You can use these settings to configure the source of credentials for each service.

For example, you might have separate directories for your phone system, voicemail system, and meeting system. If you do not set the appropriate values for these services, your users have to perform the following steps to specify accounts:


Step 1 Select the menu button list in the RTX title bar.

Step 2 Select Cisco UC Settings > Accounts.

Step 3 Enter their username and password for each service.


Table 3-5 lists the registry subkeys that you must use to specify account credential synchronization.

Table 3-5 Account Credential Synchronization Registry Subkeys

Subkey Names
Description

WebConfService_UseCredentialsFrom
VoiceMailService_UseCredentialsFrom

You can set each of these subkey names to PHONE:

WebConfService_UseCredentialsFrom = PHONE— Use credentials of your phone system as credentials for meetings

VoiceMailService_UseCredentialsFrom = PHONE— Use credentials of your phone system as credentials for visual voicemail


Microsoft Office Integration Settings

Table 3-6 lists the registry subkey that you must use to enable or disable Microsoft Office integration.

Table 3-6 Microsoft Office Integration Registry Subkey

Subkey Names
Description

OfficeIntegrateEnabled

This value enables or disables Microsoft Office integration. The default value is False. To enable the integration, set this value to True. Users must also enable Microsoft Office integration in Cisco UC settings > General.


Other Registry Settings

Table 3-7 lists the registry subkey that you must use to make local registry settings take effect.

Table 3-7 Other Registry Subkeys

Subkey Names
Description

UseLocalSetting

If you use batch files instead of Manager for Cisco UC for RTX to configure Cisco UC for RTX features, you must set this value to True to make Cisco UC for RTX uses the local registry settings. The default value of this registry subkey in the batch file template is True.