Contents
- 1 Configuring Switch and DN Objects for SIP Cluster
- 1.1 Step 1: Configuring a SIP Cluster Switch
- 1.2 Step 2: Configuring the Cluster Node DN
- 1.3 Step 3: Configuring the SIP Outbound Proxy DN
- 1.4 Step 4: Configuring dial-plan DNs
- 1.5 Step 5: Configuring Voicemail DNs
- 1.6 Step 6: Configuring MSML DNs
- 1.7 Step 7: Configuring other DNs
- 1.8 Step 8: Configuring Switch and DNs for Virtual Queues
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. Under the SIP Cluster Switch, you will configure the following DN types, as described below:
- Voice over IP Service [to add links to the DNs]
- Trunk
- Trunk Group
- 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-DN. AF:Let's use name with underscore "_" consistently for all APP DN names
- In the Options > 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 for all data centers. | applications=SIPS_usw1_1,SIPS_usw1_2,SIPS_aps2_1,SIPS_aps2_2AF:we need to decide and consistently use naming in the examples either:
SIPS_sfo_1 or SIPS_usw_1 |
| 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=Cloud |
| 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_usw1_1,SIPProxy_usw1_2,SIPProxy_aps2_1,SIPProxy_aps2_2 |
| service-type | sip-cluster-nodes |
Step 3: Configuring the SIP Outbound Proxy DN
[Updated]
The 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, SIP-Proxy-DN.
- In the Options > 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 regional 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 region 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=srv-10-sip.geo.gen.com;transport=tcp |
| external-contact | SIP access point of SIP Cluster (geo-aware SRV FQDN resolved to regional 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=srv-10-sip.geo.gen.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 dial-plan DNs
[Updated]
The Cluster Switch might contain one or more dial-plan DNs. A typical Cluster deployment will have one dial-plan DN configured for each data center.
- Under the SIP Cluster Switch, create a DN of type Voice over IP Service named, for example, Dial-Plan-DN-SFO.
- In the Options > TServer section, configure the following mandatory options:
| Name | Value | Notes | Example |
|---|---|---|---|
| url | A URL of a local SIP Feature Server | Set this option to the URL for the local SIP Feature Server in this data center. If there is more than one SIP Feature Server in the data center, create as many url options as needed to accommodate all of their addresses in one DN. The first option must always be named url. All consecutive options must be named url-<n> (see url-1 below). AF: let's add another table row for the option url-1. At least two FS instances are recommended. Let's move explanation/note to url-1 that url-n options can be configured depending on number of deployed FS |
url=http://usw-150-001.usw.gen.com:8800/ |
| url-1 | A URL of the second SIP Feature Server | Set this option to the URL for the second SIP Feature Server in this data center if there is more than one SIP Feature Server in the data center. | url-1=http://usw150-002.usw.gen.com:8800/ |
| geo-location | A string | A string identifying the data center to which this DN belongs. | geo-location=SFO |
| service-type | feature-server (confirmed with A.F.) |
Step 5: Configuring Voicemail DNs
[Updated]
- Under the SIP Cluster Switch, create a DN of type Voice over IP Service with the same name as the configured DID. Create one DN for each data center.
- In the Options > TServer section, configure the following options:
| Name | Value | Notes | Example |
|---|---|---|---|
| contact | ::msml | ||
| geo-location | A string | A string identifying the data center to which this DN belongs. | geo-location=SFO |
| service-type | voicemail |
Step 6: 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 Options > 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 region. | contact=usw1srv-150-rm.gen.com;transport=tcp |
| geo-location | A string | 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 per data center must be created. | sip-uri-params=gvp-tenant-id=us-west-14 |
| subscription-id | Environment | ||
| userdata-map-filter | * | ||
| userdata-map-format | sip-headers-encoded |
AF:We need to add: sip-uri-params=“gvp-tenant-id=<IVR_Profile_for_DC>” SIP Server sends the name of the IVR profile to be used to RM as a parameter of the INVITE’s Request URI header. IVR profile will be used both for media services and recording. One IVR Profile per data center should be created. //https://intranet.genesys.com/display/POD/Cluster+Microsoft+VM+Specification//
Step 7: 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 Group DNs
- Trunk DNs
- Extension DNs
Softswitch DNs
[NEW]
Softswitch DNs are mandatory for remote agents. Create one softswitch DN for each regionAF:data center.
- Under the SIP Cluster Switch -> Tenant, create a DN of type Voice over IP Service named, for example, Softswitch-SFO.
- In the Options > TServer section, configure the following mandatory options:
| Name | Value | Notes | Example | |
|---|---|---|---|---|
| contact | <SBC-AREC-FQDN or IP-address>:<AGENT-SIP-PORT> | The contact points to the SBC realm used to access PSTN agents. | contact=svoice-55-00-p.gen.com:5060 | |
| dual-dialog-enabled | false | |||
| geo-location | A string | 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 Group DNs
[NEW]
- Under the SIP Cluster Switch -> Tenant, create a DN of type Trunk Group for each data center configured for a particular tenant. For example, in the Standard Plus architecture, one HA pair of SIP Servers work with two data centers, therefore, two Trunk Group DNs must be created.
- In the Options > TServer section, configure the following configuration options:
| Name | Value | Notes | Example |
|---|---|---|---|
| contact | ::msml | ||
| geo-location | A string | A string identifying the data center to which this DN belongs. | geo-location=SFO |
| cpd-capability | mediaserver | ||
| make-call-rfc3725-flow | 1 | ||
| refer-enabled | false | ||
| request-uri-contact | true | [The option is in the config, but not in the VM spec] | |
| request-uri | sip:msml@<RM-SRV-FQDN>;gvp-tenant-id=Environment | sip:msml@aps2srv-000-rm.aps2.gen.com;gvp-tenant-id=Environment | |
| ring-tone-on-make-call | false | ||
| subscription-id | Environment |
Trunk Group DN for OCS
For all Trunk Group DNs used by Outbound Contact Server (OCS), the following options must be configured for Trunk Group DN objects:
- In the OCServer section; only one Trunk Group DN must be created with this option for each region configured for a particular tenant.
| Name | Value | Note |
|---|---|---|
| outbound_contact_server | true | Enables a Trunk Group DN for use by OCS. |
- In the TServer section.
| Name | Value | Note |
|---|---|---|
| geo-location | A string | A string identifying the data center to which this DN belongs. |
Trunk DNs
[NEW]
- Under the SIP Cluster Switch -> Tenant, create a DN of type Trunk for each data center configured for a particular tenant.
- In the Options > TServer section, configure the following configuration options:
| Name | Value | Notes | Example |
|---|---|---|---|
| contact | <SBC-AREC-FQDN or IP-address>:<SIP-PORT> | The contact points to the SBC realm | contact=svoice-55-00-p.gen.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 | + | ||
| priority | 1 | ||
| refer-enabled | false | ||
| sip-proxy-headers-enabled | false | ||
| sip-ring-tone-mode | 1 |
Extension DNs
[NEW]
- Under the SIP Cluster Switch -> Tenant, create a DN of type Trunk for each data center configured for a particular tenant.
- In the Options > 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 |
Provisioning of DN Extensions for SIP Phones
[Do we need this?]
There is no automated procedure to populate Annex of DN Extensions. The following procedure is recommended to populate Annex options in all selected DNs:
- Populate DN Extensions automatically using Agent or Place provisioning scripts. [Question: do we provide them to customers?]
- Compile the list of relevant Annex options according to the checklist above.
- Log in to GAX or Configuration Manager.
- Locate the target Folder with DN Extensions for your environment on the primary Switch object.
- Create the DN Extension with the name "<folder name>_Sample". This DN will be used by customer Administrators as a template to copy DN Annex settings for all manually created DNs.
- Select all DNs in the Folder (Shift+Left Click)
- Right-click with the mouse and select Manage Options.
- Click the Add tab.
- Click Modify Annex.
- Add the TServer section and all necessary options per the checklist above.
- Click Next.
- Click Execute.
- Repeat steps 4-12 in all target DN Folder on the primary Switch only. Synchronization process will transfer these settings to all secondary Switches.
Step 8: Configuring Switch and DNs for Virtual Queues
[NEW]
Virtual Queue (VQ) Switch with VQ DNs in the SIP Cluster offer a distributed agent reservation solution for a blended environment (voice and multimedia), and significantly improve performance by offloading VQ(?) traffic in the SIP Cluster.
Create a Switch object of type SIP Switch dedicated for Virtual Queue DNs with the name, for example, 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.