{=
  include("docs.util");
  start_docs_page(docs.technical_manual.page_titles.architecture);
=}

<h3>$PRODUCT_NAME Architecture Overview</h3>

<p>This document provides a high-level overview of the internal architecture that is specific to $PRODUCT_NAME.</p>

<ul>
  <li><p><a href="#log_importer">Log Importer</a>: A component which reads log data from a log source, and puts it into the $PRODUCT_NAME database.</p></li>
  <li><p><a href="#database">$PRODUCT_NAME Database</a>: A database which keeps a copy of the log data, and is queried to generate reports.</p></li>
  <li><p><a href="#reporting">Reporting Interface</a>: A web interface providing access to dynamic reports.</p></li>
  <li><p><a href="#admin">Administrative Interface</a>: A web interface for administrating profiles, schedules, users, roles, tasks, and more.</p></li>
  <li><p><a href="#web_server">Web Server</a>: A built-in web server providing a graphical interface for administrating and viewing reports.</p></li>
  <li><p><a href="#command_line">Command-line Interface</a>: An extensive command-line interface that can be used to manage profiles, generate reports, and more.</p></li>
</ul>

<h4><a name="log_importer">Log Importer</a></h4>
<p>
$PRODUCT_NAME is a log analyzer. It reads text log data from a log source (usually log files on the local disk, a network mounted disk, or FTP), parses the data, and puts it in the <a href="#database">$PRODUCT_NAME Database</a>. Log Filters can be used to convert or filter the data as it is read, or to pull in external metadata for use in reports.
</p>

<h4><a name="database">$PRODUCT_NAME Database</a></h4>
<p>
The $PRODUCT_NAME Database stores the data from the log source.  The <a href="#log_importer">Log Importer</a>
feeds data into the database, and the <a href="#reporting">Reporting Interface</a> queries the database to generate reports.
The database can be either the internal database, built into $PRODUCT_NAME, or a MySQL database.
</p>

<h4><a name="reporting">Reporting Interface</a></h4>
<p>
The Reporting Interface is an HTML interface delivered through the <a href="#web_server">Web Server</a>, to any
compatible web browser.  Reports are generated dynamically by querying the <a href="#database">$PRODUCT_NAME Database</a>.
The Reporting Interface allows arbitrary filters to be applied to any report, including Boolean filters.
Reports can be created or edited through the <a href="#admin">Administrative Interface</a>.
</p>

<h4><a name="admin">Administrative Interface</a></h4>
<p>
The Administrative Interface is an HTML interface delivered through the <a href="#web_server">Web Server</a>, to any
compatible web browser.  The Administrative Interface is used to create and edit profiles, users, scheduled tasks, and more.
</p>

<h4><a name="web_server">Web Server</a></h4>
<p>
The Web Server is an HTTP server built into $PRODUCT_NAME.  It serves the <a href="#reporting">Reporting Interface</a>
and the <a href="#admin">Administrative Interface</a>.  It is also possible to use an external web server
like Apache or IIS to serve the $PRODUCT_NAME interface.
</p>

<h4><a name="command_line">Command Line Interface</a></h4>
<p>
$PRODUCT_NAME includes an extensive command-line interface.  Some options available from the command line:</p>
<ul>
  <li><p> Create profiles</p></li>
  <li><p> Build or update databases (process logs)</p></li>
  <li><p> Expire data from an existing database</p></li>
  <li><p> Email HTML reports</p></li>
  <li><p> Generate HTML reports to disk</p></li>
</ul>
<p>
The most common command-line actions can also be run periodically, using the $PRODUCT_NAME Scheduler.
</p>



{= end_docs_page() =}