# Enter Template Information

Note: Fields that are not supported for the MiVoice 5000, MiVoice MX-ONE or MiVoice Office 400 network elements are disabled (for example: Include Secondary Phone, Other Phone, and Group Type fields).

User Template

Field | Description | Values
Label | Enter reference name for this template (for Administrator use). This field is mandatory. | Between 1 and 64 characters. This field supports UTF-8 characters.
Description | Enter a description for this template |

User Information

Field | Description | Values
UCC Bundle | Select the UCC License bundle to apply to the users created with this template. Select <none> if you intend to use "a la carte" licensing. | Select one of the following: ****************************************** <none> ******************************************* UCC Entry User for Enterprise UCC Standard User for Enterprise ****************************************** Default is <none>.
Department | Select the department where this template will place users from the drop-down menu. Optional. | Default is <none>.
Location | Select the location where this template will place users from the drop-down menu. Optional. | Default is <none>.
Prompt Language | Select the language for the user's voice services (Telephone User Interfaces). The changes take affect immediately after you click Save. Active TUI sessions remain in the previous language until the next login session. Note: This setting changes all TUIs belonging to the user to the new language, with the exception of the Mitel Collaboration Advanced (MiCollab Audio, Web and Video Conferencing) application. This setting is not applied to the MiCollab Audio, Web and Video Conferencing TUI. The MiCollab Audio, Web and Video Conferencing TUI uses the System Default Language. | System Default. By default, the prompt language uses the System Default Language that is set from the server manager. To set the System Default Language, under Configuration, click MiCollab Language. Then, select the desired language from the Language drop-down box.
Password | Select one of the following options (mandatory): Same as Primary Phone Extension to set the user's password to the user's extension number. Randomly Generate to have the system generate a random password for the user. Note that the random password is masked for security. Use this value to set the default password to the value specified. | 4- 20 characters except "|" Manual passwords must contain at least four alphanumeric characters. If the Service Information E-mail feature is configured for the system, whenever you create or change a user's password, an e-mail is sent to the user with the password.
TUI Passcode | Select one of the following options to set the user's TUI passcode (including Hot Desk User Login PIN): Same as Primary Phone Extension to set the user's passcode to the user's extension number. Randomly Generate to have the system generate a random passcode for the user. Note that the random passcode is masked for security. Use this value to set the default passcode to the value specified. | 4 to 8 telephony digits (*, #, 0-9) Manual passcodes must contain at least four numeric digits.
IDS-Manageable | Specifies that all the IDS managed fields (for example, First Name, Last Name, Department, Location, Email, and Login) for this user are managed from an Integrated Directory Service (IDS) server. | This option is enabled by default. If an IDS server is integrated with MiCollab, updates to specific user fields in the directory service record are applied to the corresponding MiCollab record fields. Updates are applied during the next synchronization event. If you clear the check box, updates made on the directory server are not applied to the MiCollab user entry. If a directory server is not integrated with the MiCollab system, this option is still enabled by default but it has no effect on the MiCollab system database.

### Service Information

Click the check boxes next to the services that you want to include and complete the fields using the information from the following table:

Primary Phone

