IceHrm Book (PDF)

1.1

1.2

1.3

1.4

2.1

2.2

3.1

3.2

4.1

4.2

4.3

5.1

5.2

5.3

5.4

TableofContents

Part1Introduction

Installation

ManualInstallation

BasicSettings

Part2EmployeeManagement

EmployeeDataImport

Part3AttendanceModule

Timesheets

Part4VacationandLeaveManagement

CompanyLeavePolicy

LeaveRequestsandApproval

Part5RecruitmentManagement

DocumentManagement

TrainingModule

ExpenseManagement

2

6.1

6.2

7.1

7.2

8.1

8.2

8.3

Part6PayrollManagement

Import-ExportPayrolls

Part7Charts

Reporting

Part8RestApi

UsingLDAP

FAQ

3

IntroductionThisbookaimstobeacomprehensiveguidetoIceHrm.We’llcovertopicssuchasinstallingIceHrmandgettingitupandrunning,configuringIceHrmandusingicehrmmodules.

WhatisIceHrm?IceHrmisaHumanresourcemanagementsystemforsmallandmedium-sizedorganizations.ItcoversallthebasicHRMneedsofacompanysuchasleavemanagement,timemanagementandhandlingemployeeinformation.

Introduction

4

http://icehrm.com/

InstallationIfyouareusingicehrmcloudpleaseskipthischapter

GettingIceHrminstalledonlytakeafewminutes.Ifiteverbecomesaproblem,pleasefileanissuedescribingtheissueyouencounteredandhowwemightmaketheprocesseasier.

Requirements

BeforeinstallingIceHrmpleasemakesureyoursystemsupportsfollowingrequirementsyou’llneedtomakesureyoursystemhasbeforeyoustart.

PHP5.3orHigherNet_SMTPextensionforPHPMySQLphp-mysqlextention$>sudoapt-getinstallphp-mysqlPHPGDlibrary$>sudoapt-getinstallphp7.0-gd

OptionalModules

Theseareoptionalcomponentswhichcouldimproveicehrmperformance

Memcache

Installation

Ifyouareinstallingtheopensourceversion,downloadthelatestreleasefromGitHub

Ifyouareinstallingtheproversionorenterpriseyoushouldhavereceivedthefilesafterpurchase.

CopythedownloadedfiletothepathyouwanttoinstalliCEHrminyourserverandextract.

CreateamysqlDBforanduser.GrantalloniCEHrmDBtonewDBuser.

VisitiCEHrminstallationpathinyourbrowser.

Duringtheinstallationform,fillindetailsappropriately.

Oncetheapplicationisinstalledusetheusername=adminandpassword=admintologintoyoursystem.

Installation

5

https://github.com/gamonoid/icehrm/issues/new

http://php.net/

http://dev.mysql.com/downloads/

http://php.net/manual/en/mysqli.installation.php

http://php.net/manual/en/mysqli.installation.php

https://www.digitalocean.com/community/tutorials/how-to-install-and-use-memcache-on-ubuntu-14-04

https://github.com/gamonoid/icehrm/releases/latest

AfterinstallationthesettingsmodulecanbeaccessedbylogininasadminandgoingtoSystem->Settings

Cron(ScheduledTask)forNotificationsNotificationcronisusedtosendperiodicnotifications.Documentexpirynotificationswilldependonthisscheduler.

Totriggerthescheduleryouneedtorunfollowingfile

(IceHrmRoot)/app/cron.php

SettingupLinuxCron

Inlinuxenvironmentacronshouldbesetuptorunevery10minutes.

Thiscanbedonebyplacingfollowinglineinyourcrontab.Dependingonyourserveryoucaneditcrontabsudovi/etc/crontab

oryoucanusecrontab-ecommand

/10*(IceHrmRoot)/app/cron.php

makesurethat(IceHrmRoot)/app/cron.phpfileisexecutable*SettingupWindowsSchedulerForsettingupthewindowsschedulerpleasecheckhttp://windows.microsoft.com/en-au/windows/schedule-task#1TC=windows-7

Installation

6

http://windows.microsoft.com/en-au/windows/schedule-task#1TC=windows-7

ManualInstallationIfyouencounteredanyissueswithautomatedinstallationpleasefollowthesestepstomanuallyconfigureicehrmonyourserver.

DownloadandExtractIceHrmLatestRelease

