reports ユーティリティ

2
casp1032jp
SS-Tools ディレクトリにあるこのコマンド ライン ユーティリティを使用すると、現在のモデリング カタログ内の選択したオブジェクトのリストを表示できます。reports は、SpectroSERVER データベースがインストールされているディレクトリから実行します。
このコマンドは、レポート生成シーケンス中にデータベースをロックします。その結果、一度に 1 つのレポートのみを実行できます。
注:
reports を実行する前に、SpectroSERVER と、VNM、Model Type Editor、サードパーティ ユーティリティなどの SpectroSERVER データベースにアクセスする他のプログラムをシャットダウンしてください。そうしないと、データベースが破損する可能性があります。
このユーティリティの形式は以下のとおりです。
reports [-mtype <name_pattern>] [-relation <name_pattern>] [-handle <handle>] [-attrflags <defglmprsvw>] [-fields <cdefgimnotvGE>] [-types <bierdtcgmMRlaoIAOTU>] [-recursive] [-invisible] [-lists] [-nolists] [-groups] [-help]
-mtype
レポートに含めるモデル タイプを指定します。指定したテキスト文字列が名前に含まれるモデル タイプがすべて含まれます。たとえば、モデル タイプが IRM の場合、Hub_CSI_CIRM、Hub_CSI_IRM2、Hub_CSI_SIRM、および名前に「IRM」が含まれる他のすべてのモデル タイプのセクションがリストされます。
注:
「該当するすべての」エントリに対するワイルドカードとして、ピリオド(.)を使用できます。レポートの表示に長時間を必要とするので、ワイルドカード オプションは控え目に使用します。属性情報のないすべてのモデル タイプについてのレポートを表示するには、$SPECROOT/SS ディレクトリから以下のコマンドを実行します。
../SS-Tools/reports -mtype . -fields e
 
-relation
レポートに含める関係を指定します。出力には、モデル タイプ間の関係が一覧表示されます。
注: 「該当するすべての」エントリに対するワイルドカードとして、ピリオド(.)を使用できます。すべての関係についてのレポートを表示するには、$SPECROOT/SS ディレクトリから以下のコマンドを実行します。
../SS-Tools/reports -rel .
-handle
レポートに含めるモデル タイプの 16 進のハンドルを指定します。「0x」プレフィックスを前に付けても付けなくてもかまいません。指定したテキスト文字列がハンドルに含まれるモデル タイプがすべて含まれます。この引数は mtype 引数と似ていますが、名前の文字列ではなくモデル タイプ ハンドルを受け付けることが異なります。
たとえば、0x180027 のハンドルを指定した場合、レポートには 0x180000 の開発者 ID で作成された 27 番目のモデル タイプのセクションが含まれます。逆に、ハンドルが 180 の場合は、レポートには、その開発者 ID で作成されたすべてのモデル タイプだけでなく、同じ 3 桁がハンドルのどこかに含まれる他のモデル タイプも含まれます。
 
-attrflags defglmprsvw
指定したフラグ セットのいずれかを持つモデル タイプの属性だけがレポートに含まれるように、レポートをフィルタします。
d
データベース
e
外部
 
f
グローバル
 
g
保証済み
 
l
ログ記録
 
m
メモリ
 
p
Polled
 
r
読み取り可能
 
Shared
 
v
保持
w
書き込み可能
注:
フラグのリストの代わりに連続する 2 個の一重引用符または二重引用符を入力することは、すべてのフラグを入力することと同じです。値を指定しないでこの引数を使用すると、レポート ユーティリティはエラーで失敗します。ヘルプ ファイルが表示されます。これらの属性コンポーネントの詳細については、「Model Type Editor」を参照してください。
-fields cdefgimnotvGE
指定した属性コンポーネント(フィールド)のみを含むように、レポートをフィルタします。
c
作成者モデル タイプ
d
OID 参照
 
e
属性情報を印刷しない
 
f
Flags
 
g
ポーリング グループ
 
i
属性 ID
 
m
マニフェスト定数名
 
n
開発者 ID を含む名前
 
o
OID プレフィックス
 
t
タイプ
 
v
デフォルト値
 
G
グループ ID
E
列挙された値リスト
注:
フラグのリストの代わりに連続する 2 個の一重引用符または二重引用符を入力することは、すべてのフラグを入力することと同じです。値を指定しないでこの引数を使用すると、レポート ユーティリティはエラーで失敗します。ヘルプ ファイルが表示されます。これらの属性コンポーネントの詳細については、「Model Type Editor」を参照してください。
-types bierdtcgmMRlazoIAGOTU
指定した型の属性のみを含むように、レポートをフィルタします。
b
ブール値
i
整数
 
e
列挙値
 
r
実数
 
d
日付
 
