Configuring Switch and DN Objects for SIP Cluster
Step 1: Configuring a SIP Cluster Switch
[Updated]
Create a Switch object of type SIP Switch dedicated to the SIP Cluster. with the name, for example, SIP_Cluster. Under the SIP Cluster Switch, you will configure the following DN types, as described below:
- Voice over IP Service:
- SIP Cluster DN
- SIP Outbound Proxy DN
- MSML DN
- Softswitch DNs if there are remote agents in your environment.
- Trunk
- Routing Point
- Extension
Notes:
- Agent Logins are not required in the SIP Cluster configuration.
- All SIP Server applications representing SIP Cluster nodes must use the same switch.
- ACD Queue DNs are not supported in the SIP Cluster.
Step 2: Configuring the Cluster Node DN
[Updated]
The Cluster Switch must contain a Cluster Node DN. All SIP Server and SIP Proxy applications in the Cluster use the parameters configured in this DN.
- Under the SIP Cluster Switch, create a DN of type Voice over IP Service named, for example, SIP_Cluster.
- In the Annex > TServer section, configure the following mandatory options:
| Name | Value | Notes | Example |
|---|---|---|---|
| addp-trace | full | ||
| addp-remote-timeout | 83 | T-Controller link ADDP protocol setting. | |
| addp-timeout | 41 | T-Controller link ADDP protocol setting. | |
| applications | A comma-separated list of primary SIP Server application names in the cluster. | All SIP Server instances, except dummy SIP Server applications used by ICON, for all data centers. | applications=SIPS_sfo_1,SIPS_sfo_2,SIPS_ash_1,SIPS_ash_2 |
| dn-owner-applications | A comma-separated list of application names that can take DN ownership for a node. | The application name is sent to SIP Server as AttributeApplicationName in TRegisterClient. This name is used to identify a desktop and maintain DN ownership for remote agents. Usually, it is set to the name used by Genesys Web Services to register with SIP Server. | dn-owner-applications=Cluster |
| sipproxy-applications | A comma-separated list of all SIP Proxy application names in the cluster. | All SIP Proxy instances for all data centers. | sipproxy-applications=SIPProxy_sfo_1,SIPProxy_sfo_2,SIPProxy_ash_1,SIPProxy_ash_2 |
| service-type | sip-cluster-nodes |
Step 3: Configuring the SIP Outbound Proxy DN
[Updated]
The SIP Cluster Switch must contain one SIP Outbound Proxy DN. All SIP Server and SIP Proxy applications in the cluster use the parameters configured in this DN.
- Under the SIP Cluster Switch, create a DN of type Voice over IP Service named, for example, SIPProxy.
- In the Annex > TServer section, configure the following mandatory options:
| Name | Value | Notes | Example |
|---|---|---|---|
| contact | The SIP access point of SIP Cluster (geo-aware SRV FQDN resolved to data center's SIP Proxy instances) with reliable transport | Set this option to the Fully Qualified Domain Name (FQDN) that resolves to the SRV list of the SIP Proxy addresses. SIP Server uses this list to load-balance the traffic across all SIP Proxy instances available in a data center that is defined by geo-location. If there are multiple data centers within the cluster, this FQDN must be resolved to SIP Proxy instances located in the same data center with SIP Server, which is resolving the SRV FQDN. In other words, SIP Server must be aware only of those SIP Proxy instances installed in the same data center where SIP Server resides. It is the responsibility of the DNS to make this differentiation. This contact must be configured with the TCP transport to allow passing call attached data in SIP messages to GVP. | contact=sipx-srv.example.com;transport=tcp |
| external-contact | SIP access point of SIP Cluster (geo-aware SRV FQDN resolved to data center's SIP Proxy instances) | SIP Proxy sends the value of external-contact to its clients (e.g. GVP RM, SBC, SIP phones). SIP Cluster clients must be able to support the SRV FQDN. | external-contact=sipx-srv.example.com |
| oos-check | 10 | These two options enable active out-of-service detection. In this specific example, SIP Server is checking for SIP Proxies (by using the value of the contact option) every 10 seconds and sets them in the out-of-service state 2 seconds after the last check for which a response was not received. | |
| oos-force | 2 | ||
| service-type | sip-outbound-proxy |
Step 4: Configuring MSML DNs
[Updated]
[FDS: https://intranet.genesys.com/display/POD/GCloud+SIP+Cluster+VM+Specification]
- Create a DN of type Voice over IP Service named, for example, msml-sfo, for each data center containing contacts of all Resource Managers in the environment.
- In the Annex > TServer section, configure the following configuration options:
| Name | Value | Notes | Example |
|---|---|---|---|
| service-type | msml | ||
| contact | <RM-SRV-FQDN>;transport=tcp | The SRV FQDN resolved to a pair of A-record FQDNs or IP addresses pointing to two Resource Managers configured as an active-active HA pair which are deployed to serve a particular data center. | contact=sfosrv-rm.example.com;transport=tcp |
| geo-location | A string identifying the data center to which this DN belongs. | geo-location=sfo | |
| cpd-capability | mediaserver | ||
| make-call-rfc3725-flow | 1 | ||
| oos-check | 10 | ||
| oos-error-check | true | ||
| oos-force | 2 | ||
| prefix | msml= | ||
| refer-enabled | false | ||
| ring-tone-on-make-call | false | ||
| sip-uri-params | gvp-tenant-id=<IVR_Profile_for_DC> | SIP Server sends the name of the IVR profile to be used to Resource Manager as a parameter of the INVITE’s Request-URI header. The IVR profile will be used both for media services and recording. One IVR Profile must be created for each data center. | sip-uri-params=gvp-tenant-id=sfo-15 |
| subscription-id | Environment | ||
| userdata-map-filter | * | ||
| userdata-map-format | sip-headers-encoded |
Step 5: Configuring other DNs
[From Victor: Use Voice Profile Specification written for PEC to get examples of Trunk configuration. From the SIP Cluster VM spec take examples of:
- Trunk Group configuration created for the outbound solution
- other service DN's which are not covered here yet ]
[FDS: https://intranet.genesys.com/display/POD/How+to+configure+customer+Voice+Profile]
[From email: Here you can click through the links related to SIP Cluster:
- https://jira.genesys.com/browse/SAASNOC-39997
- https://intranet.genesys.com/display/POD/How+to+configure+DN+Extensions+for+SIP+Phones+SIP-registering+at+Genesys+Cloud+SIP+Server]
In this section, you will create the following DNs:
- Softswitch DNs if there are remote agents in your environment.
- Trunk DNs
- Extension DNs
Softswitch DNs
[Updated]
Softswitch DNs are mandatory for remote agents. Create one softswitch DN for each data center.
- Under the SIP Cluster Switch -> Tenant, create a DN of type Voice over IP Service named, for example, softswitch-sfo.
- In the Annex > TServer section, configure the following mandatory options:
| Name | Value | Example |
|---|---|---|
| contact | <SBC-FQDN or IP-address>:<AGENT-SIP-PORT> Note: The contact pointing to the SBC realm used to access PSTN agents. |
contact=sbc-example.com:5060 |
| dual-dialog-enabled | false | |
| geo-location | <A string identifying the data center to which this DN belongs> | geo-location=sfo |
| make-call-rfc3725-flow | 1 | |
| oos-check | 10 | |
| oos-force | 2 | |
| oos-options-max-forwads | true | |
| record | true | |
| refer-enabled | false | |
| service-type | softswitch | |
| sip-error-conversion | 408=486 | |
| sip-proxy-headers-enabled | false | |
| sip-ring-tone-mode | 1 |
Trunk DNs
[Updated]
- Under the SIP Cluster Switch -> Tenant, create a DN of type Trunk for each data center configured for a particular tenant.
- In the Annex > TServer section, configure the following configuration options:
| Name | Value | Notes | Example |
|---|---|---|---|
| contact | <SBC-FQDN or IP-address>:<SIP-PORT> | The contact pointing to the SBC realm. | contact=sbc-example.com:5060 |
| geo-location | A string | A string identifying the data center to which this DN belongs. | geo-location=sfo |
| dual-dialog-enabled | false | ||
| oos-check | 10 | ||
| oos-error-check | true | ||
| oos-forse | 2 | ||
| oos-options-max-forwards | 5 | ||
| prefix | This option can be used the same way as in a standard SIP Server deployment. | + | |
| priority | This option can be used the same way as in a standard SIP Server deployment. | 1 | |
| refer-enabled | false | ||
| sip-proxy-headers-enabled | false | ||
| sip-ring-tone-mode | 1 |
Routing Point DNs
Configure a DN of type Routing Point to be used for default routing in the SIP Cluster. Configure other Routing Point DNs as required for your environment.
Extension DNs for SIP phones agents
[Updated] [FDS: https://intranet.genesys.com/display/POD/How+to+configure+DN+Extensions+for+SIP+Phones+SIP-registering+at+Genesys+Cloud+SIP+Server]
- Under the SIP Cluster Switch -> Tenant, create DNs of type Extension for all SIP phones for a particular tenant.
- In the Annex > TServer section, configure the following configuration options:
| Name | Value |
|---|---|
| contact | * |
| dual-dialog-enabled | true |
| make-call-rfc3725-flow | 1 |
| refer-enabled | false |
| use-register-for-service-state | true |
| use-contact-as-dn | true |
| sip-ring-tone-mode | 1 |
| sip-cti-control | talk,hold (or talk,hold,dtmf) |
Step 6: Configuring a Switch and DNs for Virtual Queues
[Updated]
FDS: https://intranet.genesys.com/display/POD/GCloud+Voice+VM+Specification
Large contact center deployments may generate significant traffic on the Virtual Queue (VQ) DNs to satisfy complex reporting and monitoring requirements. In the SIP Cluster architecture, this traffic is isolated on a dedicated VQ switch served by several HA pairs of SIP Servers running in a non-cluster mode with one pair deployed in each data center. SIP Server instances serving the VQ switch are also used for agent reservation.
Create a Switch object of type SIP Switch dedicated for Virtual Queue DNs with the name VQ-switch. Under the VQ-switch, configure DNs of type Virtual Queue. Only DNs of this type must be configured under this VQ-switch.
You will assign this VQ Switch to a SIP Server pair dedicated to VQ DNs.