Merge pull request #545 from Cornel777/feature/voiceHandover-dataAugmentation

8x8 Feature  Voice handover Node and Data Augmentation Node

Author: alexteusz

extensions/8x8/README.md

@@ -3,6 +3,13 @@
 ## Introduction
 This Extension integrates with the 8x8 Statistics, CRM and Schedule API's.
 
+
+## Upload extension to cognigy platform
+
+1. Run `npm run publish:local` to generate a new tar.gz archive in the target folder.
+2. Go to the Cognigy Platform > Manage Section > Extensions.
+3. Click on the big blue `+ Upload extension` button and select the zip file from the target folder.
+
 ## Connections
 
 **8x8 Connection**
@@ -13,19 +20,16 @@ To use the 8x8 extension, you need to create a connection. To do so, follow thes
 
 | Field               | Description                                                                                                                                                                                                                                                                                    |
 | ------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| crmApiUsername      | The username for 8x8's CRM API access. Check [Configure External CRM API access](https://docs.8x8.com/8x8WebHelp/VCC/configuration-manager-General/content/integrationcrmapitab.htm) for more information. |
-| crmApiPassword      | The password for 8x8's CRM API access. Check [Configure External CRM API access](https://docs.8x8.com/8x8WebHelp/VCC/configuration-manager-General/content/integrationcrmapitab.htm) for more information.|
+| apiKey      | The apiKey for 8x8's apps API access. Will be configured for the desired apps in Admin Console from an Admin's SSO panel. Contact Center Schedule, Contact Center Native CRM, Contact Center Chat Gateway and Analytics for Contact Center apps are needed for current nodes. |
 | tenantId            | The tenant ID for 8x8's Contact Center API access. Check [Generate authentication tokens for 8x8 Contact Center APIs](https://docs.8x8.com/8x8WebHelp/VCC/configuration-manager-General/content/integrationapitokentab.htm) for more information. |
