OrangeHRM 2.2 - Help

From OrangeHRM

Jump to: navigation, search

Contents

Login Information

Logging in

  • Make sure that the AMP stack (Apache, MySql and PHP) is running.
  • Open your web browser and enter the url address for OrangeHRM e.g. http://localhost/orangehrm
  • Login to OrangeHRM by using the login name and password previously selected in the installation.

Change your password

You can always change your password by clicking on the Change Password link in the top right-hand side of the screen. Simply click Edit, enter Old Password, New Password, confirm New Password and click Save.

Logging out

Once logged in to the system, you can logout by clicking on the Logout link in the top right-hand side of the screen.

Welcome screen

After logging in to the system you will see the screen shown below:

[TODO: Image to be uploaded]

From the top menu you can select which module to enter. E.g. Admin Module, PIM Module, Reports Module, Leave Module and Bug Tracker From the left side menu (see figure 3.1 above) there are also links for info on support as well as direct access to the OrangeHRM Forum and OrangeHRM Blog.

Admin Module

The Admin Module is the part of the system where the HR Manager or other appointed personnel perform all system administration tasks. This include defining company structure, pay grades and other information that serves as the backbone for the rest of the system. Security issues are taken care of through this module as well, by defining user rights. Select Admin Module from the top menu. The first screen of the Admin Module menu is shown in the figure below. It will show the screen for general info on the company (see chapter 4.1 for further info on entering company info).

From the left side menu the features of the module can be selected. Each feature is described below.

Company Info

All information related to the company is provided through the Company Info. The sub menu consists of the following commands.

  • General
  • Company structure
  • Locations

General

The basic information on the company can be entered in ‘General‘, see screenshot in figure 4.2 below.

Use the action buttons to edit, clear and save the information (see description below). NOTE: Company Name is required for proceeding with several of the other functions in the system.

Edit General info

To edit the info in General, click Edit, make the required changes and click Save. If you type in text in a field and want to undo the change, click on the Clear button.

Company Structure

In the company structure you can define and enter all the Departments, Divisions, Teams etc. of the company. This will be useful later in the PIM Module so you assign a work station to each employee and thereby can specify where he/she is located.

Add to Company Structure

To add to the company structure click on Add shown in the figure below.

After clicking Add the fields shown below will appear in the You can now define a sub-division to your company by entering Name, Type (Division, Department, Team or Other), Location and Description and then clicking Save. After saving, it will appear below the company name as shown in Figure 4.6.

NOTE: Locations can either be defined from the function in the Company Structure sub menu (see below) og buy choosing Other in the drop down menu and then entering the information and clicking Save.

Delete from Company Structure

To delete simply click Delete after the Division, Department etc. that you want to delete, as shown in figure 4.7 below.

Locations

Through this feature you can add, edit and delete the different locations of the company.

Add Location

To add a new location click Add and the screen shown in the figure below will appear. If the save is successful, the Locations page is displayed with a ‘Successfully Added’ Notification.

Edit Location

Click on the Location ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Location

This would allow the user to delete a Location. Click on the checkbox against the Location ID to be deleted and click Delete button. Multiple locations could be deleted simultaneously.

Job

All information related to a Job can be handled by selecting Job from the menu. The sub menu consists of the following commands:

  • Job Titles
  • Pay Grades
  • Employment Statuses
  • EEO Job Categories

Job Titles

With the Job Titles feature you can add, delete and edit specific job titles to match the requirements of you company. Start by clicking on Job Titles from the left side menu.

Add Job Title

To add a Job Title click add from and the screen shown in figure below 4.10 will appear.

Enter Job Title Name, Job Description and Job Title Comments if needed. If you haven’t already entered the Pay Grade you want to attach to the Job Title you can do it by clicking Add Pay Grade. If you want to edit the Pay Grade(s) already entered click Edit Pay Grade (for more information on Pay Grades, please go to section 4.2.2). After finishing click Save. If the save is successful, the Job Titles page is displayed with a ‘Successfully Added’ Notification.

Edit Job Title

Click on the Job Title ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Job Title

This would allow the user to delete a Job Title. Click on the checkbox against the Job Title ID to be deleted and click Delete button. Multiple Job Titles can be deleted simultaneously.

Pay Grades

Through this feature you can add, delete and edit different Pay Grades for the company to be connected with the Job Titles. Start by clicking Pay Grades from the sub menu of Job in the left side menu.

Add Pay Grade

Click Add and you will see the picture shown in figure 4.11. Start by entering the name for the Pay Grade and click Save.

Then you will get the screen shown below for specifying the currency as well as Minimum Salary, Maximum Salary and Step Increase for the Pay Grade. Click Edit, enter the specifications and click Save. If the save is successful, the Pay Grades page is displayed with a ‘Successfully Added’ Notification.

Edit Pay Grade

Click on the Pay Grade ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Pay Grade

This would allow the user to delete a Pay Grade. Click on the checkbox against the Pay Grade ID to be deleted and click Delete button. Multiple Pay Grade could be deleted simultaneously.

Employment Status

This would allow the user to delete a Pay Grade. Click on the checkbox against the Pay Grade ID to be deleted and click Delete button. Multiple Pay Grade could be deleted simultaneously.

Add Employement Status

Click Add and you will see the picture shown in Figure X.X. Start by entering the name for the Pay Grade and click Save. If the save is successful, the Employment Status page is displayed with a ‘Successfully Added’ Notification.

Edit Employement Status

Click on the Employment ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Employment Status

This would allow the user to delete an Employment Status. Click on the checkbox against the Employment Status ID to be deleted and click the Delete button. Multiple Employment Statuses can be deleted simultaneously.

EEO Job Categories

Through this feature you can add, delete and edit EEO Job Categories. There are already 5 EEO Job Categories pre-defined. Start by clicking EEO Job Categories from the sub menu of Job in the left side menu.

Add EEO Job Category

