Add work state to ticket report

README.MD

@@ -80,7 +80,7 @@ nodeSDK.start().then( () => {
         done();
     }, this);
 
-    chatbot.onTicket((tag, history, from, start, end) => {
+    chatbot.onTicket((tag, history, from, start, end, state) => {
         // Do something when a user has completed a scenario
         ...
     }, this);
@@ -281,15 +281,15 @@ In that sample, depending on the step, the user and the answer received, a rerou
 
 ### Tickets reporting
 
-Each time a user has finished a scenario, a ticket is generated that contains all inputs received from that user associated with all actions done.
+Each time a user has finished a scenario or has exited a scenario, a ticket is generated that contains all inputs received from that user associated with all actions done.
 
 #### Listening to tickets
 
 If you want to listen to tickets generated, you have to add the following code:
 
 ```js
 
-chatbot.onTicket((tag, history, from, startdate, enddate) => {
+chatbot.onTicket((tag, history, from, startdate, enddate, state) => {
     // Do something with the ticket
     ...
 }, this);
@@ -308,6 +308,8 @@ This callback will receive:
 
 - `enddate`: The date when the scenario has finished for this user
 
+- `state`: The state of the ticket. The possible values are `CLOSED` when the scenario has been finished successfully or `ABORTED` if the scenario didn't reach the last step.
+
 #### Tickets storage
 
 It's up to your application to store tickets. Once generated, tickets are not saved by the chatbot. If you don't catch them and store them, tickets will be lost.

index.js

@@ -61,7 +61,7 @@ class RainbowAgent {
     disable() {
         this._isEnabled = false;
         this.logger.log("warn", LOG_ID + "disable() - Mode is disabled");
-        this.works.reset();
+        this.works.purge();
     }
 
     get state() {
@@ -130,7 +130,7 @@ class RainbowAgent {
     }
 
     fireTicketEvent(work) {
-        this._callbackTicket.call(this._contextTicket, work.tag, work.history, work.from, work.createdOn, work.endedOn);
+        this._callbackTicket.call(this._contextTicket, work.tag, work.history, work.from, work.createdOn, work.endedOn, work.state);
     }
 
     addPostListener() {

modules/works.js

@@ -52,10 +52,17 @@ class Works {
         });
     }
 
-    reset() {
+    purge() {
         this._works.forEach((work) => {
-            work.abort();
-            this._event.emit("ontaskfinished", work);
+            // purge opened tickets from the base when chatbot is stopped
+            if( work.state === Work.STATE.INPROGRESS ||
+                work.state === Work.STATE.NEW ||
+                work.state === Work.STATE.BLOCKED ||
+                work.state === Work.STATE.TERMINATED) {
+
+                work.abort();
+                this._event.emit("ontaskfinished", work);
+            }
         });
     }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rainbow-chatbot",
-  "version": "1.34.3",
+  "version": "1.34.4",
   "description": "Rainbow ChatBot library for the Rainbow SDK for Node.JS",
   "main": "index.js",
   "scripts": {

samples/sample_message.js

@@ -28,8 +28,8 @@ nodeSDK.start().then( () => {
         }
     }, this);
 
-    chatbot.onTicket((tag, history, from, start, end) => {
-        console.log("::: On ticket>", tag, history, from, start, end);
+    chatbot.onTicket((tag, history, from, start, end, state) => {
+        console.log("::: On ticket>", tag, history, from, start, end, state);
     }, this);
 });