Technical Documentation: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
(46 intermediate revisions by 2 users not shown)
Line 1: Line 1:
iHRIS makes use of multiple tables in a relational database (MySQL) to store its data in. [[Database Structure]] describes several of the tables used by iHRIS, in particular the user table and the tables used for [[Form Storage -- Entry/Last Entry|audited form data changes]].
* [[Introduction and Overview]]
 
* [[Database Structure]]
=Modules=
* [[Module Structure]]
This tutorial describes the iHRIS [[Module Structure]]. An iHRIS module is a collection of various types of "code" by the features that they provide to the system. Modules serve as the building blocks of iHRIS and are grouped according to the functionality they provide.
** [[Modules Lists]]  
 
** [[File Search Paths]]  
[[Modules Lists]] are links to the various [[Module Structure|modules]] used by iHRIS.
** [[Configuration (Magic) Data]]  
 
*** [[Magic Data Storage Mechanisms]]  
The [[File Search Paths|File Search Utility]] lets you easily categorize different files and make them available to iHRIS. It also allows you to copy a file from the core iHRIS Suite into your site customization to make changes there, without having to modify the core iHRIS software.
*** [[Swiss Magic Data Editor]]  
 
*** [[Migrating Forms from Entry to MagicData]]  
=Magic Data=
* [[Tasks and Roles]]  
[[Configuration (Magic) Data|Magic Data]] is a mechanism intended to handle dynamic site-level configuration data. It is the basis of much of the functionality provided by the IntraHealth Informatics Core Engine (I2CE), including how pages are served and how custom reports are made.
** [[IHRIS Task List]]  
 
** [[IHRIS Role List]]
Magic data provides a central mechanism for configuring iHRIS. This magic data is stored in a database table. Due to frequent access of the data, a caching mechanism is needed to keep the database load down. For this reason, several [[Magic Data Storage Mechanisms|magic data storage mechanisms]] have been created.
* [[Pages and Templates]]  
 
** [[IHRIS Template List]]
The [[Swiss Magic Data Editor|Swiss Magic editors]] hierarchically edit and view the configuration data. This article describes the structure of the Swiss Magic PHP classes.
* [[Forms and Form Classes]]  
 
** [[Form Lists]]  
This tutorial explains how to [[Migrating Forms from Entry to MagicData|Migrate Forms from Entry to MagicData]].
** [[IHRIS Class List]]  
 
** [[Form Storage Mechanisms]]
=Tasks and Roles=
** [[Form Fields]]
[[Tasks and Roles]] -- iHRIS uses a task- and role-based security mechanism to limit access to various parts of the system. A user is assigned a role, and a role is a collection of tasks that the role can perform. This article describes how roles and tasks are defined in Magic Data and used by the iHRIS system.
*** [[Adding Fields]]
 
*** [[Adding Form and Field Validations]]
*[[IHRIS Task List|Task List]]  
*** [[Customizing Form and Field Headers]]
*[[IHRIS Role List|Role List]]
** [[Defining Forms]]  
 
** [[Limiting Forms]]
=Pages and Templates=
** [[Form Caches]]
[[Pages and Templates]] -- This tutorial describes the role of Pages and Templates in iHRIS. A page handles each URL request. A template is used to access the HTML elements of a page.
*** [[Configuring Form Cache Generation Timing]]
 
*** [[Turn Off Background Processes]]
[[IHRIS Template List|HTML Template List]]
*** [[Recreate All Form Caches]]
 
** Miscellaneous Tutorials
=Forms and Fields=
*** [[Printed Forms]]  
[[Forms and Form Classes]] -- Records are stored in the IntraHealth Informatics Core Engine (I2CE) in forms, which consist of collection fields. You can think of a form as table in a database and a field as a column of that table.
*** [[Customize Recent Forms Display]]
 
*** [[Linking Facilities and Departments]]
*[[Form Lists]]  
*** [[Create a Data Form Map For My Custom Site]]
*[[IHRIS Class List|Class List]]  
*** [[Creating a CSV Upload Page]]
*[[Automatically Generated Integers]]
*** [[Send Email]]
 
** [[Automatically Generated Integers]]
[[Form Storage Mechanisms]] -- The iHRIS system uses a level of abstraction to separate how data is stored in the system versus how it is organized and relates to each other. A form (and its fields) provides the organization. The data storage is handled by various form storage mechanisms.
* [[Custom Reporting]]  
 
* [[Cron Jobs]]  
[[Defining Forms]] -- This page describes how to define and customize forms and fields in iHRIS by defining them in magic data.
* User Interactions
 
** [[User Automated Reports]]
[[Limiting Forms]] -- Data in iHRIS is stored in forms and fields. This article describes the structure of how various limits are applied to forms.
** [[User Alerts]]
 
** [[User Triggers]]
[[Form Fields]] -- This article describes the main data types, or form fields, used by iHRIS. These fields are defined in Magic Data; this page describes the details of how they should be defined.
 
[[Form Caches]] -- The iHRIS software caches data saved in the database (or XML file or LDAP server) for faster access and the ability to create indices. These caches are used, for example, to populate reports and drop-down lists.
 
[[Printed Forms]] -- This tutorial describes how to create "standardized" or "official" PDF forms based on the data in the system.
 
How to: [[Adding Fields|Add Fields]] -- These tutorials describe how to add new forms and fields to iHRIS.
 
How to: [[Adding Form and Field Validations|Add Validations for Forms and Fields]] -- This tutorial describes how to add custom data validations for forms and fields.
 
=Reports=
[[Custom Reporting]] -- This page collects the various articles that describe how to use the Custom Reporting system in iHRIS. This includes detailed documentation about the structure of custom reports and their use in advanced iHRIS features, as well as several tutorials on creating particular reports.
 
[[Cron Jobs]] - Running functions on a regular basis with iHRIS.


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


[[Category:Technical_Overview]]
[[Category:iHRIS Software]][[Category:Developer Resources]]

Latest revision as of 16:43, 12 August 2015