/usr/share/doc/rmagic/html/repconf.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN">
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=iso8859-1" />
        <meta name="AUTHOR" content="This page created by Wadsack-Allen Digital Goup" />
        <title>Report Magic for Analog Documentation - Report Settings</title>
<style type="text/css">
<!--
body {
    font-family: Verdana, Arial, Helvetica, sans-serif; 
    font-size:11pt;
}

p {
    font-family: Verdana, Arial, Helvetica, sans-serif; 
    font-size:11pt;
}

a {
    text-decoration:normal;
}

h1 {
    font-family: Tahoma, Arial, Helvetica, sans-serif; 
    font-size:24pt; 
    font-weight:bold;
}

h2 {
    font-family: Tahoma, Arial, Helvetica, sans-serif; 
    font-size:18pt; 
    font-weight:bold;
}

h3 {
    font-family: Tahoma, Arial, Helvetica, sans-serif; 
    font-size:16pt; 
    font-weight:bold;
}

h4 {
    font-family: Verdana, Arial, Helvetica, sans-serif; 
    font-size:14pt; 
    font-weight:bold
}

dl {
    font-family: Verdana, Arial, Helvetica, sans-serif; 
    font-size:10pt;
}

ul {
    font-family: Verdana, Arial, Helvetica, sans-serif; 
    font-size:10pt;
}

ol {
    font-family: Verdana, Arial, Helvetica, sans-serif; 
    font-size:10pt;
}

.fineprint {
    font-family:Arial, Helvetica; 
    font-size:8pt;
}

.fineprint a {
    color:#000099;
    font-weight:bold;
}

code {
    font-family: "Courier New", Courier, Monospaced, System; 
}
pre {
    font-family: "Courier New", Courier, Monospaced, System; 
}

.note  { 
	background-color: #f50000; 
	margin-right: 2em; 
	margin-left: 2em; 
	padding-right: 2px; 
	padding-left: 2px; 
	border: solid 1px #c50000; 
}

.term  { 
	background-color: #f5f5f5; 
	margin-right: 2em; 
	margin-left: 2em; 
	padding-right: 2px; 
	padding-left: 2px; 
	border: solid 1px silver;
	font-family: monospace,courier,fixedsys;
	font-size: 8pt;
}
-->
</style>
    </head>

    <body bgcolor="#ffffff" text="#000000" link="#000099" vlink="#cc3399" alink="#003399">
        <table border="0" cellspacing="0" cellpadding="0" summary="Layout table">
            <tr>
                <td align="center"><a href="http://www.reportmagic.org/"><img src="images/title.gif" width="288" height="66" alt="Report Magic for Analog" border="0" /></a> </td>

                <td rowspan="2" align="left" valign="top"><img src="images/logo.gif" width="138" height="150" alt="Documentation" /> </td>
            </tr>

            <tr>
                <td align="left" valign="top" width="291">
                    <h1>Report Settings</h1>
                </td>
            </tr>
        </table>
        

<h2><code>reports</code> section</h2>
<p>The <code>reports</code> section of your setting files contains settings 
that customize the look of the reports. The settings can be considered 
'defaults' that are applied to all reports. Specific reports can have 
their own sections <a href="#reps">as described below</a></p>

<a name="reports"></a><H3><CODE>reports</CODE> Section</H3>
<PRE>
[reports]
File_Out = reports/
Active_Column=R
Meta_Refresh = 86400
Image_Dir = ../images/
Stylesheet = styles.css
Reverse_Time = 1
Graph_Level = 1

BG_Color = #FFFFFF
Background = images/background.gif

Font = Verdana, Arial, Helvetica, sans-serif
Font_Color = #000000

Title_Font = Comic Sans MS, Brush Script, Helvetica, sans-serif
Title_BG_Color = #000000
Title_Font_Color = #FFFFFF

Data_Font = Verdana, Arial, Helvetica, sans-serif
Data_Font_Color_1 = #000000
Data_BG_Color_1 = #F0F0F0
Data_Font_Color_2 = #000000
Data_BG_Color_2 = #FFFFFF

