Configure Your Mitel Phones

Refer to the PBX Compatibility Matrix for the most recent information.

These legacy phones are compatible with Revolution.

1. For each Mitel 69xx phone model in your environment, create a text file using the following information:

   1. File name — AppInfo-<phonemodel>.cfg

      For example: AppInfo-6920.cfg or AppInfo-6940.cfg

   2. Content — add the following line to the file:

      xml application post list:<revolution_server_IP>[,<secondary_revolution_server_IP>]

      Where you replace the server IP values to reference your Revolution environment, and the secondary entry is optional.

      For example:

      xml application post list:192.168.25.01,192.168.25.02

   3. Repeat for the next phone model.

2. Within the Mitel MiVoice Business Administration tool, go to Phone Applications Update and upload the CFG files you created.

   Note: You can only upload a single file to one server at a time. If you attempt to upload multiple files at a time or the same file to two servers at the same time, you should receive a certificate error.

3. After completing this configuration, the Mitel phones will appear in the Endpoints viewer of Revolution.

If you've set up a SIP endpoint, Revolution will call the phone number set up in the notification.

Here's how this works:

• Add MiVB Page Groups and SIP phones as Revolution SIP endpoints, so that you can dial them. See SIP endpoints for instructions.
• When a Page Group SIP endpoint is assigned to a notification, all devices included in the Page Group receive the notification.
• Two-way notification types (intercom) from phone to phone, requires each SIP phone (caller and receiver) to be entered as an individual SIP endpoint, not as part of a Page Group.

Sending notification audio to MiVoice Business paging groups

This allows you to send audio that will start playing on the phones in the paging group.

1. In MiVoice Business,

   • Define a direct page primary code, such as **3.

   • Create a page group by assigning it a value, such as 1001, and assigning phones to the group.

   You will reference these values when creating a SIP endpoint in Revolution. See your MiVB documentation for more detailed instructions.

2. In Revolution, create a SIP endpoint for the MiVB page group.

   Go to Configuration > Phone Systems > SIP and select New SIP Endpoint.

   Set up the endpoint as you desire, but for SIP URI, enter a string similar to the following:

   sip:**31001@192.0.2.0;transport=TCP

   where **31001 is what you defined in the first two steps and 192.0.2.0 is the IP address of your MiVB trunk switch.

   See SIP Notifier for more information.

3. In Revolution, create a notification and select the MiVB Page Group SIP endpoint you created.

MiVB Communications Manager

1. Go to Configuration > Phone Systems > Mitel
2. Select New > New MiVB Communications Manager
3. For Name, enter a value that will help you identify this call manager.

4. For Server, enter the IP address or host name for the MiVoice Business server.

   Note: If you have redundant MiVoice Business systems, you must add all servers in a comma-separated list.

5. For Username and Password, enter the credentials for the MiVoice Business Server.

To ensure that your 69xx phones receive audio in addition to text and images from your notification, you must follow these procedures for setting up MiVoice Business, Revolution static streams, and Revolution notifications.

MiVoice Business System Administration Tool

Within this tool, you will configure Mass Audio Notification to enable audio content from Revolution on your 69xx phones.

This tool is available with Mitel MiVoice Business versions 9.1 and newer.

1. Go to Voice Network > Mass Audio Notification.

2. For Multicast Address and Multicast Port, enter the IP Address and port number for multicast broadcast.

   Note: You will use these values to set up a static stream notifier.

3. Select Save.

Revolution Static Stream Notifier

Within Revolution, you will create a Static Stream Notifier to send the audio content to the 69xx phones.

1. Go to Configuration > Static Stream

2. Select New Static Stream.

3. For Name, enter a string to make the stream notifier easily recognizable.

4. For IP Address and Port, enter the values you used when setting up Mass Audio Notification in the MiVoice Business System Administration tool.

5. Select Save.

Revolution Notification

When sending notifications to Mitel 69xx phones, set up your endpoints as follows:

• To send just text and images, assign the registered Mitel phones as endpoints.

• To send text, images, and audio, you must assign the Mitel phones and your static stream as endpoints. It is easiest to create user tags that contain the desired Mitel 69xx phones and static streams. Users then assign the appropriate user tag(s) to notifications as endpoints. (See User-created tags.)

6900 series phone configuration file must be created as follows.

1. Use a standard text editor to create the file on the Mitel MiVoice Connect server if possible or create it elsewhere and move it to the server.

xml application post list: <server ip>


where <server ip> is the actual IP address of your Revolution server

2. Save the text file as startup.txt.
3. Change the file extension from .txt to .cfg.
4. Move startup.cfg to C:\Inetpub\ftproot\phoneconfig on the Mitel MiVoice Connect.
5. Reboot the 6900 series phones so they will pull down the startup.cfg file.

400 series phone custom files are located in C:\Inetpub\ftproot\phoneconfig.

Non-400 series phones custom files are located in C:\Inetpub\ftproot.

For each phone model, you need to add the Revolution server IP address as a trusted server.

• For 400 series phones, add a new line using the following format, specifying your Revolution server IP address:

  [papi]
  trustedServers = 123.123.12.123

  Note the uppercase "S" in trustedServers and the use of the equal sign (=).

• For non-400 series phones, add a new line using the following format, specifying your Revolution server IP address:

  Trusted Servers 123.123.12.123

  Note the multi-word, initial-cap form of Trusted Servers and the lack of an equal sign (=).

In both of the above cases, for multiple trusted servers (redundancy/failover) use this format for specifying your IP addresses

"123.123.12.123,456.456.45.456"