Field | Description | Values
Include Primary Phone | When the "Include Primary Phone" service check box is not selected, the following conditions apply: You must specify a password and passcode in the "Use this value" field of the User Information section The following options are not available: Secondary phone Other phone Group Speech Auto Attendant | Default is unchecked.
Service Label. | Enter a name of up to 64 characters that identifies the service (for example, Desk Phone). The same label can be used for more than one service associated with the same user. | Up to 64 characters.
Network Element | Select an ICP from the Network Element list | Select the name of a MiVoice Business, MiVoice 5000, MiVoice MX-ONE, or MiVoice Office 400 element from the list. OR Select <blank> if the Network Element is a MiVoice Office 250. Note: This selection is not available if an ICP host has already been added as a Network Element.)
Secondary Element | For resiliency, select the phone's Secondary Element from the list. If the phone's primary Network Element goes out of service, the phone is supported by the specified Secondary Element. | The selected element must be different than the Network Element above.
Use DID Service Number as Outgoing DID Number | Check this box to display the DID number for outgoing calls made from the user's phone. The MiVoice Business CPN Substitution feature allows you to program a substitute number for outgoing calls made on a DID trunk. The substitute number is presented to the network for outgoing calls on the DID trunk. | Unchecked
CESID | Enter the Caller Emergency Service Identification (CESID) to be sent to the Public Safety Answering Point (PSAP) in the event of an emergency call. Up to 12 digits can be programmed. Note: Although a CESID can be programmed for any mobile DN, the system will only use it for External Hot Desk Users (EHDUs) that are logged on to private trunks. For regular hot desk users and EHDUs logged on to MiNET devices, the system will use the CESID associated with the set's registration DN. | Between 1 and 12 digits in length. Can contain digits 0 to 9. Default is blank.
Hot Desking User | Check to create a Hot Desking user; clear to create a standard user and device. Notes: Hot Desking User type requires COS entries. When you assign a newly created user as a Hot Desking User, the ACD Agent field is disabled. If required, select the ACD Agent field to create an ACD Agent with hot desking capability. After a user has been assigned with the ACD Agent option, you cannot change this option using Edit. You must delete the phone and then add it again to change the ACD Agent option. | Not selected.
ACD Agent | Check to designate a hot desking user as a Hot Desk ACD Agent. Notes: To enable this option, you must first select the Hot Desking User box. After a user has been assigned with the ACD Agent option, you cannot change this option using Edit. You must delete the phone and then add it again to change the ACD Agent option. | Not selected.
Enable SIP Softphone for MiCollab for PC Client | Check box to enable SIP Softphone functionality for a hot desking user. When you enable this functionality, MiCollab Client Service assigns the phone type as SOFTPHONE and Device Type as 76. The Enable SIP Softphone for MiCollab for PC Client setting is supported for MiCollab for PC Client only. Note: You can apply Teleworker service to a Hot Desking user with SIP Softphone enabled. | Not selected.
External Hot Desk License | Check box to enable External Hot Desk User (EHDU) functionality. The Device Type field must be set to Hot Desk User. External Hot Desk Users must be licensed. Licenses are programmed in the License and Option Selection form of the MiVoice Business. Note: You cannot apply the Teleworker service to an EDHU.
Hot Desk User External Dialing Prefix | Enter "9" or other prefix digit(s) required to dial out to the external hot desk device. | 1 to 26 telephony digits, 0 to 9, * or #.
Preferred Set | For a hot desking user, select the user's preferred hot desking device type from the drop down list. This field only appears if the Hot Desk User option is enabled below. If No Device is selected as the Preferred Device, the device is assigned 96 keys by default. | No Device

