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

Release Notes

• README File for iHRIS (Manage and Qualify version 3.1.4)
• 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

Windows

The Windows verison of iHRIS was formerly referred to as Offline iHRIS.

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

How Tos,Techinical Overviews, and Tutorials

How Tos

• How To: Recreate All Form Caches

Technical Overview

• Technical Overview: Configuration (Magic) Data
  • Technical Overview: Magic Data Storage Mechanisms
• Technical Overview: Data Interoperability (version 3.2 and later)
• Technical Overview: Database Structure
• Technical Overview: File Search Paths
• Technical Overview: Forms and Form Classes
  • Technical Overview: Defining Forms
  • Technical Overview: Limiting Forms
  • Technical Overview: Form Storage Mechanisms (version 3.2 and later)
• Technical Overview: Module Structure
• Technical Overview: Pages and Templates
• Technical Overview: Supporting Software
• Technical Overview: Tasks and Roles
• Technical Overview: Windows-based Development

Tutorials

• Tutorial: Adding Fields to the Person Form
• Tutorial: Adding Forms and Fields
• Tutorial: Adding ISCO 88 Job Codes to iHRIS Manage
• Tutorial: Customizing iHRIS Manage
• Tutorial: Modifying Form and Field Headers
• Tutorial: Upgrading From 3.1
• Tutorial: 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)
• Form Fields
• User's Manual

iHRIS Qualify Documentation

• Vision Statement (PDF)
• Use Case Model and Requirements - Full Report (HTML) (MS Word Document)
• ER Diagram (PNG)

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: Create a New Software Release
• HowTo: Creating Debian Packages
• HowTo: Creating an iHRIS ISO
• HowTo: Creating Translations POT files for Launchpad