# About the Bulk User Provisioning Tool

The Bulk User Provisioning tool allows you to perform the following tasks:

- add user entries to the database

- bulk import user data from a . csv or LDIF file

- program a range of fields using Auto Fill Selection prior to saving imported entries to the database

- manage detained and failed IDS updates.

Note: For MiCollab with MiVoice MX-ONE or MiVoice Office 400 integrations, you only use the Bulk User Provisioning Tool to import a .CSV file of users into MiCollab from the communications platform during initial provisioning and to synchronize MiCollab Client contacts with a directory server. Contacts that fail to be imported during a directory server synchronization are listed in the Manage Detained Queue. You do not use the Bulk User Provisioning Tool for MiCollab with MiVoice 5000.integrations.

You can perform user data operations such as adds or edits in the Bulk Provisioning tool grid and then save the operations to the Users and Services database. The Bulk User Provisioning Tool has three modes:

- Bulk User Add: This mode allows you to add records into the grid of the tool. You can then save the newly added records to the User and Services database.

- Bulk User Edit: This mode allows you to edit the users' passwords in bulk. You can select user names from the .CSV file and change the password by clicking the Reset Password button.

- Manage Detained Queue: This mode allows you to manage detained and failed Integrated Directory Service (IDS) operations. Detained IDS operations are operations that have been performed on the directory server that have not been applied to the USP database yet. Failed IDS operations are directory server updates that the MiCollab system could not apply to the USP database due to errors.

Note:

The administrator can create the contacts as basic users from Bulk User Provisioning tab.

The total number of records in the Bulk Provisioning tool is displayed in the lower-left corner of the grid.

## Bulk User Provisioning Tool - Element Descriptions

Element | Description | Notes
--- | --- | ---
Mode | Selects the Bulk Provisioning tool mode of operation. | The bulk user tool has three modes of operation: Bulk User Add Bulk User Edit Manage Detained Queue
Add | Adds a new blank user record in to the grid. | You can add new records in all four operational modes.
Delete | Deletes selected user records from the grid. | Check the box next to a record to select it.
Save | Performs the operations that are specified in the grid for each record. | Add, Update, and Delete operations are applied to the Users and Services database upon Save.
Reset Password | Resets the passwords of selected users. | Select the user names from the imported .CSV file and click the Reset Password button. When prompted, click OK to confirm your selection. Bulk User Provisioning for resetting the selected users' password takes effect. Each user receives a welcome email which will contain a new temporary password. Users must log in to the End User portal using the temporary password and specify a new password. Note: The Reset Password option will not work for MiCollab installations that have the welcome email disabled. In this case you must re-enable the welcome email.
Tools | Download Example CSV File | Download an example CSV file that you can use to create an import file of data entries.
Import from File | Import entries from a CSV or LDIF file into the Bulk User Provisioning tool
Empty Detained Queue | Remove all entries from the Detained Queue quickly.
Reload Detained Queue | Refresh the data entries in the grid from the Detained Queue.
Reload Grid from Cache | Refresh the data entries in the grid from the server cache
| Click to expand the row and display the current user and service details for this record. If there are any errors associated with the record, a detailed summary of the error is provided. | Prior to performing an Add or Delete operation, use this function to identify the detailed changes that will be made to the database.
| Check the box to select a record. | To select all records, check the box in the table header.
| Click and to sort column data. | You can sort column data in ascending or descending order. You can also configure custom sorting criteria.
OP | This column indicates the operation for each entry, for example: A (Add), U (Update), and D (Delete). The operations are applied when you click Save. | Hover your cursor over the letter to display the operation. Add, update, and delete operations are applied to the User and Services database on Save.
Timestamp (Managed Detained Mode only) | Shows the date and time of when the entry entered the detained queue. |
First Name | Enter user's first name. | Enter a first name up to 256 alphanumeric characters in length (for example, "Bob"). This field is optional and can be left blank.
Last Name | Enter user's last name. For example: "Smith". | Enter a last name up to 256 alphanumeric characters in length (for example, "Smith"). This field is mandatory.
Domain | The Domain Name is read-only and is either read from a directory server or set to the local domain | You can only manage non-local domains from the directory service or by performing an LDIF file import. The domain field is set in the LDIF file and should not be changed. In all other cases, the domain field is set to the local domain.
Login ID | Enter a login ID for the user. | For example, "smithb".
Email Address | Enter a unique primary email address for the user. For example: "smithb@mitel.com" | Use the format " name@place.suffix", where name is 2 to 40 characters in length place is 2 to 40 characters in length suffix is from 2 to 6 characters in length address does not contain special characters.
Role | Select the desired role for this user. | When you save the user, the template associated with the role is applied to the entry.
Prime Phone | Enter the directory number of the user's prime phone. |
Secondary Phone | Enter the directory number of the user's secondary phone. |
External Number | Enter the number of the user's external phone. |
Direct Inward Dial Number | Enter the dialing prefix and external number of the designated DID trunk. | Direct Inward Dialing (DID) routes incoming calls on a designated trunk to the user's phone.
SIP Password | Enter the SIP password which is passed to MBG to authenticate the SIP user. |
| Indicates an error in a data field | Hover your cursor over the error icon for information.
| Indicates that the data entry failed to import into the database. | Click the icon for a detailed report.

Note: In MX-ONE integration, the secondary phone is an attribute of the primary phone. The secondary phone can be set or not set from MX-ONE provisioning manager.
Note: To use the Teleworker services in MiVoice Office 400 or MiVoice MX-ONE, SIP Username field must be added manually in the example csv file.

## Customizing the Column Data

You can customize the way data entries are displayed in the Bulk User Provisioning tool. By right-clicking in the column header and selecting the desired menu item, you can

- sort a column of text entries alphabetically in either ascending or descending order

- sort a column of numbers in either ascending or descending order

- configure a custom sort based on column headings

- group entries according to the data in a column heading

You can also

- move a column by clicking the header and dragging it to a new position

- adjust a column width by selecting the right border of the column header with your cursor and dragging it to the left or right.

Note: After you reload the data or switch to a new tab, the sort order reverts to the default. The default sort order is as follows:

- Error icon (ascending order based on description)

- Last Name (ascending order)

- First Name (ascending order).

Parent topic: Provisioning Methods
Parent topic: Bulk User Provisioning