Click Add and you will see the picture shown in Figure X.X. Enter the name for the EEO Job Category and click Save. If the save is successful, the EEO Job Category page is displayed with a ‘Successfully Added’ Notification.

Edit EEO Job Category

Click on the EEO Job Category ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete EEO Job Category

This would allow the user to delete an EEO Job Category. Click on the checkbox against the EEO Job Category ID to be deleted and click the Delete button. Multiple EEO Job Categories can be deleted simultaneously.

Qualifications

All information related to qualifications can be handled by selecting Qualifications from the menu. The sub menu consists of the following commands.

  • Education
  • Licences

Education

The types of education to be used in the PIM module can be entered here. Click Education from the left side menu to enter.

Add Education

Click Add and you will see the picture shown in Figure 4.16. Enter the institute and the course for the education and click Save. If the save is successful, the Education page is displayed with a ‘Successfully Added’ Notification.

Edit Education

Click on the Education ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Education

This will allow the user to delete an Education. Click on the checkbox against the Education ID to be deleted and click the Delete button. Multiple Educations can be deleted simultaneously.

Licenses

The types of licences to be used in the PIM module can be entered here. Click Licences from the left side menu to enter.

Add License

Click Add and you will see the picture shown in Figure 4.17. Enter the License description and click Save. If the save is successful, the License page is displayed with a ‘Successfully Added’ Notification.

Edit Licenses

Click on the License ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Licenses

This will allow the user to delete a License. Click on the checkbox against the License ID to be deleted and click the Delete button. Multiple License can be deleted simultaneously.

Skills

All information related to qualifications can be handled by selecting Qualifications from the menu. The sub menu consists of the following commands.

  • Skills
  • Languages

Skills

The types of skills to be used in the PIM module can be entered here. Click Skills from the left side menu to enter.

Add Skill

Click Add and you will see the picture shown in Figure 4.18. Enter the Skill description and click Save. If the save is successful, the Skill page is displayed with a ‘Successfully Added’ Notification.

Edit Skill

Click on the Skill ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Skill

This will allow the user to delete a Skill. Click on the checkbox against the Skill ID to be deleted and click the Delete button. Multiple Skills can be deleted simultaneously.

Languages

The types of languages to be used in the PIM module can be entered here. Click Languages from the left side menu to enter.

Add Language

Click Add and you will see the picture shown in Figure X.X. Enter the Language description and click Save. If the save is successful, the Language page is displayed with a ‘Successfully Added’ Notification.

Edit Language

Click on the Language ID that needs to be edited. Click Edit, make the necessary changes and click Save.

Delete Language

This will allow the user to delete a Language. Click on the checkbox against the Language ID to be deleted and click the Delete button. Multiple Languages can be deleted simultaneously.

Memberships

All information related to memberships can be handled by selecting Memberships from the menu. The sub menu consists of the following commands.

  • Memberships Types
  • Memberships

Membership Types

The Membership Types page is displayed in Figure 4.20. Types of memberships held by employees are defined in the System.

A search can be done on Membership Type based on Membership Type ID or Membership Type Name. Refer Section 3.12 for steps on searching. Click on the Next link to proceed to the next page of Membership Type. Click on the Previous link to move to the previous page of Membership Type.

Add Membership Type

This would enable the addition of a Membership Type. Click on Add button in the Membership Type page. The page used to add a Membership Type is displayed in Figure 4.21.

  1. Membership Type ID is automatically generated.
  2. Enter the Description (Membership Type Name)

Click Save button. If the save is successful, the Membership Types page is displayed with a ‘Successfully Added’ Notification.

Edit Membership Type

Click on the Membership Type ID that needs to be edited. Click on Edit button, make the necessary changes and click Save button.

Delete Membership Type

This would enable the user to delete a Membership Type. Click on the checkbox against the Membership Type ID to be deleted and click Delete button. Multiple Membership Types could be deleted simultaneously.

Memberships

The Memberships page is displayed in Figure 4.22. Details of memberships held by employees are maintained in the System. NOTE: It is important to have defined the relevant type of membership before adding a membership. Refer Section 4.5.1.1 to add a membership type.

A search can be done on Memberships based on Membership ID and Membership Name. Refer Section 3.12 for steps on searching. Click on the Next link to proceed to the next page of Membership. Click on the Previous link to move to the previous page of Membership.

Add Membership

This would enable the addition of a Membership. Click on the Add button in the Membership page. The page used to add a Membership is displayed in Figure 4.23

  1. Membership ID is automatically generated.
  2. Enter the Description (Membership Name)
  3. Select Membership Type

Click on the Save button. If the save is successful, the Membership page is displayed with a ‘Successfully Added’ Notification.

Edit Membership

Click on the Membership ID that needs to be edited. Click on Edit button, make the necessary changes and click Save button.

Delete Membership

This would enable the user to delete a Membership. Click on the checkbox against the Membership ID to be deleted and click Delete button. Multiple Memberships could be deleted simultaneously.

Nationality and Race

Nationalities and races can be specified by selecting Nationality & Race from the menu. The sub menu consists of the following commands.

  • Nationalities
  • Races

Nationalities

The Nationality page is displayed in Figure 4.24. The different Nationalities of employees can be specified in the system.

A search can be done on Nationalities based on Nationality ID or Nationality Name. Click on the Next link to proceed to the next page of Nationality. Click on the Previous link to move to the previous page of Nationality.

Add Nationality

This would enable the addition of a Nationality. Click on the Add button in the Nationality page. The page used to add a Nationality is displayed in Figure 4.25

  1. Nationality ID is automatically generated.
  2. Enter the Description (Nationality Name)
  3. Click on the Save button. If the save is successful, the Nationality page is displayed with a ‘Successfully Added’ Notification.
Edit Nationality

Click on the Nationality ID that needs to be edited. Click on the Edit button, make the necessary changes and click on the Save button.

Delete Nationality