1. Ifyouareusingicehrmopensourceversiondownloaditfrom(https://github.com/gamonoid/icehrm/releases).Makesuretodownloadtherelease.zipor.gzfile(e.g:icehrm_v19.0.OS.zip).

2. Ifyouhavepurchasedicehrmpro,youcanfindinstallationdirectoryinsidethefilesyouhavedownloadedafterpurchase.

3. Extracticermtopublicwebdirectoryrootonyourwebserverfornowweassumeittobe(/var/www/)

CreatingMySQLDatabase

Logintoyourmysqlinstallationandcreateadatabaseandauserforicehrm

mysql>createdatabaseicehrm;

mysql>createuser'icehrm_user'@'localhost'identifiedby'icehrm_pwd';

mysql>grantallonicehrm.*to'icehrm_user'@'localhost';

Thenexecuteicehrmdatabasescriptsonnewlycreatedmysqldatabaseviaconsoleorphpmyadmin.

Thetwofilesyouneedtoexecutecanbefoundinicehrminstallationdirectory(assumingittobe/var/www/icehrm)

1. /var/www/icehrm/scripts/icehrmdb.sql2. /var/www/icehrm/scripts/icehrm__master__data.sql

mysql>useicehrm;

mysql>source/var/www/icehrm/scripts/icehrmdb.sql

mysql>source/var/www/icehrm/scripts/icehrm_master_data.sql

CreatingConfigurationFile

Inside<icehrm>/app/directoryyouwillfind:

config.sample.php

ManualInstallation

7

https://github.com/gamonoid/icehrm/releases

<?php

ini_set('error_log','_LOG_');

define('APP_NAME','IceFramework');

define('FB_URL','IceFramework');

define('TWITTER_URL','IceFramework');

define('CLIENT_NAME','_CLIENT_');

define('APP_BASE_PATH','_APP_BASE_PATH_');

define('CLIENT_BASE_PATH','_CLIENT_BASE_PATH_');

define('BASE_URL','_BASE_URL_');

define('CLIENT_BASE_URL','_CLIENTBASE_URL_');

define('APP_DB','_APP_DB_');

define('APP_USERNAME','_APP_USERNAME_');

define('APP_PASSWORD','_APP_PASSWORD_');

define('APP_HOST','_APP_HOST_');

define('APP_CON_STR','mysqli://'.APP_USERNAME.':'.APP_PASSWORD.'@'.APP_HOST.'/'.APP_D

B);

//fileupload

define('FILE_TYPES','jpg,png,jpeg');

define('MAX_FILE_SIZE_KB',10*1024);

//HomeLinks

define('HOME_LINK_ADMIN',CLIENT_BASE_URL."?g=admin&n=dashboard&m=admin_Admin");

define('HOME_LINK_OTHERS',CLIENT_BASE_URL."?g=modules&n=dashboard&m=module_My_Account

");

Renamethisfiletoconfig.phpandstartupdatingit.

Youmaychangeappnameandsocialmediaurlstoyourcompanysocialmediaaccounts:

define('APP_NAME','IceFramework');

define('FB_URL','IceFramework');

define('TWITTER_URL','IceFramework');

define('CLIENT_NAME','_CLIENT_');

Soabovesectioncanbechangedto:

BydefaultCLIENT_NAMEshouldbeapp

define('APP_NAME','IceHrm-YourCompanyName');

define('FB_URL','https://facebook.com/yourcompany');

define('TWITTER_URL','https://twitter.com/yourhandle');

define('CLIENT_NAME','app');

Forupdatingurlsyouneedtoknowtheabsolutepathofyouricehrminstallationandurltoyouricehrminstallation.

Foranexampleweassumepathtoicehrmis:/var/www/icehrm/andicehrmweburltobehttp://your-company-domain.com/icehrmthenpathsandurlsshouldbeupdatedasbelow.

ManualInstallation

8

http://your-company-domain.com/icehrm

define('APP_BASE_PATH','/var/www/icehrm/');

define('CLIENT_BASE_PATH','/var/www/icehrm/app/');

define('BASE_URL','http://your-company-domain.com/icehrm/');

define('CLIENT_BASE_URL','http://your-company-domain.com/icehrm/app/');

Ifyouareusingwindowsnotethatallthepathshouldbespecifiedwithforwardslash

e.g

define('APP_BASE_PATH','C:/xampp/htdocs/icehrm/');

Thenyoucanupdatethedatabaseconfigurationsasshownbelow:

define('APP_DB','icehrm');

define('APP_USERNAME','icehrm_user');

define('APP_PASSWORD','icehrm_pwd');

define('APP_HOST','localhost');

Ifyouwouldliketouploadfileslargerthan10MByoucanupdateMAX_FILE_SIZE_KBconfig.

ManualInstallation

9

GlobalSettings

Setting DescriptionCompany:

NameNameofthecompany

Company:

Logo

Companylogo.Youmayuploadthecompanylogohere.Ideallyshouldbe200pxwideandheightbetween50pxto150px.

Company:

Description

Ashortdescriptionaboutthecompany.Willbeusedmainlyinrecruitmentmodule

Email:

Enable

Setthisto"No"todisablealloutgoingemailsfrommodules.Value"Yes"willenableoutgoingemails

EmailSettings

ConfiguringEmailwithSMTP

Setting Description

Email:Mode ThisshouldbesettoSMTP

Email:SMTP

Host

Ifyouareusinglocalmachinetosendemails,setthistolocalhost.IfnotsettheIPaddressoftheserveryouareusingtosendemails

Email:SMTP

AuthenticationSetthisto"Yes"ifSMTPserverauthorizationisenabled

Email:SMTP

UserUsernameoftheSMTPuser

Email:SMTP

PasswordSMTPuserpassword

Email:SMTP

PortPortconfiguredinSMTPserver(Default25)

Email:Email

FromFromemailaddress([email protected])

ConfiguringEmailwithAmazonSES

BasicSettings

10

Setting Description

Email:Mode ThisshouldbesettoSES

Email:AmazonSESKeyAmazonaccesskeyId(YoucangetthisthroughAWSconsole)

Email:AmazoneSES

SecretAmazonaccesskeysecret

Email:EmailFrom AuthorizedemailaddressforsendingemailsthroughSES

ConfiguringEmailwithGmail

Setting Description

Email:Mode ThisshouldbesettoSMTP

Email:SMTPHost ssl://smtp.gmail.com

Email:SMTPAuthentication Yes

Email:SMTPUser [email protected]

Email:SMTPPassword Gmailpassword

Email:SMTPPort 465

Email:EmailFrom [email protected]

DeveloperSettings

BasicSettings

11

Setting DescriptionSystem:Do

notpass

JSONin

request

SelectYesifyouarehavingtroubleloadingdataforsometables

System:

Reset

Modulesand

Permissions

Whenthisissetto“Yes”IceHrmwillresetallvaluesgiveninSystem->Permissionsmodule.Thissettingcanbeusedtoreloadpermissionsafteraddingnewpermissionstomodulemeta.jsonfile

System:Add

New

PermissionsAddnewpermissionswithoutresettingmodules

System:

DebugModePrintdebuglogmessages

OtherSettings

Setting Description

Leave:Share

Calendarto

WholeCompany

If"Yes"alltheemployeesofcompanycanseeotherpeoples'leaveschedules.Ifsetto"No"onlyadminsandsupervisorswillbeabletoseeleavescheduleofsubordinates

Leave:CC

Emails

EveryemailsentthoughleavemodulewillbeCCtothesecommaseperatedlistofemailsaddresses

Leave:BCC

Emails

EveryemailsentthoughleavemodulewillbeBCCtothesecommaseperatedlistofemailsaddresses

Attendance:

Time-sheet

CrossCheck

Onlyallowuserstoaddanentrytoatimesheetonlyiftheyhavemarkedatteandancefortheselectedperiod

Recruitment:

ShowQuick

Apply

Showquickapplybuttonwhencandidatesareapplyingforjobs.Quickapplyallowcandidatestoapplywithminimumamountofinformation

Recruitment:

ShowApplyShowapplybuttonwhencandidatesareapplyingforjobs

BasicSettings

12

EmployeeManagementEmployeesmoduleisusedtolist,edit,addandsearchemployeesinyourcompany.YoucanusethesearchboxtosearchemployeesbyID,nameordepartment.Alsoyoucanusefilterbuttontofilteremployeesbyjobtitle,departmentorsupervisor.

Eachemployeeisattachedtoacompanystructure.AcompanystructurecanbeaGroup,Company,BranchoraDepartment.Beforeaddingemployeesyoushouldfirstdefineyourcompanystructures

CompanystructureCompanystructuremoduleallowsyoutodefinethestructureofyourcompany.Letyoucreateparentstructureofthecompany,branches,departmentsandothercompanyunits.

Alsoitprovidesagraphicaloverviewofhoweachofyourcompanyunitsareconnected.

EmployeeManagement

13

DifferenceBetweenUsersandEmployees

Auserisapersonwhocanlogintoicehrm.It’snotrequiredforadminuserstohaveanemployeeattachedbuteachnonadminusermusthaveanassociatedemployee.Havinganemployeeaddedinicehrmwon’tallowthepersontologintoicehrm.YouneedtocreateauserwithaManagerorEmployeeuserlevelforthatemployeetobeabletologintothesystem.

AddingEmployees

AddingemployeestoICEHrmcanonlybedonebytheadmin.TheemployeeIdfieldshouldhaveauniquevalue.Inordertocompleteaddinganemployeeyouneedtoprovidejobtitle,employmentstatusandpaygrade.Thesevaluescanbedefinedinadmin:Jobsmodule.

Onceanemployeeisaddedtothesystemyouwillbeaskedtocreateauserforthenewlyaddedemployee.

SwitchingEmployees

OneofthekeyfeaturesofICEHrm,isadminsandmanagersabilitytologinasanotheremployee.Thisfeaturecanbeusedtoapplyleaves,addattendancerecordsorupdatetimesheetsbehalfofotheremployees.

Tologinasanemployeeyoucanusetheswitchusericononemployeelistorthe“SwitchEmployee”menuintoprighthandcorner.

EmployeeManagement

14

Supervisors

1. Anyemployeecanbethesupervisorofanotheremployee.

2. ThesupervisorofanEmployeecanbeaddedbychangingsupervisorfieldofemployeeeditscreen

3. IftheemployeeishavingAdminorManageruserlevel,theycanviewalltheirsubordinates(employeeshavingthecurrentemployeeasthesupervisor)viaEmployees=>Employeesmenu

IndirectSupervisors

1. AnemployeecanhavemultipleIndirectSupervisorswhichcanbesetviaeditemployee.

2. Indirectsupervisorsareusefulwhenapprovingleaverequests(YoucanallowindirectsupervisorstoapproveleaverequestsviaSettings->Leave/PTO)

DepartmentHeads

1. Oneormoreemployeescanbeaddedtoadepartmentasaheadofadepartment.

2. AdepartmentheadcanviewandmanageallemployeesunderthatdepartmentorsubstructuresofthisdepartmentgivefollowingsettingsunderSystem->Settings->System:

"System:CompanyStructureManagersEnabled""System:ChildCompanyStructureManagersEnabled"

EmployeeManagement

15

3. YoucandefineDepartmentHeadsviaAdmin->CompanyStructures

DeletingEmployeeData

Inordertodeleteanemployee,anadminshouldfirstclickthe"TerminateEmployee"buttononemployeelist.Butwedonotdeletetheemployeedataatthistime.Insteademployeeismovedto"TemporarilyDeactivatedEmployees"tab.Whenanemployeeisin"TemporarilyDeactivatedEmployees"list,youcanrecoveralltheemployeedatawithoneclick.

Ifyoudeletetheemployeefrom"TemporarilyDeactivatedEmployees"tab,Employeeprofilewillbemovedto"TerminatedEmployeeData"tab.Atthispointyoucannotrecovertheemployee,butstillyoucandownloadallthedataforemployeeinJSONformat.

Ifyouwanttoremoveallthedatarelatedtotheemployeeyoucandeletedatain"TerminatedEmployeeData"also.

Whenbillingforcloud-hostedinstallation,weconsidercountofactiveemployeesandemployeesunder"TemporarilyDeactivatedEmployees"tab.Soifyoudonotwanttogetbilledforanemployeeyouneedtodeletetheemployeefrom"TemporarilyDeactivatedEmployees"tabalso.

EmployeeManagement

16

EmployeeHistory

YoucanviewdetailsonhowemployeedatachangedoverthetimeyoucanuseEmployees=>EmployeeHistory

JobDetailsSetup(Admin>JobDetailsSetup)

Hereyoucansetupalltheinformationrelatedtojobtitles,paygradesandemploymentstatusinyourcompany.

QualificationsSetup(Admin>QualificationsSetup)

Skills,EducationalDetails,CertificationsandLanguagesyoudefineunderqualificationssetupmodulewillbeusedbyemployeesoradminstoattachthesequalificationstotheirprofiles.

EmployeeManagement

17

EmployeeDataImportYoucanimportdataintoicehrmusingCSVfiles.Bydefault,wesupportimportingbasicemployeedetailsandattendancedata.Thisfeatureshouldbeusedonlyduringtheinitialsetup.

PreparingEmployeeDataforUpload

1. Downloadsampledatafilehere2. Thefilehasfollowingcolumnswhichmatcheswithdefaultemployeedatafiledefinition

employee_id=Theidoftheemployee(thisidshouldbeunique,iftheemployeewithsameidexistsinthesystemthenemployeedetailswillbereplaced)first_name,middle_name,last_name=Employeenamesaddress1,address2,home_phone,mobile_phone,work_email=Employeecontactdetailsgender=MaleorFemalemarital_status=Married,Single,Divorced,Widowed,Otherbirthday=MM/DD/YYformatNationality/nationality=AnynationalitydefinedinSystem->ManageMetaData->NationalityEthnicity/ethnicity=AnyethnicitydefinedunderSystem->ManageMetaData->EthnicityEmergencyContact/name=EmergencycontactnameEmergencyContact/relationship=EmergencycontactrelationshipEmergencyContact/home_phone=Emergencycontactphonessn_num=SocialsecuritynumberorIDnumberjob_title=JobTitle(thisshouldbepredefinedinAdmin->JobDetailsSetup->JobTitles)employment_status=EmploymentStatus(shouldbepredefinedinAdmin->JobDetailsSetup->EmploymentStatus)joined_date=JoineddateinMM/DD/YYformatdepartment=CompanyStructurethisemployeeisattachedto(predefinedinAdmin->CompanyStructure)

ImportingBasicEmployeeData

1. LoginasAdminandNavigatetoSystem->DataImportFilesandcreateanewentrywiththefilecreatedinthepreviousstep

EmployeeDataImport

18

https://s3.amazonaws.com/icehrm/images/blog-files/employees.csv

2. Oncetheentryiscreatedclickon"Process"

CreatingDataImporters

Youcancreatedataimportersforimportingcustomfieldsoranyotheradditionalfieldsintoemployees.

CreatingaDataImporterforUpdatingSupervisors

HereisanexampleofcreatingaDataImporterforupdatingsupervisorsandsomecustomfields

1. LoginasAdminandNavigatetoSystem->DataImporters2. CreateanewDataImporternamed"SupervisorandCustomFieldImporter"andData

Typeshouldbe"EmployeeDataImporter"

3. EachimportershouldhaveoneIDcolumn.Foremployees,theidcolumnshouldbe

EmployeeDataImport

19

employee_id.Hereishowyoucanaddthisuniqueidcolumn.4. Editthenewlycreateddataimporterandaddanewcolumnnamedemployee_id.Note

thatthevalue"iskeyfield"istrue

5. ThenaddthecolumnforSupervisor.Wecallthistypeofacolumnareferencetypecolumnbecauseitdependsonanotherrowinadifferentorsameentity

6. Notethatwehaveset"iskeyfield"totrue.7. Thenyoucanaddasamplecustomfieldtotheemployees(viaSystem->FieldNames

Setup->EmployeeCustomFields).

EmployeeDataImport

20

8. Fornow,wewilladdacustomfieldnamedContractEndDate

9. Nowyoucanaddacolumntotheexistingdataimporterforimportingdatafor"Contract

EndDate"10. NowyoucancreatetheCSVfileforimportingsupervisorandcontractenddatefor

employees.IntheCSVfile,thereshouldbethreecolumnsdefinedforEmployeeId,SupervisorandContractEndDate.Thesupervisorfieldshouldholdtheemployee_idofthesupervisor.

11. DownloadthefilealreadycreatedCSVfileforthisstepfromhere12. Cratea"DataImportFile"foruploadingthenewfile

EmployeeDataImport

21

https://s3.amazonaws.com/icehrm/images/blog-files/employee_supervisors.csv

13. Processthefile

EmployeeDataImport

22

AttendanceModuleIceHrmhasseveraldifferenttoolsformanagingandrecordingemployeetime.

AttendanceTrackingAttendancerepresentsthetimeyouwereinoffice.

RecodingAttendance

EmployeescanrecordattendanceviaTimeManagement->Attendance.Whilerecordingattendancetheycanselectthetimetheyarriveandleavetheoffice.

Whentrackingattendanceyoucaneitherletyouremployeesenterthetimewhenrecordingattendanceorconfigureittouseservertime.

AttendanceTrackingwithUserTime

UnderSystem->SettingssetAttendance:UseDepartmentTimeZonetoNo.Thiswillletyoursselectthetimewhenpunchinginandout.

AttendanceTrackingwithServerTime

Everyemployeeshouldbeattachedtoadepartment.ThesedepartmentsaredefinedunderAdmin->CompanyStructureandyoushouldhaveatimezoneforeachdepartmentdefined.Whenanemployeeattachedtoadepartmentrecordsattendanceicehrmusesthetimein

AttendanceModule

23

departmentstimezonetogeneratethecorrecttime.AllyouneedtodoissetthepropertimezoneandsetAttendance:UseDepartmentTimeZonetoYes.

MonitoringAttendance

Attendancedetailsofemployeescanbeviewed/editedviaEmployees=>Monitorattendancemodule.AdminuserscanviewallemployeeattendancewhileManagerscanviewattendancedataforsubordinates(directreports).

UploadingAttendanceData

Youcanuploadattendancedatafromyourattendancerecordingdevicesinsteadofallowingemployeestopunchin/outusingicehrm.

1. Downloadthesampleattendancefilefromhere

2. Thenaddyourattendancedatainthesameformat.

3. GotoSystem->Data->DataImportFilestab

AttendanceModule

24

https://s3.amazonaws.com/icehrm/images/blog-files/attendance_sample_import.csv

4. Createanewdataimportasshownbelow.Useadescriptivename

5. Saveandfromthe"dataimportfilelist"clickprocessbutton

Attendancewithphotoproof

AttendanceModule

25

Thisfeatureletsyouremployeestakeaphotoofhim/herattheofficeoratanyplaceyouwantthemtobeviathewebcamwhenpunchinginorout.Thishelptomakesuretheemployeeisathis/herdeskwhenaddingattendanceentry.

Readmoreaboutthishere

AttendanceSheetsAttendanceSheetswhichcanbeaccessedviaTimeManagement=>AttendanceSheetsisawayforemployeestogroupattendancedetailsforthewholeweekandsenditforapprovaltothesupervisor.Thisfeatureisusefulwhenyoupayemployeesbasedonattendance.Insuchcases,thereshouldbeanapprovalprocessinplace.

AttendanceModule

26

https://medium.com/@icehrm/how-to-prevent-buddy-punching-and-time-theft-73eb4c83aa29

AttendanceModule

27

TimesheetsTimesheetisadocumentwhichindicatesthehoursanemployeehasworked,separatedbydaysoftheweek.

InIceHrmemployeescanedittimesheetsunderTimeManagement=>TimeSheets.Thecurrentweektimesheetisautomaticallycreatedandtimesheetsforpastweekscanbecreatedbyclicking“CreatePreviousTimesheet”actionbuttononatimesheet.

ProjectsandClientsBeforestartingtopopulatetimesheetsyoushouldconfigureprojectsandclients.ThiscanbedoneviaAdmin=>Project/Clientssetuptab.

Eachandeveryprojectisattachedtoaclient.Becauseofthat,IceHrmallowsaddingclientswithbasicinformation.Onceclientsareadded,youcanstartcreatingaprojectfortheseclients.Theclientsectionrepresentsbothexternalandinternalclientsofthecompany.Thatwayyoucanattacheachandeveryprojecttoaclient.

Note:IceHrmisnotaprojectmanagementtool.Becauseofthatweonlystoreminimumdetailsaboutclientsandproject.ThisinformationisonlyusedforTimesheets.

AddingTimetoTimesheetsEmployeescanedittimesheetsviaTimeManagement=>TimeSheets=>AllMyTimesheets

Timesheets

28

Byclickingedittimesheetbuttonyoucanstartaddingtimeentriestothetimesheet.Timeentriesareassociatedwithprojects.Oneachtimesheet,youcanaddtimeforeachprojectforeachdayoftheweek.

Hereyoucanaddyourtime.(makesuretoaddtimeinhoursasdecimals.e.g:for2hoursand15minutesyoushouldadd2.25)

Makesuretoclicksavebuttontosaveyourchangestothetimesheet.Totaltimeintimesheetlistalsoupdatedaccordingtoyourchanges.

ProjectListonTimesheet

BydefaultallthedefinedprojectsunderAdmin=>Projects/ClientSetupisdisplayedintimesheetsofalltheemployees.

However,tolimitonlyselectedprojectstoanemployee:

1. Setthevalueof"Projects:MakeAllProjectsAvailabletoEmployees"settingunderSystem=>Settings=>Otherto"No"

2. AddonlyrequiredprojectstoemployeesunderAdmin=>Projects/ClientSetup=>EmployeeProjects

ViewTimesheets

Timesheets

29

Timesheetsdetailscanbeviewedbyclickingontheviewiconofanyofyourtimesheets.

TimesheetApprovalAfteraddingyourtimeentriesyoucansubmityourtimesheetforapproval.Thesupervisorshouldreceiveanotification.

SupervisoroftheemployeecanviewthetimesheetunderTimeManagement=>TimeSheets=>SubordinateTimeSheetsandapproveorrejectit.

Timesheets

30

DetailedTimesheetsInIceHrmthereisanalternativewaytoaddtimesheets.Thisisusefulifyouwanttoaddadditionaldetailsliketasktheemployeewasworkingonwithexactstartandendtimetothetimesheet.

Inordertoactivatethisfeaturesetthesetting"System:Time-sheetEntryStartandEndtimeRequired"to"Yes"underSystem=>Settings=>Systemtab.

Thenwhentheemployeeiseditingthetimesheettheviewwillbedifferentandhe/sheshouldbeabletoaddmoredetails.

Timesheets

31

ClientProjectTimeReportThisisaveryusefulreportbasedontimesheetstobillyourclientfortheworkyouremployeeperformed.EachemployeecangeneratethisreportviaUserReports=>ClientProjectTimeReport.

Timesheets

32

LeaveandVacationManagementIceHrmhasonceofthebestleavemanagementsystemsamongalltheHRMsoftware.Leavesmoduleisusedtodefinealltheelementsrequiredtomanageleaveapplicationprocessofyourcompany,

including:

LeaveperiodsLeavetypesWorkweekHolidaysLeaverules

LeavePeriods

AleaveperiodusuallyayearbutcanbedifferentaccordingtocompanyHRprocesses.Leaveperiodscan’toverlap,whichmeansifanemployeeappliedforannualleavesinleaveperiodfor“Year2014”,hisleavebalanceinleaveperiod“Year2015”won’tgetaffected.Thisissameforalltypesofleaves.Alsoiftheleaveperiodforyear2015isnotdefined,employeeswon’tbeabletoapplyleavesfor2015.

LeaveTypes

Leavetypetabdefinestypesofleaveswhichcanbeappliedbyemployees.

AddinganewLeaveType

Whenaddingaleavetypeyouneedtosetfollowingfields

VacationandLeaveManagement

33

Field Description

Admincanassignleavetoemployees

If“Yes”isselected,anAdminoraManagerisabletologinasanemployee(Pleasecheckswitchemployeeconceptexplainedinemployeemodule)andapplythistypeofleavesbehalfoftheemployee.

Employeescanapplyforthisleavetype

If“No”isselected;onlyanAdminoraManagerisallowedtoassignthistypeofleavetoanemployee.(Anemployeewon’tbeabletoapplythistypeofleave).

LeavesperYear

Thisisthenumberofleavescanbeappliedbyanemployeeperyear(orthecurrentleaveperiod).IftheleaveperiodislessthanaYearthisisthenumberofleavesfortheleaveperiod.

LeaveAccrueEnabled

Ifthisissetto“Yes”,employeeswon’thavealltheleavesaddedtotheirleavebalanceatthebeginningoftheleaveperiod.Insteadleavesgetaccruedforeverypassingdayinleaveperiod.Foranexampleifforaparticularleavetypenumberofleavesperperiodisdefinedas24andleaveperiod(having12months)isstatingfromJanuary,attheendofJanuaryanemployeewillbeableapplyfor2leavesofthisleavetype(24/12)

LeaveCarriedForward

Ifanemployeehassomeleavebalanceremaininginpreviousleaveperiod,thatamountwillgetaddtothecurrentleaveperiod.


34

PercentageofLeavesCarriedForward

Ineachyear(orperiod)whatpercentageofremainingleavesshouldbecarriedforward.

MaximumCarriedForwardAmount

Maximumnumberofleavedayswhichcanbecarriedforwardedfromoneyeartoanother.Setto0forunlimited

CarriedForwardLeaveAvailabilityPeriod

Forhowmanydayscarriedforwardleavesareavailablefromthestartdateofnextleaveperiod.

ProportionateLeavesonJoinedDate

Whethertheavailablenumberofleavesshouldbecalculatedbasedonnumberofdaysemployeeworkinagivenleaveperiod.(e.gifanemployeejoinedinendofJune,he/shewillonlygethalfofthenumberofleavesspecifiedforgivenleavetype.

WorkWeek

Workweekdefinesthedaysthatyouremployeesareworking.Whenanemployeeisapplyingforaleave,workweekistakenintoconsideration.ForanexampleifyoucompanyworksonlyfromMondaytoFridayandifanemployeeappliedforaleavefortwocontinuousweeksincludingweekends,SaturdaysandSundayswillNOTbecountedforleaveapplication.

Insomecases,companiesneedtokeepdifferentworkweeksfordifferentcountries.ForanexampleifyourbranchinUKworksahalfadayonSaturdaythenyoucanaddthatasshownonfollowingimage.AlltheleavecalculationsofUKbasedemployees(employee:countryfieldshouldbesettoUK)willbedoneaccordingtoextendedworkweekdefinedforUK.


35

Holidays

Holidaysdefinesthelistofholidaysforallleaveperiods.Itisadvisedtodefineallholidaysforalltheenabledleaveperiods.Ifanemployeeappliesforaleavewhichincludesaholiday,theleaveforholidaywon’tbecounted.Justliketheworkweek,youcanhavedifferentholidaysdefinedfordifferentcountries.Infollowingexample2014-12-18definedasaholidayonlyforUK.

Employeeleaves


36

Employeeleavestablistsalltheemployeeleaves.Anadministratorcanviewdetailsofleavesandtakeactionsonit(ApproveorReject).AdminshouldusuallyusethisfeaturewhentheSupervisorofthepersonwhoappliedtheleaveisnotabletodoit.

EmployeeLeaveEntitlement

Alltheemployeesareallowedtocheckthereleaveentitlement.Itshowasummeryoftheirleavebalancesforthecurrentleaveperiod.

Field Description

AvailableLeaves Numberofleaveremainingthatyoucanapplyduringcurrentleaveperiod

PendingLeaves Numberofleaveyouhaveappliedbutnotapprovedorrejected

LeavestobeAccrued

IftheLeaveAccrueEnabledissetfortheleavetype,thiswillshowhowmanyleavedayswillbeaddedtoyourleavebalancebyendofcurrentleaveperiod

LeavesCarriedForwarded

Leavedayscarriedforwardfrompreviousleaveperiods

LeaveGroups

Leavegroupscanbeusedto:

1. Groupasetofemployeesandcreateleaverulesaffectingallemployeesinthegroup.


37

2. Selectivelyallowsomeleavetypesonlytoagroupofemployees(foranexampleyoucanassignMaternityleavesonlytofemaleemployees)

Inordertodothis:

Firstcreatetheleavegroupunder“LeaveSettings”->”LeaveGroups”->”EditLeaveGroups”.

Addemployeestoleavegroup

CreatealeavetypeforMaternityleavebyspecifying“Femaleemployeesgroup”.Nowonlyemployeesaddedtothatgroupwillbeabletoapplyformaternityleaves

LeaveRulesByExamplesLeaverulesisoneoftheuniqueandadvancedfeaturesofICEHrm.Usingleaverulesyoucanoverwritethebehaviorofleavetypesforjobtitles,employmentstatusesorevenindividualemployees.

Followingexampleswillshowyoutheproperwaytouseleaverules

Example1

ToenableallSoftwareEngineerstoapplyfor20annualleaves,youneedtoaddanewleaveruleasshownbelow


38

Example2

EnableallSoftwareEngineerswhoarepermanentemployeestoapplyfor10medicalleaves

Example3


39

Donotallowcontactworkerstoapplyforcasualleaves.Onlyadministratorisallowedtoapplycasualleavesbehalfofthemwithamaximumlimitof5leavesperleaveperiod

ImplementingaSampleLeavePolicySettingUpLeaveModule

SinceI'vehavenoticedthatitsnotatrivialtasktosetuptheicehrmleavemoduleinitiallywhenmovingfromanotheractiveleavemanagementsetup,I'mwritingthistowalkyouthroughashorttutorial.

Let'sassumefollowing:

1.Youaremovingtheleavemanagementsystemtoicehrm,inthemiddleoftheleaveperiodfor20152.Someofyouremployeeshaveleavescarriedforwardedfrom2014,whichmightnothavebeenused3.Yourcompanyhaveannualleavewhichcanbecarriedforwardedtonextyear4.Therearecasualleavewhichareaccrued1.5pereachmonth5.Someemployeeshavejoinedin2015andtheirleaveentitlementshouldbeproportionateaccordingtojoineddate

Settingupleaveperiods


40

Firsttaskissettinguptheleaveperiods.Ifyouarestartingfrom2015youonlyneedtohavethe2015leaveperiod.Butcreatingaleaveperiodfor2016alsoshouldnotbeanissue.Creatingaleaveperiodfor2014willcarryforwardwhatevertheremainingleavesfrom2014to2015.Inthatcaseyouhavetoenterallemployeeleavedetailsfor2014manuallyintoIceHrm.SothepreferredwayistonotcreatethepreviousleaveperiodbyaddingallleavecarriedforwardedbyemployeesusingPTO(thiswillbeexplainedinanothersection).

Alsonotethatleaveperiodcanhavedifferentlengthsandcanbestartedfromanymonthoftheyear.

Settingupleavetypes

1. Letssetuptheleavetypeforannualleavewhichcanbecarriedforwardedtothenextyear

HereI'vesetleavecarriedforwardto'Yes'andcarryforwardpercentageto100%soalltheremainingannualleaveofthisyearwillbecarriedforwardtothenext.

1. Settingupcasualleavewhichareaccrued1.5pereachmonthandshouldnotbecarriedforwardtothenextyear


41

Ihaveentered18forleaveamount,thiswillaccrue1.5(18/12)dayspermonthsinceleaveperiodlengthfor2015is12months

Employeeleaveentitlement

Nowassumewehaveanemployeenamed'JhonDoe'.Hisleaveentitlement(under"Leave"=>"LeaveManagement"),afteraboveleaveperiodsandleavetypesareaddedshouldlooklikethis:

Thereare14.39leavesaccruedforthisyear(fortheperiod2015-01-01to2015-10-19).Alsoitshowsthenumberofdaythatwillbeaccruedtillendoftheyearfromnow,whichis3.61days

Addingleavebalancefrompreviousyear

Theotherproblemyouwillfacewhileadoptingicehrmleavemanagementismovingleavebalancefrompreviousyearinathirdpartyleavemanagementsystemtoicehrm.InordertodothisyoucanusePTO.ForanexampleifJhonDoehas3annualleavedaysremainingfrom2014(butyouarenotabletoautomaticallymoveitto2015becauseyouhavenotbeenusingicehrmin2015),youcanaddaPTOdaysasshownbelowthrough"Admin"=>"LeaveSettings"=>"PTO".


42

AfteraddingtheleavebalanceyouwillnoticethatJhonDoehas17annualleavesinsteadof14inhisleaveentitlement

AlsoyoumayaddnegativeleavebalancesunderPTOforcurrentyeartoreflectalreadytakenleavesbyemployees.

Proportioningleavesrespecttojoineddate

Let'sassumeJhonDoejoinedthecompanyinMay2015andshouldnotbeallowedtotakeonlyapatofleavecountdefinedfor2015.Thenforannualleavedefinitionunder"Admin"=>"LeaveSettings"=>"LeaveTypes"youcaneditAnnualLeaveandmake"ProportionateleavesonJoinedDate"="Yes"

IfthisissetthenJhonDoewillonlybeentitledfor18*(8/12)annualleavesfortheyeargivenhehasjoinedon1stofMay2015

LeaveManagementFAQ

Leave/PaidTimeOffManagement

Howtoallocate160hoursinsteadofdaysinleavemanagementmodule?

Whenaddingleaveentitlementyoushouldprimarilyuseleavetypes.Sinceyouaregetting160hoursayearyoucancreatealeavetypecalledAnnualleaveandadd20(160/8)daysasleaveamountforthatleavetype.IceHrmassumesa8hourworkday.Sowhenyoudothatyoucanapplyforaleavefor1dayor1hour.Ifyouapplyfora1dayleaveyourleaveentitlementavailableleavecountwillbecome19.Ifyouapplyforonehourit'lltakeaway0.125fromyourleaveentitlement.


43

Howtoallocatedifferentamountsofleavetodifferentemployeesorcategories?

Let'ssaysomeemployeeshaveonly150hoursofpaidtimeoff.(Foranexampleall"MarketingManagers").ToimplementthisyoucangotoaddaleaveruleforMarketingManagersforannualleavewithleaveamountofonly18.75days(150/8).Leaverulesarenotboundtoanyleaveperiod,sotheleaverulesthatyoudefinewillbeappliedtoalltheleaveperiods.

HowtocompensateanemployeewithPaidtimeoff?

Assumethatanemployeeworkedonaholidayduetosomeurgentissue.Youneedtocompensatehim/herwithanadditionaldayoff.Inthatcaseyoucanuse"PaidTimeOff"tabtoaddanadditionalleavetotheemployee.Paidtimeoffalsousedtoaddleavescarriedforwardedfrompreviousyearswhereyouhavenotbeenusingicehrm.IfyouwanttoremovesomeleavefromanemployeeyoucanaddminusPTOalso.

I'venotbeenusingIceHrmduring2015,Butwhenconfiguringleavebalancesfor2016differentemployeesarehavingdifferentleavebalancescarriedforwardedfrom2015.Howtohandlethis?

YoushouldaddtheseasPTOamountsforleaveperiod2016under"PaidTomeOff"tab.Youwillhavetoaddonerecordforeachemployee.Thisisaonetimesetup,from2017youcanuseautomaticleavecarryforwarding.


44

ImplementingaSampleLeavePolicywithIceHrm

IntroductionIcehrmhastoolstoimplementcomplexleavepolicies.Somostofthecompaniesarecoveredbyit.Foranexample,duetogovernmentregulationsofsomeEuropeancountries,theleavepoliciesofcompanieshasbecomeabittoocomplicated,butstill,IceHrmcanhandlethose.

Thissectiondescribestheprocessofimplementinganadvancedleavepolicywhichinvolvesmultipleleavegroupsandrulesinmultiplecountries.

ExampleLeavePolicyLet'sthinkofacompanyoperatinginGermanyandSingapore.

SetupLeavePeriods

InIceHrmeachLeavedayisattachedtoaLeavePeriod.SoIt'simportanttoconfiguretheLeavePeriods.LeavePeriodsaredisplayedunderAdmin=>LeaveSettings=>LeavePeriods

Ifyourcompanyhasnotbeenusingicehrmbefore,itisrecommendedtodeleteallpreviousleaveperiodsandkeeponlythecurrentleaveperiod.

AftersettingupleavetypesyoucanmanuallyaddalldetailsaboutcarriedforwardleavedaysandalreadytakenleavedaysusingPaidTimeofftabunderLeaveSettings**

LeaveTypesinSingapore

CompanyLeavePolicy

45

Singaporecompanyhasthreeleavetypes.

AnnualLeave

Everyemployeegets14daysoffperyear.Remainingleavedayscanbecarriedforwardindefinitely.Foranexample,ifyouwereanemployeesince2016andtook10,13annualleavedaysrespectivelyin2016and2017,by2018youwillhave19annualleavedays.14from2018and5daysfrompreviousyears.

CreatingLeaveTypeforAnnualLeave

1. LogintoIceHrminstallationasanadmin2. GotoAdmin->LeaveSettings3. Ifyouhavecreatedafreshinstallation,deleteexistingleavetypes4. Addanewleavetype(nameitas"AnnualLeave")5. SetLeavesperLeavePeriodto146. SetAdmincanassignleavetoemployeestoYes7. SetEmployeescanapplyforthisleavetypetoYes8. SetLeaveCarriedForwardtoYes(Asyouneedtocarryforwardremainingleaveto

nextperiod)9. SetPercentageofLeaveCarriedForwardto100asyouneedtocarryforward100%of

theremainingleave10. SetMaximumCarriedForwardAmountto0.Settingthisto0willremovethelimitation

oncarriedforwardleavedays11. SetCarriedForwardLeaveAvailabilityPeriodtoNoLimit.Thiswillallowemployeesto

carryforwardAnnualLeaveindefinitely12. SetSendNotificationEmailstoYes.Thiswillsendoutemailstoapproverswhena

leaveapplicationissubmitted13. SelectaLeaveColor.Thiswillbeusedtoshowleavedetailsonleavecalendar

CompanyLeavePolicy

46

CasualLeave

Eachemployeegets7daysperyear.Cannotbecarriedforward

CreatingLeaveTypeforCasualLeave

1. AddanewleavetypeforCasualLeave.Thesettingscanbeseeninthescreenshot2. NotethatyoushouldsetLeaveCarriedForwardtoNo

CompanyLeavePolicy

47

MaternityLeave

Aworkingmothercantakethisleave4weeksbeforeexpecteddateofchildbirth.Upto48leavedayscanbetaken.

CreatingLeaveTypeforMaternityLeave

1. AddanewleavetypeforMaternityLeave.Thesettingscanbeseeninthescreenshot2. Formaternityleave,wedonotneedtoenableaccrueorcarryforward.

CompanyLeavePolicy

48

InitialTestforLeaveSettings

Addingtestemployees

Fortesting,wehaveadded5employees.

AsyoucanseesomeemployeesarebasedinSingaporeandsomearebasedinGermany.

InitialTestforLeaveBalances

CompanyLeavePolicy

49

FortestingtheleavebalanceofeachofthemyoucanusetheEmployeeLeaveEntitlementreport.GotoAdminReports=>Reportstogenerateit.

Herealltheemployeesareentitledtohavealltheleavetypes.Also,theleavenumbersareasexpected.

CompanyLeavePolicy

50

AddingLeaveTypesbyCountry

Asyoucanseethereisaproblemwithaboveleaveentitlementreport.Theleavetypeswehavedefinedareentitledtoalltheemployees,eventheonesbasedinGermany.

Inorderto,correcttheproblem,youneedtouseleavegroups.Leavegroupsisawaytoallowonlycertainemployeestheabilitytoapplyforcertaintypesofleave.

DefiningaLeaveGroupforSingapore

DefineaLeaveGroupforSingaporeunderAdmin=>LeaveSettings=>LeaveGroups=>EditLeaveGroups

ThenaddSingaporeemployeestothisgroupunderAdmin=>LeaveSettings=>LeaveGroups=>LeaveGroupEmployees

AsthenextstepsetLeaveGroupoftheAnnualLeavetoSingapore

RepeatthisforothertwoLeaveTypesaswell.

CompanyLeavePolicy

51

SecondTestforLeaveBalances

NowgeneratetheEmployeeLeaveEntitlementreportagain.NowyouwillseethatonlySingaporebasedemployeesareentitledforLeaveTypeswejustcreated.

AllowMaternityLeaveonlytoWorkingMothers

WestillhaveaproblemwithaboveleaveentitlementforSingapore.OnlyworkingmothersshouldbeallowedtoapplyforMaternityLeave.ThiscanbeachievedbyaddinganewLeaveGroup.

1. AddaLeaveGroupNamed"SingaporeWorkingMothers"

CompanyLeavePolicy

52

1. AddNicoleSmithtoLeaveGroup"SingaporeWorkingMothers"

1. GotoLeaveTypetabandchangetheLeaveGroupforMaternityLeaveto"SingaporeWorkingMothers"

1. UnderEmployees=>EmployeesswitchtoNicoleSmith.ThiswillletyouusetheapplicationasNicoleSmith

CompanyLeavePolicy

53

1. OpenLeave=>LeaveManagement=>LeaveEntitlement.Thiswillshowallthreeleavetypes

ThirdTestforLeaveBalances

NowgeneratetheEmployeeLeaveEntitlementreportagain.NowyouwillseethatNicoleSmithisentitledtoMaternityLeave.ThisisbecauseofMaternityLeaveisunderLeaveGroupSingaporeWorkingMothersandonlyNicoleSmithisinthatLeaveGroup.

CompanyLeavePolicy

54

LeaveTypesinGermany

TheGermancompanyhasthreeleavetypes.

Vacation

Everyemployeegets25daysoffperyear.Remainingleavedayscanbecarriedforwardforthreemonths.

Iftheemployeehasbeenworkingformorethan2years.Theyget1additionalvacationday.

Iftheemployeehasbeenworkingformorethan3years.Theygetanother1additionalvacationday.

Iftheemployeehasbeenworkingformorethan4years.Theygetanother2additionalvacationdays.

Foranexampleofyour5thyearinthecompany,youget29vacationdays.

CreatingLeaveTypeforVacation

1. CreateaLeaveGroupforGermany

CompanyLeavePolicy

55

1. AddallotheremployeestothisLeaveGroup

1. CreateaLeaveTypenamedVacation.Setleavecarryforwardenableandallowcarryforwardto3months.Also,makesuretosettheLeaveGrouptoGermany

CompanyLeavePolicy

56

SickLeave

EmployeesareentitledtoSickLeavegivenwithoutalimitation.Wewillsetalimitof14daysperyearforSickLeavebutallowemployeestoapplyitwithoutarestrictionbysettingEmployeescanapplybeyondthecurrentleavebalancetoYes.

CreatingLeaveTypeforSickLeave

CompanyLeavePolicy

57

ForthTestforLeaveBalances

NowgeneratetheEmployeeLeaveEntitlementreportagain.OnlyemployeesinGermanyshouldbeentitledtoVacationandSickLeave.

CompanyLeavePolicy

58

Butstill,wehaveaproblemwithVacationLeave.Howtoapplydifferentamountsofleavetoemployeesbasedonyearsofexperience.

ThiscanbeimplementedusingLeaveRules.

CreatingLeaveRulesforVacations

LeaverulesareawaytoalterLeaveTypesforindividualorspecificgroupsofemployees.Foranexample,youcanincreasethenumberofleavedaysonlyforemployeeshavingpermanentworkcontractsbyaddingaLeaveRule.

VacationLeaveRule(Employeeshaving2YearsofExperience)

1. GotoAdmin=>LeaveSettings=>LeaveRules

2. CreateanewLeaveRuleforLeaveTypeVacation.SettheRequiredExperience(Days)to730whichis2yearsandNumberofLeaveDaysto27,asweneedtogive2additionalleavedaytoemployeeswhoworkedmorethan2years.*ThisLeaveRulewillbeappliedtotheemployeeshavingmorethan730daysbetweenthejoineddatelistedonprofileandthestartdateofthecurrentleaveperiod.

CompanyLeavePolicy

59

1. InordertocreatetheLeaveRulefor3years,copythe2-yearleaveruleandchangeRequiredExperience(Days)to1095(3Years)andNumberofLeaveDaysto28

2. InordertocreatetheLeaveRulefor4years,copythe3-yearleaveruleandchangeRequiredExperience(Days)to1460(4Years)andNumberofLeaveDaysto30

CompanyLeavePolicy

60

FifthTestforLeaveBalances

NowgeneratetheEmployeeLeaveEntitlementreportagain.

JasonWoodhas30daysofVacationashejoinedinAug2005

NoahSchmidthas25daysofvacation.HejoinedinMarch2016.Butthereisnotmorethan730daysbetweenjoineddateand1stdayofthecurrentleaveperiodwhichis1stofJan2018

JohannaFischerhas27leavedaysassheiseligiblefor2-Yearvacationleaverule.ShejoinedinMay2015andtherearemorethan730daysandlessthan1095daysfromthejoineddateto1stofJan2018

AddingInformationaboutpreviouslytakenLeaveDays

EventhoughyoujustconfiguredyourcompanyleavepolicyinIceHrm,youremployeesmighthavebeenapplyingforleavesevenbefore.

AssumeyoumigratedtoIceHrminMarch2018.Inthiscase,youcanusePaidtimeofftabtoaddalreadytakenleavedetailsforemployees.ForanexampleassumeJasonWoodhasalreadytaken5VacationDaysoff.AndJohannaFischerstillhave6Vacationdayscarriedforwardfromthepreviousyear.

InordertoimplementthisyoucanaddanegativepaidtimeoffforJasonWoodpositivepaidtimeoffforJohannaFischer.

1. VisitAdmin=>LeaveSettings=>PaidTimeoff

2. Add-5VacationdaysforJasonWood

CompanyLeavePolicy

61

1. Add6VacationdaysforJohannaFischer

SixthTestforLeaveBalances

NowgeneratetheEmployeeLeaveEntitlementreportagain.

AsyoucanseeJasonWood'sVacationdaysarereducedfrom30to25andJohannaFischer'sVacationdaysareincreasedfrom27to33.

AddingcompensatedLeavedays

CompanyLeavePolicy

62

AssumeJohannaFischerworked2additionalSaturdaystogetyoururgentprojectreleased.SoyoucancompensateherwithtwoadditionalVacationdaysusingPaidtimeoff.

MakingSaturdayaHalfDayinSingapore

Currently,bothofficesonlyworkfromMondaytoFriday.Let'ssayyouwanttomakeSingaporeemployeesworkhalfadayonSaturdayalso.

1. VisitAdmin=>LeaveSettings=>WorkWeek2. AddaworkdayforSaturdayinSingapore

NotethatthiswillbeappliedtoemployeeshavingCountrysettoSingapore**onthereprofile.

CompanyLeavePolicy

63

FewLastNotes

1. WhenanemployeeappliedforaLeavehis/herLeaveBalancewillbeupdatedonlywhentheleaveisapproved

2. UntiltheLeaveisapprovedemployeehastheabilitytodeleteit.

3. Aftertheapproval,theemployeecancanceltheLeave.Butthecancellationrequestwillbesenttothesupervisorandonlyafterthecancellationrequestisapproved,theleavebalancewillbeupdated.

4. LeavedayswillbecarriedforwardonlyfromLeavePerioddefined.Foranexample,ifyouhaveleaveperiodsdefinedfor2017and2018,leavedayswillbecarriedforwardonlyfrom2017to2108.Leavedayscouldhavebeencarriedforwardfrom2016willbeignored.

5. AfterconfiguringLeaveTypesifyouareseeingwirednumbersasbalancesfirstcheckwhetheryouhavepreviousleaveperiodsdefinedwhichareactuallynotrequired.Whenyouenableleavecarryforwardingandthereisapreviousleaveperioddefined,currentleaveperiodwillgetleavedayscarriedforwardfrompreviousleaveperiod.

6. Alltheemployeeleaverequestsshouldbeapprovedbythesupervisororanadmin.Anadmincanapproveanyleaverequest.

CompanyLeavePolicy

64

LeaveRequestsandApprovalThissectionexplainstheprocessofanemployeeapplyingforaLeaveandsupervisors,approversoradminsapprovingorrejectingtheleaverequest.

ApplyingforLeaveAnyemployeecanapplyforaleaveviaLeave=>LeaveManagementmenu

Whenapplyingforaleave,theemployeecanselecttheperiodtoapplyfortheleaveandtheninthenextsteptheycanselectwhattypeofleavetheywanttoapply(full-day/half-dayorpartial)


65

Whentheleaveapplicationissubmitted,theemployeeandthesupervisoroftheemployeewillreceiveemailnotifications


66

ThesupervisoroftheemployeecanviewleaverequestviaLeave=>LeaveManagement=>SubordinateLeavetab(Indirectsupervisorsalsowillbeabletosee/approveleaverequestsifthesetting"Leave:AllowIndirectAdminstoApprove"issetto"1")

Thesupervisorcanviewleaverequestdetailsandthenapproveorrejecttherequest


67


68

Whentheleaverequestisapprovedorrejected,anemailissenttotheemployeewiththeresult

Leaveentitlementoftheemployeeisupdatedaccordingly.Amountofleavedaysis1.875becauseithasafullday(1),half-day(0.5)andathree-hourleave(3/8).1+0.5+3/8=1.875

CancelingLeaveRequests

1. Ifaleaverequestisnotapproved,itcanbejustcancelledbytheemployee

2. Forapprovedleaverequests,theemployeeneedstosendacancellationrequest(viaLeaveManagement,ApprovedLeavetab).Thiscancellationrequestwillbesenttothesupervisorandonlywhenthesupervisorapprovethecancellationrequesttheemployee'sleaveentitlementwillbeupdated

ManageLeaveRequestsasanAdmin


69

AnadminhasaccesstoalltheemployeeleaverequestsviaAdmin=>LeaveSettings=>EmployeeLeaveList.Thefilterbuttoncanbeusedtofilterleaverequestsfromolderleaveperiodsalso.Adminhastherighttoapprove/rejectanyleaverequest


70

RecruitmentRecruitmentmodulecanbeusedto:

PostjobsLetcandidatesapplyforthesejobsScheduleinterviewsTrackcandidateprogresswithnotesSharejoblinkswithlinkedIn,facebook,twitterandgoogle+directlyfromicehrm

RecruitmentSetupRecruitmentsetupmenuisavailableunder"Recruitment"=>"RecruitmentSetup".Hereyoucanadd/editEmploymentTypes,Experiencelevels,JobFunctions,EducationLevelsandBenefits.Alltheseinformationwillbeusedwhenpostingajob.

PostingaJobJobscanbepostedvia"Recruitment"=>"JobPositions".Followingtablewilllistoutmainfieldsusedtocreatejobpostings

RecruitmentManagement

71

Fields Description

JobCodeAuniquecodetoidentifythejobposition.Urlforapplyingthejobpositionwillcontainthiscode.

JobTitle Thejobtitle

Short

Description

Ashortdescriptionaboutthejobposition.Thiswillbedisplayedwhenlistingcompanyjobs.Thepublicurlforcompaniesopenpositionsis,http://icehrm_url/entry.php?g=admin&n=candidates

Description Fulldescriptionofthejobposition

ShowSalary Whetheryouwanttoshowthesalaryrangeforthisjobposition

Keywords KeywordsforimprovingsearchandSEO

Status Onlyactivejobswillgetlisted

Image Attachanimageifyouwanttoshowanimagewithjoblisting

JobPosition-DisplayType

Youshouldselectadisplaytypewhenpostingajobposition.Thissectiondetailsthefordisplaytypessupportedyicehrm

Fields Description

Text

Only

Onlytextwillbedisplayede.g:Textad

Image

Only

Onlyanimagewillbedisplayed.TheimagefortheadshouldbeprovidedinImagefieldwhencreatingjobpositione.g:Imageonlyad

Image

andFull

Text

Usethisdisplaytypewhenyouwanttoshowanimageforthejobpositionwithafulldescriptionanddetailssuchassalary,requirementsandbenefits.

Image

and

Other

Details

Usethisdisplaytypewhenyouwanttoshowanimageforthejobpositiononlywithaminimumsetofmetadataaboutthejobpositionsuchassalary,employmenttype,experience,jobfunctionsandclosingdate.


72

http://apps.gamonoid.com/icehrm-hosted/entry.php?g=admin&n=candidates&ref=JC002

http://apps.gamonoid.com/icehrm-hosted/entry.php?g=admin&n=candidates&ref=J0003

SharingyourjobpositiononsocialmediaandusingdirectlinksYoucansharecreatedjobpositionsonGoogle+,Facebook,TwitterandLinkedIndirectlyfromIceHrmusingsociallinksonjobpositionsmodule.Alsoyoucangetadirectlinktothejobpositionwhichyoucansendviaemailoranyothermediabyclickingon"JobLink"icon.

CandidatesStorecandidatedetailsReceivejobapplicationsfromcandidatesviajobpostingsScheduleinterviewsTrackcandidateprogresswithnotes

Aftercreatingajobpositionyoucanlistallthecandidateswhohaveappliedforthejobpositionvia"Recruitment"=>"Candidates"module.Itshouldlistallthecandidateswhohaveappliedforyourjobs.


73

Hereyoucanscheduleinterviewsandaddnotesrelatedtothecandidate.Notescouldbeadetailsaboutatelephoneconversationorcandidatesexpectations.


74

DocumentManagementInIceHrmyoucanmanagecompanydocumentsaswellasindividualemployeedocuments.

CompanyDocumentsCompanydocumentscanbeaddedviaEmployees=>DocumentManagement.Dependingontheconfidentialityandnatureofthedocumentitcanbesharedonlywithindividualemployees,allemployeesattachedtoadepartmentoralltheemployeesinthecompany.

EmployeescanviewcompanydocumentsviaDocuments=>MyDocuments=>CompanyDocuments

DocumentManagement

75

EmployeePersonalDocuments

DocumentTypes

AccessedviaEmployees=>DocumentManagement=>DocumentTypes

DocumentTypestabisusedtodefinevariousdocumentsrelevanttoyourorganization.Theemployeesareabletouploaddocumentsunderthesecategories.

ExpireNotifications

Whendefiningdocumenttypesyoucandefinebeforehowmanydaysicehrmshouldnotifytheuserabouttheexpiringdocuments.

Thenotificationcronshouldbesetupforthisfeaturetofunctionproperly.Pleasecheckthesection[CronforNotifications](https://thilinah.gitbooks.io/icehrm-guide/content/installation-and-setup.html)

EmployeeDocuments

AdministratorsandManagerscanuse"EmployeeDocuments"tabtoexploreandmanagedocumentsuploadedbyemployeesoraddnewdocumentstoemployees.

Settings

Set"Notifications:SendDocumentExpiryEmails"toNoifyoudon'twishtoreceivedocumentexpirynotifications.

AlsosetNotifications:CopyDocumentExpiryEmailstoManagertoYesifyouwanttosendalldocumentexpirynotificationstorespectivemanagersalso

DocumentManagement

76

https://thilinah.gitbooks.io/icehrm-guide/content/installation-and-setup.html

SettingUpTrainingModuleTrainingmoduleinIceHrmcanbeusedtomanageprocessofprovidinginternaltrainingsforemployees.

Intrainingmodulewehavecourses,trainingsessionsandtrainingsubscriptionmanagement.

1. Admins/Managerscandefinecourses2. Admins/Managerscanusecoursestocreatetrainingsessions3. Admincanassigncoursestoemployeesoremployeescansubscribe4. Employeescanmarktrainingsessionsasattendedandattachaproofofcompletionif

required5. Admins/Managerscanapprovethatthetrainingsessioniscompletedbytheemployee

AddinganewCourse

Field Description

Code Eachcourseshouldhaveacode

Name Thecoursename

Coordinator

Theemployeeofthecompanywhoisresponsibleforcoordinatingthecourse.Insomecasescoordinatorcouldbethetrainer/instructoraswell

Trainer Nameofthepersonwhoconductthecourse

Payment

Type

Whetherthecourseissponsoredbythecompanyorpaidbytheemployee

Mostoftheotherfieldsareselfdescriptive

AddinganewTrainingSession

TrainingModule

77

Field Description

Name Nameofthetrainingsession

Course Selectthetrainigncourse

ScheduledTime Whenthistrainingsessionisscheduled

AssignmentDue

Date

Ifthetrainingsessionhasanassociatedassignment,theduedateforthat

Delivery

Method

Whetherthetrainingsessionisdeliveredinaclassroom,onlineoritsaselstudysession

Attendance

Type

-Assign=Onlyadmins/mangerscanassignthesessiontoemployees-SignUp=Sessionisopenforemployeestosignup

Attachment Anattachmentwithotherresourcesforthesession

Training

Certificate

Required

IfYes,employeeshavetoattachaproofofcompletion(suchascertificate)beforemarkingthetrainingsessionascompleted

SubscribingtoaTrainingSession

1. AnemployeecansubscribetoatrainingsessionviaTraining=>Trainingmodule.2. Goto"AllTrainingSessions"tab3. Clickonsubscribebutton

AttendanceType

EmployeescanonlysubscribetotrainingsessionshavingAttendanceTypesetto"SignUp"

TrainingModule

78

CompletingaTrainingSession

Onceanemployeeparticipatedinatrainingsessionhe/shecanmarkthetrainingascompletedviaTraining=>Training=>MyTrainingSessionstab.Oncethisisdoneanotificationwillbesenttothesupervisortoapprovethetrainingsession.

ProofofCompletion

Ifthetrainingsessionrequiresaproofofcompletion,employeehastoeditthetrainingsessionunder"MyTrainingSessions"tabandattachaproofofcompletionbeforesubmittingitforapproval

ApprovingaTrainingSession

Onceanemployeemarkatrainingsessionascompleted,thesupervisorwillreceiveanotificationtoapproveit.

Ifallthethingsareinorder,thesupervisorcanapprovethetrainingsessionviaTraining=>Training=>TrainingSessionsofDirectReportstab

TrainingModule

79

Expenses

ConfiguringExpensesModule

ExpensecategoriesandpaymentmethodscanbeconfiguredunderEmployees->ExpenseAdministration.AlsoManagerscanviewandapproveorrejectsubordinateexpensesunderthesamemodule.

Adminscanviewandeditexpensesfromallemployees.

AddingExpenses

EmployeescanaddexpensesunderFinance->Expenses.

ApprovalProcess

Youcandefine1st,2ndand3rdlevelapproversforemployees(whileeditinganemployee).Theseapproversandemployee'sdirectsupervisorwillbeinvolvedinapprovalprocessofmostoftheentitiesaddedbyemployees.

ExpenseManagement

80

Pre-ApprovingExpenses

IftheSettingExpense:Pre-ApproveExpensesissettoYes,allnewexpenseswillbeapprovedautomatically

Reporting

ExpenseManagement

81

ExpensereportcanbedownloadedunderAdmin->Reportsbyspecifyingadaterange.

ExpenseManagement

82

PayrollManagement

PayrollModuleUsage

YoumayuseIceHrmtoachievefollowingtasks:

StoreemployeesalarydetailswithandgroupintosalarycomponentsCalculatevariousdeductionsIncludeovertimepaymentsintoemployeesalaryslipsdependingonnumberofhoursAddsalarycomponentsbasedonattendancesheetsAllowemployeestodownloadpayslipsinPDFformat

UnderstandingEmployeeSalaryandSalaryComponents

Whenpayingsalarytoyouremployeesyoucanhaveitdividedintoseveralcomponents.WhenyoucreateanewinstallationofIceHrmwepre-definesomeSalarycomponentsandgroupthesesalarycomponentsaccordinglyforyourconvenience.

Ifrequiredyoucanaddmore.(Youmayview/editSalaryComponentsundermenuPayroll=>Salary)

SalaryComponentTypes

AlsoinordertomakeitmoreeasytodefinetaxesandotherdeductionsonsalarycomponentswegrouptheseintoSalaryComponentTypes

DefiningSalaryforYourEmployees

YoucanaddsalaryinformationforyouremployeesunderPayroll=>Salary=>EmployeeSalaryComponentstab.

PayrollManagement

83

Thiswayyoucandefineothersalarycomponentslikeallowancesandhourlypaydetails.

CreatingCompanyPayroll

CompanypayrollisavailableunderPayroll=>Payrollmenu.WehavealreadyaddedinformationforcalculatingpayrollforSriLankaandGhana.Youcandeleteallthesebeforestartingtoworkonyourpayroll.Butsometimesthesedatacancomehandyasanexampleforbuildingyourpayroll.

AddingaCalculationGroupForGermany

FirstweshouldstartwithaddingaCalculationGroup.GotoCalculationGroupMenuunderPayrollandaddanewcalculationgroup.AsanexamplewewillbeusingGermany.

AddingPayrollColumns

PayrollManagement

84

Oneofthebestwaystodecidewhichcolumnsyouneedhaveinyourpayrollreportistothinkofrowsinyouremployeespayslip.Payrollreportasatablewhichholdsallyourindividualemployeepayslipsineachrow.

SinceyouhavethreesalarycomponentsBasic,CarAllowanceandHourlypaywecandefinefollowingpayrollcolumns.(Fornowlet'sassumetaxis19%ontotalsalary).

Nowherearethelistofcolumnstoshowonpayroll:

1. BasicSalary2. CarAllowance3. HoursWorkedDuringMonth4. HourlyPay5. PaymentForHoursWorked6. Grossmonthlysalary7. DeductionforTax8. NetSalary

Sonowwecanstartaddingpayrollcolumns.It'sagoodideatoprefixyourpayrollcolumnswithitsrespectivecountrycodetomakeiteasiertofind.

AddingPayrollColumnforBasicSalary

Nowyoucangotothetab"PayrollColumns"andclickon"Add".

PayrollManagement

85

AsthiscolumnonlydependsonBasicSalarycomponentyoucanjustselectthethatsalarycomponentfromthelist.(Notethatinsomecasesyoucanaddmultiplesalarycomponentstosamecolumn).

AlsomakesureyousettheenabletoYesanddefaultvalueto0.00.

Thecolumnordershouldbe1becauseitshouldbethefirstcolumninyourpayrollreportforGermany.

AddingPayrollColumnforCarAllowance

PayrollManagement

86

Adding:HoursWorkedDuringMonthColumn

Thereareemployeeswhodonothaveafixedsalarybutpaidonhourlybasis.Easiestwaytohandletheseemployeesistofirstcreateacolumntogetnumberofhoursworkedforthemonthusingattendance.Inordertodothatyoucanusepre-definedcalculations.

PayrollManagement

87

Adding:HourlyPayColumn

Wecantakehourlypayfromsalarycomponentandcreatethiscolumnasbelow:

PayrollManagement

88

Adding:PaymentForHoursWorkedColumn

Basedonthepreviouscolumnyouhaveadded,nowyoucancreatethehourlypaybasedcolumnasshownbelow:

Firstcreateanewpayrollcolumn

PayrollManagement

89

Then,Clienton"Add"buttonnexttoCalculationColumns

HereyouareaddingthepreviouslydefinedhourspermonthcolumnasaparameternamedXandhourlypaycolumnasparameterY,soyoucanuseittodovariouscalculationsusingthesecolumns

PayrollManagement

90

ThenundertheFunctionfieldyoucanmultiplythesecolumns(allotherbasicmathexpressionswillworkhere)

PayrollManagement

91

AddingGrossMonthlySalaryColumn

Totalmonthlygrosssalaryshouldbethesumofbasicsalary,carallowanceandpaymentfortotalhoursworked.Thiscolumncanbecreatedasshownbelow:

PayrollManagement

92

CreatingCalculationMethodtoCalculate19%Tax

Asyouhaveseenyoucandosomecalculationsatcolumnlevel.Butthingssuchastaxwhicharehavingdifferentpercentagesandmultipleslabsit'sbettertousecalculationmethods.NowyoushouldgotoCalculationMethodstabandaddanewcalculationmethod.

YoucancreateacalculationmethodbasedonaSalarycomponentgroup(type),aSalarycomponentoranExistingpayrollcolumn.Inthiscaseweuseanexistingpayrollcolumn.

NowclickonaddbuttononCalculationProcessfiledtodefinetheactualcalculation.Accordingtoourexampleforthefullrangeofgrosssalarytaxis19%.Sowedon'tneedtodefineanyrangesandcancalculatethetaxasfollows.

PayrollManagement

93

Nowweneedtocreateapayrollcolumnandaddthiscalculationmethodtothatcolumn.

Pleasealsoplayattentionhowweareassigningcolumnordertoeachcolumn.

PayrollManagement

94

Add"NetSalary"column

NetSalaryisGrosssalaryminustax.SowecreateNetSalarycolumnasshownbelow:

Nowwehavefinisheddefiningpayrollcolumns.WhenyougotoPayrollcolumnsandsearch"DE-"youcanseeallthefieldsinGermanpayroll.

CreatePayslipTemplate

PayrollManagement

95

Asyouhavealltherequiredpayrollcolumnsyoucanusethesetocreateapaysliptemplate.SowearegoingtocreateanewpaysliptemplatenamedGermanPayslipTemplateandaddallthecolumnsdefinedabove.GotoPayslipTemplatestabandcreateanewpayslip.

Apaysliptemplatehascanbecreatedbyaddingfollowingitems:

1. CompanyLogo2. CompanyName3. Text(Foraddingspecialmessagestonotificationstoemployees)4. Separators(Forseparatingsectionsonpayslip)5. Payrollcolumns

PayrollManagement

96

CreatePayrollReport

PayrollManagement

97

PayrollReportistheunitusedtocombineallthepayrollcolumnsandcalculatemonthlypaymentsforalltheselectedemployees.

.GotoPayrollReportstabandcreateanewPayrollReport.

WhenyoucreatethepayrollreportitshouldbeinDraftstate.OnlywhenitisprocessingcompleteditshouldgotoCompletedstate.

Alsoyouneedtoselectallthepayrollcolumnsyoudefinedearlierforgermanpayrollhereasshownabove.

SelectingEmployeesForYourPayrollReport

AbovepayrollisformonthlypaidemployeeswhoareinGermanPayrollCalculationgroup.Soyouneedtoaddsomeemployeessatisfyingaboverequirementsunder"CompanyPayroll"tab.

PayrollManagement

98

AsshownbelowwehaveaddedtwoemployeestoGermanpayroll

ConfigureEmployeeSalaryComponents

Sincethepayrolldependsonemployeesalarycomponentsyoushouldmakesureallemployeesalarycomponentsaredefinedproperly.YoucandothisbygoingtoPayroll->SalarymoduleandselectingEmployeeSalarytab.

AsyoucanseehereIceHrmEmployeeisgettingaBasicandAllowancewhileLalaLameesgettingpaidperhour.Aswehaveconfiguredourpayrollreportapplicationnowabletocalculatethetaxandotherpayrollcolumnsproperly.

ProcessingPayrollReport

PayrollManagement

99

Clickonthebluecolor"Process"buttononyourpayrollreportunderPayrollReporttab.Thiswillshowsalariesofalltheemployeesinyourpayroll.

AsyoucanseehereIceHrmcannowcalculateyourpayroll.

AftercheckingfiguresmanuallyyoucanclickonfinalizebuttonwhichwillchangethepayrollreportstatustoCompleted.

DownloadingPayslips

Nowyouremployeecanloginanddownloadpayslipforthepayrollperiod2017-08-01to2017-08-31.

LoginastheemployeeandgotoUserReports->Reportsmodule.

AndthendownloadthePayslipfromanycompletedpayrollreport

PayslipforIceHrmEmployeewilllooklikethis:

PayrollManagement

100

GeneratingPayrollforNextMonth

Onceyouconfigureyourpayrollforinitially,generatingitforthesecondmonthcanbedoneinfewminutes.

CloneapreviousPayrollReportusingCopybutton

ChangeDatesandsetstatustoDraft

PayrollManagement

101

ThensavethenewPayrollReportandprocessandfinalizeit.

PayrollManagement

102

ImportandExportPayrollData

Pre-definedPayrolls

IceHrmteamhasalreadycreatedfewsamplepayrollswhichyoucanimportandusetogenerateorstudythepayrollcreationprocess.

DownloadPayrollFiles

SamplePayrollSetup

SriLankaPayrollSetup

GhanaPayrollSetup

ImportPayrolls

GotoSystem->DatamoduleSelect"DataImportFiles"TabPressAddNewbutton

Giveameaningfulnameandselect"PayrollDataImport"asDataImportDefinitions.SelectthefileyoudownloadedusingabovelinksSaveFromthelistclienton"Process"button


103

https://s3.amazonaws.com/icehrm/payroll/Sample-Country-Payroll.txt

https://s3.amazonaws.com/icehrm/payroll/Sample-Country-Payroll.txt

https://s3.amazonaws.com/icehrm/payroll/Ghana-Payroll.txt


104

InsightsAttendanceMonitoringchartsareveryusefulwhenyouwhentogetaquickabstractlookathowalltheemployeesoraspecificemployeeattendtotheirwork.Itshowshowmuchtimetheyspendtimeintheofficeagainsthowmuchtimetheyactuallyputtingintotimesheets.

AttendanceGraph

Hereyoucancheckattendancetimerecordedeverydayforalltheemployeesoraspecificemployee.

AttendancevsTimesheetsGraph

Inthischartadmins/mangerscanseehowmuchofapercentageofattendancetimegoesintotimesheetsforeachemployee.

Charts

105

Charts

106

Reporting

AdminReports(AdminReports->Reports)

IceHrmsavesallthegeneratedreportsunderreportfilessectionforfuturereferences.Adminsareentitledtogeneratefollowingreports.

UserReports(UserReports->Reports)

Followingreportscanbedownloadedbyemployees

Reporting

107

Reporting

108

IceHrmRESTApiCurrentlyicehrmexposeemployeedetailsandattendancedataviatheRESTapi.

FullApiDocumentationcanbefoundhere:https://icehrm.docs.apiary.io/#

SettingupIceHrmOpenSourceandProRESTApiPleasereferhttp://icehrm.github.io/docs/setup-rest-api/forinstuctionsonsettinguprestapiwithNginx.

Forapachewebserverwehavealreadyincludeda.htaccessfileundericehrm/app/api

UsingRESTApiwithOpenSourceandIceHrmProYourapiurlbasewillbe"http://your-icehrm-url.com/icehrm-pro-dev/app/api".

Ifyouwanttocallemployees/me,youshouldsendarequestto"http://your-icehrm-url.com/icehrm-pro-dev/app/api/employees/me".

UsingRESTApiwithCloudinstallationsFirstyoushouldenableRESTapiviaSettings->Other->EnableRESTApisetting.

IceHrmusesOAuth2.0bearerauthentication.Soyouhavetosendthebearertokenwitheveryrequest.EachicehrmusercanfindtheirauthtokenbyopeningBasicInformation->PersonalInformation->ApiAccess(tab).

RestApi

109

https://icehrm.docs.apiary.io/

http://icehrm.github.io/docs/setup-rest-api/

http://your-icehrm-url.com/icehrm-pro-dev/app/api

http://your-icehrm-url.com/icehrm-pro-dev/app/api/employees/me

MakingFirstApicall-Cloud

Ifyouricehrminstancenameistest1(https://test1.icehrm.com),yourApiurlwillbe

https://icehrm.com/api/test1

Thenaccordingtohttps://icehrm.docs.apiary.io/#youcanviewowndatabysendingaGETrequestto

https://icehrm.com/api/test1/employees/me

Youcanusefollowingrequestbychangingapiurlandauthtoken

curl-ihttps://icehrm.com/api/test1/employees/me\

-H"Authorization:BearerRRRRRRRR6fdeb20bb04b2c23DDDDD"

Forcreatingaemployeeyoucanuse

RestApi

110

https://test1.icehrm.com

https://icehrm.com/api/test1

https://icehrm.docs.apiary.io/

https://icehrm.com/api/test1/employees/me

curl-XPOST-H"Authorization:Bearer9RRRRRRRR6fdeb20bb04b2c23DDDDD"-H"Content-Typ

e:application/json"-d'{

"employee_id":"D101",

"first_name":"IceHrm123",

"middle_name":"SampleEx1",

"last_name":"Employee",

"nationality":"35",

"birthday":"1984-03-17",

"gender":"Male",

"marital_status":"Married",

"ssn_num":"",

"nic_num":"294-38-3535",

"other_id":"294-38-3535",

"driving_license":"",

"employment_status":"3",

"job_title":"11",

"pay_grade":"2",

"work_station_id":"",

"address1":"2772FlynnStreet",

"address2":"Willoughby",

"city":"Willoughby",

"country":"US",

"province":"41",

"postal_code":"44094",

"home_phone":"440-953-4578",

"mobile_phone":"440-953-4578",

"work_phone":"440-953-4578",

"work_email":"[email protected]",

"private_email":"[email protected]",

"joined_date":"2005-08-03",

"confirmation_date":"0000-00-00",

"supervisor":"1",

"indirect_supervisors":"[\"3\",\"4\"]",

"department":"1",

"termination_date":"0000-00-00",

"status":"Active",

"approver1":"5",

"approver2":"6",

"approver3":"7"

}'"https://icehrm.com/api/test1/employees"

RestApi

111

LDAPSettingsThissectiondescribetheprocessofconfiguringLDAPwithIceHrm

php-ldap

PHP5LDAPextensionshouldbeinstalledforLDAPtowork.Alsomakesureallrequiredoutboundportsareopened

Beforeusingpleaseinstallphp-ldapmodule.

ForPHP5.3$>sudoapt-getinstallphp5-ldap

ForPHP7.0$>sudoapt-getinstallphp-ldap

Forusingphpldaponwindowspleaserefer

NoLDAPforuserwithusername"admin"

Theuser"admin"willalwaysloginwithlocaldbusernameandpassword(evenLDAPisenabled)

UsetheseconfigtotestLDAPconnectionwithfollowingtestLDAPserverhttp://www.forumsys.com/tutorials/integration-how-to/ldap/online-ldap-test-server/

ChangeconfigsasfollowsunderSystem->Settings

Setting Description

LDAP:Enabled Yes

LDAP:Server ldap.forumsys.com

LDAP:Port 389

LDAP:RootDN dc=example,dc=com

LDAP:ManagerDN cn=read-only-admin,dc=example,dc=com

LDAP:ManagerPassword password

LDAP:Version3 Yes

LDAP:UserFilter uid={}

UsingLDAP

112

http://stackoverflow.com/questions/16864306/fatal-error-call-to-undefined-function-ldap-connect

http://www.forumsys.com/tutorials/integration-how-to/ldap/online-ldap-test-server/

Thencreateauserwithusername"riemann"underSystem->Users

Logoutandtryloginwithriemann/password

IssuewithLDAP

IfyouarefacingloginissuesafterenablingLDAP,youcanstillloginasuser"admin"anddisableLDAP

UsingLDAP

113

FrequentlyAskedQuestions

LeaveManagement

Howtoaddaleavetypeonlyvisibletolimitednumberofemployees

Createaleavegroup(Admin->LeaveSettings->LeaveGroups->EditLeaveGroups)Addalltheemployeesthatshouldseetheleavetypetoabovegroup(Admin->LeaveSettings->LeaveGroups->LeaveGroupEmployees)CreatealeavetypeandsetitsleavegrouptonewlycreatedleavegroupOnlytheemployeesinstep(2)willbeabletoseeandapplyforthisleavetype

FAQ

114

IceHrm Book (PDF)

Documents

Transcript of IceHrm Book (PDF)