Technical Documentation: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This documentation is intended for developers and system administrators who are installing, administering, and customizing iHRIS.  
This documentation is intended for developers and system administrators who are installing, administering, and customizing iHRIS. Need more help?  Try us [[Project Communication| here]].




== Release Notes ==


<center>'''Need more help?  Try us [[Project Communication| here]]'''</center>


* [[README File for iHRIS]] (Manage version 4.0.18 and Qualify version 4.0.18)
* [[README File for iHRIS Plan]] (version 1.0.4)


<center>'''Downloadable [http://www.ihris.org/mediawiki/index.php?title=Special:Book/render_collection/&colltitle=IHRIS_Wiki:Books/Administrator_Handbook&writer=rl PDF Version ]  of the Documentation'''</center>


== General Installation Instructions ==


== Release Notes ==


* [[README File for iHRIS]] (Manage version 4.0.18 and Qualify version 4.0.18)
===Linux (Ubuntu)===
* [[README File for iHRIS Plan]] (version 1.0.4)


== General Installation Instructions ==


===Linux (Ubuntu)===
* [[Linux (Ubuntu) Installation]]
* [[Linux (Ubuntu) Installation]]
* [[HowTo: Installing the Debian Packages]]
* [[HowTo: Installing the Debian Packages]]
Line 26: Line 24:


===Linux (RedHat-Fedora)===
===Linux (RedHat-Fedora)===
* [[Linux (RedHat-Fedora) Installation]]
* [[Linux (RedHat-Fedora) Installation]]


===Windows===
===Windows===
The Windows verison of iHRIS was formerly referred to as Offline iHRIS.  It is not currently being actively maintained.
The Windows verison of iHRIS was formerly referred to as Offline iHRIS.  It is not currently being actively maintained.


Line 38: Line 40:


==Translations==
==Translations==
[[Enabling Translations]]
[[Enabling Translations]]


Line 46: Line 50:


Master [[iHRIS Translation List (Development) |  Translation List ]]
Master [[iHRIS Translation List (Development) |  Translation List ]]


==Packages, Modules and the API==
==Packages, Modules and the API==
Modules Lists:
Modules Lists:
*[[iHRIS Module List]] a list of all modules.
*[[iHRIS Module List]] a list of all modules.
Line 69: Line 76:


==How Tos,Techinical Overviews, and Tutorials==
==How Tos,Techinical Overviews, and Tutorials==


[[Learning Materials]]
[[Learning Materials]]


===How Tos===
===How Tos===
* [[Changing the Banner and Logo to Your Organization]]  
* [[Changing the Banner and Logo to Your Organization]]  
* [[Configuring Form Cache Generation Timing]]
* [[Configuring Form Cache Generation Timing]]
Line 86: Line 97:
** [[ManageAccessFacility -- Limit Dropdown (List) Fields by User|Limit Dropdown (List) Fields by User]]
** [[ManageAccessFacility -- Limit Dropdown (List) Fields by User|Limit Dropdown (List) Fields by User]]
** [[ManageAccessFacility -- Limit Reports by User|Limit Reports by User]]
** [[ManageAccessFacility -- Limit Reports by User|Limit Reports by User]]


===Technical Overview===
===Technical Overview===
* [[Configuration (Magic) Data ]]
* [[Configuration (Magic) Data ]]
**[[Magic Data Storage Mechanisms]]
**[[Magic Data Storage Mechanisms]]
Line 125: Line 139:
** [[Swiss Magic Data -- Form Relationships]]
** [[Swiss Magic Data -- Form Relationships]]
* [[Tasks and Roles]]
* [[Tasks and Roles]]


===Tutorials===
===Tutorials===
* [[Adding Fields to the Person Form]]
* [[Adding Fields to the Person Form]]
* [[Adding Forms and Fields]]
* [[Adding Forms and Fields]]
Line 152: Line 169:
* [[Upgrading From 3.1]]
* [[Upgrading From 3.1]]
* [[Using Bazaar to Contribute Code]]
* [[Using Bazaar to Contribute Code]]


