共通プロパティセクション

<< Click to Display Table of Contents >>

マニュアル > サーバ作成ガイド > アクション編 > アクションリファレンス > サマリアクション(ロギング/集計/日報) > サマリアクションの設定ファイルとフォルダ構成 > サマリマスタ >

共通プロパティセクション

共通プロパティセクション プロパティ一覧

ログ機能関連

パラメータ名

(デフォルト値)

対象

必須

解説

DaysOfHoldingData

(0)

CSV/ODBC

 

全てのログデータ、集計データに対する、デフォルトのデータ保持日数。

設定値

内容

0

永久保持

1以上

保持する日数

 

<設定例>1年分保持の場合

DaysOfHoldingData =365

 

hint

各ログ毎に異なるデータの保持日数を指定したい場合は、ログセクション毎にDaysOfHoldingDataを指定してください。[COMMON]と各ログセクションの両方にDaysOfHoldingDataが指定されていた場合、ログセクションの設定が優先されます。

 

TermOfValidityDefinition{n}

(指定無し)

 

CSV/ODBC

 

ログをとる有効期間の定義。ある期間のみデータを収集したい場合に定義します。この期間定義は{n}の部分に番号を指定することにより複数定義できます。この有効期間番号をタグフィールドマスタの[TermOfValidity]列に指定することにより、タグ毎にデータの保存をしたい期間を指定できます。書式は以下になります。

 

TermOfValidityDefinition{n}=yyyy/mm/dd h:m:s - yyyy/mm/dd h:m:s [Wx]

{n}は1からはじまる有効期間番号。

&&で複数の書式のAndを取れます。
例)xxx && xxx && xxx

||で複数の書式のOrを取れます。
例)xxx || xxx || xxx

複数のAnd条件のOrを取れます。
例)xxx && xxx || xxx && xxx || xxx && xxx

括弧()や+-*/など、前述の演算子以外は使用できません。

[Wx]にて曜日指定が可能。xには 1:日曜,2:月曜,4:水曜...,64:土曜 のOrを指定。

 

<設定例>1:昼時間帯2:夜時間帯とした場合

