Libero Human Resource & Payroll Official Extension

From ADempiere ERP Wiki
Jump to navigationJump to search
Logo e-Evolution.png
DesignIcon.jpg Designer: Victor Perez.
Email.jpg Contact Sponsor e-mail: [victor.perez@e-evolution.com].
Develop.png Developer: [Oscar Gomez].
Sponsor smily.png Sponsor: e-Evolution,SC, located in Mexico, Equador and Venezuela.

This is to introduce Libero's HR Payroll and HR Management modules for integrating into ADempiere ERP Business Suite. The code is preliminarily in version 354 and has its own branch in SVN. The modules reuses the Application Dictionary and Data Models.

Introduction[edit]

The Libero Human Resource & Payroll is developed and maintained for [e-Evolution]. Configuring HR module in ADempiere is an easy task. First you have to setup basic data such as HR Contract, HR Employee Job type, and HR Employee. Based on these data, you can start entering the HR Employee information one by one. The screen shots in the following section will explain more about how to configure the ADempiere HR module.

SourceCode[edit]

You may access the Mercurial Repository Mercurial Repository

It is licensed under GPLv2.0 copyright of e-Evolution, Mexico.

Procedure to test using Eclipse[edit]

  • 1.- Checkout the source code from SVN
  • 2.- Modify the adempiereLiberoHR.launch and change your -DPropertyFile= and -DADEMPIERE_HOME= parameters
  • 3.- Start ADempiere using the adempiereLiberoHR.launch file (you need the adempiereTrunk source code as dependency)

Install the extension into ADempiere Setup[edit]

1.- unzip and apply the migration script for Libero HR & Payroll in a new ADempiere Instance based on 360TLS

http://sourceforge.net/projects/adempiere/files/Adempiere%20Packages/Libero%20Human%20Resource%20and%20Payroll/migration_script.zip/download

2.- Download the binary liberoHR.jar, liberozkHR.jar and patches.jar files

http://sourceforge.net/projects/adempiere/files/Adempiere%20Packages/Libero%20Human%20Resource%20and%20Payroll/liberozkHR.jar/download http://sourceforge.net/projects/adempiere/files/Adempiere%20Packages/Libero%20Human%20Resource%20and%20Payroll/liberoHR.jar/download http://sourceforge.net/projects/adempiere/files/Adempiere%20Packages/Libero%20Human%20Resource%20and%20Payroll/patches.jar/download

3.- Open Terminal command 4.- Change the ADempiere Home directory

   #cd $ADEMPIERE_HOME

5.- Copy the liberoHR.jar file to packages directory

   #cp liberoHR.jar $ADEMPIERE_HOME/packages/liberoHR/lib

6.- Copy the liberozkHR.jar file to packages directory

   #cp liberozkHR.jar $ADEMPIERE_HOME/zkpackages/liberoHR/lib    

7.- Copy the patches.jar file to lib directory

   #cp patches.jar $ADEMPIERE_HOME/lib

8.- Run ADempiere setup

   #RUN_setup.sh or RUN_silentsetup.sh

9.- Login using SuperUser , and execute the System Admin -> General Rules -> Security -> Role Access Update,after you need Login again, now you would see the new option in menu

Roadmap Document[edit]

Functionality / Feature Status Developer Priority Milestone Release Date Summary
Human Resource & Payroll -> Payroll
Payment Selection Implemented Victor Perez High 2.0 last build ...
Payment Print/Export Implemented Victor Perez High 2.0 last build ...
Concept to generate AR/AP Invoice Implemented Victor Perez High 2.0 last build ...
Payroll Engine Based on JSR 223 Scripting APIs Implemented Victor Perez High 2.0 last build ...
Concept Recurrence Under development Victor Perez High 2.0 no defined ...
Payroll Movement Report Under development Victor Perez High 2.0 no defined ...
Import Payroll Implemented Contribution from GlobalQSS High 3.0 last build ...

Project Lead[edit]

