1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter�5.�Writing a New Report</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="Lire Developer's Manual"><link rel="up" href="pt02.html" title="Part�II.�Using the Lire Framework"><link rel="previous" href="ch04s03.html" title="DLF Analyser API"><link rel="next" href="pt03.html" title="Part�III.�Developer's Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter�5.�Writing a New Report</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s03.html">Prev</a>�</td><th width="60%" align="center">Part�II.�Using the Lire Framework</th><td width="20%" align="right">�<a accesskey="n" href="pt03.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="chap:writing-report-spec"></a>Chapter�5.�Writing a New Report</h2></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch05.html#sect:filter-spec">Filter Specification</a></span></dt></dl></div><p>Writing a new report involves writing a report specification,
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter�5.�Writing a New Report</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="Lire Developer's Manual"><link rel="up" href="pt02.html" title="Part�II.�Using the Lire Framework"><link rel="prev" href="ch04s03.html" title="DLF Analyser API"><link rel="next" href="pt03.html" title="Part�III.�Developer's Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter�5.�Writing a New Report</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s03.html">Prev</a>�</td><th width="60%" align="center">Part�II.�Using the <span class="application">Lire</span> Framework</th><td width="20%" align="right">�<a accesskey="n" href="pt03.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="chap:writing-report-spec"></a>Chapter�5.�Writing a New Report</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch05.html#sect:filter-spec">Filter Specification</a></span></dt></dl></div><p>Writing a new report involves writing a report specification,
3
<tt class="filename">/service/<superservice>/reports/top-foo-by-bar.xml</tt>,
3
<code class="filename">/service/<superservice>/reports/top-foo-by-bar.xml</code>,
4
4
and adding this report along with possible configuration parameters to
5
<tt class="filename"><service>.cfg</tt>. E.g., to create a new report,
6
based upon <tt class="filename">email/from-domain.xml</tt>: copy the file
7
<tt class="filename">/usr/local/etc/lire/email.cfg</tt> to
8
<tt class="filename">~/.lire/etc/email.cfg</tt>. Copy the file
9
<tt class="filename">/usr/local/share/lire/reports/email/top-from-domain.xml</tt>
5
<code class="filename"><service>.cfg</code>. E.g., to create a new report,
6
based upon <code class="filename">email/from-domain.xml</code>: copy the file
7
<code class="filename">/usr/local/etc/lire/email.cfg</code> to
8
<code class="filename">~/.lire/etc/email.cfg</code>. Copy the file
9
<code class="filename">/usr/local/share/lire/reports/email/top-from-domain.xml</code>
11
<tt class="filename">~/.lire/reports/reports/email/from-domain.xml</tt>.
11
<code class="filename">~/.lire/reports/reports/email/from-domain.xml</code>.
12
12
Edit the last file to your needs, and enable it by listing it in your
13
<tt class="filename">~/.lire/etc/email.cfg</tt>.
13
<code class="filename">~/.lire/etc/email.cfg</code>.
16
16
Beware! The name of the report generally consists of alphanumerics and
18
18
any '-' characters. It generally consists of alphanumerics and '_'
21
</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect:filter-spec"></a>Filter Specification</h2></div></div><div></div></div><p>
21
</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect:filter-spec"></a>Filter Specification</h2></div></div></div><p>
22
22
For now, you'll have to refer to the example filters as found in the
23
23
current report specification files. We'll give one other example
24
24
here: specifying a time range.
42
42
When trying your new filter, you could install it in
43
<tt class="filename">~/.lire/filters/your-filter-name.xml</tt>. When lr_dlf2xml
43
<code class="filename">~/.lire/filters/your-filter-name.xml</code>. When lr_dlf2xml
44
44
looks up a filter which was mentioned in the report configuration file, it
45
looks first in <tt class="filename">~/.lire/filters/</tt>, and then in
46
<tt class="filename">.../share/lire/filters/</tt>.
45
looks first in <code class="filename">~/.lire/filters/</code>, and then in
46
<code class="filename">.../share/lire/filters/</code>.
48
48
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04s03.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="pt02.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="pt03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">DLF Analyser API�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�Part�III.�Developer's Reference</td></tr></table></div></body></html>
added
removed
doc/dev-manual/ch05.html
