Technical Documentation: Difference between revisions

From IHRIS Wiki
No edit summary
 
(247 intermediate revisions by 8 users not shown)
Line 1: Line 1:
This documentation is intended for developers and system administrators who are installing, administrating and customizing iHRIS. For end user documentation and detailed step-by-step instructions for using iHRIS Manage, Qualify and Plan, see the [[iHRIS:Documentation|iHRIS Documentation and User Manuals]]. For More information about the iHRIS Suite and the HRIS Strengthening program, see the [http://www.capacityproject.org/hris/ iHRIS Project Website].
* [[Introduction and Overview]]
 
 
 
<center>'''Need more help?  Try us [[Project Communication| here]]'''</center>
 
 
 
== Release Notes ==
 
* [[README File for iHRIS]] (Manage version 4.0.2 and Qualify version 4.0.2)
* [[README File for iHRIS Plan]] (version 1.0.4)
* [[Release Notes for Windows iHRIS]] (version 3.1.4)
* '''Info Sheet:''' [[Linux iHRIS Compared to Windows iHRIS]] -- considerations to make when choosing which version to install
 
== General Installation Instructions ==
 
===Linux (Ubuntu)===
* [[Linux (Ubuntu) Installation]]
* [[HowTo: Installing the Debian Packages]]
* [[HowTo: Installing on Mini-Box]]
 
===Linux (RedHat-Fedora)===
* [[Linux (RedHat-Fedora) Installation]]
 
===Windows===
The Windows verison of iHRIS was formerly referred to as Offline iHRIS.
* [[iHRIS:Using Windows iHRIS|Windows Installation]]
* [[HowTo: Using Alternate Sites in Windows iHRIS]]
* [[HowTo: Building Windows iHRIS]]
 
 
==Packages, Modules and the API==
Modules Lists:
*[[iHRIS Module List]] a list of all modules.
*[[I2CE Module List]] the modules in I2CE
*[[iHRIS Common Module List]] the modules in iHRIS Common
*[[iHRIS Manage Module List]] the modules in iHRIS Manage
*[[iHRIS Qualify Module List]] the modules in iHRIS Qualify
*[[TextLayout Tools Module List]] the modules in Textlayout Tools
Class List:
*[[iHRIS Class List]] a list of the classes with links to their documentaion
Template List:
*[[iHRIS Template List]] a list of all the html templates and their locations used in the iHRIS Suite
Form Lists:
*[[iHRIS Manage Form Fields | iHRIS Manage Forms and Fields]]
*[[iHRIS Qualify Form Fields | iHRIS Qualify Forms and Fields]]
Task Lists
*[[iHRIS Task List]]
Role Lists
*[[iHRIS Role List]]
 
 
==How Tos,Techinical Overviews, and Tutorials==
 
'''How To'''s
* [[Recreate All Form Caches]]
 
'''Technical Overview'''
* [[Configuration (Magic) Data ]]
**[[Magic Data Storage Mechanisms]]
* [[Custom Reporting -- An Overview]]
**[[Custom Reporting -- Creating Form Relationships]]
**[[Custom Reporting -- Creating Reports]]
**[[Custom Reporting -- Creating Report Views]]
* [[Data Interoperability]]  
* [[Database Structure]]
* [[Database Structure]]
* [[File Search Paths]]
* [[Module Structure]]
** [[Modules Lists]]
** [[File Search Paths]]
** [[Configuration (Magic) Data]]
*** [[Magic Data Storage Mechanisms]]
*** [[Swiss Magic Data Editor]]
*** [[Migrating Forms from Entry to MagicData]]
* [[Tasks and Roles]]
** [[IHRIS Task List]]
** [[IHRIS Role List]]
* [[Pages and Templates]]
** [[IHRIS Template List]]
* [[Forms and Form Classes]]  
* [[Forms and Form Classes]]  
**[[Form Caches]]
** [[Form Lists]]  
**[[Defining Forms]]
** [[IHRIS Class List]]  
**[[ Limiting Forms]]
** [[Form Storage Mechanisms]]
**[[Form Storage Mechanisms]]  
** [[Form Fields]]
* [[Module Structure]]
*** [[Adding Fields]]
* [[Pages and Templates]]
*** [[Adding Form and Field Validations]]
* [[Supporting Software]]
*** [[Customizing Form and Field Headers]]
* [[Swiss Magic Data Editor]]
** [[Defining Forms]]  
** [[Swiss Magic Data -- Form Relationships]]
** [[Limiting Forms]]
* [[Tasks and Roles]]
** [[Form Caches]]  
 
*** [[Configuring Form Cache Generation Timing]]
'''Tutorials'''
*** [[Turn Off Background Processes]]
* [[Adding Fields to the Person Form]]
*** [[Recreate All Form Caches]]
* [[Adding Forms and Fields]]
** Miscellaneous Tutorials
* [[Adding ISCO 88 Job Codes to iHRIS Manage]]
*** [[Printed Forms]]  
* [[Creating a New Form Field]]
*** [[Customize Recent Forms Display]]
* [[Customizing iHRIS Manage]]
*** [[Linking Facilities and Departments]]
* [[Linking Facilities and Departments]]
*** [[Create a Data Form Map For My Custom Site]]
* [[Managing Decentralized iHRIS Manage with Launchpad]]
*** [[Creating a CSV Upload Page]]
* [[Modifying Form and Field Headers]]
*** [[Send Email]]
* [[Upgrading From 3.1]]
** [[Automatically Generated Integers]]
* [[Using Bazaar to Contribute Code]]
* [[Custom Reporting]]  
* [[Migrating Forms from Entry to MagicData]]
* [[Cron Jobs]]  
 
* User Interactions
== iHRIS Common Documentation ==
** [[User Automated Reports]]
 
** [[User Alerts]]
* [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.''
** [[User Triggers]]
* [[iHRIS:Data Dictionary|Data Dictionary]]
 
 
== iHRIS Manage Documentation ==
 
* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISManageVision.pdf Vision Statement (PDF)]
* Use Case Model and Requirements - Full Report [http://www.capacityproject.org/hris/suite/UseCaseReport-iHRISManage.htm (HTML)] [http://www.capacityproject.org/hris/hris-toolkit/tools/doc/iHRISManageUseCases.doc (MS Word Document)]
* [[iHRIS Manage Form Fields | Forms and Fields]]
* [http://open.intrahealth.org/ihrismanual/ User's Manual]
 
 
== iHRIS Qualify Documentation ==
 
* [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)]
*[[iHRIS Qualify Form Fields | Forms and Fields]]
 
== iHRIS Plan Documentation ==
 
* [http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/iHRISPlan_vision.pdf Vision Statement (PDF)]
* Use Case Model and Requirements: Full Report [http://www.capacityproject.org/hris/suite/UseCaseReport_iHRISPlan.htm (HTML)] [http://www.capacityproject.org/hris/hris-toolkit/tools/doc/iHRISPlanUseCases.doc (MS Word Document)]
* [[iHRIS Plan Technical Documentation]]


<br> We also have additional tutorials for [[Developer Resources|Developers]] or [[Implementer Resources|Implementers]].


== Maintainer's Documentation ==
[[Category:iHRIS Software]][[Category:Developer Resources]]
* [[Development Timelines]]
* [[Design Documents]]
* [[HowTo: Create a New Software Release]]
* [[HowTo: Building Debian Packages from bzr]]
* [[HowTo: Creating Debian Packages]]
* [[HowTo: Creating an iHRIS ISO]]
* [[HowTo: Creating Translations]]
* [[LiveCD Notes]]

Latest revision as of 16:43, 12 August 2015