Device Type | Select a device from the Device Type list. | The following rule applies: You cannot edit device type for Generic SIP Device types that have Teleworker services assigned. This field is not available if "Hot Desking User" is checked. Enter a device type of "UC Endpoint" for MiCollab Client clients. The following MiVoice Business Device Types are not supported: Analog, Analog-FXS, 5001 IP, 5201 IP, 5401 IP, NetVision IP, Spectralink NetLink, and Superset Devices. This field does not apply to the MiVoice Office 250.
Include Teleworker Service | Click to add Teleworker service to this user template. | The following conditions apply: Default is unchecked. This field does not apply to the MiVoice Office 250. Teleworker service can be added to multiple devices for a user. When you include Teleworker service for a user's SIP phone, the system automatically configures a corresponding SIP service on the MiVoice Border Gateway. Note the following: The system sets the Set-side username on the MiVoice Border Gateway to <username-DN> (for example smithj-7328). This username format applies to MiVoice Business communication platforms only. The password field in the User Information section of the template must be set to a strong password or "Randomly Generate".
SIP Device Capabilities | When Generic SIP Device type is selected, this field defaults to 1. When UC Endpoint is selected (for a MiCollab Client Deskphone or Softphone) this field defaults to 71. | Change the Default SIP Device Capabilities number as required.
SIP Password | Enter a SIP device password for the user. When you create or change a user's SIP password, the system automatically sends a Service Info Email with the password to the user. Note: The display on 5505 SIP and 5302 IP sets is limited to eight digits. For these sets, assign a numeric password of eight digits or less. | Up to 26 ASCII characters including numeric, alphanumeric, and special characters. Default is blank. This field is only enabled for SIP devices. SIP device passwords are optional. If this field is left blank, a password is not required to register a SIP device with the MiVoice Business.
Confirm SIP Password | Re-enter the passcode to confirm.
Service Level | Displays the level of service for this directory number (DN): Full - A DN with this service level is assigned to a standard user and device with full telephony service. Multi-Device - A DN with this service level is assigned to a user that has only basic telephony functionality (emergency or attendant calls) until programmed as a member of a Multi-device User Group. Multi-Device User Groups (MDUGs) allow a single user to have multiple phones grouped under a common directory number without each phone requiring a full MiVoice Business IP License. There are two types of Multi-Device User Groups: Standard: allows up to eight phones to be grouped under a common directory number. Only the prime number requires an IP User License. The group itself, requires a MDUG license. In a MDUG, phone functionality is essentially limited to one device in the group at any given time. When one of the user's phones is engaged in call, the other phones are consider busy (in other words, "One Busy All Busy" is always enabled) and have restricted functionality. External Twin: allows only two phones, typically a desk phone and a cell phone, to be twinned. This type of group does not require a MDUG license. It only requires an IP User License and an External Hot Desk User license. The prime number uses the IP User license. The second member must be an External Hot Desk number and consumes the EHDU license. | Full Service
Zone ID | Enter a number to identify the Network Zone. The MiVoice Business platform uses Network Zones for compression and bandwidth management to associate the zones to time zones for the display of local time on IP sets to configure the zone's Location Based Number (LBN) prefix for Location Base Call Routing (optional), and to define the zone's CESID (optional). | Number from 1 to 999. Default is blank. If this field is left blank, the MiVoice Business defaults this setting to Zone 1.
Call Coverage Service Number | Assign the Call Coverage Service Number Call for the MiVoice Business Hot Desk PIN Security feature. The MiVoice Business Hot Desk PIN Security feature ensures that all hot desk users create strong (resistant to guessing) PINs by forcing them to create PINs that adhere to a set of strengthening rules. Hot Desk PIN Security is programmed in the Call Coverage Services form of the MiVoice Business System Administration Tool. This form allows you to assign a Call Coverage Service number that uniquely identifies the type of Call Coverage Service. The number that you enter in this field must exist in the Call Coverage Service form on the MiVoice Business system. If Flow Through Provisioning is enabled, the phone's Call Coverage number is automatically updated on the MiVoice Business system. Note: This field only applies to MiVoice Business Release 6.0 or later systems. | This field only applies to Mitel IP phones. If you create a new phone, this field defaults to 1. If you upgrade an existing MiCollab system to MiCollab Release 4.0 SP2 or later, this field also defaults to 1.
Deployment Profile | Select a profile for MiCollab for Mobile Client softphone or EHDU deployment: default: Default profile Do Not Deploy: The client will not be deployed. Status: :"Un-deployed" indicates that the client is not deployed. "Deployed" indicates that the configuration has been sent to the client but has not yet been downloaded. "Downloaded" indicates that the configuration has been downloaded and installed for the client. Note: This field only appears if MiCollab Client is integrated mode. | This field applies only if the Preferred Set is UC Endpoint, or if Enable SIP Softphone or EHDU is selected, and the MiCollab Client Deployment application is installed. For "UC Endpoint" devices: Default profile is selected by default. If you upgrade the MiCollab Client for Mobile application, the default profile is applied to all eligible phones. If you are upgrading and you do not wish to use the MiCollab Client for Mobile application, change this setting from default to Do Not Deploy. For EHDUs: For External Hot Desk Users, the default profile is set in the MiCollab Settings page. For SIP Softphones; Default profile is selected by default If you do not wish to use the MiCollab Client for Mobile application, change this setting from default to Do Not Deploy. Note: If there is no phone for which a deployment profile is selected, users need to provide their password every time they log in to PC and Mobile Clients. Note:If a phone with a deployment profile is added later, the user must provide their password for every login to PC and Mobile Clients. However, if the administrator or the user changes the password after the user logs in, the updated password is automatically used for the next login to PC and Mobile Clients.
Send Deployment Email | If this option is checked, a deployment email is sent to the user when you deploy a MiCollab for Mobile Client softphone from the Users and Services directory page; if unchecked, it is not sent. The deployment email provides users with a QR code. After scanning the QR code with their mobile phone, the user is authenticated, and the MiCollab for Mobile Client application is downloaded from the App Store to the user's phone. If you are only deploying a softphone to a user's web client (WebRTC client), then it is not necessary to send a deployment email. | This option is only available if the device type is set to "UC Endpoint". Default is checked (send deployment email).
Class of Service - Day | Enter a COS number for Day mode. | Number from 1 to 110. Defaults are blank. If you are integrating MiCollab with a MiVoice Business system enter COS 13 for users without the Record-a-Call feature; enter COS 14 for users with the Record-a-Call feature.
Class of Service - Night 1 | Enter a COS number for Night 1 mode. |
Class of Service - Night 2 | Enter a COS number for Night 2 mode. |
Class of Restriction - Day | Enter a COR number for Day modee. |
Class of Restriction - Night 1 | Enter a COR number for Night 1 mode of service. |
Class of Restriction - Night 2 | Enter a COR number for Night 2 mode of service. |