TermOfValidityDefinition1=*/*/* 8:*:* - */*/* 21:*:*

TermOfValidityDefinition2=*/*/* 22:*:* - */*/* 7:*:*

<設定例>1:昼時間帯2:夜時間帯3:ピーク時間帯とした場合(季節による時間帯を加味する場合)

TermOfValidityDefinition1=*/7/1 *:*:* - */9/30 *:*:* && */*/* 8:*:* - */*/* 12:*:* || */7/1 *:*:* - */9/30 *:*:* && */*/* 16:*:* - */*/* 21:*:* || */10/1 *:*:* - */6/30 *:*:* && */*/* 8:*:* - */*/* 21:*:*

TermOfValidityDefinition2=*/*/* 22:*:* - */*/* 7:*:*

TermOfValidityDefinition3=*/7/1 *:*:* - */9/30 *:*:* && */*/* 13:*:* - */*/* 15:*:*

 

hint

TimeRangeTypeがTYPE2であっても、TYPE1である場合を想定して定義して下さい。TYPE2を指定した場合、以下の例のように自動的に時間帯が調整されます。

例1) */*/* 8:*:* - */*/* 22:*:*

TYPE1の場合8:00:00-22:59:59、TYPE2の場合8:00:01-23:00:00に調整されます。

 

例2) */*/* 8:0:0 - */*/* 22:59:59

TYPE2の場合、自動的に8:00:01-23:00:00に調整されます。

 

例3) */*/* *:*:* - */*/* *:*:* W62

月~金。TYPE1の場合、該当日00:00:00-該当日23:59:59、TYPE2の場合、該当日00:00:01-該当日翌日00:00:00)

 

例4) */7/1 *:*:* - */9/30 *:*:* && */*/* 8:*:* - */*/* 22:*:*

7/1~9/30で時間帯は例1と同様。

 

TermOfValidityType

(TYPE1)

CSV/ODBC

 

TermOfValidityDefinitionを使用してデータ収集/集計の時間帯を指定する場合に、その処理方法を指定します。このパラメータは、積算カウンタ値(ADDINGCOUNT)/積算時刻値(ADDINGTIME)/積算パルス値(ADDINGPULSE)による積算処理に影響します。

 

設定値

内容

TYPE1

積算の集計処理において、集計対象となる時間帯以外に変化した値も積算されます。

TYPE2

積算の集計処理において、集計対象となる時間帯以外に変化した値は積算されません。例えば、使用量などの計量データを昼夜別々に集計したいような場合には、「TYPE2」を指定するようにしてください。

 

<設定例>

TermOfValidityType=TYPE2

 

PowerfactorMaxMinType

(TYPE1)

CSV/ODBC

 

力率の最大値と最小値の計算方法。

設定値

内容

TYPE1

最小値:マイナス方向の-0.5に近い力率 / 最大値:プラス方向の0.5に近い力率

TYPE2

最小値:絶対値が1(100%)に一番遠い力率 / 最大値:絶対値が1(100%)に一番近い力率

 

<設定例>

PowerfactorMaxMinType=TYPE2

 

AddingCountIgnoreType

(TYPE1)

CSV/ODBC

 

IGNOREZERO/IGNORENUMを集計方法のADDINGCOUNTで指定した場合の集計方法。

設定値

内容

TYPE1

集計範囲ですべての値が除外対象の場合、集計値が0となる

TYPE2

集計範囲ですべての値が除外対象の場合、集計値が無効値(NULL)となる

 

<設定例>

AddingCountIgnoreType=TYPE2

 

MaintenanceASync

(T)

CSV/ODBC

 

メンテナンス(自動削除)の同期モード。

設定値

内容

T

非同期

F

同期

 

<設定例>

MaintenanceASync=F

 

MaintenanceDelayTime

(610)

CSV/ODBC

 

メンテナンス実行の日替わりからの遅延時間(秒)。

設定値

内容

0

日替わり直後に実行

1以上

日替わりからの遅延時間(秒)

 

<設定例>

MaintenanceDelayTime=0

 

MaintenanceStartup

(F)

CSV/ODBC

 

オンライン直後にもメンテナンスを行うか。

設定値

内容

T

メンテナンスを行う。

F

メンテナンスを行わない。

 

<設定例>

MaintenanceStartup=T

 

OdbcDatabaseType

(指定無し)

 

ODBC

必須

ODBCデータベースのタイプ。指定できるデータベースタイプは以下です。

データベース製品名

データベースタイプ

SQL Server

SQLSERVER

Oracle

ORACLE

MySQL

MYSQL

PostgreSQL

POSTGRESQL

※対応バージョンは、動作環境をご確認下さい。

 

<設定例>

OdbcDatabaseType=SQLSERVER

 

OdbcSchema

(指定無し)

 

ODBC

 

ODBCデータベースのスキーマ名。データベースのデフォルトのスキーマ以外を使用する場合に設定してください。

 

<設定例>

OdbcSchema=XXX(指定したいスキーマ名)

 

attention

MySQLと接続する場合は本パラメータは指定しないでください。

 

OdbcCreatedTimeFieldName

(CREATEDTIME)

 

ODBC

 

時刻フィールドのフィールド名。通常は本設定は必要はありません。

 

<設定例>

OdbcCreatedTimeFieldName=XXX(指定したいフィールド名)

 

attention

Rev7よりOdbcDateTimeFieldNameから名称が変更となりました。旧名称でも動作します。

 

OdbcCreatedTimeDataType

(OdbcDatabaseTypeにより自動選択)

 

ODBC

 

時刻フィールドのデータ型。通常は本設定は必要はありません。

データベースタイプ

デフォルト値

SQLSERVER

DATETIME PRIMARY KEY

ORACLE

DATE PRIMARY KEY

MYSQL

DATETIME PRIMARY KEY

POSTGRESQL

TIMESTAMP PRIMARY KEY

 

<設定例>

OdbcCreatedTimeDataType=XXX(指定したいデータ型)

 

attention

Rev7よりOdbcDateTimeDataTypeから名称が変更となりました。旧名称でも動作します。

 

OdbcFaultedTimeFieldName

(FAULTEDTIME)

ODBC

 

二重化時にサブ側への保存が出来ない場合、同期用の時刻フィールド名。通常は本設定は必要はありません。

 

<設定例>

OdbcFaultedTimeFieldName=XXX(指定したいフィールド名)

 

OdbcFaultedTimeDataType

(OdbcDatabaseTypeにより自動選択)

ODBC

 

二重化時にサブ側への保存が出来ない場合、同期用の時刻フィールドのデータ型。通常は本設定は必要はありません。

データベースタイプ

デフォルト値

SQLSERVER

DATETIME

ORACLE

DATE

MYSQL

DATETIME

POSTGRESQL

TIMESTAMP

 

<設定例>

OdbcFaultedTimeDataType=XXX(指定したいデータ型)

 

OdbcValueFieldName

(空文字)

ODBC

 

値フィールドのフィールド名。通常は本設定は必要はありません。

 

hint

本設定を指定をした場合、タグフィールドマスタのフィールド名の頭に付加されます。例えば以下のように設定した場合、データベースのテーブルに定義するフィールド名は「ABCF0001」「ABCF0002」となります。

<設定例>サマリマスターファイル

OdbcValueFieldName=ABC

<設定例>タグフィールドマスターファイル

[Name],[Tag]

F001,U01.F01.T000

F002,U01.F01.T001

 

OdbcValueDataType

(OdbcDatabaseTypeにより自動選択)

ODBC

 

値フィールドのデータ型。通常は本設定は必要はありません。

データベースタイプ

デフォルト値

SQLSERVER

FLOAT

ORACLE

BINARY_DOUBLE

MYSQL

DOUBLE

POSTGRESQL

DOUBLE PRECISION

 

<設定例>

OdbcValueDataType= XXX(指定したいデータ型)

 

OdbcRestoreASync

(T)

ODBC

 

修復の同期モード。通常は本設定は必要はありません。

設定値

内容

T

非同期

F

同期

 

<設定例>

OdbcRestoreASync=F

 

OdbcRestoreThreadQueue

(0)

ODBC

 

修復時に利用する最大スレッド数。通常は本設定は必要はありません。

設定値

内容

0

データベースによる

1以上

最大スレッド数

 

<設定例>

OdbcRestoreThreadQueue=4

 

OdbcRestoreInsertQueue

(0)

ODBC

 

修復時のINSERT文のキューの数。通常は本設定は必要はありません。

設定値

内容

0

データベースによる

1以上

INSERT文のキュー数

 

<設定例>

OdbcRestoreInsertQueue=10

 

OdbcRestoreSelectLimit

(0)

ODBC

 

修復時のSELECT時の最大LIMIT数。通常は本設定は必要はありません。

設定値

内容

0

データベースによる

1以上

最大LIMIT数

 

<設定例>

OdbcRestoreSelectLimit=100

 

OdbcModifyASync

(T)

ODBC

 

再集計の同期モード。通常は本設定は必要はありません。

設定値

内容

T

非同期

F

同期

 

<設定例>

OdbcModifyASync=F

 

OdbcModifyThreadQueue

(0)

ODBC

 

再集計時に利用する最大スレッド数。通常は本設定は必要はありません。

設定値

内容

0

データベースによる

1以上

最大スレッド数

 

<設定例>

OdbcModifyThreadQueue=4

 

 

 

レポート機能関連

パラメータ名

(デフォルト値)

対象

必須

解説

ReportHeaders

(4)

CSV/ODBC

 

サマリレポートのヘッダ行数(1~5まで)。

 

<設定例>

ReportHeaders =2

 

 

 

クオリティチェック機能関連

 

hint

サマリアクションのクオリティチェック機能を有効にすると、集計元データが欠損している場合や不信頼値が含まれている場合に、集計データを「*123」などの不信頼値として扱うことができます。クオリティチェック機能の詳細については、「クオリティチェック機能を使用する」を参照してください。又、集計データがNULLだった場合に、日報画面上の表示を「***」などの指定文字列で表示したり、サブレポートのCSVやExcelファイルの出力データについてもNULL値を指定文字列にすることができます。NULL値の表示文字列の指定方法については、「NULL値の表示方法をカスタマイズする」を参照してください。

 

パラメータ名

(デフォルト値)

対象

必須

解説

StringOfNullDataForDisplay

(指定なし)

CSV/ODBC

 

集計値がNULL値の場合に、レポート画面に表示する文字列。

 

<設定例>

StringOfNullDataForDisplay=***

 

hint

本パラメータを指定しなかった場合、又はパラメータの指定をブランクにした場合は、ブランク表示となります(※「""」ではない点に注意)。

 

<ブランク表示の例>

StringOfNullDataForDisplay=

 

 

StringOfNullDataForSubReportExcel

(指定なし)

CSV/ODBC

 

集計値がNULL値の場合に、サブレポート(Excel)に出力する文字列。

 

<設定例>

StringOfNullDataForSubReportExcel=***

 

hint

ブランクの指定方法は、上記「StringOfNullDataForDisplay」と同様です。

 

StringOfNullDataForSubReportCSV

(指定なし)

CSV/ODBC

 

集計値がNULL値の場合に、サブレポート(CSV)に出力する文字列。

 

<設定例>

StringOfNullDataForSubReportCSV=***

 

hint

ブランクの指定方法は、上記「StringOfNullDataForDisplay」と同様です。

 

ShowQualityForSubReportExcel

(T)

CSV/ODBC

 

値が不信頼値の場合、不信頼値フラグ「*」をつけてサブレポート(Excel)を出力するかどうか。

 

設定値

内容

T

値が不信頼値の場合、不信頼値フラグ「*」をつける。 例)*123

F

値が不信頼値の場合、不信頼値表示を行わない。 例)123

 

<設定例>

ShowQualityForSubReportExcel=F

 

ShowQualityForSubReportCSV

(T)

CSV/ODBC

 

値が不信頼値の場合、不信頼値フラグ「*」をつけてサブレポート(CSV)を出力するかどうか。

 

設定値

内容

T

値が不信頼値の場合、不信頼値フラグ「*」をつける。 例)*123

F

値が不信頼値の場合、不信頼値表示を行わない。 例)123

 

<設定例>

ShowQualityForSubReportCSV=F

 

OdbcQualityCheckDataType

 

ODBC

 

品質チェック値を格納するフィールドのデータ型。

 

接続するDBMSの種類により、以下のデフォルト値が自動的に採用されます。通常は本設定は必要はありません。フィールドのサイズを意図的に変更したい場合などに指定します。

 

<デフォルト値>

DBMS

内容

SQLSERVER

VARCHAR(1000)

ORACLE

VARCHAR2(1000)

MYSQL

VARCHAR(1017)

POSTGRESQL

VARCHAR

 

<設定例>

OdbcQualityCheckDataType=VARCHAR(500)

 

OdbcQualityCheckFieldName

(QUALITYCHECK)

 

ODBC

 

品質チェック値を格納するフィールドのフィールド名。

 

<設定例>

OdbcQualityCheckFieldName=QUALITYCHECK

 

ActiveExpressionQualityCheckType

(NONE)

 

CSV/ODBC

 

フィールドの動的演算におけるクオリティチェックのタイプのデフォルト値。複数の条件を適用したい場合は、カンマで列挙する。

例)NULLTOBAD,BADTOBAD

 

設定値

内容

NONE

クオリティチェックを行わない。

NULLTONULL

演算データにNULL値が存在する場合はNULL値とする。

NULLTOBAD

演算データにNULL値が存在する場合は不信頼値(*123など)とする。

BADTONULL

演算データに不信頼値(*123など)が存在する場合はNULL値とする。

BADTOBAD

演算データに不信頼値(*123など)が存在する場合は不信頼値(*123など)とする。

 

「XxxTONULL,XxxTOBAD」のように複数の条件を指定した場合、両条件とも成立した場合は(NULLレコードが存在し、不信頼値も存在した場合)、XxxTONULLが優先されます。

 

動的演算に関する詳細については「フィールドの動的演算(ポイント登録時の演算式指定)」を参照してください。

 

<設定例>

ActiveExpressionQualityCheckType=NULLTOBAD

 

 

 

共通プロパティセクションの設定例

例)CSVファイルへ保存する場合の最小設定

[COMMON]

DaysOfHoldingData=365

 

例)ODBCデータベース(Microsoft SQL Server)へ保存する場合の最小設定

[COMMON]

DaysOfHoldingData=365

OdbcDatabaseType=SQLSERVER

 

例)集計値がNULLの場合に日報画面やサブレポートの表示を「***」とする場合

[COMMON]

DaysOfHoldingData=365

StringOfNullDataForDisplay=***

StringOfNullDataForSubReportExcel=***

StringOfNullDataForSubReportCSV=***