Data_Total_Font = Verdana, Arial, Helvetica, sans-serif
Data_Total_Font_Color = #000000
Data_Total_BG_Color = #FFCCCC

Data_Header_Font = Verdana, Arial, Helvetica, sans-serif
Data_Header_Font_Color = #000000
Data_Header_BG_Color = #CCCCFF
</PRE>

<DL>

<dt><code>File_Out</code></dt>
<dd>This is the file and/or directory where the report page(s) will be made. 
If this is a filename (e.g. /stats/report.html) and then Report Magic will 
build all the reports in this one file (like Analog does). If this is an 
output directory (e.g. /stats/) then Report Magic will buils each report in 
it's own file in that directory. The directory specified here (by itself or 
as a part of the filename) is used for all files generated by Report 
Magic (including the frameset and navigation pages, if generated).</dd>

<dd>In this option (as well as <code>statistics_Frame_File_Out</code> and 
<code>navigation_File_Out</code>) you can add two types of codes to tell 
Report Magic to create a custom name for the file. The first code is 
<code>%infile%</code> which, if inserted anywhere in the filename, will be 
replaced with the name of the input data file without its extension. For example, 
if under the <code>[statistics]</code> section, 
<code>File_In=/usr/bin/analog/virtualhost1.dat</code> then if you set this 
option to '/htdocs/%infile%/', all report files for this data file would be 
created in the directory '/htdocs/virtualhost1/'. The second code type allows 
you to insert the date (and/or time) of the last request from your reports in 
the output filename. For example, if you set this option to 
'/htdocs/%yyyymmdd%/' and ran the report on January 1st, 2002, using log files 
that ended December 31, 2001, you would have all your reports stored in the directory 
'/htdocs/20011201/'. For more details on how to specify a date format see the 
<a href="datefmts.html">Date Format Reference</a>.</dd>

<DD>The special filename '-' can be used to tell Report Magic to write the report 
to the standard output (STDOUT) (i.e. your display or terminal window or a pipe, '|', 
on a command line to another program). Using this filename will force Report Magic 
to create a single-file, non-frames report with no Quick Summary.</DD>

<DT><CODE>Active_Column</CODE> (<I>Optional</I>)</DT>
<DD>This tells Report Magic for Analog which column to use for charts and 
determining the "Most Active" period in the Quick Summary. By default same 
measure is used for all reports. You can change this on a report-specific level
by defining this value in a report-specific section of you settings file. See
<a href="#reps">Reports specific sections</a>, below for more details.</DD>
<DD>For a list of valid codes see the <A HREF="columns.html#active">Active Column 
section</A> of the columns reference. This setting takes a single-characer code that
must correspond to one of the columns in your Analog data file. If there are no
matching columns, then Report Magic will not create a chart for that report. In 
other words, if you set 'Active_Column=P', to use Requests for Pages to determine 
activity, then make sure that your reports have that data by settings their 
<CODE>*COLS</CODE> in your Analog configuration file. If you want pie charts, make 
sure to include include 'p' (Percent of Page Requests) in those <CODE>*COLS</CODE> 
settings.</DD>
<DD>If this value is not set, Report Magic defaults to the first column in the first 
report (usually the Monthly Report).</DD>

<DT><CODE>Meta_Refresh</CODE> (<I>Optional</I>)</DT>
<DD>This option will include a META REFRESH tag in each report file telling 
the browser to expire the data after the number of seconds you set this to. 
For example, if you set <CODE>Meta_Refresh=86400</CODE> the browser will 
automatically reload the contents every 24 hours. If this is 0 or not 
included, no META tag will be written in the report file(s).</DD>

<DT><CODE>Image_Dir</CODE> (<I>Optional</I>)</DT>
<DD>This option can be used to tell Report Magic where to find the logo 
graphics files (for Analog, WADigital and DNS) for the bottom of the reports. 
Normally, Report Magic copies the logos to the report directory. If you are 
running lots of client sites you may want to put the logos in one central 
place and have all reports referr to that place. The value of this should be 
a URL reference, relative to the report output directory on your web site. 
You should include the final '/' in the directory reference. For example, 
if you have all your reports in the /stats/reports/ directory on your website 
and put the images in /stats/images/, then you would set this option to 
'../images'. Note: you can use a host name (absolute URL) as well as a 
relative URL for this option.</DD>

