ストリームデータ処理基盤 uCosminexus Stream Data Platform - Application Framework システム構築・運用ガイド

[目次][索引][前へ][次へ]

12.3.2 Dashboard Viewerの画面編集用ファイルの詳細

ここでは,Dashboard Viewerの画面編集用ファイルの作成方法,記述形式,および定義の詳細について説明します。また,ダッシュボード表示用データをDashboard Viewerで表示するときのデータの型の扱いについても説明します。

<この項の構成>
(1) ファイルの作成方法
(2) 記述形式
(3) 定義の詳細
(4) Dashboard Viewerでの型の扱い

(1) ファイルの作成方法

Dashboard Viewerの画面編集用ファイルのファイル名は,<画面名>.xmlです。<画面名>には,16文字までの半角英数字で,任意の画面名を指定してください。

なお,Dashboard Viewerの画面編集用ファイルは,インストール時に提供されるサンプルファイルを使用して作成することをお勧めします。次のサンプルファイルをコピーして編集してください。

<インストールディレクトリ>\samples\httppacket\web\containers\uCSDPAF_Server\layout\dashboard.xml

作成したDashboard Viewerの画面編集用ファイルは,次のディレクトリに格納してください。

V01-50より前の場合
<インストールディレクトリ>\psb\CC\web\containers\uCSDPAF_Server\layout\
V01-50以降の場合
<インストールディレクトリ>\psb\CC\server\public\ejb\uCSDPAF_Server\layout\
注※
layoutディレクトリはユーザーが作成する必要があります。

Dashboard Viewerの画面編集用ファイルを作成するときの注意事項を次に示します。

(2) 記述形式

Dashboard Viewerの画面編集用ファイルの記述形式の例を示します。

<dashboardDisplay>
  <connectionSetting>
    <serverName>localhost</serverName>
    <portNo>20421</portNo>
  </connectionSetting>
  <widgetGroup>
    <widget>
      <kind>table</kind>
      <dataSetting>
        <interval>5000</interval>
        <data1>
          <dataName>InprocessAPTest/OutputAdaptor1/outputer</dataName>
          <filter>
            <columnName>SUBTIME</columnName>
            <condition>ge</condition>
            <value>100</value>
          </filter>
        </data1>
      </dataSetting>
      <dataDisplay>
        <threshold>
          <columnName>SUBTIME</columnName>
          <condition>ge</condition>
          <value>5000</value>
        </threshold>
      </dataDisplay>
    </widget>
  </widgetGroup>
</dashboardDisplay>

(3) 定義の詳細

dashboardDisplayタグ(全体情報の定義)
ダッシュボード画面の全体情報を定義します。
connectionSettingタグ(接続先サーバの定義)
接続先のサーバの情報を定義します。
serverNameタグ
接続先のSDPサーバのサーバ名を0〜255文字の半角英数字で指定します。デフォルト値は空文字です。空文字の場合,サーバに接続しません。
portNoタグ
接続先のSDPサーバのポート番号を0〜65,535文字の半角整数で指定します。デフォルト値は空文字です。空文字の場合,サーバに接続しません。
widgetGroupタグ(ウィジェット全体の定義)
ウィジェット全体の情報を定義します。
widgetタグ(ウィジェットの定義)
ウィジェットを定義します。
kindタグ
表示するウィジェットの種別を指定します。デフォルト値は,tableです。指定できる値を次に示します。
  • bar
    縦方向の棒グラフです。
  • circle
    円グラフです。
  • x-y
    散布図です。
  • trend
    折れ線グラフです。
  • table
    表です。