This would enable the user to delete a Nationality. Click on the checkbox against the Nationality ID to be deleted and click Delete button. Multiple Nationalities could be deleted simultaneously.

Race

The Races page is displayed in Figure 4.26. The different races of employees can be specified in the system. A search can be done on Races based on Race ID or Race Name. Refer Section 3.12 for steps on searching. Click on the Next link to proceed to the next page of Race. Click on the Previous link to move to the previous page of Race.

Add Race

This would enable the addition of a Race. Click on the Add button in the Race page. The page used to add a Race is displayed in Figure 4.27.

  1. Race ID is automatically generated.
  2. Enter the Description (Race Name)

Click the Save button. If the save is successful, the Race page is displayed with a ‘Addition Successful’ Notification.

Edit Race

Click on the Race ID that needs to be edited. Click on the Edit button, make the necessary changes and click on the Save button.

Delete Race

This would enable the user to delete a Race. Click on the checkbox against the Race ID to be deleted and click on the Delete button. Multiple races could be deleted simultaneously.

Users

Users can be administered by selecting Users from the menu. The sub menu consists of the following commands.

  • HR Admin Users
  • ESS Users
  • Admin User Groups

HR Admin User

Through this function you can add, edit, delete and manage the HR Admin users of OrangeHRM. To access, click on HR Admin User from the sub-menu of Users in the left side menu. The HR Admin users have specified rights depending on the User Group which they are assigned to (see part 4.7.1.1 below). Figure 4.28 below shows the

Add HR Admin User

Click on the Add button in the above page to add a new user. The following page will be displayed.

  1. User Code is auto-generated
  2. Enter user name
  3. Enter password
  4. Confirm Password by entering same password
  5. Select status (enabled/ disabled)
  6. Select employee (not required)
  7. Select User Group (see part 4.7.3 for further info on the User Groups)


NOTE: Make sure, that employee information is entered into the system prior to creating user account for the employee.


Make the above entries and click on the Save button. If the save is successful, the HR Admin Users page is displayed with a ‘Addition Successful’ Notification.

Edit HR Admin User

Click on the user ID to be edited. Click on Edit button, make the necessary changes and click on Save button.

Delete HR Admin User

Click on the user ID to be edited. Make the necessary changes and click on Edit button.

ESS Users

Through this function the Users for the Employee Self Service Module can be created. To access select ESS Users from the Users sub menu in the left side menu.

  1. User Code is auto-generated
  2. Enter user name
  3. Enter password
  4. Confirm Password by entering same password
  5. Select status (enabled/ disabled)
  6. Select employee


NOTE: Make sure, that employee information is entered into the system prior to creating user account for the employee.

Edit User Group

Click on the User Group ID to be edited. Click on Edit button, changes to the Description and click on Save button.

Delete User Group

Click on the checkbox against the user group to be deleted and click on the Delete button.

User Groups

The user groups to be assigned to the HR Admin users can be created and maintained using this page. Defining the user group allows to assign certain rights and permissions to particular users, who form one group. Click on Admin Admin User Groups from the Users sub menu to open the page.

Add User Group

Click on Add button in the above page to add a new user group. The page shown below will be displayed.

Assigning User Rights

Assigning of certain rights and permissions to the users will help manage the security and integrity of the system. Once you will define the new Admin user group, please assign the rights, as described below


  1. In the Admin User Groups page, click on the user group to which you wish to assign rights and click on the Assign rights link.
  2. Each user group can be assigned with different rights. Click on the required module in the Assigned rights area.
  3. Click on the Edit button and select the check boxes depending on the rights you wish to assign.
  4. Then, click on Save button
  5. Once you have assigned all the necessary rights to the user group – click Back button, to return to the User Group definition screen. Your changes will be saved in the system.
Edit User Group

Click on the User Group ID to be edited. Click on Edit button, make the necessary changes to the Description and click Save button. If you need to edit the assigned user rights, please read through the next section.

Editing Assigned User Rights

NOTE: You are not allowed to edit the User Rights for the group, where your log in account belongs.


To edit the assigned rights of the group, click on the link Assign User Rights. The following screen will be displayed To edit the rights for the particular module – select the module from the Assigned Rights list. The information on the rights for the module will be loaded into the section for rights assignment. Click Edit button and modify the rights as required. To depreciated user group of all rights click on Delete button.

Delete User Group

Click on the checkbox against the user group to be deleted and click on the Delete button.


NOTE: It is impossible to delete the User group, to which your account belongs.


Email notifications

Email notifications section allows setting up the parameters for the operations related to sending and receiving email notifications through OrangeHRM. The section allows performing mail configuration and subscription for the various types of email notifications.


The sub menu consists of the following commands.

  • Configuration
  • Subscribe


NOTE: It is important to specify correct email addresses of the employees, who would like to subscribe for email notifications. The email address setting is performed in the Personal Information Management module Contacts tab - refer Section 5.4.

Configuration

Configuration of mail settings is essential if the users of the system require sending and receiving notifications, related to the operations performed within OrangeHRM (for example, Leave management operation, Time sheets administration operations). The Figure 4.35 shows email configuration screen. configure the mail, specify appropriate values for the fields and click Save button.

Subscribe

This sub menu section will allow you to subscribe users for receiving email notifications through OrangeHRM system. Enter the correct email address and select the types of notifications the user would like to receive by clicking the appropriate checkboxes. Click Save button.

Customers

This section of the menu allows define and store in the system basic information on the customers and clients of the company. The list of the existing customers being displayed as shown on the Figure 4.37. A search can be performed on Customers based on Customer ID or Customer Name. Click on the Next link to proceed to the next page of Customers. Click on the Previous link to move to the previous page of Customers.

Add Customer

To add the new customer into the system, click Add button in the Customers page. The page used to add a Customer is displayed in Figure 4.38

  1. Code is automatically generated.
  2. Enter the Customer Name (It can be the name of company / organization or individual). You can also enter company’s internal customers.
  3. Description – the description and comments about the customer

