名称
mxreport - Systems Insight Managerレポート ファイル フォーマット
構文
mxreport
説明
mxreport コマンドは、拡張マークアップ言語(XML)形式で記述されたレポー
トおよびレポート カテゴリ情報の読み込みおよび書き込みをサポートしてい
ます。この機能を利用して、Systems Insight Manager環境内でレポートまた
はレポート カテゴリを追加または削除することが可能です。
各ファイルには、1つまたは複数のレポートまたはレポート カテゴリの定義を
記述できます。
文書型定義
文書型定義(DTD)ファイルは、XMLファイルの規則を定義したものです。この
規則には、有効な要素タグ、属性、XMLファイル内の要素の出現回数などがあ
ります。レポートDTDファイルの名前は、mxReports.dtdであり、その内容を以
下に示します。マンページの書式上、DTDの内容は実際のファイルと同じよう
に表示されないことがあります。
<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT displayName (#PCDATA)>
<!ATTLIST displayName
displayLocale CDATA #REQUIRED
>
<!ELEMENT group EMPTY>
<!ATTLIST group
groupLocale CDATA #REQUIRED
parent CDATA #REQUIRED
child CDATA #REQUIRED
>
<!ELEMENT item EMPTY>
<!ATTLIST item
viewColName CDATA #REQUIRED
viewName CDATA #REQUIRED
>
<!ELEMENT privilege (#PCDATA)>
<!ELEMENT query (#PCDATA)>
<!ATTLIST query
queryType CDATA #REQUIRED
queryLocale CDATA #REQUIRED
>
<!ELEMENT report (group, displayName, query, item+, viewOption, privilege)>
<!ATTLIST report
reportName CDATA #REQUIRED
reportId CDATA #IMPLIED
displayFlag CDATA #REQUIRED
editFlag CDATA #REQUIRED
creatorId CDATA #IMPLIED
plugin CDATA #IMPLIED
displayOrder CDATA #IMPLIED
>
<!ELEMENT reportList (report+)>
<!ELEMENT viewOption (#PCDATA)>
要素
DTDで定義されているとおり、レポートXMLファイルには以下の要素を記述でき
ます。
レポートXMLファイルの1行目は、次のように記述しなければなりません。
<?xml version="1.0" encoding="encoding-value" ?>
encoding-value パラメータは、有効なエンコード値に置き換えます。有効な
エンコード値は、次のWebサイトにあります。
http://www.iana.org/assignments/character-sets
XMLヘッダ行が指定されていない場合は、システムのデフォルトのエンコード
は、"UTF-8"になります。
"report-list"要素はレポートXMLファイルに1度だけ記述され、レポート情報
リストを囲っている必要があります。 "report-list"要素には、0個以上の
"report"要素を含めることができます。
"report-list"要素に"report"または"category"要素が含まれていない場合、
関連するmxreportコマンドを実行しても何の効果もありません。
"report"要素は、レポートXMLファイルに0回以上記述する必要があります。
"report"要素には以下の属性があります。
"reportName"属性は必須属性で、レポート名を指定します。ユーザは、
"reportId"属性の既存のレポートのIDと一緒に"reportName"属性に新しい名前
を指定すると、既存のレポートを変更することができます。 "reportName"CMS
内で固有のものでなければなりません。
"displayName"属性は必須属性で、レポート表示名を指定します。
"displayName"CMS内で固有のものでなければなりません。
"reportId"属性はオプションで、固有のレポートIDを指定します。 XMLファイ
ルに既存のレポートを表示している場合、システムは常に"id"属性を出力しま
す。 レポートの追加を無視するので、ユーザは"reportId"属性を指定する必
要はありません。
"displayFlag"属性は必須で、レポートの表示タイプを指定します。レポート
を表示する場合は、常に"1"に設定する必要があります。
"editFlag"属性は必須で、レポートを編集できるかを指定します。 "0"を指定
するとレポートは編集できません。"1"を指定するとレポートは編集できま
す。
"creatorId"属性はオプションで、将来的に使用するものです。
"plugin"属性はオプションです。"0"は、システム定義レポートを指定しま
す。この属性がが指定されない場合、デフォルト値は"10"になります。
"displayOrder"属性はオプションで、将来的に使用するものです。
"viewOption"属性は必須です。"0"は、同じテーブル内のすべてのシステムを
表示するように指定します。 "1"は、個別のテーブル内の各システムを表示す
るように指定します。
"queryType"属性は必須です。常に"0"に設定する必要があります。
"queryLocale"属性は必須です。クエリの言語ロケールを指定します。
"displayLocale"属性は必須です。レポート表示の言語ロケールを指定しま
す。
"groupLocale"属性は必須です。グループ レポート表示の言語ロケールを指定
します。
"parent"属性は必須です。レポートのセットのグループ名を指定します。
"category-name"属性は必須で、レポートを特定のカテゴリに割り当てます。
"category-name"によるカテゴリ属性は、システムに存在している必要があり
ます。
"child"属性は必須です。個載れリースでは、""(例 child="")に設定されて
いる必要があります。
"viewColName"属性は必須です。hpmxItemテーブルのDbViewColNameを指定しま
す。
"viewName"属性は必須です。hpmxItemテーブルのDbViewNameを指定します。
コメント
XMLファイルには、コメントを記述することができます。コメントは、"<!--"
で始まり、 "-->"で終了しなければなりません。コメントは開始タグと終了タ
グの間で、複数行にわたって記述できます。
例
本セクションでは、レポートXMLファイルの例をいくつか示します。
この例は、インベントリを報告するレポートの定義を含むファイルを示してい
ます。
<?xml version="1.0" encoding="UTF-8"?>
<reportList>
<report reportName="Inventory 7 - Servers" displayFlag="0" creatorId="1" editFlag="1">
<group groupLocale="en_US" parent="System reports" child=""/>
<displayName displayLocale="en_US">Inventory 7 - Servers</displayName>
<query queryType="0" queryLocale="en_US">All Servers</query>
<item viewColName="DeviceName" viewName="R_Inventory"/>
<item viewColName="ProductType" viewName="R_Inventory"/>
<item viewColName="ProductName" viewName="R_Inventory"/>
<item viewColName="SerialNumber" viewName="R_Inventory"/>
<item viewColName="AssetTag" viewName="R_Inventory"/>
<item viewColName="MemorySize" viewName="R_Inventory"/>
<item viewColName="OSName" viewName="R_Inventory"/>
<item viewColName="OSVendor" viewName="R_Inventory"/>
<item viewColName="Location" viewName="R_Inventory"/>
<item viewColName="DeviceOwner" viewName="R_Inventory"/>
<viewOption>0</viewOption>
<privilege>0</privilege>
</report>
</reportList>
制限事項
本コマンドは、CMS上でのみ実行できます。
著者
mxreport は、HPにより開発されました。
参照(HP-UX)
mxreport(1M)、mxcategoryitem(4)
参照(Linux)
mxreport(8)、mxcategoryitem(4)