widgetSettingタグ(ウィジェットのパネルの定義)
ウィジェットのパネルの情報を定義します。
titleタグ
ウィジェットのタイトルを,日本語を含む0〜32文字の文字列で指定します。デフォルト値は空文字です。
borderタグ(ウィジェットの枠線の定義)
ウィジェットの枠線を定義します。
Colorタグ
ウィジェットの枠線の色を,RGBで指定できる色で指定します。デフォルト値は,192,192,192(灰色)です。
bgタグ(ウィジェットの背景の定義)
ウィジェットの背景を定義します。
なお,widgetタグ下のkindタグがtableの場合,表の背景に背景色および背景画像は表示されません。
Color1タグ
ウィジェットの背景色を,RGBで指定できる色で指定します。デフォルト値は,255,255,255(白)です。
bgImageタグ
ウィジェットの背景に設定する画像ファイルのURLを,http://から始まる0〜255文字の半角英数字で指定します。デフォルト値は空文字です。
指定できる画像ファイルはGIF形式およびJPG形式です。指定した画像に動画が含まれる場合は,動作は保障されません。ウィジェットと画像のサイズが異なる場合,画像を拡大または縮小しないで,ウィジェットの中央地点と画像の中央地点を合わせた位置に表示します。
空文字を指定した場合,および画像が表示できない場合は,背景色が設定されます。
dataSettingタグ(ウィジェットのデータ設定の定義)
ウィジェットのデータ設定の情報を定義します。
intervalタグ
Dashboard Viewerの表示の更新間隔,およびDashboard ViewerがDashboard Serverからデータを取得する間隔を1〜60000の半角整数(単位:ミリ秒)で指定します。デフォルト値は3000です。
なお,起動直後や再接続直後は,データが表示されるまでに更新間隔の2倍程度の時間が掛かります。
data1タグ〜data5タグ(データ系列の定義)
表示するデータを定義します。各データ系列は最大で1,024個保持できます。1,024個を超えた場合,Dashboard Serverに早く到着した順に破棄されます。
widgetタグ下のkindタグがbar,circle,tableの場合,data2タグ〜data5タグの値は利用されません。
legendNameタグ
表示するデータの凡例名を0〜30文字の日本語を含む文字列で指定します。デフォルト値は空文字です。
なお,widgetタグ下のkindタグがbar,circle,またはtableの場合,凡例名は表示されません。
dataNameタグ
Dashboard Serverから取得したいデータの接続名を0〜255文字の半角英数字で指定します。デフォルト値は空文字です。
空文字を指定した場合,データ接続はしません。入力した接続名が存在しない場合は,エラーが発生します。
Dashboard Viewer起動後,指定した接続名が存在しないか接続に失敗した場合は,接続状態アイコンが接続失敗のアイコンになります。
column1タグ〜column2タグ
Dashboard Serverから取得したデータの中から,どのカラムを表示するかを0〜255文字の半角英数字で指定します。デフォルト値は空文字です。
widgetタグ下のkindタグの値によって,指定する内容が異なります。
  • bar
    column1タグには横軸(ID)を指定します。column2タグには縦軸(値)を指定します。
  • circle
    column1タグには扇形(ID)を指定します。column2タグには扇形の大きさ(値)を指定します。
  • x-y
    column1タグには横軸(x軸の値)を指定します。column2タグには縦軸(y軸の値)を指定します。
  • trend
    column1タグには横軸(時刻)を指定します。column2タグには縦軸(値)を指定します。
  • table
    値を使用しません。
kindタグがbar,circle,x-y,trendの場合,column1タグまたはcolumn2タグに空文字を指定したときは,データは表示されません。
Dashboard Viewer起動後に初めてデータを取得できた場合,データの中に指定したカラム名が存在しないときは,エラーメッセージKFSP46954-Eが出力されます。適切ではない型のときは,エラーメッセージKFSP46955-Eが出力されます。
colorタグ
widgetタグ下のkindタグがx-y,またはtrendの場合に,データを表示する色をRGBで指定できる色で指定します。デフォルト値は,0,0,0(黒)です。
filterタグ(フィルターの定義)
取得したデータに対するフィルターの情報を定義します。フィルターは各データに一つだけ設定できます。
columnNameタグ
データにフィルターをかけるカラム名を0〜255文字の半角英数字で指定します。デフォルト値は空文字です。
conditionタグで定義するフィルターの条件を満たしていないデータを非表示にします。空文字の場合,データを非表示にしません。
Dashboard Viewer起動後に初めてデータを取得できた場合,データの中に指定したカラム名が存在しないときは,エラーメッセージKFSP46954-Eが出力されます。適切ではない型のときは,エラーメッセージKFSP46955-Eが出力されます。
conditionタグ
カラムの値とvalueタグで指定する値の間の条件を指定します。デフォルト値はeqです。
columnNameタグに指定した値の型ごとに指定できる値が異なります。指定できる値を次に示します。
  • columnNameタグに文字列型(STRING)のカラム名を指定した場合
    eq(=)またはne(!=)のどちらかを指定できます。
  • columnNameタグに整数型(BYTE,SHORT,INT,LONGのどれか)のカラム名を指定した場合
    lt(>),gt(<),le(>=),ge(<=),eq(=),ne(!=)のどれかを指定できます。