Click on the Save button. If the save is successful, the newly added customer is displayed with a ‘Successfully Added’ Notification in the Customer page.

Edit Customer

Click on the Customer ID that needs to be edited. Click on the Edit button, make the necessary changes and click on the Save button.

Delete Customer

This would enable the user to delete the customer. Click on the checkbox against the Customer ID to be deleted and click Delete button. Multiple Customers could be deleted simultaneously.


NOTE: It is impossible to delete customer if there are any projects (Section 4.10) or any time events (Section 8.1) associated with this customer

Projects

The administrators are able to define the projects, which were / are / will be managed by the company. The list of the existing projects being displayed as shown on the Figure 4.39. A search can be performed on Customers based on Project ID or Project Name. Click on the Next link to proceed to the next page of Projects. Click on the Previous link to move to the previous page of Projects

Add Project

To add the new project into the system, click Add button in the Projects page. The page used define new Project is displayed in Figure 4.40.


NOTE: Enter the Customer of the Project information into the system prior to adding Project information. See Section 4.9 for more information.

  1. Code is automatically generated.
  2. Select the Customer Name from the drop down list. Only the customers that have been entered in to the system will appear in the list.
  3. Enter the Name for the project.
  4. Description – the description and comments about the customer

Click on the Save button. If the save is successful, the newly added project is displayed with a ‘Successfully Added’ Notification in the Project page.

Edit Project

Click on the Project ID that needs to be edited. Click on the Edit button, make the necessary changes and click on the Save button.

Delete Project

This would enable the user to delete the project. Click on the checkbox against the Project ID to be deleted and click Delete button. Multiple Projects could be deleted simultaneously.


NOTE: It is impossible to delete project if there are time events (Section 8.1) associated with this project.

Personal Information Management (PIM) Module

This core module maintains all relevant employee related information, including different types of personal information, detailed qualifications and work experience, job related information etc. Picture of employee is included as well. Information captured in this module is utilized by all other modules, thus eliminating data redundancy. To access, select PIM Module from the top menu. This first screen will show a list of the employees entered. See figure 5.1 below.

If you haven’t entered any employees yet you need to add one before you can start using the PIM Module. See part 5.1.1 below on Adding employee. If employees are already entered you can access their details by clicking on Employee ID. A search can be done on Membership Type based on Membership Type ID or Membership Type Name. Click on the Next link to proceed to the next page of Employees. Click on the Previous link to move to the previous page of Employees.

Add Employee

A new employee is added to the system using the Employee Information Page. Click on the Add button shown in Figure 5.2.

Then the following screen will be displayed.

Enter details and click the Save button.

  1. Employee ID is automatically generated.
  2. Enter First Name
  3. Enter Last Name
  4. Enter Middle Name (Optional)
  5. Enter Nick Name (Optional)
  6. Attach Photo (Optional)

NOTE: The attached photo size should not exceed 1MB


NOYR: The remaining details such as personal information, job information etc. can be entered after clicking Save or by clicking on the relevant EmployeeID on the relevant pages (For this, the particular employee should have been entered prior to entering such information).

Main Interface

When either clicking on the Employee ID of an employee already created or clicking Save when adding a new employee, you will enter the main interface of the PIM Module. The PIM Module menu is displayed below

The icon menu in the middle of the screen shows all the features for entering info in the PIM Module. This is categorised into the following areas:

  • Personal
  • Contact
  • Emergency contact(s)
  • Dependents
  • Immigration
  • Job
  • Payments
  • Report-to
  • Work experience
  • Education
  • Skills
  • Languages
  • Licenses
  • Memberships
  • Attachments

Each category is described below.

Personal

To access personal information click on the Personal icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.5 below.

Use the action buttons Edit/Save above the Icon menu to edit and save the information.

  • The Nationality box contains the nationalities which has been entered in the Admin

Module.

  • The Ethnic Races box contains the nationalities which has been entered in the Admin

Module.

Contact

To access the contact information click on the Contact icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.6 below.

Use the action buttons Edit/Save above the Icon menu to edit and save the information.

Emergency Contacts

To access the emergency contact(s) information, click on the Emergency Contact(s) icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.7 below.

Enter the information of the emergency contact and click the Save button below the fields. The emergency contact will then appear at the bottom as the example showed in the figure above. You can enter an unlimited number of emergency contacts

  • To edit the emergency contacts, simply click on the name, do the changes and click on the Save button.
  • To delete an emergency contact click in the tick box and then click on the Delete

button.

Dependents

To access the dependents information click on the Dependents icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.8 below.

Enter the information of the Dependents/ Children and click the Save button below the fields. The Dependents/ Children contact will then appear bellow the fields.

  • To edit the Dependents/ Children info, simply click on the name, do the changes and click on the Save button.
  • To delete Dependents/ Children from the list, click in the tick box and then click on the Delete button.

Immigration

To access the immigration information click on the Immigration icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.9 below.

Select if it is either Passport or Visa in from the upper left corner, enter the information and click the Save button below the fields. The Passport / Visa information will then appear bellow the fields.

  • To edit the Passport / Visa info, simply click in the Passport / Visa column, do the changes and click on the Save button.
  • To delete Passport / Visa from the list, click in the tick box and then click on the Delete button.

Job

To access the job information click on the Job icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.10 below.

Use the action buttons Edit/Save above the Icon menu to edit and save the job information.

  • Job Titles which were entered into the system by Administrator will be loaded in the drop down list
  • Employment Statuses which were entered into the system by Administrator will be loaded in the drop down list
  • EEO categories which were entered into the system by Administrator will be loaded in the drop down list
  • Sub – division can be selected for the employee from the Company Structure information, which is displayed after clicking Browse (…) button
  • The Joined Date can be selected from the calendar.