<dt><code>Stylesheet</code> (<i>Optional</i>)</dt>
<dd>This points to a file contianing a stylesheet for Report Magic to use 
for styles. If your output format is 'XHTML 1.0' then the reports will contain 
a link to this sheet.  In this case, this should be a URL and you need to make 
the stylesheet available to the web page when you publish the reports. If your 
output format is 'HTML 3.2' then this should be a local filename and the reports 
will be built with <code>&lt;FONT&gt;</code> and other tags based on the 
styles defined in the stylesheet. For details on the format for a stylesheet, 
see the entry on the <a href="advanced.html">advanced settings page</a>.</dd>

<DT><CODE>Reverse_Time</CODE> (<I>Optional</I>)</DT>
<DD>This option will reverse the direction of data in time report graphs. 
Use this if you've configured Analog to output time reports with data from 
newest to oldest (i.e. used the <CODE>*BACK</CODE> option). This makes sure 
the graphs come out looking right, because people expect a time-axis to run 
from oldest to newest (left to right).</DD>

<dt><code>Graph_Level</code> (<i>Optional</i>)</dt>
<dd>This option affects hierarchical report only. It tells the report to graph
a different level of the hierarchy than the primary one. This is useful, for example, 
in the Directory Report, when using it as a Virtual Host report. Without setting this 
(or setting it to the default value of '1'), only the first level item 'http://' will 
be graphed. What you really want is the second level. By setting this to '2', you would 
graph each virtual domain in your "directory" report.</dd>