Coordinator[edit]

[1]


Functional Specs[edit]

Key Functionality

  • Payroll Contacts
  • Department
  • Job Position
  • Employes
    • General Data
    • Employe Attribute (Numeric,String,Quantity,Date, Logic)
    • Employe Account Bank
    • Employe Contact
    • Employe Location
    • Employe Interest Area
  • Payroll
    • Concept Category
    • Concept &
    • List Category
    • List and Tables
    • Period Control
    • Payroll Events
    • Payroll Rule Engine (Based in JSR 223 Scripting APIs)
    • Payroll Document Process

Technical Specs[edit]

  • Totally integrate with Adempiere

Reference[edit]

Developers[edit]

Testers[edit]

Sponsors[edit]

e-Evolution, Mexico

Requirements[edit]

A good HR & Payroll Management to Adempiere

Successful Installed Sites[edit]

  • Implemented by Consulting firm e-Evolution
    • 1 Customer in Venezuela with 750 employees
    • 1 Customer in Ecuador with 600 employees
    • 1 Customer in Ecuador with 100 employees

Libero Human Resources & Payroll FAQs[edit]

Q: How do you calculate tax from a table like this one?[edit]

From Michael Judd of Akuna Ltd Screenshot-Payroll Table PAYE1 Michael Judd@Elefire.Elefire Ltd -adempiere.lan-adempiere.lan-adempiere-adempiere--.png

I want to have a monthly gross pay, and then calculate tax using the bands on this table like this:

Gross Pay = 2000

  • 0 - 435 * col_1 (0%) = 0
  • 436.00 - 620.83 * col_1 (10%) = 18.48
  • 620.84 - 2000.00 * col_1 (22%) = 303.42
  • Total 321.90

I expect I need to create a Rule as BeanShell (for example) in the System client and allocate this to Payroll Concept Catalog.

How would I define the rule? Use getConcept to retrieve the values from the table lines?

Employee Staturary Deductions[edit]

  • This example is also suitable for employee's contribution similar to Singapore's CPF and Malaysia's Employee Provident Fund (EPF)

Screenshot-Payroll Concept CatalogPAYE Tax.png

Hi Michael!

Here the answer your question and screen shot:

EE02HRPayrollConcept.png

EE02HRPayrollAttribure.png

EE02HRPayrollRule.png


In the class model HRProcess we have some static methods that you can use in Rule Engine:

1.- 2.- 3.-

Screenshots[edit]

Payroll Menu[edit]

Libero Payroll

Contract[edit]

Libero Payroll

Employee Job[edit]

Libero Payroll

Department[edit]

Libero Payroll

Employee Setup[edit]

Libero Payroll

Employee Data[edit]

Libero Payroll

Employee Account[edit]

Libero Payroll

Employee Attribute[edit]

Libero Payroll

Employee Bank Account[edit]

Libero Payroll

Employee Location[edit]

Libero Payroll

Employee Contact[edit]

Libero Payroll

Payroll Setup[edit]

Libero Payroll

Payroll: Sequence Calculation Concepts[edit]

Libero Payroll

Payroll Year[edit]

Libero Payroll

Payroll Periods[edit]

Libero Payroll

Concept Category[edit]

Libero Payroll

Concept Setup[edit]

Libero Payroll

Types of concept[edit]

Libero Payroll

Content type of concept[edit]

Libero Payroll

Concept Attribute[edit]

Libero Payroll

Concept Type Rule Engine[edit]

Libero Payroll

Attribute Type Rule Engine[edit]

Libero Payroll

Rule Engine: Calculating total income[edit]

Libero Payroll

Rule Engine: Calculating Days[edit]

Libero Payroll

Rule Engine: Calculating withholding tax[edit]

Libero Payroll

List Category[edit]

Libero Payroll

List[edit]

Libero Payroll

List Version[edit]

Libero Payroll

List: Line Detail[edit]

Libero Payroll

Payroll Events[edit]

Libero Payroll

