Configure Unifed CM Users and CTI Remote Devices in Bulk for Hybrid Call Service Connect

Document created by Cisco Documentation Team on Mar 7, 2016Last modified by Marc Hollett on Aug 18, 2017
Version 7Show Document
  • View in full screen mode
 

Configure Unifed CM Users and CTI Remote Devices in Bulk for Hybrid Call Service Connect

Follow this tasks in this article if you want to use the Bulk Administration Tool to configure your users and CTI remote devices in bulk.

  

Hybrid Call Service Connect requires that you configure your on-premises users with CTI remote devices, which are virtual devices. After you create these virtual devices, the Cisco Collaboration Cloud creates a remote destination. These components allow for outgoing and incoming calls to ring the desk phone and Cisco Spark app of the called party.

Before You Begin 

Ensure that you started the configuration from this article. Complete these steps:

  
  •  

    Configure the initial Hybrid Call Service Connect settings in Cisco Spark Control Hub 

      

  •  

    Configure Cisco Unified Communications Manager settings for Hybrid Call Service Connect

      

  •  

    The Spark Remote Device (RD) is supported for Unified CM 10.5(2)SU5, 11.0(1)SU3, and 11.5(1)SU3. However, it is is not yet fully supported in other Unified CM releases that are compatible with Hybrid Call Service Connect. In the latter cases, the CTI-RD is used instead. For these latter cases, if you are relying on automatic creation of RDs as part of Hybrid Call Service Connect activation, then CTI-RDs are created. If you are creating RDs manually, then create CTI-RDs; do not create Spark-RDs.

      

  
            
 Command or ActionPurpose
1    Enable Users for Mobility 
  
  

Before exporting your user list, ensure that all users in your cluster are enabled for mobility. This step ensures that their CTI remote devices work correctly.

     
2    Export Your User List
  
  

Extract your user data as a text file.

     
3    Edit Your User List
  
  

Modify the user information in your file so that the attributes are correct before you upload the file to your publisher node. These steps walk through prompts that you would see in Microsoft Excel; other spreadsheet programs may vary.

     
4    Create the CTI Remote Device File Format
  
  

Prepare a new template file. This file contains the common configuration for the CTI remote devices for your users.

     
5    Edit the New File Template
  
  

Combine your user IDs from the users file with primary extensions in the template file and create a comma separated value (csv) file.

     
6    Create a CTI Remote Device Template
  
  

Create a template for all CTI remote devices that you associate with users. Like the user bulk settings, this template helps you specify universal settings for the CTI remote devices.

     
7    Upload Your CTI Remote Device Template File
  
  

Upload your csv file so it is ready to be applied to your system.

     
8    Insert the CTI Remote Device Entries
  
  

Update the phone specific details so that the CTI remote device information is added to your system in bulk.

     
9    Check the Status of Your Bulk Job
  
  

If needed, check the status of your bulk configuration. When your system refreshes, you can see whether the job succeeded or failed.

     

Enable Users for Mobility

Before exporting your user list, ensure that all users in your cluster are enabled for mobility. This step ensures that their CTI remote devices work correctly.

       
1    From Cisco Unified CM Administration, choose Bulk Administration > Users > Update Users > Query.
2    Click Find to show a list of users in the cluster, and then click Next.
3    On the Update Users Configuration window, check both check boxes next to Enable Mobility
4    Schedule your bulk job to either run immediately or at some later time, and then click Submit.
What to Do Next

 

Export Your User List

  

Export Your User List

Extract your user data as a text file.

Before You Begin 

Enable Users for Mobility

  
         
1    From Cisco Unified CM Administration, choose Bulk Administration > Users > Export Users.
2    Select Find All, and then select Next.
3    Enter a filename and select All User Format.
4    Run the export job.
5    After the job is complete, choose Bulk Administration > Upload/Download Files.
6    Find the file that your system created and download it to your desktop.
What to Do Next

 

Edit Your User List

  

Edit Your User List

Modify the user information in your file so that the attributes are correct before you upload the file to your publisher node. These steps walk through prompts that you would see in Microsoft Excel; other spreadsheet programs may vary.

Before You Begin 

Export Your User List

  
         
1    In your spreadsheet application, open your user list text file. At the prompt, choose Delimited and then specify your delimiter as Comma. Select Finish.
2    Highlight the primary extension column, go to the data tab, and select Sort. If prompted, expand the selection.
3    With the file sorted by primary extension, highlight all the rows without a primary extension and delete those rows.
4    Delete all columns except First Name, Last Name, User ID, and Primary Extension.
5    The primary extensions are in the format xxxxxxxx in <Partition>. Copy this value into a new column but omit the in <partition> characters. This new column must contain only the primary extension.
6    Save your file and give it a meaningful name, such as UserList.
What to Do Next

 

Create the CTI Remote Device File Format

  

Create the CTI Remote Device File Format

Prepare a new template file. This file contains the common configuration for the CTI remote devices for your users.