t
時間
 
c
Counter
 
g
ゲージ
 
m
モデル ハンドル
 
M
モデル タイプ ハンドル
 
R
関係ハンドル
 
l
ランドスケープ ハンドル
 
a
属性 ID
 
z
テキスト文字列
 
o
Object ID
 
I
IP アドレス
 
A
エージェント ID
 
O
オクテット文字列
 
T
タグ付きオクテット
U
64 ビット符号なし整数
 
-recursive
レポートに子孫(子)モデル タイプを含めます。
 
-invisible
レポートに以下のモデル タイプを含めます。
検索パターンに一致するすべての表示モデル タイプ(表示モデル タイプ フラグが true に設定されている)
現在ロードされている開発者 ID によって作成され、検索パターンに一致した、すべての非表示モデル タイプ(表示モデル タイプ フラグが false に設定されている)
-lists
複数の値を許可する属性のみをレポートに含めます。
-nolists
複数の値を許可する属性をレポートに含めないでください。
-groups
モデル タイプ グループをレポートに含めます。
-help
コマンドの使用方法に関する情報を表示します。
モデル タイプ レポートの実行
モデル タイプ レポートは、特定のモデル タイプの属性情報をリストします。モデル タイプ レポートを実行するには、以下の構文を使用します。
../SS-Tools/ \ reports [-mtype <model type>][-attrflags w][-fields][-invisible]
or
../SS-Tools/ \ reports [-handle <model handle>][-attrflags ""][-fields][-invisible]
例として、次のコマンドは、HUB_CSI_IRM2 モデル タイプについてのレポートを生成します。
reports -mtype HUB_CSI_IRM2 -attrflags e -fields don -invisible
レポートには、外部フラグが設定されているすべての属性がリストされます。含まれる各属性について、OID 参照、OID プレフィックス、および名前(開発者 ID 付き)が示されます。また、レポートには、指定したモデル タイプのベース モデル タイプ(親モデル タイプ)の全リストが含まれます。ベース モデル タイプは継承の順にリスト表示されます。
レポートは、ワークステーションの標準出力デバイスに送信されます。
レポートの出力デバイスの指示
reports ユーティリティは、ワークステーションの標準出力デバイスに出力を送信します。通常は画面に表示されます。ファイルまたはプリンタに出力を直接リダイレクトするには、UNIX のコマンド ラインで標準パイプ コマンドを使用します。
例 1
次のコマンドは、HUB_CSI_IRBM モデル タイプについてのレポートを生成します。
reports -mtype HUB_CSI_IRBM -attrflags e -fields n
このレポートには、モデル タイプの開発者、その名前およびハンドル、6 つの属性フラグの状態、および直接のベース モデル タイプの ID を示す、標準的なヘッダ セクションが含まれます。レポートの残りの部分は外部フラグが設定された属性に制限され、レポートの細目では属性名のみがリストされます。
レポートは単に一度だけの表示としてワークステーション画面に表示されます。レポートが長すぎる場合、レポートの最後だけが表示されます(ディスプレイが表示できるテキストの最大行)。
例 2
次のコマンドは同じレポートを生成しますが、レポートを増分表示ファイルとしてワークステーション画面に送信し、最初の画面が表示されます。
reports -mtype HUB_CSI_IRBM -attrflags e -fields n | more
Return キーを押すとその画面を表示しながら連続する行をインクリメントでき、スペース キーを押すと次の画面を表示できます。
例 3
次のコマンドは同じレポートを生成し、現在のディレクトリの REPORT_1 という名前の ASCII ファイルにそれを書き込みます。
reports -mtype HUB_CSI_IRBM -attrflags e -fields n > REPORT_1
指定した名前のファイルが現在のディレクトリに存在する場合は、新しいレポートによって上書きされます。
前にディレクトリ パスを付けてレポート ファイル名を指定できます。
 
例 4
次のコマンドは同じレポートを生成し、<ptr> で指定するプリンタに印刷ファイルとして送信します。
reports -mtype HUB_CSI_IRBM -attrflags e -fields n > lpr -P<ptr>
関係レポートの実行
関係レポートには、選択した関係に従ってモデル タイプ間の関係がリストされます。関係レポートを実行するには、以下の構文を使用します。
../SS-Tools/reports -rel <relation>
<relation> は、レポートに含める関係の名前です。一度に 1 つの関係を指定します。
例として、次のコマンドは、関係 Connects_to についてのレポートを生成します。
../SS-Tools/reports -rel Connects_to
レポートは、Connects_to 関係に含まれる各シーケンシャル ルールをリストし、ワークステーションの標準出力デバイスに送信されます。レポートをファイルに書き込む方法、またはプリンタに送信する方法については、「レポートの出力デバイスの指示」を参照してください。