Process Document Payroll[edit]

Libero Payroll

Process[edit]

Libero Payroll

Movement[edit]

Libero Payroll

Functional team[edit]

  • Volunteers for reviewing:

Result of Functional Review[edit]

  • General observations. San Salvador, July 28th, 2013, 01:25 GMT.
    • Libero HR/Payroll is now part of Adempiere; the main difference is that is is implemented as a package (like Libero MFG), which can or cannot be included in the implementation.
    • The module reuses whenever possible existing Adempiere objects. A good example is here the usage of windows, scripts and processes.
    • Libero HR/Payroll concentrates more on the Payroll than in the Human Resources part.
      • IMHO this models right now just basic HR needs, though thanks to its flexibility more advanced solutions -like the one from Walking Tree- can be easily added.
    • The module is more tool-kit than a ready-to-use module. This means, the implementors have to develop everything.
    • The module enables to manage complex payroll scenarios/situations.
    • Downside: the module offers all possibilities, but you have to do it by yourself. There is no solution for a specific country.
    • I have tested it with the rules for Nicaragua, El Salvador and Colombia which are with some slight differences similar (Financial and Tax officers come to mind similar ideas). I suppose other countries should behave to a great extent similar. If not, the module offers all possibilities to model it as well.
    • I refrained from explaining every window, because they are depicted above and their behavior is self-explanatory.
    • I have used extensively Scripts, as they don't need to be installed; the only (and great) disadvantage is that it is not possible to debug scripts: you must run it and "post mortem" guess what it might have happened.
    • One way to overcoming the debugging shortage of Scripts is developing a process in java, debugging it, and converting into a Script. You must only be careful to translate variables and parameters. This is a matter of taste.
    • The movements process do what it is supposed to do. You can simulate in an easy manner the behavior of a payroll.
    • Recursive definitions work well, i.e. you can define a Rule which is based in another Rule and it is resolved well.

Technical team[edit]

  • Volunteers for reviewing:

Result of Technical Review[edit]

  • General observations San Salvador, July 28th, 2013, 01:25 GMT.
    • Libero Production and HR is somehow split: some files are in the actual code, others are in packages.
    • ADempiere code now
      • All model classes are in the package org.eevolution.model, which is an integral part of ADempiere
        • This applies to Libero Manufacturing and Libero HR
        • Example: X_HR_Attribute, I_HR_Attribute (Model for Payroll attributes)
    • In the Libero branch are the classes defined which implement the business logic
      • No I nor X class
      • Almost all M classes (a couple are in the actual ADempiere branch now)
        • Example: MHRConcept, MHRPayroll, MHRMovement
      • All processes
        • Example: HRCreatePeriods, HRAttributeEmployee, HRCreateConcept, HRPAySelectionCreateScheck, PayrollProcessing
    • The I and X classes are generated and their nomenclature is OK.
    • The same applies to the M classes: they stick to the naming of other ADempiere documents like MOrder.
    • Private variables follow the ADempiere convention (m_.... or p_....)
    • All class headers I reviewed have JavaDoc comments with Licence documentation.
    • Most methods have very short JavaDoc comments.
    • Extensive usage of Query and DB classes for accessing the database.
    • Model validators are used as otherwise in ADempiere
    • Usage of self-explanatory exceptions when important errors encountered
    • License headers and serialVersionUID existent in the "M"classes I reviewed.
    • Comments are sparse and could be more explicit, but this is common in ADempiere
    • Imports are dedicated
      • example: import org.compiere.util.Env;. This is how it is implemented --> OK
      • example: import org.compiere.model.*. I haven't found any case like this --> OK
    • Usage of static final variables when needed
    • Code readable: well formatted.
    • Some methods are quite long
    • I have debugged HRCreateConcept, HRPAySelectionCreateScheck, PayrollProcessing and other processes; after "a couple" of tries, the functionality can be understood.
    • The code is well readable, but the matter is complex, so you have to take patience and time if you want to understand it completely.