Employee Contracts

  • User can select to Show/Hide Employee Contracts (contract extensions)
  • Enter the contract extension start and end date and click the Save button below the fields. The contract will then appear below Assigned Contracts.
  • To edit the contract info, simply click on the Contract Extension ID, do the changes and click on the Save button.
  • To delete a contract from the list, click in the tick box and then click on the Delete button.

Payments

To access the payments information click on the Payments icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.11 below.

  • Enter the information of the payment by selecting currency, entering basic salary and then clicking the Save button below the fields. The payment will then appear under assigned salary as the example shown in figure 5.11. The minimum and maximum salary will be loaded into the system according to the selected Pay Grade.
  • To edit an assigned salary, simply click on the currency type, do the changes and click on the Save button.
  • To delete an assigned salary from the list, click in the tick box and then click on the Delete button.

Report-To

To access the report-to information click on the Report-to icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.12 below.

  • Enter the information of the Supervisor / Subordinate and click on the Save button below the fields. The Supervisor/Subordinate info will then appear bellow the fields.
  • To edit the Supervisor/Subordinate info, simply click on the Employee ID, do the changes and click on the Save button.
  • To delete a Supervisor/Subordinate from the list, click in the tick box and then click on the Delete button.

Work Experience

To access the work experience information click on the Work experience icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.13 below.

  • Enter the work experience info and click on the Save button below the fields. The

work experience info will then appear bellow the fields.

  • To edit the work experience info, simply click on the Work Experience ID, do the

changes and click on the Save button. If you want to cancel the operation and add a new work experience instead, click on the Add button.

  • To delete a work experience from the list, click in the tick box and then click on the

Delete button.

Education

To access the education information click on the Education icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.14 below.

  • Enter the information of the education and click the Save button below the fields. The education will then appear at the bottom under Assigned Education as the example shown in the figure above.
  • The education field contains the education info entered in the admin module.
  • To edit the education history, simply click on the education name, do the changes and click on the Save button.
  • To delete an education click in the tick box and then click on the Delete button.

Skills

To access the skills information click on the Skills icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.15 below.

  • Enter the skill info and click on the Save button below the fields. The skill will then appear bellow the fields under assigned skills as shown in the figure above.
  • The Skill shall be selected from the drop down list. The list will be populated with the values, specified in the Admin Module.
  • To edit the skill info, simply click on the skill name, do the changes and click on the Save button. If you want to cancel the operation and add a new skill instead, click on the Add button.
  • To delete a skill from the list, click in the tick box and then click on the Delete button.

Languages

To access the language information click on the Language icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.16 below.

  • Enter the language info and click on the Save button below the fields. The language will then appear bellow the fields under assigned languages as shown in the figure above.
  • The language field contains the languages entered in the admin module.
  • To edit the language info assigned, simply click on the language name, do the changes and click on the Save button. If you want to cancel the operation and add a new language instead, click on the Add button.
  • To delete a language from the list, click in the tick box and then click on the Delete button.

Licenses

To access the license information click on the Licenses icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.17 below.

  • Enter the license info and click on the Save button below the fields. The license will then appear bellow the fields under assigned licenses as shown in the figure above.
  • The license field contains the licenses entered in the admin module.
  • To edit a license assigned, simply click on the license name, do the changes and click on the Save button. If you want to cancel the operation and add a new license instead, click on the Add button.
  • To delete a license from the list, click in the tick box and then click on the Delete button.

Memberships

To access the membership information click on the Memberships icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.18 below.

  • Enter the membership info and click on the Save button below the fields. The membership will then appear bellow the fields under assigned memberships.
  • The ‘membership type’ and ‘membership’ fields are related and contains the membership types and memberships entered in the admin module.
  • To edit a membership assigned, simply click on the membership name, do the changes and click on the Save button. If you want to cancel the operation and add a new membership instead, click on the Add button.
  • To delete a membership from the list, click in the tick box and then click on the Delete button.

Attachments

To access attachments click on the Attachments icon in the icon menu in the middle of the screen. Bellow the icon menu you will then see the fields shown in figure 5.19


NOTE: The size of the attached files can not exceed 1MB.


  • Select a path for the attachment, enter a description and the click on the Save button below the fields. The attachment will then appear bellow the fields under assigned attachments.
  • To access an attachment simply click on the file name, and then click on the button saying show file. If you want to cancel the operation and add a new attachment instead, click on the Add button.
  • To delete an attachment from the list, click in the tick box and then click on the Delete button.

ESS Module

Employee self service is a powerful tool providing employees of the company with the ability to view relevant information such as personal information, updating personal information with web - enabled PC without having to hassle the HR staff. The functionality of this module spans through the entire system, making information available anywhere, anytime. Of course all information is subject to company defined security policy, where everyone can only view the information he/she is authorized to. Time and cost saving effects from this solution are tremendous.

To use the ESS module the Employee has to be created and added as an ESS User through the User function in the Admin Module. See part 4.7.2 for further information on creating the ESS user. To login to the ESS module, enter the username and password which were selected when creating the user. After logging in, the ESS user can access the menu shown in the figure below.


  • ESS – Through this the employee can access and edit his/hers personal information of the PIM Module. See part 5 for further information on these functions.
  • Leave Module – Through this the employee can apply for leave to a supervisor and approve reject leave for a subordinate. See part 7 for further information on these functions.
  • Time Module – Through this module employee can enter and submit the time sheets for the approval by supervisor. See part 8 for further information.
  • Bug Tracker – Through this the employee can report bugs encountered when using the system. See part 9 for further information on this.

Leave Module

A comprehensive leave management module with extensive possibilities of defining leave types, company holidays, applying for and assigning of leave for the employees of the company. It caters for all application and approval processes and is able to display information on leave entitlement, balance, history etc. The functionality of the Leave module differs depending on the rights of the user of the system. The Leave module will be described from the perspective of Administrator, ESS User – Supervisor (the user who has subordinates, see section 5.10 for more information) and the ESS User (the user who does not have subordinates assigned)