Dashboard Viewer起動後に初めてデータを取得できた場合,上記の条件で指定できない値を指定したときは,エラーメッセージKFSP46961-Eが出力されます。
valueタグ
比較する値を指定します。
columnNameタグに指定した値の型ごとに指定できる値が異なります。指定できる値を次に示します。
  • columnNameタグに文字列型(STRING)のカラム名を指定した場合
    0〜255文字の半角英数字で指定します。
  • columnNameタグに整数型(BYTE,SHORT,INT,LONGのどれか)のカラム名を指定した場合
    32bit整数型の範囲(-2147483648〜2147483647)で指定します。
Dashboard Viewer起動後に初めてデータを取得できた場合,上記の条件で指定できない値を指定したときは,エラーメッセージKFSP46961-Eが出力されます。
valueタグの値は省略できません。
dataDisplayタグ(データ表示の定義)
ウィジェット内のデータ表示の情報を定義します。
thresholdタグ(しきい値の定義)
表示しているデータに対するしきい値を定義します。
columnNameタグ
しきい値の設定をするカラム名を0〜255文字の半角英数字で指定します。デフォルト値は空文字です。
widgetタグ下のkindタグがtableの場合に,指定したしきい値を満たす行のすべての文字を赤く表示します。空文字を指定した場合,強調表示をしません。
Dashboard Viewer起動後に初めてデータを取得できた場合,表示されるテーブルデータの中に,指定したカラム名が存在しないときは,エラーメッセージKFSP46954-Eが出力されます。適切でない型のときは,エラーメッセージKFSP46955-Eが出力されます。
conditionタグ
カラムの値とvalueタグで指定した値の間の条件を指定します。デフォルト値はeqです。
columnNameタグに指定した値の型ごとに指定できる値が異なります。指定できる値を次に示します。
  • columnNameタグに文字列型(STRING)のカラム名を指定した場合
    eq(=)またはne(!=)のどちらかを指定できます。
  • columnNameタグに整数型(BYTE,SHORT,INT,LONGのどれか)のカラム名を指定した場合
    lt(>),gt(<),le(>=),ge(<=),eq(=),ne(!=)のどれかを指定できます。
この条件に合わない値を指定した場合,エラーメッセージKFSP46961-Eが出力されます。
valueタグ
比較する値を指定します。
columnNameタグに指定した値の型ごとに指定できる値が異なります。指定できる値を次に示します。
  • columnNameタグに文字列型(STRING)のカラム名を指定した場合
    0〜255文字の半角英数字で指定します。
  • columnNameタグに整数型(BYTE,SHORT,INT,LONGのどれか)のカラム名を指定した場合
    32bit整数型の範囲(-2147483648〜2147483647)で指定します。
