Technical Documentation: Difference between revisions

From IHRIS Wiki
No edit summary
 
(126 intermediate revisions by 6 users not shown)
Line 1: Line 1:
This documentation is intended for developers and system administrators who are installing, administering, and customizing iHRIS. Need more help?  Try us [[Project Communication| here]]. There is also [[Country-Specific Documentation]].
* [[Introduction and Overview]]
 
 
== Release Notes ==
 
* [[README File for iHRIS]] (Manage version 4.1 and Qualify version 4.1)
* [[README File for iHRIS Plan]] (version 1.0.4)
 
 
Change Logs:
*[[iHRIS Suite 4.0 Development | Version 4.0]]
*[[iHRIS Suite 4.1 Development | Version 4.1]]
 
== General Installation Instructions ==
 
[[Software Requirements]]
 
[[Installation and Setup Instructions]]
 
===Linux (Ubuntu)===
 
* [[Linux (Ubuntu) Installation]]
* [[HowTo: Installing the Debian Packages]]
* [[HowTo: Installing on Mini-Box]]
 
Installing on ext4 filesystem?  see [http://ubuntuforums.org/showthread.php?t=1313834 this]
 
Poor internet connection?  See creating a [[Software Reporsitory Mirror|Software Repository Mirror]] for offline use.
 
===Linux (RedHat-Fedora)===
 
* [[Linux (RedHat-Fedora) Installation]]
 
 
==Translations==
 
*[[Enabling Translations]]
*[[I2CE Translation List (Development) | I2CE Translation List ]]
*[[iHRIS Common Translation List (Development) | iHRIS Common Translation List ]]
*[[iHRIS Manage Translation List (Development) | iHRIS Manage Translation List ]]
*[[iHRIS Qualify Translation List (Development) | iHRIS Qualify Translation List ]]
 
* Master [[iHRIS Translation List (Development) |  Translation List ]]
 
==Packages, Modules and the API==
[[Module Listing]]
 
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==
 
[[Learning Materials]]
 
 
===How Tos===
 
* [[Changing the Banner and Logo to Your Organization]]
* [[Changing Passport Image Dimensions and Size]]
* [[Configuring Form Cache Generation Timing]]
* [[Configuring Report Generation Timing]]
* [[Generate Reports Automatically]]
* [[Create a Data Form Map For My Custom Site]]
* [[Archive Reports Automatically]]
* [[Deleting Records]]
* [[Recreate All Form Caches]]
* [[Turn Off Background Processes]]
* [[Configuring Restricted Access by Facility or Geography]]
** [[ManageAccessFacility -- Create Facility/Geographic Restricted Users|Create Facility/Geographic Restricted Users]]
** [[ManageAccessFacility -- Limit Dropdown (List) Fields by User|Limit Dropdown (List) Fields by User]]
** [[ManageAccessFacility -- Limit Reports by User|Limit Reports by User]]
* [[Data entry statistics]]
* [http://www.ihris.org/mediawiki/upload/SettingPosition.pdf Set Positions (PDF of PowerPoint presentation)]
* [http://wiki.ihris.org/wiki/File:HRHIS_workflow_map_Problems.jpg iHRIS Manage Workflow Map Problem Areas (JPG)]
* [[Display Mapped Field From a Report]]
* [[Remap Data Fields]]
 
===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]]
**[[Custom Reporting -- Creating a Staff List Example | Tutorial: Creating A Staff List]]
**[[Custom Reporting -- Exporting Relationships and Reports to a Module]]
**[[Custom Reporting -- Search Reports]]
**[[Custom Reporting -- Limit Viewing A Report By A Task]]
**[[Custom Reporting -- Exporting Reports From the Command Line]]
* [[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]]  
**[[Automatically Generated Form Pages]]
** [[Form Lists]]  
**[[Form Fields]]
** [[IHRIS Class List]]  
***[[Automatically Generated Integers]]
** [[Form Storage Mechanisms]]
**[[Form Caches]]
** [[Form Fields]]
***[[Exporting and Updating Form Caches Using Profiles]]
*** [[Adding Fields]]
**[[Defining Forms]]
*** [[Adding Form and Field Validations]]
**[[Limiting Forms]]
*** [[Customizing Form and Field Headers]]
**[[Changing List Displays]]
** [[Defining Forms]]  
**[[Form Storage Mechanisms]]
** [[Limiting Forms]]
* [[Module Structure]]
** [[Form Caches]]  
* [[Pages and Templates]]
*** [[Configuring Form Cache Generation Timing]]
*Printed Forms
*** [[Turn Off Background Processes]]
** [[Printed Forms| Printed Forms PDF]]
*** [[Recreate All Form Caches]]
** [[Standardized Letters (ODT) | Printed Forms Open Office (Word) Document]]
** Miscellaneous Tutorials
** [[Printed Forms with Reports (ODT)| Reports and Printed Forms, Open Office (Word) Document]]
*** [[Printed Forms]]  
** [[Printed Forms form Relationships (ODT)]]
*** [[Customize Recent Forms Display]]
* [[Pluggable Authentication]]
*** [[Linking Facilities and Departments]]
* SDMX-HD Data Export
*** [[Create a Data Form Map For My Custom Site]]
** [[SDMX-HD Data Export -- Zanzibar]]
*** [[Creating a CSV Upload Page]]
** [[SDMX-HD Data Export -- Kenya]]
*** [[Send Email]]
* [[Setting Up Mail]]
** [[Automatically Generated Integers]]
* [[Supporting Software]]
* [[Custom Reporting]]  
* [[Swiss Magic Data Editor]]
* [[Cron Jobs]]  
** [[Swiss Magic Data -- Form Relationships]]
* User Interactions
* [[Tasks and Roles]]
** [[User Automated Reports]]
 
** [[User Alerts]]
===Tutorials===
** [[User Triggers]]
 
* [[Adding Fields to the Person Form]]
* [[Adding Forms and Fields]]
* [[Adding Form and Field Validations]]
* [[Adding ISCO 88 Job Codes to iHRIS Manage]]
* [[Creating a New Form Field]]
* Custom Reporting
** [[Custom Reporting -- Creating a Staff List Example | Create a Staff List Custom Report]]
** [[Custom Reporting -- Creating an Establishment Report | Creating an Establishment Custom Report]]
** [[Custom Reporting -- Add Images to a Report | Add Images to a Report]]
** [[Printed Forms with Reports (ODT)| Reports and Printed Forms, Open Office (Word) Document]]
* [[Customizing Form and Field Headers]]
* [[Customizing iHRIS Manage]]
* [[Decentralized iHRIS Data Policy]]
* [[Decentralized iHRIS Structure]]
* [[Exporting Standardized Data]]
* [[iHRIS Regional Rollout]]
* Launchpad
** [[Installing a Custom Site from Launchpad]]
** [[Managing A Site In Launchpad]]
* [[Linking Facilities and Departments]]
* [[Migrating Forms from Entry to MagicData]]
* [[Modifying Form and Field Headers]]
* [[Setting An Establishment]]
* [[Upgrading From 3.1]]
* [[Using Bazaar to Contribute Code]]
* [[Create a Calendar Display Page]]
* [[Data Export to DHIS in iHRIS F.A.S.T]]


== Maintainer's Documentation ==
<br> We also have additional tutorials for [[Developer Resources|Developers]] or [[Implementer Resources|Implementers]].


* [[HowTo: Release iHRIS Software]]
[[Category:iHRIS Software]][[Category:Developer Resources]]
* [[Design Documents]]
* [[Importing Data]]
* [[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]]
* [[iHRIS Retain User's Manual (Draft)]]
* [[Arabic Translations]]
* [[Data Dictionary - iHRIS 4.1]]

Latest revision as of 15:43, 12 August 2015