develop: progress tax detail report

This commit is contained in:
Richard Case 2021-03-14 06:05:02 +00:00 committed by casesolved-co-uk
parent a5d47f70b8
commit ef8ab135c9
2 changed files with 224 additions and 120 deletions

View File

@ -29,11 +29,28 @@ frappe.query_reports["Tax Detail"] = {
reqd: 1, reqd: 1,
width: "60px" width: "60px"
}, },
{
fieldname: "report_name",
label: __("Report Name"),
fieldtype: "Read Only",
default: frappe.query_report.report_name,
hidden: 1,
reqd: 1
},
{
fieldname: "mode",
label: __("Mode"),
fieldtype: "Read Only",
default: "run",
hidden: 1,
reqd: 1
}
], ],
onload: function onload(report) { onload: function onload(report) {
// Remove Add Column and Save from menu // Remove Add Column and Save from menu
report.page.add_inner_button(__("New Report"), () => new_report, __("Custom Report")); report.page.add_inner_button(__("New Report"), () => new_report(), __("Custom Report"));
report.page.add_inner_button(__("Load Report"), () => load_report, __("Custom Report")); report.page.add_inner_button(__("Load Report"), () => load_report(), __("Custom Report"));
hide_filters();
}, },
after_datatable_render: (datatable) => { after_datatable_render: (datatable) => {
if (frappe.query_report.report_name == 'Tax Detail') { if (frappe.query_report.report_name == 'Tax Detail') {
@ -47,65 +64,83 @@ frappe.query_reports["Tax Detail"] = {
} }
}; };
function hide_filters() {
frappe.query_report.page.page_form[0].querySelectorAll('.form-group.frappe-control').forEach(function setHidden(field) {
if (field.dataset.fieldtype == "Read Only") {
field.classList.add("hidden");
}
});
}
class TaxReport { class TaxReport {
// construct after datatable is loaded // construct after datatable is loaded
constructor() { constructor() {
this.report = frappe.query_reports["Tax Detail"];
this.qr = frappe.query_report; this.qr = frappe.query_report;
this.page = frappe.query_report.page; this.page = frappe.query_report.page;
this.create_controls(); this.create_controls();
this.sections = {};
this.mode = 'run';
this.load_report(); this.load_report();
} }
load_report() { load_report() {
// TODO if (this.loaded) {
this.setup_menu(); return;
// this.qr.refresh_report() }
} const report_name = this.qr.report_name;
setup_menu() { this.report_name.value = report_name;
this.qr.menu_items.forEach((item, idx) => {
if (item['label'] == __('Save')) {
delete this.qr.menu_items[idx];
}
})
this.qr.menu_items.push({
label: __('Save'),
action: this.save_report
})
this.qr.set_menu_items();
}
save_report() {
// TODO
frappe.call({ frappe.call({
method:'erpnext.accounts.report.tax_detail.tax_detail.new_custom_report', method: 'erpnext.accounts.report.tax_detail.tax_detail.get_custom_reports',
args: {'name': values.report_name}, args: {name: report_name},
freeze: true freeze: true
}).then((r) => { }).then((r) => {
frappe.set_route("query-report", values.report_name); const data = JSON.parse(r.message[report_name]['json']);
if (data && data['sections']) {
this.sections = data['sections'];
} else {
this.sections = {};
}
this.set_section();
})
this.loaded = 1;
}
save_report() {
frappe.call({
method:'erpnext.accounts.report.tax_detail.tax_detail.save_custom_report',
args: {
reference_report: 'Tax Detail',
report_name: this.qr.report_name,
columns: this.qr.get_visible_columns(),
sections: this.sections
},
freeze: true
}).then((r) => {
this.reload();
}); });
} }
set_value_options() { set_value_options() {
let curcols = []; this.fieldname_lookup = {};
let options = []; this.label_lookup = {};
this.qr.columns.forEach((col, index) => { this.qr.columns.forEach((col, index) => {
if (col['fieldtype'] == "Currency") { if (col['fieldtype'] == "Currency") {
curcols.push(index); this.fieldname_lookup[col['label']] = col['fieldname'];
options.push(col['label']); this.label_lookup[col['fieldname']] = col['label'];
} }
}); });
this.currency_cols = curcols; const options = Object.keys(this.fieldname_lookup);
this.controls['value_field'].$wrapper.find("select").empty().add_options(options); this.controls['value_field'].$wrapper.find("select").empty().add_options(options);
this.controls['value_field'].set_input(options[0]); this.controls['value_field'].set_input(options[0]);
} }
add_value_field_to_filters(filters) { set_value_label_from_filter() {
const section_name = this.controls['section_name'].value;
const fidx = this.controls['filter_index'].value;
if (section_name && fidx) {
const fieldname = this.sections[section_name][fidx]['fieldname'];
this.controls['value_field'].set_input(this.label_lookup[fieldname]);
} else {
this.controls['value_field'].set_input(Object.keys(this.fieldname_lookup)[0]);
}
}
get_value_fieldname() {
const curlabel = this.controls['value_field'].value; const curlabel = this.controls['value_field'].value;
this.currency_cols.forEach(index => { return this.fieldname_lookup[curlabel];
if (this.qr.columns[index]['label'] == curlabel) {
filters['fieldname'] = this.qr.columns[index]['fieldname'];
}
});
return filters;
} }
new_section(label) { new_section(label) {
const dialog = new frappe.ui.Dialog({ const dialog = new frappe.ui.Dialog({
@ -123,57 +158,87 @@ class TaxReport {
}); });
dialog.show(); dialog.show();
} }
set_section(name) { get_filter_controls() {
this.mode = 'edit'; this.qr.filters.forEach(filter => {
if (name && !this.sections[name]) { if (filter['fieldname'] == 'mode') {
this.sections[name] = {}; this.mode = filter;
this.controls['section_name'].$wrapper.find("select").empty().add_options(Object.keys(this.sections));
}
if (name) {
this.controls['section_name'].set_input(name);
}
this.reload();
}
reload() {
if (this.mode == 'edit') {
const section_name = this.controls['section_name'].value;
let filters = {};
if (section_name) {
let fidx = this.controls['filter_index'].value;
let section = this.sections[section_name];
let fidxs = Object.keys(section);
fidxs.unshift('');
this.controls['filter_index'].$wrapper.find("select").empty().add_options(fidxs);
this.controls['filter_index'].set_input(fidx);
if (fidx != '') {
filters = section[fidx];
}
} else {
this.controls['filter_index'].$wrapper.find("select").empty();
} }
// Set filters if (filter['fieldname'] == 'report_name') {
// reload datatable this.report_name = filter;
} else {
this.controls['filter_index'].$wrapper.find("select").empty();
// Query the result from the server & render
}
}
get_select(label, list, type) {
const dialog = new frappe.ui.Dialog({
title: label,
fields: [{
fieldname: 'select',
label: label,
fieldtype: 'Select',
options: list
}],
primary_action_label: label,
primary_action: (values) => {
dialog.hide();
this.exec_select(values.select, type);
} }
}); });
dialog.show(); }
set_mode(mode) {
this.mode.value = mode;
}
edit_mode() {
return this.mode.value == 'edit';
}
set_section(name) {
if (name && !this.sections[name]) {
this.sections[name] = {};
}
let options = Object.keys(this.sections);
options.unshift('');
this.controls['section_name'].$wrapper.find("select").empty().add_options(options);
if (name) {
this.controls['section_name'].set_input(name);
} else {
this.controls['section_name'].set_input('');
}
if (this.controls['section_name'].value) {
this.set_mode('edit');
} else {
this.set_mode('run');
}
this.controls['filter_index'].set_input('');
this.reload();
}
reload_filter() {
const section_name = this.controls['section_name'].value;
if (section_name) {
let fidx = this.controls['filter_index'].value;
let section = this.sections[section_name];
let fidxs = Object.keys(section);
fidxs.unshift('');
this.controls['filter_index'].$wrapper.find("select").empty().add_options(fidxs);
this.controls['filter_index'].set_input(fidx);
} else {
this.controls['filter_index'].$wrapper.find("select").empty();
this.controls['filter_index'].set_input('');
}
this.set_filters();
}
set_filters() {
let filters = {};
const section_name = this.controls['section_name'].value;
const fidx = this.controls['filter_index'].value;
if (section_name && fidx) {
filters = this.sections[section_name][fidx]['filters'];
}
this.setAppliedFilters(filters);
this.qr.datatable.columnmanager.applyFilter(filters);
this.set_value_label_from_filter();
}
setAppliedFilters(filters) {
Array.from(this.qr.datatable.header.querySelectorAll('.dt-filter')).map(function setFilters(input) {
let idx = input.dataset.colIndex;
if (filters[idx]) {
input.value = filters[idx];
} else {
input.value = null;
}
});
}
reload() {
// Reloads the data. When the datatable is reloaded, load_report()
// will be run by the after_datatable_render event.
this.qr.refresh();
if (this.edit_mode()) {
this.reload_filter();
} else {
this.controls['filter_index'].$wrapper.find("select").empty();
}
} }
delete(name, type) { delete(name, type) {
if (type === 'section') { if (type === 'section') {
@ -200,7 +265,7 @@ class TaxReport {
fieldtype: 'Select', fieldtype: 'Select',
fieldname: 'section_name', fieldname: 'section_name',
change: (e) => { change: (e) => {
this.set_section(); this.set_section(this.controls['section_name'].get_input_value());
} }
}); });
// BUTTON in button.js // BUTTON in button.js
@ -229,7 +294,8 @@ class TaxReport {
fieldtype: 'Select', fieldtype: 'Select',
fieldname: 'filter_index', fieldname: 'filter_index',
change: (e) => { change: (e) => {
// TODO this.controls['filter_index'].set_input(this.controls['filter_index'].get_input_value());
this.set_filters();
} }
}); });
controls['add_filter'] = this.page.add_field({ controls['add_filter'] = this.page.add_field({
@ -240,17 +306,19 @@ class TaxReport {
let section_name = this.controls['section_name'].value; let section_name = this.controls['section_name'].value;
if (section_name) { if (section_name) {
let prefix = 'Filter'; let prefix = 'Filter';
let filters = this.qr.datatable.columnmanager.getAppliedFilters(); let data = {
filters = this.add_value_field_to_filters(filters); filters: this.qr.datatable.columnmanager.getAppliedFilters(),
fieldname: this.get_value_fieldname()
}
const fidxs = Object.keys(this.sections[section_name]); const fidxs = Object.keys(this.sections[section_name]);
let new_idx = prefix + '0'; let new_idx = prefix + '0';
if (fidxs.length > 0) { if (fidxs.length > 0) {
const fiidxs = fidxs.map((key) => parseInt(key.replace(prefix, ''))); const fiidxs = fidxs.map((key) => parseInt(key.replace(prefix, '')));
new_idx = prefix + (Math.max(...fiidxs) + 1).toString(); new_idx = prefix + (Math.max(...fiidxs) + 1).toString();
} }
this.sections[section_name][new_idx] = filters; this.sections[section_name][new_idx] = data;
this.controls['filter_index'].set_input(new_idx); this.controls['filter_index'].set_input(new_idx);
this.reload(); this.reload_filter();
} else { } else {
frappe.throw(__('Please add or select the Section first')); frappe.throw(__('Please add or select the Section first'));
} }
@ -273,7 +341,7 @@ class TaxReport {
fieldtype: 'Select', fieldtype: 'Select',
fieldname: 'value_field', fieldname: 'value_field',
change: (e) => { change: (e) => {
// TODO this.controls['value_field'].set_input(this.controls['value_field'].get_input_value());
} }
}); });
controls['save'] = this.page.add_field({ controls['save'] = this.page.add_field({
@ -281,17 +349,22 @@ class TaxReport {
fieldtype: 'Button', fieldtype: 'Button',
fieldname: 'save', fieldname: 'save',
click: () => { click: () => {
// TODO: Save to db this.controls['section_name'].set_input('');
this.mode = 'run'; this.set_mode('run');
this.reload(); this.save_report();
} }
}); });
this.controls = controls; this.controls = controls;
this.set_value_options(); this.set_value_options();
this.get_filter_controls();
this.show_help(); this.show_help();
} }
show_help() { show_help() {
const help = __('You can add multiple sections to your custom report using the New Section button above. To specify what data goes in each section, specify column filters below, then save with Add Filter. Each section can have multiple filters added. You can specify which Currency column will be summed for each filter in the final report with the Value Column select box.'); const help = __(`You can add multiple sections to your custom report using the New Section button above.
To specify what data goes in each section, specify column filters below, then save with Add Filter.
Each section can have multiple filters added.
You can specify which Currency column will be summed for each filter in the final report with the Value Column select box.
Once you're done, hit Save & Run.`);
this.qr.show_status(help); this.qr.show_status(help);
} }
} }
@ -306,6 +379,20 @@ function get_reports(cb) {
}) })
} }
function override_menu() {
//TODO: Replace save button
this.qr.menu_items.forEach((item, idx) => {
if (item['label'] == __('Save')) {
delete this.qr.menu_items[idx];
}
})
this.qr.menu_items.push({
label: __('Save'),
action: this.save_report
})
this.qr.set_menu_items();
}
function new_report() { function new_report() {
const dialog = new frappe.ui.Dialog({ const dialog = new frappe.ui.Dialog({
title: __("New Report"), title: __("New Report"),
@ -320,8 +407,13 @@ function new_report() {
primary_action_label: __('Create'), primary_action_label: __('Create'),
primary_action: function new_report_pa(values) { primary_action: function new_report_pa(values) {
frappe.call({ frappe.call({
method:'erpnext.accounts.report.tax_detail.tax_detail.new_custom_report', method:'erpnext.accounts.report.tax_detail.tax_detail.save_custom_report',
args: {'name': values.report_name}, args: {
reference_report: 'Tax Detail',
report_name: values.report_name,
columns: frappe.query_report.get_visible_columns(),
sections: {}
},
freeze: true freeze: true
}).then((r) => { }).then((r) => {
frappe.set_route("query-report", values.report_name); frappe.set_route("query-report", values.report_name);

View File

@ -3,7 +3,7 @@
# Contributed by Case Solved and sponsored by Nulight Studios # Contributed by Case Solved and sponsored by Nulight Studios
from __future__ import unicode_literals from __future__ import unicode_literals
import frappe import frappe, json
from frappe import _ from frappe import _
# field lists in multiple doctypes will be coalesced # field lists in multiple doctypes will be coalesced
@ -16,15 +16,12 @@ required_sql_fields = {
# "Journal Entry Account": ["debit_in_account_currency", "credit_in_account_currency"] # "Journal Entry Account": ["debit_in_account_currency", "credit_in_account_currency"]
} }
@frappe.whitelist()
def get_required_fieldlist():
"""For overriding the fieldlist from the client"""
return required_sql_fields
def execute(filters=None, fieldlist=required_sql_fields): def execute(filters=None):
if not filters: if not filters:
return [], [] return [], []
fieldlist = required_sql_fields
fieldstr = get_fieldstr(fieldlist) fieldstr = get_fieldstr(fieldlist)
gl_entries = frappe.db.sql(""" gl_entries = frappe.db.sql("""
@ -136,9 +133,12 @@ custom_report_dict = {
} }
@frappe.whitelist() @frappe.whitelist()
def get_custom_reports(): def get_custom_reports(name=None):
filters = custom_report_dict.copy()
if name:
filters['name'] = name
reports = frappe.get_list('Report', reports = frappe.get_list('Report',
filters = custom_report_dict, filters = filters,
fields = ['name', 'json'], fields = ['name', 'json'],
as_list=False as_list=False
) )
@ -148,22 +148,34 @@ def get_custom_reports():
return reports_dict return reports_dict
@frappe.whitelist() @frappe.whitelist()
def new_custom_report(name=None): def save_custom_report(reference_report, report_name, columns, sections):
if name == 'Tax Detail': import pymysql
frappe.throw("The parent report cannot be overwritten.") if reference_report != 'Tax Detail':
if not name: frappe.throw(_("The wrong report is referenced."))
frappe.throw("The report name must be supplied.") if report_name == 'Tax Detail':
frappe.throw(_("The parent report cannot be overwritten."))
data = {
'columns': json.loads(columns),
'sections': json.loads(sections)
}
doc = { doc = {
'doctype': 'Report', 'doctype': 'Report',
'report_name': name, 'report_name': report_name,
'is_standard': 'No', 'is_standard': 'No',
'module': 'Accounts' 'module': 'Accounts',
'json': json.dumps(data, separators=(',', ':'))
} }
doc.update(custom_report_dict) doc.update(custom_report_dict)
doc = frappe.get_doc(doc)
doc.insert()
return True
@frappe.whitelist() try:
def save_custom_report(data): newdoc = frappe.get_doc(doc)
return None newdoc.insert()
frappe.msgprint(_("Report created successfully"))
except (frappe.exceptions.DuplicateEntryError, pymysql.err.IntegrityError):
dbdoc = frappe.get_doc('Report', report_name)
dbdoc.update(doc)
dbdoc.save()
frappe.msgprint(_("Report updated successfully"))
return report_name