Report Magic for Analog Documentation - Building your Settings File
Author: This page created by Wadsack-Allen Digital Goup

# Building your Settings File

## Report Magic for Analog Settings

Report Magic for Analog's settings are separated into at least five sections, `statistics`, `navigation` and `website` and the `graphs`, `reports` and related sections. The `statistics` section covers general settings for creating the reports. The `navigation` section tells Report Magic for Analog how to format and display the navigation page or naviagtion menu (if on the same page). The `website` section has some options for linking website data and feedback. The `graphs` section allows you to define many formatting options for graphs and the `reports` section provide formatting settings for how the report pages should look. You can also create a section for each specific report to customize settings for that report alone.

Below are sample settings for the first three section and a description of what each setting means. The `graphs`, `reports` and related sections are covered on a separate page.

### `statistics` Section

    [statistics]
    File_In = report.dat
    Frame_File_Out = index.html
    Frame_Border = 0
    No_Robots = 1
    Log_File = rmagic.log
    Always_Quit = 1
    Language = en
    Verbose = NWE
    Include = standard.ini
    Format = XHTML 1.0

`File_In`
  This is the location of the computer readable output from Analog. It can include a path name (including a drive letter or network path). This is relative to the directory from which Report Magic for Analog was run.
  The special filename '-' can be used to tell Report Magic to read the input from the standard input (STDIN) (i.e. your keyboard or a pipe, '|', on a command line). This option supports the %infile% and %dateformat% codes descibed under `File_Out` in the `[reports]` section, below.
`Frame_File_Out` (Optional)
  This is the name of the frameset page. It no longer uses a path name or drive letter. (You can put a path in here, but it will be ignored. The path specified in `report_File_Out`, below, is used for all files.) This option supports the %infile% and %dateformat% codes descibed under `File_Out` in the `[reports]` section, below. If no value is given, and Report Magic is producing a frameset, then this will defaut to 'index.html'.
`Frame_Border` (Optional)
  This sets the width of the separator between the navigation and report frames. If you set this to '0' then no separator will be drawn (and the frames will not be resizable).
`No_Robots` (Optional)
  This option, if set to 1, will add a META tag to each output file to tell robots not to index the files.
`Log_File` (Optional)
  This option gives the name of a file to which Report Magic will send all messages (errors or notices). This is useful for automated jobs, especially on a Mac platform where you don't have redirection. By default, if no logfile is given (if this option is not used), all notification and error messages are written to STDERR (your console screen). Errors are appended to (added to the end of) the logfile. The name of the logfile can include the %infile% and %dateformat% codes descibed under `File_Out` in the `[reports]` section, below.
`Always_Quit` (Optional, Mac only)
  For the Mac platform only, this option tells Report Magic to quit the program whenever any error occurs. (Normally it leaves the "console" window up so you can see any messages.) This is especially useful when running Report Magic as a scheduled task with the 'cron' utility (or other task scheduler). If you are using the logging option (above) it will also quit the program on errors and on completion, so this is redundant when logging is enabled. This option has no effect on non-Mac platforms.
`Language` (Optional)
  This will set the language to be used for the current report. Valid languages are listed in the `lang` directory under the directory where you installed Report Magic. There is a directory for each set of language files. So, for example, to set the report to German you would use 'de'. Rembemer that if you are setting the language in Report Magic for a set of reports to also set the langauge in the Analog config file or your Daily Summary will show every day as Sunday.
  Note If you are running Analog 3.x and want the output in German, rename the file lang/de/lang_3.ini to lang/de/lang.ini.
`Verbose` (Optional)
  This allows you to control what kind of messages Report Magic tells when running. The valid values are N for Notices, W for Warnings and E for errors. The default is to output all. To tell Report Magic to be absolutely quiet use the keyword NONE.
`Include` (Optional)
  You can include the contents of another setting file in a given file. This setting takes the name of a settings file whose values will be included. The settings in the current file will override anything in the included file. This is an easy way for an ISP to include a standard file and customize just the necessary settings for each client. This option supports the %infile% and %dateformat% codes descibed under `File_Out` in the `[reports]` section, below.
`Format` (Optional)
  This specifies the output file format for the reports. Currently undertood formats are 'XHTML 1.0' (which converts reports formating choices into CSS style sheets) and 'HTML 3.2' (which uses lots of tags). Default is 'XHTML 1.0'.

