Bulk Import from File

Use the Bulk User Provisioning Tool to provision users and services. The tool allows you to perform the following tasks:

import a database of user entries from a file
edit the user entries in the online editor, and then
upload the entries into the MiCollab Users and Services database.

Conditions

You cannot use the bulk import feature to change existing user records in the database. Bulk import is for adding new users and services only.
You can import user data from the following source files:
- comma-separated value (CSV) file exported from a communications platform
- LDAP Data Interchange Format (LDIF) file exported from a directory server.
You cannot import MiCollab Client contacts via a CSV or LDIF file.
Contacts imported via Active Directory are displayed as read-only in the Bulk User Provisioning tool.
You must open the Example CSV File (BUPExample.csv) in Microsoft Excel and use it to import your user data. It is not possible to bulk add a user by manually data-fill (typing into the grid).
The maximum import file size is 5000 entries.
MiCollab users can be configured with multiple phones and each phone extension consumes a device (Multi-Device User Group device) on the MiVoice Business system. On a 2500 or 5000-user MiCollab system, it is possible to exceed the device limits of the MiVoice Business system(s). To minimize the possibility of over provisioning, do not assign users with unnecessary phones. Also, during initial bulk provisioning of a 2500 or 5000-user MiCollab system, create roles and templates that assign the actual phone requirements for the users. For example, if you have UCC Premium users who only require two phones, create and apply a "UCC Premium - 2 phone" role and template. If you use the default UCC roles and templates, the maximum number of phones are applied, increasing the risk of over provisioning.
The Bulk User Import Tool does not support importing MAC addresses from the CSV file.
Disable Skype plug-ins before you import records using the Bulk User Provisioning tool. Skype plug-ins can cause the BUP import process to be very slow or in extreme cases stop functioning.
2-byte UTF-8 character format is supported in the following User and Services application fields: First Name, Last Name, and Role. To import entries with UTF-8 characters, you must import them from a CSV or LDIF file that supports UTF-8 encoding. Use an editor (for example, Notepad++) that supports UTF-8 encoding to create the import file.

Note:
Do not use an Excel file. Excel does not display UTF-8 characters properly in CSV files, even if the encoding is set to UTF-8. Also, if you are importing from an LDIF file, ensure that only ISO-8859-1 characters are present in the file. For LDIF import files, the Users and Services Bulk User Provisioning tool only supports the ISO-8859-1 character set.
The Bulk Import from File functionality is not supported for MiCollab integrations with the MiVoice 5000. However, MiCollab Client contacts that fail to be imported during a directory server synchronization can be managed from the Manage Detained Queue.
For MiCollab with MiVoice Office 400 or MiVoice MX-ONE integrations, you only use the Bulk User Provisioning Tool to import users into MiCollab. You can export a CSV file of user entries from the communications platform and then import the user entries into the MiCollab system using the Bulk User Provisioning (BUP) tool in USP. Note that an import CSV file for the BUP tool can contain a maximum of 5000 users.

Note: The Flow Through Provisioning feature shares MiVoice Business templates with the MiCollab system. The MiVoice Business templates support key template programming for users created from MiCollab USP. However, when a key template is created on the MiVoice Business system, the template is not validated for incomplete key programming (such as a missing ring type in a DSS/BLF key). The system only generates errors when you attempt to apply the invalid key template to a user via a role. Therefore, whenever you create a new key template on the MiVoice Business, ensure that you test it by applying it to a MiVoice Business user. If you receive errors related to key programming when you attempt to apply a shared template, you must correct the key template on the MiVoice Business.

Import File Format

The file must include the mandatory headers listed in the following table:

Column Header	Mandatory or Optional	Format	Notes
First Name	optional	Up to 256 characters. UTF8 characters are supported; however, ordinal indicator characters are not displayed correctly in the First Name and Last Name fields across MiCollab applications.	The first name or last name must be provided.
Last Name	mandatory		The first name or last name must be provided.
Login ID	mandatory	2 to 21 characters. Limited to ASCII (non-accented) characters (@, comma, or space are not allowed).	A login ID is generated from the user's first and last name if this value is missing. This field does not apply to corporate contacts.
Email Address	optional (unless required by template for specified role)	Must be a valid e-mail address. Limited to ASCII (non-accented) characters.	Email address is mandatory if MiCollab Audio, Web and Video Conferencing is included in the template.
Role	mandatory	UTF8 characters are supported.	The roles that you specify in the Import file must be programmed in the Roles tab of the User and Services application (with the exception of the default Contact role). Otherwise, warnings will be present after you import the entries into the Bulk User Provisioning tool. The Role that you assign to a user must correspond to the user's MiVoice Business network element.
Primary Phone	optional (unless required by template for specified role)	1 to 7 digits, # or *. No spaces	Directory number must be unique (cannot already exist in system directory). For non-corporate contacts, external numbers are permitted.
Secondary Phone	optional (unless required by template for specified role)	1 to 7 digits, # or *. No spaces.	Directory number must be unique (cannot already exist in system directory). For non-corporate contacts, external numbers are permitted.
External Number	optional (unless required by template for specified role)	E.164 format is supported.	This column is mandatory if the selected template requires an external hot desk user (EHDU) number. For MiCollab with MiVoice MX-ONE integrations, this field only applies to MiCollab Client contact entries.
DID Number	optional	E.164 format is supported	Direct Inward Dialing (DID) routes incoming calls on a designated trunk to the user's phone. Enter the dialing prefix and external number of the designated DID trunk. This field only applies to MiCollab with MiVoice Business integrations. Not applicable to corporate contacts
SIP Password	optional (unless required by template for specified role)	Up to 26 characters (ISO-8599-1). This field can be blank.	SIP password which will be passed to MBG to authenticate the SIP user. This column is mandatory if the selected template requires a SIP Password.
ID	optional	E.164 format is supported