-| dataRequestToken    | The data request token for 8x8's Contact Center API's limited to querying the data. Check [Generate authentication tokens for 8x8 Contact Center APIs](https://docs.8x8.com/8x8WebHelp/VCC/configuration-manager-General/content/integrationapitokentab.htm) for more information. |
-| actionRequestToken  | The action request token for 8x8's Contact Center API's that permit triggering of actions. [Check Generate authentication tokens for 8x8 Contact Center APIs](https://docs.8x8.com/8x8WebHelp/VCC/configuration-manager-General/content/integrationapitokentab.htm) for more information. |
-| clusterBaseUrl      | The cluster base URL from the Agent Workspace or CM instance (e.g. https://vcc-eu3.8x8.com). |
+| baseUrl      | The base URL from the Agent Workspace or CM instance (https://api.8x8.com). |
 
 
 ## Node: Get Customer
 
 The node allows you to collect customer information and match it with the native CRM. To use this node, you need to create an 8x8 CRM connection (refer to the Connections section for more information).
 
-The node will look up one ore more of the following case details:
+The node will look up the following case details:
 * First Name
 * Last name
 * Email
@@ -47,7 +51,7 @@ After the node configuration is completed, it will have two exit points:
 
 This node allows you to collect customer information and match it with the native CRM case.
 
-The node will look up one ore more of the following case details:
+The node will look up the following case details:
 - Case Number
 - Account Number
 - Last name of customer
@@ -71,7 +75,7 @@ After the node configuration is completed, it will have two exit points:
 This node allows you to check the condition of a queue before entering a queue. It provides a set of conditions
 which when met, will trigger specific actions. The node gives the flow much more routing flexibility by allowing testing queue status repeatedly.
 
-1. 8x8 CRM Connection - Steps for creating a connection are located inside the Connections section
+1. 8x8 Simple Connection - Steps for creating a connection are located inside the Connections section
 2. Select the queue - The dropdown will display the available queues for which you can test the conditions
 3. There are NO agents - The following options are presented when you enable the condition:
   * Available
@@ -92,20 +96,54 @@ After the node configuration is completed, test Queue will have two exit points:
 
 ## Node: Schedule
 
-This node allows you to check the state of the Contact Center schedule and route interactions accordingly.
+This node allows you to check the state of the Contact Center schedule and route interactions accordingly. 
 
 ### Setup Steps:
 
-1. 8x8 CRM Connection: The steps to create a connection can be found in the Connections section.
-2. Select the schedule: The dropdown will show the available schedules.
+1. 8x8 Simple Connection: The steps to create a connection can be found in the Connections section. 
+2. Select the schedule: The dropdown will show the available schedules. 
 
 ### Exit Points:
 
 Once the node configuration is completed, it will have 8 exit points:
-1. Schedule open: Contact Center is Open.
-2. Schedule closed: Contact Center is Closed.
-3. Choice 1 to Choice 6 Schedule: Six additional options that provide more refined choices other than Open or Closed for the day.
+1. Schedule open: Contact Center is Open. 
+2. Schedule closed: Contact Center is Closed. 
+3. Choice 1 to Choice 6 Schedule: Six additional options that provide more refined choices other than Open or Closed for the day. 
+
+
+## Node: Voice Handover
+
+This node allows you to transfer a voice interaction from inside the flow to an 8x8 VCC queue. Once reached inside the flow the node will attempt the transfer to the queue and call Id configured.
+
+### Important requirement:
+
+The customer has the sole responsability to obtain and store to context for later usage the call Id beforehand and firstly during the flow execution. This will be available inside {{input.data.payload.sip.headers["X-8x8-CID"]}}.Other properties will be available on the headers object.
+
+### Setup Steps:
+
+1. 8x8 Simple Connection - Steps for creating a connection are located inside the Connections section
+2. Handover Initiated message input - a message that will be uttered during the call when voice handover node has began execution
+3. Queue Id - id of a desired queue existing on the tenant id configured inside the connection
+4. 8x8 JSON Properties - configure the payload for the request here. Default obligatory value set as default. Values can be changed as required whilst preserving the structure and new additionalProperties objects can be added as needed.
+
+### Exit Points:
+No child nodes needed or configured for this. Failure will result in missed handover and the error message logged in Logs.
+
+## Node: Data Augmentation
 
+This node allows you to enrich/augment the additionalProperties sent and displayed to the agent upon voice interaction being served inside AW.
 
+### Important requirement:
 
+The customer has the sole responsability to obtain and store to context for later usage the call Id beforehand and firstly during the flow execution. This will be available inside {{input.data.payload.sip.headers["X-8x8-CID"]}}.Other properties will be available on the headers object.
 
+### Setup Steps:
+
+1. 8x8 Simple Connection - Steps for creating a connection are located inside the Connections section
+2. Queue Id - id of a desired queue existing on the tenant id configured inside the connection
+3. Use JSON Fields to configure payload - toggle that will switch between 5 sections with label/value input pairs for quick configuration or 8x8 Data Augmentation JSON properties JOSN input for complete control of the payload.
+4. 8x8 Data Augmentation JSON properties - configure the payload for the request here. Default model valid value set as default. Values can be changed as required whilst preserving the structure and new  objects can be added as needed.
+More info on the enpoint [8x8 Contact Center Data Augmentation API](https://support.8x8.com/contact-center/8x8-contact-center/developers/8x8_Contact_Center_Data_Augmentation_API)
+
+### Exit Points:
+No child nodes needed or configured for this. Failure will result in missed transmission and the error message logged in Logs.

extensions/8x8/package-lock.json

@@ -1,24 +1,20 @@
 {
-	"name": "8x8",
-	"version": "4.0.0",
+	"name": "8x8-cognigy-extension",
+	"version": "5.0.0",
 	"description": "Integrates with 8x8",
 	"main": "build/module.js",
 	"scripts": {
-      "transpile": "tsc -p .",
-      "lint": "eslint src/** --fix",
-      "zip": "tar cfz 8x8.tar.gz build/* package.json package-lock.json README.md icon.png",
-      "build": "npm run transpile && npm run lint && npm run zip"
-  },
+		"publish:local": "node --experimental-json-modules scripts/publish-local.mjs",
+		"build": "tsc -p .",
+		"clean": "rm -rf build",
+		"lint": "eslint src/** --fix",
+		"test": "jest --coverage",
+		"test:dev": "jest --watchAll --coverage"
+	},
 	"keywords": [
-    "8x8 Contact Center",
-    "CRM",
-    "Statistics",
-    "Schedule"
+    "8x8 Contact Center", "CRM", "Statistics", "Schedule"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Cognigy/Extensions"
-  },
+	"repository": "https://github.com/8x8/vcc-cognigy-extension",
 	"author": "8x8",
 	"license": "MIT",
 	"devDependencies": {

extensions/8x8/package.json

@@ -0,0 +1,7 @@
+import { simpleConnection } from './8x8SimpleConnection';
+
+describe('8x8SimpleConnection', () => {
+  it('should match snapshot', () => {
+    expect(simpleConnection).toMatchSnapshot();
+  });
+});

extensions/8x8/src/connections/8x8Connection.test.ts

@@ -0,0 +1,17 @@
+import type { IConnectionSchema } from '@cognigy/extension-tools';
+
+export const simpleConnection: IConnectionSchema = {
+  type: 'eightbyeightsimple',
+  label: '8x8',
+  fields: [
+    { fieldName: 'apiKey' },
+    { fieldName: 'baseUrl' },
+    { fieldName: 'tenantId' }
+  ]
+};
+
+export interface I8x8SimpleConnection {
+  apiKey: string
+  baseUrl: string
+  tenantId: string
+}

extensions/8x8/src/connections/8x8Connection.ts

@@ -0,0 +1,19 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`8x8SimpleConnection should match snapshot 1`] = `
+{
+  "fields": [
+    {
+      "fieldName": "apiKey",
+    },
+    {
+      "fieldName": "baseUrl",
+    },
+    {
+      "fieldName": "tenantId",
+    },
+  ],
+  "label": "8x8",
+  "type": "eightbyeightsimple",
+}
+`;

extensions/8x8/src/connections/8x8SimpleConnection.test.ts

@@ -1,19 +1,23 @@
 import { createExtension } from '@cognigy/extension-tools';
-import { connection } from './connections/8x8Connection';
+import { simpleConnection } from './connections/8x8SimpleConnection';
 import { getCustomerNodes } from './nodes/customer';
 import { getScheduleNodes } from './nodes/schedule';
 import { getTestConditionOfQueueNode } from './nodes/testConditionOfQueue';
 import { getCaseNodes } from './nodes/case';
+import { getVoiceHandoverNode } from './nodes/voiceHandover';
+import { getDataAugmentationNode } from './nodes/dataAugmentation';
 
 export default createExtension({
   nodes: [
     ...getCustomerNodes(),
     ...getScheduleNodes(),
     ...getTestConditionOfQueueNode(),
-    ...getCaseNodes()
+    ...getCaseNodes(),
+    ...getVoiceHandoverNode(),
+    ...getDataAugmentationNode()
   ],
   connections: [
-    connection
+    simpleConnection
   ],
   options: {
     label: '8x8'

extensions/8x8/src/connections/8x8SimpleConnection.ts

@@ -38,9 +38,9 @@ exports[`customer > getCaseNodes should create the nodes for case logic 1`] = `
     "fields": [
       {
         "key": "connection",
-        "label": "8x8 CRM Connection",
+        "label": "8x8 Connection",
         "params": {
-          "connectionType": "eightbyeight",
+          "connectionType": "eightbyeightsimple",
           "required": true,
         },
         "type": "connection",

extensions/8x8/src/connections/__snapshots__/8x8Connection.test.ts.snap

@@ -10,10 +10,9 @@ const mockAxios = axios as unknown as jest.Mock;
 describe('case > api > fetchCustomerData()', () => {
   const getMockParams = (): FetchCaseDataParams => ({
     filterXml: '<CASENUM>123123123</CASENUM>',
-    crmApiPassword: 'test-pass',
+    apiKey: 'hgs43v35y4h',
     tenantId: 'test-tenant',
-    clusterBaseUrl: 'https://8x8.com',
-    crmApiUsername: 'user'
+    baseUrl: 'https://8x8.com'
   });
 
   it('should fetch and convert xml to json', async() => {

extensions/8x8/src/connections/__snapshots__/8x8SimpleConnection.test.ts.snap

@@ -3,28 +3,23 @@ import type { CaseData } from '../types';
 import mapCaseDataXMLToJson from './utils/mapCaseDataXMLToJson';
 
 export interface FetchCaseDataParams {
+  apiKey: string
   tenantId: string
-  crmApiUsername: string
-  crmApiPassword: string
-  clusterBaseUrl: string
+  baseUrl: string
   filterXml: string
 }
 
-const fetchCaseData = async({ filterXml, crmApiPassword, tenantId, crmApiUsername, clusterBaseUrl }: FetchCaseDataParams): Promise<CaseData[]> => {
+const fetchCaseData = async({ filterXml, apiKey, tenantId, baseUrl }: FetchCaseDataParams): Promise<CaseData[]> => {
   const response = await axios({
     method: 'POST',
-    url: `${clusterBaseUrl}/WAPI/wapi.php`,
-    data: `xml_query=
-    <WAPI>
-      <TENANT>${tenantId}</TENANT>
-      <USERNAME>${crmApiUsername}</USERNAME>
-      <PASSWORD>${crmApiPassword}</PASSWORD>
-      <COMMAND OBJECT="Case" ACTION="GET">
+    url: `${baseUrl}/cc/v1/wapi`,
+    data: ` <COMMAND OBJECT="Case" ACTION="GET">
         ${filterXml}
-      </COMMAND>
-    </WAPI>`,
+      </COMMAND>`,
     headers: {
-      'Content-Type': 'application/x-www-form-urlencoded'
+      'Content-Type': 'application/xml',
+      'X-8x8-Tenant': tenantId,
+      'x-api-key': apiKey
     }
   });
   return mapCaseDataXMLToJson(response.data);

extensions/8x8/src/module.ts

@@ -63,10 +63,10 @@ export const getCaseNode = createNodeDescriptor({
   fields: [
     {
       key: 'connection',
-      label: '8x8 CRM Connection',
+      label: '8x8 Connection',
       type: 'connection',
       params: {
-        connectionType: 'eightbyeight',
+        connectionType: 'eightbyeightsimple',
         required: true
       }
     },