Secondary Phone (Optional)

Field | Description | Values
Include Secondary Phone | Click to set up a secondary phone for this user template. This option is only available if the Include Prime Phone box is checked. | Default is unchecked. Can be set to the same values available for Primary Phone.
Derive DN | Check this box if you want to derive the phone number from the primary phone directory number. It's recommended that you assign users with a prime phone and then derive the directory number of any additional phones from the prime phone directory number. | The system derives the directory number of this phone by inserting an * between the 1st and 2nd digits of the primary directory number. For example, if the Primary Phone DN is 2000, then the derived DN would be 2*000.
All other fields | See Primary Phone descriptions. Note: Network Element for the Secondary Phone automatically defaults to the Network Element of the Primary Phone. | See Primary Phone defaults.

Other Phone (Optional)

Field | Description | Values
Include Other Phone | Click to set up another phone for this user template. This option is only available if the Secondary Prime Phone box is checked. | Default is unchecked. Can be set to the same values available for Primary Phone.
Derive DN | Check this box if you want to derive the Other Phone directory number from the primary phone directory number. It's recommended that you assign users with a prime phone and then derive the directory number of any additional phones from the prime phone directory number. | The system derives the directory number of this phone by inserting an * between the 2nd and 3rd digits of the primary directory number. For example, if the Primary Phone DN is 2000, then the derived DN would be 20*00.
All other fields | See Primary Phone descriptions. Note: Network Element for the Secondary Phone automatically defaults to the Network Element of the Primary Phone. | See Primary Phone defaults.

Group (Optional)

Field | Description | Values
Include Group | Select check box to create a group with this user template. | Default is unchecked
Group Type | Personal Ring Group (PRG): Allows two or more phones for a single user to be grouped under a common directory number. The devices ring simultaneously (Ring All) when called. The typical scenario is a person's desktop phone and cell phone are twinned together, where the desk phone is considered the prime extension. Both devices require a full MiVoice Business IP User Licence. Multi-Device - Standard: Allows up to eight devices (phones) to be grouped under a common directory number. The devices in this group are licensed collectively to a user with a single Multi-device Users license. Multi-Device - External Twin: Allows only two devices, typically a desk phone and a cell phone, to be twinned. This type of group requires an IP User License and an External Hot Desk User license. The prime number uses the IP User license; the second number uses the External Hot Desk User license. | Default is Multi-Device - External Twin
Prime | Identifies the pilot phone for the group. The devices are group together under the primary phone directory number. This field is read-only. | Primary Phone.
Members | Check the boxes to include the Secondary Phone, Other Phone, or both, as members in the group. | By default, both Secondary and Other Phone are selected as group members.

Speech Auto Attendant (Optional)

