Adding more info
This commit is contained in:
Thilina Hasantha
410
readme.md
410
readme.md
@@ -30,6 +30,416 @@ Upgrade from Previous Versions to Latest Version
|
||||
Note: If you are upgrading from older versions of icehrm please note that the icehrm leave module is removed since v13.0
|
||||
|
||||
|
||||
IceHrm Pro
|
||||
----------
|
||||
|
||||
IceHrm Profession version (in short IceHrmPro) is the feature rich commercial alternative for icehrm
|
||||
open source version.
|
||||
|
||||
You can learn more about [IceHrm Pro here](http://blog.icehrm.com/docs/icehrm-pro/)
|
||||
|
||||
To purchase IceHrmPro please visit [](http://icehrm.com/modules.php)
|
||||
|
||||
|
||||
Your Company Structure (Departments / Branches and other Organization Units)
|
||||
-------------------------------------------
|
||||
|
||||
Company structure module allows you to define the structure of you company by
|
||||
creating parent structure of the company, branches, departments and other
|
||||
company units. Also it provides a graphical overview of how each of
|
||||
your company units are interconnected.
|
||||
|
||||
|
||||
|
||||
Employee Management
|
||||
-------------------
|
||||
|
||||
Employees module is used to list, edit, add and search employees in your company.
|
||||
You can use the search box to search employees by ID, name or department.
|
||||
Also you can use filter button to filter employees by job title, department or supervisor.
|
||||
|
||||
###Difference Between Users and Employees
|
||||
|
||||
A user is a person who can login to icehrm. It’s not required for admin users to have an employee attached but
|
||||
each non admin user must have an associated employee. Having an employee added in icehrm won’t
|
||||
allow the person to login to icehrm. You need to create user with a Manager or Employee user level
|
||||
for that employee to be able to login to the system.
|
||||
|
||||
###Adding Employees
|
||||
|
||||
Adding employees to ICE Hrm can only be done by the admin. The employee Id field should have a unique value.
|
||||
In order to complete adding an employee you need to provide job title, employment status and pay grade.
|
||||
These values can be defined in admin: Jobs module.
|
||||
|
||||
Once an employee is added to the system you will be asked to create a user for the newly added employee
|
||||
|
||||
###Switching Employees
|
||||
|
||||
One of the key features of ICE Hrm, is admins and mangers ability to login as another employee.
|
||||
This feature can be used to apply leaves, add attendance records or update time sheets behalf of other employees.
|
||||
|
||||
To login as an employee you can use the switch user icon on employee list or the “Switch Employee” menu in top right hand corner.
|
||||
|
||||
In open source version you must switch employee to edit employee basic information like skills and qualifications.
|
||||
But on Pro and Enterprise versions you can directly update employee information through Advanced Employee Management module.
|
||||
|
||||
|
||||
Settings
|
||||
--------
|
||||
|
||||
After installation the settings module can be accessed by login in as admin and going to System->Settings
|
||||
|
||||
## Global Settings
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><code>Company: Name</code></p></td>
|
||||
<td><p>
|
||||
Name of the company
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Company: Logo</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Company logo. You may upload the company logo here.
|
||||
Ideally should be 200px wide and height between 50px to 150 px.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Company: Description</code></p></td>
|
||||
<td><p>
|
||||
|
||||
A short description about the company. Will be used mainly in recruitment module
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: Enable</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Set this to "No" to disable all outgoing emails from modules. Value "Yes" will enable outgoing emails
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
## Email Settings
|
||||
|
||||
### Configuring Email with SMTP
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><code>Email: Mode</code></p></td>
|
||||
<td><p>
|
||||
|
||||
This should be set to SMTP
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Host</code></p></td>
|
||||
<td><p>
|
||||
|
||||
If you are using local machine to send emails, set this to localhost. If not set the IP address of the server you are using to send emails
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Authentication</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Set this to "Yes" if SMTP server authorization is enabled
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP User</code></p></td>
|
||||
<td><p>
|
||||
|
||||
User name of the SMTP user
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Password</code></p></td>
|
||||
<td><p>
|
||||
|
||||
SMTP user password
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Port</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Port configured in SMTP server (Default 25)
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: Email From</code></p></td>
|
||||
<td><p>
|
||||
|
||||
From email address (e.g icehrm@mydomain.com)
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
### Configuring Email with Amazon SES
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><code>Email: Mode</code></p></td>
|
||||
<td><p>
|
||||
|
||||
This should be set to SES
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: Amazon SES Key</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Amazon access key Id (You can get this through AWS console)
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: Amazone SES Secret</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Amazon access key secret
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: Email From</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Authorized email address for sending emails through SES
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
### Configuring Email with Gmail
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><code>Email: Mode</code></p></td>
|
||||
<td><p>
|
||||
|
||||
This should be set to SMTP
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Host</code></p></td>
|
||||
<td><p>
|
||||
|
||||
ssl://smtp.gmail.com
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Authentication</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Yes
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP User</code></p></td>
|
||||
<td><p>
|
||||
|
||||
yourgmailaddress@gmail.com
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Password</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Gmail password
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: SMTP Port</code></p></td>
|
||||
<td><p>
|
||||
|
||||
465
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Email: Email From</code></p></td>
|
||||
<td><p>
|
||||
|
||||
yourgmailaddress@gmail.com
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
## Developer Settings
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><code>System: Do not pass JSON in request</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Select Yes if you are having trouble loading data for some tables
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>System: Reset Modules and Permissions</code></p></td>
|
||||
<td><p>
|
||||
|
||||
When this is set to “Yes” IceHrm will reset all values given in System->Permissions module. This setting can be used to reload permissions after adding new permissions to module meta.json file
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>System: Add New Permissions</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Add new permissions without resetting modules
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>System: Debug Mode</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Print debug log messages
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
## Other Settings
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><code>Leave: Share Calendar to Whole Company</code></p></td>
|
||||
<td><p>
|
||||
|
||||
If "Yes" all the employees of company can see other peoples' leave schedules.
|
||||
If set to "No" only admins and supervisors will be able to see leave schedule of subordinates
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Leave: CC Emails</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Every email sent though leave module will be CC to these comma seperated list of emails addresses
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Leave: BCC Emails</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Every email sent though leave module will be BCC to these comma seperated list of emails addresses
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Attendance: Time-sheet Cross Check</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Only allow users to add an entry to a timesheet only if they have marked atteandance for the selected period
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Recruitment: Show Quick Apply</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Show quick apply button when candidates are applying for jobs. Quick apply allow candidates to apply with minimum amount of information
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>Recruitment: Show Apply</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Show apply button when candidates are applying for jobs
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
Release note v14.0
|
||||
------------------
|
||||
|
||||
Reference in New Issue
Block a user