Saved By Dbot (ROI) Widget - Administrator Guide - 8.5 - Cortex XSOAR - Cortex - Security Operations

Cortex XSOAR On-prem Documentation

Product
Cortex XSOAR
Version
8.5
Creation date
2024-03-10
Last date published
2024-11-28
Category
Administrator Guide
Solution
On-prem
Abstract

Customize the Saved by Dbot widget that calculates the amount saved by Cortex XSOAR. Return on Investment (ROI) widget.

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

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

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 (ROI) Widget.

Note

The widget is disabled by default, as enabling it may affect performance when running large amounts of automations. To enable the widget, contact Customer Support.

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 script runs * time taken to run script)] * cost of 1 Man hour in dollars.

The time to run an integration task with any integrated product, the time to generate a report, and the time to run an automated action are set to 5 minutes.

'Number of times' is how many times an automated procedure has run since Cortex XSOAR was first used. 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 & InfoSettingsSystemServer SettingsServer Configuration+ Add Server Configuration and add the following :

Keys

Values

roi.cost.manhour

Amount in Dollars. Default: 60

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

Customize the currency symbol in the saved by Dbot (ROI) 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. For more details, see 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"
}