TC3012en-Ed01 OXE Device Management Configuration Guide For SIP SoftPhone and Deskphone

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 86

Technical Bulletin OmniPCX Enterprise

TC3012 ed.01 Release 100.1

Device Management configuration guide for SIP


DeskPhone and SoftPhone for OXE R100.1

This document provides the configuration details required to install the Device Management module embedded in the OXE
Call Server to serve SIP DeskPhone and SoftPhone for R100.1 (N2).

Revision History
Edition 1: January 5, 2023 creation of the document

Legal notice:
www.al-enterprise.com The Alcatel-Lucent name and logo are trademarks of Nokia used under license by ALE. To view other
trademarks used by affiliated companies of ALE Holding, visit: www.al-enterprise.com/en/legal/trademarks-copyright. All other
trademarks are the property of their respective owners. The information presented is subject to change without notice. Neither
ALE Holding nor any of its affiliates assumes any responsibility for inaccuracies contained herein.
© Copyright 2023 ALE International, ALE USA Inc. All rights reserved in all countries.
Table of contents
1 Feature Presentation ............................................................................................................................... 5
2 Compatibilities ........................................................................................................................................ 6
3 Migration from OmniVista 8770 DM to OXE DM ......................................................................................... 7

3.1 Conditions to move to OXE DM .......................................................................................................... 7


3.2 Activation of OXE DM ........................................................................................................................ 7
3.2.1 Define a Sub type for each SIP extension device ........................................................................... 7
3.2.2 Upgrade all NOE3G-EE SIP R510 into R550 using the OmniVista 8770 ............................................ 8
3.2.3 Disable the DM in OmniVista 8770 to activate the OXE DM ............................................................ 9

4 Common configuration for SoftPhone and DeskPhone ............................................................................. 11


4.1 Customization of the certificate for OXE DM ...................................................................................... 11
4.1.1 Configure OXE FQDN in tool netadmin & activate DNS resolver from OXE .................................... 11
4.1.2 Generate the new certificate based on OXE FQDN and renew CTL file .......................................... 11
4.1.2.1 Local node signing the certificate or CSR .............................................................................................11
4.1.2.2 Remote node from OXE subnetwork signing the certificate ....................................................................12
4.2 Generic OXE parameter for SIP Phone COS ...................................................................................... 14
4.3 OXE DM Profiles creation ................................................................................................................. 15
4.3.1 Configure Generic DM profile 1 DeskPhone in LAN with LDAP ...................................................... 15
4.3.2 Configure Generic DM profile 2 SoftPhone in RW with Office365 .................................................. 18
4.4 Supported Deployment cases ........................................................................................................... 22
4.4.1 Mono-device ............................................................................................................................. 22
4.4.2 Multi-devices ............................................................................................................................ 22
4.5 SIP user creation as Main Device using OXE WBM ............................................................................. 23
4.6 Configuration using OmniVista 8770 application Users ....................................................................... 25

5 ALE DeskPhone deployment................................................................................................................... 28


5.1 DHCP configuration for DeskPhone .................................................................................................. 28
5.2 DeskPhone MAC address allocation .................................................................................................. 30
5.3 ALE-300 SIP switch from NOE to SIP ................................................................................................ 30
5.4 DeskPhone Network configuration .................................................................................................... 32
5.5 DeskPhone first Initialization ............................................................................................................ 34
5.6 Binary upgrade ............................................................................................................................... 35
5.6.1 First installation ........................................................................................................................ 35
5.6.2 Upgrade from OXE patch with new binary .................................................................................. 35

6 ALE SoftPhone deployment .................................................................................................................... 36

6.1 Specific configuration for ALE-S ....................................................................................................... 36


6.1.1 Configure external LDAP server for authentification in tool swinst ................................................ 36
6.1.2 Configure source for Directory Search Internal LDAP or Office 365 ............................................... 38
6.1.3 Internal LDAP: json file deployment and activation in the Phone applications COS ........................ 38
6.1.4 Teams Connector ...................................................................................................................... 40

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 2/86
6.2 SoftPhone software installation ........................................................................................................ 43
6.2.1 Single installation package wizard (Interactive mode) ................................................................. 43
6.2.2 Performing multiple client installation (Silent mode) .................................................................... 47
6.2.3 Removal ................................................................................................................................... 48
6.3 SoftPhone initialization .................................................................................................................... 49
6.4 Programmed keys management for ALES client ................................................................................ 52
6.4.1 Emergency call / Guard / Operator ............................................................................................. 53
6.4.2 Immediate forward ................................................................................................................... 54
6.4.3 Supervision key ........................................................................................................................ 54

7 Remote Worker configuration with OT-SBC and embedded RP ................................................................. 55


7.1 Using SBC to secure ALES conversations on corporate LAN and on WAN (Internet) ............................. 55
7.2 Deployments supported for OpenTouch context or OXE standalone ................................................... 55
7.3 SBC installation and network interface configuration ......................................................................... 56
7.3.1 OAMP address via CLI ............................................................................................................... 56
7.3.2 Network interface configuration ................................................................................................. 57
7.3.2.1 LAN Interface ....................................................................................................................................57
7.3.2.2 WAN Interface ..................................................................................................................................58
7.4 Security .......................................................................................................................................... 59
7.4.1 TLS contexts ............................................................................................................................. 59
7.4.2 Media Security .......................................................................................................................... 60
7.5 NAT Translation .............................................................................................................................. 60
7.6 Media Realms creation .................................................................................................................... 62
7.7 SIP Interfaces configuration............................................................................................................. 62
7.7.1 LAN SIP Interface ..................................................................................................................... 62
7.7.2 WAN SIP Interface .................................................................................................................... 64
7.8 IP Profile configuration .................................................................................................................... 64
7.8.1 Create IP profile for OXE ........................................................................................................... 65
7.8.2 Create IP profile for ALES Remote workers ................................................................................. 66
7.9 Proxy set for OXE ............................................................................................................................ 67
7.9.1 Create Proxy Set ....................................................................................................................... 67
7.10 Create Proxy Address .................................................................................................................... 67
7.11 SIP Message Manipulation ............................................................................................................. 68
7.11.1 Message manipulation set for OXE IP Group ............................................................................. 68
7.11.2 Message manipulation set for ALES Remote Workers ................................................................ 69
7.11.3 IP Group ................................................................................................................................ 70
7.11.4 IP Group for OXE server .......................................................................................................... 71
7.11.5 IP Group for OXE Remote Workers (ALES clients on WAN) ........................................................ 72
7.12 IP to IP Routing ............................................................................................................................ 73
7.12.1 OXE to ALES RW Users routing ................................................................................................ 73
7.12.2 ALES RW Users to OXE routing ................................................................................................ 74
7.13 Classification ................................................................................................................................. 75
7.13.1 Classification for ALES Remote users ........................................................................................ 75
7.14 HTTP Proxy................................................................................................................................... 75
7.14.1 Enable HTTP Proxy on SBC ...................................................................................................... 75

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 3/86
7.14.2 Create Upstream group for OXE ............................................................................................... 76
7.14.3 Add Upstream Host to Upstream Group .................................................................................... 78
7.14.4 Create HTTP Directive set ........................................................................................................ 78
7.14.5 Add directives to Directive set .................................................................................................. 79
7.14.6 Create HTTP Proxy Server ....................................................................................................... 80
7.14.7 Create HTTP Location for Proxy Server ..................................................................................... 81

8 Troubleshooting .................................................................................................................................... 83
8.1 DM configuration file generation ...................................................................................................... 83
8.2 NGINX server log ............................................................................................................................ 83
8.2.1 DeskPhone logs ........................................................................................................................ 83
8.2.2 Activate the debug log level....................................................................................................... 84
8.3 ALES – LDAP authentication failure .................................................................................................. 84

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 4/86
1 Feature Presentation
This document describes the configuration of the module Device Management embedded in OXE server for
release R100.1.

In previous release from OXE, the Device Management module was hosted on the OmniVista 8770 server for
the mass deployment of SIP DeskPhones. Only alternative to deploy a SIP phone was to use the embedded
WBM from the phone itself, to deploy a limited number of phones.

The objective of this feature is to manage with OXE DM the supported SIP end points
- SIP DeskPhones: NOE3G-EE SIP R550, ALE-2 and new models ALE-3 and ALE-300
- SIP SoftPhones: new application ALE-S for PC and Android

OmniVista 8770 Device Management benefits


- Centralized for all OXE nodes and OXE networks with User & device template

- Plug and Play solution

- Support existing SIP phones: 8001, 8088 Hotel or Huddle Room, 8008/18/28s, new ALE-2/ALE-3.

Restriction: ALE-300 SIP is not yet supported on 8770 DM.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 5/86
OXE DM benefits
- Higher security with customer base certificate

- Management by DM profile per node

- More resilient with duplication of Call Server

- Can still be used with OmniVista 8770 User application

- Automatic update of binary and immediate notification of configuration file modification

Restriction: Support only phones NOE3GEE models 8008/18/28s, ALE-2, SoftPhone ALE-S for PC and Android
and new models ALE-3 and ALE-300 SIP.

2 Compatibilities

DeskPhone SIP ALE-2, NOE3GEE SIP R550 and ALE SoftPhone for PC and Android are supported with version
R100.1 TR, from patch N2.514.12.

New Client ALE-3 and ALE-300 SIP are supported from version R100.1 MD1, from patch N2.514.23.C.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 6/86
3 Migration from OmniVista 8770 DM to OXE DM

