node-voicegateway-soe

Service Orchestration Engine (SOE) example for the IBM Voice Gateway (VGW) written in Node.js using the Restify REST framework. For more information and other useful examples built with Python or Java please visit:

IBM WASdev Github - The IBM WASdev Github page

What's NEW

2.2.0 - Current Release

2.2.0 : Added '/reporting' endpoint for Voice Gateway event logging (CDR, Transcriptions, Conversation) using Apache CouchDB as database backend.

2.1.0

2.1.0 : Support for multiple Watson Conversation Workspaces (multi-tenant).
2.1.0-1 : Minor changes - Code refactoring.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Docker Deployment

Please read Docker-README.md for details

Installing from sources

Prerequisites

Node.js 8.9.x

Clone the repository onto your local machine:

git clone https://github.com/rfrobisher/node-voicegateway-soe.git

Go to the node-voicegateway-soe directory and install the project dependencies with npm

cd node-voicegateway-soe
npm install

Setting your Conversation Credentials

Rename the settings.dist.json file to settings.json

mv settings.dist.json settings.json

Add your Watson Conversation credentials to settings.json file.

For a single Conversation Workspace you can define as a parameter a single tenant block, with the Conversation credentials as the example below:

    "conversation": {
        "description": "Watson Conversation credentials",
        "parameters": [
            {
                "tenantName": "<YOUR_TENANT_NAME_DESCRIPTION>",
                "workspaceID": "<YOUR_WORKSPACE_ID>",
                "username": "<YOUR_CONVERSATION_USERNAME>",
                "password": "<YOUR_CONVERSATION_PASSWORD>"
            }
    }

Instead, if your Voice Gateway comunicate against more than one Conversation Workspace, you can set as many tenant blocks inside the parameter key as you want!

    "conversation": {
        "description": "Watson Conversation credentials",
        "parameters": [
            {
                "tenantName": "<YOUR_TENANT_NAME_DESCRIPTION>",
                "workspaceID": "<YOUR_WORKSPACE_ID>",
                "username": "<YOUR_CONVERSATION_USERNAME>",
                "password": "<YOUR_CONVERSATION_PASSWORD>"
            },
            {
                "tenantName": "<YOUR_TENANT_NAME_DESCRIPTION>",
                "workspaceID": "<YOUR_WORKSPACE_ID>",
                "username": "<YOUR_CONVERSATION_USERNAME>",
                "password": "<YOUR_CONVERSATION_PASSWORD>"
            },
        ...
    }

Reporting Endpoint Configuration

By default the Voice Gateway can generate CDR, Transcriptions, and Conversation records.

For more information about setting up the Voice Gateway reporting event generation, please check:

Reporting Configuration - IBM Voice Gateway Documentation

As the SOE sits in the middle of the Voice Gateway and Watson Conversation, it can log events of both sides and send it to a remote CouchDB / CloudantDB database for storage.

Setup your CouchDB / CloudantDB parameters in ```settings.json`` file:

    "couchdb": {
        "description": "Apache CouchDB instance parameters",
        "parameters": {
            "instanceName" :"<YOUR_INSTANCE_NAME_DESCRIPTION>",
            "host": "<YOUR_COUCHDB_HOST_NAME_OR_IP>",
            "database" : "<YOUR_COUCHDB_DATABASE_NAME>",
            "protocol": "http",
            "port": "5984",
            "username": "<YOUR_COUCHDB_USERNAME>",
            "password": "<YOUR_COUCHDB_PASSWORD>"
        }
    },

Note : The SOE won't create a local DB if you set the reporting variable to true and don't add the remote database parameters in the settings.json file!

Running the Server

In the node-voicegateway-soe directory, start the server by running

npm start

Adjust the logger timezone

To change the logger timezone export TZ as your local environment variable

export TZ=<YOUR_TIMEZONE_GOES_HERE>

Built With

Restify - Restify REST Framework
Bunyan - Bunyan JSON Logging Module
PouchDB - PouchDB The database that syncs!
Watson Developer Cloud - Watson Developer Cloud Node.js SDK

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Authors

Xavier Urzúa - Initial work - rfrobisher

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Acknowledgments

IBM WASdev Github - The IBM WASdev Github page

acgrau/node-voicegateway-soe