Custom Reporting -- Exporting Relationships and Reports to a Module (4.0.13): Difference between revisions

From IHRIS Wiki
Line 26: Line 26:
Ahora puede agregar un directorio en el directorio de módulos de su sitio para su moódulo nuevo y luego mover el archivo de configuración ahí. Finalmente si desea que este se habilite por defecto, habilite el módulo en su archivo de configuración del sitio.
Ahora puede agregar un directorio en el directorio de módulos de su sitio para su moódulo nuevo y luego mover el archivo de configuración ahí. Finalmente si desea que este se habilite por defecto, habilite el módulo en su archivo de configuración del sitio.


==Options==
==Opciones==
There are a few other default options you can override that will affect the completed module.
Existen unas cuantas otras opciones por defecto que puede desabilitar que afectarán el módulo completado.


;--version (<code>--version=4.0.3.2</code>) : Set the version to be used for the moduleYou can set this when you've made changes and need to make a new module file based on an existing module.
;--version (<code>--version=4.0.3.2</code>) : Fije la versión a ser utilizada por el móduloPuede fijar esto cuando haya hecho cambios y necesite hacer un nuevo archivo de módulo basado en un módulo existente.
;--module (<code>--module=MyReport-relationship</code>) : Set the module name for the module and the filename that will be created.
;--module (<code>--module=MyReport-relationship</code>) : Fije el nombre del módulo para el módulo y el filename que se creará.
;--display (<code>--display="My Report Module"</code>) : Set the display name for the module.
;--display (<code>--display="My Report Module"</code>) : Fije el nombre a mostrarse para el módulo.
;--description (<code>--description="This is my report relationship and report/report view definitions."</code>) : Set the description for the module.
;--description (<code>--description="This is my report relationship and report/report view definitions."</code>) : Fije la descripción para el módulo.


The display and description will appear in the Configure Modules page to further define the module you have created.
La visualización y descripción aparecerán en la página Configure Modules page para definir de manera más detallada el módulo que ha creado.


==Testing==
==Testing==

Revision as of 00:23, 30 September 2013


Se ha creado una herramienta que permite que las relaciones y todos los informes relacionados y reportViews se exporten de manera sencilla a un módulo que luego se podrá compatir con otras personas.

Habilitando la Herramienta

la herramienta es parte del módulo exportReport. Este módulo puede encontrarse bajo Pages->Admin->exportReport. También se puede habilitar esto con

php index.php --update=1 --enable=exportReport

de las pages del directorio del sitio.

Utilizando la Herramienta

Vaya a el sub-directory de páginas del directorio del sitio. El directorio del sitio es donde se encuentra el archivo de módulo del sitio, e.j. iHRIS-Manage-Demo.xml. Ahora escriba este comando:

<source lang="bash"> php index.php --page=admin/exportReport </source> Cuando se ejecute preguntará si desea incluir la relación en el módulo. Sí creó una nueva relación, entonces escriba Y si. Si desea exportar informes nuevos o vistas de informes entonces escriba N no.

A continuación mostrará una lista de todos los informes que utilizan la relación dada. Escriba el número que está al lado del informe(s) que desea incluir. Escriba sólo un número a la vez seguido de enter. Cuando haya selecionado todo lo que desee incluir escriba q seguido de enter.

Por cada informe que selecionó, ahora se mostrarán la lista de vistas de informe para ese informe. Una vez más seleccione las vistas del informe que desea incluir en el módulo y escriba q seguido de enter y con eso habrá terminado.

Un archivo se creará llamado CustomReports-full-XXX.xml en su directorio actual. El XXX será reemplazado por la relación que escoja. Sí el archivo ya existe se le agregarán números de esta manera: CustomReports-full-XXX001.xml.

Ahora puede agregar un directorio en el directorio de módulos de su sitio para su moódulo nuevo y luego mover el archivo de configuración ahí. Finalmente si desea que este se habilite por defecto, habilite el módulo en su archivo de configuración del sitio.

Opciones

Existen unas cuantas otras opciones por defecto que puede desabilitar que afectarán el módulo completado.

--version (--version=4.0.3.2)
Fije la versión a ser utilizada por el módulo. Puede fijar esto cuando haya hecho cambios y necesite hacer un nuevo archivo de módulo basado en un módulo existente.
--module (--module=MyReport-relationship)
Fije el nombre del módulo para el módulo y el filename que se creará.
--display (--display="My Report Module")
Fije el nombre a mostrarse para el módulo.
--description (--description="This is my report relationship and report/report view definitions.")
Fije la descripción para el módulo.

La visualización y descripción aparecerán en la página Configure Modules page para definir de manera más detallada el módulo que ha creado.

Testing

When testing you have to consider two cases: Are you going to test on the same machine you used to export these reports? Or are you going to test on a different machine?

Testing on the same site

If you are going to test on the same site you used to create these reports, remember you'll still have these reports (relationships, reports and reportViews) that you created from the Browser. The export tool however inserts lines <conflict> that will delete all entries created from the the Graphical User Interface. For some reasons sometime this does not work properly. So you may need to go delete them manually from the Magic Data Browser by going through

Configure System -> Browse Magic Data -> modules -> CustomReports -> relationships
from here you delete the relationship that you are sure you exported to the XML file.

You should repeat the same for reports and reportViews. Then enable your module in the site config file and initialize the upgrade from the browser.

Warning:
you have to be extra careful not to delete anything that does not relate to what you have exported.

Testing on a different machine/site

This does't necessarily need to be on a different machine, it could just be another iHRIS instance running on the same machine. You will need to delete the <erase> entries in the final module file and then enable it on the site config.