After the upgrade of the OXE server into R100.0, the OmniVista 8770 DM configuration will remain
active and all the SIP DeskPhone already connected will remain in service:
- NOE3G-EE SIP R510
- 8088 in Hotel mode
- 8088 in Huddle room
- 8001 (Phase-Out devices)

3.1 Conditions to move to OXE DM


- If the system is already equipped with SIP phones 8001 or 8088: it is mandatory to keep OmniVista
8770 DM for DeskPhone. Only the new client ALE-SoftPhone will be supported by OXE DM.
- For an installation where only devices NOE3G-EE SIP are deployed: it is possible keep OmniVista
8770 DM OR move from OmniVista 8770 DM to OXE DM. During the migration the set will have
to be reset. They will be temporarily and lose their customization.
- For installation where no SIP DeskPhones were connected: new phones can be directly deployed to
OXE DM.

Note ALE-S clients will always be handled by OXE DM.


OTC clients from OpenTouch server will always be handled by OmniVista 8770 DM.

3.2 Activation of OXE DM


3.2.1 Define a Sub type for each SIP extension device
Before activation of OXE DM, you first need to define the Sub-type of each SIP Extension device declared on
the system.
Select the entry Users, pick the filter Set Type then select type SIP Extension to list the devices:

For each device, define the corresponding Sub type in the SIP tab:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 7/86
3.2.2 Upgrade all NOE3G-EE SIP R510 into R550 using the OmniVista 8770
In OmniVista 8770, Devices application select tab Applications
1. Select the corresponding OXE node and Add Package with the new application profile for each mode
of set 8008 / 8018 / 8028s:

2. Select the new version R550 – 1.55.xx

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 8/86
3. Deploy the package

4. Check the phone are properly updated during after scheduled period of upgrade

3.2.3 Disable the DM in OmniVista 8770 to activate the OXE DM

Warning Disabling the DM in OmniVista 8770 will cause the OmniVista 8770 to remove the device configuration.
Connected phone will lose their configuration. A reset flash will be mandatory on all devices.

Once all the devices have been updated, you can Disable the DM on OmniVista 8770 servers from the
directory:
System / Other System Param. / System Parameters

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 9/86
OmniPCX Enterprise - Release 100.1
Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 10/86
4 Common configuration for SoftPhone and DeskPhone

4.1 Customization of the certificate for OXE DM


From R100.1, the internal OXE PKI has evolve to support the generation of a new certificate based on FQDN
adapted to SIP equipment.

Therefore, the configuration of the FQDN from OXE system in the tool netadmin becomes mandatory and a
new certificate must be generated to deploy the new DeskPhone ALE-300 SIP.

It is necessary to generate/renew the OXE certificate delivered from internal OXE PKI or external PKI and
generate/renew the associated CTL file for SIP DeskPhones.

4.1.1 Configure OXE FQDN in tool netadmin & activate DNS resolver from OXE

1. In root login, run command netadmin and enter menu 17. 'Node configuration' / 2. 'Update'

Warning: the node name must be unique.


Warning: *** Change of Node name, requires regeneration of Call Server Certificates (CA
Update is not required ) followed by an OXE reboot ***
Enter node name (default is oxe61) ? oxe61
Do you want to activate internal name resolver (y/n default is 'n') ? y

2. Enter menu 19. 'Domain Management' / 1. 'Configure OXE Domain' / 2. 'Create/Update'

Warning: *** Change of OXE Domain name, requires regeneration of Call Server Certificates
(CA Update is not required ) followed by an OXE reboot***
Do you want to continue now (y/n default is 'n') ? y
Enter OXE Domain to be configured (default is company.com) ? company.com

4.1.2 Generate the new certificate based on OXE FQDN and renew CTL file

Note 1: this modification requires a restart of the system via reboot or double bascul

3. In root login, run command netadmin and enter menu 11. 'Security' / 11. 'PKI Management' / 1.
'Certificate'

4.1.2.1 Local node signing the certificate or CSR

4. You can either update


a. Internal certificate with entry : 1. 'Create/Modify CS Certificate' / 1. 'Internal
Certificate (Automatic Generated)'

Call Server Certificate Already present.


Do you want to replace it (y/n default is n) ? y
Do you want to update the CA (y/n, default is n)?n

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 11/86
Do you want to create Call Server Certificates (y/n, default is y)?y

The certificate will be created with the following CN & SAN fields
Common Name(CN)=oxe61.company.com
Subject Alternative Name(SAN)=DNS:oxe61.company.com DNS:*.company.com IP:10.13.0.6
IP:10.13.0.4 IP:10.13.0.5

Do you want to configure any additional Subject alternative Names (y/n, default is n) ?n

Please enter information that will be incorporated into your certificate request.

Country Name (2 letter code) [XX]:FR


State or Province Name []:HDS
Locality Name []:Paris
Organization Name []:ALE
Organization Unit Name []:TS

/C=FR/ST=HDS/L=Paris/O=ALE/OU=TS/

Are you sure you want to create Certificate/CSR with above details (y/n default is y)?y

Generating Physical Call Server private key...


Generating Call Server Certificate Signing Request for Physical Call Server...
Signing Physical Call Server CSR...
Physical Call Server and Twin Call Server Certificates successfully generated

Note : Perform Copy to Twin Operation to copy the Twin Certificates to Twin Server

b. For External certificate, create a new CSR for an external PKI : 2. 'Generate CSR' then
import the new certificate with 1. 'Create/Modify CS Certificate' / 2. 'Import
PKCS#12/PKCS#7' on the same Call Server

4.1.2.2 Remote node from OXE subnetwork signing the certificate

5. Select entry : 5. 'CSR Sign and Import (Network)'

11.11.1.Certificate Management
==============================
1. 'Create/Modify CS Certificate'
2. 'Generate CSR'
3. 'Delete Certificate'
4. 'CSR Signing (Local)'
5. 'CSR Sign and Import (Network)'
0. 'Previous menu'

What is your choice ? 5

Enter the OXE signing IP : 135.117.104.103

Please wait...

The certificate will be created with the following CN & SAN fields

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 12/86
Common Name(CN)=node006001.fr.alcatel-lucent.com
Subject Alternative Name(SAN)=IP:135.117.86.198 DNS:135.117.86.198
DNS:node006001.fr.alcatel-lucent.com DNS:*.fr.alcatel-lucent.com IP:135.117.86.204
DNS:135.117.86.204 IP:135.117.86.202 DNS:135.117.86.202 IP:135.117.86.199
DNS:135.117.86.199 IP:135.117.86.203 DNS:135.117.86.203

Do you want to configure any additional Subject alternative Names (y/n, default is n) ?n

Enter the key Size (Between 2048-4096, Default 2048): 2048

Please enter information that will be incorporated into your certificate request.

Country Name (2 letter code) [XX]:FR


State or Province Name []:HDS
Locality Name []:Paris
Organization Name []:ALE
Organization Unit Name []:TS

/C=FR/ST=HDS/L=Paris/O=ALE/OU=TS/

Are you sure you want to create Certificate/CSR with above details (y/n default is y)?y

Generating CSR for main call server...

Network signing in progress, please wait...

Network signing completed.

Warning:
CA update requires
1.Immediate regeneration of lanpbx followed by an OXE reboot. Multiple CA updates without
lanpbx regeneration and endpoint trust store update could cause CTL inconsistency between
OXE & endpoints and may lead to communication issues.
2.PCS certificate(s) to be generated manually through PCS menu if PCS(s) configured.

Do you want to import the certificates (y/n)? y


/tmp/xa006001_cert.pem: OK

Certificates are imported successfully.

Note : Perform 'Copy to twin CPU (all)' operation to copy the twin certificates to twin
server.

6. New certificate is now common to both Call Server.


It includes the FQDN as the Common Name of the certificate and all IP addresses are added as SAN.
Consult the certificate with entry 4. 'View':

Call Server Certificate


-----------------------
issuer=/C=FR/ST=HDS/L=Paris/O=ALE/OU=TS/CN=lab01-12345-67890-11111
subject=/C=FR/ST=HDS/L=Paris/O=ALE/OU=TS/CN=oxe61.company.com
notBefore=Sep 8 06:58:37 2022 GMT

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 13/86
notAfter=Sep 3 06:58:37 2042 GMT
subjectAltName=DNS:oxe61.company.com, DNS:*.company.com, IP Address:10.13.0.6, IP
Address:10.13.0.4, IP Address:10.13.0.5

7. Perform the copy of the certificate to twin cpu with entry 10. 'Copy setup' / 2. 'Copy to twin
CPU (all)'

8. Exit from root login then launch command lanpbxbuild to renew the CTL file and select entry 6.
Apply changes

6. Apply changes
7. Copy lanpbx to lanpbx-mipt
0. Quit

==> 6

Signed CTL generated: /DHS3data/mao/DM/VHE8082/ctl_VHE8082


CTL_sign OK
--------DM ctl_VH8082 file generation--------
--------Start of Native Encryption signing------
lanpbx content signing Completed.
lanpbx content signing Completed.
lanpbx content signing Completed.
lanpbx content signing Completed.
------------------------------------------------
------------------------------------------------
--------End of Native Encryption signing--------
Renaming /DHS3data/mao/lanpbx.cfg to /DHS3data/mao/lanpbx.cfg.old

