ペイロード・ハンドラ・クラスおよびパラメータ
この項では、サポート対象のヘッドエンド・システムおよびペイロード・タイプに有効なペイロード・ハンドラ・クラス名および関連する動的パラメータについて説明します。
アダプタ開発キット
出荷時に、アダプタ開発キットは、AMIヘッドエンド・システムからネイティブ初期測定データ書式および設備イベント・データ書式(初期測定ビジネス・オブジェクトと設備イベント・シーダー・ビジネス・オブジェクトの書式)でエクスポートされた、使用量およびイベント・データのペイロード処理をサポートしています。詳細は、「アダプタ開発キットのネイティブ書式」を参照してください。
ペイロード・タイプ: ADK CSV
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.dg.processing.CSVPayloadHandler
ペイロード・タイプ: ADK XML
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.dg.processing.XMLPayloadHandler
ペイロード・タイプ: ADKシーダー
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.dg.processing.SeederPayloadHandler
カスタムおよび標準外書式の処理
アダプタ開発キットは、AMIヘッドエンド・システムからのデータのペイロード処理をカスタムおよび標準外書式でサポートするように構成できます。このタイプのペイロードの処理では、データを解析してネイティブ書式に変換するために、特定のペイロード・ハンドラ・クラス(次を参照)およびGroovyライブラリ・スクリプトの作成が必要です。詳細は、「アダプタ開発キットのカスタム・ペイロード処理」および「ペイロード処理ユーザー・イグジット・インターセプタ・スクリプト」を参照してください。
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.dg.processing.PayloadHandlerViaUserExits
アダプタ開発キットでは、共通情報モデル(CIM)書式のデータのペイロード処理もサポートされています。詳細は、「アダプタ開発キットの共通情報モデル(CIM)ペイロード処理」を参照してください。
Itron OpenWayのアダプタ
ペイロード・タイプ: Itron OpenWay XML
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d8.processing.ItronXMLPayloadHandler
- 動的パラメータ:
動的パラメータ名 |
説明および有効な値 |
---|---|
intervalValueDecPlaces |
オプション値。数量値の小数点以下の桁数を指定します。このパラメータが欠落している場合、処理ロジックでは小数点以下の桁数がデフォルトの6に設定されます。 |
filterRegisterSource |
オプション値。ソース指針データをフィルタする必要があるかどうかを設定します。有効な値は、trueおよびfalse(デフォルト)です |
ペイロード・タイプ: Itron OpenWay例外
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d8.processing.ExceptionPayloadHandler
MV90 Adapter for Itron
ペイロード・タイプ: MV90
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d5.processing.MV90PayloadHandler
- 動的パラメータ:
動的パラメータ名 |
説明および有効な値 |
---|---|
usePhysicalChannel |
オプション値。物理チャネルIDをIMDシーダーに渡して計量コンポーネント識別子番号を作成するかどうかを設定します。falseに設定すると、MV90 LOGCHANフィールドが使用されます。 |
fieldForDvcIdN |
オプション値。設備IDの値として使用されるフィールドを指定します。有効な値は次のとおりです。
|
MV90ScalarChannelSuffix |
オプション値。検針指針に対するスカラー初期測定データが作成された場合に計量コンポーネント識別子番号に追加されるサフィックス値を保持します。デフォルト値は_Sです。 |
processMV90ScalarData |
オプション値。検針指針が処理されるかどうかを設定します。有効な値は、trueおよびfalse(デフォルト)です。 |
sendStatusAsIs |
オプション値。ステータス・コードがヘッドエンドから取得される場合に、ステータス・コードが渡されるかどうかを決定します。これをfalseに設定するか、指定されない場合は、ステータス・コードが解析されてビットがオンの初期測定データ・シーダーにステータス・タイプが渡されるときに、デフォルトの既存の動作が実行されます。有効な値は、trueおよびfalse(デフォルト)です。 |
MV90DateFormat |
オプション値。入力された日時フィールドを解析するのに使用される日付書式を保持します。コードでは、書式の限定された値リストをサポートします。このパラメータが欠落している場合、または入力された値がこのリストの値と一致しない場合、使用される書式はデフォルト値のMMDDYYhhmmです。有効な値は次のとおりです。
|
MV90IntervalValueDecPlaces |
オプション値。数量値の小数点以下の桁数を指定します。このパラメータが欠落している場合、処理ロジックでは小数点以下の桁数がデフォルトの6に設定されます。 |
MV90StrtmtrAndStopmtrToDecimal |
オプション値。MV90 STRTMTR (前回検針メーター)およびSTOPMTR (今回検針メーター)が小数に変換されるかどうかを決定します。処理ロジックでは、これらのフィールドを小数として処理し、設定を使用して必要な小数桁数を決定します。 |
Landis+Gyrのアダプタ
ペイロード・タイプ: L+G使用
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d3.processing.LGUsagePayloadHandler
- 動的パラメータ:
動的パラメータ名 |
説明および有効な値 |
---|---|
dateTimeInUTC |
Landis+Gyrシステムが、日時情報をUTC (true)または設備のローカル時間(false)のいずれで送信するかを示します。指定されない場合のデフォルト動作は、設備のローカル時間になります。有効な値は、trueおよびfalse(デフォルト)です |
ペイロード・タイプ: L+Gイベント
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d3.processing.LGEventPayloadHandler
- 動的パラメータ:
動的パラメータ名 |
説明および有効な値 |
---|---|
dateTimeInUTC |
Landis+Gyrシステムが、日時情報をUTC (true)または設備のローカル時間(false)のいずれで送信するかを示します。指定されない場合のデフォルト動作は、設備のローカル時間になります。有効な値は、trueおよびfalse(デフォルト)です |
ペイロード・タイプ: L+G CIMイベント
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d3.processing.LGCIMEventPayloadHandler
- 動的パラメータ: 該当なし
Sensusのアダプタ
ペイロード・タイプ: Sensus RNI使用
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d6.processing.SensusUsagePayloadHandler
- 動的パラメータ:
動的パラメータ名 |
説明および有効な値 |
---|---|
dateTimeInUTC |
Sensus RNIシステムが日時情報をUTC (true)または設備のローカル時間(false)のいずれで送信しているかを示します。指定されない場合のデフォルト動作は、設備のローカル時間になります。有効な値は、trueおよびfalse(デフォルト)です。 |
useExternalTOU |
スカラー使用にのみ適用されます。 測定データの処理時に外部参照TOU期間を使用する必要があるかどうかを示します。 trueに設定した場合は、Sensusが提供するTOU期間は、外部TOU "preVEE/externalTOU"としてIMDシーダーに渡されます。指定しないかfalseに設定した場合は、Sensusが提供するTOU期間は、外部計量コンポーネント識別子番号"preVEE/mcIdN"としてIMDシーダーに渡されます。有効な値は、trueおよびfalse(デフォルト)です。 |
sendStatusAsIs |
ヘッドエンドから受信したステータス・コードが渡されるかどうかを決定します。trueに設定した場合は、ヘッドエンドから受信したステータス・コードが送信されます。指定しないかfalseに設定した場合は、ヘッドエンドからのステータス・コードはビット・マスクを介して処理され、複数の個別のステータスが生成されます。有効な値は、trueおよびfalse(デフォルト)です。 |
sendIntervalDateTimes |
trueに設定した場合、インターバル・レコードのIMDシーダーの"preVEE/msrms/mL/dt"要素にはインターバル日時が移入され、"preVEE/enDt"要素には最後のインターバルのインターバル日時が移入されます。指定しないかfalseに設定した場合、インターバル・レコードのIMDシーダーの"preVEE/msrms/mL/dt"要素は移入されず、"preVEE/enDt"要素には開始日 + SPI * インターバル数が移入されます。有効な値は、trueおよびfalse(デフォルト)です。 |
scalarExpanding |
オプション値。スカラー・ペイロードで処理する検針指針の数を定義します。定義した場合、Sensusのペイロード処理ではこの設定を使用して、ペイロードに含まれるすべてのスカラー検針が処理されるようにします。 デフォルト値は2です。 |
ペイロード・タイプ: Sensus RNIイベント
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d6.processing.SensusEventPayloadHandler
- 動的パラメータ:
動的パラメータ名 |
説明および有効な値 |
---|---|
dateTimeInUTC |
Sensus RNIシステムが日時情報をUTC (true)または設備のローカル時間(false)のいずれで送信しているかを示します。指定されない場合のデフォルト動作は、設備のローカル時間になります。有効な値は、trueおよびfalse(デフォルト)です |
Silver Spring Networksのアダプタ
ペイロード・タイプ: Silver Spring Networks CSV
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d7.processing.SSNCSVPayloadHandler
ペイロード・タイプ: Silver Spring Networks XML
- ペイロード・ハンドラ・クラス: com.splwg.d1.domain.sgg.d7.processing.SSNXMLPayloadHandler
共通パラメータ
次のパラメータは、サポート対象のすべてのヘッドエンド・システム・アダプタで使用できます。
動的パラメータ名 |
説明および有効な値 |
---|---|
suppressPayloadStatistics |
オプション・パラメータ。ペイロードの処理時にPayloadStatisticsビジネス・オブジェクトが作成されないかどうかを決定します。これをfalseに設定するか、指定されない場合は、ペイロード処理の開始時にPayloadStatisticsビジネス・オブジェクトが作成されるとき、デフォルトの既存の動作が実行されます。有効な値は、trueおよびfalse(デフォルト)です。 |
suppressPayloadErrorNotification |
オプション・パラメータ。ペイロードの処理時にエラーが発生した場合に、PayloadErrorNotificationビジネス・オブジェクトが作成されないかどうかを決定します。これをfalseに設定するか、指定されない場合は、ペイロード処理時に発生したすべてのエラーに対してPayloadErrorNotificationビジネス・オブジェクトが作成されるとき、デフォルトの既存の動作が実行されます。これをfalseに設定すると、エラー説明がアプリケーション・ログ・ファイルに書き込まれます。有効な値は、trueおよびfalse(デフォルト)です。 |
suppressPayloadSummary |
オプション・パラメータ。ペイロードの処理時にPayloadSummaryビジネス・オブジェクトが作成されないかどうかを決定します。これをfalseに設定するか、指定されない場合は、ペイロード処理の終了時にPayloadSummaryビジネス・オブジェクトが作成されるとき、デフォルトの既存の動作が実行されます。有効な値は、trueおよびfalse(デフォルト)です。 |
commitSizeInKB |
オプション・パラメータ。コミット前に設備イベントおよびIMDシーダーに割り当てられるメモリーの合計量(KB)を指定します。シーダーは、そのサイズがこのパラメータに定義された値を超えるか、ペイロードの終わりに達するまでメモリー内に保持されます。 デフォルト値は100です。 注意: chunkSizeパラメータが設定されている場合、このパラメータ(デフォルト値または指定した値)は無視されます。 |
chunkSize |
オプション・パラメータ。単一バッチ・スレッドで処理されるペイロードの部分(チャンク)のサイズをバイト単位で指定します。 パラメータが設定されている場合、commitSizeInKBパラメータは無視されます。 このパラメータは、次のペイロード書式でサポートされています。
|