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 multiple views de los datos en el informe.

Pasos Iniciales

Para crear un informe, primero debe:

• escoger un 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.

Report Tables Structure

Reports are based on a form relationship. Each set of forms which satisfy a relationship corresponds to one row of a report table. A report named XXXXX will cause a table named 'zebra_XXXXX in the database to be created and populated.

The columns in the report table are as follows:

• `$reportFormName+id`: The id's of each of the forms satisfying the relationship.
• `$reportFormName+$fieldName`: Any of the selected fields from each of the forms in the relationship as well as any field used to limit the report.
• `$function`: Any functions that are selected for the report

Selecting Fields

Any of the fields of any of the forms which satisfies the chosen form relationship can be included in the report.

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 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 functions defined for a relationship can be selected to include in the report. They can also be chosen as limits.

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. 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