Custom Reporting -- Creating Reports: Difference between revisions

From IHRIS Wiki
No edit summary
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
This documentation applies specifically to iHRIS 4.0, although much of it applies to version 3.1.
This documentation applies specifically to iHRIS 4.0, although much of it applies to version 3.1.
==Uso para el que fue Diseñado==
==Intended Use==
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.
This step is intended who has a moderate understanding of how the data are related in the system. It consists of little more than choosing a form relationship and selecting the data you want in the report with checkboxes.


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.
Once a report has been defined, you can create [[Custom Reporting -- Creating Report Views|multiple views]] of the data in the report.


==Pasos Iniciales==
==First Steps==
Para crear un informe, primero debe:
To create a report, you first must first:
*escoger un [[Custom Reporting -- Creating Form Relationships|relationship]]
*chose a [[Custom Reporting -- Creating Form Relationships|relationship]]
*seleccionar un "Display Name" para el informe,  el nombre del informe para el usuario final.
*select a "Display Name" for the report,  the name of the report for the end user.
*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 -.   
*select a "Short Name" for the report, which is a way to reference the report internally and can only contain alpha-numeric characters and some limited punctuation such as _ and -.   
*Una descripción del informe.
*A description of the report.
*Una categoría para el informe.  Esto se utiliza para agrupar distintas vistas de informes.
*A category for the report.  This is used to group different report views together.


==Estructura de las Tablas en los Informes==
==Report Tables Structure==
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 .   
Reports are based on a [[Custom Reporting -- Creating Form Relationships|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 [[#Report Table Generation|populated]].   


Las columnas en una tabla de informe son:
The columns in the report table are as follows:
*`$reportFormName+id`: Las id de cada uno de los formularios que satisfacen la relación.  
*`$reportFormName+id`: The id's of each of the forms satisfying the relationship.  
* `$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.
* `$reportFormName+$fieldName`: Any of the [[#Selecting Fields|selected fields]] from each of the forms in the relationship as well as any field used to [[#Selecting Limits|limit]] the report.
*`$function`: Cualquier [[#Selecting Functions|functions]] que esté seleccionado para el informe
*`$function`: Any [[#Selecting Functions|functions]] that are selected for the report


==Selección de Campos==
==Selecting Fields==
Cualquiera de los campos en cualquiera de los formularios que satisfagan la relación de formulario seleccionada puede ser incluido en el reporte.
Any of the fields of any of the forms which satisfies the chosen form relationship can be included in the report.


==Selección de Límites==
==Selecting Limits==
Cualquiera de los campos de un formulario en la relación puede ser seleccionado para limitar el informe.  Estos límites apareceran en las vistas del inforem. Hay varias formas (estilos) para limitar un campo, dependiendo del campo, y son catalogados [[Limiting Forms#Existing Styles|here]].
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]].


Para cada estilo de límite para un campo, se puede fijar el encabezado de texto bajo el cual el límite es desplegado en la vista del informe.
For each limit style for a field, you can set the header text under which the limit is displayed in the report view.


==Selección de Funciones==
==Selecting Functions==
Cualquiera de las [[Custom Reporting -- Creating Form Relationships#Adding in a SQL Function|functions]] definidas para una relación puede ser seleccionada para incluirse en el informe. También pueden ser escogidas como límites.
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==
==Adding Links==
Line 49: Line 49:
*/modules/CustomReports/times/stale_by_report/XXXXX   
*/modules/CustomReports/times/stale_by_report/XXXXX   


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

Latest revision as of 14:23, 8 November 2013

This documentation applies specifically to iHRIS 4.0, although much of it applies to version 3.1.

Intended Use

This step is intended who has a moderate understanding of how the data are related in the system. It consists of little more than choosing a form relationship and selecting the data you want in the report with checkboxes.

Once a report has been defined, you can create multiple views of the data in the report.

First Steps

To create a report, you first must first:

  • chose a relationship
  • select a "Display Name" for the report, the name of the report for the end user.
  • select a "Short Name" for the report, which is a way to reference the report internally and can only contain alpha-numeric characters and some limited punctuation such as _ and -.
  • A description of the report.
  • A category for the report. This is used to group different report views together.

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.

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. 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
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Custom_Reporting_--_Creating_Reports&oldid=52778"