Note that the addresses comma-separated, with no space, and are enclosed double-quotation marks (").

For MiVoice Connect

1. Select the wrench icon > Users > Users.
2. Select a user name.
3. Select the Telephony tab.
4. Select Enable phone API (PAPI).
5. Select Save.

For ShoreTel Director

1. Select Administration > Users > Individual Users.
2. Select a user name.
3. Select Allow Phone API.
4. Select Save.

Connect Communications Manager

1. Go to Configuration > Phone Systems > Mitel
2. Click New > New Connect Communications Manager.
3. For Name, enter a value that will help you identify this call manager.
4. For Server, enter the address, or Fully Qualified Domain Name, for the Mitel server.
5. For Advanced Settings, you should only alter the default values if you are not using the default Mitel server port (4308) or username/password credentials (st_configread/passwordconfigread).
6. Select Save.

You'll need to update these files – startup.cfg, <model>.cfg, and <mac>.cfg – to configure XML push requests so your IP phones can receive text, images, and audio. Consult your Mitel documentation.

Example Syn Apps XML Push Notifications:

xml application post list: 10.0.10.10
action uri startup: http://10.0.10.10/MitelRegistrar/?dn=$$SIPUSERNAME$$&ip=$$LOCALIP$$
action uri registered: http://10.0.10.10/MitelRegistrar/?dn=$$SIPUSERNAME$$&ip=$$LOCALIP$$

Follow the instructions below to configure your SIP phones.

Configure each phone with the Revolution IP address so the phone can register as an endpoint.

Tip: You may be able to make these changes in your PBX communications manager. Consult your vendor documentation. If not use these instructions.

1. Log into the phone's web interface.
2. On the Configuration Server page, enter the Revolution server IP address in the XML Push Server List (Approved IP Addresses) field.
3. On the Action URI Configuration page, enter the following in the Poll field and set the Interval between 60 and 300 seconds depending on how frequently you want the phones to register.

http://<rev_ip>/MitelRegistrar/?dn=$$SIPUSERNAME$$&ip=$$LOCALIP$$

Tips:
• Make sure the interval is shorter than the Revolution Endpoint Inactive Timeout set in Global Settings.
• If you have hundreds (or thousands) of phones, a longer interval is better (15 minutes).
4. Save your changes.
5. Reboot your phones.

MiVoice Business page groups and SIP lines display on the Endpoints page as soon as they're added as Revolution SIP endpoints.

MiVoice Connect, Mitel Clearspan, and ShoreTel Director phones display on the Endpoints page with the next system refresh and can then be assigned to notifications. To update the Endpoints page immediately, go to Status > System Status > Mitel Module and select Refresh Data.

You can configure your Mitel PBX system to monitor when an emergency number is dialed. These numbers then display as triggers on the Mitel module page and can be assigned to notifications to trigger an alert when the number is dialed. For example, you can monitor 9-1-1. When it's dialed from a phone on the network, an emergency alert notification is sent to security and reception to notify them that an incident has occurred. See the Dial Monitoring topic for details.

1. Go to Configuration > Phone Systems > Mitel
2. Select Settings and update the following as needed.

   • Cache Update Interval – Determines how frequently Revolution pulls in new data from MiVoice Business, MiVoice Connect, or ShoreTel Director.

     The value entered here must be less than the value configured in Global Settings > Endpoints > Endpoints Inactive Timeout Minutes.

If you're using Revolution SIP Activator to trigger notifications, you'll need to first configure a SIP trunk in your Mitel communications manager. See the Mitel MiVoice Connect SIP Trunk Setup topic (also for ShoreTel Director customers) or the Mitel MiVoice Business SIP Trunk Setup topic.

Important: SIP Activator is required in order to trigger live broadcast/paging notifications.

Mitel IP phones support extension reassignment, sometimes referred to as extension mobility, where a user can reassign their extension to a new phone.

Revolution detects this change on the next refresh of the Mitel information. You can force a refresh using the following steps:

1. Go to Status > System Status > Mitel Module.
2. Select Refresh Data.

The following screen captures show how the Mitel endpoints change after Thomas Anderson reassigns his extension to a new phone.

Note: The Mitel 53xx devices do not support real-time paging. Paging occurs at the polling interval, which you configure in the SPX file; this typically defaults to 15 seconds.

Follow this procedure to set up your Mitel 53xx devices to work with Revolution. Refer to Legacy Phones for a list of supported 53xx devices and their limitations.

Note: This procedure requires the Mitel App Packager, which is part of the Mitel HTML Toolkit. The procedure is written based on the MiVoice Business PBX.

1. Download the application source files from the server where Revolution is installed.
   C:\Program Files (x86)\Syn-Apps\ShoreTelNotifier\Mitel53xx\PhoneApps.zip

   1. Unzip the archive file.

   2. Run the PowerShell script update_app_host.ps1.

   3. At the prompt, enter the IP address of your Revolution server.

   This script updates the various files to include your IP address in preparation for the next steps.

2. Run the Mitel HTML App Packager.

   1. For each model group, use Browse for Directory to select the directory containing the files you edited.

   2. Select Generate to produce a SPX file (spx.package) in the same directory.

3. From MiVoice Business System Administration Tool:

   1. Go to User and Devices > Advanced Configuration > Phone Applications Update.

      1. Select Upload App.

      2. Select Choose File and navigate to the SPX file you generated.

      3. Repeat for each model group.

   2. Go to User and Devices > User and Services Configuration.

      1. Locate and select a device you want to update from the list.

      2. Select the Phone Applications tab.

      3. For HTML Infrastructure Enabled, select Yes.

      4. For Notification Application1, select your package.

      5. Select Save Changes. Your device will now be able to poll the Revolution server to receive notifications.

      6. Repeat for any other devices.

      Note: From this User and Services Configuration page, you could do a bulk update of your devices. First, Export a CSV of the data. Second, manually change the entries for your devices as follows: Set the HTML Infrastructure License column to Yes and the Notification Application1 column to the name of your SPX package. Third, Import the CSV you just edited. See your Mitel documentation for additional information about this process.