This document provides information on the use of BAT to import user contact lists into Cisco Unified Presence. We can prepopulate contact lists for new Cisco Unified Presence client users or add to existing contact lists. For this you must provide BAT with an input file that contains the user contact lists.
Cisco recommends that you have knowledge of these topics:
- Cisco Unified Presence 8.6 and Up
- Cisco Unified Communications Manager 6.x
To import user contact lists, you must provide BAT with an input file that contains the user contact lists.
The input file must be a CSV file in the following format:
<User ID>,<User Domain>,<Contact ID>,<Contact Domain>,<Nickname>,<Group Name>
The following is a sample CSV file entry:
The user ID of the Cisco Unified Presence user. It can have a maximum 132 characters. (This is a mandatory parameter.)
The Presence domain of the Cisco Unified Presence user. It can have a maximum of 128 characters.(This is a mandatory parameter)
The user ID of the contact list entry. It can have a maximum of 132 characters. ( This is a mandatory parameter)
The Presence domain of the contact list entry. The following restrictions apply to the format of the domain name:
•Length must be less than or equal to 128 characters
•Contains only numbers, upper- and lowercase letters, and hyphens
•Must not start or end with hyphens
•Length of label must be less than or equal to 63 characters
•Top-level domain must be characters only and have at least two characters
Note This is a mandatory parameter.
The nickname of the contact list entry. It can have a maximum of 255 characters.
The name of the group to which the contact list entry is to be added. It can have a maximum of 255 characters.(This is a mandatory parameter. )
Tasks to be completed before importing
1. Provision the users on Cisco Unified Communications Manager.
2. Ensure that the users are licensed and assigned to Cisco Unified Presence.
Note The default contact list import rate is based on the server hardware type. You can change the contact list import rate by selecting Cisco Unified Presence Administrator > System > Service Parameters > Cisco Bulk Provisioning Service. However, if you increase the default import rate, this will result in higher CPU and memory usage on Cisco Unified Presence.
Complete the following steps to import user contact lists into Cisco Unified Presence:
- Check Maximum Contact List Size
- Upload the Input File Using BAT
- Create a New Bulk Administration Job
- Check Results of Bulk Administration Job
Check Maximum Contact List Size
Before you import contact lists, Cisco recommends that you check the Maximum Contact List Size and Maximum Watchers settings in Cisco Unified Presence. If a user's contact list size is over the limit, no contacts will be imported for the user. To ensure that no user's contact list size exceeds the limit, you can increase the Maximum Contact List Size setting or set it to Unlimited. This ensures that each user's contact list is fully imported to Cisco Unified Presence.
The system default value is 200 for Maximum Contact List Size and 200 for Maximum Watchers.
Note:- You only need to check the maximum contact list size on those clusters that contain users for whom you wish to import contacts. When you change Presence settings, the changes are applied to all nodes in the cluster; therefore you only need to change these settings on the Cisco Unified Presence Publisher node within the cluster.
Upload the Input File Using BAT
The following procedure describes how to upload the CSV file using BAT.
Step 1 Select Cisco Unified Presence Administration > Bulk Administration > Upload/Download Files.
Step 2 Select Add New.
Step 3 Select Browse to locate and select the CSV file.
Step 4 Select Contact Lists as the Target.
Step 5 Select Import Users' Contacts - Custom File as the Transaction Type.
Step 6 Select Save to upload the file.
Create a New Bulk Administration Job
The following procedure describes how to create a new bulk administration job in Cisco Unified Presence Administration.
Step 1 Select Cisco Unified Presence Administration > Bulk Administration > Contact List > Update.
Step 2 From the File Name drop-down list, select the file to import.
Step 3 In the Job Description field, enter a description for this Bulk Administration job.
Step 4 Select one of the following:
•Select Run Immediately to execute the Bulk Administration job immediately.
•Select Run Later to schedule a time to execute the Bulk Administration job.
Step 5 Select Submit. If you selected to run the job immediately, the job runs after you select Submit.
Check Results of Bulk Administration Job
When the Bulk Administration job is complete, the Cisco Unified Presence BAT tool writes the results of the contact list import job to a log file. The log file contains the following information:
• The number of contacts that were successfully imported.
• The number of internal server errors that were encountered while trying to import the contacts.
• The number of contacts that were not imported (ignored). The log file lists a reason for each ignored contact at the end of the log file. The following are the reasons for not importing a contact:
- Invalid format—invalid row format, for example, a required field is missing or empty
- Invalid contact domain—the contact domain is in an invalid format; see Table 6-3 for the valid format of the contact domain
- Cannot add self as a contact—you cannot import a contact for a user if the contact is the user
- User's contact list is over limit—the user has reached the maximum contact list size and no more contacts can be imported for that user
- User is not assigned to local node—the user is not assigned to the local node
• The number of contacts in the CSV file that were unprocessed due to an error that caused the BAT job to finish early. This error rarely occurs.
Complete the following procedure to access this log file.
Step 1 Select Cisco Unified Presence Administration > Bulk Administration > Job Scheduler.
Step 2 Select Find and select the job ID of the contact list import job.
Step 3 Select the Log File Name link to open the log.
If you require further detail on any BAT job, see the Bulk Provisioning Service debug logs. You can access these logs at the following location: /var/log/active/cm/trace/bps/log4j/bps000*.txt
You can enable debug logging for the Bulk Provisioning Service on the Cisco Unified Serviceability GUI.
Configure BAT Provisioning Service Logging on Cisco Unified Presence
The following procedure describes how to configure BAT Provisioning Service logging on Cisco Unified Presence.
Step 1 Select Cisco Unified Serviceability > Trace > Configuration.
Step 2 Select the Cisco Unified Presence server, and select Go.
Step 3 Select Database and Admin Services from the Service Group drop-down list and select Go.
Step 4 Select the Bulk Provisioning Service from the Service drop-down list and select Go.
Step 5 Select Trace On.
Step 6 In the Trace Filter Settings, select the Debug Trace Level. If you want to enable debug level on the traces, select Debug.
Step 7 Select Save.