View source for Custom Reporting -- Creating Reports

This documentation applies specifically to iHRIS 4.0, although much of it applies to version 3.1.
==Uso para el que fue Diseñado==
Este paso está destinado para aquel que tenga una comprensión moderada de como los datos se relacionan en el sistema. COnsiste en poco más de escoger una relación de formularios y seleccionar los datos que se quieren en el informe marcando las casillas específicas.

Una vez que el informe ha sido definido, se puede crae un [[Custom Reporting -- Creating Report Views|multiple views]] de los datos en el informe.

==Pasos Iniciales==
Para crear un informe, primero debe:
*escoger un [[Custom Reporting -- Creating Form Relationships|relationship]]
*seleccionar un "Display Name" para el informe,  el nombre del informe para el usuario final.
*seleccione un "Short Name" para el informe, wo cual es una manera de hacer referencia internamente al informe y sólo puede contener caracteres alfa-numericos y algunos signos limitados de puntuación tales como _ y -.  
*Una descripción del informe.
*Una categoría para el informe.  Esto se utiliza para agrupar distintas vistas de informes.

==Estructura de las Tablas en los Informes==
Los informes se basan en [[Custom Reporting -- Creating Form Relationships|form relationship]].  Cada juego de formularios que satisfacen una relación corresponden a una fila en una tabla de informe. Un informe llamado '''XXXXX''' ocasionara que  una tabla llamada 'zebra_'''XXXXX''''' y [[#Report Table Generation|populated]] se creen en la base de datos .   

Las columnas en una tabla de informe son:
*`$reportFormName+id`: Las id de cada uno de los formularios que satisfacen la relación. 
* `$reportFormName+$fieldName`: Cualquiera de los [[#Selecting Fields|selected fields]] de cada unao de los formularios en la relación asi como cualquier campo utilizado para [[#Selecting Limits|limit]] del reporte.
*`$function`: Cualquier [[#Selecting Functions|functions]] que esté seleccionado para el informe

==Selección de Campos==
Cualquiera de los campos en cualquiera de los formularios que satisfagan la relación de formulario seleccionada puede ser incluido en el reporte.

==Selecting Limits==
Any of the fields of a form in the relationship can be selected to limit the report by.  These limits will show up in the report views.  There are various ways (styles) that a field can be limited, depending on the field, and are cataloged [[Limiting Forms#Existing Styles|here]].

For each limit style for a field, you can set the header text under which the limit is displayed in the report view.

==Selecting Functions==
Any of the [[Custom Reporting -- Creating Form Relationships#Adding in a SQL Function|functions]] defined for a relationship can be selected to include in the report.  They can also be chosen as limits.

==Adding Links==

==Pivots==

In Limiting options for Reported Fields, there is an option "Enable Pivoting on this Limit".   The pivot let's you link the values displayed in one report to the limits/filters of another report.

For an example of what this is, take a look at the iHRIS Manage Demo site, look under the "Facility List" report.  Next to the values in the  "Facility Name" column, you will see a [+].  Suppose you are looking at "Rushonga Hospital"

Clicking on the [+] will open a list of related reports, Job Breakdown, Position List, Staff directory.  If you click on the link "Switch to Staff Directory" it will take you to the Staff Directory report where the limit of "Rushonga Hospital" has already been applied.

==Report Table Generation==
The '''zerbra_XXXXX''' tables contain the data of the report and are built from the [[Form Caches|form caches]].   These tables are generated by a background process once a report is consider stale.  The background process is spawned by default every 10 minutes.  This can be specified by setting the value in magic data at:
*/modules/CustomReports/times/background
The stale time for a report defaults to 10 minutes.  This can be over-ridden by the following setting values in magic data:
*/modules/CustomReports/times/stale 
*/modules/CustomReports/times/stale_by_report/XXXXX   

[[Category:Technical Overview]][[Category:Reports]][[Category:Review2013]]