The HR Admin can:

  • View Leave Summary for each employee and entitle leave days of each available type
  • Define Days Off – Weekends and Specific Holidays
  • Define Leave Types
  • Assign Leave for any employee

The ESS User – Supervisor can:

  • View the Personal or Employee (subordinate) Leave Summary
  • View the Leave List – the detailed leave information
  • Apply for Leave
  • Assign Leave for his/her subordinates
  • Approve/Reject leave

The ESS User can:

  • View the Personal Leave Summary
  • View the detailed leave information
  • Apply for Leave

Leave Summary

Administrator views Leave Summary

To view leave summary click Leave Summary from the left side menu. The screen, shown in the Figure 7.1 will be displayed. The leave summary of the employees can be viewed for one particular year, therefore the year must be selected from the drop down list. There are two criteria which can be used to filter the leave summary that can be generated:

  • Employee Name
  • Leave Type

If the user wants to view the Leave summary for one employee, the Employee Name shall be selected. The Employee Name drop down list has two options “All Employee” and “Select”. Once Select is chosen, user can browse through the employees (Figure 7.2), who have already been entered into the system and select the particular employee. It is possible to search for Employee within the Employee list by Employee ID or Employee Name.

To filter the Leave Summary by particular leave type, user must select it from the Leave Type drop down list. The list is populated with the values which have been entered into the system through Define Leave Type functionality (refer section 7.1.3 for more information).

View Leave Summary

To view all or filtered Leave Summary information, the user must click View button.

  • The Administrator can edit the Entitled Leave information by pressing the Edit button. The screen shown in the Figure 7.3 will be displayed. The appropriate leave information should be edited and saved into the system by pressing Save button

Supervisor views Leave Summary

The ESS User who has been assigned subordinate employees can view their leave summary. The supervisor can view:

  • Personal Leave Summary
  • Employee Leave Summary
Personal Leave Summary

Personal Leave Summary Sub-menu of the left side menu item Leave Summary will allow Supervisor to view his/her leave summary information. For more detail please, refer to section 7.1.3

Employee Leave Summary

The Supervisor can view the leave summary information for his/her subordinates. In order to do this, click the Employee Leave Summary sub-menu of the left side menu item Leave Summary. The screen displayed in the Figure 7.4 will be shown To view the leave summary, you must select the year from the drop down list. If you wish to display the summary only of one subordinate, select him/her in the Employee Name drop down list and press the View button. The screen displayed in the Figure 7.5 is shown.

NOTE: To be able to view the summary information on the subordinates, the appropriate employees’ information and “Report-to” relationship must be entered into the system.

ESS User views Leave Summary

By clicking on Leaves Summary (for ESS Users) and Personal Leave Summary (for Supervisors) the ESS user can view a list of the leave types and get a summary of the leave taken the leave available as shown in the screen in Figure 7.6 below

Define Days Off

By selecting Define Days Off from the left side menu of the system, administrator of OrangeHRM can define the days off that will be applicable to the entire company and will be taken into consideration while calculating leave duration. Days off have been classified into:

  • Weekends
  • Specific Holidays

Weekend

The screen used for defining weekends for the company is displayed in the Figure 7.7. For each day of the week the administrator shall specify whether it is Full or Half working day or Weekend. After specifying the information, it should be saved by clicking Save button.

Specific Holidays

The specific holidays that will not be considered as company’s working days can be defined through this module. With the Specific Holidays feature you can add, delete and edit Specific holidays to match the requirements and policies of your company. Start by clicking on Specific Holidays under the Define Days Off item from the left side menu.

Add Specific Holidays

To add a Specific holiday click Add from and the screen shown in figure below 7.9 will appear. It is compulsory to specify the Name of the Holiday and to select the date when the holiday occurs. By default all holidays are marked as non-recurring. To mark holiday as recurring, meaning that the holiday will occur on the same day next year, click the Recurring check box. For example, Christmas is recurring holiday, as every year it happens on the 25th of December. Easter is not recurring holiday. It is also possible to specify, whether the holiday is full or half day. After finishing click Save. If the save is successful, the list of the Specific Holidays will be displayed with a ‘Successfully Added’ Notification.

Edit Specific Holidays

Click on the link with the name of Specific holiday that needs to be edited. Click Edit, make the necessary changes and click Save

Delete Specific Holidays

This would allow the user to delete Specific Holiday. Click on the checkbox against the Name of the holiday to be deleted and click Delete button. Multiple holidays can be deleted simultaneously.

Define Leave Types

Through this section the administrator of the system will be able to define leave types, which are compatible with the HR policies of the company. Start by clicking on Define Leave Types item from the left side menu. The list of the specific holidays is being displayed as shown in Figure 7.10.

Add New Leave Type

To add a Leave Type click Add from and the screen shown in figure below 7.11 will appear. Enter the leave type name and click Save. If the save is successful, the list of the Leave Types will be displayed with a ‘Successfully Added’ Notification.


NOTE: The entitlement of leave of each type for the employees is performed through the Leave Summary section. The functionality is explained in the 7.1.1.1.1 section

Edit Leave Type

Click on the Edit button above the list of the Leave Types. It enables you to edit all the leave type names. Make the necessary changes and click Save.

Delete Leave Type

This would allow the user to delete Leave Type. Click on the checkbox against the Leave Type to be deleted and click Delete button. Multiple leave types can be deleted simultaneously.

Leave List

Leave List provides the detailed information about the leaves information for the particular employee or his/her subordinates.

View Leave List

To view leave list information, employee must be logged in as ESS user. Click the Leave List menu item from the left side menu and the following information will be displayed, as shown in Figure 7.12

  1. Date or the range of dates the leave was applied for
  2. No of days – the figure calculated excluding weekends and defined specific holidays
  3. Status - Pending approval / approved / rejected / taken
  4. Leave period – single or range
  5. Comments

