Payload Handler Classes and Parameters
This section provides valid Payload Handler Class Names and associated dynamic parameters for supported head end systems and payload types.
Adapter Development Kit
As delivered, the Adapter Development Kit supports payload processing of usage and event data exported from an AMI head end system in the “native” initial measurement and device event data formats (the format of the initial measurement and device event seeder business objects). See The Adapter Development Kit Native Format for more information.
Payload Type: ADK CSV
- Payload Handler Class: com.splwg.d1.domain.sgg.dg.processing.CSVPayloadHandler
Payload Type: ADK XML
- Payload Handler Class: com.splwg.d1.domain.sgg.dg.processing.XMLPayloadHandler
Payload Type: ADK Seeder
- Payload Handler Class: com.splwg.d1.domain.sgg.dg.processing.SeederPayloadHandler
Processing Custom and Non-Standard Formats
The Adapter Development Kit can be configured to support payload processing of data from AMI head end systems in custom and non-standard formats. Processing payloads of this type requires a specific Payload Handler Class (see below), and creation of Groovy Library Scripts to parse and transform data into the “native” format. See Adapter Development Kit Custom Payload Processing and Payload Processing User Exit Interceptor Scripts for more information.
- Payload Handler Class: com.splwg.d1.domain.sgg.dg.processing.PayloadHandlerViaUserExits
The Adapter Development Kit also supports payload processing of data in the Common Information Model (CIM) format. See Adapter Development Kit Common Information Model (CIM) Payload Processing for more information.
Common Parameters
The following parameters can be used by all of the supported head end system adapters.
|
Dynamic Parameter Name |
Description and Valid Values |
|---|---|
|
suppressPayloadStatistics |
Optional parameter. Determines if the PayloadStatistics business object will not be created while processing payload. If this set to false or not provided, then the default existing behavior when a PayloadStatistics business object is created at the start of the payload processing. Valid values are ‘true’ and ‘false’ (default). |
|
suppressPayloadError |
Optional parameter. Determines if the PayloadErrorNotification business object will not be created when an error occurs while processing payload. If this set to false or not provided, then the default existing behavior when a PayloadErrorNotification business object is created for every error occurred during the payload processing. If this set to false, the error description will be written into the application log file. Valid values are ‘true’ and ‘false’ (default). |
|
suppressPayloadSummary |
Optional parameter. Determines if the PayloadSummary business object will not be created while processing payload. If this set to false or not provided, then the default existing behavior when a PayloadSummary business object is created at the end of the payload processing. Valid values are ‘true’ and ‘false’ (default). |
|
createFilePerCommit |
Optional parameter. Determines how files are created when streaming files out to a file system or Object Storage. When set to true, streamed out files are written per commit. Valid values are ‘true’ and ‘false’ (default). |
|
commitSizeInKB |
Optional Parameter. Specifies the total amount of memory (in KB) allocated for Device Event and IMD seeders before they are committed. Seeders are kept in memory until their size exceeds the value defined for this parameter or the end of payload is reached. Default value is 100. Note: This parameter (either the default value or a specified value) is ignored when the chunkSize parameter is set. |
|
chunkSize |
Optional parameter. Specifies the size in bytes of a portion (chunk) of the payload that will be processed in a single batch “thread”. If parameter is set, the commitSizeInKB parameter is ignored. This parameter is supported by the following payload formats:
|