<dt><code>Show_Bytes_As</code> (<em>Optional</em>)</dt>
<dd>This takes a value like "K", "M", "G", "T", etc. If given, then Report Magic will
reduce byte counts in reports to only this value. For example, if the value is "M", then
all reports will show all byte counts in megabytes (MB) with the fully reduced value
following in parentheses. (e.g. 2940941107 bytes would be reduced to "2804 MB (2.739GB)".
If no value is given for this, then byte counts are reduced completely as usual.</dd>

<DT><CODE>BG_Color</CODE> (<I>Optional</I>)</DT>
<DD>This is an optional background color<SUP>*</SUP> for the report 
page(s).</DD>

<DT><CODE>Background</CODE> (<I>Optional</I>)</DT>
<DD>This is an optional image for the background of the report page(s).</DD>

<DT><CODE>Font</CODE> (<I>Optional</I>)</DT>
<DD>This is the name of the desired typeface for the description and other 
text on the report page(s). This can be a comma-separated list of typeface 
options, such as "Arial, Helvetica, sans-serif".</DD>

<DT><CODE>Font_Color</CODE> (<I>Optional</I>)</DT>
<DD>This is the color<SUP>*</SUP> of the output text on the report page(s). 
This color is also used for the labels, titles and axis in the graphs. Only 
about 30 colors are recognized in the graphs. If the color you choose is not 
known, it will revert to black for the graph titles, labels and axis.</DD>

<DT><CODE>Title_Font</CODE> (<I>Optional</I>)</DT>
<DD>This is the name of the desired typeface for the report titles. This can 
be a comma-separated list of typeface options, such as "Arial, Helvetica, 
sans-serif".</DD>

<DT><CODE>Title_BG_Color</CODE> (<I>Optional</I>)</DT>
<DD>This is the background color<SUP>*</SUP> of the report title boxes. 
Report titles are bounded by a box so can have a background color or even 
be "reversed" (e.g. white on black).</DD>

<DT><CODE>Title_Font_Color</CODE> (<I>Optional</I>)</DT>
<DD>This is the color<SUP>*</SUP> of the report title text. See 
<CODE>Title_BG_Color</CODE> about creating "reversed" type titles.</DD>

<DT><CODE>Data_Font</CODE> (<I>Optional</I>)</DT>
<DD>This is the name of the desired typeface for the data columns on the 
report page(s). This can be a comma-separated list of typeface options, such 
as "Arial, Helvetica, sans-serif".</DD>

<dt><code>Data_Font_Color_1</code> (<i>Optional</i>)</dt> 
<dd>This is the color of the text for the data in one set of 
rows (defaults to <code>Font_Color</code>).</dd>

<DT><CODE>Data_BG_Color_1</CODE> (<I>Optional</I>)</DT>
<DD>This is the background color<SUP>*</SUP> of one set of data rows. Data 
sets can use two colors that alternate with rows for better legibility.</DD>

<dt><code>Data_Font_Color_2</code> (<i>Optional</i>)</dt> 
<dd>This is the color of the text for the data in the other 
set of rows (defaults to <code>Font_Color</code>).</dd>

<DT><CODE>Data_BG_Color_2</CODE> (<I>Optional</I>)</DT>
<DD>This is the background color<SUP>*</SUP> of the other set of data rows. 
See <CODE>Data_Color_1</CODE> above for the alternate color.</DD>

<dt><code>Data_Total_Font</code> (<i>Optional</i>)</dt> 
<dd>This is the name of the desired typeface for the summary 
data rows (defaults to <code>Data_Font</code>).</dd>

<dt><code>Data_Total_Font_Color</code> (<i>Optional</i>)</dt> 
<dd>This is the name of the color for the text in the 
summary data rows (defaults to <code>Data_Font_Color</code>).</dd>

<DT><CODE>Data_Total_BG_Color</CODE> (<I>Optional</I>)</DT>
<DD>This is the background color<SUP>*</SUP> of the totals rows on summary 
reports. These rows provide additional summary information, but are not 
graphed.</DD>

<dt><code>Data_Header_Font</code> (<i>Optional</i>)</dt> 
<dd>This is the name of the desired typeface for the table 
header rows (defaults to <code>Data_Font</code>).</dd>

<dt><code>Data_Header_Font_Color</code> (<i>Optional</i>)</dt> 
<dd>This is the name of the color for the text in the 
table header rows (defaults to <code>Data_Font_Color</code>).</dd>

<DT><CODE>Data_Header_BG_Color</CODE> (<I>Optional</I>)</DT>
<DD>This is the background color<SUP>*</SUP> of data table headers.</DD>

</DL>

<P><SUP>*</SUP><B>Note</B>: All colors can be a standard browser
color name or a 6-digit hex color code preceded by a number sign. (e.g. 
"black" or #000000).</P>



<a name="graphs"></a><h2><code>graphs</code> section</h2>
<p>The <code>graphs</code> section of your setting files contains settings 
to control the formatting of the graphs.</p>

<pre>
[graphs]
BG_Color = #FFFFCC
Font = C:\Winnt\Fonts\Arial.ttf, 14, 12, 10
Font_Color = #000000
Width = 400
Height = 300
3d = 1
Palette = lgreen, lblue, lred, lpurple,lyellow, green, blue, red, purple, yellow
Cycle_Colors = 1
Shadows = 1
Format = png
Path_To = /web/images/
URL_To = /images/
</PRE>

<dl>
<dt><code>BG_Color</code> (<i>Optional</i>)</dt>
<dd>This allows you to specify a color to be used for the
graphing area of the graph. If none is given this will use the 
report page background color. This is separate from the background 
color for the graph image which will always match the report page 
backgroun color.</dd>

<dt><code>Font</code> (<i>Optional</i>)</dt>
<dd>This can be set to the full path of a True Type font that will be used for 
all text in the graphs. To use this on the source package, you must have 
installed lttf (see the <A HREF="inst_src.html">Source Package Installation 
Notes</A> for details).</dd>
<dd>You can also customize the point size used for elements of the graphs. To 
do this you would follow the font name with a comma and a comma-separated 
list of 3 point sizes to use for graph title, axes titles and values labels. 
For example, you could specify <code>Font=C:\Windows\Fonts\arial.ttf, 
24, 14, 10</code>. Be careful not to use too large of a font size or you 
won't leave room for the graph and you'll get a 'Vertical size to small' error.</dd>
<dd><b>Mac Users</b> The Mac version of Report Magic does not yet support 
True Type fonts. Therefore this option is ignored on the Mac platform.</dd>

<dt><code>Font_Color</code> (<i>Optional</i>)</dt>
<dd>This is the color of the graph text. The grid lines and axes are colored 
between this and the <code>BG_Color</code>, defined above. This defaults to 
the report page text color.</dd>

<dt><code>Width</code> (<i>Optional</i>)</dt>
<dd>This gives the desired width (in pixels) of the graph. Default is 400.
You can change this on a report-specific basis by setting this under the 
report's section. See <a href="#reps">below</a>.</dd>

<dt><code>Height</code> (<i>Optional</i>)</dt>
<dd>This gives the desired height (in pixels) of the graph. Default is 300.
You can change this on a report-specific basis by setting this under the 
report's section. See <a href="#reps">below</a>.</dd>

<dt><code>3d</code> (<i>Optional</i>)</dt>
<dd>This if set to 1, will draw 3d graphs, 0 draws 2d graphs. Default is 1. You 
can also specify 2d or 3d on individual graphs using, for example, 'lines2d' or 
'lines3d' for the <code>GraphType</code> setting in the <a href="#reps">report 
specific sections</a>. You can change this on a report-specific basis by setting 
this under the report's section. See <a href="#reps">below</a></dd>

<dt><code>Palette</code> (<i>Optional</i>)</dt>
<dd>This gives a comma-separated list of color names to use for the bars 
in the bar charts. Valid colors include any 6 digit hex code, preceded by 
a number/hash symbol ("#") or one of (white, lgray, gray, dgray, black, lblue, 
blue, dblue, gold, lyellow, yellow, dyellow, lgreen, green, dgreen, lred, red, 
dred,lpurple, purple, dpurple, lorange, orange, pink, dpink, marine, cyan, lbrown, 
dbrown).</dd>

<dt><code>Cycle_Colors</code> (<i>Optional</i>)</dt>
<dd>If this is set to 1, each bar in a series on the bar charts
will use a different color from the <code>Palette</code> list. 
If set to 0, all bars will use the first color. Default is 1.</dd>

<dt><code>Shadows</code> (<i>Optional</i>)</dt>
<dd>If this is set to 1, Report Magic will draw drop-shadows on 
the bars in the bar charts. Set this to 0 to disable the shadows. 
Default is 1.</dd>

<dt><code>Format</code> (<i>Optional</i>)</dt>
<dd>This give the desired ouput format for graph images. Valid 
values are PNG and JPEG (and 'GIF' if you have a really old verion 
of libgd). Default is PNG because the files are much smaller. This will 
only work when you build Report Magic with support for the proper file 
types. For Windows users, both formats are supported. For Mac users, 
you will only get GIF format. On other platforms, this depends on the 
options you used when you built libgd. See <a href="inst_src.html"> the 
source package installation</a> for details.</dd>

<dt><code>Path_To</code></dt>
<dd>This specifies a path where the graph files should be stored on the 
server. By default, Report Magic stores graph files in the same folder
as the report files. When working in <a href="cgi.html">CGI mode</a>, 
however, it cannot send graphs unless they can be stored somewhere. 
This allows you to tell Report Magic to write the graphs in an explicit
location in your web site. See <code>URL_To</code>, below, for the 
companion setting.</dd>

<dt><code>URL_To</code></dt>
<dd>As a companion to <code>Path_To</code>, above, this tell Report 
Magic's reports where to find the images that have been stored on the 
web site. For example, if your web site is in <code>/web/</code> and 
you store your graphs in <code>/web/images/</code>, then you would 
want to set the <code>URL_To</code> value to <code>/images/</code> 
if you are writing the reports to the root of the web site or 
to CGI.</dd>

</dl>



<a name="reps"><h2>Reports specific section</h2></a>
<p>For each report, you can customize the default settings that you set 
in the <code>reports</code> section. To do this you create a section 
using the section name shown in the <a href="reports.html">reports 
reference</a> and set the approriate settings below that. For example, 
if you wanted to have a green background on the Monthly Report, you 
could add this to your settings file:</p>
<pre>
[MONTHLY]
BG_Color=green
</pre>

<p>You can also change report-specific configurations or text in these 
sections as well. This is covered in more detail in the 
<a href="advanced.html">advanced settings</a> page. However, as an example, 
if you wished to change the name of the General Summary to "Executive Summary," 
for one set of reports you could add this to your settings file:</p>
<pre>
[GENERAL]
LongName=Executive Summary
</pre>

<a name="graphtype"><h4>Customizing the GraphType</h4></a>
<p>The type of graph each report crates is already defined by Report Magic. 
Usually these types make sense for the majority of data in a report and do not need
to be changed. However, by setting this option for a particular report, you can 
change the graph types you want displayed.</p>
<p><code>GraphType</code> takes a comma-separated list of types of
graphs that you want Report Magic to produce for the report. Basic 
values are <code>pie</code>, <code>bars</code> and <code>lines</code>. 
These will be formatted in 2d or 3d versions, based on the 
<code>[graphs]3d</code> setting described above.</p>
<p>It is also possible to force a specific report to use 2d or 3d graphs, 
ignoring the 'global' setting by specifying that in the <code>GraphType</code> 
setting for that reports. For example, to make all the line graphs on the 
time reports 2d, you would add something like this to your settings file:</p>
<pre>
[MONTHLY]
GraphType=lines2d
[WEEKLY]
GraphType=lines2d
[FULLDAILY]
GraphType=lines2d
[FULLHOURLY]
GraphType=lines2d
[QUARTER]
GraphType=lines2d
[FIVE]
GraphType=lines2d
</pre>


<a name="rows"><h4>Settings Rows in the Summaries</h4></a>

<p>Finally, there are two report-specific options for the General Summary 
and Quick Summary. The <code>Rows</code> setting determines which rows 
will be displayed for each report.</p>

<pre>
[GENERAL]
Rows=SR, PR, FL, RR, NF, NH, BT
</pre>
<dl>
<dt><code>Rows</code> (<i>Optional</i>)</dt>
<dd>This specifies which rows Report Magic for Analog should include in the 
General Summary. These correspond to the values used by Analog in the 
computer readable output file. Values should be separated by commas (','). 
For a list see the <A HREF="columns.html#general">General Summary 
section</A> of the columns reference. If you don't include this setting or 
you use the keyword 'ALL', the General Summary will show all rows in your 
Analog file.</dd>
</dl>

<pre>
[QUICK]
Rows= m, W, D, H, B
</pre>
<dl>
<dt><code>Rows</code> (<i>Optional</i>)</dt>
<dd>This tells Report Magic for Analog which columns to show for the 
Quick Summary. The letters are those used by Analog to represent report 
in the computer readable output files. Values should be 
separated by commas (','). For a list of valid options see the 
code letters in the <a href="reports.html">reports reference</a>. If you 
don't include this setting or your use the keyword 'NONE', 
no Quick Summary will be made. If you use the keyword 'ALL', all possible 
summary rows will be show. The rows in the Quick Summary will be in the 
same order as the letters are in this option.</dd>
</dl>

 
        

        <div style="text-align: center; border-top: 2px solid black; border-bottom: 2px solid black; margin-top: 4px; margin-bottom: 6px; padding-top: 4px; padding-bottom:6px;">
            [<a href="index.html">Introduction</a>]&nbsp;[<a href="map.html">Documentation&nbsp;map</a>]&nbsp;[<a href="siteindex.html">Index</a>]&nbsp;[<a href="faq.html">Frequently Asked Questions</a>]&nbsp;[<a href="license.html">License</a>]
        </div>
        
        <span class="fineprint">Send questions or comments to <a href="mailto:dgsupport@wadsack-allen.com">Wadsack-Allen Digital Group Support</a>.<br />
         <a href="http://reportmagic.org/">Report Magic</a> 2.21 Documentation. Copyright &copy; 1999-2003 <a href="http://wadsack-allen.com/">Wadsack-Allen</a>. All Rights Reserved.</span>
    </body>
</html>
rmagic 2.21-5 / usr / share / doc / rmagic / html / repconf.html