The information is being displayed for all the leaves the employee has applied for or has been assigned. To view the detailed information on the leave, the user must click on the link with the leave dates. The following screen displayed in Figure 7.13 will be shown. To go back to the Leave List, click Back button.

Edit Leave Statuses

This functionality can be used by ESS Users to change the leave statuses from Pending Approval or Approved to Cancelled. In other words, this section allows employees to cancel the leaves they have applied for or the leaves they have been assigned.


NOTE: The Status of the Taken leaves can not be edited.

If the range of dates leave status is being edited, user can apply changes for the entire leave or make changes partially. If user wants to cancel status of the entire leave, the new Status must be selected from the check box in the Leave list. If the partial changes need to be applied, user can open the leave details by clicking on the link of the leave, he wants to modify, and change the statuses for any leave days as he/she requires. The screen of the detailed leave list with the option to change statuses is show in the figure 7.14 After changing the leave statuses click Save button.


NOTE: If the email notifications functionality has been configured (see section 4.3 for more information), the email notification will be sent to the Supervisor of the Employee and to the HR Admin users, who have subscribed for the Leave management mail notifications, once the employee modifies and saves the status of leave.

Assign Leave

The HR administrator can assign leave to any employee of the company, whose information was entered into the system.


NOTE: Enter the Employee information (including Report-to), leave type information and information on specific holidays and weekeds must be entered into the system for the correct leave calculation.

To assign leave, click on the Assign Leave item on the left side menu. The screen displayed in the Figure 7.15 will be displayed. While assigning leave user must select the Employee Name.

  • Administrator of OrangeHRM, the list of all the employees, who were entered into the system prior, will be displayed.
  • ESS User - supervisor can assign leaves only for his/her subordinates. In this case the drop down list populated with the names of all subordinates will be displayed.

Leave type drop down list will be populated with the leave types, entered by the Administrator. The leave range should be specified by selecting From and To dates. The user also has the possibility to take full day or half day (morning/afternoon) leave by selecting the appropriate value from the drop down list. Once the necessary information is being entered, click Apply button. The necessary leave calculations will be performed by system automatically.


NOTE: If the email notifications functionality has been configured (see section 4.3 for more information), the email notification will be sent to the Employee (has has been assigned leave) and to the HR Admin users, who have subscribed for the Leave management mail notifications, once the leave is assigned. The Assigned leave will change the status to Taken on the day of the Leave and the information for the taken and available leave for particular employee will be modified accordingly.

Apply for Leave

If the user is logged in to the system through the ESS, he can apply for leave through by clicking on the Apply for Leave menu item on the left side menu. The screen displayed in the Figure 7.16 will be shown. The user shall select the Leave Type from the drop down list which will be populated with the Leave Types, specified by the HR Administrator. The From and To dates shall be chosen. If user wants to apply for the leave that is not longer than one day, the same From and To dates shall be chosen. User can also apply for full or half day (morning or afternoon options available) leave, by selecting the appropriate value. The comments can be specified. After user finishes specification of leave details, he can apply for leave by clicking Apply button. The leave will be pending approval from the Supervisor of the user.


NOTE: If the email notifications functionality has been configured (see section 4.3 for more information), the email notification will be sent to the Supervisor of the Employee, who has applied for leave and to the HR Admin users, who have subscribed for the Leave management mail notifications.

Approve Leave

The ESS User – Supervisor (the user has the subordinates assigned in the “Report-to” PIM section (see section 5.10 for more information)) can approve or reject leaves, that were applied for by his/her subordinates. To do so, the Supervisor must be logged in to the system through the ESS and click on Approve Leave left side menu item. The screen, displayed in the Figure 7.17 will be shown. To approve or reject the leave of the subordinate, Supervisor must select the appropriate Status from the drop down list. This action will approve or reject the whole leave. The comment can be specified by Supervisor. System has the possibility for partial approval or rejection of the leave. To do so, Supervisor shall click on the link with the leave dates. The screen displayed in the Figure 7.18 will be shown. Now the Supervisor can select Approved or Rejected Status for each day of the leave. The changes will be saved into the system after clicking Save button.


NOTE: If the email notifications functionality has been configured (see section 4.3 for more information), the email notification will be sent to the Employee, who has applied for leave, and to the HR Admin users, who have subscribed for the Leave management mail notifications. The Approved leave will change the status to Taken on the day of the Leave and the information for the taken and available leave for particular employee will be modified accordingly.

Time Module

The module automates time tracking related processes. The functionality of the module allows the employees of the company to create and submit weekly timesheets and the supervisors to modify, approve and reject the timesheets, submitted by their subordinates. The time module allows better tracking of the employee occupancy and the tasks that employees are working on. The effective management and task assignment strategies can be implemented based on the information, received from the employee timesheets.

Personal timesheets

If the user is logged into the system with the ESS (Employee Self Service) account, he/she can create the timesheets. Click on the Time tab at the top of the web page and select Timesheets left side menu items. If the ESS user has subordinates assigned, he will have the opportunity to manage his own and his subordinates’ timesheets. Therefore select Personal Timesheets in this case.

Edit Timesheets

The user can edit the weekly timesheets. The form for the timesheet editing is displayed in the Figure 8.1. With the help of arrow buttons on top of the screen user must select the week, for which the timesheet needs to be edited. Once the week is selected, press Edit button and make the necessary modifications to the timesheets.

Add Time Events

Employee the Edit button is pressed; employee can add new time events to his timesheet. The screen shown in the Figure 8.2 will be displayed. Employee must specify the customer or client for the task, he has been doing. The list of customers will be populated with the customer names, created by the Administrator of the system (see section 4.9 for more information). Once the customer will be selected the project / activity drop down list will be populated with the projects that are associated with the particular customer (see section 4.10 for more information). Employee shall insert thee start time for the event. The Insert Time button will insert the current time into the field automatically and will simplify addition of the time event for the customer.


