Adding or modifying a profile

To manually add a Deployment Profile:

  1. Click Create new profile.

  2. Enter the following parameters.

    Setting Description

    General Settings

    Name

    A descriptive name for the profile.

    Use Teleworker

    Select the Teleworker setting for the user from the drop-down menu.

    • off to disable the Client to register via the MBG.

    • on to enable a client to register via the MBG instead of directly with the PBX. If the Client is deployed with this setting, the user has the option to manually change the setting, but this change will not be overwritten by force configuration updates from the DeployU.

    • on (locked) to enable a client to register via the MBG instead of directly with the PBX. If the Client is deployed with this setting, the user has the option to manually change the setting and this change will be overwritten by force configuration updates from the DeployU. This will always reset the setting to on.

    Note:

    If the setting is on or on (locked), then all the mandatory MBG SIP host options are displayed.

    Use Softphone

    Select the Softphone setting for the user from the drop-down menu.

    • off to use deskphone for calls.

    • on to bypass the deskphone and have users handle calls directly on their smartphones. If the Client is deployed with this setting, the user has the option to manually change the setting, but this change will not be overwritten by force configuration updates from the DeployU.

    • on (locked) to bypass the deskphone and have users handle calls directly on their smartphones. If the Client is deployed with this setting, the user has the option to manually change the setting and this change will be overwritten by force configuration updates from the DeployU. This will always reset the setting to on.

    MBG

    Select the MBG connection to use. To connect MBGs, go to Configuration > Connections to MBGs.

    Override user e-mail

    Select this box if the Deployment e-mail address (see below) should be used as the recipient of all deployment e-mails.

    Deployment e-mail address

    Enter an e-mail address to be used as the recipient for the deployment file if a user account does not have an e-mail address connected to it. This is a mandatory setting.

    Log level

    Select the log level at which errors should be recorded. The collected logs are added to the server logs on the MiCollab where they can be downloaded with administrator privileges.

    Call Mode

    Select Audio or Video. Audio enables outgoing audio-only calls.

    Office Number

    Enter the phone number used to route client calls through the system.

    For MiVoice Business, Office Number is matched to the Hot Desking Access Number. When a client makes a call to a telephone number shorter than the MiCollab Client PBX Node Extension length, and they select to make a 'Native Call', the client will first make a call to the Office Number, then it will dial the desired number through the PBX.

    Office Number Pause

    Specifies the number of seconds that should pass before dialing an extension.

    Config download host

    Specify where the configuration should be downloaded. Choose between the MiCollab Server FQDN and Custom. The Custom setting supports the use of an FQDN that is different from the MiCollab Server FQDN. The Custom setting should not be used with an IP address.

    MBG SIP host

    This setting is only available if Use Teleworker is on or on (locked). The MBG SIP host provides the main features telephony, chat, presence, and so forth of the MiCollab Mobile Client.

    Specify the interface that should be used on the MBG:

    • MBG’s FQDN: The FQDN of the connected MBG that is used for MiCollab Mobile Client connections

    • MBGs Public IP: The public IP visible to the Application Management Center (AMC)

    • MBGs External Interface: The public IP of the WAN interface of the MBG

    • Custom: Enter an FQDN or IP address

    • Custom DNS SRV: A DNS-name used for SRV requests only

    It is highly recommended to use an FQDN which only resolves to the outside WAN even from behind the company firewall. Custom and Custom DNS SRV allow you to enter an IP address or domain name, respectively.

    MBG-WebRTC SIP host

    This setting specifies the interface that should be used on the MBG for WebRTC client connections. This field must be set to MBG's FQDN (default). The Custom setting is available for use with possible future deployment scenarios and should not be used.

    PBX SIP host

    Choose between Default or Custom DNS SRV. If set to Default the value returned by the PBX is used. If Custom DNS SRV is used, a field to specify the host appears. Please note that the Softphone Setting (see below) SIP Port is disabled.

    Note: If the PBX IP address is changed, a manual sync for the users in MiCollab Client deployment is required to enable softphone for the users.

    Conference Access Code

    Enter the access code for initiating conferences (if available) on your PBX System.

    Emergency Numbers

    These numbers are exempt from any special routing and are dialed directly! Certain numbers are pre-configured but can be modified and more can be added. Multiple emergency numbers must be separated with commas and no spaces. Although it is not recommended, emergency numbers that are not applicable to the user's region can be deleted if the emergency number (for example, 119) conflicts with an existing dialing string (for example, extension 119). Before you delete an emergency number, you should be certain that the user will not be traveling to a region that uses it.

    Softphone Settings

    PBX Type

    Select the PBX. Options are MiVoice Business, MiVoice 5000, MiVoice MX-ONE, and MiVoice Office 400.

    SIP transport protocol

    Select TLS or TCP. TLS is the recommended setting.

    Note: TCP as the SIP transport protocol is not supported by some Android devices. If you are using any of the devices listed below, set the protocol to TLS. UDP is also possible, but from a functionality perspective, TLS is preferable. The following phones have been tested and documented, but with new phones frequently entering the market this list may not be complete: HTC One M7, HTC One Mini 601n, HTC One M8, HTC One M9, HTC One X, SONY XPERIA Z, SONY XPERIA Z2, SONY XPERIA Z3, SONY XPERIA Z3 Compact, CAT B15Q, YotaPhone 2.

    SRTP mode

    Secure Real-time Transport Protocol mode (Off, Mandatory, or Optional). SRTP mode option is visible only when SIP transport protocol is set as TLS.

    Note: SRTP mode is supported for audio only.

    SIP port

    Specify the port that should be used for the selected protocol. This setting is only applicable if the PBX SIP host is set to Default.

    SIP DTMF method

    Select RFC 2833/RFC 4733 or SIP INFO. RFC 2833/RFC 4733 is the default.

    Default audio codec

    Select G722, G722.1, G729, PCMA, or PCMU. This only sets the initially requested codec. The codec used will be negotiated according to codecs requested by other devices.

    Max video TX rate (kbits/s)

    Select the maximum video data-transmit rate allowed when in a call. The default value is 768. Valid values are: 1536, 1024, 768, 512, 384, 192, 128. If a non-matching value is set, it will be changed to nearest supported one e.g. 850 to 768 accordingly.

    Max video RX rate (kbits/s)

    Select the maximum video-receive rate that the client will indicate in AS line. The default value is 768. Valid values are 1536, 1024, 768, 512, 384, 192, 128. If a non-matching value is set, it will be changed to the nearest supported one e.g. 850 to 768 accordingly.

    DSCP SIP

    Specify the Types of Service (ToS) for SIP traffic. Valid values can be created in compliance with RFC 2474.

    DSCP RTP audio

    Specify Types of Service (ToS) for RTP traffic. Valid values can be created in compliance with RFC 2474.

    DSCP RTP video

    Specify Types of Service (ToS) for RTP Video traffic. Valid values can be created in compliance with RFC 2474.

    Verify TLS-server-certificate

    Select the checkbox to validate and verify the TLS server certificate for the SIP connection.

    TLS-server-certificate CA

    Select the TLS-server-certificate type to validate the PBX or MBG identity on the SIP TLS connection.

    Types of certificates that are supported on the TLS connection (PBX or MBG):

    • Public CA (Trusted 3rd party certificate): The admin must apply a trusted certificate on the PBX or MBG.

    • Mitel CA (built-in Mitel certificates): These certificates are shipped along with MiVB and MBG.

    • Custom: In case the administrator, who has implemented their own Certification Authority (CA), the admin can upload the certificate to the Client Deployment Service and will be distributed to the client from there. With this setting, the clients will validate the MBG identity on the SIP TLS connection using the certificate provided.

    If the Mitel CA certificate is selected, set MBG SIP TLS certificate option (MiVoice Border Gateway > System Configuration > Settings) to Mitel.

    If the Public CA certificate is selected, set MBG SIP TLS certificate option to Web server.

    Note:

    MiCollab Client Deployment profile setting for TLS server certificate validation must match the above MBG setting. If the setting does not match, the MiCollab Client softphones will fail to register as validation will fail. For more information on MBG configuration settings, see MiVoice Border Gateway > System Configuration help section.

    TLS-server-certificate CA Upload

    This option is available only if the Custom certificate is selected in TLS-server-certificate CA.

    Browse and select the Custom certificate issued by the admin.

    Teleworker Type

    If the account belongs to a teleworker, this option must be set to MBG. The only Teleworker type currently supported is MBG.

    SIP transport protocol

    Select TLS or TCP. TLS is the recommended setting.

    Note: TCP as the SIP transport protocol is not supported by some Android devices. If you are using any of the devices listed below, set the protocol to TLS. UDP is also possible, but from a functionality perspective, TLS is preferable. The following phones have been tested and documented, but with new phones frequently entering the market this list may not be complete: HTC One M7, HTC One Mini 601n, HTC One M8, HTC One M9, HTC One X, SONY XPERIA Z, SONY XPERIA Z2, SONY XPERIA Z3, SONY XPERIA Z3 Compact, CAT B15Q, YotaPhone 2.

    SRTP mode

    Secure Real-time Transport Protocol mode (Off, Mandatory, or Optional)

    SIP Port

    Specify the port that should be used for the selected protocol.

    SIP DTMF mode

    Choose RFC 2833/RFC 4733, or SIP INFO. RFC 2833/RFC 4733 is used as the default mode.

    Default audio codec

    Select G722, G722.1, G729, PCMA, or PCMU. This only sets the initially requested codec. The codec used will be negotiated according to codecs requested by other devices.

    Max video TX rate (kbits/s)

    Select the maximum video data-transmit rate allowed when in a call. Default value is 768. Valid values are: 1536, 1024, 768, 512, 384, 192, 128. If a non-matching value is set, it will be changed to nearest supported one e.g. 850 to 768 accordingly.

    Max video RX rate (kbits/s)

    Select the maximum video-receive rate that the client will indicate in AS line. Default value is 768. Valid values are 1536, 1024, 768, 512, 384, 192, 128. If a non-matching value is set, it will be changed to nearest supported one e.g. 850 to 768 accordingly.

    DSCP SIP

    Specify the Types of Service (ToS) for SIP traffic. Valid values can be created in compliance with RFC 2474.

    DSCP RTP audio

    Specify Types of Service (ToS) for RTP traffic. Valid values can be created in compliance with RFC 2474.

    DSCP RTP video

    Specify Types of Service (ToS) for RTP Video traffic. Valid values can be created in compliance with RFC 2474.

    Verify TLS-server-certificate

    Select the checkbox to validate and verify the TLS server certificate for the SIP connection.

    TLS-server-certificate CA

    Select the TLS-server-certificate type to validate the MBG identity on the SIP TLS connection.

    Types of certificates that are supported on the TLS connection (MBG):

    • Public CA (Trusted 3rd party certificate): The admin must apply a trusted certificate on the MBG.

    • Mitel CA (built-in Mitel certificates): These certificates are shipped along with MiVB and MBG.

    • Custom: In case the admin who has implemented their own Certification Authority (CA), the admin can upload the certificate to the Client Deployment Service and will be distributed to the client from there. With this setting, the clients will validate the MBG identity on the SIP TLS connection using the certificate provided.

    If Mitel CA certificate is selected, set MBG SIP TLS certificate option (MiVoice Border Gateway > System Configuration > Settings) to Mitel.

    If Public CA certificate is selected, set MBG SIP TLS certificate option to Web server.

    Note: MiCollab Client Deployment profile setting for TLS server certificate validation must match the above MBG setting. If the setting does not match, the MiCollab Client softphones will fail to register as validation will fail. For more information on MBG configuration settings, see MiVoice Border Gateway > System Configuration help section.
    Note: TCP as the SIP transport protocol is not supported by some Android devices. If you are using any of the devices listed below, set the protocol to TLS. UDP is also possible, but from a functionality perspective, TLS is preferable. The following phones have been tested and documented, but with new phones frequently entering the market this list may not be complete: HTC One M7, HTC One Mini 601n, HTC One M8, HTC One M9, HTC One X, SONY XPERIA Z, SONY XPERIA Z2, SONY XPERIA Z3, SONY XPERIA Z3 Compact, CAT B15Q, YotaPhone 2.

  3. Click Validate configuration and save (recommended) to run the diagnostic tests and save the profile settings.

    or Click Save to save the profile settings only.

Parent topic: Deployment Profiles