9. If you have External Encryption Gateway configured on the system, load the new certificate from the
call server on each VM of External Encryption Gateway.

10. Reset the system by a restart or double bascul from the Call Server

Note: If you have encrypted network link, it is necessary to remove and restore the encryption on the Direct
IP Link or Hybrid VPN Link to renew the IPSec tunnel between the nodes.

4.2 Generic OXE parameter for SIP Phone COS


Activate SIP notification on SIP end points
• Enter WebAdmin
• Go to entry SIP Extension / Phone classes of service and select
o the default class 0 if no other SIP end point is declared
o a new class, if other SIP end points are declared

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 14/86
4.3 OXE DM Profiles creation
Several DM profiles can be necessary for SoftPhone and Deskphone according to the deployment mode:
- If ALE-2/ALE-3 device is used in LAN and WAN, a dedicated profile is required for each use case
- If DeskPhone use the internal LDAP search and SoftPhone use Office 365 for directory search, a
dedicated profile is required for each use case
- For ALE SoftPhone, you need to choose between the LDAP or Office 365 for directory search:
o LDAP search or Office 365 integration can be used for LAN configuration only
o For Remote Worker configuration, it is recommended to use Office 365 integration, due to
security issue to expose the internal LDAP on public address

In our example, we will provide 2 different profiles:


- 1: DeskPhone in LAN with LDAP adapted for ALE-2/ALE-3/ALE-300 SIP and NOE3G-EE SIP R550
DeskPhones with internal LDAP for directory search.
- 2: SoftPhone in RW with Office365 adapted to the ALE-S desktop in remote Worker with directory
search based on Office 365 and internal LDAP for Authentication

Tools WBM, MGR or OmniVista 8770 - OXE configuration can be used to configure the DM profiles. We will use
WBM in our example.

4.3.1 Configure Generic DM profile 1 DeskPhone in LAN with LDAP


In WBM, select the path SIP device management / DM profile, then click the button + Create to create a
new profile

o General characteristics

Set Profile Number to 1


Set Name to DeskPhone in LAN with LDAP
Set the Emergency Numbers

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 15/86
Note Labels for Emergency Numbers are not considered by the DeskPhone or Softphone currently.

Set LDAP server param for directory Search:

It is recommended to declare LDAPs connection on port 636 and configure the LDAP server using the LDAP
Server FQDN. The DNS server must be configured on OXE in netadmin menu 14. 'DNS configuration'

o Device characteristics

Set external server address like DNS1 /DNS2 and SNTP:

Note If you leave those fields empty the role IP Addresses from the Call Server will be filled automatically on the
xml configuration file.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 16/86
o Telephony characteristics

Set in section DIALING RULE, External access prefix and Minimal length to apply rule according to your
numbering plan:

Declare the OXE prefix Twin Set Get Call value (only for multi-devices config)

Activate the Telephony features:

o Advanced characteristics

Default Admin password for is 123456, it is advised to replace it by complex password that will requested to
connect in Admin menu from the set.

Activate SSH for troubleshooting if necessary.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 17/86
For Hotel or Business purpose the admin can force some Programmed Key in each DM profile:

However, there are not synchronized in OXE user details at Programmed Keys level.

4.3.2 Configure Generic DM profile 2 SoftPhone in RW with Office365


In WBM, select the path SIP device management / DM profile, then click the button + Create to create a
new profile

o General characteristics

Set Profile Number to 2


Set Name to SoftPhone in RW with Office365
Set the Emergency numbers

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 18/86
Note Labels are not considered by the DeskPhone or Softphone currently.

If available, set LDAP server param for directory Search:

It is recommended to declare LDAPs connection on port 636 and configure the LDAP server using the LDAP
Server FQDN. The DNS server must be configured on OXE in netadmin menu 14. 'DNS configuration'

Warning During the TLS handshake, the ALE-S performs a control between the FQDN and the CN from the LDAP
server certificate. If the control is not correct the ALE-S will reject the TLS session and block LDAP request.

o Application characteristics

If Office 365 is used for ALE SoftPhone configure the associated settings
Set Office 365 Client ID : 12345678-abcd-1234-abcd-12345678910
Set Office 365 Tenant ID : abcdef78-abcd-1234-abcd-12345678910
Set Office 365 Integration : to Mandatory (to force activation), to Optional (requires user activation in
Contacts tab from ALE-S)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 19/86
o SIP characteristics

For remote worker support, set SBC to YES then provide


- the Outbound proxy address and Outbound proxy port 5261 shared with OpenTouch server
- the Backup Reverse Proxy fqdn with public reverse proxy address

o Telephony characteristics

Set Dialing rule External access prefix to 0 and Minimal length to apply rule to 10

Declare the OXE prefix Twin Set Get Call value (only for multi-devices config)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 20/86
Activate the Telephony features:

For Business context, the Programmed Keys can be configured at the user level and will be pushed to the SIP
device:

For Hotel context, the admin can force some Programmed Key in each DM profile:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 21/86
4.4 Supported Deployment cases
4.4.1 Mono-device
- ALES is declared as the Main Device of the OXE user as a SIP extension device with sub-type ALE-
deskstop or ALE-mobile
- SIP DeskPhone is declared as the Main Device of the OXE user as a SIP extension device with sub-type
8008 / 8018 / 8028s /ALE-2 / ALE-3 / ALE-300

SIP DeskPhone SIP SoftPhone

SIP Extension SIP Extension


Main Main

4.4.2 Multi-devices
- SIP DeskPhone as the Main Device of the OXE user as a SIP extension device with sub-type 8008 /
8018 / 8028s /ALE-2 / ALE-3 / ALE-300

- ALES PC or Android can be declared as the Secondary Device of the OXE user as a SIP extension device
with sub-type ALE-deskstop or ALE-mobile.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 22/86
SIP DeskPhone SIP SoftPhone

SIP SIP
Extension
Main Extension
Secondary

4.5 SIP user creation as Main Device using OXE WBM


Note In this example I will only mention the minimum settings for the SIP extension declaration. All other entries
proposed are valid, if you want to improve the configuration of the user by declaring a voicemail (Tab
voicemail), adapt the COS (Tab Rights) or set the device as secondary device (tab Assoc.sets).

1. Create a new user with


a. Directory Number
b. Directory Name
c. Directory First Name
d. Set Type : SIP extension
e. External login (only required for ALE SoftPhone)

2. In SIP tab, pick correct the Sub type and set the DM profile 1 or 2:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 23/86
3. In Other tab, set the Phone COS application 2 (only required for ALE SoftPhone):

4. Programmed keys management from Administrator

Some telephony services, such like the supervision, require creating a dedicated programed key by
administrator on the device on OXE side.

Expand the User menu to configure the programmed Keys:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 24/86
Note Other programmed key such like a direct call or forward services can be configured either by Admin or end
user. If the Admin manage a key, it will overwrite the local key from the user

4.6 Configuration using OmniVista 8770 application Users


Note In this example I will only mention the minimum settings for the SIP extension declaration. You can use a
OXE profile to customize other settings

The minimum version for the OmniVista 8770 to create an ALES or ALE-2 device is R5.0.22.0 with patch K.

1. Create the OXE user based on the following parameters


a. Last Name
b. First Name
c. User ID (for ALES if LDAP OmniVista 8770 is used for authentication, duplicate the External
login)
d. OmniVista 8770 password (for ALES if LDAP OmniVista 8770 is used for authentication,
declare the user password)
e. External login (only for ALES device, must match the field login in the OXE user interface)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 25/86
2. In the OXE attributes, define:
a. Device type: SIP extension

Warning In case you use the OmniVista 8770 as LDAP authentication server, the User ID and External login must be
identical

3. Open the OXE tab and configure the SIP options to declare the Sub type and DM profile

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 26/86
For further details consult: OmniVista OmniVista 8770 Administrator Manual Release 5.0 - October 2021
8AL90703USAN
• Chapter 3.2.4 Configuring users, section 5. To associate an ALE SIP Softphone for Windows to the
user
• or chapter 4.4.8.2 Creating and Associating a New Device to a User

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 27/86
5 ALE DeskPhone deployment

5.1 DHCP configuration for DeskPhone


• Vendor Class Identifier
o ictouch.0 : is used by NOE3G-EE SIP R550 and ALE-300 SIP
o aledevice : is used by ALE-2 and ALE-3

• External DHCP server needs to use option 66


o NOE3G-EE SIP R510: <OXE_main IP@>/DM/dmictouch
o NOE3G-EE SIP R550 / ALE-300 SIP: https://<OXE_main IP@>/DM/dmictouch or
https://<OXE_FQDN>/DM/dmictouch (with DNS server entry)
o ALE-2 / ALE-3: https://<OXE_main IP@>/DM/dmictouch or
https://<OXE_FQDN>/DM/dmictouch (with DNS server entry)

• OXE Embedded DHCP


o New classes are automatically created SIP80x8s and ALE-2X
x NOE x
x MIPT x
x VHE x
x VHENOE x
x MIPT2 x
x IPXBS x
x SIP80x8s x
x gd3 x
x gd4 x
x ALE-2X x
x gdxl x
x x
mqqqqqqqqqqqqqqqqqqqqqqqqqqqj

o TFTP Server Address must be configured to provide option 66


▪ NOE3G-EE SIP R550 / ALE-300:
lqReview/Modify: Classesqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqk
x x
x Node Number (reserved) : 101 x
x DHCP Configuration : 1 x
x Name : SIP80x8s x
x x
x Vendor ID : ictouch.0 x
x TFTP Server address : https://oxe.company.com/dmictouch x
x Default lease time (mn) : 60 x
x Max lease time (mn) : 1440 x
x Configuration file : ------------------------------------- x
x x
mqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj

▪ ALE-2 / ALE-3:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 28/86
lqReview/Modify: Classesqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqk
x x
x Node Number (reserved) : 101 x
x DHCP Configuration : 1 x
x Name : ALE-2X x
x x
x Vendor ID : aledevice x
x TFTP Server address : https://oxe.company.com/dmictouch x
x Default lease time (mn) : 60 x
x Max lease time (mn) : 1440 x
x Configuration file : ------------------------------------- x
x x
mqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj

If you defined the OXE FQDN in option 66 configure the DNS Primary and DNS Secondary with the main IP
Addresses of the Call server in each range of IP address:

lqConsult/Modify: All Subnetworksqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqk


x x
x Node Number (reserved) : 699 x
x DHCP configuration : 1 x
x x
x Subnetwork x
x x
x Subnet address : 10.40.0.0 x
x Netmask : 255.255.0.0 x
x x
x Broadcast address : 10.40.255.255 x
x Default router address : --------------------------------------- x
x TFTP server address : --------------------------------------- x
x VLan ID : ---- x
x VLan Address : --------------------------------------- x
x SVP Server for MIPT : --------------------------------------- x
x DNS Primary : 10.13.0.6 x
x DNS Secondary : 10.14.0.7------------------------------ x
x x
mqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj

Don’t forget to Apply modification in the first menu:

lqDHCP Configurationqqqqqqqqqqqqqqqqqqqqk
x x
x -> Go down hierarchy x
x Consult/Modify x
x Consult/Modify Overview of Object x
x Modify x
x Modify Overview of Object x
x Apply modifications x
x Facilities x
mqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 29/86
5.2 DeskPhone MAC address allocation
• MAC address allocation – static or dynamic

As an administrator, you can allocate statically the MAC address of the device in the WBM/MGR menu in the
new subfolder IP SIP extension:
- Go into the submenu User/ IP SIP extension and configure the MAC address with lower case letter

Note It currently mandatory to use lower case letter to fill the MAC address.

As a result, the configuration file is automatically created in the folder /DHS3data/mao/DM/dmictouch.


If no MAC address is registered no configuration file is generated. Thus the set will start in Auto-discovery
mode requiring:
- The username: Directory number of the user
- The password: Secret code from the user (by default 0000)

After registration of the device MAC address the configuration file is generated on-the-fly.

5.3 ALE-300 SIP switch from NOE to SIP


Upgrade of the binaries into R200.0

If the phone runs with NOE binary R150, an update of NOE and SIP binaries into R200 is required to switch the
device into SIP mode. This step is not required if you receive a new Phone with binaries NOE & SIP R200.

1. Pre-requisites: ALE-300 device must be declared as OXE user in NOE mode

2. Check the SIP binary for ALE-300 with command downstat i :

- ALEx00(ALE-300,ALE-400,ALE-500)
bootloader 1.20.14
application 1.20.11
sip 1.00.03

3. Upload of the SIP binary, can be performed per phone or generally for all ALE-300

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 30/86
A new parameter is introduced for the DeskPhone Enterprise in the menu: Alcatel-Lucent 8&9
Series → 8&9 Series COS → Phone COS -> Force Download NOE/SIP

a. If set to NO, only the NOE binary R200 will be uploaded on the DeskPhone Enterprise, when
the phone will be connected to the NOE user.
The SIP binary will be updated at the moment of the bascul from NOE to SIP as there will be
no SIP binary detected.

b. If set to YES, the Phone the NOE binary and SIP binary are upgraded automatically on the set
and SIP binary 1.00.03 is available on the set.

It requires 2 steps of upgrade on the phone. First the new NOE binary is downloaded and
installed, then the phone reset with the new NOE binary. Then the SIP binary is downloaded
and installed with a second reboot of the phone.

Check its presence in tab Menu / Settings / Options / Version / SIP

Note: if the phone is already deployed with the correct NOE binary, the SIP binary is not
update automatically. You need to force the update with downstat i.

4. Don’t forget to remove the MAC of the Phone from the NOE device / TSC IP user,
otherwise the phone will not be authorized to be registered on a SIP user

The next step is to switch the device into SIP binary according to the IP configuration

Switch from NOE to SIP

5. Trigger by MMI, recommended on production system where there are other device NOE3GEE and ALE
Deskphone declared in NOE mode
i. After device boots, press * and # keys simultaneously to enter MMI
ii. Enter password if requested
iii. Select Software Infos -> Run Mode, click on “Set Mode” to switch and press the
floppy disk icon to save.

6. Trigger by DHCP, only available when no other device are declared into NOE mode or if a dedicated
DHCP User Class can be configured on external DHCP server
In the Vendor Class from the NOE mode, alcatel.noe.0, must be updated with the
keyword sipconfig.txt

a. Embedded OXE DHCP: modify the existing class SIP80x8s

lqReview/Modify: Classesqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqk
x x
x Node Number (reserved) : 101 x
x DHCP Configuration : 1 x
x Name : NOE x
x x

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 31/86
x Vendor ID : alcatel.noe.0 x
x TFTP Server address : ------------------------------------- x
x Default lease time (mn) : 60 x
x Max lease time (mn) : 1440 x
x Configuration file : sipconfig.txt x
x x
mqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj

b. External DHCP: add the new DHCP option 67 with the keyword sipconfig.txt

5.4 DeskPhone Network configuration


By default, the set start in dynamic mode and will retrieve the path from DM from option 66. This method can
be used on all DeskPhones.

• ALE-2 / ALE-3 deployment in static mode

1. Let the phone start with the default configuration in DHCP mode, it will start with the configuration
embedded in the flash.
2. Access the menu of Administration to enter the IP config:
- Enter tab Menu / Advanced setting fill the password 123456
- Enter Network / IP config / IPv4 settings select static mode and configure the
IP/Subnet/Gateway and if useful DNS1/DNS2
- After restart of the set, wait for one minute, then connect to the WBM from the set using
https://<phone_IP@>
- Enter the Tab Provision/Auto Provision and fill the DM URL with the url
https://<OXE_main_IP@>/dmictouch or https://<OXE_FQDN>/DM/dmictouch (with
DNS server entry)

• NOE3G-EE SIP deployment in static mode


Warning Upgrade to R550 is mandatory before the move of the SIP device to the OXE DM.

Two solutions are possible to upgrade the binary to R550:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 32/86
- Phone Out-of-box or declared in NOE mode
o Connect the set to the Call Server in R100.0 and associated it to a NOE user
o The new SIP binary will be updated by default
o Restart the set and connect in MMI in Soft infos, change run mode to SIP then exit
o At next start the phone will boot on SIP binary with SIP VCI
o Put the NOE set out of service and remove the associated MAC address

- Phone already declared in SIP mode on OmniVista 8770 DM


o Retrieve the zip file of version 1.55.00.5016.
o Create a new package and deploy it to the connected devices
o In the Device Application, dissociate and re-associate the MAC address of the device to force
the upgrade
o Remove the CTL by
▪ Connect in SSH and launch the command CTL erase
▪ Log in Admin menu to select Factory reset

Static configuration
- Move to right direction to display the settings menu and select Admin, then fill the default password
123456
- Enter IP param / IP Config / IPv4 settings select static mode and configure the
IP/Subnet/Gateway and if useful DNS1/DNS2
- After restart of the set, wait for one minute, then connect to the WBM from the set using
https://<phone_IP@>
- Enter the Tab Setting/Auto Provision and fill the Provision Server URL with the url
https://<OXE_main_IP@>/dmictouch or https://<OXE_FQDN>/DM/dmictouch (with
DNS server entry)

• ALE-300 SIP deployment in static mode

7. Enter the MMI in NOE mode to modify the Running mode into SIP
a. After device boots, press * and # keys simultaneously to enter MMI
b. Enter password if requested

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 33/86
c. Select Software Infos -> Run Mode, click on “Set Mode” to switch and press the floppy
disk icon to save.

8. Provide the IP configuration in SIP MMI


a. After device boots, press key I to enter MMI
b. Select Network -> Phone IP config
c. Modify IPV4 mode into Static
d. Configure the mandatory fields:
i. IP address
ii. gateway
iii. router
iv. DNS1 & DNS2
e. Save by pressing back key 
Note: set the DNS 1 and DNS2 with OXE main IP address(es)
f. Select SIP configuration and configure the entry DM url based on the main IP address
(local redundancy) or FQDN (spatial redundancy):
https://<OXE_IP_or_FQDN>/dmictouch

5.5 DeskPhone first Initialization


• Global initialization sequence is as follow

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 34/86
• First Initialization steps to recover the CTL

At first initialization the set runs in Trust Of First Use (TOFU mode), meaning that it established the TLS
connection without authentication of the TLS server certificate.
1. Config file is downloaded to retrieve CTL settings with filename, hash and IP Address of signing
device, i.e. OXE IP address
2. CTL file is uploaded and installed => New TLS link established WITH check of the server certificate
base on CTL
3. Config file is reloaded to read the Audio / SIP parameter / binary path
4. Binary header to check the version of binary, and start background upload is necessary
5. Phone register to OXE in SIP
6. Phone send the NOTIFY for Identification
7. Phone SUBSCRIBE to SIP notification for voicemail-event (missed call/VM messages) /user-profile
(DND) / dialog (supervision/hunting group)

5.6 Binary upgrade


The config file from OXE DM provides the path of the binary on the OXE server with the schedule to apply the
daily for new binary:
<setting id="FirmwareUpdate" value="1" override="true"/>
<setting id="DmEnetcfgUpgradeFile" value="https://oxe.company.com/downbin" override="true"/>
<setting id="DmAdmcfgUpdateTimeEnable" value="true" override="true"/>
<setting id="DmAdmcfgUpdateTimeStart" value="04:00" override="true"/>
<setting id="DmAdmcfgUpdateTimeDelta" value="180" override="true"/>

5.6.1 First installation


At first initialization, the phone will automatically receive the version of binary available on the Call Server
through the OXE DM settings.
As the phone reset several times, it will perform its upgrade/downgrade to match the version provided by
OXE, if no denial of downgrade is implemented.

5.6.2 Upgrade from OXE patch with new binary


After first initialization, the phones check the availability of a new binary at the configured time. When a new
binary will be provided through an update of the Call Server version, the phone will be updated at the next
control of the binary version.
It is also possible to force the download of a set by generating a reset of the device.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 35/86
6 ALE SoftPhone deployment
The client ALE SoftPhone provides an authentication mechanism based on a login/password from Microsoft
account.

It is thus mandatory to deploy an external LDAP server for authentication. In most of the case it
should be the Active Directory or it can be an external LDAP server.

Note Despite the OmniVista 8770 provides an external LDAP, it has some limitations for customer site in term of
password management and notifications:
- Password must be managed in the directory by admin, and notified to end user
- There is no notification for password expiry to end user, it is the role of admin to inform the end
user
- Only admin can replace the password when it is already expired
It is recommended for lab systems.

Second aspect to configure is the source for the Directory Search which can be either:
- An external LDAP: i.e OmniVista 8770 or Active Directory
o It is only suitable for LAN deployment for R100.0.
o It requires to define a LDAP filed mapping file *.json. See section Internal LDAP: LDAP fields
mapping json file
o Then deploy it on the phone using the Phone Applications COS. See section Internal LDAP:
json file deployment and activation in the Phone applications COS
- Office 365 integration
o It is mandatory for Remote Worker deployment for R100.0
o It requires to register the ALE-S application in the Microsoft Azure admin page. See section
Office 365 Integration

Both clients can be deployed in local and remote worker with various environments. Check the deployments
guides for technical aspects:
- TC2954 Quick steps deployment with 8770 for ALE SoftPhone
- TC2955 Quick steps deployment with Active directory for ALE SoftPhone
- TC2956 Quick steps integration with Teams for ALE SoftPhone
- TC2957 Quick steps deployment in Remote worker for ALE SoftPhone

6.1 Specific configuration for ALE-S


6.1.1 Configure external LDAP server for authentification in tool swinst
Open tool swinst and access menu 2. expert / 6 system management / 5 Users account
management / 5 ldap authentication

1. Select entry 2 Create/Modify LDAP server to configure the LDAP server

The example below corresponds to an Active Directory configuration:


Authentication Realm =

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 36/86
Hostname = LDAPserver.company.com
Port = 636
Scheme = ldaps://
Search Base DN = ou=Users,ou=CORP,dc=company,dc=lcl
Login attribute = cn
Filter = (objectClass=Person)
Bind DN = CN=SA-VOICE-01,ou=Privileged Accounts,ou=Core
Accounts,dc=corp,dc=local
Bind password = ***********

Hostname: LDAP FQDN is recommended in association with the OXE DNS configuration in netadmin menu
14. 'DNS configuration'. IP address can be used if OXE DNS is not configured in netadmin.
Login attribute: attribute in the LDAP for the login values
Bind DN: correspond to the user Distinguished Name

2. Go back to previous menu and save the NGINX configuration:

Do you want to dynamically reconfigure nginx ? (y/n, default y): y

Nginx successfuly reconfigured


Press return

3. Enter again menu 5 ldap authentication, then activate the configuration with entry 3
Enable/Disable LDAP authentication

LDAP authentication is currently desactivated


Do you want to activate LDAP authentication ? (y/n, default y): y

4. Check the configuration is correctly activated using the entry 1 View configured LDAP server

Current LDAP configuration :

LDAP authentication is currently activated

Authentication Realm =
Hostname = LDAPserver.company.com
Port = 636
Scheme = ldaps://
Search Base DN = ou=Users,ou=CORP,dc=company,dc=lcl
Login attribute = cn
Filter = (objectClass=Person)
Bind DN = CN=USER-01,ou=Accounts,dc=company,dc=lcl
Bind password = ***********

Press return

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 37/86
Check the deployments guides of 8770 or Active Directory for technical aspects:
- TC2954 Quick steps deployment with 8770 for ALE SoftPhone
- TC2955 Quick steps deployment with Active directory for ALE SoftPhone

6.1.2 Configure source for Directory Search Internal LDAP or Office 365
For ALE SoftPhone, you need to choose between the LDAP or Office 365 for directory search:
➢ LDAP search or Office 365 integration can be used for LAN configuration only
➢ For Remote Worker configuration, it is recommended to use Office 365 integration, due to security issue
to expose the internal LDAP on public address

6.1.3 Internal LDAP: json file deployment and activation in the Phone applications COS
Modify the default .json file on OXE

Default customization file ldapfm.json is deployed automatically in directory /usr3/mao/DM/dmsoftphone/ales:

(699)xa006099> ll /usr3/mao/DM/dmsoftphone/ales/
total 4
-r--r--r--. 1 mtcl tel 1221 Nov 14 23:45 ldapfm.json

Activation of the file on ALE SoftPhone devices


1. Go to "Applications -> Phone Applications -> Applications List "

2. Create new application with


a. Set Application Index to 2
b. Set Application ID to LDAP field mapping
c. Set Application url to https://<oxe_fqdn>/DM/dmsoftphone/ales/ldapfm.json

3. Go to "Applications -> Phone Applications -> Phone Applications COS"


a. select COS for ALES users and fill "Application Item No1" with created Application index and
set "Application Enable : 1“

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 38/86
4. Go to "Applications -> Phone Applications -> Apply Modifications" and apply modifications.

5. Regenerate DM files with "SIP device management -> Generate all Configuration Files"

6. Check in DM file that URL to json file exists in Appl0ConfigUrl settings:


<setting id="Appl0ConfigId" value="2" override="true"/>
<setting id="Appl0ConfigEnable" value="true" override="true"/>
<setting id="Appl0ConfigUrl"
value="https://oxe.company.com/DM/dmsoftphone/ales/ldapfm.json " override="true"/>

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 39/86
6.1.4 Teams Connector

The integration of ALE SoftPhone in Microsoft Teams environment is provided with the ALES PowerApps:

This application can run in Teams client application or Teams web browser Edge and Chrome.

ALES PowerApps

The PowerApps is a Web application only available in Microsoft runtime (as Teams application is).

The PowerApps is not connect directly to OpenTouch and requires ALE SoftPhone installation on PC.

The new software is provided in MyPortal along with the ALE SoftPhone application.

Search contacts in Microsoft Teams ecosystem:

Contacts can be searched from:


- Outlook contact (local, O365)
- Azure AD

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 40/86
Telephony features

ALES PowerApps provides access to ALE SoftPhone features:


• Make call/Answer call
• Incoming call notifications
• Call routing, call history
• Programmable keys
• Supervision/Pick-up

Licensing

Microsoft PowerApps require a specific license, included in some Office 365 licenses or can be bought
in separate plans.

PowerApps usage is included in ALE SoftPhone license.

Deployment of the ALES PowerApps

You are asked to upload the application and then share the application to a Teams user or group:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 41/86
For detailed process of deployment review the document :
- TC2956 Quick steps integration with Teams for ALE SoftPhone

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 42/86
6.2 SoftPhone software installation
6.2.1 Single installation package wizard (Interactive mode)

Application desktop is provided as an *.msi installation package. It is available in MyPortal in OmniPCX R100.0
software download version:

1. As an administrator from the PC, install the application by double click on the msi package to start the
installation

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 43/86
2. Click Next

3. Accept the Terms of license Aggreement then click Next

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 44/86
4. Select or modify the Installation folder then click Next

5. Provide the public and private FQDN or IP address of the OXE DM, then click Next

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 45/86
6. Confirm if you want to install the extension for Microsoft Outlook, click Next

7. Click Install and accept the installation

8. Click Finish to finalize installation and start the application

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 46/86
6.2.2 Performing multiple client installation (Silent mode)

Standard deployment tools are available to install several clients simultaneously from a remote
computer on the network.

These tools rely on command lines. For an ALE SoftPhone installation with the msi package, the command
line used is: msiexec /i <access path>\AleSoftPhone-<version>.msi /qn where:
• /i specifies the msi package to run
• <access path> specifies where is located the msi package
• /qn requests installation to run silently

The command line can include additional options such as:

• INSTALLDIR
o Define the installation path.
o Default value : <program files>\Alcatel-Lucent Enterprise\ALE SoftPhone\

• OXEHOST / REVERSEPROXY
o Local access (OXE) and Remote access (RP) servers name
o There no default value.

• INSTALL_EXTENSION
o Install ALE Softphone extension for Microsoft Outlook.
o Available values are :
▪ 1: Install extension. (DEFAULT)
▪ 0: Do not install.

• LANGUAGE
o Used to define the user language in component that will need a special language parameter.
The following “Land code” or “Lang id” values are accepted:

Language_Lang code Lang id


Czech cs_CZ 1029
Danish da_DK 1030
German de_DE 1031
English (default) en_US 1033
Spanish es_ES 1034
Finnish fi_FI 1035
French fr_FR 1036
Hungarian hu_HU 1038
Itialian it_IT 1040
Korean ko_KR 1042
Dutch nl_NL 1043
Norwegian nb_NO 1044
Polish pl_PL 1045
Portuguese pt_PT 2070

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 47/86
Brazilian Portuguese pt_BR 1046
Russian ru_RU 1049
Swedish sv_SE 1053
Turkish tr_TR 1055
Chinese (Simplified) zh_CN 2052
Chinese (Traditional) zh_TW 1028

• LOGIN
o Define the user’s login.
o No default value.

These additional options must be entered in upper case (mandatory).

Example:
msiexec /i D:\soft\ALESoftphone-<version>.msi /qn INSTALLDIR=C:\Program\Alcatel-Lucent
\AleSoftPhone OXEHOST=oxe.company.com REVERSEPROXY=rp.mycompany.com

Upgrade
Upgrade installs a new version of binaries and set registry keys (it is performed with “msiexec /i AleSoftPhone-
<version>.msi /qr” option).

Upgrade process is started in the same way as first installation (ALE SoftPhone installer detects the already
installed version).

Downgrade is not supported (only possible by uninstall then install).

Repair

The goal of this mode is to repair binaries and registry keys according installed version.

Repair process is started in the same way as first installation (ALE SoftPhone installer detects the already
installed version).

The repair mode is activated if the same version is already installed.

There are no options. ALE SoftPhone must be stopped during maintenance in the same way as an upgrade.

6.2.3 Removal
Removal process starts the installer program for removal. This will delete the following folders
• Installation folder (a.k.a <Program Files>\ Alcatel-Lucent Enterprise\ALE SoftPhone)
• Configuration folders: %APPDATA%\ Alcatel-Lucent Enterprise\ALE Softphone
• Logs folders: %TEMP%\ Alcatel-Lucent Enterprise\ALE Softphone

Silent mode removal:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 48/86
ALE SoftPhone Installer for removal start in silent mode from command line :
msiexec /qn /x " AleSoftPhone-<version>.msi"
AleSoftPhone -<version>.msi /x

In case of ALE SoftPhone running, ALE SoftPhone is killed and uninstalled.

Interactive mode removal:


It can be started from “Add/remove programs” of Windows Configuration Panel, it displays a confirmation
dialog box.

In case of ALE SoftPhone running a warning is displayed. If user confirms uninstallation, ALE SoftPhone is
stopped and uninstalled.

6.3 SoftPhone initialization


• First initialization

Connection menu will open requiring the External login and password

- Fill in the login and password entries


- Private and public FQDN of the DM OXE provided at installation are automatically filled.
- If remote worker credential differs, enter the dedicated information

Note In remote worker, authentication on reverse is only supported with external LDAP, client certificate is not
yet supported.

At first connection to the DM, the certificate will be authentication using the windows OS trust store. If the
OXE DM Certificate is not trusted, the user is prompted to accept the certificate from the DM to connect start
the authentication session.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 49/86
Note It is necessary to distribute the ROOT CA from the internal OXE PKI or external PKI by the Windows
administrator through the GPA tools. Check section 3.2 Customization of the certificate for OXE DM for
more details.

Then the application will send an initial https request with login & password with the following sequence:

• Activation of Office 365 at user level in the ALE-S application

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 50/86
The Office365 Integration option can be Optional or Mandatory.
When this option is validated and the ALE softphone restarted, we can see the following option in the
application under Contact configuration:

When the option is set as Mandatory in the OXE SIP DM profile, this option is automatically activated at the
ALE softphone application start and the following Office36 authentication windows are displayed to
authenticate:

Enter your Office365 login and after the password.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 51/86
6.4 Programmed keys management for ALES client

ALES client provides 5 pages of 24 keys to define Programmed Keys by end user:

OXE Admin can only manage 10 keys from the server side, including Key 1 and Key 2 reserved for multi-Line:

The supervision key created by Admin will be positioned in the first 10 keys:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 52/86
If the user already created a local key, it will be moved to the first empty key available automatically:

6.4.1 Emergency call / Guard / Operator


Those number are automatically defined from the OXE DM configuration:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 53/86
Note The label associated to those number are not used by ALES application.

6.4.2 Immediate forward


Warning When creating an Immediate forward to external number, it must include the prefix for trunk seizure.

6.4.3 Supervision key


Warning It is mandatory to configure the Supervision key with Ringing Mode set to No Ring as shown below to benefit
from the new feature of SIP supervision based on NOTIFY messages.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 54/86
7 Remote Worker configuration with OT-SBC and embedded RP

7.1 Using SBC to secure ALES conversations on corporate LAN and on WAN
(Internet)

One considers here 2 interfaces / 2 networks on SBC.


• LAN interface with direct access to OXE, DNS, LDAP servers. SIP, RTP, HTTP traffic

• WAN interface with internet access through firewall.


Should be in SIP secured (SIP/TLS and SRTP) mode for Remote Worker clients to operate with
internal OXE server through SBC in SIP secured mode.

7.2 Deployments supported for OpenTouch context or OXE standalone

If the system OXE is already deployed in OpenTouch ecosystem with OTC clients configured in remote worker
mode, the OT-SBC and reverse proxy components will already be configured following the documentation
8AL90065USAI OT-SBC Configuration Guide.

You can directly go to the section HTTP Proxy to declare the additional HTTP rules to access the OXE DM.
For a new deployment of OXE system, you need to follow the next steps to configure the SBC component and
embedded Reverse Proxy form OT-SBC R7.4.

The detailed deployment of ALES SoftPhone with OXE standalone is detailed in the documentation below:
TC2957 Quick steps deployment in Remote worker for ALE SoftPhone

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 55/86
7.3 SBC installation and network interface configuration
For configurations other than that described, refer to this document: SBC 7.4 configuration guide from
AudioCodes.
Mediant Software SBC Virtual and Server Editions User's Manual Ver. 7.4

7.3.1 OAMP address via CLI

1. Use tVMWare/Hyper-V console to connect to the Mediant Software SBC’s CLI management interface.
2. At the prompt, type the username (default is Admin - case sensitive), and then press ENTER:
Username: Admin
3. At the prompt, type the password (default is Admin - case sensitive), and then press ENTER:
Password: Admin
4. At the prompt, type enable and press ENTER:
Mediant SW> enable
5. At the prompt, type the password again and press ENTER:
Password: Admin
6. At the prompt, type the following commands to access the network interface configuration:
Mediant SW# configure voip
Mediant SW(config-voip)# interface network-if 0
Mediant SW(network-if-0)#
7. At the prompt, type the following commands to configure the corporate network used for LAN users and
SBC management (IP address, prefix length and default gateway):
Mediant SW(network-if-0)# set ip-address xxx.xxx.xxx.xxx
Mediant SW(network-if-0)# set prefix-length 24
Mediant SW(network-if-0)# set gateway xxx.xxx.xxx.xxx
At the prompt, type exit to complete the network-if-0 configuration:
Mediant SW(network-if-0)# exit
8. If Mediant Software SBC is connected to the IP network that uses a VLAN ID, type the following command
to configure it (otherwise skip to step 9):
Mediant SW(config-voip)# interface network-dev 0
Mediant SW(network-dev-0)# vlan-id x
Mediant SW(network-dev-0)# exit
9. At the prompt, type exit to complete the configuration:
Mediant SW(config-voip)# exit
10. At the prompt, type write to write the configuration and auxiliary files to NV memory:

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 56/86
Mediant SW# write
11. At the prompt, type reload now to reset the device and activate the new configuration:

Mediant SW# reload now

7.3.2 Network interface configuration


Configuration for IPv4 only.

7.3.2.1 LAN Interface


Open the ‘IP Interfaces' page (SETUP > IP NETWORK > CORE ENTITIES > IP Interfaces)

Fill LAN IP interface configuration:


• Name: Any name that describes LAN interface
• Application type: OAMP + Media + Control
• Ethernet device: Select ethernet device connected to LAN network
• DNS: Enter LAN DNS servers
• IP Address: LAN IP address for access to local servers and configuration web interface
• Prefix length: Netmask in prefix format
• Default gateway: Gateway for access to LAN.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 57/86
For local ALE network use VLAN 1
If you have two physical ports, they automatically will be assigned to separated Ethernet Groups. In other
case assign WAN physical interface to Ethernet Group for WAN access.

7.3.2.2 WAN Interface


Create new Ethernet Device according to your network configuration.

Create IP Interface for WAN access

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 58/86
Application type: Media + Control
Ethernet Device: WAN ethernet device
Primary DNS: DNS Address
Other parameters should be set according to network configuration.
For wan ALE network use VLAN 2

7.4 Security
7.4.1 TLS contexts
SETUP > IP NETWORK > SECURITY > TLS Contexts

TLS Version: TLSv1.2


DTLS Version: DTLSv1.2
Cipher Server: AES:RC4
Cipher Client: ALL:!ADH
Strict Certificate Extension Validation: Enable, if you uploaded the Root CA certificate to TLS
Context, otherwise should be set to Disable
DH Key Size: 1024
Upload certificate or generate new via CSR. For different purposes e.g., https, you can create several
TLS Contexts.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 59/86
7.4.2 Media Security
Open the 'Media Security' page (SETUP > SIGNALING & MEDIA > MEDIA > Media Security)

Media security: Enable


Media Security Behavior: Mandatory
Offered SRTP Cipher Suites: AES-CM-128-HMAC-SHA1-80

7.5 NAT Translation


In case of WAN interface behind NAT you should configure NAT Translation

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 60/86
Enter port range and Target IP Address for each range.
Mandatory: 5261, range 6000-6499

If you need to enable NAT Traversal for media, open the 'Media Settings' page (SETUP > SIGNALING &
MEDIA > MEDIA > Media Settings)

Set NAT Traversal to ‘Enable NAT Only If Necessary’


Nat Traversal: Enable NAT Only if Necessary

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 61/86
Number of Media Channels: For example, 10000, not limited if -1
Need to use for ALE network

7.6 Media Realms creation


Open the 'Media Realms' page (SETUP > SIGNALING & MEDIA > CORE ENTITIES > Media Realms)

Create one Media Realm per leg (use '+New' button):


A media realm for LAN voice media OXE
A media realm for ALES WAN 'RemoteUsers'

IPv4 Interface Name: set the same name as in IP Interfaces Table


Media Realm Name: set a relevant name
IPv4 Interface Name: set the same name as in IP Interfaces Table
Port Range Start: set a different value for each use
Number of Media Session legs: set the max quantity of the media legs

7.7 SIP Interfaces configuration


7.7.1 LAN SIP Interface
By default, SBC creates SIP interface for LAN.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 62/86
Update default SIP Interface parameters according to your network configuration from (SETUP >
SIGNALING AND MEDIA > CORE ENTITIES > SIP Interfaces):
SIP Interface port:
Enter required port for UDP, TCP, TLS connection, enter ‘0’ if not used. Default UDP only
port 5060.
User Security Mode:
‘Accept Registered Users’ blocks any SIP requests from unregistered users – to apply to all
WAN SIP interfaces
Other choices: ‘Not configured’ (default value for ALES),’Accept all’ = calls from unregistered
users are not blocked (forbidden for WAN domain), ‘Accept Registered Users from Same
Source’
Enable Un-Authenticated Registrations:
‘Disable’ = Registers are sent to the SIP Proxy Server, the user registration is added to the
database only if authenticated by the proxy server. ‘Not Configured’ (default value for ALES)
= to use with OXE SIP interface, ‘Enable’ = the SBC device adds any REGISTER requests to
its database even if the requests are not authenticated by a SIP proxy (forbidden for WAN
domain)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 63/86
7.7.2 WAN SIP Interface
Create SIP Interface WAN:

Application type: SBC


Topology location: UP
Network Interface: WAN
SIP port: TLS 5261
TLS Context Name: TLS context for WAN from “SETUP > IP NETWORK > SECURITY > TLS
Contexts”
User Security Mode: Accept Registered Users
Enable Un-Authenticated Registrations: Disable

7.8 IP Profile configuration


Open the 'IP Profiles' page (SETUP > SIGNALING & MEDIA > CODERS & PROFILES > IP Profiles ).

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 64/86
7.8.1 Create IP profile for OXE

Broken Connection Mode: ‘Ignore’ (to keep the media active after a pause on stream)
SBC Media Security Mode: ‘Not secured’
Remote Replaces Mode: Keep as is

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 65/86
7.8.2 Create IP profile for ALES Remote workers

Broken Connection Mode: ‘Ignore’

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 66/86
SBC Media Security Mode: ‘Secured’
Signaling Diffserv: 40

7.9 Proxy set for OXE


Open the 'Proxy Sets' page (SETUP > SIGNALING & MEDIA > CORE ENTITIES > Proxy Sets)
Don’t use Proxy Set ID 0, used by default on SBC. Create new proxy set.

7.9.1 Create Proxy Set

Name: Any, for example “OXE proxy set”


SIP IPv4 Interface: SIP interface created for OXE on LAN
Classification Input: ‘IP Address only’

7.10 Create Proxy Address


Use configured on OXE port and transport type (Default for ALES: UDP, 5060)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 67/86
Standalone: Use OXE IP Address
Local redundancy: Use OXE shared IP Address
Spatial redundancy: Use OXE FQDN
Also, able to make additional redundancy using “Proxy Set > Redundancy / Keep alive” (See SBC docs) by
adding operational OXE IPs to Proxy Address list to prevent DNS issues.

7.11 SIP Message Manipulation


Need to create message manipulations for OXE and ALES IP Groups.

7.11.1 Message manipulation set for OXE IP Group


Open the Message Manipulations page (SETUP > SIGNALING & MEDIA > Message Manipulation ->
Message Manipulations)
Create two message manipulations with same manipulation set ID. For example: 2

Name: Any
Manipulation Set ID: Selected for OXE
Row Role: Use Current Condition
No changes for Message Type and Condition to effect on all SIP messages
Action Subject: header.to.url.host

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 68/86
Action Type: Modify
Action Value: OXE Hostname and port

Name: Any
Manipulation Set ID: Selected for OXE
Row Role: Use Current Condition
No changes for Message Type and Condition to effect on all SIP messages
Action Subject: header.from.url.host
Action Type: Modify
Action Value: OXE Hostname and port

7.11.2 Message manipulation set for ALES Remote Workers


Create four message manipulations with same manipulation set ID. For example: 5

Name: Any
Manipulation Set ID: Selected for ALES RW

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 69/86
Row Role: Use Current Condition
Action Subject: header.to.url.host
Action Type: Modify
Action Value: SBC WAN Hostname and port

Name: Any
Manipulation Set ID: Selected for ALES RW
Row Role: Use Current Condition
Action Subject: header.from.url.host
Action Type: Modify
Action Value: SBC WAN Hostname and port

Name: Any
Manipulation Set ID: Selected for ALES RW
Row Role: Use Current Condition
Message Type: refer.request
Condition: header.Refer-To exists
Action Subject: header.Refer-To.url.host
Action Type: Modify
Action Value: SBC WAN Hostname and port

Name: Any
Manipulation Set ID: Selected for ALES RW
Row Role: Use Current Condition
Message Type: refer.request
Condition: header.Referred-By exists
Action Subject: header.Referred-By.url.host
Action Type: Modify
Action Value: SBC WAN Hostname and port

7.11.3 IP Group
IP Group ID 0 cannot be used: this IP Group is set to default values and is used by the device when IP
Groups are not implemented.
Filling the SIP group name with a value will push that value in ‘Request-URI’ and ‘To’ header for all outgoing
SIP message for servers declared in the IP Group.

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 70/86
7.11.4 IP Group for OXE server

Set the following parameters for OXE (Index ‘2’ here):


Type: ‘Server’
Topology Location: Down
Proxy Set: <proxy set for OXE>
SIP group name: <OXE node or role SIP Request-URI FQDN>
Media Realm, IP Profile ID: set the values configured for OXE on LAN side
Classify by proxy set: enable
Outbound Message manipulation Set: <Manipulation Set number> defined in the Message
Manipulations table for the headers contents of the SIP messages sent to OXE server

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 71/86
7.11.5 IP Group for OXE Remote Workers (ALES clients on WAN)

Set the following parameters for OXE Remote workers (index ‘5’ here):
Type: ‘User’
Topology Location: Up
Media Realm: set the value configured for OXE ALES Remote workers
IP Profile ID: set the value configured for the OXE ALES Remote workers
Classify by proxy set: disable for any Remote workers
Outbound Message manipulation Set:: <Manipulation Set number> defined in the Message
Manipulations table for the headers contents of the SIP messages sent to ALES Remote workers
Media TLS Contexts: TLS Contexts for ALES RW Users

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 72/86
7.12 IP to IP Routing
Open the 'IP to IP Routing' page (SETUP > SIGNALING & MEDIA > SBC > Routing > IP-to-IP
Routing)

7.12.1 OXE to ALES RW Users routing

Name: Any, for example ‘OXE -> ALES Users’


Source IP Group: OXE IP Group
ReRoute IP Group: Any
Destination Type: All Users

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 73/86
7.12.2 ALES RW Users to OXE routing

Name: Any, for example ‘ALES Users -> OXE’


Source IP Group: ALES RW Users IP Group
ReRoute IP Group: Any
Destination Type: IP Group
Destination IP Group: OXE IP Group

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 74/86
7.13 Classification
7.13.1 Classification for ALES Remote users

Name: Any, for example ‘ALES Users’


Source SIP Interface: External SIP TLS interface
Destination Host: SBC External FQDN
Source IP Group: ALES RW IP Group

7.14 HTTP Proxy


For now, limited by 1024 connections, but for ALES used only to get DM and ldapfm.json files

7.14.1 Enable HTTP Proxy on SBC


Go to (Setup > IP Network > HTTP Proxy > General Settings)
Enable HTTP Proxy application and set DNS Servers

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 75/86
SBC restart is needed.

7.14.2 Create Upstream group for OXE

Go to (Setup > IP Network > HTTP Proxy > Upstream Groups)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 76/86
Name: Any
Protocol: HTTP/HTTPS
Load Balancing Mode: IP Hash

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 77/86
7.14.3 Add Upstream Host to Upstream Group

Host: OXE IP or FQDN


Port: DM access port

7.14.4 Create HTTP Directive set


Go to (Setup > IP Network > HTTP Proxy > HTTP Directive Sets)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 78/86
Name: Any
Description: Any

7.14.5 Add directives to Directive set

Go to (Setup > IP Network > HTTP Proxy > HTTP Directive Sets -> OXE Directive set -> HTTP
Directives)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 79/86
Add new directives line by line:
proxy_set_header Host $host;
proxy_buffering off;
proxy_read_timeout 900;
client_max_body_size 10m;
client_body_timeout 3600;
sub_filter_types *;
sub_filter_once off;

7.14.6 Create HTTP Proxy Server


Go to (Setup > IP Network > HTTP Proxy > HTTP Proxy Servers)
Create new HTTP Proxy Server

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 80/86
Name: Any
Domain Name: External SBC FQDN for RP
Listening Interface: New or existing external interface for RP
HTTPS Listening Port: External port for RP access
Bind To Device: Disable
Additional Directive Set: OXE_RP (From step 15.4)

7.14.7 Create HTTP Location for Proxy Server

Go to (Setup > IP Network > HTTP Proxy > HTTP Proxy Servers -> HTTP Locations)

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 81/86
URL Pattern: /DM/dmsoftphone/
Upstream Scheme: HTTPS
Upstream Group: OXE Upstream Group
Upstream Path: /DM/dmsoftphone/
Outbound Interface: New or existing LAN interface for RP
Cache: No
TLS Context: TLS Contexts for OXE DM

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 82/86
8 Troubleshooting

8.1 DM configuration file generation


• SIP DeskPhone

o The DM generated file is based on MAC address, filename is: config.<mac>.xml in


/DHS3data/mao/DM/dmictouch folder.
o The generation is only available when mac address is configured

Check the configuration file availability on the DM folder:


(699)xa006099> ll /usr3/mao/DM/dmictouch/
total 84
-rw-rw-rw-. 1 mtcl tel 13541 Jul 27 19:50 config.00809fa0a9f0.xml
-rw-rw-rw-. 1 mtcl tel 13533 Jul 27 19:50 config.00809fa0bd27.xml
-rw-rw-rw-. 1 mtcl tel 13549 Jul 27 19:50 config.00809fa0e7e0.xml
-rw-rw-rw-. 1 mtcl tel 10104 Jul 27 19:50 config.3c28a6000002.xml
-rw-rw-rw-. 1 mtcl tel 10104 Jul 27 19:50 config.ac3f43000001.xml

• ALE SIP SofPhone

o The DM generated file is based on login account (this login is mandatory for ALES)
o When login account is a mail address tree, filename is: <domain of mail>/<firstcharacter
of user of the mail address dump in hexa>/conf_<user of the mail address dump in
hexa>.xml
o When login account isn’t a mail address tree, filename is: __/<firstcharacter of user of the
mail address dump in hexa>/conf_<user of the mail address dump in hexa>.xml
o ALES-desktop
▪ Initial path of the file /DHS3data/mao/DM/dmsoftphone/ ALES-desktop
o ALES-mobile
▪ Initial path of the file /DHS3data/mao/DM/dmsoftphone/ ALES-mobile

Check the configuration file availability on the DM folder:


(699)xa006099> ll /usr3/mao/DM/dmsoftphone/ALES-desktop/__/73/
total 20
-rw-rw-rw-. 1 mtcl tel 17571 Jul 27 19:50 conf_736261727261756c.xml

8.2 NGINX server log


In root login, you can check the webserver logs from directory /var/log/nginx files access.log or
error.log.

8.2.1 DeskPhone logs

• Deskphone - config provisioning

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 83/86
[root@csa61 nginx]# grep dmictouch access.log
2021-07-27T17:02:14+02:00 [10.13.0.88 -] "-" "GET /DM/dmictouch/config.xml
HTTP/1.1" STATUS=404 SIZE=146 DURATION=0.000 GZIP=- "ALE ALE-2 2.12.00.002.1095
3c28a60801f6 TPK211600327"
2021-07-27T17:02:15+02:00 [10.13.0.88 -] "-" "GET
/DM/dmictouch/config.3c28a60801f6.xml HTTP/1.1" STATUS=200 SIZE=9844
DURATION=0.000 GZIP=- "ALE ALE-2 2.12.00.002.1095 3c28a60801f6 TPK211600327"

• Deskphone - binary update


[root@csa61 nginx]# grep downbin access.log
2021-07-27T06:59:38+02:00 [10.13.0.84 -] "-" "GET /downbin/sip8018N HTTP/1.1"
STATUS=206 SIZE=256 DURATION=0.000 GZIP=- "ALE 8018-GE 1.55.00.5016 00809feded36"
2021-07-27T06:59:44+02:00 [10.13.0.84 -] "-" "GET /downbin/bin8018N HTTP/1.1"
STATUS=206 SIZE=256 DURATION=0.000 GZIP=- "ALE 8018-GE 1.55.00.5016 00809feded36"
2021-07-27T07:09:39+02:00 [10.13.0.84 -] "-" "GET /downbin/sip8018N HTTP/1.1"
STATUS=206 SIZE=256 DURATION=0.000 GZIP=- "ALE 8018-GE 1.55.00.5016 00809feded36"
2021-07-27T07:09:45+02:00 [10.13.0.84 -] "-" "GET /downbin/bin8018N HTTP/1.1"
STATUS=206 SIZE=256 DURATION=0.000 GZIP=- "ALE 8018-GE 1.55.00.5016 00809feded36"
2021-07-27T07:57:08+02:00 [10.13.0.88 -] "-" "GET /downbin/sipH3_6X HTTP/1.1"
STATUS=200 SIZE=56923 DURATION=0.045 GZIP=- "ALE ALE-2 2.12.00.002.1095
3c28a60801f6"
2021-07-27T08:07:08+02:00 [10.13.0.88 -] "-" "GET /downbin/sipH3_6X HTTP/1.1"
STATUS=200 SIZE=56923 DURATION=0.042 GZIP=- "ALE ALE-2 2.12.00.002.1095
3c28a60801f6"

8.2.2 Activate the debug log level

To enable the log in debug mode, then modify the file: /etc/nginx/nginx.conf
And comment the line:
#error_log /var/log/nginx/error.log info;
And uncomment the line:
error_log /var/log/nginx/error.log debug;
after this to take into account the debug mode launch the command: nginx -s reload

8.3 ALES – LDAP authentication failure

If we have a bad entry in the LDAP authentication, we will see this info under: /var/log/nginx/error.log
2021/08/17 00:05:26 [error] 6167#6167: http_auth_ldap: Initial bind failed (49:
Invalid credentials [80090308: LdapErr: DSID-0C09044E, comment:
AcceptSecurityContext error, data 52e, v2580])
And under: /var/log/nginx/access.log
2021-08-17T14:40:04+02:00 [155.132.130.228 -] "-" "GET
/DM/dmsoftphone/conf_6c697070.xml HTTP/1.1" STATUS=401 SIZE=574 DURATION=0.000

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 84/86
GZIP=- "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like
Gecko) Chrome/92.0.4515.131 Safari/537.36 Edg/92.0.902.67"
2021-08-17T14:40:26+02:00 [155.132.130.228 swinst] "-" "GET
/DM/dmsoftphone/conf_6c697070.xml HTTP/1.1" STATUS=000 SIZE=0 DURATION=10.000
GZIP=- "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like
Gecko) Chrome/92.0.4515.131 Safari/537.36 Edg/92.0.902.67"
2021-08-17T14:40:36+02:00 [155.132.130.228 swinst] "-" "GET
/DM/dmsoftphone/conf_6c697070.xml HTTP/1.1" STATUS=000 SIZE=0 DURATION=10.002
GZIP=- "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like
Gecko) Chrome/92.0.4515.131 Safari/537.36 Edg/92.0.902.67"

When this will work correctly you must have:


2021-08-17T17:08:14+02:00 [155.132.130.228 -] "-" "GET /DM/dmsoftphone HTTP/1.1"
STATUS=401 SIZE=172 DURATION=0.000 GZIP=- "ALES-desktop/0.0.017.000"
2021-08-17T17:08:14+02:00 [155.132.130.228 account] "-" "GET /DM/dmsoftphone
HTTP/1.1" STATUS=200 SIZE=17502 DURATION=0.093 GZIP=- "ALES-desktop/0.0.017.000"

We can check the LDAP info under the file: /etc/nginx/nginx_variants.cfg


If you want to modify this info, then don’t forget to reload the file by the command:
./reconfigure_nginx.sh
And relaunch the nginx by the command: nginx -s reload

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 85/86
Submitting a Service Request
Please connect to our eService Request application.

Before submitting a Service Request, please be sure:


− The application has been certified via the AAPP if a third party application is involved.
− You have read the release notes that list new features, system requirements, restrictions, and more,
and are available in the Technical Documentation Library.
− You have read through the related troubleshooting guides and technical bulletins available in the
Technical Documentation Library.
− You have read through the self-service information on commonly asked support questions and known
issues and workarounds available in the Technical Knowledge Center.

- END OF DOCUMENT -

OmniPCX Enterprise - Release 100.1


Device Management configuration guide for SIP DeskPhone and SoftPhone for OXE R100.1 TC3012 ed.01
© Copyright 2023 ALE International, ALE USA Inc. page 86/86

You might also like