Report Magic for Analog Documentation

レポートの設定

reports セクション

reportsセクションではレポートの見た目のカスタマイズに関する設定を行います。ここの設定は全てのレポートページに”デフォルト”として反映されます。 特定のレポートで下記に記述されているように、該当するセクションにて設定することが可能です。

reports セクション

[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
File_Out
レポートを出力するファイル 又はディレクトリを指定します。 もしここでファイル名が設定された場合(例 /stats/report.html)、(Analogのように)全てのレポートが指定されたファイルに書き込まれます。もし、ここでディレクトリ名を設定した場合(例 /stats/)、Report Magic は独自の名前付けで各ファイルを指定されたディレクトリ内に作成します。 ここで指定されたディレクトリ(ディレクトリそのもの、またはファイル名の一部として)は、全てのReport Magicが生成する全てのファイルに使用されます。(生成した場合はフレームや目次ページも含みます)
(statistics_Frame_File_Outnavigation_File_Outと同じように)このオプションではファイル名を決めるのに、2種類のコードを設定することができます。 一つ目のコードは%infile%で、ファイル名のどこにでも挿入が可能で、[statistics]セクションの下、File_Inで設定されているものが固定で使用されます。 例えば、このFile_Inの設定がFile_In=/usr/bin/analog/virtualhost1.dat となっており、ここの設定を'/htdocs/%infile%/'とした場合、レポートは'/htdocs/virtualhost1/'に生成されます。
2つ目のコードはレポート出力名(ディレクトリ名)に時間(または時間と日付、または時間のみ)を使用することができるものです。 例えば、もしここの設定を'/htdocs/%yyyymmdd%/' とし、2002年1月1日に2001年12月31日までのログを使用してReport Magicを実行した場合、レポートはすべてhtdocs/20011201/'ディレクトリ内に出力されます。 このコードに関する詳細設定については日付形式 レファレンスをご参照ください。
もし特殊ファイル名'-'を使用した場合、レポートは標準出力(STDOUT)されます。(重要:ディスプレイ、またはターミナルウィンドウでpipeまたは'|'を使用してコマンドラインから実行します) このファイル名を使用する場合、Report Magicは強制的に、クイックサマリーのない非フレーム、全てのレポートがひとつにまとまったレポートを作成します。
Active_Column (オプション)
Analog用Report Magicniにてどの項目を図に使用するかを定義し、クイックサマリーでの"Most Active"な時期を決定します。 デフォルトでは全てのレポートに同じ値が使用されます。 この値は設定次第で特定のレポートごとに異なる設定にすることができます。 詳細については下記のレポート別の設定をご参照ください。
選択できる設定値のリストに関してはコラムレファレンスのA HREF="columns.html#active">Active Column セクションをご参照ください。 Analogが出力したコンピュータ用出力結果ファイル内の各行にある、一致するアルファベット1文字のコードで設定します。もし一致するものがない場合、レポートの図は作成されません。 つまり、もし 'Active_Column=P'(ページ毎のレポート変動をみるようにする)とここで設定をした場合、Analogの設定ファイルの*COLSにてページ毎のレポートデーTが出力されるように設定してある必要があります。 もしパイ図表 (円を半径で仕切った図表)を使用したい場合、*COLS設定にて'p'(ページリクエストのパーセンテージ)が含まれていることをご確認ください。
もし、その値が設定されていない場合、一番始めのレポートにある最初のコラムがデフォルトです。 (デフォルトは月別レポート(Monthly Report)です)
Meta_Refresh (オプション)
このオプションでは設定した数字の秒数毎にレポートを再読み込みさせるMETA REFRESHを書くレポートファイルに追加するものです。 例えば、Meta_Refresh=86400と設定した場合、ブラウザは自動的に24時間ごとにコンテンツを再読み込みするようになります。 もしここの設定が0またはなにもない場合はこのMETAタグはレポートファイルに記述されません。
Image_Dir (オプション)
レポートのフッター部分で使用するロゴファイル(Analog用、WADigital そしてDNS)の画像が格納されているパスを指定します。 通常、Report Magicはレポートディレクトリにロゴファイルのコピーをします。もしたくさんのクライアントサイトでReport Magicを使用している場合、ロゴファイルを各レポートディレクトリ配下ではなく一箇所にまとめて管理をし、各レポートはそこ参照するようにできた方が便利でしょう。 ここで設定する値はウェブサイトのディレクトリからのURLレファレンスを相対パスになります。 値の最後に '/'を付けるのを忘れないようにしてください。 例えばウェブサーバの/stats/reports/ディレクトリにウェブサイトがあり、画像ファイルを /stats/images/に格納する場合、ここでの設定は'../images'となります。 注意:相対URLの変わりにホスト名(完全なURL)を指定することも可能です。
Stylesheet (オプション)
Report Magicにてスタイルシートを使用するのは、決まったスタイルでレポートを表示させるためです。 もし出力形式が'XHTML 1.0'の場合、レポートはこのスタイルシートへのリンクを含みます。 その場合、ここでの設定はURLとなり、レポートを公開する際、ここで設定したスタイルシートが入手できるようにしておく必要があります。
もし出力形式が'HTML 3.2' の場合、ここでの設定はローカルのファイル名で、レポートはスタイルシートで設定されているスタイルに基づいて<FONT> やほかのタグ を使用して構成されます。 スタイルシートのフォーマット設定の詳細については 更なるページの詳細設定をご参照ください。
Reverse_Time (オプション)
ここでは時間別のレポートグラフの順番を逆にする設定ができます。 このオプションを設定することにより、時間別のレポートを最新情報から表示させることができます。 (すなわち、*BACKオプションを使用します) これにより、時間軸を古いものから新しいもの(左から右へ)を想定するので、グラフが見やすくなります。
Graph_Level (オプション)
このオプションは階層型のレポートだけに影響します。 階層のグラフを第一階層ではなく別のレベルで作成するように設定することができます。 バーチャルホストレポートでディレクトリレポートを表示させたい場合などにとても便利です。 この設定をしない場合(または設定がデフォルトの'1'の場合)、実際は第二階層の状況を知りたいにもかかわらず、第一階層の'http://'のみがグラフ化されます。 ここで値を'2'に設定すれば、各バーチャルドメインの"ディレクトリ"レポートのグラフを作成できます。
Show_Bytes_As (オプション)
ここで使用する設定値は"K"、 "M"、"G"、 "T"のようなものです。 もしここで値が設定されると、Report Magicは設定された値のレベルにバイト表示を変換します。 例えば、ここで"M"を設定した場合、全てのレポートでメガバイト(MB)での概算表示となります。 (例 2940941107 bytesの場合は"2804 MB (2.739GB)"という表示になります。) もし設定がされていない場合、デフォルトは通常のように概算されずに全てが表示されます。
BG_Color (オプション)
レポートページの背景色*のオプション設定です。
Background (オプション)
レポートの背景イメージのオプション設定です。
Font (オプション)
レポートの表示文字のフォントタイプの設定です。 コンマで区切って、複数のフォントタイプを"Arial, Helvetica, sans-serif"のように設定することができます。 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".
Font_Color (オプション)
レポートのフォントの色* を設定できます。 ここで設定した色はグラフのラベル、タイトルそして座標軸でも使用されます。 グラフ部分では30色ほどだけ認識されます。 もし選択したフォントの色がグラフにて認識されない場合は、グラフのラベル、タイトルそして座標軸では黒が使用されます。
Title_Font (オプション)
レポートのタイトルのフォントタイプの設定です。 コンマで区切って、複数のフォントタイプを"Arial, Helvetica, sans-serif"のように設定することが可能です。
Title_BG_Color (オプション)
レポートタイトルボックスの背景色*の設定です。 レポートタイトルは四角で囲まれているため、背景色を設定できます。また、"reversed" と設定することにより、色の反転を行うことも可能です。(黒の上に白で表示)
Title_Font_Color (オプション)
レポートタイトルの文字の色*の設定です。 タイトルで色反転を行う"reversed"設定に関してはTitle_BG_Colorをご参照ください。
Data_Font (オプション)
レポートのデータ項目のフォントタイプの設定です。 コンマで区切って、複数のフォントタイプを"Arial, Helvetica, sans-serif"のように設定することが可能です。
Data_Font_Color_1 (オプション)
データを列ごとに1セットにして文字の色設定ができます。 (デフォルトはFont_Colorでの設定です。)
Data_BG_Color_1 (オプション)
1セットのデータ列ごとの背景色* の設定です。 ここで設定することにより、データ列の背景色が2色交互となり、見やすくなります。
Data_Font_Color_2 (オプション)
上記Data_Font_Color_1で設定した列の文字色と交互に表示される列の文字の色設定です。 (デフォルトはFont_Colorでの設定です)
Data_BG_Color_2 (オプション)
Data_Color_1で設定した列の背景色と交互で表示される列の背景色*の設定です。
Data_Total_Font (オプション)
サマリーデータの列のフォントタイプの設定です。 (デフォルトはData_Fontの設定です)
Data_Total_Font_Color (オプション)
サマリーデータの列のフォントの色の設定です。 (デフォルトは Data_Font_Colorの設定です。)
Data_Total_BG_Color (オプション)
サマリーレポートの全ての合計列の背景色*の設定です。 ここで提供するのはサマリー部分のみに表示される合計で、グラフ化されていないものです。
Data_Header_Font (オプション)
テーブルのヘッダ列のフォントタイプの設定です。 (デフォルトは Data_Fontの設定です。)
Data_Header_Font_Color (オプション)
テーブルヘッダ列のフォントの色の設定です。 (デフォルトは Data_Font_Colorの設定です。)
Data_Header_BG_Color (オプション)
データテーブルのヘッダーの背景色*の設定です。

*注意:全ての色設定は通常のブラウザで使用される16bitの演算子である16進数(Hex.decimal)の記述指定かまたは色の名前で設定します。 (例:黒の場合"black"または#000000で指定します)

graphs セクション

graphsセクションではグラフのフォーマット設定を行います。

[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/
BG_Color (オプション)
グラフエリアの色設定を行います。 もし設定が行われていない場合は、レポートページの背景色が使用されます。 これはレポートページの背景色とマッチしているグラフ背景の色とは異なります。
Font (オプション)
グラフで使用される文字列のフォントタイプのフルパスを指定します。 これをソースパッケージで使用するには、lttfがインストールされている必要があります。(詳細に関してはSourceパッケージのインストールをご参照ください)
グラフで使用している点の大きさをカスタマイズすることができます。 カスタマイズを行うにはフォント名をコンマ、コンマで分けたグラフタイトル、座標軸のタイトル、値のラベルの3点のサイズリストで設定します。 例:Font=C:\Windows\Fonts\arial.ttf, 24, 14, 10 フォントサイズを大きく指定しすぎないように注意してください。 フォント指定が大きすぎる場合は、グラフスペースがなくなったり、'Vertical size to small'とのエラーメッセージが表示されます。
Macユーザへ:MacバージョンのReport MagicではTrue Typeフォントをサポートしていません。そのため、ここでのオプションはMacプラットフォームでは無視されます。
Font_Color (オプション)
グラフの文字の色を設定します。 グリッドラインと座標軸の色はここで設定した値とBG_Colorで設定した値の中間になります。デフォルトはレポートページの文字の色です。
Width (オプション)
ここではグラフの幅(単位はピクセル)を設定します。 デフォルト値は400です。 レポートセクションで設定することにより、レポートごとに違う値を設定することが可能です。 詳細は下記をご参照ください。
Height (オプション)
ここではグラフの高さ(単位はピクセル)を設定します。 デフォルト値は300です。 レポートセクションで設定することにより、レポートごとに違う値を設定することが可能です。 詳細は下記をご参照ください。
3d (オプション)
ここで1を設定することにより、3Dのグラフを設定できます。また、0を設定すると2Dのグラフとなります。 デフォルト値は1です。 各グラフに対して2Dにするか3Dにすつかの設定を行うことができます。 それを行うにはレポートごとセクションの中のGraphTypeにて'lines2d'や'lines3d' のように設定します。 この設定はレポートセクションで設定することにより、レポートごとに違う値を設定することが可能です。 詳細は下記をご参照ください。
Palette (オプション)
ここでは棒グラフのバー部分で使用する色の名前をコンマ区切りのリストで設定します。 指定できる色は6桁の16進数コードの数字とハッシュシンボル("#")か、色名(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)です。
Cycle_Colors (オプション)
もしここで1が設定された場合、棒グラフ系のグラフの色がPaletteで設定されている色リストに基づいて各棒グラフでバーが異なる色になります。 もし0が設定されている場合は、全ての棒グラフのバーは上記Paletteで設定されている最初の色で統一されます。 デフォルト値は1です。
Shadows (オプション)
もしここで1が設定されている場合、棒グラフでバーに影をつけます。 ここの設定が0の場合、影は作成されません。 デフォルト値は1です。
Format (オプション)
ここではグラフイメージを希望する出力フォーマットを設定します。 使用できる値はPNGとJPEGです。(もし古いバージョンのlibgdを使用していれば'GIF'が使用できます) デフォルト値はファイルサイズが一番小さいPNGとなっています。 ここの設定はReport Magic構築の際に正しいファイルタイプをサポートするように設定している場合のみ動作します。 Windows系の環境では両方のフォーマットがサポートされています。 Mac系の環境ではGIFフォーマットのサポートのみです。 他のプラットフォームではlibgdを構築した際のオプション設定次第です。 詳細に関してはSource パッケージの場合をご参照ください。
Path_To
ここではグラフファイルのサーバでの保存先フォルダを指定します。 デフォルトではレポートファイルと同じフォルダに保存されます。 もし、CGIモードで実行する場合、グラフファイル保存場所が設定されていないとグラフ表示はできません。 ここで設定することにより、Report Magicにグラフ保存先を明示することができます。 下記のURL_Toで、関連する設定をご確認ください。
URL_To
上記のPath_Toと関連して設定します。解析結果レポートに画像表示場所がどこにあるかを指示します。 例えば、ウェブサイトが/web/にあり、グラフ画像を/web/images/に保存していて、レポートをウェブサーバのルートかCGIにレポートを出力する場合、URL_Toの値は/images/ になります。

Reports特有セクション

各レポートに対して、reportsセクションで設定したものをカスタマイズすることができます。それをするには、レポート レファレンスを使用してセクションを作成し、適切な設定をする必要があります。 例えば、月ごとのレポートで背景を緑に設定したい場合は次のように設定ファイルに追加します。

[MONTHLY]
BG_Color=green

それだけではなく、またレポート独自の設定や文字をこのセクションで設定することができます。詳細は詳細設定ページがあります。 例えば、全体のレポートを"Executive Summary"に変更したい場合はひとつのレポートセットにて、次のような記述を追加することで変更可能です。

[GENERAL]
LongName=Executive Summary

グラフタイプのカスタマイズ

各レポートのグラフタイプはReport Magicで定義されています。 大抵の場合は意味がわかりやすいものになっているため、変更する必要はないかと思います。 しかし、それを変更したい場合には、ここで設定を行うことにより好みのグラフタイプにすることができます。

GraphTypeはグラフのタイプをコンマ区切りのリストで設定します。 基本値はpie, bars and linesです。 上記の[graphs]3dでの設定により、2Dにしたり3Dにしたりすることができます。

また、独特の設定をGraphType対象レポートに対して行うことにより、その特定のレポートに対して'全体'用の設定を無視させ、2Dや3Dのグラフにすることができます。 例えば、全ての時間別レポートの線グラフを2Dに設定したい場合、設定ファイルに以下の記述を追加します。

[MONTHLY]
GraphType=lines2d
[WEEKLY]
GraphType=lines2d
[FULLDAILY]
GraphType=lines2d
[FULLHOURLY]
GraphType=lines2d
[QUARTER]
GraphType=lines2d
[FIVE]
GraphType=lines2d

サマリー内の行の設定

最後に、全体のサマリーとクイックサマリー用のレポート独自の2つの設定があります。 Rowsでは各レポートにてどの行を表示するかを設定します。

[GENERAL]
Rows=SR, PR, FL, RR, NF, NH, BT
Rows (オプション)
ここでは全体のサマリーにてどの行をReport Magicに読み込ませるかを設定します。 ここでの設定値はAnalogが出力したコンピュータ用出力形式のファイルの設定にと同じです。 値はコンマ(',')区切りで設定してください。 行レファレンス値についてはGeneral Summary セクションをご参照ください。 もしこの設定をしない場合、または'ALL'と設定した場合、Analogで出力されたファイルにある全ての行が全体のサマリーに表示されます。
[QUICK]
Rows= m, W, D, H, B
Rows (オプション)
ここではどの行をクイックサマリーで表示させるかを設定します。 設定する文字はAnalogが出力したコンピュータ用出力形式のファイルで使用されているものを使用します。 設定値はコンマ (',')区切りで設定してください。 値のオプションの文字コードに関してはレポート レファレンスをご参照ください。 もしここで設定を行わない場合、又は'NONE'と設定した場合はクイックサマリーは作成されません。もし'ALL'と設定した場合は表示可能な全てのサマリー行が表示されます。 クイックサマリーで表示される行は、ここで設定されたオプションの文字コード順に表示されます。
[はじめに] [ドキュメント の目次] [Index] [よくある質問] [ライセンス]
質問やコメントは Group Support宛に送付してください。
Report Magic 2.21 Documentation. Copyright © 1999-2003 Wadsack-Allen. All Rights Reserved.