diff --git a/readme.md b/readme.md index 530c6115..bf1d4c12 100644 --- a/readme.md +++ b/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. + +![Company Structure](https://icehrm.s3.amazonaws.com/images/blog-images/Company_stucture.png) + +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 + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription

Company: Name

+ Name of the company + +

Company: Logo

+ + Company logo. You may upload the company logo here. + Ideally should be 200px wide and height between 50px to 150 px. + +

Company: Description

+ + A short description about the company. Will be used mainly in recruitment module + +

Email: Enable

+ + Set this to "No" to disable all outgoing emails from modules. Value "Yes" will enable outgoing emails + +

+
+ +## Email Settings + +### Configuring Email with SMTP + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription

Email: Mode

+ + This should be set to SMTP + +

Email: SMTP Host

+ + 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 + +

Email: SMTP Authentication

+ + Set this to "Yes" if SMTP server authorization is enabled + +

Email: SMTP User

+ + User name of the SMTP user + +

Email: SMTP Password

+ + SMTP user password + +

Email: SMTP Port

+ + Port configured in SMTP server (Default 25) + +

Email: Email From

+ + From email address (e.g icehrm@mydomain.com) + +

+
+ +### Configuring Email with Amazon SES + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription

Email: Mode

+ + This should be set to SES + +

Email: Amazon SES Key

+ + Amazon access key Id (You can get this through AWS console) + +

Email: Amazone SES Secret

+ + Amazon access key secret + +

Email: Email From

+ + Authorized email address for sending emails through SES + +

+
+ +### Configuring Email with Gmail + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription

Email: Mode

+ + This should be set to SMTP + +

Email: SMTP Host

+ + ssl://smtp.gmail.com + +

Email: SMTP Authentication

+ + Yes + +

Email: SMTP User

+ + yourgmailaddress@gmail.com + +

Email: SMTP Password

+ + Gmail password + +

Email: SMTP Port

+ + 465 + +

Email: Email From

+ + yourgmailaddress@gmail.com + +

+
+ +## Developer Settings + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription

System: Do not pass JSON in request

+ + Select Yes if you are having trouble loading data for some tables + +

System: Reset Modules and Permissions

+ + 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 + +

System: Add New Permissions

+ + Add new permissions without resetting modules + +

System: Debug Mode

+ + Print debug log messages + +

+
+ +## Other Settings + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription

Leave: Share Calendar to Whole Company

+ + 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 + +

Leave: CC Emails

+ + Every email sent though leave module will be CC to these comma seperated list of emails addresses + +

Leave: BCC Emails

+ + Every email sent though leave module will be BCC to these comma seperated list of emails addresses + +

Attendance: Time-sheet Cross Check

+ + Only allow users to add an entry to a timesheet only if they have marked atteandance for the selected period + +

Recruitment: Show Quick Apply

+ + Show quick apply button when candidates are applying for jobs. Quick apply allow candidates to apply with minimum amount of information + +

Recruitment: Show Apply

+ + Show apply button when candidates are applying for jobs + +

+
+ Release note v14.0 ------------------