Report Magic for Analog Documentation

クイックスタート

はじめに

まず一番始めにReport Magicを使用するために行うことは”インストール”することです。もうすでにReport Magicをダウンロード済みかと思いますが、もしまだダウンロードしていない場合はオンラインのダウンロード ページ からダウンロードしてください。
次にReport Magicをインストールしたいディレクトリにアーカイブファイルを展開します。
各インストールの手順については下記から該当するリンクをご参照ください。

インストール後の動作確認

インストール後にまずすることは動作の確認です。 Report Magicにはセットアップを確認することができるサンプルデータが同梱されています。 ここではご利用のプラットフォーム別のテストに仕方を紹介します。

Source パッケージ
rmagicディレクトリの中の./rmagic.plを実行してください。
Report Magicはレポートファイルをreports/ディレクトリの中に作成します。
作成されたそのレポートをウェブブラウザ(またはlynx)で確認します。
Windows用パッケージ (Quick and Dirty)
エクスプローラで'Program Files'に移動します。
その後、'WADigital'の中の'ReportMagic'に移動し、そこにあるReport Magicのアイコンをダブルクリックしてください。
Report Magicは'reports'という名前のフォルダを作成し、その中に全てのレポートを作成します。
作成された'reports'フォルダの中にある'index.html'をダブルクリックし、ブラウザで結果を確認します。
Windows用パッケージ (コマンドプロンプト使用)
’スタート’→’プログラム’→’コマンドプロンプト’(ご利用のOSによって場所が異なります。MEや2000では’スタート’→’プログラム’→’アクセサリー’→’システムツール’の中)でコマンドプロンプトを実行します。
cd "\Program Files\WADigital\ReportMagic"と入力してください。
その後、rmagicと入力し、Enterキーを押してください。
レポート作成の状況が表示されます。終了後、reportsフォルダにあるレポートを上記のQuick and Dirtyと同じように開いて確認します。
Macintosh用パッケージ
Report MagicフォルダからReport Magicのアイコンをダブルクリックします。
Report Magicはreportsというフォルダを作成し、その中にレポートを作成します。
reportsフォルダに移動し、'index.html'というファイルをダブルクリックし、結果をブラウザで確認します。

設定

さて次に、自分で持っているログの解析手順を説明したいと思います。
まず、Analogがインストールされており、設定がされている必要があります。まだこれが済んでいない場合はAnalog Web Siteにゆき、手順に従ってインストール・設定を行ってください。
Analolgを設定する際にはOUTPUT HTMLの設定(デフォルト)を参照すると、レポートが全て必要なデータを含んでいるのかを確かめることができます。

AnalogでReport Magicを使用するには

Report MagicをAnalogで使用するには、Analogがコンピュータ用の出力形式でレポートを作成するよう既存のAnalogの設定ファイルを編集するか、新しい設定ファイルを作成する必要があります。 (もしReport Magic用に新しい設定ファイルを作成する場合はまず、Analogで通常通りのHTML形式で出力できることを確認することをお勧めします。そうすれば、analogが動作することは確認済みなので、その後トラブルが発生した際の切り分けが簡単になります)
AnalogがReport Magicと連携して動作するようにするには、Analogの設定ファイルを2行変更(または追加)するのみです。:

変更の1行目はAnalogのレポート出力形式の部分です。OUTPUTという単語で始まる行を探し、下記のように変更してください。もし、そのような行が存在しない場合(デフォルトの設定ファイルのように)はAnalog設定ファイルのどこでもよいので、追加をしてください。(追加する場所はどこでも構いませんが、OUTFILEで始まっている行の下に追加するとわかりやすいかと思います)

OUTPUT COMPUTER

変更の2行目はAnalogがファイルを出力する場所です。既存のanalogの統計結果を上書きしないためも、またHTMLファイルを作成するわけではないので OUTFILEという単語で始まる行を下記のように変更してください:

OUTFILE report.dat

(当然、Report MagicをAnalogとは別のディレクトリで実行される場合は、Report Magicディレクトリ内にこの出力ファイルを作成させたいかと思います。その場合は必要に応じてパス情報を設定してください。)

上記の設定が完了したら、Analogを新しい設定ファイルで実行させてみてください。 もし何か設定ファイルに問題があれば、Analogが教えてれます。
設定に問題がなければ、AnalogはReport Magicが使用するreport.datという名前のコンピュータ用の出力形式ファイルを作成します。

MACユーザへ:report.dat ファイルが作成されたあとにReport Magicのディレクトリにコピー/移動したほうが簡単です。この方法にするとReport Magicの設定ファイルを作成する際にパスの設定に煩わされることがありません。

Report Magicの設定

次にReport Magicの出力とフォーマットオプションの設定を行います。
一番簡単な手順は、配布されているrmagic.sampleファイルをコピーし、rmagic.ini (Mac版の場合はReport Magic.ini)という名前にファイル名を変更して、そのファイルを編集する方法です。

新しいrmagic.iniファイルにて下記の設定変更を行います。:

[statistics]
File_In
Analogが作成したファイルを指定します。もし作成したreport.datをReport Magicディレクトリにコピーした場合、単にreport.datと設定するだけです。
[reports]
File_Out
レポートファイルを作成したい場所のパスを記述します。
[website]
Title
レポートにつけるタイトルを記述します。

Report Magicの実行

設定ファイルが完成したら、Analog用Report Magicを実行し、レポートファイルを作成することができます。

Windows版の場合、Report Magicを実行するためには下記のコマンドをReport Magicディレクトリ内で実行するかReport Magicのアイコンをダブルクリックするだけです。:

rmagic

もしsource版の場合、下記のようにコマンドラインからReport Magicを実行することができます(Perlが/usr/bin/perlのパスでインストールされている場合):

./rmagic.pl

もしMac Binary版を使用している場合、Report Magicのアイコンをダブルクリックするだけです。

Report Magicの実行が問題なく完了したら、reportsサブディレクトリ内に新しいレポートファイルのセットが作成されます。
サブディレクトリ内のindex.htmlをブラウザで開き、レポート参照を行ってください。

追加事項

Report Magicにはたくさんのオプションと設定があります。 上記の手順が問題なくできた方は、設定ファイルを変更してもっと自分仕様のレポート作成を行いたくなるはずです。
更に詳細な設定を行いたい場合は、設定ファイルの構築をご参照ください。
Report Magicで実現できる詳細な設定について記述されています。

もしReport Magicで使用しているrmagic.iniとは異なる設定ファイルを使用したい場合やコマンドラインからオプションを設定したい場合(例えばスクリプトやスケジュール)にはAnalog用のReport Magicの実行のページをご参照ください。

例を見たほうがわかりやすい場合は、samplesフォルダにあるサンプル設定ファイルやスタイルシートを参考にしてください。
何か疑問がある場合は
よくある質問にて回答をさがしてみてください。

[はじめに] [ドキュメント の目次] [Index] [よくある質問] [ライセンス]
質問やコメントは Wadsack-Allen Digital Group Support宛に送付してください。
Report Magic 2.21 Documentation. Copyright © 1999-2003 Wadsack-Allen. All Rights Reserved.