<< Click to Display Table of Contents >> マニュアル > サーバ作成ガイド > アクション編 > アクションリファレンス > サマリアクション(ロギング/集計/日報) > サマリアクションの設定ファイルとフォルダ構成 > サマリマスタ > 集計ログセクション |
集計ログセクション プロパティ一覧
集計機能関連
パラメータ名 (デフォルト値) |
対象 |
必須 |
解説 |
|||||||||||||||||||||||||||||
DaysOfHoldingData (-1) |
CSV/ODBC |
|
集計ログのデータ保持日数。
<設定例>1年分保持の場合
|
|||||||||||||||||||||||||||||
SummaryUnit (指定無し) |
CSV/ODBC |
必須 |
集計の期間の単位。
<設定例>5分毎に集計を行いレコードの追加をする場合
<設定例>1時間毎に集計を行いレコードの追加をする場合
|
|||||||||||||||||||||||||||||
SummaryType (指定無し) |
CSV/ODBC |
|
集計方法の指定。
<設定例>全てのフィールドの集計方法を平均値にする場合
<設定例>フィールド毎に集計方法を指定する場合
この場合、タグフィールドマスタでは以下のように集計方法を指定します。
|
|||||||||||||||||||||||||||||
SummaryParam (指定無し) |
CSV/ODBC |
|
集計パラメータの指定。
<設定例>全てのフィールドの集計方法がADDINGCOUNTで、境界値を設定する場合
<設定例>フィールド毎に集計方法を指定する場合
この場合、タグフィールドマスタでは以下のように集計方法を指定します。
|
|||||||||||||||||||||||||||||
SummaryOffset (0) |
CSV/ODBC |
集計時間をオフセットしたい場合に本パラメータを指定します。
SummaryOffsetの単位(時間、日など)は、SummaryUnitで指定した単位(MIN、HOUR、DAYなど)を元に下記の単位が採用されます。例えば、「SummaryUnit=1MONTH」の場合、MONTHが指定されているため、SummaryOffsetの単位は1日単位となり、「SummaryOffset=1」とすると1日オフセットされます。
<設定例>日報集計で当日8:00から24時間分のデータを集計する場合
|
||||||||||||||||||||||||||||||
CalculationType ([Expression]) |
CSV/ODBC |
計算ログをとりたい場合、計算方法を指定します。計算フィールドについては「計算フィールドマスタ」を参照して下さい。
<設定例>計算フィールドマスタの[Expression]列に従って演算する。
<設定例>計算フィールドマスタの[SummaryType]列に従って集計する。
計算フィールドマスタの設定例。
|
||||||||||||||||||||||||||||||
CalculationParam (指定無し) |
CSV/ODBC |
|
計算ログの集計パラメータの指定。
<設定例>全ての計算フィールドの集計方法がAVERAGEで、0を演算から無視したい場合
<設定例>フィールド毎に集計方法を指定する場合
計算フィールドマスタの設定例。
|
|||||||||||||||||||||||||||||
TimeRangeType (TYPE1) |
CSV/ODBC |
集計時にどの時間範囲で保存するかのタイプ。
|
||||||||||||||||||||||||||||||
DecimalNum (-1) |
CSV/ODBC |
小数点以下の桁数の指定。
<設定例>全てのフィールドの小数点以下の桁数を1桁にする場合
<設定例>フィールド毎に小数点以下の桁数を指定したい場合
この場合、タグフィールドマスタでフィールド毎に以下のように小数点以下の桁数を指定することができます。
|
||||||||||||||||||||||||||||||
SearchMaxPrevMins (指定無し) |
CSV/ODBC |
本パラメータを指定すると、集計方法(ADDINGCOUNT/ADDINGTIME/ADDINGTIME2/ADDINGPULSE)にて、集計時に指定した分単位の期間までさかのぼって検索して有効な値が見つからなかった場合、前回値が存在しないものとして算出します。指定を行わなかった場合、有効な値が見つかるまでさかのぼって検索します。
<設定例>
|
||||||||||||||||||||||||||||||
CsvFileName (指定無し) |
CSV |
必須 |
ログを保存するCSVファイル名。実際のファイル名はCsvFileUnitの設定に従い末尾に日付が付加されます。サマリフォルダからの相対パスで指定します。また、他のルートログや集計ログと同じフォルダを指定しないで下さい。
<設定例>
|
|||||||||||||||||||||||||||||
CsvFileUnit (DAY) |
CSV |
ファイルの保存単位を指定します。
<設定例>
|
||||||||||||||||||||||||||||||
CsvSearchMaxPrevRecords (10000) |
CSV |
積算値(ADDINGCOUNT)を求める場合、指定したレコード検索しても値が見つからなかった場合、前回値を0として算出します。指定を行わなかった場合、10000がデフォルト値になります。
<設定例>
|
||||||||||||||||||||||||||||||
OdbcSearchMaxPrevRecords (100) |
ODBC |
積算値(ADDINGCOUNT)を求める場合、指定したレコード検索しても値が見つからなかった場合、前回値を0として算出します。指定を行わなかった場合、100がデフォルト値になります。
<設定例>
|
||||||||||||||||||||||||||||||
OdbcTable (指定無し) |
ODBC |
必須 |
ログを保存するODBCデータベースのテーブル名。
<設定例>
|
|||||||||||||||||||||||||||||
SummaryASync (F) |
ODBC |
集計の同期モード。
<設定例>
|
レポート機能関連
パラメータ名 (デフォルト値) |
対象 |
必須 |
解説 |
|||||||||||||
ReportLayoutMaster (指定無し) |
CSV/ODBC |
必須 |
レイアウトマスターファイルのパス。サマリフォルダからの相対パスで指定します。
<設定例>1年分保持の場合
|
|||||||||||||
ReportLayoutMasterSheet (指定無し) |
CSV/ODBC |
|
印刷時に使用するシート名。
<設定例>
|
|||||||||||||
ReportOutputSheetName (指定無し)
|
CSV/ODBC |
|
サブレポートとしてExcelファイル出力した場合のシート名の名称。
<設定例>
|
|||||||||||||
ReportPrinter ((default)) |
CSV/ODBC |
|
レポート印刷時使用するプリンタ名。OSに設定されたデフォルトのプリンタを使用したい場合は「(default)」を指定します。
<設定例>
|
|||||||||||||
ReportExcel (F) |
CSV/ODBC |
|
レイアウトマスターファイル内で計算式やグラフを使用するかの設定。
<設定例>
|
|||||||||||||
ReportTitleHeader (指定無し) |
CSV/ODBC |
|
レポートのタイトルのヘッダ。
<設定例>
|
|||||||||||||
ReportTitleFooter (指定無し) |
CSV/ODBC |
|
レポートのタイトルのフッタ。
<設定例>
|
|||||||||||||
ReportTitleTotal (指定無し) |
CSV/ODBC |
|
レポートの集計行に表示するタイトル文字列(合計)を指定します。レイアウトマスターにキーワード(**F_TitleTotal)を指定すると、印刷時やExcelファイル出力時に本プロパティの値が出力されます。尚、サマリレポートグリッドコントロールのTitleTotalに文字列を指定した場合は、画面表示時はそちらが優先されます。 |
|||||||||||||
ReportTitleAverage (指定無し) |
CSV/ODBC |
|
レポートの集計行に表示するタイトル文字列(平均)を指定します。レイアウトマスターにキーワード(**F_TitleAverage)を指定すると、印刷時やExcelファイル出力時に本プロパティの値が出力されます。尚、サマリレポートグリッドコントロールのTitleAverageに文字列を指定した場合は、画面表示時はそちらが優先されます。 |
|||||||||||||
ReportTitleMax (指定無し) |
CSV/ODBC |
|
レポートの集計行に表示するタイトル文字列(最大)を指定します。レイアウトマスターにキーワード(**F_TitleMax)を指定すると、印刷時やExcelファイル出力時に本プロパティの値が出力されます。尚、サマリレポートグリッドコントロールのTitleMaxに文字列を指定した場合は、画面表示時はそちらが優先されます。 |
|||||||||||||
ReportTitleMin (指定無し) |
CSV/ODBC |
|
レポートの集計行に表示するタイトル文字列(最小)を指定します。レイアウトマスターにキーワード(**F_TitleMin)を指定すると、印刷時やExcelファイル出力時に本プロパティの値が出力されます。尚、サマリレポートグリッドコントロールのTitleMinに文字列を指定した場合は、画面表示時はそちらが優先されます。 |
|||||||||||||
ReportTitleLoadFactor (指定無し) |
CSV/ODBC |
|
レポートの集計行に表示するタイトル文字列(負荷率)を指定します。レイアウトマスターにキーワード(**F_TitleLoadFactor)を指定すると、印刷時やExcelファイル出力時に本プロパティの値が出力されます。尚、サマリレポートグリッドコントロールのTitleLoadFactorに文字列を指定した場合は、画面表示時はそちらが優先されます。 |
|||||||||||||
ReportExcelCellFormatType (formatednum) |
CSV/ODBC |
|
Excelへ出力するときのセルの書式設定。詳しくは「対応可能なExcelのセル書式について」を参照して下さい。
<設定例>
|
|||||||||||||
ReportOffset (0) |
CSV/ODBC |
|
レポート表示にて表示開始時刻(日時)を変更したい時に指定します。本パラメータにマイナスの数値を指定することはできません。
ReportOffsetの単位(時間、日など)は、SummaryUnitで指定した単位(MIN、HOUR、DAYなど)を元に下記の単位が採用されます。例えば、「SummaryUnit=1HOUR」の場合、HOURが指定されているため、ReportOffsetの単位は1時間単位となり、「ReportOffset=1」とすると1時間オフセットされます。
<設定例>当日8:00から翌7時までの24時間分のデータを表示
|
|||||||||||||
(0) |
CSV/ODBC |
レポートのリファレンス時刻(日時)を変更したい時に指定します。
通常、リファレンス時刻と実際のデータの時刻は同じ時系列ですが、集計データを参照する際に指定する日時と参照されるデータの日時をずらしたい場合に本パラメータを指定してください。例えば、月報の集計ログセクションで本パラメータに「1」を設定した場合、リファレンス時刻には1ヶ月加算された日時が渡されてくるものとして処理されます(例えば、リファレンス時刻に4月が指定された場合は3月の集計データが採用されます)。
リファレンス時刻(オフセット後の時刻)は下記のメソッド及びイベントパラメータの開始リファレンス時刻、終了リファレンス時刻で使用されます。 ・メソッド:CreateReport / PrintReport / CreateSubReport / GridLoadReport ・イベント:CREATESUBREPORT / PRINTREPORT
イベントでの相対時刻での開始リファレンス時刻及び終了リファレンス時刻の指定ではキーワード"[REFERENCEOFFSET]"を指定すると、ReferenceOffsetで指定した値がプラスマイナス記号とともに埋め込まれます。
例)イベントパラメータの開始時刻及び終了時刻の指定例 日報 : ...,DAY-1D[REFERENCEOFFSET]D,DAY[REFERENCEOFFSET]D,... 月報 : ...,MONTH-1MO[REFERENCEOFFSET]MO,MONTH[REFERENCEOFFSET]MO,... 年報 : ...,YEAR+1Y[REFERENCEOFFSET]Y,YEAR[REFERENCEOFFSET]Y,...
尚、ReferenceOffsetの単位(時間、日など)はSummaryUnitで指定した単位(MIN、HOUR、DAYなど)を元に下記の単位が採用されます。例えば、「SummaryUnit=1HOUR」の場合、HOURが指定されているため、ReferenceOffsetの単位は1日単位となり、「ReferenceOffset=1」とすると1日オフセットされます。
<設定例>月報のリファレンス時刻を1カ月加算した日時で指定したい場合
■リファレンス時刻とは
リファレンス時刻とは、集計データにアクセスする各種機能から、処理の対象とする集計データを範囲指定する際に指定する日時のことを指します。例えば日報画面などから日報、月報、年報などの集計データを取得して画面に表示するような場面では、参照したいレポートの日付を画面から指定する事によって対象の集計データの表示が行われますが、ここで指定する日付がリファレンス時刻です。
例えば、月報の集計ログセクションにReportOffsetパラメータで以下のように設定した場合、生成される月報集計データは10日から翌月9日までのデータとなります。
[DAY::MONTH] SummaryUnit=1DAY ReportOffset=10
上記でReferenceOffcetを指定しなかった場合、PRINTREPORTなどの開始リファレンス時刻に「4月」、終了リファレンス時刻に「5月」を指定すると、処理の対象となる月報データは4月10日~5月9日までのデータとなります。ユーザ要件としてこの仕様で問題がない場合は、特にReferenceOffsetパラメータを指定する必要はありません。
一方、ユーザ要件などにより、4月10日~5月9日までの月報データを、「4月」ではなく「5月」として扱いたいような場合は、以下のようにReferenceOffcetパラメータを使用します。
[DAY::MONTH] SummaryUnit=1DAY ReportOffset=10 ReferenceOffset=1
上記のように設定することにより、PRINTREPORTなどの開始リファレンス時刻に「5月」、終了リファレンス時刻に「6月」指定すると、処理の対象となる月報データは4月10日~5月9日までのデータとなります。
|
||||||||||||||
ReportTitleDateFormat (指定無し) |
CSV/ODBC |
|
レポートの日付の書式。印刷及び画面表示時に使用される日付の書式です。
▪サマリレポートグリッドコントロールのTitleDateFormatに書式を指定すると画面表示時そちらが優先されます。 ▪印刷時やExcelファイル出力時には日付のデータ型が文字列型として出力されます。ReportTitleDateFormatに何も指定しないと、データ型が日付型で出力されます。ただし、その場合サマリレポートグリッドコントロールのTitleDateFormatに書式を指定する必要があります。 ▪本パラメータには、日時書式(フリー書式)を指定することができます。書式の詳細については「日時書式(フリー書式)」を参照してください。
<設定例>日報にて0-23時で表示
<設定例>日報にて1-24時で表示
<設定例>月報を曜日付きで表示
<設定例>月報を曜日無しで表示
<設定例>年報で月を表示
|
|||||||||||||
ReportReferenceDateFormat (指定無し) |
CSV/ODBC |
|
印刷時に使用されるレポートの参照日付の日時書式を指定することができます。 書式の詳細については「日時書式(フリー書式)」を参照してください。
|
クオリティチェック機能関連
サマリアクションのクオリティチェック機能を有効にすると、集計元データが欠損している場合や不信頼値が含まれている場合に、集計データを「*123」などの不信頼値として扱うことができます。クオリティチェック機能の詳細については、「クオリティチェック機能を使用する」を参照してください。 |
パラメータ名 (デフォルト値) |
対象 |
必須 |
解説 |
|||||||||||||||
QualityCheckRequiredRecords (0) |
CSV/ODBC |
|
集計レコード毎に必要とする元データの件数。例えば、生データを1分周期でロギングしている場合、1時間分のレコード数は60件となる。
本パラメータを定義すると、例えば生データから日報集計を行う際に、1時間分の集計対象データの件数が本パラメータで指定した件数と一致しなかった場合を異常とみなし、集計結果のデータに不信頼値フラグ「*」が付与されます。本パラメータを定義しなかった場合、又は本パラメータに0を指定した場合は、集計対象データ件数によるチェックを行いません。
本パラメータは、生データを元に集計を行う集計ログセクションのみに指定してください(例、[RAW::DAY])。
<設定例>
|
|||||||||||||||
QualityCheckType (NONE)
|
CSV/ODBC |
|
タグフィールドマスタおよび計算フィールドマスタ(サマリマスタの集計ログセクションで「CalculationType=[SummaryType{n}]」が指定されている場合)におけるクオリティチェックのタイプ。複数の条件を適用したい場合は、カンマで列挙する。例)NULLTOBAD,BADTOBAD
「XxxTONULL,XxxTOBAD」のように複数の条件を指定した場合、両条件とも成立した場合は(NULLレコードが存在し、不信頼値も存在した場合)、XxxTONULLが優先されます。 尚、TermOfValidityが設定されているフィールドはクオリティチェックの対象外となり、NONEと同等の動作となります。
<設定例>
|
|||||||||||||||
QualityCheckTypeFieldMaster (指定無し)
|
CSV/ODBC |
|
タグフィールドマスタおよび計算フィールドマスタ(「CalculationType=[SummaryType{n}]」が指定されている場合)で、フィールド毎に個別にQualityCheckTypeを指定したい場合は、本パラメータにタグフィールドマスタ(および計算フィールドマスタ)の列名を指定する。
<設定例>
|
|||||||||||||||
ExpressionQualityCheckType (NONE)
|
CSV/ODBC |
|
計算フィールドマスタ(「CalculationType=[Expression]」が指定されている場合)での演算式におけるクオリティーチェックのタイプ。複数の条件を適用したい場合は、カンマで列挙する。 例)NULLTOBAD,BADTOBAD
「XxxTONULL,XxxTOBAD」のように複数の条件を指定した場合、両条件とも成立した場合は(NULLレコードが存在し、不信頼値も存在した場合)、XxxTONULLが優先されます。 尚、計算フィールドマスタの[UncertainIsZero]列に「F」を指定した場合は、NULL値が存在した場合の計算結果はNULLとなります。本件の詳細については、「計算フィールドマスタ」の記述を参照してください。
<設定例>
|
|||||||||||||||
ExpressionQualityCheckTypeFieldMaster (指定なし)
|
CSV/ODBC |
|
計算フィールドによる静的演算において、フィールド毎に個別にExpressionQualityCheckTypeを指定したい場合は、計算フィールドマスタの列名を指定する。
<設定例>
|
集計ログセクションの設定例
例)CSVファイルへ保存する場合の最小設定
[RAW::AVERAGE] CsvFileName=DB\AVRAGE\SMR_AVERAGE_.csv CsvFileUnit=DAY SummaryType=AVERAGE SummaryUnit=1MIN |
例)ODBCデータベースへ保存する場合の最小設定
[RAW::AVERAGE] ODBCTable=AVERAGETABLE SummaryType=AVERAGE SummaryUnit=1MIN |
例)レポート機能を使用する場合の最小設定
[RAW::DAY] CsvFileName=DB\DAY\SMR_DAY_.csv CsvFileUnit=DAY DecimalNum=[DecimalNum1] TimeRangeType=TYPE2 SummaryType=[SummaryType1] SummaryParam=[SummaryParam1] SummaryUnit=1HOUR ReportLayoutMaster=layoutmaster.xls ReportLayoutMasterSheet=DAY ReportTitleDateFormat=@[%H時] |
例)計算フィールドを使用する場合の追加項目
[RAW::DAY] ・・・ CalculationType=[Expression] ・・・
[DAY::MONTH] ・・・ CalculationType=[SummaryType1] ・・・
[MONTH::YEAR] ・・・ CalculationType=[SummaryType1] ・・・
|
例)クオリティチェック機能を使用する場合の設定例(※RAWデータが1分周期の場合)
[RAW::DAY] QualityCheckRequiredRecords=60 QualityCheckType=NULLTOBAD QualityCheckTypeFieldMaster=[QualityCheckType1] ExpressionQualityCheckType=NULLTOBAD ExpressionQualityCheckTypeFieldMaster=[ExpressionQualityCheckType1]
[DAY::MONTH] QualityCheckType=NULLTOBAD QualityCheckTypeFieldMaster=[QualityCheckType1] ExpressionQualityCheckType=NULLTOBAD ExpressionQualityCheckTypeFieldMaster=[ExpressionQualityCheckType1]
[MONTH::YEAR] QualityCheckType=NULLTOBAD QualityCheckTypeFieldMaster=[QualityCheckType1] ExpressionQualityCheckType=NULLTOBAD ExpressionQualityCheckTypeFieldMaster=[ExpressionQualityCheckType1] |
Ver6以降、ReportTitleDateFormatパラメータに指定可能な書式として、「日時書式(フリー書式)」の指定が可能となりました。このパラメータの定義は上位互換として旧書式についても動作しますが、特別な理由がない限り、日時書式(フリー書式)を指定するようにしてください。
ReportTitleDateFormatに指定が可能な旧書式は以下のとおりです。
|