Chapter 4. Writing a New Report
Prev | Part II. Using the Lire Framework | Next

## Chapter 4. Writing a New Report

Writing a new report involves writing a report specification, e.g. `/service/<superservice>/reports/top-foo-by-bar.xml`, and adding this report along with possible configuration parameters to `<service>.cfg`. E.g., to create a new report, based upon `email/from-domain.xml`: copy the file `/usr/local/etc/lire/email.cfg` to `~/.lire/etc/email.cfg`. Copy the file `/usr/local/share/lire/reports/email/top-from-domain.xml` to e.g. `/usr/local/share/lire/reports/email/from-domain.xml`. Edit the last file to your needs, and enable it by listing it in your `~/.lire/etc/email.cfg`.

Beware! The name of the report generally consists of alphanumerics and '-', but the name of parameters may not contain any '-' characters. It generally consists of alphanumerics and '_' characters.

## Report Information

Prev | Up | Next
API for 2DLF Scripts | Home | Report's Display Specification