### `navigation` Section

    [navigation]
    File_Out = navfile.html
    BG_Color = #FFFFFF
    Background = images/flag_bg.gif
    Font_Color = #000000
    Font = Verdana, Arial
    Bullet_Image = images/bar1.gif
    Stylesheet = styles.css
    Top_Logo = logo.html

`File_Out` (Optional)
  This is the name of the file for the navigation page. This option supports the %infile% and %dateformat% codes descibed under `File_Out` in the `[reports]` section, above.
  If this setting is not specified, then Report Magic will create the reports without the frameset. Instead of a navigation frame, each report will have a navigation menu to the right.
`BG_Color` (Optional)
  This is an optional setting that specifies the background color* of the navigation page.
`Background` (Optional)
  This is an optional image for the navigation page background
`Font_Color` (Optional)
  This is the color* of the output text on the navigation page. All text (normal and hyperlinked) will be this color.
`Font` (Optional)
  This is the name of the desired typeface for the text on the navigation page. This can be a comma-separated list of typeface options, such as "Arial, Helvetica, sans-serif".
`Bullet_Image` (Optional)
  This is a virtual link to the image used for a bullet for navigation items. Report Magic for Analog neither checks for the existence of this image nor copies it from anywhere, so make sure this image exists as specified. This name is a virtual (i.e. on the website) reference relative to the navigation page.
`Stylesheet` (Optional)
  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 `<FONT>` and other tags based on the styles defined in the stylesheet. For details on the format for a stylesheet, see the entry on the advanced settings page.
`Top_Logo` (optional)
  Use this to give the name of a file (relative to the working directory) that contains a snippet of HTML to insert at the top of the page. If this is provided it replaces the "Report Navigation" text.

*Note: 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).

### `CGI` Section

    [CGI]
    Analog = /usr/bin/analog
    Analog_Forbidden = LOGFORMAT APACHELOGFORMAT DEFAULTLOGFORMAT APACHEDEFAULTLOGFORMAT HEADERFILE FOOTERFILE UNCOMPRESS OUTFILE CACHEOUTFILE LOCALCHARTDIR ERRFILE DNS CGI SETTINGS PROGRESSFREQ LANGFILE DESCFILE
    Analog_Allowed =
    Forbidden = statistics_File_In statistics_Include statistics_Log_File statistics_Frame_File_Out graphs_Path_To graphs_URL_To reports_File_Out navigation_File_Out navigation_Top_Logo website_Company_Logo
    Allowed =

`Analog`
`Analog_Forbidden`
`Analog_Allowed`
`Forbidden`
`Allowed`

### `website` Section

    [website]
    Title = My Web Site Report
    Webmaster = webmaster@flaglink.com
    Base_URL = http://www.flaglink.com
    Company_Logo = logofile.htm

`Title`
  This is the text title of the entire statistics report and frameset. It appears at the top of each report file and as the title for the frameset (i.e. in the browser titlebar). This would be something like "Web Statistics for My Website". This option supports the insertion codes (like ${infile} and %mmm d, yyyy%) as descibed under `[reports]File_Out` in the report settings page and in the advanced settings.
`BaseURL` (Optional)
  This is the base URL of the site for which these statistics were made. If you don't include this setting then links pertaining to the website for which the statistics were compiled will be relative to root of the site that the reports are hosted on. (In other words, if your hosting the stats on a different website than they came from, include this setting.)
`Webmaster` (Optional)
  This is email address to contact for questions on the reports. If you don't include this setting, the "Contact us" feedback message will not be included.
`Company_Logo` (Optional)
  With this option you can specify the name of a file that Report Magic will load to insert at the bottom of each report. This file should contain a snippet of HTML (that is, something like "<FONT SIZE=1>Hosted by mycompany.com</FONT>") that can include your hosting company name, your logo (through an IMG tag) or anything else you want in the footer of each report. Using this option will also cause the logo images for Analog, Wadsack-Allen Digital Group and DNS Websites to be removed. This can save bandwidth and storage, especially when hosting a large number of client sites.

[Introduction] [Documentation map] [Index] [Frequently Asked Questions] [License]
Send questions or comments to Wadsack-Allen Digital Group Support.
Report Magic 2.21 Documentation. Copyright © 1999-2003 Wadsack-Allen. All Rights Reserved.