feat: Earned Leave UX Enhancement

hrms/hr/doctype/leave_allocation/leave_allocation.js

@@ -1,138 +1,289 @@
 // Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
 // License: GNU General Public License v3. See license.txt
 
-cur_frm.add_fetch('employee', 'employee_name', 'employee_name');
+cur_frm.add_fetch("employee", "employee_name", "employee_name");
 
 frappe.ui.form.on("Leave Allocation", {
- onload: function(frm) {
+ onload: function (frm) {
  // Ignore cancellation of doctype on cancel all.
  frm.ignore_doctypes_on_cancel_all = ["Leave Ledger Entry"];
 
- if (!frm.doc.from_date) frm.set_value("from_date", frappe.datetime.get_today());
+ if (!frm.doc.from_date)
+ frm.set_value("from_date", frappe.datetime.get_today());
 
- frm.set_query("employee", function() {
+ frm.set_query("employee", function () {
  return {
- query: "erpnext.controllers.queries.employee_query"
+ query: "erpnext.controllers.queries.employee_query",
  };
  });
- frm.set_query("leave_type", function() {
+
+ frm.set_query("leave_type", function () {
  return {
  filters: {
- is_lwp: 0
- }
+ is_lwp: 0,
+ },
  };
  });
  },
 
- refresh: function(frm) {
+ refresh: function (frm) {
  if (frm.doc.docstatus === 1 && frm.doc.expired) {
- var valid_expiry = moment(frappe.datetime.get_today()).isBetween(frm.doc.from_date, frm.doc.to_date);
+ var valid_expiry = moment(frappe.datetime.get_today()).isBetween(
+ frm.doc.from_date,
+ frm.doc.to_date
+ );
  if (valid_expiry) {
  // expire current allocation
- frm.add_custom_button(__('Expire Allocation'), function() {
+ frm.add_custom_button(__("Expire Allocation"), function () {
  frm.trigger("expire_allocation");
  });
  }
  }
 
  if (!frm.doc.__islocal && frm.doc.leave_policy_assignment) {
- frappe.db.get_value("Leave Type", frm.doc.leave_type, "is_earned_leave", (r) => {
- if (cint(r?.is_earned_leave))
+ frappe.db.get_value(
+ "Leave Type",
+ frm.doc.leave_type,
+ ["is_earned_leave", "earned_leave_frequency", "rounding"],
+ (r) => {
+ if (!cint(r?.is_earned_leave)) return;
  frm.set_df_property("new_leaves_allocated", "read_only", 1);
- });
+ frm.frequency = r?.earned_leave_frequency;
+ frm.rounding = r?.rounding;
+ frm.trigger("get_monthly_earned_leave");
+
+ frm.add_custom_button(__("Allocate Leaves Manually"), function () {
+ const dialog = new frappe.ui.Dialog({
+ title: "Enter details",
+ fields: [
+ {
+ label: "New Leaves to be Allocated",
+ fieldname: "new_leaves",
+ fieldtype: "Data",
+ onchange: function () {
+ frm.new_leaves = this.value;
+ },
+ },
+ ],
+ primary_action_label: "Allocate",
+ primary_action() {
+ frm.trigger("allocate_leaves_manually");
+ dialog.hide();
+ },
+ });
+ dialog.fields_dict.new_leaves.set_value(frm.new_leaves);
+ dialog.show();
+ });
+ }
+ );
  }
  },
 
- expire_allocation: function(frm) {
+ expire_allocation: function (frm) {
  frappe.call({
- method: 'hrms.hr.doctype.leave_ledger_entry.leave_ledger_entry.expire_allocation',
+ method:
+ "hrms.hr.doctype.leave_ledger_entry.leave_ledger_entry.expire_allocation",
  args: {
- 'allocation': frm.doc,
- 'expiry_date': frappe.datetime.get_today()
+ allocation: frm.doc,
+ expiry_date: frappe.datetime.get_today(),
  },
  freeze: true,
- callback: function(r) {
+ callback: function (r) {
  if (!r.exc) {
  frappe.msgprint(__("Allocation Expired!"));
  }
  frm.refresh();
- }
+ },
  });
  },
 
- employee: function(frm) {
+ employee: function (frm) {
  frm.trigger("calculate_total_leaves_allocated");
  },
 
- leave_type: function(frm) {
+ leave_type: function (frm) {
  frm.trigger("leave_policy");
  frm.trigger("calculate_total_leaves_allocated");
+ frm.trigger("make_dashboard");
  },
 
- carry_forward: function(frm) {
+ carry_forward: function (frm) {
  frm.trigger("calculate_total_leaves_allocated");
  },
 
- unused_leaves: function(frm) {
- frm.set_value("total_leaves_allocated",
- flt(frm.doc.unused_leaves) + flt(frm.doc.new_leaves_allocated));
+ unused_leaves: function (frm) {
+ frm.set_value(
+ "total_leaves_allocated",
+ flt(frm.doc.unused_leaves) + flt(frm.doc.new_leaves_allocated)
+ );
  },
 
- new_leaves_allocated: function(frm) {
- frm.set_value("total_leaves_allocated",
- flt(frm.doc.unused_leaves) + flt(frm.doc.new_leaves_allocated));
+ new_leaves_allocated: function (frm) {
+ frm.set_value(
+ "total_leaves_allocated",
+ flt(frm.doc.unused_leaves) + flt(frm.doc.new_leaves_allocated)
+ );
  },
 
- leave_policy: function(frm) {
+ leave_policy: function (frm) {
  if (frm.doc.leave_policy && frm.doc.leave_type) {
- frappe.db.get_value("Leave Policy Detail", {
- 'parent': frm.doc.leave_policy,
- 'leave_type': frm.doc.leave_type
- }, 'annual_allocation', (r) => {
- if (r && !r.exc) frm.set_value("new_leaves_allocated", flt(r.annual_allocation));
- }, "Leave Policy");
+ frappe.db.get_value(
+ "Leave Policy Detail",
+ {
+ parent: frm.doc.leave_policy,
+ leave_type: frm.doc.leave_type,
+ },
+ "annual_allocation",
+ (r) => {
+ if (r && !r.exc)
+ frm.set_value("new_leaves_allocated", flt(r.annual_allocation));
+ },
+ "Leave Policy"
+ );
  }
  },
- calculate_total_leaves_allocated: function(frm) {
- if (cint(frm.doc.carry_forward) == 1 && frm.doc.leave_type && frm.doc.employee) {
+
+ calculate_total_leaves_allocated: function (frm) {
+ if (
+ cint(frm.doc.carry_forward) == 1 &&
+ frm.doc.leave_type &&
+ frm.doc.employee
+ ) {
  return frappe.call({
  method: "set_total_leaves_allocated",
  doc: frm.doc,
- callback: function() {
+ callback: function () {
  frm.refresh_fields();
- }
+ },
  });
  } else if (cint(frm.doc.carry_forward) == 0) {
  frm.set_value("unused_leaves", 0);
- frm.set_value("total_leaves_allocated", flt(frm.doc.new_leaves_allocated));
+ frm.set_value(
+ "total_leaves_allocated",
+ flt(frm.doc.new_leaves_allocated)
+ );
  }
- }
+ },
+
+ get_monthly_earned_leave: async function (frm) {
+ await frappe.run_serially([
+ () =>
+ frappe.db
+ .get_value("Employee", frm.doc.employee, "date_of_joining")
+ .then((r) => (frm.doj = r.message.date_of_joining)),
+ () =>
+ frappe.db.get_value(
+ "Leave Policy Detail",
+ {
+ parent: frm.doc.leave_policy,
+ leave_type: frm.doc.leave_type,
+ },
+ "annual_allocation",
+ (r) => {
+ frm.annual_leaves = r.annual_allocation;
+ },
+ "Leave Policy"
+ ),
+ () =>
+ frappe.call({
+ method: "hrms.hr.utils.get_monthly_earned_leave",
+ args: {
+ date_of_joining: frm.doj,
+ annual_leaves: frm.annual_leaves,
+ frequency: frm.frequency,
+ rounding: frm.rounding,
+ },
+ callback: function (r) {
+ frm.monthly_leaves = r.message;
+ frm.new_leaves = r.message;
+ frm.trigger("make_dashboard");
+ },
+ }),
+ ]);
+ },
+
+ allocate_leaves_manually: function (frm) {
+ frappe.call({
+ method: "hrms.hr.utils.allocate_leaves_manually",
+ args: {
+ allocation_name: frm.doc.name,
+ new_leaves: frm.new_leaves,
+ },
+ callback: function () {
+ frm.refresh();
+ },
+ });
+ },
+
+ make_dashboard: async function (frm) {
+ response = await frappe.db.get_value("Leave Type", frm.doc.leave_type, [
+ "is_earned_leave",
+ "earned_leave_frequency",
+ ]);
+ leave_type = response.message;
+ if (
+ !leave_type.is_earned_leave ||
+ leave_type.earned_leave_frequency != "Monthly"
+ )
+ return;
+ $("div").remove(".form-dashboard-section.custom");
+
+ const from_date_array = frm.doc.from_date.split("-");
+ const from_month = from_date_array[1] - 1;
+ const to_date_array = frm.doc.to_date.split("-");
+ let to_month = to_date_array[1] - 1;
+ if (to_date_array[0] > from_date_array[0]) to_month += 12;
+
+ const months = [];
+ for (let i = from_month; i <= to_month; i++) {
+ months.push(moment().month(i).format("MMMM"));
+ }
+
+ frm.dashboard.add_section(
+ frappe.render_template("leave_allocation_dashboard", {
+ months: months,
+ monthly_leaves: frm.monthly_leaves,
+ }),
+ __("Allocated Leaves")
+ );
+ frm.dashboard.show();
+ },
 });
 
 frappe.tour["Leave Allocation"] = [
  {
  fieldname: "employee",
  title: "Employee",
- description: __("Select the Employee for which you want to allocate leaves.")
+ description: __(
+ "Select the Employee for which you want to allocate leaves."
+ ),
  },
  {
  fieldname: "leave_type",
  title: "Leave Type",
- description: __("Select the Leave Type like Sick leave, Privilege Leave, Casual Leave, etc.")
+ description: __(
+ "Select the Leave Type like Sick leave, Privilege Leave, Casual Leave, etc."
+ ),
  },
  {
  fieldname: "from_date",
  title: "From Date",
- description: __("Select the date from which this Leave Allocation will be valid.")
+ description: __(
+ "Select the date from which this Leave Allocation will be valid."
+ ),
  },
  {
  fieldname: "to_date",
  title: "To Date",
- description: __("Select the date after which this Leave Allocation will expire.")
+ description: __(
+ "Select the date after which this Leave Allocation will expire."
+ ),
  },
  {
  fieldname: "new_leaves_allocated",
  title: "New Leaves Allocated",
- description: __("Enter the number of leaves you want to allocate for the period.")
- }
+ description: __(
+ "Enter the number of leaves you want to allocate for the period."
+ ),
+ },
 ];

hrms/hr/doctype/leave_allocation/leave_allocation_dashboard.html

@@ -0,0 +1,20 @@
+{% if monthly_leaves %}
+<table class="table table-bordered small">
+ <thead>
+ <tr>
+ <th style="width: 50%">{{ __("Month") }}</th>
+ <th style="width: 50%">{{ __("No. of Leaves") }}</th>
+ </tr>
+ </thead>
+ <tbody>
+ {% for(const value of months) { %} {% %}
+ <tr>
+ <td>{%= value %}</td>
+ <td>{%= monthly_leaves %}</td>
+ </tr>
+ {% } %}
+ </tbody>
+</table>
+{% else %}
+<p style="margin-top: 30px">No Leave has been allocated.</p>
+{% endif %}