Configuring DevLink3

New Connection Method

With IP Office Release 10, Chronicall and Avaya Call Reporting now use a new and secure way to connect to Avaya IP Office called DevLink3.  This is the only way to reliably log data from IP Office and is a requirement for logging with Avaya IPO 10.0 and above. 

This means that both Chronicall and ACR will employ a secure connection to communicate with Avaya IP Office via TCP (connection-oriented) and not rely on UDP (connection-less) methods as Monitor did in the past.  Chronicall will still collect all the wonderful detailed information from Avaya IP Office that you have grown accustomed to but with more reliability and certainty.

Licensing Requirements by Avaya for Third-Party Applications to Use DevLink3

For all IP Office connections to a third-party application like Chronicall using DevLink3, Avaya requires the use of a CTI Link Pro License. 

For Avaya Call Reporting, you do not need a CTI Link Pro license as it is considered a first-party application by Avaya IPO.  

• Every node of IPO R10 and above must have a CTI Link Pro license to connect to Chronicall 
  
  • NOTE:  Avaya's OEM Avaya Call Reporting (ACR) licensing does not  require a separate CTI Link Pro license. That functionality is included with its license
• Most sites using DevLink3 will use the regular Devlink3 connection. When we need to connect to the IP Office via the internet instead of a local network port then you will use the DevLink Websocket option.
  • NOTE: Each IP Office node you have will need a CTI Link Pro license to log via TCP-based DevLink3 unless you have Avaya's Cloud-hosted Chronicall or Avaya Call Reporting. 

Setup within IP Office

• NOTE: The details below are determined by Avaya but are listed for your convenience
• NOTE: The DevLink 3 protocol is available over TCP or TLS
  • For TCP the port on IP Office is 50797
  • For TLS the port is 50796

Steps

1. Log into IP Office Manager
2. Navigate to File > Advanced Settings > Security Settings
   • Default username/password is security/securitypwd

Turn on the Devlink3 connection

1. 1. Select System > Unsecured Interface tab
      
      
      
      
   2. Check the box next to "TAPI / DevLink 3" on the “Unsecured interfaces” tab within System Security
      • This must be checked for Chronicall/ACR connectivity
      • Availability of the TCP service is governed by the IP Office security settings

Add DevLink3 to a Rights Group

• A combination of username and password is used to authenticate the application.
• This is configurable on the IP Office by adding a new Rights Group and Service User via the Security Settings on the IP Office
  1. While still under the Security Settings menu click on the "Rights Groups" option
  2. Configure a new Rights Group and enable the checkbox "DevLink3" in the Telephony API’s tab
     
     

Add the DevLink3 Rights Group Membership to a new Service User

1. Configure a new Service User with a Name, Password and assign it to the DevLink3 "Rights Group Membership"
   • NOTE: Please use alphanumeric passwords only, no symbols
   • NOTE: Make sure to write down the Username and Password for your Service User; you'll need those to complete the setup within Chronicall/ACR
     
     
     
     
   • NOTE: When monitoring events, a maximum of 3x DevLink3 connections are allowed to a single IP Office. If using multi-node flags, only 3x Devlink3 connections are allowed on a single SCN.
   • NOTE: The above steps, for configuring your Right Group and Service User, will need to be duplicated for each IP Office Node you're connecting to Chronicall.

Setup within Chronicall/ACR

1. Navigate to Admin (System) > System Settings > Server Edition
2. Click on the ellipsis next to "IP Office Connections"
3. Either Add a new site or Edit a previously created IPO connection
4. When configuring a site, change the API from "System Monitor (Legacy)" to "DevLink3 (recommended)"
   
   
   • Site Name: Give the IP Office connection a meaningful name
   • IP Address of IP Office: Enter the IP address of the IP Office
   • DevLink3 Use TLS: Set to true if using TLS
     • This requires a certificate of at least medium-security loaded into IP Office
   • DevLink3 Username: Enter the Service User with DevLink3 rights
     • Created in the steps above
   • DevLink3 Password: Enter the password of the Service User
   • External Trunks: See here for more details