Service Control Application Suite for Broadband API プログラマ ガイド
Reporter CLI
Reporter CLI
発行日;2012/01/09 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 1MB) | フィードバック

目次

Reporter CLI

Reporter CLIの概要

構文と使用法

コマンドラインでの使用法

コマンドラインでの構文

コマンドライン オプション

コマンド ファイルでの使用法

コマンド ファイルでの構文

Reporter CLI

この章では、Service Control Reporter CLI(コマンドライン インターフェイス)を使用してService Control reporterアプリケーションを実行するさまざまな方法について、構文、スイッチ、およびオプションも含めて説明します。

この章の内容は次のとおりです。

「Reporter CLIの概要」

「構文と使用法」

Reporter CLIの概要

Reporter CLIは、SCASl Reporter GUIの機能を補足するコマンドライン アプリケーションをベースとしています。このCLIは 実行可能プログラム として、または CGIスクリプト として実行できます。Service Control Reporter CLIは、対応するSCAS Reporter GUIを超える機能性と柔軟性を提供し、サードパーティ製アプリケーションと統合することにより、使用状況および統計に基づく出力の生成が可能です。

構文と使用法

SCAS Reporterは、次の方法で実行できるアプリケーションです。

コマンドライン ― コマンドライン バージョンでは、パラメータの入力が受け付けられます。

コマンド ファイル ― コマンド ファイル バージョンは、コマンドライン パラメータの入ったファイルを入力として読み込みます。バッチ ファイルとして実行できます。

起動される実行可能プログラム ― 起動元のアプリケーションにプログラムを埋め込みます。アプリケーションは、SCAS Reporterにパラメータとして渡されるストリングをダイナミックに構築します。

さらに、次の場所からSCAS Reporterを呼び出すことができます。

CGI BINディレクトリ ISAPIブラウザ 、および NSAPIブラウザ ― SCAS Reporterは、CGI BINディレクトリからでも、ISAPIまたはNSAPI準拠のブラウザからでも呼び出せます。アプリケーションの出力はHTML形式で返され、ブラウザで表示されます。エラーが検出された場合は、該当するエラー メッセージが表示されます。

コマンドラインでの使用法

SCAS Reporterアプリケーションを起動するためのコマンドライン構文は、次のとおりです。

reporter { [-r report-id] | [-n report-name] | [-i report-index] }

-f [report-format] -k key=value -e [CON]

-l user-name\password@host-machine

[drive:][path] <report-filename>

コマンドラインでの構文

SCAS Reporterアプリケーションを起動するときコマンドラインで使用するスイッチは、次のとおりです。

スイッチ -f -k 、および -e は省略可能です。

-r -n 、または -i スイッチのうち、いずれか1つだけを指定する必要があります。

その他のパラメータは必須です。

コマンドライン オプション

SCAS Reporterアプリケーションを起動するときにコマンドラインで使用するオプションについて、次の表で説明します。

 

表8-1 SCAS Reporterアプリケーションのコマンドライン オプション

オプション
SCAS Reporterによるアクション
説明

-r <report-id>

report-idを使用してレポートを生成します。

このパラメータは、定義済みのテンプレートを使用してレポートを生成する場合に使用します。

-n <report-name>

report-nameを使用してレポートを生成します。

このパラメータは、個人用のテンプレートを使用してレポートを生成する場合に使用します。指定した名前は、保存されているレポート名と照合されます。レポート名には大文字と小文字の区別があります。

-i <report-index>

report-indexを使用してレポートを生成します。

このパラメータは、個人用のテンプレートを使用してレポートを生成する場合に使用します。

-f [report-format]

指定したレポート フォーマットで、グラフまたは表としてレポートを生成します。report-formatを省略すると、デフォルトのフォーマットが使用されます。アスタリスク付きのフォーマットが、デフォルトです。

表のフォーマット:
JPG
GIF *
HTM

グラフのフォーマット:
CSV*
HTM
XLS

-k key=value

指定する値で定義済みのキーを上書きします。

-l user-name\password @hostname

(必須)user-name\password@hostname machineを使用してログインします。

Reporterの実行可能プログラムをホスティングしているワークステーションのユーザ名およびパスワードを使用してください。

<report-filename>

(必須)出力の転送先ファイル名。

ファイル名がすでに存在する場合、元のファイルが上書きされます。

-e [CON]

出力(メッセージおよびエラー)をエラー メッセージ ファイルにリダイレクトします。オプションのCONスイッチとしてコンソール ウィンドウを使用し、ウィンドウが開いている場合、そのウィンドウにエラー メッセージがリダイレクトされます。

ReporterはWin32アプリケーションなので、stderrはエラー メッセージ ファイルにリダイレクトされます。

コマンド ファイルでの使用法

コマンド ファイルからSCAS Reporterアプリケーションを起動するためのコマンドは、次のとおりです。

reporter@[drive:][path][command-file]

コマンド ファイルでの構文

コマンド ファイルからSCAS Reporterアプリケーションを起動するための構文は、次のとおりです。

実行可能プログラム名の後ろに、アットマーク(@)、ドライブおよびパス(省略可能)、および入力に使用するコマンド ファイルの名前(必須)を指定します。

コマンド ファイルの行ごとに、レポートを生成するための異なるコマンドを指定します。

セミコロン(;)で始まる行は注釈行とみなされ、無視されます。

バックスラッシュ(\)を使用して長い行を分割できます。最終行を除く各行の最後にあるバックスラッシュが連結されます。