|
|
| (177 intermediate revisions by 7 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>
| |
| | |
| | |
| <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>
| |
| | |
| | |
| == Release Notes ==
| |
| | |
| * [[README File for iHRIS]] (Manage version 4.0.18 and Qualify version 4.0.18)
| |
| * [[README File for iHRIS Plan]] (version 1.0.4)
| |
| | |
| == General Installation 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]
| |
| | |
| ===Linux (RedHat-Fedora)===
| |
| * [[Linux (RedHat-Fedora) Installation]]
| |
| | |
| ===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''.
| |
| * [[iHRIS:Using Windows iHRIS|Windows Installation]]
| |
| * [[HowTo: Using Alternate Sites in Windows iHRIS]]
| |
| * [[HowTo: Building Windows iHRIS]]
| |
| | |
| | |
| ==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==
| |
| 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]] | |
| * [[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]]
| |
| | |
| ===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]]
| |
| * [[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 Fields]] | | ** [[Form Lists]] |
| ***[[Automatically Generated Integers]]
| | ** [[IHRIS Class List]] |
| **[[Form Caches]] | | ** [[Form Storage Mechanisms]] |
| ***[[Exporting and Updating Form Caches Using Profiles]]
| | ** [[Form Fields]] |
| **[[Defining Forms]] | | *** [[Adding Fields]] |
| **[[Limiting Forms]] | | *** [[Adding Form and Field Validations]] |
| **[[Changing List Displays]] | | *** [[Customizing Form and Field Headers]] |
| **[[Form Storage Mechanisms]] | | ** [[Defining Forms]] |
| * [[Module Structure]]
| | ** [[Limiting Forms]] |
| * [[Pages and Templates]]
| | ** [[Form Caches]] |
| *Printed Forms | | *** [[Configuring Form Cache Generation Timing]] |
| ** [[Printed Forms| Printed Forms PDF]] | | *** [[Turn Off Background Processes]] |
| ** [[Standardized Letters (ODT) | Printed Forms Open Office (Word) Document]] | | *** [[Recreate All Form Caches]] |
| ** [[Printed Forms with Reports (ODT)| Printed Forms Open Office (Word) Document]] | | ** Miscellaneous Tutorials |
| * [[Pluggable Authentication]]
| | *** [[Printed Forms]] |
| * SDMX-HD Data Export
| | *** [[Customize Recent Forms Display]] |
| ** [[SDMX-HD Data Export -- Zanzibar]] | | *** [[Linking Facilities and Departments]] |
| ** [[SDMX-HD Data Export -- Kenya]] | | *** [[Create a Data Form Map For My Custom Site]] |
| * [[Setting Up Mail]]
| | *** [[Creating a CSV Upload Page]] |
| * [[Supporting Software]]
| | *** [[Send Email]] |
| * [[Swiss Magic Data Editor]]
| | ** [[Automatically Generated Integers]] |
| ** [[Swiss Magic Data -- Form Relationships]] | | * [[Custom Reporting]] |
| * [[Tasks and Roles]] | | * [[Cron Jobs]] |
| | | * User Interactions |
| ===Tutorials===
| | ** [[User Automated Reports]] |
| * [[Adding Fields to the Person Form]] | | ** [[User Alerts]] |
| * [[Adding Forms and Fields]] | | ** [[User Triggers]] |
| * [[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]] | |
| * [[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]] | |
| | |
| == 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.''
| |
| * [[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]] | |
| | |
|
| |
|
| == 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]] |
| * [[Development Timelines]]
| |
| * [[IHRIS Ideas List]]
| |
| * [[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]]
| |
| * [[iHRIS Retain User's Manual (Draft)]]
| |
| * [[Arabic Translations]]
| |