この条件に合わない値を指定した場合,エラーメッセージKFSP46961-Eが出力されます。
valueタグの値は省略できません。
xAxisタグ(x軸の定義)
x軸の設定情報を定義します。
maxタグ
widgetタグ下のkindタグがx-yの場合に,表示しているデータのx軸方向の表示について,最大値を空文字,または32bitの整数型の範囲(-2147483648〜2147483647)で指定します。デフォルト値は空文字です。
最大値(maxタグの値)<=最小値(minタグの値)となる値が指定された場合は,エラーメッセージKFSP46961-Eが出力されます。
最大値を空文字で指定した場合,自動でスケール変更されます。
なお,widgetタグ下のkindタグがx-y以外の場合,x軸の最大値の設定はしません。
minタグ
widgetタグ下のkindタグがx-yの場合に,表示しているデータのx軸方向の表示について,最小値を空文字,または32bitの整数型の範囲(-2147483648〜2147483647)で指定します。デフォルト値は空文字です。
最大値(maxタグの値)<=最小値(minタグの値)となる値が指定された場合は,エラーメッセージKFSP46961-Eが出力されます。
最小値を空文字で指定した場合,自動でスケール変更されます。
なお,widgetタグ下のkindタグがx-y以外の場合,x軸の最小値の設定はしません。
yAxisタグ(y軸の定義)
y軸の設定情報を定義します。
maxタグ
widgetタグ下のkindタグがx-yまたはtrendの場合に,表示しているデータのy軸方向の表示について,最大値を空文字,または32bit整数型の範囲(-2147483648〜2147483647)で指定します。デフォルト値は空文字です。
最大値(maxタグの値)<=最小値(minタグの値)となる値が指定された場合は,エラーメッセージKFSP46961-Eが出力されます。
最大値を空文字で指定した場合,自動でスケール変更されます。
なお,widgetタグ下のkindタグがx-yまたはtrend以外の場合,y軸の最大値の設定はしません。
minタグ
widgetタグ下のkindタグがx-yまたはtrendの場合に,表示しているデータのy軸方向の表示について,最小値を空文字,または32bit整数型の範囲(-2147483648〜2147483647)で指定します。デフォルト値は空文字です。
最大値(maxタグの値)<=最小値(minタグの値)となる値が指定された場合は,エラーメッセージKFSP46961-Eが出力されます。
最小値に空文字を指定した場合,自動でスケール変更されます。
なお,widgetタグ下のkindタグがx-yまたはtrend以外の場合,y軸の最小値の設定はしません。
xTimeRangeタグ(時間軸の定義)
x軸(時間軸)の設定情報を定義します。
rangeタグ
widgetタグ下のkindタグがtrendの場合に,表示しているデータのx軸の表示時間を1〜86400(単位:秒)の半角整数で指定します。1画面に入る表示時間を指定してください。デフォルト値は300です。
なお,widgetタグ下のkindタグがtrend以外の場合,x軸について表示時間の設定はしません。
SliderFlagタグ
widgetタグ下のkindタグがtrendの場合に,時間軸(x軸)のスライダーを表示するかどうかを指定します。デフォルト値はOFFです。
指定できる値(半角大文字)を次に示します。
  • ON
    スライダーを表示します。
  • OFF
    スライダーを表示しません。
なお,widgetタグ下のkindタグがtrend以外の場合,時間軸(x軸)のスライダー表示の設定はしません。
tablePropertiesタグ(表の定義)
表の設定情報を定義します。
columnHeaderListタグ(カラムヘッダーの定義)
widgetタグ下のkindタグがtableの場合に,表示するカラムヘッダーの情報を定義します。
columnタグ
表示するカラムについて,カラムごとの情報を定義します。
タグの数が16個を超える場合,エラーメッセージKFSP46966-Eが出力されます。
actualNameタグ
受信データに含まれるカラムのうち,データを表示したいカラム名を0〜255文字の半角英数字で指定します。デフォルト値は空文字です。
空文字を指定した場合,ソートはしません。
Dashboard Viewer起動後に初めてデータを取得できた場合,データの中に指定したカラム名が存在しないときは,エラーメッセージKFSP46954-Eが出力されます。
displayNameタグ
カラムヘッダーに表示するカラム名を0〜32文字の日本語を含む文字列で指定します。デフォルト値は空文字です。
legendタグ(凡例の定義)
凡例の情報を定義します。
displayFlagタグ
グラフの右側に凡例を表示するかどうかを指定します。デフォルト値はOFFです。
指定できる値(半角大文字)を次に示します。
  • ON
    凡例を表示します。
  • OFF
    凡例を表示しません。