NOTE: The start time and date of the time event specified in the timesheet must be within the week of the timesheet. Otherwise, the time information will not be counted in.

The End time of the event AND/OR Duration shall be specified by the employee. If one of the fields is specified, the other is calculated automatically. Reported date will be populated by the system automatically with the current date. Employee can specify the description of the time event and click Update. This will update the time sheet with the information of the time event. Press the Reset button to reset the information entered for the particular time event. Once the timesheet is updated the information about the event is being entered into the weekly timesheet and the Successfully Updated notification is being displayed.

Edit Time Events

To edit the information about time events, user must select the appropriate Timesheet and press the Edit button. The screen shown in the Figure 8.3 allows editing time event information. Once the necessary modifications of the time event are performed, click Update button.

Delete Time Events

To delete the time event, click the check box for the time event and click Delete button. Please, refer Figure 8.3. Deletion of multiple time events can be performed simultaneously.

Submit Timesheets

Once the ESS user has entered his/her timesheet information, he can submit it for the approval of the Supervisor.


NOTE: The submitted and approved timesheets can not be edited

To submit the timesheet, click on the Submit button for the particular timesheet. Please, refer Figure 8.4

Employee Timesheets

The HR Administrators and the ESS Users – Supervisors, who have the subordinates assigned, can view the timesheets of the other employees. Click the Employee Timesheets sub menu of the Timesheets left side menu item.

Administrator access to Employee Timesheets

If the HR administrator views the Employee timesheets, the screen, shown in the Figure 8.5 will be displayed. Administrator can view the submitted timesheet information for any employee information. The employee selection can be performed by clicking Browse (…) button. The employees who have been entered into the system information will be shown as in Figure 8.6. It is possible to search for Employee within the Employee list by Employee ID or Employee Name. Administrator shall select the Employee from the list by clicking on the Employee ID link and press the View button (refer the Figure 8.5) The information on the submitted weekly timesheets for the employee will be displayed as shown in Figure 8.7. To browse through the timesheets, use the arrow buttons on top of the screen The HR administrator can approve or reject timesheets of the employee. Please refer to 8.2.3 section for further information.

Supervisor access to Employee Timesheets

If the Supervisor can access the timesheets submitted by his/her subordinates. If the Supervisor select Employee Timesheets from the left side menu, the screen, shown in the Figure 8.8 will be displayed. Supervisor can select the employee and from the Employee Name list, which will be populated with the employee names that have been entered into the system and have been assigned the current user as their Supervisor. Click the View button and the submitted / approved / rejected timesheets of the particular employee will be displayed. Please, refer Figure 8.7 for more information. To increase the effectiveness of browsing through the timesheets, the subordinates’ timesheets that are pending approval are displayed in the separate list. Supervisor can easily select the particular timesheet from the list by clicking the View button for the timesheet. The Supervisor can approve or reject timesheets of the subordinate. Please refer to 8.2.3 section for further information.

Approve/Reject and Edit Other Employee Timesheets

The HR Administrator or the Supervisor can approve/reject and edit the submitted timesheets of the other employees or their subordinates respectively. The edition of the other employees’ timesheets can be performed in the same manner as for the personal timesheets. Please, refer to the section 8.1.1 for more information.


NOTE: Once the timesheet is submitted, the duration field will be made read only.

Once the necessary changes (if any) have been made, the Supervisor or HR Admin can Approve or Reject the timesheet of the Employee. The submitted timesheets that is pending approval is shown in the Figure 8.9 To Approve / Reject the timesheet, press the appropriate button, as shown in the figure below.


NOTE: If the timesheet is Approved, the further edition and modification is impossible.

Reports Module

This feature produces customized reports according to your needs. Any number of reports can be defined by selecting from a range of search criteria and report fields. Report definitions can be saved to avoid repeating this task. Once the report definition is saved, the report can be generated by providing the required criteria data.

  • To access the module select Reports from the top menu and you will see the screen

shown in the figure shown below.

Define Reports

  • To define and create reports start by clicking Define Reports from the left side

menu.

  • Then click on the Add button shown in the figure below.

After clicking the Add button you will see the screen shown in the figure below.

  • To create a report you first have to specify a Report Name.
  • Then select which selection criteria the report shall be based my clicking the tick box and then selecting from the drop down menu.
  • Then select which select which info fields to be included in the report.
  • Finally click the Save button.

Assign User Groups

After clicking the Save button the report is created. Then the screen shown below will appear. The report is automatically assigned to the user group which the creator belongs to.

  • If you want to assign other user groups click on the Add button shown in the figure

above and the screen shown in the figure below will appear.

  • Click in the tick box for the user group you want to assign and click on the Add

button. The user group will then appear under Assigned User Groups.

View Reports

To view reports click on View Reports from the left side menu and you will see a list of the reports created as shown in the example in the figure below.

You can then access the report you need by clicking on the reports Report ID.

Edit Reports

To edit reports click on Define Reports from the left side menu and you will see a list of the reports created as shown in the example in the figure below.

  • You can then access the report you need by clicking on the reports Report ID.
  • Click on the Edit button as shown in the figure below. Do the wanted changes and click save.

Bug Tracker

In the event of any bugs being encountered while using the system, these bugs could be immediately reported on-line using the Bug Tracker module. Therefore, this would facilitate the repair of any defects in the system. Information on bugs could be queried as well which makes it useful to determine the status of bugs which have already been reported and also to check whether new bugs have been reported that requires amendments/modifications.

  • Access the Bug Tracker by clicking on Bug Tracker from the top menu.
  • Enter the different criteria and description. See figure 9.1 below.
  • Click on the Save button. If the save is successful, the Bugs Information page is displayed with a ‘Addition Successful’ Notification.
Retrieved from "http://www.orangehrm.com/wiki/index.php/OrangeHRM_2.2_-_Help"
Personal tools