Field | Description | Values
Include Speech Auto-Attendant | Select check box to create a registered Speech Auto Attendant user for this template. | Default is unchecked. This check box is disabled if Speech Auto Attendant is not installed. This check box is not applicable to MiVoice 5000 and MiVoice MX-ONE elements.
Contact Phone | Select the number that you want to use as your Speech Auto Attendant (SAA) contact number. Select "None" to unassign your current SAA number. | List of phones currently owned by the user. Note: User must have at least one phone service before entries in these SAA fields are enabled.
Private User | Select this option to exclude your phone from SAA recognition. (This means you cannot be reached by having a caller speak your name to the auto attendant.) Note: User is still recognized as a registered SAA user. | You can only select this option after a phone has been selected from the Contact Phone list.

MiCollab Client (Optional)

Field | Description | Values
Feature Profile | Assign a Feature Profile. Feature profiles define the licensed MiCollab Client features that are assigned to a user. | Default is Feature Profile 1.
Desk phone extension | Assigns MiCollab Client desk phone service to the specified phone. | None: Do not assign service. Primary:Assign to Primary phone's DN. Secondary: Assign to Secondary phone's DN.
Soft phone extension | Assigns MiCollab Client softphone service to the specified phone. | None: Do not assign service. Other: Assign to Other phone's DN.
Deployment profile | This field allows you to select the deployment profile that should be applied when you deploy a MiCollab MAC or PC Client without a softphone to a user. After you click Save, a deployment e-mail is sent automatically to the user. The extension field in the e-mail is set to "None". The user clicks the link in the e-mail to complete the deployment. | Default is "Do Not Deploy". Typically, you would select the Default profile. Note: If there is no phone for which a deployment profile is selected, users need to provide their password every time they log in to PC and Mobile Clients. Note:If a phone with a deployment profile is added later, the user must provide their password for every login to PC and Mobile Clients. However, if the administrator or the user changes the password after the user logs in, the updated password is automatically used for the next login to PC and Mobile Clients.
MiTeam Meetings | Allows you to disable or re-enable MiTeam Meetings for the user. This box applies to all UCC license bundles (except Basic bundle) and users on-boarded to CloudLink. When you clear this box, the cross launch functionality from MiCollab Client to MiTeam Meetings application is disabled. When you check this box, the users can click on Meetings option in the Client to open the MiTeam Meetings application. | By default, this box is unchecked.
MiTeam Classic | Allows you to disable or re-enable MiTeam Classic for the user. This box only applies to UCC Standard users with an active MiTeam Classic license. When you clear this box, the MiTeam tab is removed from the user's client. When you check this box, the MiTeam tab is added to the user's client. | By default, this box is unchecked.

EMEM Voicemail Service (Optional)

Field | Description | Values
Include EMEM Voicemail Service | Click to add EMEM voice mail service to this user template. Note: It is applicable only for docker deployments. | Default is unchecked.

NuPoint Unified Messaging Voicemail (Optional)

