Networking Guide for Cisco Unity Connection Release 8.x
VPIM Networking in Cisco Unity Connection 8.x
Table of Contents
Cisco Unity Connection supports the Voice Profile for Internet Mail (VPIM) protocol, which is an industry standard that allows different voice messaging systems to exchange voice and text messages over the Internet or any TCP/IP network. VPIM is based on the Simple Mail Transfer Protocol (SMTP) and the Multi-Purpose Internet Mail Extension (MIME) protocols.
VPIM Networking can be used for messaging between Cisco Unity Connection 2.x and later servers, or between Connection 2.x and later servers and other VPIM-compatible voice messaging systems such as Cisco Unity 4.0 and later. Note that additional server discovery and directory synchronization functionality is available when you use Digital Networking rather than VPIM to connect multiple Connection 2.x and later servers.
VPIM Networking is a licensed feature. For more information on obtaining licenses for Connection features, see the “ Managing Licenses in Cisco Unity Connection 8.x ” chapter of the System Administration Guide for Cisco Unity Connection Release 8.x, available at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/administration/guide/8xcucsagx.html.
This section describes the prerequisites for setting up VPIM Networking, and provides a task list containing a high-level view of all of the tasks you need to complete for the setup, and the order in which they should be completed. If you are unfamiliar with VPIM Networking, you should first read the “VPIM Concepts in Cisco Unity Connection 8.x” section and then review the task list and procedures before beginning the setup.
1. Make decisions about your numbering plan and gather information needed to configure VPIM Networking. See the “Making Design Decisions and Gathering Needed Information” section.
2. Determine the domain name that is used for messaging between the remote voice messaging system and Connection. See the “Determining the Domain Name” section.
3. As applicable, configure DNS files. See the “Resolving Names with IP Addresses” section.
4. Verify network and SMTP connectivity with the remote voice messaging system. See the “Verifying Connectivity with the Remote Voice Messaging System” section.
5. Create the VPIM locations for each remote voice messaging system. See the “Creating VPIM Locations” section.
6. Create VPIM contacts for each VPIM location. See the “Creating VPIM Contacts” section.
7. Optionally, customize the contact creation settings for each VPIM location. See the “Customizing VPIM Contact Directory Update Settings” section.
8. Optionally, add an alternate name for each VPIM location. See the “Adding Alternate Names for Each VPIM Location” section.
9. Set up the remote voice messaging system for VPIM. Precisely how this is done depends on the voice messaging system. However, you need to provide the remote system with information about Connection. See the “Gathering Information About Cisco Unity Connection to Configure Another Voice Messaging System for VPIM” section.
For detailed explanations of VPIM Networking concepts, see the “VPIM Concepts in Cisco Unity Connection 8.x” section.
VPIM messages are addressed in the format <Mailbox Number>@<Domain Name>. In order for messages to be exchanged between the remote voice messaging system and Cisco Unity Connection, you need to decide on the domain name that the remote voice messaging system uses when addressing messages to Connection users. The domain name is configured as follows:
VPIM messages are sent over the Internet or any TCP/IP network via SMTP. Therefore, a mechanism for name resolution is required for the remote voice messaging server. The supported method for name resolution is through a Domain Name System (DNS).
For networking with another voice messaging server, you may need to install and configure an SMTP service or gateway on that server. See the documentation of the other voice messaging system for information on installing the SMTP service or gateway. Before proceeding, verify that the SMTP service or gateway has been installed on the other voice messaging server.
If you receive no reply, troubleshoot the network connectivity problem until the problem is resolved. Then continue with Step 3.
Step 3 Enter ping <Domain name> where <Domain name> is the domain name that is used to address messages to the remote voice messaging server. The domain name in this step is the domain name that is entered for the VPIM location in Cisco Unity Connection Administration when setting up VPIM Networking.
Step 4 If you received a reply when pinging the IP address in Step 2, but no replies when pinging the domain name in Step 3, see the “Resolving Names with IP Addresses” section. When the problem is resolved, continue with Step 5.
Step 5 Test network connectivity in the opposite direction. For systems other than Connection, see the documentation for information on how to conduct the test, and continue with Step 6. Note that the remaining steps in this procedure may not exactly match the steps necessary for your system, so you may need to make adjustments.
If you receive no reply, troubleshoot the network connectivity problem until the problem is resolved. Then continue with Step 7.
Step 7 On the remote server, ping the domain name, where the domain name is the one that is discussed in the “Determining the Domain Name” section.
Step 8 If pinging by domain name fails, see the “Resolving Names with IP Addresses” section.
Create a VPIM location on Cisco Unity Connection for each remote voice messaging system to which users send messages. If Connection will message with a large number of voice messaging systems, you may prefer to configure only a few VPIM locations at this time and proceed with the rest of the setup. After verifying that messaging works correctly between Connection and the voice messaging systems for which VPIM locations have been configured, you can create the rest of the VPIM locations.
You may prefer to create only a few VPIM contacts at this point, for testing purposes, until you verify that Cisco Unity Connection and the remote voice messaging system can successfully exchange messages. After you have confirmed that messaging between Connection and the remote voice messaging system is working correctly, you can finish creating the VPIM contacts. Note that you must first create VPIM locations before creating VPIM contacts, and the VPIM contacts must be created on the same Connection server on which you created the VPIM locations.
The Bulk Administration Tool (BAT) allows you to create multiple VPIM contacts at the same time by importing contact data from a comma-separated value (CSV) file. CSV is a common text file format for moving data from one data store to another.
Step 4 Rearrange the data so that the columns are in the same order as the column headers that you will add in Step 5. The order of the column headers does not matter, though it is good practice to set up your CSV file as indicated here. For example, the columns of data in this sample are sorted so that the alias of the contact is followed by the last name, the first name, the extension, the remote mailbox ID (RemoteMailAddress), and then by VPIM location (DeliveryLocationDisplayName):
aabade,Abade,Alex,2001,3000,Chicago VMS VPIM Location
Note The only required column headers for creating contacts are Alias and Extension. However, in order to create VPIM contacts you must also include columns for the remote mailbox ID and the VPIM location.
Tip Include a column with the ListInDirectory header and a value of 1 for each contact if you would like users to be able to address messages to VPIM contacts the same way that they address messages to regular Connection users—by extension or by spelling the name of the recipient. For a list of optional column headers, see the “Required and Optional CSV Fields for Contacts” table in the “Using the Cisco Unity Connection 8.x Bulk Administration Tool” appendix of the User Moves, Adds, and Changes Guide for Cisco Unity Connection Release 8.x, available at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/user_mac/guide/8xcucmacx.html.
Step 7 If your CSV file contains columns of data that you do not want to import, delete the columns. Alternatively, you can title one column NOTES. The BAT ignores data beneath any NOTES column header, but it does not support more than one NOTES column in a CSV file.
Step 10 Continue with the following “To Create VPIM Contacts by Using the Bulk Administration Tool” procedure.
Step 5 In the Choose File dialog box, browse to the directory where you saved the CSV file that you created in the To Prepare a CSV File for Creating VPIM Contacts and select Open.
The failed objects file contains data that failed to create a VPIM contact. The Bulk Administration Tool reports the first error it detects in a row in a CSV file. When you have corrected that error, the BAT may detect additional errors in the same row when the data is imported again. Thus, you may need to repeat the correction process—running the BAT and correcting an error—several times to find and correct all errors.
The failed objects file contains all the records that failed to create a VPIM contact. You can save the file as a CSV file, and use it when you run the BAT again. Note that each time you run the BAT, the failed objects file is overwritten.
Step 5 Run the BAT again with the CSV file that you saved in Step 4 as the input file.
Step 6 Repeat this procedure until all VPIM contact accounts are created without error, and then proceed to the “After Creating VPIM Contacts” section.
In addition to manually creating, modifying, and deleting VPIM contacts, you can configure Cisco Unity Connection to automatically update records in the VPIM contact directory based on information that is contained in incoming VPIM messages. The settings that control whether the creation, modification, and deletion actions occur automatically, and how the incoming information is used to create or modify a record, can be individually configured for each VPIM location. By default, no automatic directory updates occur for any VPIM locations.
Depending on the Contact Creation settings that you select for each VPIM location, Connection uses information from the header of an incoming VPIM message. If a VPIM message is received from a sender on a VPIM location that is configured to allow automatic VPIM contact creation, and no existing VPIM contact matches the information of the sender, a new VPIM contact record is created, provided that the VPIM message contains:
Additional Contact Creation settings allow you to specify how to map the parsed text name of the VPIM contact to a first name, last name, and display name, and how to map the phone number to an extension.
Note Changes to the Map VPIM Contact Extensions setting on the Contact Creation page for a VPIM location affect only VPIM contacts that are created after the setting is saved. VPIM contacts that already existed before the Map VPIM Contact Extensions setting is changed are not automatically updated. You must manually change the extension for each previously existing VPIM contact for that VPIM location.
If a VPIM message is received from a sender on a VPIM location that is configured to allow automatic VPIM contact modification, and an existing VPIM contact matches the sender information, the VPIM contact can be updated. You can choose whether VPIM contact information is updated each time a message is received from a VPIM contact, or only when a message is received from a VPIM contact whose text name has changed since the directory entry was created. You can also decide whether or not to allow an update to the display name when a modification is made.
If a message from a Connection user to a VPIM contact results in a non-delivery receipt (NDR), indicating that the message was undeliverable because the intended recipient does not exist (SMTP 5.1.1), and if the VPIM location is configured to allow automatic VPIM contact deletion, the VPIM contact is deleted.
Step 4 On the Contact Creation page, check the Automatically Create VPIM Contacts check box to enable automatic creation of a VPIM contact record for this location when a VPIM message arrives and the sender does not already have a corresponding VPIM contact record.
Step 5 If you checked the Automatically Create VPIM Contacts check box in Step 4, in the Contact Template list, select the template on which to base the automatically created contacts.
Step 8 Check the Allow VPIM Contact Display Name Updates check box to enable automatic updates to the VPIM contact display name when an incoming message from this location has a changed display name for the sender.
Step 10 In the Mapping Text Names field, select one of the following options to indicate how text names in incoming messages from this location are mapped to the display names for automatically created VPIM contact records:
Step 11 In the Map VPIM Contact Extensions To field, select one of the following settings to indicate how the phone number on incoming messages from this location is mapped to the extension for automatically created VPIM contact records:
When the Cisco Unity Connection system uses the voice-recognition option, you can also specify alternate names for the display name that you give a VPIM location. Users say the display name when they use voice commands to blind address to a mailbox number at a VPIM location (for example, to address to extension 55 at a VPIM location named Seattle, a user would say “five five at Seattle”) or to address a message to a VPIM contact name at a VPIM location (for example, “Robin Smith in Chicago”). Consider specifying alternate names if the VPIM location display name contains administrative information that users are not likely to know, or if it is not pronounced the way it would be read, as may be the case with acronyms and abbreviations. Also consider adding alternate names if users tend to refer to a location in multiple ways. For example, if users at one site refer to a location as “Seattle branch” and users at another site refer to the same location as “Seattle office,” you could add both “Seattle branch” and “Seattle office” as alternate names.
Gathering Information About Cisco Unity Connection to Configure Another Voice Messaging System for VPIM
When you remove a VPIM location, you must remove (or reassign) any contacts and contact templates that use the location before deleting the VPIM location object. Use the following task list to remove a VPIM location.
1. Use the Bulk Administration Tool to export a list of all administrator-defined contacts. See the “Exporting Contacts to a CSV File” section in the “ Using the Cisco Unity Connection 8.x Bulk Administration Tool ” appendix of the User Moves, Adds, and Changes Guide for Cisco Unity Connection Release 8.x, available at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/user_mac/guide/8xcucmacx.html.
2. Download the export file, and use a text editor to modify it to contain only the rows in which the DeliveryLocationDisplayName matches the display name of the VPIM location that you are removing. (If you plan to reassign the contacts to a different VPIM location, update the value in the DeliveryLocationDisplayName column.)
3. Use the Bulk Administration Tool to delete the list of contacts you generated in Task 2. See the “Deleting Contacts” section in the “ Using the Cisco Unity Connection 8.x Bulk Administration Tool ” appendix of the User Moves, Adds, and Changes Guide for Cisco Unity Connection Release 8.x.
Alternatively, to reassign the contacts to a different VPIM location, use the Update option. See the “Updating Contacts” section in the “ Using the Cisco Unity Connection 8.x Bulk Administration Tool ” appendix of the User Moves, Adds, and Changes Guide for Cisco Unity Connection Release 8.x.
4. In Cisco Unity Connection Administration, expand Templates, then select Contact Templates. If a contact template is configured to use the VPIM location as the delivery location, change the delivery location, or delete the template. (You may need to select the display name of each template on the Search Contact Templates page to verify or change the delivery location.)
5. To delete the location, in Connection Administration, expand Networking, then select VPIM Locations. On the Search VPIM Locations page, check the check box next to the display name of the location that you want to delete, then select Delete Selected.
VPIM messages are made up of one or more MIME-encoded parts. The VPIM specification allows for optional MIME parts for spoken name and for forwarded and text messages. Cisco Unity Connection does not, however, support sending or receiving a vCard (an electronic business card that includes phone number, text name, and email address). If a vCard is attached to an outgoing or incoming message, Connection removes the vCard data. In addition, any attachments to messages other than the voice message and embedded messages are removed from outgoing and incoming messages.
Connection allows you to specify whether the recorded name of the sender is sent with outgoing messages. If incoming messages include a recorded name, it is played as part of the message. Connection can also be configured to update the directory with information from the header from incoming messages.
Outgoing messages to a VPIM location do not include any recipients other than those at the VPIM location. Therefore, when a VPIM recipient replies to all addressees on a message, the reply will go only to the sender and to any other recipients at the same VPIM location.
Figure 4-1 shows a sample VPIM message. Only a portion of the MIME encoding of the spoken name and voice message parts are shown because they are very long.
A VPIM address is in the same format as a typical SMTP email address: localpart@hostpart. The right-hand side of the address is the domain name of the system on the TCP/IP network that handles messages. The left-hand side of the address is a unique identifier for the user. Typically, the left-hand side is the user mailbox number or the mailbox number with a prefix.
The Audio Format Conversion settings for the VPIM location (on the Networking > Edit VPIM Location page in Cisco Unity Connection Administration) allow you to control the audio format of outgoing and incoming VPIM messages, as follows: