Welcome to the Cyara Knowledge Center

Overview

This guide describes how to configure the Cyara Voice Gateway (OPAL) for registering H323 extensions without using Cyara Call Engine for the task.

Firewall Requirements

Configuration Objects

Below are the configuration points for the Cyara Voice Gateway once the installation is complete.

After the installation is complete on the server, navigate to the Cyara Voice Gateway URL.

http://localhost:1719

From the home screen Click System Parameters

1. Update the Log File to the desired log output file name.
2. Update the Log Rotate Directory with the location of the desired log output destination.
3. Change the Log Rotate Size to 10000KB, in Example 1 the default Log Rotate Size is set to 500000kb, this will cause an issue when running the Cyara Voice Gateway.

                        Example 1 

4. Media Transfer Mode should be set to Bypass
5. Auto Start audio should be set to Send & Receive and the remainder set to Don’t offer.

6. Preferred Media should be set to the customer’s requirement, example G.711 or G.729.

6a.Removed Media are Codecs to be prevented from being used. These are wildcards as in the above Preferred Media, with the addition of preceding the expression with a '!' which removes all formats except the indicated wildcard. Also, the '@' character may also be used to indicate a media type, e.g. @video removes all video codecs.

7. Default options can be used in the following section.

8. H.323 Interfaces will need to be updated with installed Servers IP address port :1720.
9. 
10. H.323 Security needs to be set to h323 &h323s
11. H.323 Aliases will be the section to add the provided H.323 Extension. When adding an extension be sure to change the drop down from Ignore to Add

11. There are two ways to add mulitple extensions to the Cyara Voice Gateway (OPAL Parameters). First is as mentioned above by using the add drop down, however these have to be entered and saved one by one. Once you add one the Accept button at the bottom of the page will need to be clicked and the page will need to be reloaded to add the next one in the list. ****Note: Number of Ports and Licesnes will dicate the number of extensions that can be used.

       11a. Second method is to Export the Parameters registry, update as described below in Example 2.

Registry Location: [HKEY_USERS\.DEFAULT\Software\Equivalence\OPAL Server\CurrentVersion\Parameters]. ****Note this is in the User Section.

                Example 2: “H.323 Aliases Array Size” will need to be updated with the number of extensions to              

                Be added. For each extension a(n) “H.323 Aliases #”=”Extension” will need to be added to the

                End of the exported .reg file. Once the update is complete run double click your updated .reg file

                to update the registry with the new parameters. I have also attached a sample exported .reg.

                *****Note: Keep a backup of the original exported .reg prior to making any changes. 

                                    I have also attached a sample .reg file, Opal_Parameters.txt

12. Remote Gatekeeper Address will need to be updated with the IP of the PBX/Switch that the H.323 extensions will register.
13. Remote Gatekeeper Password will be the numberical password for the H.323 extensions in use. Not if registering mulitple H.323 extensions the numberical password will need to be the same for all.

14. Sip Interfaces will need both UDP and TCP assigned to the installation server IP address. Port 5060 will be used by OPAL for communication. Routing to the Call Engine will be configured below with port 15060. Sip Security needs sip & sips

15. Sip Local Register Domains will need to be the installation server IP address and port :5060 SDP Security will need sdp & sdps selected.

16. SCCP Device Type 30008 for Avaya, 30016 for Cisco

17. Routes will need to be defined as shown in Example 3. Here Port 15060 is being used as this route dictate the location and port of the call engine.
18. 

Example 3.

18. Update the CDR Text file with the location of the desired log output destination

19. Once configuration is complete Click the Accept button at the bottom of the System Parameters page to save all changed configuration items.
20. Example 4 From the home screen Click Registration Status after a Stop and Start of the Cyara Voice Gateway. Example contains multiple extension registration.

Example 4:

21. Voice.CallEngine.exe.conifg SIP configuration section, which should be installed on the same servers as Cyara Voice Gateway. Update the SIP section with Call Signaling Port value of 15060, this will be the port that Cyara Voice Gateway uses to communicate/route calls to the Call Engine.

Cyara Call Engine (pre 7.10 - Dialogic HMP Based):

<SIP>
    <add key="Codecs" value="g729a-2fpp,g729a-3fpp,g729a-4fpp"/>
    <add key="CallSignalingPort" value="15060" />
    <!--add key="ShouldRegister" value="true" /-->
    <!--add key="RegistrationCsvFile" value=".\register-opal.csv" /-->
    <add key="TcpAsDefaultSipTransport" value="True" />
    <add key="AllowSipOverTcp" value="True" />
    <!--add key="XOpalAoRListFile" value=".\opal-aor.txt"/-->
  </SIP>

Cyara Call Engine Next (20.1 and above):

Note: with the latest call engine use only those configuration options that are present in the configuration file:

<add key="CallSignalingIpAddress" value=""/>
<add key="CallSignalingPort" value="5060" />
<add key="Transport" value="udp"/>
<add key="Codecs" value="alaw, ulaw" />
<add key="RtpIpAddress" value=""/>
<add key="RegistrationFile" value=".\register-opal.csv"/>

Starting with Cyara 20.1 opal-aor file is defined in the register-opal.csv. Below is the example from the version 22.1.

Note: that your version may have different syntax. Please check examples provided with your Call Engine Next installation.

UserName,Password,Identity,Contact,Domain,Realm,TTL,XOpalAoRListFile,AuthenticationUserName,CUCM,DeviceName,DeviceType
cyara,,sip:cyara@192.168.30.70:15060,sip:cyara@192.168.30.70:5060,192.168.30.70:15060,cyara,300,opal-aor.txt,cyara,,,

Opal AOR File Example

file opal-aor.txt:

h323:1100..1109@192.168.30.213;type=gk
sccp:SEP000011110020..000011110027@192.168.30.20