WikiSysop at 16:16, September 29, 2022

2022-09-29T16:16:48Z

Julie.munn@genesys.com: Published

2021-10-29T17:44:25Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Enable a tenant for Digital Channels
|Context=Learn how to enable your tenant for Digital Channels.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|“Nexus” is the simplified name we use for the Digital Channels application and nodes, so you’ll see that name referenced throughout this document.|}}Complete the steps on this page to provision your tenant and set up Digital Channels to work with Web Services and Applications (GWS).
<div class="pdf-table-landscape">
===Prerequisites===
Review the '''Prerequisites''' table and make sure you have all the listed information before you get started. The values in this table are referenced later by the name in the Variable column.
{{{!}} class="wikitable"
{{!}}+Prerequisites
!Parameter
!Variable
!Type
!Example
!Notes
{{!}}-
{{!}}GWS URL
{{!}}$gwsURL
{{!}}HTTPS URL string
{{!}}<nowiki>https://gws.mydomain.com</nowiki>
{{!}}Host of the Web Services and Applications load balancer.
{{!}}-
{{!}}Auth URL
{{!}}$authURL
{{!}}HTTPS URL string
{{!}}https://auth.mydomain.com
{{!}}Host of the Auth Services load balancer.
{{!}}-
{{!}}GWS admin username
{{!}}$gwsAdminName
{{!}}string
{{!}}ops
{{!}}The GWS ops credentials. See {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Provision}}.
{{!}}-
{{!}}GWS admin password
{{!}}$gwsAdminPass
{{!}}string
{{!}}ops
{{!}}The GWS ops credentials. See {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Provision}}.
{{!}}-
{{!}}Tenant User
{{!}}$tenantUser
{{!}}string
{{!}}nexus
{{!}}The Person username from your tenant configuration. See {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=PreConfig|anchor=person|display text=Create a Person object}}.
{{!}}-
{{!}}Tenant User Password
{{!}}$tenantUserPassword
{{!}}string
{{!}}nexus_password
{{!}}The Person password from your tenant configuration. See {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=PreConfig|anchor=person|display text=Create a Person object}}.
{{!}}-
{{!}}Contact Center ID
{{!}}$ccId
{{!}}string
{{!}}578ec98e-f07c-46ad-9675-f36c22f3ba9f
{{!}}The contact center ID provisioned in Web Services and Applications. If you don't have this ID, see {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=EnableTenant|anchor=ccid|display text=Get contact center ID from GWS}} below.
{{!}}-
{{!}}Tenant Name
{{!}}$tenantName
{{!}}string
{{!}}premise_tenant
{{!}}The tenant name you used as <$tenantName/$ccId> in the {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=PreConfig|anchor=configgws|display text=Enable Nexus UX}} step.
{{!}}-
{{!}}Digital Channels FQDN URL
{{!}}$nexusURL
{{!}}HTTPS URL string
{{!}}<nowiki>https://nexus.mydomain.com</nowiki>
{{!}}The fully qualified domain name (FQDN) for Digital Channels.
{{!}}-
{{!}}UCS URL
{{!}}$ucsURL
{{!}}HTTPS URL string
{{!}}[https://ucsx.mydomain.com/ https://ucs.mydomain.com]
{{!}}A URL pointing on the Universal Contact Service (UCS) entry point.
{{!}}}</div>
{{NoteFormat|Use a REST client or curl utility to make the requests explained on this page. Make sure to substitute the variables - prefixed with '$' - with their values.|}}
|Status=No
}}{{Section
|sectionHeading=Get contact center ID from GWS
|anchor=ccid
|alignment=Vertical
|structuredtext=If you don't have the contact center ID (as specified in the '''Prerequisites''' table above), you can get it with the following request:<syntaxhighlight lang="json">
curl --user $gwsAdminName:$gwsAdminPass --request GET '$authURL/environment/v3/contact-centers'
</syntaxhighlight>The expected response:<syntaxhighlight lang="json">
{
"data": {
"contactCenters": [
{
"id": "<your contact center id ($ccId)>",
"environmentId": "<your environment id>",
"domains": [
<list of domains for your contact center>
],
"auth": "configServer"
}
]
}
}
</syntaxhighlight>
|Status=No
}}{{Section
|sectionHeading=Add GWS to the list of available GWS services for Nexus
|anchor=gws
|alignment=Vertical
|structuredtext=Complete the steps in this section to add GWS to the list of available GWS services for Nexus.
===Create the authentication client===
To create the authentication client, send a POST request to GWS that includes a body parameter called '''data''' in JSON format. Give '''data''' the following properties:
{{{!}}
!Property
!Value
{{!}}-
{{!}}clientType
{{!}}CONFIDENTIAL
{{!}}-
{{!}}internalClient
{{!}}true
{{!}}-
{{!}}authorizedGrantTypes
{{!}}refresh_token, password, client_credentials, authorization_code
{{!}}-
{{!}}redirectURIs
{{!}}$nexusURL
{{!}}-
{{!}}authorities
{{!}}ROLE_INTERNAL_CLIENT
{{!}}-
{{!}}scope
{{!}}*
{{!}}-
{{!}}description
{{!}}nexus_client
{{!}}-
{{!}}name
{{!}}nexus_client
{{!}}-
{{!}}client_id
{{!}}nexus_client
{{!}}-
{{!}}client_secret
{{!}}<client secret token> - randomly generated and saved for further use
{{!}}-
{{!}}accessTokenExpirationTimeout
{{!}}43200
{{!}}-
{{!}}refreshTokenExpirationTimeout
{{!}}2592000
{{!}}}
<div class="pdf-table-landscape">
====Sample request====
<syntaxhighlight lang="json">
curl --user $gwsAdminName:$gwsAdminPass --request POST '$authURL/auth/v3/ops/clients' \
--header 'Content-Type: application/json' \
--data '{"data": {
"internalClient": true,
"name": "nexus_client",
"clientType": "CONFIDENTIAL",
"client_id": "nexus_client",
"client_secret": "<client secret token>",
"authorities": ["ROLE_INTERNAL_CLIENT"],
"scope": ["*"],
"authorizedGrantTypes": ["client_credentials", "authorization_code", "refresh_token", "implicit", "password"],
"redirectURIs": ["$nexusURL"],
"accessTokenExpirationTimeout": 43200,
"refreshTokenExpirationTimeout": 2592000
}
}'
</syntaxhighlight></div>

====Expected response====
The expected response is '''200 OK'''.
<div class="pdf-table-landscape">
===Verify client===
To verify that authentication was successful, send a POST request to GWS:
<syntaxhighlight>
curl --user nexus_client:<client secret token> \
--request POST '$authURL/auth/v3/oauth/token?grant_type=client_credentials&scope=*&client_id=nexus_client&client_secret=<client secret token>'
</syntaxhighlight>This is the response:<syntaxhighlight>
{"access_token":"<bearer token>","token_type":"bearer","expires_in":43199,"scope":"*"}
</syntaxhighlight>

===Add GWS to the nex_gapis table for Nexus===

Execute the following query in the PostgreSQL command line interface:
<syntaxhighlight lang="postgres">
INSERT INTO nex_gapis (url, clientid, apikey, clientsecret, created, region, authinturl, authexturl) VALUES ('$gwsURL', 'nexus_client', 'NA', '<client secret token>', now(), NULL, '$authURL', '$authURL');

</syntaxhighlight></div>
|Status=No
}}{{Section
|sectionHeading=Provision Digital Channels in GWS
|anchor=provisionDC
|alignment=Vertical
|structuredtext=To provision Digital Channels in GWS, send a POST request to GWS:<syntaxhighlight>
curl --user $gwsAdminName:$gwsAdminPass --request POST '$authURL/environment/v3/contact-centers/$ccId/settings' \
--header 'Content-Type: application/json' \
--data '{
"data":
{
"name":"chatservice-uri",
"location":"/",
"value":"$nexusURL",
"shared":false
}
}
</syntaxhighlight><br />
|Status=No
}}{{Section
|sectionHeading=Get the authentication token
|anchor=authtoken
|alignment=Vertical
|structuredtext=To get the authentication token, send a POST request to GWS:<syntaxhighlight>
curl --user nexus_client:<client secret token> --request POST '$authURL/auth/v3/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=$ccId\\$tenantUser' \
--data-urlencode 'client_id=nexus_client' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'password=$tenantUserPassword'
</syntaxhighlight>The expected response:
<syntaxhighlight>
{"access_token":"<$outGWSAccessToken>","token_type":"bearer","refresh_token":"<refresh_token>","expires_in":43199,"scope":"*"}

</syntaxhighlight>
As an output of this step, you will have the GWS access token:
{{{!}} class="wikitable"
{{!}}+
!Parameter
!Variable
!Type
!Example
!Notes
{{!}}-
{{!}}Nexus API Key
{{!}}$outGWSAccessToken
{{!}}UUID string
{{!}}9b7682b7-cbce-422f-9bbb-ecda85e61695
{{!}}The access_token from the response example.
{{!}}}
|Status=No
}}{{Section
|sectionHeading=Provision the Universal Contact Service connection
|anchor=ucs
|alignment=Vertical
|structuredtext=You must complete this step if you are using {{Link-AnywhereElse|product=UCS|version=Current|manual=UCSPEGuide|display text=Universal Contact Service}} in your environment.

Make the following POST request to create the PlatformUCS service:
curl -X POST \
$nexusURL/nexus/v3/provisioning/services/$ccid/PlatformUCS \
-H 'Content-Type: application/json' \
-H 'x-api-key: $apiKey' \
-H 'x-ccid: $ccid' \
-d '{
"url" : "$ucsURL",
"secret": {},
"data" : {}
}'
|Status=No
}}{{Section
|sectionHeading=Provision the tenant in Digital Channels
|anchor=provisiontenant
|alignment=Vertical
|structuredtext=To provision the tenant in Digital Channels, make the following POST request:<syntaxhighlight>
curl --request POST '$nexusURL/nexus/v3/provisioning/tenants' \
--header 'Authorization: Bearer $outGWSAccessToken' \
--header 'Content-Type: application/json' \
--data '{
"id": "$ccId",
"name": "$tenantName",
"type": "PureEngage",
"backendurl": "$gwsURL",
"username": "$tenantUser",
"token": "$tenantUserPassword",
"genesystenantid": 1
}'
</syntaxhighlight>
The expected response:
<syntaxhighlight lang="json">
{
"status": {
"code": 0
},
"data": {
"xapikey": "$nexusApiKey"
},
"operationId": "ec90f3d2-f4b5-47fd-9004-2c309398ab38"
}</syntaxhighlight>As an output of this step, you will have the specific tenant API key:
{{{!}} class="wikitable"
{{!}}+
!Parameter
!Variable
!Type
!Example
!Notes
{{!}}-
{{!}}Nexus API Key
{{!}}$nexusApiKey
{{!}}UUID string
{{!}}9b7682b7-cbce-422f-9bbb-ecda85e61695
{{!}}The '''xapikey''' from the response example. For creating chat.
{{!}}}
|Status=No
}}{{Section
|sectionHeading=Enable routing using Designer Applications
|anchor=routing
|alignment=Vertical
|structuredtext=Use Agent Setup to {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Transactions|display text=add the following values}} to the "DesignerEnv" transaction in the Environment tenant. If the transaction doesn't exist, create it with a type of List and "DesignerEnv" as Name and Alias.
{{{!}} class="wikitable"
!Property
!Value
{{!}}-
{{!}}baseurl
{{!}}<Nexus FQDN URL>/nexus/v1
{{!}}-
{{!}}password
{{!}}<consumer api-key>
{{!}}-
{{!}}url
{{!}}<Nexus FQDN url>/nexus/v3
{{!}}}
|Status=No
}}
}}

@@ Line 153: / Line 153: @@
 ====Sample request====
 <syntaxhighlight lang="json">
-curl --user $gwsAdminName:$gwsAdminPass --request POST '$authURL/auth/v3/ops/clients' \
+curl --user ops:ops --request POST '$gwsURL' \
 --header 'Content-Type: application/json' \
 --data '{"data": {
@@ Line 169: / Line 169: @@
+     }
 }'
-</syntaxhighlight></div>
+</syntaxhighlight>In the above example, the <code>ops:ops</code> GWS superuser is different for your environment.
 ====Expected response====
@@ Line 187: / Line 188: @@
 Execute the following query in the PostgreSQL command line interface:
 <syntaxhighlight lang="postgres">
-INSERT INTO nex_gapis (url, clientid, apikey, clientsecret, created, region, authinturl, authexturl) VALUES ('$gwsURL', 'nexus_client', 'NA', '<client secret token>', now(), NULL, '$authURL', '$authURL');
+NSERT INTO nex_gapis (url, clientid, apikey, clientsecret, created) VALUES ('$gwsURL', 'nexus_client', 'NA', '<client secret token>', now());
 </syntaxhighlight></div>
 |Status=No

PEC-DC/Current/DCPEGuide/EnableTenant - Revision history

WikiSysop at 16:16, September 29, 2022

Julie.munn@genesys.com: Published