widgetタグ下のkindタグに指定する値によって,表示される凡例の内容が異なります。
  • bar
    横軸に表示された名前の一覧を表示します。
  • circle
    円グラフ内の扇形が持つ名前の一覧を表示します。
  • x-y
    data1タグ〜data5タグごとにlegendNameタグで指定した値を表示します。
  • trend
    data1タグ〜data5タグごとにlegendNameタグで指定した値を表示します。
  • table
    ONを指定しても凡例は表示されません。
widthタグ
凡例の大きさを1〜2048の半角整数(単位:ピクセル),または1〜100の半角整数と%で指定します。半角整数と%で指定した場合,ウィジェットに対する凡例の大きさを割合で指定します。半角整数と%で指定した結果,凡例を表示しきれない場合は,表示しきれるサイズに変更されます。
デフォルト値は25%です。
jumpToURLタグ(URL遷移の定義)
URL遷移の情報を定義します。
URLタグ
遷移先のURLを,http://から始まる0〜128文字の半角英数字で指定します。デフォルト値は空文字です。
空文字を指定した場合,URL遷移をしません。
parameter1タグ
選択したデータが持つ情報のうち,URL遷移先に渡す引数1の引数名を0〜16文字の半角英数字で指定します。デフォルト値は空文字です。
空文字を指定した場合,URL遷移先に情報を渡しません。
value1タグ
選択したデータが持つ情報のうち,URL遷移先に渡す引数1の値を0〜16文字の半角英数字で指定します。デフォルト値は空文字です。
widgetタグ下のkindタグに指定する値によって,指定する値(URL遷移先に渡せる値)が異なります。
  • bar
    ID(横軸)の値を指定します。
  • circle
    ID(横軸)の値を指定します。
  • x-y
    legendの値を指定します。
  • trend
    legendの値を指定します。
  • table
    column1〜column16の値を指定します。
widgetタグ下のkindタグにtableを指定し,Dashboard Viewer起動後に初めてデータを取得できた場合,column[n]の[n]の値が表示されているカラム数以上のときは,エラーメッセージKFSP46961-Eが出力されます。また,column[n]に対して,[n]番目のカラムの型が文字列型でないときは,エラーメッセージKFSP46955-Eが出力されます。

(4) Dashboard Viewerでの型の扱い

ダッシュボード表示用データをDashboard Viewerで表示するとき,Dashboard Viewerでは,そのデータは次の表に示す型で扱われます。

項番 ダッシュボード出力コネクター定義で指定できる型 Dashboard Viewerでの型の扱い 値の範囲
1 BYTE 整数 -231〜(231)-1
2 SHORT
3 INT
4 LONG 整数 -253〜253※1
5 FLOAT 倍精度実数※2 1.79769313486231×(10308)〜-1.79769313486231×(10308)
6 DOUBLE
7 BIG_DECIMAL 文字列型 0〜1,024文字※3
8 STRING
9 DATE 時刻型※4 上限※1:1970年1月1日0時0分0.000秒
下限※1:9999年12月31日23時59分59.999秒
10 TIME
11 TIMESTAMP
注※1
下限を下回る値を受信した場合は,その値は下限の値に置き換えられます。上限を上回る値を受信した場合は,その値は上限の値に置き換えられます。
注※2
値の範囲は,IEEE 754に準拠します。ダッシュボード出力コネクターとDashboard Viewer間で,値の丸めは発生しません。
注※3
上限を上回る長さの文字列を受信した場合,その文字列は上限の長さで打ち切られます。2バイト文字は1文字として扱われます。
注※4
TIMESTAMP型の表示形式を次に示します。
YYYY-MM-DD hh:mm:ss.SSS
YYYY:年
MM:月
DD:日
hh:時
mm:分
ss:秒
SSS:ミリ秒