/
sales_pipeline_analytics.py
293 lines (221 loc) · 9.1 KB
/
sales_pipeline_analytics.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# Copyright (c) 2013, Frappe Technologies Pvt. Ltd. and contributors
# For license information, please see license.txt
import json
from datetime import date
from itertools import groupby
import frappe
from dateutil.relativedelta import relativedelta
from frappe import _
from frappe.utils import cint, flt
from erpnext.setup.utils import get_exchange_rate
def execute(filters=None):
return SalesPipelineAnalytics(filters).run()
class SalesPipelineAnalytics(object):
def __init__(self, filters=None):
self.filters = frappe._dict(filters or {})
def run(self):
self.get_columns()
self.get_data()
self.get_chart_data()
return self.columns, self.data, None, self.chart
def get_columns(self):
self.columns = []
self.set_range_columns()
self.set_pipeline_based_on_column()
def set_range_columns(self):
based_on = {"Number": "Int", "Amount": "Currency"}[self.filters.get("based_on")]
if self.filters.get("range") == "Monthly":
month_list = self.get_month_list()
for month in month_list:
self.columns.append({"fieldname": month, "fieldtype": based_on, "label": month, "width": 200})
elif self.filters.get("range") == "Quarterly":
for quarter in range(1, 5):
self.columns.append(
{"fieldname": f"Q{quarter}", "fieldtype": based_on, "label": f"Q{quarter}", "width": 200}
)
def set_pipeline_based_on_column(self):
if self.filters.get("pipeline_by") == "Owner":
self.columns.insert(
0, {"fieldname": "opportunity_owner", "label": _("Opportunity Owner"), "width": 200}
)
elif self.filters.get("pipeline_by") == "Sales Stage":
self.columns.insert(0, {"fieldname": "sales_stage", "label": _("Sales Stage"), "width": 200})
def get_fields(self):
self.based_on = {"Owner": "_assign as opportunity_owner", "Sales Stage": "sales_stage"}[
self.filters.get("pipeline_by")
]
self.data_based_on = {
"Number": "count(name) as count",
"Amount": "opportunity_amount as amount",
}[self.filters.get("based_on")]
self.group_by_based_on = {"Owner": "_assign", "Sales Stage": "sales_stage"}[
self.filters.get("pipeline_by")
]
self.group_by_period = {
"Monthly": "month(expected_closing)",
"Quarterly": "QUARTER(expected_closing)",
}[self.filters.get("range")]
self.pipeline_by = {"Owner": "opportunity_owner", "Sales Stage": "sales_stage"}[
self.filters.get("pipeline_by")
]
self.duration = {
"Monthly": "monthname(expected_closing) as month",
"Quarterly": "QUARTER(expected_closing) as quarter",
}[self.filters.get("range")]
self.period_by = {"Monthly": "month", "Quarterly": "quarter"}[self.filters.get("range")]
def get_data(self):
self.get_fields()
if self.filters.get("based_on") == "Number":
self.query_result = frappe.db.get_list(
"Opportunity",
filters=self.get_conditions(),
fields=[self.based_on, self.data_based_on, self.duration],
group_by="{},{}".format(self.group_by_based_on, self.group_by_period),
order_by=self.group_by_period,
)
if self.filters.get("based_on") == "Amount":
self.query_result = frappe.db.get_list(
"Opportunity",
filters=self.get_conditions(),
fields=[self.based_on, self.data_based_on, self.duration, "currency"],
)
self.convert_to_base_currency()
self.grouped_data = []
grouping_key = lambda o: (o.get(self.pipeline_by) or "Not Assigned", o[self.period_by]) # noqa
for (pipeline_by, period_by), rows in groupby(self.query_result, grouping_key):
self.grouped_data.append(
{
self.pipeline_by: pipeline_by,
self.period_by: period_by,
"amount": sum(flt(r["amount"]) for r in rows),
}
)
self.query_result = self.grouped_data
self.get_periodic_data()
self.append_data(self.pipeline_by, self.period_by)
def get_conditions(self):
conditions = []
if self.filters.get("opportunity_source"):
conditions.append({"source": self.filters.get("opportunity_source")})
if self.filters.get("opportunity_type"):
conditions.append({"opportunity_type": self.filters.get("opportunity_type")})
if self.filters.get("status"):
conditions.append({"status": self.filters.get("status")})
if self.filters.get("company"):
conditions.append({"company": self.filters.get("company")})
if self.filters.get("from_date") and self.filters.get("to_date"):
conditions.append(
["expected_closing", "between", [self.filters.get("from_date"), self.filters.get("to_date")]]
)
return conditions
def get_chart_data(self):
labels = []
datasets = []
self.append_to_dataset(datasets)
for column in self.columns:
if column["fieldname"] != "opportunity_owner" and column["fieldname"] != "sales_stage":
labels.append(column["fieldname"])
self.chart = {"data": {"labels": labels, "datasets": datasets}, "type": "line"}
return self.chart
def get_periodic_data(self):
self.periodic_data = frappe._dict()
based_on = {"Number": "count", "Amount": "amount"}[self.filters.get("based_on")]
pipeline_by = {"Owner": "opportunity_owner", "Sales Stage": "sales_stage"}[
self.filters.get("pipeline_by")
]
frequency = {"Monthly": "month", "Quarterly": "quarter"}[self.filters.get("range")]
for info in self.query_result:
if self.filters.get("range") == "Monthly":
period = info.get(frequency)
if self.filters.get("range") == "Quarterly":
period = f'Q{cint(info.get("quarter"))}'
value = info.get(pipeline_by)
count_or_amount = info.get(based_on)
if self.filters.get("pipeline_by") == "Owner":
if value == "Not Assigned" or value == "[]" or value is None:
assigned_to = ["Not Assigned"]
else:
assigned_to = json.loads(value)
self.check_for_assigned_to(period, value, count_or_amount, assigned_to, info)
else:
self.set_formatted_data(period, value, count_or_amount, None)
def set_formatted_data(self, period, value, count_or_amount, assigned_to):
if assigned_to:
if len(assigned_to) > 1:
if self.filters.get("assigned_to"):
for user in assigned_to:
if self.filters.get("assigned_to") == user:
value = user
self.periodic_data.setdefault(value, frappe._dict()).setdefault(period, 0)
self.periodic_data[value][period] += count_or_amount
else:
for user in assigned_to:
value = user
self.periodic_data.setdefault(value, frappe._dict()).setdefault(period, 0)
self.periodic_data[value][period] += count_or_amount
else:
value = assigned_to[0]
self.periodic_data.setdefault(value, frappe._dict()).setdefault(period, 0)
self.periodic_data[value][period] += count_or_amount
else:
self.periodic_data.setdefault(value, frappe._dict()).setdefault(period, 0)
self.periodic_data[value][period] += count_or_amount
def check_for_assigned_to(self, period, value, count_or_amount, assigned_to, info):
if self.filters.get("assigned_to"):
for data in json.loads(info.get("opportunity_owner") or "[]"):
if data == self.filters.get("assigned_to"):
self.set_formatted_data(period, data, count_or_amount, assigned_to)
else:
self.set_formatted_data(period, value, count_or_amount, assigned_to)
def get_month_list(self):
month_list = []
current_date = date.today()
month_number = date.today().month
for month in range(month_number, 13):
month_list.append(current_date.strftime("%B"))
current_date = current_date + relativedelta(months=1)
return month_list
def append_to_dataset(self, datasets):
range_by = {"Monthly": "month", "Quarterly": "quarter"}[self.filters.get("range")]
based_on = {"Amount": "amount", "Number": "count"}[self.filters.get("based_on")]
if self.filters.get("range") == "Quarterly":
frequency_list = [1, 2, 3, 4]
count = [0] * 4
if self.filters.get("range") == "Monthly":
frequency_list = self.get_month_list()
count = [0] * 12
for info in self.query_result:
for i in range(len(frequency_list)):
if info[range_by] == frequency_list[i]:
count[i] = count[i] + info[based_on]
datasets.append({"name": based_on, "values": count})
def append_data(self, pipeline_by, period_by):
self.data = []
for pipeline, period_data in self.periodic_data.items():
row = {pipeline_by: pipeline}
for info in self.query_result:
if self.filters.get("range") == "Monthly":
period = info.get(period_by)
if self.filters.get("range") == "Quarterly":
period = f"Q{cint(info.get(period_by))}"
count = period_data.get(period, 0.0)
row[period] = count
self.data.append(row)
def get_default_currency(self):
company = self.filters.get("company")
return frappe.db.get_value("Company", company, ["default_currency"])
def get_currency_rate(self, from_currency, to_currency):
cacheobj = frappe.cache()
if cacheobj.get(from_currency):
return flt(str(cacheobj.get(from_currency), "UTF-8"))
else:
value = get_exchange_rate(from_currency, to_currency)
cacheobj.set(from_currency, value)
return flt(str(cacheobj.get(from_currency), "UTF-8"))
def convert_to_base_currency(self):
default_currency = self.get_default_currency()
for data in self.query_result:
if data.get("currency") != default_currency:
opportunity_currency = data.get("currency")
value = self.get_currency_rate(opportunity_currency, default_currency)
data["amount"] = data["amount"] * value