Note: For MiVoice MX-ONE, DTS Phone field is treated as Secondary Extension.

Import from .CSV File

Export the user data from the MiVoice Business , MiVoice MX-ONE, MiVoice Office 400 or MiVoice Office 250 communications platform to a CSV file. For MiVoice Business systems, you can export the user data from the User and Device Configuration form (refer to the MiVoice Business System Administration Tool online help for instructions).
In the MiCollab server manager, under Applications click Users and Services.
Click the Bulk User Provisioning tab.
Click Tools, click Download Example CSV File, scroll down to the bottom of the screen, and then click Open. The file (BUPExample.csv) opens in Excel. The BUPExample.csv file is shown below:

Copy the communication platform user data from the exported file into the import file spreadsheet columns, starting at row 2.

MiVoice Business Specific Information:

The following table shows how the BUP file headings map to the MiVoice Business User and Service Configuration form headings. Refer to the notes provided below for additional guidelines.

BUP File Column Heading	User and Services Configuration File Column Heading
First Name	First Name
Last Name	Last Name
Login ID	Login ID
Email Address	Email
Role	Not applicable - you need to create roles on MiCollab and specify one of the roles in the BUP file.
Primary Phone	Number
DID Number	DID Service Number
SIP Password
Department	Department
Location	Location

General Notes:

Do not modify or overwrite the first row of header data in the spreadsheet. If you modify the first row of data, the import will fail.
The maximum import file size is 5000 entries.
Do not import AWV or NP-UM ports (that is, do not include AWV or NP-UM ports in the BUP spreadsheet).
Ensure that an appropriate role is assigned to each user.
Enter Roles carefully -- Roles are case sensitive.
Add each network element users in a separate BUP Import Spreadsheet file.
If there are two phones in a template and one is a MiNET phone and the other is a SIP Phone, the SIP password is only applied to the SIP phone.

MiVoice Business Specific Notes:

If you are importing a Bulk User Provisioning file to migrate to Flow Through Provisioning, the phone service details (for example: Device Type) are irrelevant. The sync and reconcile operation that runs at the end of the start sharing process assigns the users' phone services from the MiVoice Business database to the MiCollab user entries.
In MiVoice Business, Login IDs are case sensitive (so, smithF and smithf are two unique Login IDs). However in MiCollab, Login IDs are not case sensitive (so, smithF and smithf are the same Login ID). To avoid conflicts during the synchronization, ensure that all Login IDs consist of a unique set of characters.

Click the Office Button , click Save As, click Other Formats and then save the file type as CSV (comma delimited) (*.csv).
If you are prompted to "keep the workbook in this format", click Yes. Close the file.
Click Tools and then click Import from File. The Import from File window opens.
Select Import Bulk Add CSV File.
Click Browse and navigate to the .csv file.
Select the file and click Open.

Note: Ensure that you disable Skype plug-ins before you import records using the Bulk User Provisioning tool. Skype plug-ins can cause the BUP import process to be very slow or in extreme cases stop functioning.

Click Import. The data from the .csv file is imported.
If the import is successful, the entries are listed in the Bulk User Provisioning Tool. Invalid entries are indicated with error icons. Correct any invalid entries.
Ensure that an appropriate role is assigned to each user.
If required, add user entries to the grid, or remove user entries from the grid.
Check the boxes next to the entries that you want to save to database. Click the box in the table header to select all entries.
Click Save. The Operation Progress window opens and displays the save to database progress. If necessary, you can stop the save process at any time by clicking Cancel. The Bulk Add Progress window closes and you return to the Bulk User Add screen. The screen displays error icons for any entries that were not saved to the database.
After the import is complete, the Operation Progress window closes.
Click the Users tab and check to ensure that all the entries are listed correctly.

Import from LDIF File

Note: You cannot import a MiVoice MX-ONE LDIF into MiCollab. Although the MiVoice MX-ONE manager (AM7450) supports LDIF export, the format of the LDIF file is not compatible with MiCollab.

To import data from a .LDIF file:

Export the user data from the directory server to a LDIF file and save the file in a directory on your client PC.
In the MiCollab server manager, under Applications click User and Services.
Click the Bulk User Provisioning tab.
Click Tools and then click Import from File. The Import from File window opens.
Select Import LDAP Data Interchange Format (LDIF) File.
Click Browse and navigate to the LDIF file.
Select the file and click Open.
Click Import. The data from the LDIF file is imported.
If the import is successful, the entries are listed in the Bulk User Provisioning Tool. Invalid entries are indicated with error icons. Correct any invalid entries.
Ensure that an appropriate role is assigned to each user. Note that you can use Auto-Fill to quickly complete the roles for a selection of users.
Check the boxes next to the entries that you want to save to database. Click the box in the table header to select all entries.
Click Save. The Operation Progress window opens and displays the save to database progress. If necessary, you can stop the save process at any time by clicking Cancel. The Bulk Add Progress window closes and you return to the Bulk User Add screen. The screen lists any entries that were not saved to the database.
After the import is complete, the Operation Progress window closes.
Click the Users tab and check to ensure that all the entries are listed correctly.

↑