Technical Documentation

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 and User Manuals. For More information about the iHRIS Suite and the HRIS Strengthening program, see the iHRIS Project Website.

Need more help? Try us here

Downloadable PDF Version of the Documentation

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 this

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

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.

• Windows Installation
• HowTo: Using Alternate Sites in Windows iHRIS
• HowTo: Building Windows iHRIS

Translations

Enabling Translations

• I2CE Translation List
• iHRIS Common Translation List
• iHRIS Manage Translation List
• iHRIS Qualify Translation List

Master 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 Forms and 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
  • Create Facility/Geographic Restricted Users
  • Limit Dropdown (List) Fields 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
  • 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
• File Search Paths
• Forms and Form Classes
  • Form Fields
    • Automatically Generated Integers
  • Form Caches
    • Exporting and Updating Form Caches Using Profiles
  • Defining Forms
  • Limiting Forms
  • Changing List Displays
  • Form Storage Mechanisms
• Module Structure
• Pages and Templates
• Printed Forms
  • Printed Forms PDF
  • Printed Forms Open Office (Word) Document
  • Reports and Printed Forms, Open Office (Word) Document
• Pluggable Authentication
• SDMX-HD Data Export
  • SDMX-HD Data Export -- Zanzibar
  • SDMX-HD Data Export -- Kenya
• Setting Up Mail
• Supporting Software
• Swiss Magic Data Editor
  • Swiss Magic Data -- Form Relationships
• Tasks and Roles

Tutorials

• 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
  • Create a Staff List Custom Report
  • Creating an Establishment Custom Report
  • Add Images to a Report
  • 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

iHRIS Common Documentation

• Common Use Cases and Requirements (MS Word Document) Note: These use cases are included in the full HTML reports for each system below.
• Data Dictionary

iHRIS Manage Documentation

• Vision Statement (PDF)
• Use Case Model and Requirements - Full Report (HTML) (MS Word Document)
• Forms and Fields
• User's Manual

iHRIS Qualify Documentation

• Vision Statement (PDF)
• Use Case Model and Requirements - Full Report (HTML) (MS Word Document)
• Forms and Fields

iHRIS Plan Documentation

• Vision Statement (PDF)
• Use Case Model and Requirements: Full Report (HTML) (MS Word Document)
• iHRIS Plan Technical Documentation

Maintainer's Documentation

• HowTo: Release iHRIS Software
• 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