Saved By Dbot (ROI) Widget

Configure the Saved by Dbot ROI widget in Cortex XSOAR 6.13 with a server setting.

In the Dashboard, Incidents tab, Cortex XSOAR comes with a number of pre-installed widgets, such as Saved by DBot.

The Saved by Dbot widget calculates the amount saved in dollars according to actions carried out by all users in Cortex XSOAR across all incidents.

Note

Although the widget comes out of the box with Cortex XSOAR, you can add the Return on Investment (ROI) widget in the Widgets Library, which is identical to the Saved by Dbot widget.

The following parameters are used to calculate the amount saved by Dbot (ROI):

Parameter	Description
Man Hour	The amount in dollars of each hour for an analyst.
Roundtrip	The time it takes in minutes to run an integration task with any of the integrated products. This can be a command within a script or inside the War Room.
Report	The times it takes to write an incident report.
Script	The time it takes to undertake an action that a script would do.

The ROI is calculated as follows:

(# of times roundtrip completed * time taken to do roundtrip) + (# of times report generated * time taken to generate report) + (# of times automation run * time taken to run automation)] * cost of 1 Man hour in dollars.

'Number of times' is how many times an automated procedure has run since Cortex XSOAR was installed. If you reset the Saved by dBOT widget to 0 via the API after installation, 'number of times' is how many times an automated procedure has run since the last reset. The Saved by dBOT widget is based on absolute time and does not support date ranges.

You can change the way ROI is calculated based on your own statistics of time taken to perform the tasks for the actions when done manually. To change the statistics, select Settings → About → Troubleshooting → Add Server Configuration and add the following keys and values:

Keys	Values
ROI.Cost.ManHour	Amount in dollars. Default: 60
ROI.Time.RoundTrip	Amount in minutes (whole number). Default: 5
ROI.Time.Report	Amount in minutes (whole number). Default: 5
ROI.Time.Script	Amount in minutes (whole number). Default: 5

You can also change the currency symbol from dollars to a currency of your choice.

Customize the Currency Symbol in the Saved by Dbot Widget

The default currency symbol in the Saved by Dbot widget is the dollar sign ($). To change the currency symbol, you need to create a widget using a JSON file.

In this example, which you can use as a template, we changed the value for the currencySign argument to Euro (€).

{  
   "size":5,
   "dataType":"roi",
   "params":{  
      "currencySign":"€"
   },
   "query":"",
   "modified":"2019-01-12T15:13:09.872797+02:00",
   "shouldCommit":false,
   "name":"Return On Investment (ROI)",
   "shouldPush":false,
   "dateRange":{  
      "fromDate":"0001-01-01T00:00:00Z",
      "toDate":"0001-01-01T00:00:00Z",
      "period":{  
         "by":"",
         "byTo":"",
         "byFrom":"days",
         "toValue":null,
         "fromValue":30,
         "field":""
      }
   },
   "commitMessage":"",
   "isPredefined":true,
   "version":13,
   "id":"roi",
   "shouldPublish":false,
   "category":"others",
   "sort":null,
   "prevName":"Return On Investment (ROI)",
   "widgetType":"number"
}

Reset the ROI Widget

You can reset the contents of the Return on Investment (ROI) widget by running the following curl command.

curl --request DELETE 'https://<SERVER>:<PORT>/statistics/application/roi' \--header 'Authorization: <API_KEY>'

Note

In a multi-tenant environment, the API is only exposed on the tenant level.