9.10.4 Dashboard output connector definition

You specify a dashboard output connector definition (DashboardOutputConnectorDefinition tag) as a child element of a CB definition for output (OutputCBDefinition tag).

For details about dashboard output processing, see 10.7 Dashboard output.

Organization of this subsection
(1) Format
(2) Details of definition
(3) Example

(1) Format

<DashboardOutputConnectorDefinition
MaxNum="maximum-number-of-records-to-be-retained"
Record="record-name"
ReadRecordRemoveFlag="{ON|OFF}">
 <RecordHoldTime
  DateReference="{CURRENT_DATE|LAST_UPDATE}"
  RecordTime="record-retention-period"
  DateFieldPosition="time-field-number"/>
 <DataProcessingDefinition
  Name="{HistoryRecorder|NoDataProcessing}"
   <HistoryRecorder/>
   <NoDataProcessing/>
 </DataProcessingDefinition>
</DashboardOutputConnectorDefinition>

(2) Details of definition

DashboardOutputConnectorDefinition tag (all definition information)
Defines all dashboard output connector definition information. You specify this definition only once.
MaxNum="maximum-number-of-records-to-be-retained"
Specifies the maximum number of records to be retained in the record area, as an integer from 1 to 10000. If this attribute is omitted, 1000 is assumed.
When the number of records exceeds the value specified in this attribute, records are deleted sequentially beginning with the oldest record.
Record="record-name"
Specifies a record to be output to the dashboard. This attribute cannot be omitted.
ReadRecordRemoveFlag="{ON|OFF}"
Specifies whether the record acquired by Dashboard Server is to be deleted from the dashboard output connector. If this attribute is omitted, OFF is assumed.
The permitted values are as follows:
  • ON
    Deletes record.
  • OFF
    Does not delete record.
RecordHoldTime tag (definition of record retention period)
Defines the period of time during which the record is to be retained when records are deleted from the dashboard output connector based on the retention period. If this attribute is omitted, record deletion based on the retention period is not performed.
A record is deleted when the following condition is satisfied:

(Reference time in the DateReference attribute - retention period in the RecordTime attribute)
> Time in the field with the DateFieldPosition attribute

For example, if the reference time is 10:00:10, retention period is 5 seconds, and time in the field is 10:00:04, that record is deleted.
DateReference="{CURRENT_DATE|LAST_UPDATE}"
Specifies the reference time for determining record deletion. This attribute cannot be omitted.
The permitted values are as follows:
  • CURRENT_DATE
    Uses the current system time as the reference time.
  • LAST_UPDATE
    Uses the last time a tuple was received as the reference time.
RecordTime="record-retention-period"
Specifies the record's retention period (in seconds), as an integer from 0 to 86400. This attribute cannot be omitted.
DateFieldPosition="time-field-number"
Specifies the number of the field in the record that contains the time, as an integer from 1 to 3000. This attribute cannot be omitted.
DataProcessingDefinition tag (definition of data processing)
Defines how to process the dashboard-display data that is output by the dashboard output connector. If this definition is omitted, data is not processed.
Name="{HistoryRecorder|NoDataProcessing}"
Specifies whether or not to process the dashboard-display data. This attribute cannot be omitted.
The permitted values are as follows:
  • HistoryRecorder
    Processes dashboard-display data. If you want to display charts, specify HistoryRecorder. When dashboard-display data is processed, all the records that meet the maximum number of records to be retained and the record retention period are retained as the dashboard-display data.
    If you specify HistoryRecorder, specify an empty HistoryRecorder tag under the DataProcessingDefinition tag.
  • NoDataProcessing
    Does not process dashboard-display data. If you do not need to process the dashboard-display data, specify NoDataProcessing. When dashboard-display data is not processed, any existing dashboard-display data is deleted each time a record is acquired from the dashboard output connector.
    If you specify NoDataProcessing, specify an empty NoDataProcessing tag under the DataProcessingDefinition tag.
HistoryRecorder tag (log retention definition)
If you specified HistoryRecorder in the Name attribute in the DataProcessingDefinition tag, specify an empty HistoryRecorder tag under the DataProcessingDefinition tag.
If you specified NoDataProcessing in the Name attribute, there is no need to specify this tag.
NoDataProcessing tag (no-processing output definition)
If you specified NoDataProcessing in the Name attribute in the DataProcessingDefinition tag, specify an empty NoDataProcessing tag under the DataProcessingDefinition tag.
If you specified HistoryRecorder in the Name attribute, there is no need to specify this tag.

(3) Example

<?xml version="1.0" encoding="UTF-8"?>
<root:AdaptorCompositionDefinition
xmlns:docon="http://www.hitachi.co.jp/soft/xml/sdp/adaptor/definition/callback/DashboardOutputConnectorDefinition">
<!-- Omitted -->

<!-- CB definition for output -->
<cb:OutputCBDefinition class="jp.co.Hitachi.soft.sdp.adaptor.callback.io.dashboard.DashboardOutputCBImpl" name="outputer2">
 <!-- Dashboard output connector definition -->
 <docon:DashboardOutputConnectorDefinition MaxNum="1000" Record="RECORD2"
  ReadRecordRemoveFlag="OFF">
   <!-- Definition of record retention period -->
   <docon:RecordHoldTime DateReference="LAST_UPDATE"
    RecordTime="300" DateFieldPosition="1"/>
   <!-- Definition of data processing -->
   <docon:DataProcessingDefinition Name="NoDataProcessing">
     <docon:NoDataProcessing/>
   </docon:DataProcessingDefinition>
 </docon:DashboardOutputConnectorDefinition>
</cb:OutputCBDefinition>