Before You Begin 

Edit Your User List

  
            
1    Configure a single CTI remote device for one user, if this device doesn't yet exist. This entry serves as a template for the other CTI-RDs that you'll use the Bulk Administration Tool to create.

You can use any device name you want. For this configuration, we recommend that you use SparkRD<userid>.

2    From Cisco Unified CM Administration, navigate to Bulk Administration > Phones > Phone File Format > Create File Format.
3    Create a new file format named SparkRD and add the following fields:
  • Device fields
    •  

      CSS

        

    •  

      CSS Reroute

        

    •  

      Description

        

    •  

      Device Name

        

    •  

      Device Pool

        

    •  

      Location

        

    •  

      Owner User ID

        

    •  

      Rerouting Calling Search Space

        

    •  

      User ID

        

  • Line fields
    •  

      Alerting Name

        

    •  

      ASCII Alerting Name

        

    •  

      ASCII Display

        

    •  

      Display

        

    •  

      Directory Number

        

    •  

      External Phone Number Mask

        

    •  

      Line CSS

        

    •  

      Line Description

        

    •  

      Line Text Label

        

    •  

      Maximum Number of Calls

        

    •  

      Route Partition

        

    •  

      Voice Mail Profile

        

4    Enter 1 for the Maximum Number of Lines.
5    Click Save.
6    Navigate to Bulk Administration > Phones > Export Phones > Specific Details.
7    Search for phones with the device type CTI Remote Device to find the entry that you created, for example, SparkRD<userid>.
8    Select Next. Using the file format SparkRD, run the job.
9    After the job finishes, choose Bulk Administration > Upload/Download Files and find the text file that you just created. Download it to your desktop and give it a meaningful name such as SparkRD-fileformat.
What to Do Next

 

Edit the New File Template

  

Edit the New File Template

Combine your user IDs from the users file with primary extensions in the template file and create a comma separated value (csv) file.

          
1    In Microsoft Excel, open the SparkRD file format file. At the prompt, choose Delimited and then specify your delimiter as Comma.
2    Select Finish.
3    Open your modified user list file.
4    Copy your list of user IDs from the users file into the User ID column of the file format spreadsheet. Then copy the new list of Primary Extensions into the Directory Number 1 column.
5    Using the User ID column, populate the Device Name column with SparkRD<userid>. Populate the remaining columns with data that is specific to your cluster; use the data in the original CTI remote device as a guide.
6    Populate the Maximum Number of Calls column with the value 4.
7    Save the resulting file in the comma separated value (.csv) format.

Create a CTI Remote Device Template

Create a template for all CTI remote devices that you associate with users. Like the user bulk settings, this template helps you specify universal settings for the CTI remote devices.

Before You Begin 

Edit the New File Template

  
              
1    From Cisco Unified CM Administration, choose Bulk Administration > Phones > Phone Template.
2    Select Add New.
3    Select the phone type CTI Remote Device.
4    Specify an owner for the template.
5    Name the new template SparkRD Call and enter a description.
6    Select Save.
7    Select a Device Pool and Location, and leave the other settings with their default values.
8    Select Save.
9    Select Line 1. Name the Line Template SparkRD Call
10    Place the template in the appropriate Route Partition. Leave the other fields with their default values.
11    Select Save.
What to Do Next

 

Upload Your CTI Remote Device Template File

  

Upload Your CTI Remote Device Template File

Upload your csv file so it is ready to be applied to your system.

Before You Begin 

Create a CTI Remote Device Template

  
      
1    From Cisco Unified CM Administration, choose Bulk Administration > Upload/Download Files, and select Add New.
2    Browse to the SparkRD template file that you created earlier. Set the target to Phones and set the Transaction Type to Insert Phones - Specific Details.
3    Select Save.
What to Do Next

 

Insert the CTI Remote Device Entries

  

Insert the CTI Remote Device Entries

Update the phone specific details so that the CTI remote device information is added to your system in bulk.

          
1    From Cisco Unified CM Administration, choose Bulk Administration > Phones > Insert Phones.
2    Select Insert Phone Specific Details.
3    For File Name, select the csv file that you uploaded.
4    For Phone Template Name, select the CTI-RD template that you created.
5    Select Run Immediately to run this job now or Run Later to schedule the job to run at a more convenient time.
6    (Optional)Enter a job description to identify the job.
7    Select Submit.
What to Do Next

 

Check the Status of Your Bulk Job

  

Check the Status of Your Bulk Job

 

If needed, check the status of your bulk configuration. When your system refreshes, you can see whether the job succeeded or failed.

  
Before You Begin 

Insert the CTI Remote Device Entries

  
     
1    From Cisco Unified CM Administration, choose Bulk Administration > Job Scheduler.
2    Select Find to show the status of the bulk job that you scheduled.
What to Do Next

 

Return to this article and follow the steps to configure the Expressway pair.

  
 

Attachments

    Outcomes