== iHRIS Common Documentation ==
== iHRIS Common Documentation ==


* [http://www.capacityproject.org/hris/hris-toolkit/tools/doc/iHRISCommonUseCases.doc Common Use Cases and Requirements (MS Word Document)] ''Note: These use cases are included in the full HTML reports for each system below.''
* [http://www.capacityproject.org/hris/hris-toolkit/tools/doc/iHRISCommonUseCases.doc Common Use Cases and Requirements (MS Word Document)] ''Note: These use cases are included in the full HTML reports for each system below.''
Line 160: Line 179:


== iHRIS Manage Documentation ==
== iHRIS Manage Documentation ==


* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISManageVision.pdf Vision Statement (PDF)]
* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISManageVision.pdf Vision Statement (PDF)]
Line 168: Line 188:


== iHRIS Qualify Documentation ==
== iHRIS Qualify Documentation ==


* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISQualifyVision.pdf Vision Statement (PDF)]
* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISQualifyVision.pdf Vision Statement (PDF)]
* Use Case Model and Requirements - Full Report [http://www.capacityproject.org/hris/suite/UseCaseReport_iHRISQualify.htm (HTML)] [http://www.capacityproject.org/hris/hris-toolkit/tools/doc/iHRISQualifyUseCases.doc (MS Word Document)]
* Use Case Model and Requirements - Full Report [http://www.capacityproject.org/hris/suite/UseCaseReport_iHRISQualify.htm (HTML)] [http://www.capacityproject.org/hris/hris-toolkit/tools/doc/iHRISQualifyUseCases.doc (MS Word Document)]
*[[iHRIS Qualify Form Fields | Forms and Fields]]
*[[iHRIS Qualify Form Fields | Forms and Fields]]


== iHRIS Plan Documentation ==
== iHRIS Plan Documentation ==


* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISPlan_vision.pdf Vision Statement (PDF)]
* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISPlan_vision.pdf Vision Statement (PDF)]
Line 181: Line 204:


== Maintainer's Documentation ==
== Maintainer's Documentation ==


* [[HowTo: Release iHRIS Software]]
* [[HowTo: Release iHRIS Software]]
Line 195: Line 219:
* [[Arabic Translations]]
* [[Arabic Translations]]


==Country Specific Installation Instructions==
 
==Country-Specific Installation Instructions==
 


*[[Bihar Installation Instructions]]
*[[Bihar Installation Instructions]]
*[[Jharkhand Installation Instructions]]
*[[Jharkhand Installation Instructions]]
*[[Lesotho MOHSW Installation]]
*[[Lesotho MOHSW Installation]]
<center>'''Downloadable [http://www.ihris.org/mediawiki/index.php?title=Special:Book/render_collection/&colltitle=IHRIS_Wiki:Books/Administrator_Handbook&writer=rl PDF Version ]  of the Documentation'''</center>

Revision as of 11:41, 11 July 2012

This documentation is intended for developers and system administrators who are installing, administering, and customizing iHRIS. Need more help? Try us here.


Release Notes


General Installation Instructions

Linux (Ubuntu)

Installing on ext4 filesystem? see this

Poor internet connect? See creating a Software Reporsitory Mirror for offline use.

Linux (RedHat-Fedora)

Windows

The Windows verison of iHRIS was formerly referred to as Offline iHRIS. It is not currently being actively maintained.

It is current not the latest version.


Translations

Enabling Translations

Master Translation List


Packages, Modules and the API

Modules Lists:

Class List:

Template List:

  • iHRIS Template List a list of all the html templates and their locations used in the iHRIS Suite

Form Lists:

Task Lists

Role Lists


How Tos,Techinical Overviews, and Tutorials

Learning Materials


How Tos


Technical Overview


Tutorials


iHRIS Common Documentation


iHRIS Manage Documentation


iHRIS Qualify Documentation


iHRIS Plan Documentation


Maintainer's Documentation


Country-Specific Installation Instructions


Downloadable PDF Version of the Documentation