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

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

9.10.4 ダッシュボード出力コネクター定義

ダッシュボード出力コネクター定義(DashboardOutputConnectorDefinitionタグ)は,出力用CB定義(OutputCBDefinitionタグ)の子要素として定義します。

なお,ダッシュボードへの出力の処理については,「11.7 ダッシュボードへの出力」を参照してください。

<この項の構成>
(1) 記述形式
(2) 定義の詳細
(3) 記述例

(1) 記述形式

<DashboardOutputConnectorDefinition
 MaxNum="<最大レコード保持数>"
 Record="<レコード名>"
 ReadRecordRemoveFlag="{ON|OFF}">
  <RecordHoldTime 
   DateReference="{CURRENT_DATE|LAST_UPDATE}"
   RecordTime="<レコード保持期間>"
   DateFieldPosition="<時刻フィールド番号>"/>
  <DataProcessingDefinition
   Name="{HistoryRecorder|NoDataProcessing}">
    <HistoryRecorder/>
    <NoDataProcessing/>
  </DataProcessingDefinition>
</DashboardOutputConnectorDefinition>

(2) 定義の詳細

DashboardOutputConnectorDefinitionタグ(全体情報の定義)
ダッシュボード出力コネクター定義の全体情報を定義します。この定義は必ず1個だけ記述します。
MaxNum="<最大レコード保持数>"
レコード保持領域内でのレコードの最大保持数を1〜10000の整数で指定します。省略した場合,1000が仮定されます。
レコード数がこの属性で指定した値を超えると,古いレコードから順番に削除します。
Record="<レコード名>"
ダッシュボード出力の対象となるレコードを指定します。この属性は省略できません。
ReadRecordRemoveFlag="{ON|OFF}"
Dashboard Serverが取得したレコードをダッシュボード出力コネクターから削除するかどうかを指定します。省略した場合,OFFが仮定されます。
指定できる値を次に示します。
  • ON
    レコードを削除します。
  • OFF
    レコードを削除しません。
RecordHoldTimeタグ(レコード保持期間の定義)
保持期間によってダッシュボード出力コネクターのレコードを削除する場合に,レコードを保持する期間を定義します。この定義を省略した場合,保持期間によるレコードの削除は行われません。
なお,レコードが削除されるのは,次の条件を満たす場合です。
(DateReference属性の基準時刻−RecordTime属性の保持期間)
>DateFieldPosition属性のフィールドの時刻
例えば,基準時刻が10:00:10,保持期間が5秒,フィールドの時刻が10:00:04だった場合,そのレコードは削除されます。
DateReference="{CURRENT_DATE|LAST_UPDATE}"
レコードを削除するための基準時刻を指定します。この属性は省略できません。
指定できる値を次に示します。
  • CURRENT_DATE
    システムの現在の時刻を基準時刻とします。
  • LAST_UPDATE
    最後にタプルを受信した時刻を基準時刻とします。
RecordTime="<レコード保持期間>"
レコードの保持期間(単位:秒)を0〜86400の整数で指定します。この属性は省略できません。
DateFieldPosition="<時刻フィールド番号>"
レコード内で時刻が設定されているフィールドの番号を1〜3000の整数で指定します。この属性は省略できません。
DataProcessingDefinitionタグ(データの加工処理の定義)
ダッシュボード出力コネクターが出力するダッシュボード表示用データの加工処理について定義します。この定義を省略した場合,データの加工処理は行われません。
Name="{HistoryRecorder|NoDataProcessing}"
ダッシュボード表示用データの加工処理を行うかどうかを指定します。この属性は省略できません。
指定できる値を次に示します。
  • HistoryRecorder
    加工処理を行います。グラフを表示したい場合には,HistoryRecorderを指定します。加工処理を行う場合,最大レコード保持数,およびレコード保持期間の定義に従うすべてのレコードをダッシュボード表示用データ内に保持します。
    HistoryRecorderを指定した場合,DataProcessingDefinitionタグの下に空のHistoryRecorderタグを記述します。
  • NoDataProcessing
    加工処理を行いません。加工処理が不要な場合には,NoDataProcessingを指定します。加工処理を行わない場合,ダッシュボード出力コネクターからレコードを取得するたびに,それまでのダッシュボード表示用データがすべて削除されます。
    NoDataProcessingを指定した場合,DataProcessingDefinitionタグの下に空のNoDataProcessingタグを記述します。
HistoryRecorderタグ(履歴保持定義)
DataProcessingDefinitionタグのName属性でHistoryRecorderを指定した場合に,DataProcessingDefinitionタグの下に空のHistoryRecorderタグを記述します。
Name属性でNoDataProcessingを指定した場合には,このタグを記述する必要はありません。
NoDataProcessingタグ(無加工出力定義)
DataProcessingDefinitionタグのName属性でNoDataProcessingを指定した場合に,DataProcessingDefinitionタグの下に空のNoDataProcessingタグを記述します。
Name属性でHistoryRecorderを指定した場合には,このタグを記述する必要はありません。

(3) 記述例

<?xml version="1.0" encoding="UTF-8"?>
<root:AdaptorCompositionDefinition
xmlns:docon="http://www.hitachi.co.jp/soft/xml/sdp/adaptor/definition/callback/DashboardOutputConnectorDefinition">
<!-- 途中略 -->
 
<!-- 出力用CB定義 -->
<cb:OutputCBDefinition class="jp.co.Hitachi.soft.sdp.adaptor.callback.io.dashboard.DashboardOutputCBImpl" name="outputer2">
  <!-- ダッシュボード出力コネクター定義 -->
  <docon:DashboardOutputConnectorDefinition MaxNum="1000" Record="RECORD2"
   ReadRecordRemoveFlag="OFF">
    <!-- レコード保持期間の定義 -->
    <docon:RecordHoldTime DateReference="LAST_UPDATE"
     RecordTime="300" DateFieldPosition="1"/>
    <!-- データの加工処理の定義 -->
    <docon:DataProcessingDefinition Name="NoDataProcessing">
      <docon:NoDataProcessing/>
    </docon:DataProcessingDefinition>
  </docon:DashboardOutputConnectorDefinition>
</cb:OutputCBDefinition>