Field | Description | Values
Include NuPoint Unified Messaging Voicemail | Click to add a voice mail box to this user template. This field is disabled if the template provides an MiCollab Advanced Messaging (AVST) mailbox. | Default is unchecked.
Associate With Phone | Select the phone service with which to associate the voice mailbox. | None: Do not assign mailbox. Primary:Extension field is set to Primary phone's DN. Secondary: Extension field is set to Secondary phone's DN. (Only available when Secondary Phone service is selected.)
Use Extension Number for Mailbox | Click to use the extension number of the selected phone as the mailbox number. | Default is unchecked. If this check box is left unchecked, a Mailbox Number field is included in the manual entry section of the Quick Add form.
Attendant Extension | This is the number that is called if user dials 0 to return to the attendant. If an attendant extension is defined, it is assigned to ALL mailboxes being created. Optional. | Enter a valid extension number for the attendant. Default is blank. 0-11 telephony digits (*, #, 0-9).
Feature COS | Select a value from the FCOS values available. | Default is 14.
Limits COS | Select a value from the LCOS values available. | Default is 1.
Message Waiting #1 | Select a value from the options available. | Default is None. Note: To enable the MWI feature for MiVoice Business phones, you must have MiTAI Integration enabled for the associated phones. Note: To enable the MWI feature for MiVoice Business and MiVoice MX-ONE phones, you must use the "DTMF to PBX" setting.
Message Waiting #2
Use 3300 Record-A-Call | Select to enable Record-A-Call feature. | Default is unchecked.
Standard Unified Messaging | Select the check box to enable Standard Unified Messaging for the user's mailbox. Standard UM provides voice mail and FAX access to Lotus Notes, Novell GroupWise and Microsoft Outlook e-mail clients, or from the Web View in the user's e-mail client or Web browser. Users can also access voice, FAX, and Record-A-Call messages from the telephone user interface (TUI). When a voice mail message is left in a Standard Unified Messaging mailbox, the system sends messages to the UM SMTP Email Addresses that are defined for the user's mailbox. You can define these email addresses in the user's mailbox through the NuPoint Web Console, or the user can define them through their MiCollab End User Portal. Refer to the Unified Messaging book in the NuPoint Web Console online help for details. | Default is unchecked. Note: The following configuration conditions apply: The Feature COS assigned to the mailbox must have the Standard UM feature enabled. A Standard UM mailbox license must be available for each mailbox that you configure with Standard UM.
Advanced Unified Messaging | Select the check box to enable Advanced Unified Messaging for the user's mailbox. Note: For MiCollab Release 5.0 and later systems, you must enable the Advanced UM option using the check box in the NuPoint Unified Messaging tab of the USP application. You cannot enable the Advanced UM option through the NP-UM web console. Advanced Unified Messaging offers a high level of messaging integration and synchronization between a user's e-mail client and NuPoint UM voice mailbox. Full MWI synchronization is provided for voice messages that are accessed through the e-mail client. Message status synchronization is provided for e-mails that are listened to from the NuPoint voice mailbox (they are marked as "read" in the e-mail inbox). Advanced UM users can access their voice, fax, RAC, and email messages (from their Microsoft Outlook inbox or Lotus Notes 7 inbox, and from the NuPoint Voice mailbox) over the phone. Access to email via the Telephone User Interface (TUI) is enabled by integration with the email client, the email server, and text-to-speech (TTS) technology. Refer to the Unified Messaging book in the NuPoint Web Console online help for additional details. | Default is unchecked. Note: The following configuration conditions apply: The NP-UM Feature COS assigned to the mailbox must have the Advanced UM feature enabled. An Advanced UM license is required for each mailbox that requires Advanced Unified Messaging. If a UCC license bundle is assigned to the mailbox user, this option is enabled by default and read-only. If you clear the check box, Advanced UM is disabled for the user and the license is removed. Also, the Advanced UM e-mail addresses are cleared from the Mailbox page in the user's MiCollab End User Portal.

Audio, Web and Conferencing (Optional)

Field | Description | Values
Include Audio, Web and Video Conferencing | Click to create a registered MiCollab Audio, Web and Video Conferencing user for this template. Note: Email address entry is mandatory when this template is applied. | Default is unchecked.
Registered Phone | Select the phone service (Primary, Secondary, or Other phone) with which to associate MiCollab Audio, Web and Video Conferencing. | Default is Primary. Note: If "Include Phone Service" is not enabled for a Secondary Phone or Other Phone, these options are not available.
Use Extension Number for Registered Phone | Click to use the extension number of the selected phone as the registered phone. OR Clear this box to allow entry of a number during the "Quick Add" process. | Default is unchecked.

Vidyo Field Descriptions (Optional)

Field | Description | Default
Include Vidyo Service | Check the box to enable the service. Clear the box to disable. | Disabled
Room Type | Normal: Assign this setting to regular users. It allows a user to host personal Vidyo meetings from a desktop device or mobile device. VidyoMobile and VidyoDesktop users can also host meetings or join with other Vidyo users and room systems. | Default is Normal
Vidyo Room: Assign this setting to meeting rooms. Meeting rooms must be equipped with a Vidyo supported device. Note: Vidyo supports their own room systems and devices. The MiVoice Video Phone can connect to a Vidyo conference via the Vidyo Gateway product (which supports connecting SIP enabled video devices to Vidyo's proprietary video codec environment). The MiVoice Video Phone user must dial into the Vidyo conference using the "Dial by URI" feature.
Executive: Assign this setting to priority users. It allows them to connect from any VidyoMobile or VidyoDesktop enabled device without a concurrent use license.
Panoramic: Assign this setting to meeting rooms that are equipped with multiple screens (up to nine high-resloution screens are supported).