Linking to Reportico

Running Reportico reports by specifying URL parameters

You can access menus and reports directly by specifying the relevant information as part of the URL without having to go through the Admin page or by creating a custom script. For example you can :-

  • Directly access a report project menu

  • Run a report specifying all report criteria and the output format in the URL

  • With JSON and XML output format you can effectively turn your report suite into a web API

  • Take users directly to specified report without going through the menu, allowing you to build your own menu front end to reports

  • Embed reportico report output within your web pages

  • Run Reportico from a Linux command line (using for example wget) , allowing you to save reports and email them to recipients

In order to achieve the above, you need to point your browser at the run.php in your Reportico area (or a custom copy of this file) and provide various parameters to identify which project you want to run and what mode - menu mode (the default), report preparation/criteria entry mode or design mode. To generate report output you need to specify the report xml file name, the report output format ( HTML, PDF, CSV, JSON, XML ) and also the criteria. criteria and output format (HTML, PDF, CSV) within the URL. Exampes follow below but a list of available parameters is provided in Appendix 2 - Reportico URL request parameters.

Below find examples of simple common options for running Reportico from the browser :-

To run a report menu for a project, enter:

    http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=MENU&project={PROJECTCODE}

To run a report menu for a project which is restricted by a password, enter:

    http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=MENU&project={PROJECTCODE}&project_password={PASSWORD}

To run a specific report in criteria entry mode:

    http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=PREPARE&
                           project={PROJECTCODE}&xmlin={REPORT}.xml

To generate HTML output for a report. :

    http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=EXECUTE&
                          project={PROJECTCODE}&xmlin={REPORT}.xml&
                          target_format=HTML

To generate XML output for a report - just change the XML to PDF, CSV or JSON for those formats :

    http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=EXECUTE&
                          project={PROJECTCODE}&xmlin={REPORT}.xml&
                          target_format=XML

To generate HTML output for, for example, all invoices from 1st August 2011 to Today for raised for customers living in London or Paris you might do:- :

    http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=EXECUTE&
                          project={PROJECTCODE}&xmlin={REPORT}.xml&
                          target_format=HTML&MANUAL_daterange_FROM=2011-08-01&MANUAL_daterange_TO=TODAY%MANUAL_city=London,Paris

To Run a specific report in design mode in a password unprotected project:

http://{HOST}/{REPORTICO_DIR}/run.php?execute_mode=MAINTAIN&
                           project={PROJECTCODE}&xmlin={REPORT}.xml

Creating Links to Reports in Web Pages

Using the above mechanism you can create links in you web pages to Reportico reports. You can also use ajax calls to fetch Reportico output and present the output in a modal window or div, for example.